Manual fixes

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index a9044b7132fd86a7e15fe8792fd85e411475dc88..88b7b8c40fd8d9101970c56ccc198b121863ad89 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -120,22 +120,16 @@ manner to refer to the application.
 
 \helpref{wxApp::SetClassName}{wxappsetclassname}
 
 
 \helpref{wxApp::SetClassName}{wxappsetclassname}
 

-\membersection{wxApp::GetExitOnDelete}\label{wxappgetexitondelete}
+\membersection{wxApp::GetExitOnFrameDelete}\label{wxappgetexitonframedelete}

 
 

-\constfunc{bool}{GetExitOnDelete}{\void}
+\constfunc{bool}{GetExitFrameOnDelete}{\void}

 
 Returns TRUE if the application will exit when the top-level window is deleted, FALSE
 otherwise.
 
 \wxheading{See also}
 
 
 Returns TRUE if the application will exit when the top-level window is deleted, FALSE
 otherwise.
 
 \wxheading{See also}
 

-\helpref{wxApp::SetExitOnDelete}{wxappsetexitondelete}
-
-\membersection{wxApp::GetPrintMode}\label{wxappgetprintmode}
-
-\constfunc{bool}{GetPrintMode}{\void}
-
-Returns the print mode: see \helpref{wxApp::SetPrintMode}{wxappsetprintmode}.
+\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete}

 
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 
 
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 


@@ -143,9 +137,25 @@ Returns the print mode: see \helpref{wxApp::SetPrintMode}{wxappsetprintmode}.
 
 Returns a pointer to the top window.
 
 
 Returns a pointer to the top window.
 

+\wxheading{Remarks}
+
+If the top window hasn't been set using \helpref{wxApp::SetTopWindow}{wxappsettopwindow}, this
+function will find the first top-level window (frame or dialog) and return that.
+
+\wxheading{See also}
+
+\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.
+

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

-\helpref{wxApp::SetTopWindow}{wxappsettopwindow}
+\helpref{SetUseBestVisual}{wxappsetusebestvisual}

 
 \membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
 
 
 \membersection{wxApp::ExitMainLoop}\label{wxappexitmainloop}
 


@@ -255,7 +265,7 @@ The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE a
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Under X, OnEndSession is called in response to the 'die' event.
+Under X, OnEndSession is called in response to the `die' event.

 
 Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
 
 
 Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
 


@@ -271,7 +281,7 @@ Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
 \func{bool}{OnInit}{\void}
 
 This must be provided by the application, and will usually create the
 \func{bool}{OnInit}{\void}
 
 This must be provided by the application, and will usually create the

-application's main window, calling \helpref{wxApp::SetTopWindow}{wxappsettopwindow}.
+application's main window, optionally calling \helpref{wxApp::SetTopWindow}{wxappsettopwindow}.

 
 Return TRUE to continue processing, FALSE to exit the application.
 
 
 Return TRUE to continue processing, FALSE to exit the application.
 


@@ -300,7 +310,7 @@ and vetoes the shutdown if Close returns FALSE. This will be sufficient for many
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Under X, OnQueryEndSession is called in response to the 'save session' event.
+Under X, OnQueryEndSession is called in response to the `save session' event.

 
 Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSION message.
 
 
 Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSION message.
 


@@ -339,8 +349,7 @@ BOOL CTheApp::PreTranslateMessage(MSG *msg)
 
 \func{bool}{Pending}{\void}
 
 
 \func{bool}{Pending}{\void}
 

-Returns TRUE if unprocessed events are in the window system event queue
-(MS Windows and Motif).
+Returns TRUE if unprocessed events are in the window system event queue.

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


@@ -407,9 +416,9 @@ manner to refer to the application.
 
 \helpref{wxApp::GetClassName}{wxappgetclassname}
 
 
 \helpref{wxApp::GetClassName}{wxappgetclassname}
 

-\membersection{wxApp::SetExitOnDelete}\label{wxappsetexitondelete}
+\membersection{wxApp::SetExitOnFrameDelete}\label{wxappsetexitonframedelete}

 
 

-\func{void}{SetExitOnDelete}{\param{bool}{ flag}}
+\func{void}{SetExitOnFrameDelete}{\param{bool}{ flag}}

 
 Allows the programmer to specify whether the application will exit when the
 top-level frame is deleted.
 
 Allows the programmer to specify whether the application will exit when the
 top-level frame is deleted.


@@ -419,41 +428,51 @@ top-level frame is deleted.
 \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{Remarks}
-
-Currently, setting this to FALSE only has an effect under Windows.
-
-\membersection{wxApp::SetPrintMode}\label{wxappsetprintmode}
+\membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}

 
 

-\func{void}{SetPrintMode}{\param{int}{ mode}}
+\func{void}{SetTopWindow}{\param{wxWindow* }{window}}

 
 

-Sets the print mode determining what printing facilities will be
-used by the printing framework.
+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;
+it's 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
+needs to use the top window.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{mode}{This can be one of:
+\docparam{window}{The new top window.}

 
 

-\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf wxPRINT\_WINDOWS}}{Under Windows, use Windows printing (wxPrinterDC). This is the
-default under Windows.}
-\twocolitem{{\bf wxPRINT\_POSTSCRIPT}}{Use PostScript printing (wxPostScriptDC). This is the
-default for non-Windows platforms.}
-\end{twocollist}
-}%
+\wxheading{See also}

 
 

-\membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
+\helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}

 
 

-\func{void}{SetTopWindow}{\param{wxWindow* }{window}}
+\membersection{wxApp::GetStdIcon}\label{wxappgetstdicon}

 
 

-Sets the `top' window. You should normally call this from within \helpref{wxApp::OnInit}{wxapponinit} to
-let wxWindows know which is the main window.
+\func{virtual wxIcon}{GetStdIcon}{\param{int }{which}} const
+
+Returns the icons used by wxWindows internally, e.g. the ones used for 
+message boxes.  This function is used internally and 
+can be overridden by the user to change the default icons.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{window}{The new top window.}
+\docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.}

 
 

-\wxheading{See also}
+\membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}

 
 

-\helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
+\func{void}{SetUseBestVisual}{\param{bool}{ flag}}
+
+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.
+
+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.
+
+This function currently only has effect under GTK.
+
+\wxheading{Parameters}

 
 

+\docparam{flag}{If TRUE, the app will use the best visual.}