]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/thread.tex
* wxStream fixes (integer/line parsing).
[wxWidgets.git] / docs / latex / wx / thread.tex
index 742473d5dafaf863e059e2625be192e52a9ca6bc..89bc18dd2423d0b19072f3be6ba8c819c7274561 100644 (file)
@@ -12,6 +12,10 @@ such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcritical
 
 None.
 
+\wxheading{Include files}
+
+<wx/thread.h>
+
 \wxheading{See also}
 
 \helpref{wxMutex}{wxmutex}, \helpref{wxCondition}{wxcondition}, \helpref{wxCriticalSection}{wxcriticalsection}
@@ -54,7 +58,7 @@ One of:
 
 \membersection{wxThread::Delete}\label{wxthreaddelete}
 
-\func{\void}{Delete}{\void}
+\func{void}{Delete}{\void}
 
 This function should be called to terminate this thread. Unlike \helpref{Kill}{wxthreadkill}, it
 gives the target thread the time to terminate gracefully. Because of this, however, this function
@@ -66,6 +70,16 @@ Delete() may be called for thread in any state: running, paused or even not yet
 it must be called if \helpref{Create}{wxthreadcreate} or \helpref{Run}{wxthreadrun} fail to free
 the memory occupied by the thread object.
 
+\membersection{wxThread::Entry}\label{wxthreadentry}
+
+\func{virtual void *}{Entry}{\void}
+
+This is the entry point of the thread. This function is pure virtual and must
+be implemented by any derived class. The thread execution will start here.
+
+The returned value is the thread exit code but is currently ignored in
+wxWindows implementation (this will change in near future).
+
 \membersection{wxThread::GetID}\label{wxthreadgetid}
 
 \constfunc{unsigned long}{GetID}{\void}