the find dialog is created hidden, as all the other top level windows, but the docs...

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 33ee4e679e266a408f201769144d6c3b6e7df278..3a137b085c28e63fa8931594a82fe851601fefc0 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -30,12 +30,14 @@ the corresponding topic.
 \helpref{wxBITMAP}{wxbitmapmacro}\\
 \helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
 \helpref{wxBell}{wxbell}\\
 \helpref{wxBITMAP}{wxbitmapmacro}\\
 \helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
 \helpref{wxBell}{wxbell}\\

+\helpref{wxCHECK}{wxcheck}\\

 \helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
 \helpref{wxCHECK2}{wxcheck2}\\
 \helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
 \helpref{wxCHECK2}{wxcheck2}\\

+\helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}\\

 \helpref{wxCHECK\_MSG}{wxcheckmsg}\\
 \helpref{wxCHECK\_RET}{wxcheckret}\\
 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\
 \helpref{wxCHECK\_MSG}{wxcheckmsg}\\
 \helpref{wxCHECK\_RET}{wxcheckret}\\
 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\

-\helpref{wxCHECK}{wxcheck}\\
+\helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\

 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
 \helpref{wxClipboardOpen}{functionwxclipboardopen}\\
 \helpref{wxCloseClipboard}{wxcloseclipboard}\\
 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
 \helpref{wxClipboardOpen}{functionwxclipboardopen}\\
 \helpref{wxCloseClipboard}{wxcloseclipboard}\\


@@ -67,6 +69,7 @@ the corresponding topic.
 \helpref{wxError}{wxerror}\\
 \helpref{wxExecute}{wxexecute}\\
 \helpref{wxExit}{wxexit}\\
 \helpref{wxError}{wxerror}\\
 \helpref{wxExecute}{wxexecute}\\
 \helpref{wxExit}{wxexit}\\

+\helpref{wxEXPLICIT}{wxexplicit}\\

 \helpref{wxFAIL\_MSG}{wxfailmsg}\\
 \helpref{wxFAIL}{wxfail}\\
 \helpref{wxFatalError}{wxfatalerror}\\
 \helpref{wxFAIL\_MSG}{wxfailmsg}\\
 \helpref{wxFAIL}{wxfail}\\
 \helpref{wxFatalError}{wxfatalerror}\\


@@ -114,6 +117,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}\\


@@ -151,6 +155,8 @@ the corresponding topic.
 \helpref{wxLogTrace}{wxlogtrace}\\
 \helpref{wxLogVerbose}{wxlogverbose}\\
 \helpref{wxLogWarning}{wxlogwarning}\\
 \helpref{wxLogTrace}{wxlogtrace}\\
 \helpref{wxLogVerbose}{wxlogverbose}\\
 \helpref{wxLogWarning}{wxlogwarning}\\

+\helpref{wxLL}{wxll}\\
+\helpref{wxLongLongFmtSpec}{wxlonglongfmtspec}\\

 \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
 \helpref{wxMatchWild}{wxmatchwild}\\
 \helpref{wxMessageBox}{wxmessagebox}\\
 \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
 \helpref{wxMatchWild}{wxmatchwild}\\
 \helpref{wxMessageBox}{wxmessagebox}\\


@@ -180,6 +186,7 @@ the corresponding topic.
 \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
 \helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
 \helpref{wxRmdir}{wxrmdir}\\
 \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
 \helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
 \helpref{wxRmdir}{wxrmdir}\\

+\helpref{wxSafeShowMessage}{wxsafeshowmessage}\\

 \helpref{wxSafeYield}{wxsafeyield}\\
 \helpref{wxSetClipboardData}{wxsetclipboarddata}\\
 \helpref{wxSetCursor}{wxsetcursor}\\
 \helpref{wxSafeYield}{wxsafeyield}\\
 \helpref{wxSetClipboardData}{wxsetclipboarddata}\\
 \helpref{wxSetCursor}{wxsetcursor}\\


@@ -196,6 +203,7 @@ the corresponding topic.
 \helpref{wxSetWorkingDirectory}{wxsetworkingdirectory}\\
 \helpref{wxShell}{wxshell}\\
 \helpref{wxShowTip}{wxshowtip}\\
 \helpref{wxSetWorkingDirectory}{wxsetworkingdirectory}\\
 \helpref{wxShell}{wxshell}\\
 \helpref{wxShowTip}{wxshowtip}\\

+\helpref{wxShutdown}{wxshutdown}\\

 \helpref{wxSleep}{wxsleep}\\
 \helpref{wxSnprintf}{wxsnprintf}\\
 \helpref{wxSplitPath}{wxsplitfunction}\\
 \helpref{wxSleep}{wxsleep}\\
 \helpref{wxSnprintf}{wxsnprintf}\\
 \helpref{wxSplitPath}{wxsplitfunction}\\


@@ -268,6 +276,22 @@ the following can be done:
     }
 \end{verbatim}
 
     }
 \end{verbatim}
 

+\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion}
+
+\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
+
+Returns $1$ if the compiler being used to compile the code is GNU C++
+compiler (g++) version major.minor.release or greater. Otherwise, and also if
+the compiler is not GNU C++ at all, returns $0$.
+
+\membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion}
+
+\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
+
+Returns $1$ if the version of w32api headers used is major.minor.release or
+greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
+Win32 at all, returns $0$.
+

 \section{Application initialization and termination}\label{appinifunctions}
 
 The functions in this section are used on application startup/shutdown and also
 \section{Application initialization and termination}\label{appinifunctions}
 
 The functions in this section are used on application startup/shutdown and also


@@ -365,7 +389,8 @@ call to this function.
 
 \membersection{::wxSafeYield}\label{wxsafeyield}
 
 
 \membersection{::wxSafeYield}\label{wxsafeyield}
 

-\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{
+    onlyIfNeeded = FALSE}}

 
 This function is similar to wxYield, except that it disables the user input to
 all program windows before calling wxYield and re-enables it again
 
 This function is similar to wxYield, except that it disables the user input to
 all program windows before calling wxYield and re-enables it again


@@ -395,8 +420,8 @@ once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
 
 Calls \helpref{wxApp::Yield}{wxappyield}.
 
 
 Calls \helpref{wxApp::Yield}{wxappyield}.
 

-This function is kept only for backwards compatibility, please use 
-\helpref{wxApp::Yield}{wxappyield}method instead in any new code.
+This function is kept only for backwards compatibility. Please use
+the \helpref{wxApp::Yield}{wxappyield} method instead in any new code.

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


@@ -464,16 +489,16 @@ 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
 process termination.
 
 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
 process termination.
 

-If callback isn't NULL and if execution is asynchronous, 
+If callback isn't NULL and if execution is asynchronous,

 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 the process finishes. Specifying this parameter also allows you to redirect the
 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 the process finishes. Specifying this parameter also allows you to redirect the

-standard input and/or output of the process being launched by calling 
+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
 \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


@@ -503,7 +528,7 @@ single string.}
 array, any additional ones are the command parameters and the array must be
 terminated with a NULL pointer.}
 
 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}, 
+\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}}
 {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
 
 \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}


@@ -530,7 +555,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


@@ -582,6 +607,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}}


@@ -595,6 +632,26 @@ See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxShutdown}\label{wxshutdown}
+
+\func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
+
+This function shuts down or reboots the computer depending on the value of the
+{\it flags}. Please notice that doing this requires the corresponding access
+rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
+and that this function is only implemented under Unix and Win32.
+
+\wxheading{Parameters}
+
+\docparam{flags}{Either {\tt wxSHUTDOWN\_POWEROFF} or {\tt wxSHUTDOWN\_REBOOT}}
+
+\wxheading{Returns}
+
+{\tt TRUE} on success, {\tt FALSE} if an error occured.
+
+\wxheading{Include files}
+
+<wx/utils.h>

 
 \section{Thread functions}\label{threadfunctions}
 
 
 \section{Thread functions}\label{threadfunctions}
 


@@ -693,6 +750,9 @@ Returns time of last modification of given file.
 
 \func{char *}{wxFileNameFromPath}{\param{char *}{path}}
 
 
 \func{char *}{wxFileNameFromPath}{\param{char *}{path}}
 

+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
+

 Returns the filename for a full path. The second form returns a pointer to
 temporary storage that should not be deallocated.
 
 Returns the filename for a full path. The second form returns a pointer to
 temporary storage that should not be deallocated.
 


@@ -789,7 +849,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}


@@ -802,7 +862,7 @@ Returns a string containing the current (or working) directory.
 
 \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
 
 
 \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
 

-This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
+{\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.

 
 Copies the current working directory into the buffer if supplied, or
 copies the working directory into new storage (which you must delete yourself)
 
 Copies the current working directory into the buffer if supplied, or
 copies the working directory into new storage (which you must delete yourself)


@@ -826,7 +886,7 @@ if the buffer is NULL.
 %%
 %% It is the application's responsibility to create and delete the file.
 
 %%
 %% It is the application's responsibility to create and delete the file.
 

-These functions are obsolete, please use\rtfsp
+{\bf NB:} These functions are obsolete, please use\rtfsp

 \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
 instead.
 
 \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
 instead.
 


@@ -884,6 +944,9 @@ Under MS Windows, the current drive is also changed if {\it dir} contains a driv
 
 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
 
 
 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
 

+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
+

 This function splits a full file name into components: the path (including possible disk/drive
 specification under Windows), the base name and the extension. Any of the output parameters
 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
 This function splits a full file name into components: the path (including possible disk/drive
 specification under Windows), the base name and the extension. Any of the output parameters
 ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of


@@ -1083,7 +1146,7 @@ Gets operating system version information.
 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
 
 Returns the home directory for the given user. If the username is empty
 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
 
 Returns the home directory for the given user. If the username is empty

-(default value), this function behaves like 
+(default value), this function behaves like

 \helpref{wxGetHomeDir}{wxgethomedir}.
 
 \wxheading{Include files}
 \helpref{wxGetHomeDir}{wxgethomedir}.
 
 \wxheading{Include files}


@@ -1148,24 +1211,24 @@ case-sensitive comparison.
 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
   \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
 
 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
   \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
 

+{\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+

 Returns {\tt TRUE} if the substring {\it s1} is found within {\it s2},
 ignoring case if {\it exact} is FALSE. If {\it subString} is {\tt FALSE},
 no substring matching is done.
 
 Returns {\tt TRUE} if the substring {\it s1} is found within {\it s2},
 ignoring case if {\it exact} is FALSE. If {\it subString} is {\tt FALSE},
 no substring matching is done.
 

-This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
-

 \membersection{::wxStringEq}\label{wxstringeq}
 
 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
 
 \membersection{::wxStringEq}\label{wxstringeq}
 
 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
 

+{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
+

 A macro defined as:
 
 \begin{verbatim}
 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
 \end{verbatim}
 
 A macro defined as:
 
 \begin{verbatim}
 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
 \end{verbatim}
 

-This function is obsolete, use \helpref{wxString}{wxstring} instead.
-

 \membersection{::wxStrlen}\label{wxstrlen}
 
 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}
 \membersection{::wxStrlen}\label{wxstrlen}
 
 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}


@@ -1344,11 +1407,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}


@@ -1690,7 +1755,8 @@ The symbols are not shown when the generic function is used.
  \param{wxTipProvider *}{tipProvider},
  \param{bool }{showAtStartup = TRUE}}
 
  \param{wxTipProvider *}{tipProvider},
  \param{bool }{showAtStartup = TRUE}}
 

-This function shows a "startup tip" to the user.
+This function shows a "startup tip" to the user. The return value is the
+state of the ``Show tips at startup'' checkbox.

 
 \docparam{parent}{The parent window for the modal dialog}
 
 
 \docparam{parent}{The parent window for the modal dialog}
 


@@ -1843,7 +1909,7 @@ See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowset
 
 \section{Printer settings}\label{printersettings}
 
 
 \section{Printer settings}\label{printersettings}
 

-These routines are obsolete and should no longer be used!
+{\bf NB:} These routines are obsolete and should no longer be used!

 
 The following functions are used to control PostScript printing. Under
 Windows, PostScript output can only be sent to a file.
 
 The following functions are used to control PostScript printing. Under
 Windows, PostScript output can only be sent to a file.


@@ -2057,6 +2123,51 @@ The clipboard must have previously been opened for this call to succeed.
 
 \section{Miscellaneous functions}\label{miscellany}
 
 
 \section{Miscellaneous functions}\label{miscellany}
 

+\membersection{wxEXPLICIT}\label{wxexplicit}
+
+{\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
+the compiler supports it or nothing otherwise. Thus, it can be used even in the
+code which might have to be compiled with an old compiler without support for
+this language feature but still take advantage of it when it is available.
+
+\membersection{wxLL}\label{wxll}
+
+\func{wxLongLong\_t}{wxLL}{\param{}{number}}
+
+This macro is defined for the platforms with a native 64 bit integer type and
+allows to define 64 bit compile time constants:
+
+\begin{verbatim}
+    #ifdef wxLongLong_t
+        wxLongLong_t ll = wxLL(0x1234567890abcdef);
+    #endif
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/longlong.h>
+
+\membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
+
+This macro is defined to contain the {\tt printf()} format specifier using
+which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
+printed. Example of using it:
+
+\begin{verbatim}
+    #ifdef wxLongLong_t
+        wxLongLong_t ll = wxLL(0x1234567890abcdef);
+        printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
+    #endif
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{wxLL}{wxll}
+
+\wxheading{Include files}
+
+<wx/longlong.h>
+

 \membersection{::wxNewId}\label{wxnewid}
 
 \func{long}{wxNewId}{\void}
 \membersection{::wxNewId}\label{wxnewid}
 
 \func{long}{wxNewId}{\void}


@@ -2132,6 +2243,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.


@@ -2145,6 +2259,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.


@@ -2320,7 +2437,7 @@ See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
 
 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
 
 
 \func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
 

-This function is obsolete, please use 
+{\bf NB:} This function is obsolete, please use

 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
 
 Strips any menu codes from {\it in} and places the result
 \helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
 
 Strips any menu codes from {\it in} and places the result


@@ -2426,7 +2543,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).
 


@@ -2518,7 +2635,7 @@ class wxFrame: public wxWindow
   DECLARE_DYNAMIC_CLASS(wxFrame)
 
  private:
   DECLARE_DYNAMIC_CLASS(wxFrame)
 
  private:

-  const wxString\& frameTitle;
+  const wxString& frameTitle;

  public:
   ...
 };
  public:
   ...
 };


@@ -2760,7 +2877,7 @@ loading from resource data.
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp

-\tt{#}defining a name to an integer). Unlikely to be used by an application except
+{\tt\#}defining a name to an integer). Unlikely to be used by an application except

 perhaps for implementing resource functionality for interpreted languages.
 
 \membersection{::wxResourceClear}\label{wxresourceclear}
 perhaps for implementing resource functionality for interpreted languages.
 
 \membersection{::wxResourceClear}\label{wxresourceclear}


@@ -2926,7 +3043,7 @@ load an entire {\tt .wxr file} into a string.
 
 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
 
 
 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
 

-Makes \tt{#}included XBM or XPM bitmap data known to the wxWindows resource system.
+Makes {\tt\#}included XBM or XPM bitmap data known to the wxWindows resource system.

 This is required if other resources will use the bitmap data, since otherwise there
 is no connection between names used in resources, and the global bitmap data.
 
 This is required if other resources will use the bitmap data, since otherwise there
 is no connection between names used in resources, and the global bitmap data.
 


@@ -2949,7 +3066,8 @@ standard one (installed by wxWindows in the beginning of the program).
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 

-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log
+functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.

 
 Display a debugging message; under Windows, this will appear on the
 debugger command window, and under Unix, it will be written to standard
 
 Display a debugging message; under Windows, this will appear on the
 debugger command window, and under Unix, it will be written to standard


@@ -2964,8 +3082,6 @@ each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
 (at least for Watcom C++): preformat your messages and use OutputDebugString
 instead.
 
 (at least for Watcom C++): preformat your messages and use OutputDebugString
 instead.
 

-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-

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


@@ -2974,7 +3090,7 @@ This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}
 
 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
 
 
 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
 

-This function is now obsolete, please use \helpref{wxLogError}{wxlogerror} 
+{\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}

 instead.
 
 Displays {\it msg} and continues. This writes to standard error under
 instead.
 
 Displays {\it msg} and continues. This writes to standard error under


@@ -2989,7 +3105,7 @@ wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
 
 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
 
 
 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
 

-This function is now obsolete, please use 
+{\bf NB:} This function is now obsolete, please use

 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
 
 Displays {\it msg} and exits. This writes to standard error under Unix,
 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
 
 Displays {\it msg} and exits. This writes to standard error under Unix,


@@ -3147,6 +3263,32 @@ trace masks.
 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
 \end{itemize}
 
 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
 \end{itemize}
 

+\membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
+
+\func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
+
+This function shows a message to the user in a safe way and should be safe to
+call even before the application has been initialized or if it is currently in
+some other strange state (for example, about to crash). Under Windows this
+function shows a message box using a native dialog instead of
+\helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
+it simply prints the message to the standard output using the title as prefix.
+
+\wxheading{Parameters}
+
+\docparam{title}{The title of the message box shown to the user or the prefix
+of the message string}
+
+\docparam{text}{The text to show to the user}
+
+\wxheading{See also}
+
+\helpref{wxLogFatalError}{wxlogfatalerror}
+
+\wxheading{Include files}
+
+<wx/log.h>
+

 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
 
 \func{unsigned long}{wxSysErrorCode}{\void}
 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
 
 \func{unsigned long}{wxSysErrorCode}{\void}


@@ -3180,11 +3322,11 @@ Returns the error message corresponding to the given system error code. If
 
 \func{}{WXTRACE}{formatString, ...}
 
 
 \func{}{WXTRACE}{formatString, ...}
 

+{\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+

 Calls wxTrace with printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 
 Calls wxTrace with printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 

-This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-

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


@@ -3193,14 +3335,14 @@ This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 
 \func{}{WXTRACELEVEL}{level, formatString, ...}
 
 
 \func{}{WXTRACELEVEL}{level, formatString, ...}
 

+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+

 Calls wxTraceLevel with printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 The first argument should be the level at which this information is appropriate.
 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
 this value.
 
 Calls wxTraceLevel with printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 The first argument should be the level at which this information is appropriate.
 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
 this value.
 

-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-

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


@@ -3209,11 +3351,11 @@ This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}
 
 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
 
 
 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
 

+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+

 Takes printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 
 Takes printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 

-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-

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


@@ -3222,14 +3364,14 @@ This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}
 
 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
 
 
 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
 

+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+

 Takes printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 The first argument should be the level at which this information is appropriate.
 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
 this value.
 
 Takes printf-style variable argument syntax. Output
 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
 The first argument should be the level at which this information is appropriate.
 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
 this value.
 

-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-

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


@@ -3275,14 +3417,14 @@ Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
 
 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
 
 
 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
 

-\func{wxLongLone}{wxGetLocalTimeMillis}{\void}
+\func{wxLongLong}{wxGetLocalTimeMillis}{\void}

 
 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
 
 \wxheading{See also}
 
 \helpref{wxDateTime::Now}{wxdatetimenow},\\
 
 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
 
 \wxheading{See also}
 
 \helpref{wxDateTime::Now}{wxdatetimenow},\\

-\helpref{wxLongLone}{wxlonglong}
+\helpref{wxLongLong}{wxlonglong}

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


@@ -3363,7 +3505,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


@@ -3371,7 +3513,7 @@ builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.
 
 To override the default behaviour in the debug builds which is to show the user
 a dialog asking whether he wants to abort the program, continue or continue
 
 To override the default behaviour in the debug builds which is to show the user
 a dialog asking whether he wants to abort the program, continue or continue

-ignoring any subsequent assert failures, you may override 
+ignoring any subsequent assert failures, you may override

 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
 the global application object exists.
 
 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
 the global application object exists.
 


@@ -3394,7 +3536,7 @@ because it will not be executed in release mode at all.
 
 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
 
 
 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
 

-This macro results in a 
+This macro results in a

 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
 of the given type {\it type} is less than {\it size} bits.
 
 \helpref{compile time assertion failure}{wxcompiletimeassert} if the size
 of the given type {\it type} is less than {\it size} bits.
 


@@ -3428,14 +3570,14 @@ specified {\it condition} is false. The compiler error message should include
 the {\it msg} identifier - please note that it must be a valid C++ identifier
 and not a string unlike in the other cases.
 
 the {\it msg} identifier - please note that it must be a valid C++ identifier
 and not a string unlike in the other cases.
 

-This macro is mostly useful for testing the expressions involing the 
+This macro is mostly useful for testing the expressions involving the

 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
 sometimes desirable to test them at the compile time.
 
 Note that this macro internally declares a struct whose name it tries to make
 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
 use it on the same line in two different source files. In this case you may
 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
 sometimes desirable to test them at the compile time.
 
 Note that this macro internally declares a struct whose name it tries to make
 unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
 use it on the same line in two different source files. In this case you may

-either change the line in which either of them appears on or use the 
+either change the line in which either of them appears on or use the

 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
 
 \wxheading{See also}
 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
 
 \wxheading{See also}


@@ -3447,7 +3589,7 @@ either change the line in which either of them appears on or use the
 
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
 
 
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
 

-This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} 
+This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}

 except that it allows you to specify a unique {\it name} for the struct
 internally defined by this macro to avoid getting the compilation errors
 described \helpref{above}{wxcompiletimeassert}.
 except that it allows you to specify a unique {\it name} for the struct
 internally defined by this macro to avoid getting the compilation errors
 described \helpref{above}{wxcompiletimeassert}.