]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/app.tex
note about comctl32.dll bug with tree ctrl colours added
[wxWidgets.git] / docs / latex / wx / app.tex
index cd5a9fd40021712626c5a5d6f5aaf7ff20a3871d..55249bf1cd6bf4f4bc468ae7378286e1aca1b3e2 100644 (file)
@@ -120,16 +120,16 @@ manner to refer to the application.
 
 \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}
 
-\helpref{wxApp::SetExitOnDelete}{wxappsetexitondelete}
+\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete}
 
 \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}
 
-\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}
 
@@ -216,6 +233,23 @@ If you use this member, you can selectively consume keypress events by calling\r
 \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnChar}{wxwindowonchar},\rtfsp
 \helpref{wxWindow::OnCharHook}{wxwindowoncharhook}, \helpref{wxDialog::OnCharHook}{wxdialogoncharhook}
 
+\membersection{wxApp::OnFatalException}\label{wxapponfatalexception}
+
+\func{void}{OnFatalException}{\void}
+
+This function may be called if something fatal happens: an unhandled
+exception under Win32 or a a fatal signal under Unix, for example. However,
+this will not happen by default: you have to explicitly call 
+\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions} to enable this.
+
+Generally speaking, this function should only show a message to the user and
+return. You may attempt to save unsaved data but this is not guaranteed to
+work and, in fact, probably won't.
+
+\wxheading{See also}
+
+\helpref{wxHandleFatalExcetions}{wxhandlefatalexceptions}
+
 \membersection{wxApp::OnIdle}\label{wxapponidle}
 
 \func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}
@@ -229,7 +263,7 @@ wxWindows' strategy for OnIdle processing is as follows. After pending user inte
 application have all been processed, wxWindows 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
-caling \helpref{wxIdleEvent::ReqestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
+caling \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, wxWindows 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.
@@ -254,7 +288,7 @@ The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE a
 
 \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.
 
@@ -299,7 +333,7 @@ and vetoes the shutdown if Close returns FALSE. This will be sufficient for many
 
 \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.
 
@@ -338,8 +372,7 @@ BOOL CTheApp::PreTranslateMessage(MSG *msg)
 
 \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}
 
@@ -406,9 +439,9 @@ manner to refer to the application.
 
 \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.
@@ -418,10 +451,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.}
 
-\wxheading{Remarks}
-
-Currently, setting this to FALSE only has an effect under Windows.
-
 \membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
 
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
@@ -441,6 +470,19 @@ 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}}
+
+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
@@ -451,5 +493,25 @@ can be overridden by the user to change the default icons.
 
 \wxheading{Parameters}
 
-\docparam{which}{One of the wxICON\_XXX defines and chooses which icon to return.}
+\docparam{which}{One of the wxICON\_XXX specifies which icon to return.}
+
+See \helpref{wxMessageBox}{wxmessagebox} for a list of icon identifiers.
+
+\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.}