As per the wx-dev discussion in early Jan, replaced

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index f662fd4048dc601c76afea301fe4fc1eb734d8e3..b830069460c24716842917986353ef5a797fab96 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -231,7 +231,7 @@ Returns 0 under X, and the wParam of the WM\_QUIT message under Windows.
 
 This function is called when an assert failure occurs, i.e. the condition
 specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt FALSE}.
 
 This function is called when an assert failure occurs, i.e. the condition
 specified in \helpref{wxASSERT}{wxassert} macro evaluated to {\tt FALSE}.

-It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_| is defined) as
+It is only called in debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) as

 asserts are not left in the release code at all.
 
 The base class version show the default assert failure dialog box proposing to
 asserts are not left in the release code at all.
 
 The base class version show the default assert failure dialog box proposing to


@@ -425,8 +425,9 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
 
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp

-\helpref{wxCloseEvent}{wxcloseevent},\rtfsp
-\helpref{wxApp::OnEndSession}{wxapponendsession}
+\helpref{wxCloseEvent}{wxcloseevent}
+%% GD: OnXXX functions are not documented
+%%\helpref{wxApp::OnEndSession}{wxapponendsession}

 
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 
 
 \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
 


@@ -479,7 +480,10 @@ If TRUE is returned, more OnIdle processing is requested by one or more window.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxApp::OnIdle}{wxapponidle}, \helpref{wxWindow::OnIdle}{wxwindowonidle}, \helpref{wxIdleEvent}{wxidleevent}
+%% GD: OnXXX functions are not documented
+%%\helpref{wxApp::OnIdle}{wxapponidle}
+\helpref{wxWindow::OnIdle}{wxwindowonidle},\rtfsp
+\helpref{wxIdleEvent}{wxidleevent}

 
 \membersection{wxApp::SetAppName}\label{wxappsetappname}
 
 
 \membersection{wxApp::SetAppName}\label{wxappsetappname}
 


@@ -599,3 +603,29 @@ This function currently only has effect under GTK.
 
 \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}}
+
+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.
+