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

\section{\class{wxProcessEvent}}\label{wxprocessevent}

A process event is sent when a process is terminated.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/process.h>

\wxheading{Library}

\helpref{wxBase}{librarieslist}

\wxheading{Event table macros}

To process a wxProcessEvent, use these event handler macros to direct input to a member
function that takes a wxProcessEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_END\_PROCESS(id, func)}}{Process a wxEVT\_END\_PROCESS event.
{\it id} is the identifier of the process object (the id passed to the wxProcess constructor)
or a window to receive the event.}
\end{twocollist}%

\wxheading{See also}

\helpref{wxProcess}{wxprocess},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}

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

\membersection{wxProcessEvent::wxProcessEvent}\label{wxprocesseventctor}

\func{}{wxProcessEvent}{\param{int }{id = 0}, \param{int }{pid = 0}, \param{int }{exitcode = 0}}

Constructor. Takes a wxProcessObject or window id, a process id and an
exit status.

%\membersection{wxProcessEvent::m\_pid}
%
%\member{int}{m\_pid}
%
%Contains the process id.
%
\membersection{wxProcessEvent::GetPid}\label{wxprocesseventgetpid}

\constfunc{int}{GetPid}{\void}

Returns the process id.

\membersection{wxProcessEvent::GetExitCode}\label{wxprocesseventgetexitcode}

\func{int}{GetExitCode}{\void}

Returns the exist status.
Commit	Line	Data
3972fb49 JS	1	\section{\class{wxProcessEvent}}\label{wxprocessevent}
	2
	3	A process event is sent when a process is terminated.
	4
	5	\wxheading{Derived from}
	6
	7	\helpref{wxEvent}{wxevent}\\
	8	\helpref{wxObject}{wxobject}
	9
954b8ae6 JS	10	\wxheading{Include files}
	11
	12	<wx/process.h>
	13
a7af285d VZ	14	\wxheading{Library}
	15
	16	\helpref{wxBase}{librarieslist}
	17
3972fb49 JS	18	\wxheading{Event table macros}
	19
	20	To process a wxProcessEvent, use these event handler macros to direct input to a member
	21	function that takes a wxProcessEvent argument.
	22
	23	\twocolwidtha{7cm}
	24	\begin{twocollist}\itemsep=0pt
	25	\twocolitem{{\bf EVT\_END\_PROCESS(id, func)}}{Process a wxEVT\_END\_PROCESS event.
	26	{\it id} is the identifier of the process object (the id passed to the wxProcess constructor)
	27	or a window to receive the event.}
	28	\end{twocollist}%
	29
	30	\wxheading{See also}
	31
	32	\helpref{wxProcess}{wxprocess},\rtfsp
	33	\helpref{Event handling overview}{eventhandlingoverview}
	34
	35	\latexignore{\rtfignore{\wxheading{Members}}}
	36
3e79fa75	37	\membersection{wxProcessEvent::wxProcessEvent}\label{wxprocesseventctor}
3972fb49	38
9722642d	39	\func{}{wxProcessEvent}{\param{int }{id = 0}, \param{int }{pid = 0}, \param{int }{exitcode = 0}}
3972fb49	40
9722642d MB	41	Constructor. Takes a wxProcessObject or window id, a process id and an
9722642d MB	42	exit status.
3972fb49	43
9722642d MB	44	%\membersection{wxProcessEvent::m\_pid}
	45	%
	46	%\member{int}{m\_pid}
	47	%
	48	%Contains the process id.
	49	%
3972fb49 JS	50	\membersection{wxProcessEvent::GetPid}\label{wxprocesseventgetpid}
	51
	52	\constfunc{int}{GetPid}{\void}
	53
	54	Returns the process id.
	55
9722642d	56	\membersection{wxProcessEvent::GetExitCode}\label{wxprocesseventgetexitcode}
3972fb49	57
9722642d	58	\func{int}{GetExitCode}{\void}
3972fb49	59
9722642d	60	Returns the exist status.
ba637f22	61