X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc4fe30871fad3e3957c299838f3eba5ddb9e3b5..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/conditn.tex diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex index 52dfc70846..cf3a6df608 100644 --- a/docs/latex/wx/conditn.tex +++ b/docs/latex/wx/conditn.tex @@ -105,13 +105,17 @@ None. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxCondition::wxCondition}\label{wxconditionconstr} +\membersection{wxCondition::wxCondition}\label{wxconditionctor} \func{}{wxCondition}{\param{wxMutex\& }{mutex}} @@ -119,9 +123,9 @@ Default and only constructor. The {\it mutex} must be locked by the caller before calling \helpref{Wait}{wxconditionwait} function. Use \helpref{IsOk}{wxconditionisok} to check if the object was successfully -intiialized. +initialized. -\membersection{wxCondition::\destruct{wxCondition}} +\membersection{wxCondition::\destruct{wxCondition}}\label{wxconditiondtor} \func{}{\destruct{wxCondition}}{\void} @@ -145,7 +149,7 @@ not. \constfunc{bool}{IsOk}{\void} Returns {\tt true} if the object had been initialized successfully, {\tt false} -if an error occured. +if an error occurred. \membersection{wxCondition::Signal}\label{wxconditionsignal} @@ -172,7 +176,8 @@ Waits until the condition is signalled. This method atomically releases the lock on the mutex associated with this condition (this is why it must be locked prior to calling Wait) and puts the thread to sleep until \helpref{Signal}{wxconditionsignal} or -\helpref{Broadcast}{wxconditionbroadcast} is called. +\helpref{Broadcast}{wxconditionbroadcast} is called. It then locks the mutex +again and returns. Note that even if \helpref{Signal}{wxconditionsignal} had been called before Wait without waking up any thread, the thread would still wait for another one @@ -181,7 +186,7 @@ Wait or the thread may sleep forever. \wxheading{Return value} -Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occured. +Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occurred. \wxheading{See also} @@ -190,7 +195,7 @@ Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occured. \membersection{wxCondition::WaitTimeout}\label{wxconditionwaittimeout} -\func{wxCondError}{Wait}{\param{unsigned long}{ milliseconds}} +\func{wxCondError}{WaitTimeout}{\param{unsigned long}{ milliseconds}} Waits until the condition is signalled or the timeout has elapsed. @@ -205,6 +210,6 @@ timeout expires. \wxheading{Return value} Returns {\tt wxCOND\_NO\_ERROR} if the condition was signalled, -{\tt wxCOND\_TIMEOUT} if the timeout elapsed ebfore this happened or another +{\tt wxCOND\_TIMEOUT} if the timeout elapsed before this happened or another error code from wxCondError enum.