Corrected wrong use of delete in region code.

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index cfaa54463a20713769c93532716f18f81dbac3c7..33ee4e679e266a408f201769144d6c3b6e7df278 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -37,7 +37,7 @@ the corresponding topic.
 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\
 \helpref{wxCHECK}{wxcheck}\\
 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\
 \helpref{wxCHECK}{wxcheck}\\
 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\

-\helpref{wxClipboardOpen}{wxclipboardopen}\\
+\helpref{wxClipboardOpen}{functionwxclipboardopen}\\

 \helpref{wxCloseClipboard}{wxcloseclipboard}\\
 \helpref{wxColourDisplay}{wxcolourdisplay}\\
 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\
 \helpref{wxCloseClipboard}{wxcloseclipboard}\\
 \helpref{wxColourDisplay}{wxcolourdisplay}\\
 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\


@@ -51,12 +51,11 @@ the corresponding topic.
 \helpref{wxDDEInitialize}{wxddeinitialize}\\
 \helpref{wxDROP\_ICON}{wxdropicon}\\
 \helpref{wxDebugMsg}{wxdebugmsg}\\
 \helpref{wxDDEInitialize}{wxddeinitialize}\\
 \helpref{wxDROP\_ICON}{wxdropicon}\\
 \helpref{wxDebugMsg}{wxdebugmsg}\\

-\helpref{wxDirExists}{wxdirexists}\\
+\helpref{wxDirExists}{functionwxdirexists}\\

 \helpref{wxDirSelector}{wxdirselector}\\
 \helpref{wxDisplayDepth}{wxdisplaydepth}\\
 \helpref{wxDirSelector}{wxdirselector}\\
 \helpref{wxDisplayDepth}{wxdisplaydepth}\\

-\helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\
-\helpref{wxDisplaySize}{wxdisplaysize}\\

 \helpref{wxDisplaySize}{wxdisplaysize}\\
 \helpref{wxDisplaySize}{wxdisplaysize}\\

+\helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\

 \helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
 \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
 \helpref{wxDynamicCast}{wxdynamiccast}\\


@@ -71,7 +70,7 @@ the corresponding topic.
 \helpref{wxFAIL\_MSG}{wxfailmsg}\\
 \helpref{wxFAIL}{wxfail}\\
 \helpref{wxFatalError}{wxfatalerror}\\
 \helpref{wxFAIL\_MSG}{wxfailmsg}\\
 \helpref{wxFAIL}{wxfail}\\
 \helpref{wxFatalError}{wxfatalerror}\\

-\helpref{wxFileExists}{wxfileexists}\\
+\helpref{wxFileExists}{functionwxfileexists}\\

 \helpref{wxFileModificationTime}{wxfilemodificationtime}\\
 \helpref{wxFileNameFromPath}{wxfilenamefrompath}\\
 \helpref{wxFileSelector}{wxfileselector}\\
 \helpref{wxFileModificationTime}{wxfilemodificationtime}\\
 \helpref{wxFileNameFromPath}{wxfilenamefrompath}\\
 \helpref{wxFileSelector}{wxfileselector}\\


@@ -121,6 +120,7 @@ the corresponding topic.
 \helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
 \helpref{wxGetTempFileName}{wxgettempfilename}\\
 \helpref{wxGetTextFromUser}{wxgettextfromuser}\\
 \helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
 \helpref{wxGetTempFileName}{wxgettempfilename}\\
 \helpref{wxGetTextFromUser}{wxgettextfromuser}\\

+\helpref{wxGetTopLevelParent}{wxgettoplevelparent}\\

 \helpref{wxGetTranslation}{wxgettranslation}\\
 \helpref{wxGetUTCTime}{wxgetutctime}\\
 \helpref{wxGetUserHome}{wxgetuserhome}\\
 \helpref{wxGetTranslation}{wxgettranslation}\\
 \helpref{wxGetUTCTime}{wxgetutctime}\\
 \helpref{wxGetUserHome}{wxgetuserhome}\\


@@ -424,9 +424,9 @@ processes.
 
 \membersection{::wxExecute}\label{wxexecute}
 
 
 \membersection{::wxExecute}\label{wxexecute}
 

-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{int }{sync = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}

 
 

-\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+\func{long}{wxExecute}{\param{char **}{argv}, \param{int }{flags = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}

 
 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
 
 
 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
 


@@ -450,8 +450,9 @@ arguments, terminated by NULL.
 The semantics of the third and fourth versions is different from the first two
 and is described in more details below.
 
 The semantics of the third and fourth versions is different from the first two
 and is described in more details below.
 

-If {\it sync} is FALSE (the default), flow of control immediately returns.
-If TRUE, the current application waits until the other program has terminated.
+If {\it flags} parameter contains {\tt wxEXEC\_ASYNC} flag (the default), flow
+of control immediately returns. If it contains {\tt wxEXEC\_SYNC}, the current
+application waits until the other program has terminated.

 
 In the case of synchronous execution, the return value is the exit code of
 the process (which terminates by the moment the function returns) and will be
 
 In the case of synchronous execution, the return value is the exit code of
 the process (which terminates by the moment the function returns) and will be


@@ -469,10 +470,21 @@ case of using DDE under Windows for command execution). In particular, in this,
 and only this, case the calling code will not get the notification about
 process termination.
 
 and only this, case the calling code will not get the notification about
 process termination.
 

-If callback isn't NULL and if execution is asynchronous (note that callback
-parameter can not be non-NULL for synchronous execution),
+If callback isn't NULL and if execution is asynchronous, 

 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when

-the process finishes.
+the process finishes. Specifying this parameter also allows you to redirect the
+standard input and/or output of the process being launched by calling 
+\helpref{Redirect}{wxprocessredirect}. If the child process IO is redirected,
+under Windows the process window is not shown by default (this avoids having to
+flush an unnecessary console for the processes which don't create any windows
+anyhow) but a {\tt wxEXEC\_NOHIDE} flag can be used to prevent this from
+happening, i.e. with this flag the child process window will be shown normally.
+
+Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure
+that the new process is a group leader (this will create a new session if
+needed). Calling \helpref{wxKill}{wxkill} with the argument of -pid where pid
+is the process ID of the new process will kill this process as well as all of
+its children (except those which have started their own session).

 
 Finally, you may use the third overloaded version of this function to execute
 a process (always synchronously) and capture its output in the array
 
 Finally, you may use the third overloaded version of this function to execute
 a process (always synchronously) and capture its output in the array


@@ -482,6 +494,20 @@ the messages from standard error output in the {\it errors} array.
 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
 \helpref{Exec sample}{sampleexec}.
 
 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
 \helpref{Exec sample}{sampleexec}.
 

+\wxheading{Parameters}
+
+\docparam{command}{The command to execute and any parameters to pass to it as a
+single string.}
+
+\docparam{argv}{The command to execute should be the first element of this
+array, any additional ones are the command parameters and the array must be
+terminated with a NULL pointer.}
+
+\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC}, 
+{\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
+
+\docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
+

 \wxheading{Include files}
 
 <wx/utils.h>
 \wxheading{Include files}
 
 <wx/utils.h>


@@ -493,7 +519,7 @@ See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
 Should only be used in an emergency: normally the top-level frame
 should be deleted (after deleting all other frames) to terminate the
 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
 Should only be used in an emergency: normally the top-level frame
 should be deleted (after deleting all other frames) to terminate the

-application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
+application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp}.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -635,7 +661,7 @@ threads.
 \helpref{wxFile}{wxfile}\\
 \helpref{wxFileName}{wxfilename}
 
 \helpref{wxFile}{wxfile}\\
 \helpref{wxFileName}{wxfilename}
 

-\membersection{::wxDirExists}\label{wxdirexists}
+\membersection{::wxDirExists}\label{functionwxdirexists}

 
 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
 
 
 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
 


@@ -648,7 +674,7 @@ Returns TRUE if the directory exists.
 Converts a DOS to a Unix filename by replacing backslashes with forward
 slashes.
 
 Converts a DOS to a Unix filename by replacing backslashes with forward
 slashes.
 

-\membersection{::wxFileExists}\label{wxfileexists}
+\membersection{::wxFileExists}\label{functionwxfileexists}

 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 


@@ -1934,7 +1960,7 @@ class instead.
 
 <wx/clipbrd.h>
 
 
 <wx/clipbrd.h>
 

-\membersection{::wxClipboardOpen}\label{wxclipboardopen}
+\membersection{::wxClipboardOpen}\label{functionwxclipboardopen}

 
 \func{bool}{wxClipboardOpen}{\void}
 
 
 \func{bool}{wxClipboardOpen}{\void}
 


@@ -2081,16 +2107,6 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient},
 
 <wx/dde.h>
 
 
 <wx/dde.h>
 

-\membersection{::wxDisplaySize}\label{wxdisplaysize}
-
-\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-
-Gets the physical size of the display in pixels.
-
-\wxheading{Include files}
-
-<wx/gdicmn.h>
-

 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}


@@ -2218,6 +2234,17 @@ See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxco
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
+
+\func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
+
+Returns the first top level parent of the given window, or in other words, the
+frame or dialog containing it, or {\tt NULL}.
+
+\wxheading{Include files}
+
+<wx/window.h>
+

 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}


@@ -2337,7 +2364,7 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\section{Byte order macros}\label{macros}
+\section{Byte order macros}\label{byteordermacros}

 
 The endian-ness issues (that is the difference between big-endian and
 little-endian architectures) are important for the portable programs working
 
 The endian-ness issues (that is the difference between big-endian and
 little-endian architectures) are important for the portable programs working


@@ -2395,7 +2422,7 @@ been compiled on a big-endian architecture, the value will be unchanged.
 Use these macros to read data from and write data to a file that stores
 data in big-endian format.
 
 Use these macros to read data from and write data to a file that stores
 data in big-endian format.
 

-\section{RTTI functions}\label{macros}
+\section{RTTI functions}\label{rttimacros}

 
 wxWindows uses its own RTTI ("run-time type identification") system which
 predates the current standard C++ RTTI and so is kept for backwards
 
 wxWindows uses its own RTTI ("run-time type identification") system which
 predates the current standard C++ RTTI and so is kept for backwards