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

\section{\class{wxProcess}}\label{wxprocess}

This class contains a method which is invoked when a process finishes.
It can raise a \helpref{wxProcessEvent}{wxprocessevent} if wxProcess::OnTerminate
isn't overriden.

\wxheading{Derived from}

\helpref{wxEvtHandler}{wxevthandler}

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

\membersection{wxProcess::wxProcess}\label{wxprocessconstr}

\func{}{wxProcess}{\param{wxEvtHandler *}{ parent = NULL}, \param{int}{ id = -1}}

Constructs a process object. {\it id} is only used in the case you want to
use wxWindows events. 

\wxheading{Parameters}

\docparam{parent}{The event handler parent.}

\docparam{id}{id of an event.}

\membersection{wxProcess::\destruct{wxProcess}}

\func{}{\destruct{wxProcess}}{\void}

Destroys the wxProcess object.

\membersection{wxProcess::OnTerminate}\label{wxprocessonterminate}

\constfunc{void}{OnTerminate}{\param{int}{ pid}}

It is called when the process with the pid {\it pid} finishes.
It raises a wxWindows event when it isn't overriden.

\docparam{pid}{The pid of the process which ends.}
Commit	Line	Data
eafc087e GL	1	\section{\class{wxProcess}}\label{wxprocess}
	2
	3	This class contains a method which is invoked when a process finishes.
	4	It can raise a \helpref{wxProcessEvent}{wxprocessevent} if wxProcess::OnTerminate
	5	isn't overriden.
	6
	7	\wxheading{Derived from}
	8
	9	\helpref{wxEvtHandler}{wxevthandler}
	10
	11	\latexignore{\rtfignore{\wxheading{Members}}}
	12
	13	\membersection{wxProcess::wxProcess}\label{wxprocessconstr}
	14
	15	\func{}{wxProcess}{\param{wxEvtHandler *}{ parent = NULL}, \param{int}{ id = -1}}
	16
	17	Constructs a process object. {\it id} is only used in the case you want to
	18	use wxWindows events.
	19
	20	\wxheading{Parameters}
	21
	22	\docparam{parent}{The event handler parent.}
	23
	24	\docparam{id}{id of an event.}
	25
	26	\membersection{wxProcess::\destruct{wxProcess}}
	27
	28	\func{}{\destruct{wxProcess}}{\void}
	29
	30	Destroys the wxProcess object.
	31
	32	\membersection{wxProcess::OnTerminate}\label{wxprocessonterminate}
	33
	34	\constfunc{void}{OnTerminate}{\param{int}{ pid}}
	35
	36	It is called when the process with the pid {\it pid} finishes.
	37	It raises a wxWindows event when it isn't overriden.
	38
	39	\docparam{pid}{The pid of the process which ends.}