\helpref{wxApp::Pending}{wxapppending}
+\membersection{wxApp::FilterEvent}\label{wxappfilterevent}
+
+\func{int}{FilterEvent}{\param{wxEvent\& }{event}}
+
+This function is called before processing any event and allows the application
+to preempt the processing of some events. If this method returns $-1$ the event
+is processed normally, otherwise either {\tt true} or {\tt false} should be
+returned and the event processing stops immediately considering that the event
+had been already processed (for the former return value) or that it is not
+going to be processed at all (for the latter one).
+
\membersection{wxApp::GetAppName}\label{wxappgetappname}
\constfunc{wxString}{GetAppName}{\void}
\constfunc{bool}{GetAuto3D}{\void}
-Returns TRUE if 3D control mode is on, FALSE otherwise.
+Returns true if 3D control mode is on, false otherwise.
\wxheading{See also}
\membersection{wxApp::GetExitOnFrameDelete}\label{wxappgetexitonframedelete}
-\constfunc{bool}{GetExitFrameOnDelete}{\void}
+\constfunc{bool}{GetExitOnFrameDelete}{\void}
-Returns TRUE if the application will exit when the top-level window is deleted, FALSE
+Returns true if the application will exit when the top-level window is deleted, false
otherwise.
\wxheading{See also}
-\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete}
+\helpref{wxApp::SetExitOnFrameDelete}{wxappsetexitonframedelete},\\
+\helpref{wxApp shutdown overview}{wxappshutdownoverview}
\membersection{wxApp::GetTopWindow}\label{wxappgettopwindow}
\constfunc{bool}{GetUseBestVisual}{\void}
-Returns TRUE if the application will use the best visual on systems that support
-different visuals, FALSE otherwise.
+Returns true if the application will use the best visual on systems that support
+different visuals, false otherwise.
\wxheading{See also}
\func{bool}{Initialized}{\void}
-Returns TRUE if the application has been initialized (i.e. if\rtfsp
+Returns true if the application has been initialized (i.e. if\rtfsp
\helpref{wxApp::OnInit}{wxapponinit} has returned successfully). This can be useful for error
message routines to determine which method of output is best for the
current state of the program (some windowing systems may not like
\membersection{wxApp::OnAssert}\label{wxapponassert}
-\func{void}{OnAssert}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*msg}}
+\func{void}{OnAssert}{\param{const wxChar }{*file}, \param{int }{line}, \param{const wxChar }{*cond}, \param{const wxChar }{*msg}}
This function is called when an assert failure occurs, i.e. the condition
-specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt FALSE}.
+specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt false}.
It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) as
asserts are not left in the release code at all.
\docparam{line}{the line number in this file where the assert occured}
+\docparam{cond}{the condition of the failed assert in string form}
+
\docparam{msg}{the message specified as argument to
\helpref{wxASSERT\_MSG}{wxassertmsg} or \helpref{wxFAIL\_MSG}{wxfailmsg}, will
be {\tt NULL} if just \helpref{wxASSERT}{wxassert} or \helpref{wxFAIL}{wxfail}
\func{int}{OnExit}{\void}
-Provide this member function for any processing which needs to be done as
-the application is about to exit.
+Provide this member function for any processing which needs to be
+done as the application is about to exit. OnExit is called after
+destroying all application windows and controls, but before
+wxWindows cleanup.
\membersection{wxApp::OnCmdLineError}\label{wxapponcmdlineerror}
was specified by the user). The default behaviour is to show the program usage
text and abort the program.
-Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
-{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
+Return {\tt true} to continue normal execution or {\tt false} to return
+{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program.
\wxheading{See also}
Called when the help option ({\tt --help}) was specified on the command line.
The default behaviour is to show the program usage text and abort the program.
-Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
-{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
+Return {\tt true} to continue normal execution or {\tt false} to return
+{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program.
\wxheading{See also}
Don't forget to call the base class version unless you want to suppress
processing of the standard command line options.
-Return {\tt TRUE} to continue normal execution or {\tt FALSE} to return
-{\tt FALSE} from \helpref{OnInit}{wxapponinit} thus terminating the program.
+Return {\tt true} to continue normal execution or {\tt false} to return
+{\tt false} from \helpref{OnInit}{wxapponinit} thus terminating the program.
\wxheading{See also}
%%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::RequestMore}{wxidleeventrequestmore}, wxWindows will send another OnIdle
+%%calling \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.
%%
%%Use the EVT\_END\_SESSION event table macro to handle query end session events.
%%
-%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a TRUE argument
+%%The default handler calls \helpref{wxWindow::Close}{wxwindowclose} with a true argument
%%(forcing the application to close itself silently).
%%
%%\wxheading{Remarks}
wxWindows you have to call the base class version in the derived class
OnInit().
-Return TRUE to continue processing, FALSE to exit the application.
+Return true to continue processing, false to exit the application.
\membersection{wxApp::OnInitCmdLine}\label{wxapponinitcmdline}
about to close down. Typically, an application will try to save unsaved documents
at this point.
-If \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns TRUE, the application
+If \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns true, the application
is allowed to veto the shutdown by calling \helpref{wxCloseEvent::Veto}{wxcloseeventveto}.
The application might veto the shutdown after prompting for documents to be saved, and the
user has cancelled the save.
Use the EVT\_QUERY\_END\_SESSION event table macro to handle query end session events.
You should check whether the application is forcing the deletion of the window
-using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is TRUE,
+using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is true,
destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
If not, it is up to you whether you respond by destroying the window.
The default handler calls \helpref{wxWindow::Close}{wxwindowclose} on the top-level window,
-and vetoes the shutdown if Close returns FALSE. This will be sufficient for many applications.
+and vetoes the shutdown if Close returns false. This will be sufficient for many applications.
\wxheading{Remarks}
\wxheading{See also}
\helpref{wxWindow::Close}{wxwindowclose},\rtfsp
-\helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
\helpref{wxCloseEvent}{wxcloseevent}
%% GD: OnXXX functions are not documented
%%\helpref{wxApp::OnEndSession}{wxapponendsession}
\membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
-\func{bool}{ProcessMessage}{\param{MSG *}{msg}}
+\func{bool}{ProcessMessage}{\param{WXMSG *}{msg}}
Windows-only function for processing a message. This function
is called from the main message loop, checking for windows that
-may wish to process it. The function returns TRUE if the message
-was processed, FALSE otherwise. If you use wxWindows with another class
+may wish to process it. The function returns true if the message
+was processed, false otherwise. If you use wxWindows with another class
library with its own message loop, you should make sure that this
function is called to allow wxWindows to receive messages. For example,
-to allow co-existance with the Microsoft Foundation Classes, override
+to allow co-existence with the Microsoft Foundation Classes, override
the PreTranslateMessage function:
\begin{verbatim}
// Provide wxWindows message loop compatibility
BOOL CTheApp::PreTranslateMessage(MSG *msg)
{
- if (wxTheApp && wxTheApp->ProcessMessage(msg))
- return TRUE;
+ if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
+ return true;
else
return CWinApp::PreTranslateMessage(msg);
}
\func{bool}{Pending}{\void}
-Returns TRUE if unprocessed events are in the window system event queue.
+Returns true if unprocessed events are in the window system event queue.
\wxheading{See also}
\wxheading{Remarks}
These functions poll the top-level windows, and their children, for idle event processing.
-If TRUE is returned, more OnIdle processing is requested by one or more window.
+If true is returned, more OnIdle processing is requested by one or more window.
\wxheading{See also}
%% GD: OnXXX functions are not documented
%%\helpref{wxApp::OnIdle}{wxapponidle}
-\helpref{wxWindow::OnIdle}{wxwindowonidle},\rtfsp
\helpref{wxIdleEvent}{wxidleevent}
\membersection{wxApp::SetAppName}\label{wxappsetappname}
\wxheading{Parameters}
-\docparam{auto3D}{If TRUE, all controls will be created with 3D appearances unless
-overridden for a control or dialog. The default is TRUE}
+\docparam{auto3D}{If true, all controls will be created with 3D appearances unless
+overridden for a control or dialog. The default is true}
\wxheading{Remarks}
\wxheading{Parameters}
-\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{See also}
+
+\helpref{wxApp::GetExitOnFrameDelete}{wxappgetexitonframedelete},\\
+\helpref{wxApp shutdown overview}{wxappshutdownoverview}
\membersection{wxApp::SetTopWindow}\label{wxappsettopwindow}
\helpref{wxApp::GetVendorName}{wxappgetvendorname}
-\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 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.
+applications 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.
\wxheading{Parameters}
-\docparam{flag}{If TRUE, the app will use the best visual.}
+\docparam{flag}{If true, the app will use the best visual.}
\membersection{wxApp::Yield}\label{wxappyield}
-\func{bool}{Yield}{\param{bool}{ onlyIfNeeded = FALSE}}
+\func{bool}{Yield}{\param{bool}{ onlyIfNeeded = false}}
Yields control to pending messages in the windowing system. This can be useful, for example, when a
time-consuming process writes to a text window. Without an occasional
Calling Yield() recursively is normally an error and an assert failure is
raised in debug build if such situation is detected. However if the the
-{\it onlyIfNeeded} parameter is {\tt TRUE}, the method will just silently
-return {\tt FALSE} instead.
+{\it onlyIfNeeded} parameter is {\tt true}, the method will just silently
+return {\tt false} instead.
projects / wxWidgets.git / blobdiff