fix various latex errors

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index eaf657693a9274b3153f96c5febd4676f3de279c..49a09ab262e16ad28fd9a37818fbbf71556a3008 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -12,7 +12,7 @@ objects in the application.
 \end{itemize}
 
 You should use the macro IMPLEMENT\_APP(appClass) in your application implementation
 \end{itemize}
 
 You should use the macro IMPLEMENT\_APP(appClass) in your application implementation

-file to tell wxWindows how to create an instance of your application class.
+file to tell wxWidgets how to create an instance of your application class.

 
 Use DECLARE\_APP(appClass) in a header file if you want the wxGetApp function (which returns
 a reference to your application object) to be visible to other files.
 
 Use DECLARE\_APP(appClass) in a header file if you want the wxGetApp function (which returns
 a reference to your application object) to be visible to other files.


@@ -32,14 +32,15 @@ a reference to your application object) to be visible to other files.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxApp::wxApp}
+
+\membersection{wxApp::wxApp}\label{wxappctor}

 
 \func{void}{wxApp}{\void}
 
 Constructor. Called implicitly with a definition of a wxApp object.
 
 
 
 \func{void}{wxApp}{\void}
 
 Constructor. Called implicitly with a definition of a wxApp object.
 
 

-\membersection{wxApp::\destruct{wxApp}}
+\membersection{wxApp::\destruct{wxApp}}\label{wxappdtor}

 
 \func{void}{\destruct{wxApp}}{\void}
 
 
 \func{void}{\destruct{wxApp}}{\void}
 


@@ -75,7 +76,7 @@ implementation returns a new wxLogGui class.
 
 \membersection{wxApp::Dispatch}\label{wxappdispatch}
 
 
 \membersection{wxApp::Dispatch}\label{wxappdispatch}
 

-\func{void}{Dispatch}{\void}
+\func{virtual void}{Dispatch}{\void}

 
 Dispatches the next event in the windowing system event queue.
 
 
 Dispatches the next event in the windowing system event queue.
 


@@ -103,6 +104,15 @@ had been already processed (for the former return value) or that it is not
 going to be processed at all (for the latter one).
 
 
 going to be processed at all (for the latter one).
 
 

+\membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
+
+\func{virtual void}{ExitMainLoop}{\void}
+
+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::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}
 \membersection{wxApp::GetAppName}\label{wxappgetappname}
 
 \constfunc{wxString}{GetAppName}{\void}


@@ -111,7 +121,7 @@ Returns the application name.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-wxWindows sets this to a reasonable default before
+wxWidgets sets this to a reasonable default before

 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 
 
 calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will.
 
 


@@ -186,20 +196,34 @@ different visuals, false otherwise.
 Returns the application's vendor name.
 
 
 Returns the application's vendor name.
 
 

-\membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
+\membersection{wxApp::IsActive}\label{wxappisactive}

 
 

-\func{void}{ExitMainLoop}{\void}
+\constfunc{bool}{IsActive}{\void}

 
 

-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.
+Returns \true if the application is active, i.e. if one of its windows is
+currently in the foreground. If this function returns \false and you need to
+attract users attention to the application, you may use 
+\helpref{wxTopLevelWindow::RequestUserAttention}{wxtoplevelwindowrequestuserattention} 
+to do it.
+
+
+\membersection{wxApp::IsMainLoopRunning}\label{wxappismainlooprunning}
+
+\func{static bool}{IsMainLoopRunning}{\void}
+
+Returns \true if the main event loop is currently running, i.e. if the
+application is inside \helpref{OnRun}{wxapponrun}.
+
+This can be useful to test whether the events can be dispatched. For example,
+if this function returns \false, non-blocking sockets cannot be used because
+the events from them would never be processed.

 
 
 \membersection{wxApp::MainLoop}\label{wxappmainloop}
 
 
 
 \membersection{wxApp::MainLoop}\label{wxappmainloop}
 

-\func{int}{MainLoop}{\void}
+\func{virtual int}{MainLoop}{\void}

 
 

-Called by wxWindows on creation of the application. Override this if you wish
+Called by wxWidgets on creation of the application. Override this if you wish

 to provide your own (environment-dependent) main loop.
 
 \wxheading{Return value}
 to provide your own (environment-dependent) main loop.
 
 \wxheading{Return value}


@@ -319,14 +343,37 @@ Return {\tt true} to continue normal execution or {\tt false} to return
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
 
 \helpref{OnInitCmdLine}{wxapponinitcmdline}
 
 

+\membersection{wxApp::OnExceptionInMainLoop}\label{wxapponexceptioninmainloop}
+
+\func{virtual bool}{OnExceptionInMainLoop}{\void}
+
+This function is called if an unhandled exception occurs inside the main
+application event loop. It can return \true to ignore the exception and to
+continue running the loop or \false to exit the loop and terminate the
+program. In the latter case it can also use C++ \texttt{throw} keyword to
+rethrow the current exception.
+
+The default behaviour of this function is the latter in all ports except under
+Windows where a dialog is shown to the user which allows him to choose between
+the different options. You may override this function in your class to do
+something more appropriate.
+
+Finally note that if the exception is rethrown from here, it can be caught in 
+\helpref{OnUnhandledException}{wxapponunhandledexception}.
+
+

 \membersection{wxApp::OnExit}\label{wxapponexit}
 
 \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
 done as the application is about to exit. OnExit is called after
 destroying all application windows and controls, but before

-wxWindows cleanup.
+wxWidgets 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}
 
 
 \membersection{wxApp::OnFatalException}\label{wxapponfatalexception}


@@ -357,11 +404,11 @@ work and, in fact, probably won't.
 %%since this forwards OnIdle events to windows and also performs garbage collection for
 %%windows whose destruction has been delayed.
 %%
 %%since this forwards OnIdle events to windows and also performs garbage collection for
 %%windows whose destruction has been delayed.
 %%

-%%wxWindows' strategy for OnIdle processing is as follows. After pending user interface events for an
-%%application have all been processed, wxWindows sends an OnIdle event to the application object. wxApp::OnIdle itself
+%%wxWidgets' strategy for OnIdle processing is as follows. After pending user interface events for an
+%%application have all been processed, wxWidgets 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
 %%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

-%%calling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
+%%calling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWidgets 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.
 %%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.


@@ -404,13 +451,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 
 
 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
 
 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
+wxWidgets you have to call the base class version in the derived class

 OnInit().
 
 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}
 
 
 \membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline}


@@ -456,11 +506,12 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxCloseEvent}{wxcloseevent}\rtfsp
 
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxCloseEvent}{wxcloseevent}\rtfsp
 

+

 \membersection{wxApp::OnRun}\label{wxapponrun}
 
 \func{virtual int}{OnRun}{\void}
 
 \membersection{wxApp::OnRun}\label{wxapponrun}
 
 \func{virtual int}{OnRun}{\void}
 

-This virtual function is where the execution of a program written in wxWindows
+This virtual function is where the execution of a program written in wxWidgets

 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
 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


@@ -468,6 +519,10 @@ the last frame has been deleted and
 \helpref{GetExitOnFrameDelete}{wxappgetexitonframedelete} flag is \true (this
 is the default).
 
 \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}
 \membersection{wxApp::OnUnhandledException}\label{wxapponunhandledexception}
 
 \func{virtual void}{OnUnhandledException}{\void}


@@ -479,6 +534,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.
 
 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}}
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 
 \func{bool}{ProcessMessage}{\param{WXMSG *}{msg}}


@@ -486,14 +542,14 @@ try/catch clause around the call to the base class version there.
 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
 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
+was processed, false otherwise. If you use wxWidgets with another class

 library with its own message loop, you should make sure that this
 library with its own message loop, you should make sure that this

-function is called to allow wxWindows to receive messages. For example,
+function is called to allow wxWidgets to receive messages. For example,

 to allow co-existence with the Microsoft Foundation Classes, override
 the PreTranslateMessage function:
 
 \begin{verbatim}
 to allow co-existence with the Microsoft Foundation Classes, override
 the PreTranslateMessage function:
 
 \begin{verbatim}

-// Provide wxWindows message loop compatibility
+// Provide wxWidgets message loop compatibility

 BOOL CTheApp::PreTranslateMessage(MSG *msg)
 {
   if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
 BOOL CTheApp::PreTranslateMessage(MSG *msg)
 {
   if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))


@@ -506,7 +562,7 @@ BOOL CTheApp::PreTranslateMessage(MSG *msg)
 
 \membersection{wxApp::Pending}\label{wxapppending}
 
 
 \membersection{wxApp::Pending}\label{wxapppending}
 

-\func{bool}{Pending}{\void}
+\func{virtual 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.
 


@@ -521,7 +577,7 @@ Returns true if unprocessed events are in the window system event queue.
 
 Sends idle events to a window and its children.
 
 
 Sends idle events to a window and its children.
 

-Please note that this function is internal to wxWindows and shouldn't be used
+Please note that this function is internal to wxWidgets and shouldn't be used

 by user code.
 
 \wxheading{Remarks}
 by user code.
 
 \wxheading{Remarks}


@@ -540,7 +596,7 @@ If true is returned, more OnIdle processing is requested by one or more window.
 
 Sets the name of the application. The name may be used in dialogs
 (for example by the document/view framework). A default name is set by
 
 Sets the name of the application. The name may be used in dialogs
 (for example by the document/view framework). A default name is set by

-wxWindows.
+wxWidgets.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -602,10 +658,10 @@ deleted. If false, the application will continue to run.}
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
 
 Sets the `top' window. You can call this from within \helpref{wxApp::OnInit}{wxapponinit} to
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
 
 Sets the `top' window. You can call this from within \helpref{wxApp::OnInit}{wxapponinit} to

-let wxWindows know which is the main window. You don't have to set the top window;
+let wxWidgets know which is the main window. You don't have to set the top window;

 it is only a convenience so that (for example) certain dialogs without parents can use a
 specific window as the top window. If no top window is specified by the application,
 it is only a convenience so that (for example) certain dialogs without parents can use a
 specific window as the top window. If no top window is specified by the application,

-wxWindows just uses the first frame or dialog in its top-level window list, when it
+wxWidgets just uses the first frame or dialog in its top-level window list, when it

 needs to use the top window.
 
 \wxheading{Parameters}
 needs to use the top window.
 
 \wxheading{Parameters}


@@ -624,7 +680,7 @@ needs to use the top window.
 
 Sets the name of application's vendor. The name will be used
 in registry access. A default name is set by
 
 Sets the name of application's vendor. The name will be used
 in registry access. A default name is set by

-wxWindows.
+wxWidgets.

 
 \wxheading{See also}
 
 
 \wxheading{See also}