Removed OGL prior to re-adding; some Watcom corrections

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index cd5a9fd40021712626c5a5d6f5aaf7ff20a3871d..e894a39d178f9722d437a5098a20dde25937aa4a 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -120,16 +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}
+\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete}

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


@@ -144,7 +144,24 @@ function will find the first top-level window (frame or dialog) and return that.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxApp::SetTopWindow}{wxappsettopwindow}
+\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}
+
+\helpref{SetUseBestVisual}{wxappsetusebestvisual}
+
+\membersection{wxApp::GetVendorName}\label{wxappgetvendorname}
+
+\constfunc{wxString}{GetVendorName}{\void}
+
+Returns the application's vendor name.

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


@@ -254,7 +271,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.
 


@@ -299,7 +316,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.
 


@@ -338,8 +355,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}
 


@@ -406,9 +422,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.


@@ -418,10 +434,6 @@ 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::SetTopWindow}\label{wxappsettopwindow}
 
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
 \membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
 
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}


@@ -441,6 +453,19 @@ needs to use the top window.
 
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 
 
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 

+
+\membersection{wxApp::SetVendorName}\label{wxappsetvendorname}
+
+\func{void}{SetVendorName}{\param{const wxString\& }{name}}
+
+Sets the name of application's vendor. The name will be used
+in registry access. A default name is set by
+wxWindows.
+
+\wxheading{See also}
+
+\helpref{wxApp::GetVendorName}{wxappgetvendorname}
+

 \membersection{wxApp::GetStdIcon}\label{wxappgetstdicon}
 
 \func{virtual wxIcon}{GetStdIcon}{\param{int }{which}} const
 \membersection{wxApp::GetStdIcon}\label{wxappgetstdicon}
 
 \func{virtual wxIcon}{GetStdIcon}{\param{int }{which}} const


@@ -453,3 +478,21 @@ can be overridden by the user to change the default icons.
 
 \docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.}
 
 
 \docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.}
 

+\membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
+
+\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.}
+