Misc fixes

[wxWidgets.git] / docs / latex / wx / conditn.tex

diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex
index f6b77506d0f33971bb6af1ecaac7b37cb7369447..777a3cd226aaf48afb22db2f16aaaf3ab37a57ae 100644 (file)
--- a/docs/latex/wx/conditn.tex
+++ b/docs/latex/wx/conditn.tex
@@ -1,11 +1,24 @@
 \section{\class{wxCondition}}\label{wxcondition}
 
 \section{\class{wxCondition}}\label{wxcondition}
 

-TODO
+wxCondition variables correspond to pthread conditions or to Win32 event
+objects. They may be used in a multithreaded application to wait until the
+given condition becomes true which happens when the condition becomes signaled.
+
+For example, if a worker thread is doing some long task and another thread has
+to wait until it's finished, the latter thread will wait on the condition
+object and the worker thread will signal it on exit (this example is not
+perfect because in this particular case it would be much better to just 
+\helpref{Wait()}{wxthreadwait} for the worker thread, but if there are several
+worker threads it already makes much more sense).

 
 \wxheading{Derived from}
 
 None.
 
 
 \wxheading{Derived from}
 
 None.
 

+\wxheading{Include files}
+
+<wx/thread.h>
+

 \wxheading{See also}
 
 \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}
 \wxheading{See also}
 
 \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}


@@ -58,4 +71,3 @@ Waits until a signal is raised or the timeout has elapsed.
 
 The second form returns if the signal was raised, or FALSE if there was a timeout.
 
 
 The second form returns if the signal was raised, or FALSE if there was a timeout.
 

-