X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7737c485f3cc2e12bb48ae88d0c500c50028385c..a49686b4c29e431ed24b14fae4d97140d447a149:/docs/latex/wx/thread.tex?ds=sidebyside

diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex
index 1fe11c9e73..400824fd6e 100644
--- a/docs/latex/wx/thread.tex
+++ b/docs/latex/wx/thread.tex
@@ -11,7 +11,7 @@ such as \helpref{mutexes}{wxmutex} and/or \helpref{critical sections}{wxcritical
 There are two types of threads in wxWindows: {\it detached} and {\it joinable}
 ones, just as in the POSIX thread API (but unlike Win32 threads where all threads
 are joinable). The difference between the two is that only joinable threads
-can return a return code - this is returned by the Wait() function. Detached
+can return a return code -- this is returned by the Wait() function. Detached
 threads (the default type) cannot be waited for.
 
 You shouldn't hurry to create all the threads joinable, however, because this
@@ -47,7 +47,7 @@ None.
 \func{}{wxThread}{\param{wxThreadKind }{kind = wxTHREAD\_DETACHED}}
 
 This constructor creates a new detached (default) or joinable C++ thread object. It
-does not create or start execution of the real thread - for this you should
+does not create or start execution of the real thread -- for this you should
 use the \helpref{Create}{wxthreadcreate} and \helpref{Run}{wxthreadrun} methods.
 
 The possible values for {\it kind} parameters are:
@@ -63,7 +63,7 @@ The possible values for {\it kind} parameters are:
 \func{}{\destruct{wxThread}}{\void}
 
 The destructor frees the resources associated with the thread. Notice that you
-should never delete a detached thread - you may only call 
+should never delete a detached thread -- you may only call
 \helpref{Delete}{wxthreaddelete} on it or wait until it terminates (and auto
 destructs) itself. Because the detached threads delete themselves, they can
 only be allocated on the heap.
@@ -74,10 +74,12 @@ stack.
 
 \membersection{wxThread::Create}\label{wxthreadcreate}
 
-\func{wxThreadError}{Create}{\void}
+\func{wxThreadError}{Create}{\param{unsigned int }{stackSize = 0}}
 
 Creates a new thread. The thread object is created in the suspended state, and you
-should call \helpref{Run}{wxthreadrun} to start running it.
+should call \helpref{Run}{wxthreadrun} to start running it.  You may optionally
+specify the stack size to be allocated to it (Ignored on platforms that don't
+support setting it explicitly, eg. Unix).
 
 \wxheading{Return value}
 
@@ -96,26 +98,21 @@ One of:
 
 Calling \helpref{Delete}{wxthreaddelete} is a graceful way to terminate the
 thread. It asks the thread to terminate and, if the thread code is well
-written, the thread will terminate after the next call to 
+written, the thread will terminate after the next call to
 \helpref{TestDestroy}{wxthreadtestdestroy} which should happen quite soon.
 
-However, if the thread doesn't call \helpref{TestDestroy}{wxthreadtestdestroy} 
+However, if the thread doesn't call \helpref{TestDestroy}{wxthreadtestdestroy}
 often enough (or at all), the function will not return immediately, but wait
 until the thread terminates. As it may take a long time, and the message processing
 is not stopped during this function execution, message handlers may be
 called from inside it!
 
-Delete() may be called for thread in any state: running, paused or even not yet
-created. Moreover, it must be called if \helpref{Create}{wxthreadcreate} or 
-\helpref{Run}{wxthreadrun} failed for a detached thread to free the memory
-occupied by the thread object. This cleanup will be done in the destructor for joinable
-threads.
-
-Delete() may be called for a thread in any state: running, paused or even not yet created. Moreover,
-it must be called if \helpref{Create}{wxthreadcreate} or \helpref{Run}{wxthreadrun} fail to free
-the memory occupied by the thread object. However, you should not call Delete()
-on a detached thread which already terminated - doing so will probably result
-in a crash because the thread object doesn't exist any more.
+Delete() may be called for a thread in any state: running, paused or even not
+yet created. Moreover, it must be called if \helpref{Create}{wxthreadcreate} or
+\helpref{Run}{wxthreadrun} fail in order to free the memory occupied by the
+thread object. However, you should not call Delete() on a detached thread which
+already terminated -- doing so will probably result in a crash because the
+thread object doesn't exist any more.
 
 For detached threads Delete() will also delete the C++ thread object, but it
 will not do this for joinable ones.
@@ -144,7 +141,7 @@ from a derived class. It also can only be called in the context of this
 thread, i.e. a thread can only exit from itself, not from another thread.
 
 This function will terminate the OS thread (i.e. stop the associated path of
-execution) and also delete the associated C++ object for detached threads. 
+execution) and also delete the associated C++ object for detached threads.
 \helpref{wxThread::OnExit}{wxthreadonexit} will be called just before exiting.
 
 \membersection{wxThread::GetCPUCount}\label{wxthreadgetcpucount}
@@ -157,6 +154,14 @@ Returns the number of system CPUs or -1 if the value is unknown.
 
 \helpref{SetConcurrency}{wxthreadsetconcurrency}
 
+\membersection{wxThread::GetCurrentId}\label{wxthreadgetcurrentid}
+
+\func{static unsigned long}{GetCurrentId}{\void}
+
+Returns the platform specific thread ID of the current thread as a
+long.  This can be used to uniquely identify threads, even if they are
+not wxThreads.
+
 \membersection{wxThread::GetId}\label{wxthreadgetid}
 
 \constfunc{unsigned long}{GetId}{\void}
@@ -183,31 +188,31 @@ The following priorities are defined:
 
 \constfunc{bool}{IsAlive}{\void}
 
-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).
 
 \membersection{wxThread::IsDetached}\label{wxthreadisdetached}
 
 \constfunc{bool}{IsDetached}{\void}
 
-Returns TRUE if the thread is of the detached kind, FALSE if it is a joinable one.
+Returns true if the thread is of the detached kind, false if it is a joinable one.
 
 \membersection{wxThread::IsMain}\label{wxthreadismain}
 
 \func{static bool}{IsMain}{\void}
 
-Returns TRUE if the calling thread is the main application thread.
+Returns true if the calling thread is the main application thread.
 
 \membersection{wxThread::IsPaused}\label{wxthreadispaused}
 
 \constfunc{bool}{IsPaused}{\void}
 
-Returns TRUE if the thread is paused.
+Returns true if the thread is paused.
 
 \membersection{wxThread::IsRunning}\label{wxthreadisrunning}
 
 \constfunc{bool}{IsRunning}{\void}
 
-Returns TRUE if the thread is running.
+Returns true if the thread is running.
 
 \membersection{wxThread::Kill}\label{wxthreadkill}
 
@@ -228,7 +233,7 @@ This function can only be called from another thread context, i.e. a thread
 cannot kill itself.
 
 It is also an error to call this function for a thread which is not running or
-paused (in the latter case, the thread will be resumed first) - if you do it, 
+paused (in the latter case, the thread will be resumed first) -- if you do it,
 a {\tt wxTHREAD\_NOT\_RUNNING} error will be returned.
 
 \membersection{wxThread::OnExit}\label{wxthreadonexit}
@@ -237,7 +242,7 @@ a {\tt wxTHREAD\_NOT\_RUNNING} error will be returned.
 
 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. This function will not be called if the thread was 
+thread. This function will not be called if the thread was
 \helpref{killed}{wxthreadkill}.
 
 This function should never be called directly.
@@ -247,7 +252,7 @@ This function should never be called directly.
 \func{wxThreadError}{Pause}{\void}
 
 Suspends the thread. Under some implementations (Win32), the thread is
-suspended immediately, under others it will only be suspended when it calls 
+suspended immediately, under others it will only be suspended when it calls
 \helpref{TestDestroy}{wxthreadtestdestroy} for the next time (hence, if the
 thread doesn't call it at all, it won't be suspended).
 
@@ -257,7 +262,7 @@ This function can only be called from another thread context.
 
 \func{wxThreadError}{Run}{\void}
 
-Starts the thread execution. Should be called after 
+Starts the thread execution. Should be called after
 \helpref{Create}{wxthreadcreate}.
 
 This function can only be called from another thread context.
@@ -267,7 +272,7 @@ This function can only be called from another thread context.
 \func{void}{SetPriority}{\param{int}{ priority}}
 
 Sets the priority of the thread, between $0$ and $100$. It can only be set
-after calling \helpref{Create()}{wxthreadcreate} but before calling 
+after calling \helpref{Create()}{wxthreadcreate} but before calling
 \helpref{Run()}{wxthreadrun}.
 
 The following priorities are already defined:
@@ -304,8 +309,8 @@ Sets the thread concurrency level for this process. This is, roughly, the
 number of threads that the system tries to schedule to run in parallel.
 The value of $0$ for {\it level} may be used to set the default one.
 
-Returns TRUE on success or FALSE otherwise (for example, if this function is
-not implemented for this platform - currently everything except Solaris).
+Returns true on success or false otherwise (for example, if this function is
+not implemented for this platform -- currently everything except Solaris).
 
 \membersection{wxThread::TestDestroy}\label{wxthreadtestdestroy}
 
@@ -313,7 +318,7 @@ not implemented for this platform - currently everything except Solaris).
 
 This function should be called periodically by the thread to ensure that calls
 to \helpref{Pause}{wxthreadpause} and \helpref{Delete}{wxthreaddelete} will
-work. If it returns TRUE, the thread should exit as soon as possible.
+work. If it returns true, the thread should exit as soon as possible.
 
 \membersection{wxThread::This}\label{wxthreadthis}
 
