X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4d5a0f67c6f127ad08548494cdddc5c89bb27194..9b9337da0c597d9ba18f731a4e641bda25437224:/docs/latex/wx/app.tex

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index c71c82dbec..f082563254 100644
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -85,6 +85,17 @@ This can be used for programming event loops, e.g.
 
 \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}
@@ -227,7 +238,7 @@ Returns 0 under X, and the wParam of the WM\_QUIT message under Windows.
 
 \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}.
@@ -243,6 +254,8 @@ the user to stop the program, continue or ignore all subsequent asserts.
 
 \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} 
@@ -334,7 +347,7 @@ work and, in fact, probably won't.
 %%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.
@@ -424,14 +437,13 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 \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
@@ -439,14 +451,14 @@ 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))
+  if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
     return TRUE;
   else
     return CWinApp::PreTranslateMessage(msg);
@@ -482,7 +494,6 @@ If TRUE is returned, more OnIdle processing is requested by one or more window.
 
 %% GD: OnXXX functions are not documented
 %%\helpref{wxApp::OnIdle}{wxapponidle}
-\helpref{wxWindow::OnIdle}{wxwindowonidle},\rtfsp
 \helpref{wxIdleEvent}{wxidleevent}
 
 \membersection{wxApp::SetAppName}\label{wxappsetappname}
@@ -571,20 +582,6 @@ wxWindows.
 
 \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}}
@@ -592,7 +589,7 @@ See \helpref{wxMessageBox}{wxmessagebox} for a list of icon identifiers.
 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.
@@ -603,3 +600,29 @@ This function currently only has effect under GTK.
 
 \docparam{flag}{If TRUE, the app will use the best visual.}
 
+\membersection{wxApp::Yield}\label{wxappyield}
+
+\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
+yield, the text window will not be updated properly, and on systems with
+cooperative multitasking, such as Windows 3.1 other processes will not respond.
+
+Caution should be exercised, however, since yielding may allow the
+user to perform actions which are not compatible with the current task.
+Disabling menu items or whole menus during processing can avoid unwanted
+reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
+function.
+
+Note that Yield() will not flush the message logs. This is intentional as
+calling Yield() is usually done to quickly update the screen and popping up a
+message box dialog may be undesirable. If you do wish to flush the log
+messages immediately (otherwise it will be done during the next idle loop
+iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
+
+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.
+
