Removed some inappropriate use of verbatim

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 486303f6670aa975bd858780a0d0f36ea264952b..14744e8644f82962ba89cf6c7ebd78c5c8326571 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -114,6 +114,7 @@ the corresponding topic.
 \helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
 \helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
 \helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\
 \helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
 \helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
 \helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\

+\helpref{wxGetProcessId}{wxgetprocessid}\\

 \helpref{wxGetResource}{wxgetresource}\\
 \helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
 \helpref{wxGetResource}{wxgetresource}\\
 \helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
 \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\


@@ -466,7 +467,7 @@ calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
 
 For asynchronous execution, however, the return value is the process id and
 zero value indicates that the command could not be executed. As an added
 
 For asynchronous execution, however, the return value is the process id and
 zero value indicates that the command could not be executed. As an added

-complication, the return value of $-1$ in this case indicattes that we didn't
+complication, the return value of $-1$ in this case indicates that we didn't

 launch a new process, but connected to the running one (this can only happen in
 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
 launch a new process, but connected to the running one (this can only happen in
 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


@@ -532,7 +533,7 @@ application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp}
 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
 
 Equivalent to the Unix kill function: send the given signal {\it sig} to the
 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
 
 Equivalent to the Unix kill function: send the given signal {\it sig} to the

-process with PID {\it pid}. The valud signal values are
+process with PID {\it pid}. The valid signal values are

 
 \begin{verbatim}
 enum wxSignal
 
 \begin{verbatim}
 enum wxSignal


@@ -584,6 +585,18 @@ enum wxKillError
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxGetProcessId}\label{wxgetprocessid}
+
+\func{unsigned long}{wxGetProcessId}{\void}
+
+Returns the number uniquely identifying the current process in the system.
+
+If an error occurs, $0$ is returned.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxShell}\label{wxshell}
 
 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
 \membersection{::wxShell}\label{wxshell}
 
 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}


@@ -814,7 +827,7 @@ TRUE if successful.
 
 Copies {\it file1} to {\it file2}, returning TRUE if successful. If
 {\it overwrite} parameter is TRUE (default), the destination file is overwritten
 
 Copies {\it file1} to {\it file2}, returning TRUE if successful. If
 {\it overwrite} parameter is TRUE (default), the destination file is overwritten

-if it exists, but if {\it overwrite} is FALSE, the functions failes in this
+if it exists, but if {\it overwrite} is FALSE, the functions fails in this

 case.
 
 \membersection{::wxGetCwd}\label{wxgetcwd}
 case.
 
 \membersection{::wxGetCwd}\label{wxgetcwd}


@@ -1372,11 +1385,13 @@ The application must check for an empty return value (the user pressed
 Cancel). For example:
 
 \begin{verbatim}
 Cancel). For example:
 
 \begin{verbatim}

-const wxString& s = wxFileSelector("Choose a file to open");
-if (s)
+wxString filename = wxFileSelector("Choose a file to open");
+if ( !filename.empty() )

 {
 {

-  ...
+    // work with the file
+    ...

 }
 }

+//else: cancelled by user

 \end{verbatim}
 
 \wxheading{Include files}
 \end{verbatim}
 
 \wxheading{Include files}


@@ -2160,6 +2175,9 @@ Find a menu item identifier associated with the given frame's menu bar.
 
 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
 
 
 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
 

+{\bf NB:} This function is obsolete, please use 
+\helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
+

 Find a window by its label. Depending on the type of window, the label may be a window title
 or panel item label. If {\it parent} is NULL, the search will start from all top-level
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
 Find a window by its label. Depending on the type of window, the label may be a window title
 or panel item label. If {\it parent} is NULL, the search will start from all top-level
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.


@@ -2173,6 +2191,9 @@ The search is recursive in both cases.
 
 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
 
 
 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
 

+{\bf NB:} This function is obsolete, please use 
+\helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
+

 Find a window by its name (as given in a window constructor or {\bf Create} function call).
 If {\it parent} is NULL, the search will start from all top-level
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
 Find a window by its name (as given in a window constructor or {\bf Create} function call).
 If {\it parent} is NULL, the search will start from all top-level
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.


@@ -2454,7 +2475,7 @@ data in big-endian format.
 
 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

-compatribility reasons but also because it allows some things which the
+compatibility reasons but also because it allows some things which the

 standard RTTI doesn't directly support (such as creating a class from its
 name).
 
 standard RTTI doesn't directly support (such as creating a class from its
 name).
 


@@ -3416,7 +3437,7 @@ compilation error messages if the condition they check fail.
 
 \membersection{::wxOnAssert}\label{wxonassert}
 
 
 \membersection{::wxOnAssert}\label{wxonassert}
 

-\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{msg = NULL}}
+\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}

 
 This function is called whenever one of debugging macros fails (i.e. condition
 is false in an assertion). It is only defined in the debug mode, in release
 
 This function is called whenever one of debugging macros fails (i.e. condition
 is false in an assertion). It is only defined in the debug mode, in release