Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index 4908d31e6f74ea7e49248b0eefb1841a325bc973..37214ede081e2bcb5d5a509b97bb40c97d9dc370 100644 (file)
--- 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,6 +91,7 @@ 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}}
@@ -96,6 +103,7 @@ 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,6 +115,7 @@ 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}
@@ -117,6 +126,7 @@ Returns true if 3D control mode is on, false otherwise.
 
 \helpref{wxApp::SetAuto3D}{wxappsetauto3d}
 
+
 \membersection{wxApp::GetClassName}\label{wxappgetclassname}
 
 \constfunc{wxString}{GetClassName}{\void}
@@ -128,6 +138,7 @@ manner to refer to the application.
 
 \helpref{wxApp::SetClassName}{wxappsetclassname}
 
+
 \membersection{wxApp::GetExitOnFrameDelete}\label{wxappgetexitonframedelete}
 
 \constfunc{bool}{GetExitOnFrameDelete}{\void}
@@ -140,6 +151,7 @@ otherwise.
 \helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete},\\
 \helpref{wxApp shutdown overview}{wxappshutdownoverview}
 
+
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 
 \constfunc{virtual wxWindow *}{GetTopWindow}{\void}
@@ -155,6 +167,7 @@ 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}
@@ -166,12 +179,14 @@ different visuals, false otherwise.
 
 \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}
@@ -180,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}
 
@@ -237,6 +243,7 @@ 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 }{*cond}, \param{const wxChar }{*msg}}
@@ -262,14 +269,6 @@ the user to stop the program, continue or ignore all subsequent asserts.
 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. OnExit is called after
-destroying all application windows and controls, but before
-wxWindows cleanup.
 
 \membersection{wxApp::OnCmdLineError}\label{wxapponcmdlineerror}
 
@@ -286,6 +285,7 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
+
 \membersection{wxApp::OnCmdLineHelp}\label{wxapponcmdlinehelp}
 
 \func{bool}{OnCmdLineHelp}{\param{wxCmdLineParser\& }{parser}}
@@ -300,6 +300,7 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
+
 \membersection{wxApp::OnCmdLineParsed}\label{wxapponcmdlineparsed}
 
 \func{bool}{OnCmdLineParsed}{\param{wxCmdLineParser\& }{parser}}
@@ -318,6 +319,17 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 
 \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}
@@ -386,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}
@@ -400,6 +413,7 @@ OnInit().
 
 Return true to continue processing, false to exit the application.
 
+
 \membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline}
 
 \func{void}{OnInitCmdLine}{\param{wxCmdLineParser\& }{parser}}
@@ -408,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}}
@@ -444,6 +459,32 @@ 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{WXMSG *}{msg}}
@@ -468,6 +509,7 @@ BOOL CTheApp::PreTranslateMessage(MSG *msg)
 }
 \end{verbatim}
 
+
 \membersection{wxApp::Pending}\label{wxapppending}
 
 \func{bool}{Pending}{\void}
@@ -478,16 +520,16 @@ Returns true if unprocessed events are in the window system event queue.
 
 \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.
@@ -495,10 +537,9 @@ 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}}
@@ -511,6 +552,7 @@ wxWindows.
 
 \helpref{wxApp::GetAppName}{wxappgetappname}
 
+
 \membersection{wxApp::SetAuto3D}\label{wxappsetauto3d}
 
 \func{void}{SetAuto3D}{\param{const bool}{ auto3D}}
@@ -530,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}}
@@ -541,6 +584,7 @@ manner to refer to the application.
 
 \helpref{wxApp::GetClassName}{wxappgetclassname}
 
+
 \membersection{wxApp::SetExitOnFrameDelete}\label{wxappsetexitonframedelete}
 
 \func{void}{SetExitOnFrameDelete}{\param{bool}{ flag}}
@@ -558,6 +602,7 @@ deleted. If false, the application will continue to run.}
 \helpref{wxApp::GetExitOnFrameDelete}{wxappgetexitonframedelete},\\
 \helpref{wxApp shutdown overview}{wxappshutdownoverview}
 
+
 \membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
 
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
@@ -578,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}}
@@ -590,6 +636,7 @@ wxWindows.
 
 \helpref{wxApp::GetVendorName}{wxappgetvendorname}
 
+
 \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
 
 \func{void}{SetUseBestVisual}{\param{bool}{ flag}}
@@ -608,6 +655,18 @@ This function currently only has effect under GTK.
 
 \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}}