X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8a2c6ef8d186df490df28a694820a5e8afc4b5e8..d45d30c8682f858321600e2958167d7ef54ebeb5:/docs/latex/wx/app.tex diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index bd02e31db8..12e553cd56 100644 --- 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} +\wxheading{Include files} + + + \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} -\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. -TODO: completely rewrite the language stuff. - \membersection{wxApp::\destruct{wxApp}} \func{void}{\destruct{wxApp}}{\void} @@ -129,18 +131,17 @@ otherwise. \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. +\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} @@ -269,7 +270,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 -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. @@ -309,8 +310,6 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO \helpref{wxCloseEvent}{wxcloseevent},\rtfsp \helpref{wxApp::OnEndSession}{wxapponendsession} -\membersection{wxWindow::OnScroll}\label{wxwindowonscroll} - \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. -\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}} -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} @@ -457,3 +441,15 @@ let wxWindows know which is the main window. \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.} +