Document wxMessageQueueError.
Document the enum defining the error codes of wxMessageQueue<> class. Closes #12634. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65964 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -1,11 +1,35 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: msgqueue.h
|
||||
// Name: wx/msgqueue.h
|
||||
// Purpose: interface of wxMessageQueue<T>
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows licence
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
Error codes for wxMessageQueue<> operations.
|
||||
|
||||
This enum contains the possible return value of wxMessageQueue<> methods.
|
||||
|
||||
@since 2.9.0
|
||||
@category{threading}
|
||||
*/
|
||||
enum wxMessageQueueError
|
||||
{
|
||||
/// Indicates that the operation completed successfully.
|
||||
wxMSGQUEUE_NO_ERROR = 0,
|
||||
|
||||
/**
|
||||
Indicates that no messages were received before timeout expired.
|
||||
|
||||
This return value is only used by wxMessageQueue<>::ReceiveTimeout().
|
||||
*/
|
||||
wxMSGQUEUE_TIMEOUT,
|
||||
|
||||
/// Some unexpected (and fatal) error has occurred.
|
||||
wxMSGQUEUE_MISC_ERROR
|
||||
};
|
||||
|
||||
/**
|
||||
wxMessageQueue allows passing messages between threads.
|
||||
|
||||
|
Reference in New Issue
Block a user