X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b9697cb4104c115d39d10915b47e2381938020e0..b09857ae000a60704207d63290be937584805fb0:/interface/wx/thread.h?ds=sidebyside diff --git a/interface/wx/thread.h b/interface/wx/thread.h index 56d79333cc..e97b4a024c 100644 --- a/interface/wx/thread.h +++ b/interface/wx/thread.h @@ -675,17 +675,6 @@ enum wxThreadError wxTHREAD_MISC_ERROR }; -/** - Defines the interval of priority -*/ -enum -{ - WXTHREAD_MIN_PRIORITY = 0u, - WXTHREAD_DEFAULT_PRIORITY = 50u, - WXTHREAD_MAX_PRIORITY = 100u -}; - - /** @class wxThread @@ -1092,7 +1081,7 @@ public: /** Gets the thread identifier: this is a platform dependent number that uniquely identifies the thread throughout the system during its existence - (i.e. the thread identifiers may be reused). + (i.e.\ the thread identifiers may be reused). */ wxThreadIdType GetId() const; @@ -1113,17 +1102,14 @@ public: static wxThreadIdType GetMainId(); /** - Gets the priority of the thread, between zero and 100. + Gets the priority of the thread, between 0 (lowest) and 100 (highest). - The following priorities are defined: - - @b WXTHREAD_MIN_PRIORITY: 0 - - @b WXTHREAD_DEFAULT_PRIORITY: 50 - - @b WXTHREAD_MAX_PRIORITY: 100 + @see SetPriority() */ unsigned int GetPriority() const; /** - Returns @true if the thread is alive (i.e. started and not terminating). + Returns @true if the thread is alive (i.e.\ started and not terminating). Note that this function can only safely be used with joinable threads, not detached ones as the latter delete themselves and so when the real thread is @@ -1234,13 +1220,15 @@ public: static bool SetConcurrency(size_t level); /** - Sets the priority of the thread, between 0 and 100. + Sets the priority of the thread, between 0 (lowest) and 100 (highest). + It can only be set after calling Create() but before calling Run(). - The following priorities are defined: - - @b WXTHREAD_MIN_PRIORITY: 0 - - @b WXTHREAD_DEFAULT_PRIORITY: 50 - - @b WXTHREAD_MAX_PRIORITY: 100 + The following symbolic constants can be used in addition to raw + values in 0..100 range: + - ::wxPRIORITY_MIN: 0 + - ::wxPRIORITY_DEFAULT: 50 + - ::wxPRIORITY_MAX: 100 */ void SetPriority(unsigned int priority);