X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/526954c5968baa29218c994ec48e476ae2bd4b9f..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/msgqueue.h diff --git a/interface/wx/msgqueue.h b/interface/wx/msgqueue.h index 3e3cc120dd..8caf29c7e8 100644 --- a/interface/wx/msgqueue.h +++ b/interface/wx/msgqueue.h @@ -1,11 +1,34 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: msgqueue.h +// Name: wx/msgqueue.h // Purpose: interface of wxMessageQueue // 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.