X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9154d8cfff9f6a58ccec94bf242086e7e10ea91b..07b87e8d9b49b46bbe71d414feb35db2be278586:/docs/latex/wx/app.tex?ds=sidebyside

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index 94d63f9676..37214ede08 100644
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -32,12 +32,14 @@ a reference to your application object) to be visible to other files.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxApp::wxApp}
 
 \func{void}{wxApp}{\void}
 
 Constructor. Called implicitly with a definition of a wxApp object.
 
+
 \membersection{wxApp::\destruct{wxApp}}
 
 \func{void}{\destruct{wxApp}}{\void}
@@ -45,18 +47,21 @@ Constructor. Called implicitly with a definition of a wxApp object.
 Destructor. Will be called implicitly on program exit if the wxApp
 object is created on the stack.
 
+
 \membersection{wxApp::argc}\label{wxappargc}
 
 \member{int}{argc}
 
 Number of command line arguments (after environment-specific processing).
 
+
 \membersection{wxApp::argv}\label{wxappargv}
 
 \member{char **}{argv}
 
 Command line arguments (after environment-specific processing).
 
+
 \membersection{wxApp::CreateLogTarget}\label{wxappcreatelogtarget}
 
 \func{virtual wxLog*}{CreateLogTarget}{\void}
@@ -68,6 +73,7 @@ implementation returns a new wxLogGui class.
 
 \helpref{wxLog}{wxlog}
 
+
 \membersection{wxApp::Dispatch}\label{wxappdispatch}
 
 \func{void}{Dispatch}{\void}
@@ -85,17 +91,19 @@ This can be used for programming event loops, e.g.
 
 \helpref{wxApp::Pending}{wxapppending}
 
+
 \membersection{wxApp::FilterEvent}\label{wxappfilterevent}
 
 \func{int}{FilterEvent}{\param{wxEvent\& }{event}}
 
 This function is called before processing any event and allows the application
 to preempt the processing of some events. If this method returns $-1$ the event
-is processed normally, otherwise either {\tt TRUE} or {\tt FALSE} should be
+is processed normally, otherwise either {\tt true} or {\tt false} should be
 returned and the event processing stops immediately considering that the event
 had been already processed (for the former return value) or that it is not
 going to be processed at all (for the latter one).
 
+
 \membersection{wxApp::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
@@ -107,16 +115,18 @@ Returns the application name.
 wxWindows sets this to a reasonable default before
 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 
+
 \membersection{wxApp::GetAuto3D}\label{wxappgetauto3d}
 
 \constfunc{bool}{GetAuto3D}{\void}
 
-Returns TRUE if 3D control mode is on, FALSE otherwise.
+Returns true if 3D control mode is on, false otherwise.
 
 \wxheading{See also}
 
 \helpref{wxApp::SetAuto3D}{wxappsetauto3d}
 
+
 \membersection{wxApp::GetClassName}\label{wxappgetclassname}
 
 \constfunc{wxString}{GetClassName}{\void}
@@ -128,16 +138,19 @@ manner to refer to the application.
 
 \helpref{wxApp::SetClassName}{wxappsetclassname}
 
+
 \membersection{wxApp::GetExitOnFrameDelete}\label{wxappgetexitonframedelete}
 
-\constfunc{bool}{GetExitFrameOnDelete}{\void}
+\constfunc{bool}{GetExitOnFrameDelete}{\void}
 
-Returns TRUE if the application will exit when the top-level window is deleted, FALSE
+Returns true if the application will exit when the top-level window is deleted, false
 otherwise.
 
 \wxheading{See also}
 
-\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete}
+\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete},\\
+\helpref{wxApp shutdown overview}{wxappshutdownoverview}
+
 
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 
@@ -154,23 +167,26 @@ function will find the first top-level window (frame or dialog) and return that.
 
 \helpref{SetTopWindow}{wxappsettopwindow}
 
+
 \membersection{wxApp::GetUseBestVisual}\label{wxappgetusebestvisual}
 
 \constfunc{bool}{GetUseBestVisual}{\void}
 
-Returns TRUE if the application will use the best visual on systems that support
-different visuals, FALSE otherwise.
+Returns true if the application will use the best visual on systems that support
+different visuals, false otherwise.
 
 \wxheading{See also}
 
 \helpref{SetUseBestVisual}{wxappsetusebestvisual}
 
+
 \membersection{wxApp::GetVendorName}\label{wxappgetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}
 
 Returns the application's vendor name.
 
+
 \membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
 
 \func{void}{ExitMainLoop}{\void}
@@ -179,15 +195,6 @@ Call this to explicitly exit the main message (event) loop.
 You should normally exit the main loop (and the application) by deleting
 the top window.
 
-\membersection{wxApp::Initialized}\label{wxappinitialized}
-
-\func{bool}{Initialized}{\void}
-
-Returns TRUE if the application has been initialized (i.e. if\rtfsp
-\helpref{wxApp::OnInit}{wxapponinit} has returned successfully).  This can be useful for error
-message routines to determine which method of output is best for the
-current state of the program (some windowing systems may not like
-dialogs to pop up before the main loop has been entered).
 
 \membersection{wxApp::MainLoop}\label{wxappmainloop}
 
@@ -236,12 +243,13 @@ Returns 0 under X, and the wParam of the WM\_QUIT message under Windows.
 %%\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnChar}{wxwindowonchar},\rtfsp
 %%\helpref{wxWindow::OnCharHook}{wxwindowoncharhook}, \helpref{wxDialog::OnCharHook}{wxdialogoncharhook}
 
+
 \membersection{wxApp::OnAssert}\label{wxapponassert}
 
-\func{void}{OnAssert}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*msg}}
+\func{void}{OnAssert}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*cond}, \param{const wxChar }{*msg}}
 
 This function is called when an assert failure occurs, i.e. the condition
-specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt FALSE}.
+specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt false}.
 It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) as
 asserts are not left in the release code at all.
 
@@ -254,17 +262,13 @@ the user to stop the program, continue or ignore all subsequent asserts.
 
 \docparam{line}{the line number in this file where the assert occured}
 
+\docparam{cond}{the condition of the failed assert in string form}
+
 \docparam{msg}{the message specified as argument to 
 \helpref{wxASSERT\_MSG}{wxassertmsg} or \helpref{wxFAIL\_MSG}{wxfailmsg}, will
 be {\tt NULL} if just \helpref{wxASSERT}{wxassert} or \helpref{wxFAIL}{wxfail} 
 was used}
 
-\membersection{wxApp::OnExit}\label{wxapponexit}
-
-\func{int}{OnExit}{\void}
-
-Provide this member function for any processing which needs to be done as
-the application is about to exit.
 
 \membersection{wxApp::OnCmdLineError}\label{wxapponcmdlineerror}
 
@@ -274,13 +278,14 @@ Called when command line parsing fails (i.e. an incorrect command line option
 was specified by the user). The default behaviour is to show the program usage
 text and abort the program.
 
-Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return 
-{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
+Return {\tt true} to continue normal execution or {\tt false} to return 
+{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program.
 
 \wxheading{See also}
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
+
 \membersection{wxApp::OnCmdLineHelp}\label{wxapponcmdlinehelp}
 
 \func{bool}{OnCmdLineHelp}{\param{wxCmdLineParser\& }{parser}}
@@ -288,13 +293,14 @@ Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
 Called when the help option ({\tt --help}) was specified on the command line.
 The default behaviour is to show the program usage text and abort the program.
 
-Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return 
-{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
+Return {\tt true} to continue normal execution or {\tt false} to return 
+{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program.
 
 \wxheading{See also}
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
+
 \membersection{wxApp::OnCmdLineParsed}\label{wxapponcmdlineparsed}
 
 \func{bool}{OnCmdLineParsed}{\param{wxCmdLineParser\& }{parser}}
@@ -306,13 +312,24 @@ set from the command line.
 Don't forget to call the base class version unless you want to suppress
 processing of the standard command line options.
 
-Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return 
-{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
+Return {\tt true} to continue normal execution or {\tt false} to return 
+{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program.
 
 \wxheading{See also}
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
+
+\membersection{wxApp::OnExit}\label{wxapponexit}
+
+\func{int}{OnExit}{\void}
+
+Provide this member function for any processing which needs to be
+done as the application is about to exit. OnExit is called after
+destroying all application windows and controls, but before
+wxWindows cleanup.
+
+
 \membersection{wxApp::OnFatalException}\label{wxapponfatalexception}
 
 \func{void}{OnFatalException}{\void}
@@ -345,7 +362,7 @@ work and, in fact, probably won't.
 %%application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself
 %%sends an OnIdle event to each application window, allowing windows to do idle processing such as updating
 %%their appearance. If either wxApp::OnIdle or a window OnIdle function requested more time, by
-%%caling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
+%%calling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
 %%event to the application object. This will occur in a loop until either a user event is found to be
 %%pending, or OnIdle requests no more time. Then all pending user events are processed until the system
 %%goes idle again, when OnIdle is called, and so on.
@@ -365,7 +382,7 @@ work and, in fact, probably won't.
 %%
 %%Use the EVT\_END\_SESSION event table macro to handle query end session events.
 %%
-%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE argument
+%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a true argument
 %%(forcing the application to close itself silently).
 %%
 %%\wxheading{Remarks}
@@ -381,6 +398,7 @@ work and, in fact, probably won't.
 %%\helpref{wxCloseEvent}{wxcloseevent},\rtfsp
 %%\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession}
 
+
 \membersection{wxApp::OnInit}\label{wxapponinit}
 
 \func{bool}{OnInit}{\void}
@@ -393,7 +411,8 @@ Notice that if you want to to use the command line processing provided by
 wxWindows you have to call the base class version in the derived class
 OnInit().
 
-Return TRUE to continue processing, FALSE to exit the application.
+Return true to continue processing, false to exit the application.
+
 
 \membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline}
 
@@ -403,6 +422,7 @@ Called from \helpref{OnInit}{wxapponinit} and may be used to initialize the
 parser with the command line options for this application. The base class
 versions adds support for a few standard options only.
 
+
 \membersection{wxApp::OnQueryEndSession}\label{wxapponqueryendsession}
 
 \func{void}{OnQueryEndSession}{\param{wxCloseEvent\& }{event}}
@@ -411,7 +431,7 @@ This is an event handler function called when the operating system or GUI sessio
 about to close down. Typically, an application will try to save unsaved documents
 at this point.
 
-If \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns TRUE, the application
+If \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns true, the application
 is allowed to veto the shutdown by calling \helpref{wxCloseEvent::Veto}{wxcloseeventveto}.
 The application might veto the shutdown after prompting for documents to be saved, and the
 user has cancelled the save.
@@ -419,12 +439,12 @@ user has cancelled the save.
 Use the EVT\_QUERY\_END\_SESSION event table macro to handle query end session events.
 
 You should check whether the application is forcing the deletion of the window
-using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is TRUE,
+using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is true,
 destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
 If not, it is up to you whether you respond by destroying the window.
 
 The default handler calls \helpref{wxWindow::Close}{wxwindowclose} on the top-level window,
-and vetoes the shutdown if Close returns FALSE. This will be sufficient for many applications.
+and vetoes the shutdown if Close returns false. This will be sufficient for many applications.
 
 \wxheading{Remarks}
 
@@ -439,61 +459,87 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 %% GD: OnXXX functions are not documented
 %%\helpref{wxApp::OnEndSession}{wxapponendsession}
 
+
+\membersection{wxApp::OnRun}\label{wxapponrun}
+
+\func{virtual int}{OnRun}{\void}
+
+This virtual function is where the execution of a program written in wxWindows
+starts. The default implementation just enters the main loop and starts
+handling the events until it terminates, either because 
+\helpref{ExitMainLoop}{wxappexitmainloop} has been explicitly called or because
+the last frame has been deleted and 
+\helpref{GetExitOnFrameDelete}{wxappgetexitonframedelete} flag is \true (this
+is the default).
+
+
+\membersection{wxApp::OnUnhandledException}\label{wxapponunhandledexception}
+
+\func{virtual void}{OnUnhandledException}{\void}
+
+This function is called when an unhandled C++ exception occurs inside 
+\helpref{OnRun()}{wxapponrun} (the exceptions which occur during the program
+startup and shutdown might not be caught at all).
+Note that the exception type is lost by now, so if you want to really handle
+the exception you should override \helpref{OnRun()}{wxapponrun} and put a
+try/catch clause around the call to the base class version there.
+
+
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 
-\func{bool}{ProcessMessage}{\param{MSG *}{msg}}
+\func{bool}{ProcessMessage}{\param{WXMSG *}{msg}}
 
 Windows-only function for processing a message. This function
 is called from the main message loop, checking for windows that
-may wish to process it. The function returns TRUE if the message
-was processed, FALSE otherwise. If you use wxWindows with another class
+may wish to process it. The function returns true if the message
+was processed, false otherwise. If you use wxWindows with another class
 library with its own message loop, you should make sure that this
 function is called to allow wxWindows to receive messages. For example,
-to allow co-existance with the Microsoft Foundation Classes, override
+to allow co-existence with the Microsoft Foundation Classes, override
 the PreTranslateMessage function:
 
 \begin{verbatim}
 // Provide wxWindows message loop compatibility
 BOOL CTheApp::PreTranslateMessage(MSG *msg)
 {
-  if (wxTheApp && wxTheApp->ProcessMessage(msg))
-    return TRUE;
+  if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
+    return true;
   else
     return CWinApp::PreTranslateMessage(msg);
 }
 \end{verbatim}
 
+
 \membersection{wxApp::Pending}\label{wxapppending}
 
 \func{bool}{Pending}{\void}
 
-Returns TRUE if unprocessed events are in the window system event queue.
+Returns true if unprocessed events are in the window system event queue.
 
 \wxheading{See also}
 
 \helpref{wxApp::Dispatch}{wxappdispatch}
 
-\membersection{wxApp::SendIdleEvents}\label{wxappsendidleevents}
-
-\func{bool}{SendIdleEvents}{\void}
 
-Sends idle events to all top-level windows.
+\membersection{wxApp::SendIdleEvents}\label{wxappsendidleevents}
 
-\func{bool}{SendIdleEvents}{\param{wxWindow*}{ win}}
+\func{bool}{SendIdleEvents}{\param{wxWindow*}{ win}, \param{wxIdleEvent\& }{event}}
 
 Sends idle events to a window and its children.
 
+Please note that this function is internal to wxWindows and shouldn't be used
+by user code.
+
 \wxheading{Remarks}
 
 These functions poll the top-level windows, and their children, for idle event processing.
-If TRUE is returned, more OnIdle processing is requested by one or more window.
+If true is returned, more OnIdle processing is requested by one or more window.
 
 \wxheading{See also}
 
-%% GD: OnXXX functions are not documented
-%%\helpref{wxApp::OnIdle}{wxapponidle}
 \helpref{wxIdleEvent}{wxidleevent}
 
+
 \membersection{wxApp::SetAppName}\label{wxappsetappname}
 
 \func{void}{SetAppName}{\param{const wxString\& }{name}}
@@ -506,6 +552,7 @@ wxWindows.
 
 \helpref{wxApp::GetAppName}{wxappgetappname}
 
+
 \membersection{wxApp::SetAuto3D}\label{wxappsetauto3d}
 
 \func{void}{SetAuto3D}{\param{const bool}{ auto3D}}
@@ -514,8 +561,8 @@ Switches automatic 3D controls on or off.
 
 \wxheading{Parameters}
 
-\docparam{auto3D}{If TRUE, all controls will be created with 3D appearances unless
-overridden for a control or dialog. The default is TRUE}
+\docparam{auto3D}{If true, all controls will be created with 3D appearances unless
+overridden for a control or dialog. The default is true}
 
 \wxheading{Remarks}
 
@@ -525,6 +572,7 @@ This has an effect on Windows only.
 
 \helpref{wxApp::GetAuto3D}{wxappgetauto3d}
 
+
 \membersection{wxApp::SetClassName}\label{wxappsetclassname}
 
 \func{void}{SetClassName}{\param{const wxString\& }{name}}
@@ -536,6 +584,7 @@ manner to refer to the application.
 
 \helpref{wxApp::GetClassName}{wxappgetclassname}
 
+
 \membersection{wxApp::SetExitOnFrameDelete}\label{wxappsetexitonframedelete}
 
 \func{void}{SetExitOnFrameDelete}{\param{bool}{ flag}}
@@ -545,8 +594,14 @@ top-level frame is deleted.
 
 \wxheading{Parameters}
 
-\docparam{flag}{If TRUE (the default), the application will exit when the top-level frame is
-deleted. If FALSE, the application will continue to run.}
+\docparam{flag}{If true (the default), the application will exit when the top-level frame is
+deleted. If false, the application will continue to run.}
+
+\wxheading{See also}
+
+\helpref{wxApp::GetExitOnFrameDelete}{wxappgetexitonframedelete},\\
+\helpref{wxApp shutdown overview}{wxappshutdownoverview}
+
 
 \membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
 
@@ -568,6 +623,7 @@ needs to use the top window.
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 
 
+
 \membersection{wxApp::SetVendorName}\label{wxappsetvendorname}
 
 \func{void}{SetVendorName}{\param{const wxString\& }{name}}
@@ -580,6 +636,7 @@ wxWindows.
 
 \helpref{wxApp::GetVendorName}{wxappgetvendorname}
 
+
 \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
 
 \func{void}{SetUseBestVisual}{\param{bool}{ flag}}
@@ -587,7 +644,7 @@ wxWindows.
 Allows the programmer to specify whether the application will use the best visual
 on systems that support several visual on the same display. This is typically the
 case under Solaris and IRIX, where the default visual is only 8-bit whereas certain
-appications are supposed to run in TrueColour mode.
+applications are supposed to run in TrueColour mode.
 
 Note that this function has to be called in the constructor of the {\tt wxApp} 
 instance and won't have any effect when called later on.
@@ -596,11 +653,23 @@ This function currently only has effect under GTK.
 
 \wxheading{Parameters}
 
-\docparam{flag}{If TRUE, the app will use the best visual.}
+\docparam{flag}{If true, the app will use the best visual.}
+
+
+\membersection{wxApp::HandleEvent}\label{wxapphandleevent}
+
+\constfunc{virtual void}{HandleEvent}{\param{wxEvtHandler}{ *handler}, \param{wxEventFunction}{ func}, \param{wxEvent\& }{event}}
+
+This function simply invokes the given method \arg{func} of the specified
+event handler \arg{handler} with the \arg{event} as parameter. It exists solely
+to allow to catch the C++ exceptions which could be thrown by all event
+handlers in the application in one place: if you want to do this, override this
+function in your wxApp-derived class and add try/catch clause(s) to it.
+
 
 \membersection{wxApp::Yield}\label{wxappyield}
 
-\func{bool}{Yield}{\param{bool}{ onlyIfNeeded = FALSE}}
+\func{bool}{Yield}{\param{bool}{ onlyIfNeeded = false}}
 
 Yields control to pending messages in the windowing system. This can be useful, for example, when a
 time-consuming process writes to a text window. Without an occasional
@@ -621,6 +690,6 @@ iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
 
 Calling Yield() recursively is normally an error and an assert failure is
 raised in debug build if such situation is detected. However if the the 
-{\it onlyIfNeeded} parameter is {\tt TRUE}, the method will just silently
-return {\tt FALSE} instead.
+{\it onlyIfNeeded} parameter is {\tt true}, the method will just silently
+return {\tt false} instead.
 
