]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/threadht.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / threadht.tex
... / ...
CommitLineData
1\section{\class{wxThreadHelperThread}}\label{wxThreadHelperThread}
2
3The wxThreadHelperThread class is used internally by the
4\helpref{wxThreadHelper}{wxthreadhelper} mix-in class. This class simply
5calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} in its owner class
6when the thread runs.
7
8\wxheading{Derived from}
9
10\helpref{wxThread}{wxthread}
11
12\wxheading{Include files}
13
14<wx/thread.h>
15
16\wxheading{See also}
17
18\helpref{wxThread}{wxthread}, \helpref{wxThreadHelper}{wxthreadhelper}
19
20\latexignore{\rtfignore{\wxheading{Members}}}
21
22\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadhelperthreadctor}
23
24\func{}{wxThreadHelperThread}{\void}
25
26This constructor simply initializes member variables.
27
28\membersection{wxThreadHelperThread::m\_owner}
29
30\member{wxThreadHelperThread\& }{m\_owner}
31
32the \helpref{wxThreadHelper}{wxthreadhelper} object which holds the code to
33run inside the thread.
34
35\membersection{wxThreadHelperThread::Entry}\label{wxthreadhelperthreadentry}
36
37\func{virtual ExitCode}{Entry}{\void}
38
39This is the entry point of the thread. This function eventually calls
40\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}. The actual worker
41thread code should be implemented in
42\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
43shared data and synchronization objects can be shared easily between the
44main thread and the worker thread.
45
46The returned value is the thread exit code which is the value returned by
47\helpref{Wait()}{wxthreadwait}.
48
49This function is called by wxWidgets itself and should never be called
50directly.
51
52\membersection{wxThreadHelperThread::CallEntry}\label{wxthreadhelperthreadcallentry}
53
54\func{virtual ExitCode}{CallEntry}{\void}
55
56This is a convenience method that actually calls
57\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}. This function
58eventually calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}.
59The actual worker thread code should be implemented in
60\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
61shared data and synchronization objects can be shared easily between the
62main thread and the worker thread.
63
64It must be declared after \helpref{wxThreadHelper}{wxthreadhelper} so it
65can access \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} and avoid
66circular dependencies. Thus, it uses the inline keyword to allow its
67definition outside of the class definition. To avoid any conflicts
68between the virtual and inline keywords, it is a non-virtual method.
69
70The returned value is the thread exit code which is the value returned by
71\helpref{Wait()}{wxthreadwait}.
72
73This function is called by wxWidgets itself and should never be called
74directly.
75