Doc corrections

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

diff --git a/docs/latex/wx/process.tex b/docs/latex/wx/process.tex
index 98e90695dc56a04c3f490ecf62634ad7bd3c8d5e..e3ced7324959927c78bca80110eb43545ebc3cd9 100644 (file)
--- a/docs/latex/wx/process.tex
+++ b/docs/latex/wx/process.tex
@@ -1,6 +1,6 @@
 \section{\class{wxProcess}}\label{wxprocess}
 
 \section{\class{wxProcess}}\label{wxprocess}
 

-The objects of this class are used in conjunction with the 
+The objects of this class are used in conjunction with the

 \helpref{wxExecute}{wxexecute} function. When a wxProcess object is passed to
 wxExecute(), its \helpref{OnTerminate()}{wxprocessonterminate} virtual method
 is called when the process terminates. This allows the program to be
 \helpref{wxExecute}{wxexecute} function. When a wxProcess object is passed to
 wxExecute(), its \helpref{OnTerminate()}{wxprocessonterminate} virtual method
 is called when the process terminates. This allows the program to be


@@ -15,10 +15,10 @@ library users should only delete those objects whose notifications have been
 processed (and call \helpref{Detach()}{wxprocessdetach} for others).
 
 wxProcess also supports IO redirection of the child process. For this, you have
 processed (and call \helpref{Detach()}{wxprocessdetach} for others).
 
 wxProcess also supports IO redirection of the child process. For this, you have

-to call its \helpref{Redirect}{wxprocessredirect} method before passing it to 
-\helpref{wxExecute}{wxexecute}. If the child process was launched successfully, 
-\helpref{GetInputStream}{wxprocessgetinputstream}, 
-\helpref{GetOutputStream}{wxprocessgetoutputstream} and 
+to call its \helpref{Redirect}{wxprocessredirect} method before passing it to
+\helpref{wxExecute}{wxexecute}. If the child process was launched successfully,
+\helpref{GetInputStream}{wxprocessgetinputstream},
+\helpref{GetOutputStream}{wxprocessgetoutputstream} and

 \helpref{GetErrorStream}{wxprocessgeterrorstream} can then be used to retrieve
 the streams corresponding to the child process standard output, input and
 error output respectively.
 \helpref{GetErrorStream}{wxprocessgeterrorstream} can then be used to retrieve
 the streams corresponding to the child process standard output, input and
 error output respectively.


@@ -92,7 +92,7 @@ Normally, a wxProcess object is deleted by its parent when it receives the
 notification about the process termination. However, it might happen that the
 parent object is destroyed before the external process is terminated (e.g. a
 window from which this external process was launched is closed by the user)
 notification about the process termination. However, it might happen that the
 parent object is destroyed before the external process is terminated (e.g. a
 window from which this external process was launched is closed by the user)

-and in this case it {\bf should not delete} the wxProcess object, but 
+and in this case it {\bf should not delete} the wxProcess object, but

 {\bf should call Detach()} instead. After the wxProcess object is detached
 from its parent, no notification events will be sent to the parent and the
 object will delete itself upon reception of the process termination
 {\bf should call Detach()} instead. After the wxProcess object is detached
 from its parent, no notification events will be sent to the parent and the
 object will delete itself upon reception of the process termination


@@ -121,6 +121,38 @@ It returns an output stream correspoding to the input stream of the subprocess.
 If it is NULL, you have not turned on the redirection.
 See \helpref{wxProcess::Redirect}{wxprocessredirect}.
 
 If it is NULL, you have not turned on the redirection.
 See \helpref{wxProcess::Redirect}{wxprocessredirect}.
 

+\membersection{wxProcess::IsErrorAvailable}\label{wxprocessiserroravailable}
+
+\constfunc{bool}{IsErrorAvailable}{\void}
+
+Returns {\tt TRUE} if there is data to be read on the child process standard
+error stream.
+
+\wxheading{See also}
+
+\helpref{IsInputAvailable}{wxprocessisinputavailable}
+
+\membersection{wxProcess::IsInputAvailable}\label{wxprocessisinputavailable}
+
+\constfunc{bool}{IsInputAvailable}{\void}
+
+Returns {\tt TRUE} if there is data to be read on the child process standard
+output stream. This allows to write simple (and extremely inefficient)
+polling-based code waiting for a better mechanism in future wxWindows versions.
+
+See the \helpref{exec sample}{sampleexec} for an example of using this
+function.
+
+\wxheading{See also}
+
+\helpref{IsInputOpened}{wxprocessisinputopened}
+
+\membersection{wxProcess::IsInputOpened}\label{wxprocessisinputopened}
+
+\constfunc{bool}{IsInputOpened}{\void}
+
+Returns {\tt TRUE} if the child process standard output stream is opened.
+

 \membersection{wxProcess::Kill}\label{wxprocesskill}
 
 \func{static wxKillError}{Kill}{\param{int}{ pid}, \param{wxSignal}{ signal = wxSIGNONE}}
 \membersection{wxProcess::Kill}\label{wxprocesskill}
 
 \func{static wxKillError}{Kill}{\param{int}{ pid}, \param{wxSignal}{ signal = wxSIGNONE}}


@@ -150,7 +182,7 @@ enum wxSignal
 \end{verbatim}
 
 {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning
 \end{verbatim}
 
 {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning

-under both Unix and Windows but all the other signals are equivalent to 
+under both Unix and Windows but all the other signals are equivalent to

 {\tt wxSIGTERM} under Windows.
 
 Returns the element of {\tt wxKillError} enum:
 {\tt wxSIGTERM} under Windows.
 
 Returns the element of {\tt wxKillError} enum:


@@ -196,7 +228,7 @@ It raises a wxWindows event when it isn't overridden.
 
 \membersection{wxProcess::Open}\label{wxprocessopen}
 
 
 \membersection{wxProcess::Open}\label{wxprocessopen}
 

-\func{static wxProcess *}{Open}{\param{const wxString\& }{cmd}}
+\func{static wxProcess *}{Open}{\param{const wxString\& }{cmd} \param{int }{flags = wxEXEC\_ASYNC}}

 
 This static method replaces the standard {\tt popen()} function: it launches
 the process specified by the {\it cmd} parameter and returns the wxProcess
 
 This static method replaces the standard {\tt popen()} function: it launches
 the process specified by the {\it cmd} parameter and returns the wxProcess


@@ -212,6 +244,8 @@ exits to avoid memory leaks.
 \wxheading{Parameters}
 
 \docparam{cmd}{The command to execute, including optional arguments.}
 \wxheading{Parameters}
 
 \docparam{cmd}{The command to execute, including optional arguments.}

+\docparam{flags}{The flags to pass to \helpref{wxExecute}{wxexecute}.
+  NOTE: wxEXEC\_SYNC should not be used.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}