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

\section{\class{wxThreadHelperThread}}\label{wxThreadHelperThread}

The wxThreadHelperThread class is used internally by the
\helpref{wxThreadHelper}{wxthreadhelper} mix-in class.  This class simply
turns around and calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}
in its owner class when the thread runs.

\wxheading{Derived from}

\helpref{wxThread}{wxthread}

\wxheading{Include files}

<wx/thread.h>

\wxheading{See also}

\helpref{wxThread}{wxthread}, \helpref{wxThreadHelper}{wxthreadhelper}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadctor}

\func{}{wxThreadHelperThread}{\void}

This constructor simply initializes member variables.

\membersection{wxThreadHelperThread::m\_owner}

\member{wxThreadHelperThread\& }{m\_owner}

the \helpref{wxThreadHelper}{wxthreadhelper} object which holds the code to
run inside the thread.

\membersection{wxThreadHelperThread::Entry}\label{wxthreadhelperthreadentry}

\func{virtual ExitCode}{Entry}{\void}

This is the entry point of the thread.  This function eventually calls
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}.  The actual worker
thread code should be implemented in
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
shared data and synchronization objects can be shared easily between the
main thread and the worker thread.

The returned value is the thread exit code which is the value returned by
\helpref{Wait()}{wxthreadwait}.

This function is called by wxWindows itself and should never be called
directly.

\membersection{wxThreadHelperThread::CallEntry}\label{wxthreadhelperthreadcallentry}

\func{virtual ExitCode}{CallEntry}{\void}

This is a convenience method that actually calls
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}.  This function
eventually calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}.
The actual worker thread code should be implemented in
\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
shared data and synchronization objects can be shared easily between the
main thread and the worker thread.

It must be declared after \helpref{wxThreadHelper}{wxthreadhelper} so it
can access \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} and avoid
circular dependencies.  Thus, it uses the inline keyword to allow its
definition outside of the class definition.  To avoid any conflicts
between the virtual and inline keywords, it is a non-virtual method.

The returned value is the thread exit code which is the value returned by
\helpref{Wait()}{wxthreadwait}.

This function is called by wxWindows itself and should never be called
directly.
Commit	Line	Data
78ee6a47 VZ	1	\section{\class{wxThreadHelperThread}}\label{wxThreadHelperThread}
	2
	3	The wxThreadHelperThread class is used internally by the
	4	\helpref{wxThreadHelper}{wxthreadhelper} mix-in class. This class simply
	5	turns around and calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}
	6	in its owner class when 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{wxthreadctor}
	23
	24	\func{}{wxThreadHelperThread}{\void}
	25
	26	This constructor simply initializes member variables.
	27
	28	\membersection{wxThreadHelperThread::m\_owner}
	29
	30	\member{wxThreadHelperThread\& }{m\_owner}
	31
	32	the \helpref{wxThreadHelper}{wxthreadhelper} object which holds the code to
	33	run inside the thread.
	34
	35	\membersection{wxThreadHelperThread::Entry}\label{wxthreadhelperthreadentry}
	36
	37	\func{virtual ExitCode}{Entry}{\void}
	38
	39	This is the entry point of the thread. This function eventually calls
	40	\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}. The actual worker
	41	thread code should be implemented in
	42	\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
	43	shared data and synchronization objects can be shared easily between the
	44	main thread and the worker thread.
	45
	46	The returned value is the thread exit code which is the value returned by
	47	\helpref{Wait()}{wxthreadwait}.
	48
	49	This function is called by wxWindows itself and should never be called
	50	directly.
	51
	52	\membersection{wxThreadHelperThread::CallEntry}\label{wxthreadhelperthreadcallentry}
	53
	54	\func{virtual ExitCode}{CallEntry}{\void}
	55
	56	This is a convenience method that actually calls
	57	\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}. This function
	58	eventually calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}.
	59	The actual worker thread code should be implemented in
	60	\helpref{wxThreadHelper::Entry}{wxthreadhelperentry}, not here, so all
	61	shared data and synchronization objects can be shared easily between the
	62	main thread and the worker thread.
	63
	64	It must be declared after \helpref{wxThreadHelper}{wxthreadhelper} so it
65	can access \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} and avoid
66	circular dependencies. Thus, it uses the inline keyword to allow its
67	definition outside of the class definition. To avoid any conflicts
68	between the virtual and inline keywords, it is a non-virtual method.
69
70	The returned value is the thread exit code which is the value returned by
71	\helpref{Wait()}{wxthreadwait}.
72
73	This function is called by wxWindows itself and should never be called
74	directly.