From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Fri, 27 Feb 2004 17:10:38 +0000 (+0000)
Subject: documented OnRun()/OnExit() return values; expanded OnInit()
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/bc37bb431f2eb2f3aef8ca01888e3f4a1429d9f4

documented OnRun()/OnExit() return values; expanded OnInit()


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25980 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index eaf657693a..d02fd5a8cb 100644
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -32,6 +32,7 @@ a reference to your application object) to be visible to other files.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxApp::wxApp}
 
 \func{void}{wxApp}{\void}
@@ -321,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}
@@ -404,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}
@@ -456,6 +464,7 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxCloseEvent}{wxcloseevent}\rtfsp
 
+
 \membersection{wxApp::OnRun}\label{wxapponrun}
 
 \func{virtual int}{OnRun}{\void}
@@ -468,6 +477,10 @@ 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}\label{wxapponunhandledexception}
 
 \func{virtual void}{OnUnhandledException}{\void}
@@ -479,6 +492,7 @@ 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{WXMSG *}{msg}}