X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4c39aa3a6582f06a4aae8023ad1c2c862b1ab35d..395a82b13fa5f316d2d0dead17701e9bc23337d3:/docs/latex/wx/app.tex

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index 3691e53d1c..d02fd5a8cb 100644
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -196,17 +196,6 @@ 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}
 
 \func{int}{MainLoop}{\void}
@@ -333,12 +322,16 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 
 \membersection{wxApp::OnExit}\label{wxapponexit}
 
-\func{int}{OnExit}{\void}
+\func{virtual int}{OnExit}{\void}
 
-Provide this member function for any processing which needs to be
+Override 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.
+wxWindows cleanup. Note that it is not called at all if 
+\helpref{OnInit}{wxapponinit} failed.
+
+The return value of this function is currently ignored, return the same value
+as returned by the base class method if you override it.
 
 
 \membersection{wxApp::OnFatalException}\label{wxapponfatalexception}
@@ -356,7 +349,7 @@ work and, in fact, probably won't.
 
 \wxheading{See also}
 
-\helpref{wxHandleFatalExcetions}{wxhandlefatalexceptions}
+\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions}
 
 %% VZ: the wxApp event handler are private and should not be documented here!
 %%
@@ -416,13 +409,16 @@ work and, in fact, probably won't.
 
 This must be provided by the application, and will usually create the
 application's main window, optionally calling 
-\helpref{wxApp::SetTopWindow}{wxappsettopwindow}.
+\helpref{wxApp::SetTopWindow}{wxappsettopwindow}. You may use 
+\helpref{OnExit}{wxapponexit} to clean up anything initialized here, provided
+that the function returns \true.
 
 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
+immediately.
 
 
 \membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline}
@@ -466,9 +462,7 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 \wxheading{See also}
 
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
-\helpref{wxCloseEvent}{wxcloseevent}
-%% GD: OnXXX functions are not documented
-%%\helpref{wxApp::OnEndSession}{wxapponendsession}
+\helpref{wxCloseEvent}{wxcloseevent}\rtfsp
 
 
 \membersection{wxApp::OnRun}\label{wxapponrun}
@@ -483,8 +477,11 @@ the last frame has been deleted and
 \helpref{GetExitOnFrameDelete}{wxappgetexitonframedelete} flag is \true (this
 is the default).
 
+The return value of this function becomes the exit code of the program, so it
+should return $0$ in case of successful termination.
 
-\membersection{wxApp::OnUnhandledException}{wxapponunhandledexception}
+
+\membersection{wxApp::OnUnhandledException}\label{wxapponunhandledexception}
 
 \func{virtual void}{OnUnhandledException}{\void}
 
@@ -534,14 +531,13 @@ Returns true if unprocessed events are in the window system event queue.
 
 \membersection{wxApp::SendIdleEvents}\label{wxappsendidleevents}
 
-\func{bool}{SendIdleEvents}{\void}
-
-Sends idle events to all top-level windows.
-
-\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.
@@ -549,8 +545,6 @@ 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}
 
 
