fixed bug in mouse handling

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

diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex
index 3a86dc67ce7c8ac75931fb31010e1b6a2e54d828..e531599ce22aae2f518e58994f8a282d9ed3ad08 100644 (file)
--- a/docs/latex/wx/thread.tex
+++ b/docs/latex/wx/thread.tex
@@ -43,12 +43,19 @@ None.
 
 \membersection{wxThread::wxThread}\label{wxthreadctor}
 
-\func{}{wxThread}{\void}
+\func{}{wxThread}{\param{wxThreadKind }{kind = wxTHREAD\_DETACHED}}
 
 Constructor creates a new detached (default) or joinable C++ thread object. It
 does not create (or starts execution of) the real thread - for this you should
 use \helpref{Create}{wxthreadcreate} and \helpref{Run}{wxthreadrun} methods.
 
+The possible values for {\it kind} parameters are:
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxTHREAD\_DETACHED}}{Create a detached thread.}
+\twocolitem{{\bf wxTHREAD\_JOINABLE}}{Create a joinable thread}
+\end{twocollist}
+
 \membersection{wxThread::\destruct{wxThread}}
 
 \func{}{\destruct{wxThread}}{\void}
@@ -210,10 +217,11 @@ be used with extreme care (and not used at all whenever possible)!} The resource
 allocated to the thread will not be freed and the state of the C runtime library
 may become inconsistent. Use \helpref{Delete()}{wxthreaddelete} instead.
 
-For detached threads Kill() will also call \helpref{OnExit}{wxthreadonexit} 
-and delete the associated C++ object, however this will not happen for
-joinable threads and this means that you will still have to delete the
-wxThread object yourself to avoid memory leaks.
+For detached threads Kill() will also delete the associated C++ object,
+however this will not happen for joinable threads and this means that you will
+still have to delete the wxThread object yourself to avoid memory leaks.
+In neither case \helpref{OnExit}{wxthreadonexit} of the dying thread will be
+called, so no thread-specific cleanup will be performed.
 
 This function can only be called from another thread context, i.e. a thread
 can not kill itself.
@@ -228,7 +236,8 @@ paused (in the latter case, the thread will be resumed first) - if you do it,
 
 Called when the thread exits. This function is called in the context of the
 thread associated with the wxThread object, not in the context of the main
-thread.
+thread. This function will not be called if the thread was 
+\helpref{killed}{wxthreadkill}.
 
 This function should never be called directly.
 
@@ -324,8 +333,7 @@ See also \helpref{Sleep()}{wxthreadsleep}.
 
 \constfunc{ExitCode}{Wait}{\void}
 
-Waits until the thread terminates and returns its exit code or {\tt
-(ExitCode)-1} on error.
+Waits until the thread terminates and returns its exit code or {\tt (ExitCode)-1} on error.
 
 You can only Wait() for joinable (not detached) threads.