Added EVT_GRID_EDITOR_CREATED and wxGridEditorCreatedEvent so the user

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index af67ba0e185a8ecfb5f7871b6cd323a3b718dea8..ec2ac10d7f32ae5ae0366f126ea01608db864801 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -38,8 +38,9 @@ a reference to your application object) to be visible to other files.
 
 Constructor. Called implicitly with a definition of a wxApp object.
 
 
 Constructor. Called implicitly with a definition of a wxApp object.
 

-The argument is a language identifier; this is an experimental
-feature and will be expanded and documented in future versions.
+% VZ: there is no such feature so far...
+% The argument is a language identifier; this is an experimental
+% feature and will be expanded and documented in future versions.

 
 \membersection{wxApp::\destruct{wxApp}}
 
 
 \membersection{wxApp::\destruct{wxApp}}
 


@@ -133,7 +134,7 @@ otherwise.
 
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 
 
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 

-\constfunc{wxWindow *}{GetTopWindow}{\void}
+\constfunc{virtual wxWindow *}{GetTopWindow}{\void}

 
 Returns a pointer to the top window.
 
 
 Returns a pointer to the top window.
 


@@ -144,7 +145,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}
 


@@ -216,6 +234,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}
 
 \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}}
 \membersection{wxApp::OnIdle}\label{wxapponidle}
 
 \func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}


@@ -229,7 +264,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
 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.
 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 +289,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 +334,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.
 


@@ -423,7 +458,7 @@ deleted. If FALSE, the application will continue to run.}
 
 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;
 
 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
+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
 needs to use the top window.
 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.


@@ -436,6 +471,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


@@ -446,5 +494,25 @@ can be overridden by the user to change the default icons.
 
 \wxheading{Parameters}
 
 
 \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.}