Minor tweek for WXPM

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index dccfc2856746828d146df2e82457234e434e7f10..12e553cd56b35f074f4a463ef51350b64c003a89 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -22,6 +22,10 @@ a reference to your application object) to be visible to other files.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/app.h>
+

 \wxheading{See also}
 
 \helpref{wxApp overview}{wxappoverview}
 \wxheading{See also}
 
 \helpref{wxApp overview}{wxappoverview}


@@ -30,15 +34,13 @@ a reference to your application object) to be visible to other files.
 
 \membersection{wxApp::wxApp}
 
 
 \membersection{wxApp::wxApp}
 

-\func{void}{wxApp}{\param{int}{ language = wxLANGUAGE\_ENGLISH}}
+\func{void}{wxApp}{\void}

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

-TODO: completely rewrite the language stuff.
-

 \membersection{wxApp::\destruct{wxApp}}
 
 \func{void}{\destruct{wxApp}}{\void}
 \membersection{wxApp::\destruct{wxApp}}
 
 \func{void}{\destruct{wxApp}}{\void}


@@ -129,18 +131,17 @@ otherwise.
 
 \helpref{wxApp::SetExitOnDelete}{wxappsetexitondelete}
 
 
 \helpref{wxApp::SetExitOnDelete}{wxappsetexitondelete}
 

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

 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 
 \constfunc{wxWindow *}{GetTopWindow}{\void}
 
 Returns a pointer to the top window.
 
 \membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
 
 \constfunc{wxWindow *}{GetTopWindow}{\void}
 
 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{wxApp::SetTopWindow}{wxappsettopwindow}
 \wxheading{See also}
 
 \helpref{wxApp::SetTopWindow}{wxappsettopwindow}


@@ -229,7 +230,7 @@ application have all been processed, wxWindows sends an OnIdle event to the appl
 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
 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

-event to the application event. This will occur in a loop until either a user event is found to be
+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.
 
 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.
 


@@ -262,14 +263,14 @@ Under Windows, OnEndSession is called in response to the WM\_ENDSESSION message.
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
 \helpref{wxCloseEvent}{wxcloseevent},\rtfsp
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
 \helpref{wxCloseEvent}{wxcloseevent},\rtfsp

-\helpref{wxApp::OnQueryEndSession}{wxappqueryonendsession}
+\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession}

 
 \membersection{wxApp::OnInit}\label{wxapponinit}
 
 \func{bool}{OnInit}{\void}
 
 This must be provided by the application, and will usually create the
 
 \membersection{wxApp::OnInit}\label{wxapponinit}
 
 \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.
 


@@ -309,8 +310,6 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 \helpref{wxCloseEvent}{wxcloseevent},\rtfsp
 \helpref{wxApp::OnEndSession}{wxapponendsession}
 
 \helpref{wxCloseEvent}{wxcloseevent},\rtfsp
 \helpref{wxApp::OnEndSession}{wxapponendsession}
 

-\membersection{wxWindow::OnScroll}\label{wxwindowonscroll}
-

 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 
 \func{bool}{ProcessMessage}{\param{MSG *}{msg}}
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 
 \func{bool}{ProcessMessage}{\param{MSG *}{msg}}


@@ -423,31 +422,16 @@ deleted. If FALSE, the application will continue to run.}
 
 Currently, setting this to FALSE only has an effect under Windows.
 
 
 Currently, setting this to FALSE only has an effect under Windows.
 

-\membersection{wxApp::SetPrintMode}\label{wxappsetprintmode}
-
-\func{void}{SetPrintMode}{\param{int}{ mode}}
-
-Sets the print mode determining what printing facilities will be
-used by the printing framework.
-
-\wxheading{Parameters}
-
-\docparam{mode}{This can be one of:
-
-\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}
-}%
-

 \membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
 
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
 
 \membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
 
 \func{void}{SetTopWindow}{\param{wxWindow* }{window}}
 

-Sets the `top' window. You should normally call this from within \helpref{wxApp::OnInit}{wxapponinit} to
-let wxWindows know which is the main 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
+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}
 


@@ -457,3 +441,15 @@ let wxWindows know which is the main window.
 
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 
 
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 

+\membersection{wxApp::GetStdIcon}\label{wxappgetstdicon}
+
+\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}
+
+\docparam{which}{One of the wxICON_XXX defines and chooses which icon to return.}
+