compilation fix after TRUE/FALSE change

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index c71c82dbecb988a152a8070971314b0bdf251c22..00aff20c0caaf9bb236d65ce66e45f5173a7aba8 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -424,7 +424,6 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
 \wxheading{See also}
 
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
 \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}
 \helpref{wxCloseEvent}{wxcloseevent}
 %% GD: OnXXX functions are not documented
 %%\helpref{wxApp::OnEndSession}{wxapponendsession}


@@ -482,7 +481,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}
 
 %% GD: OnXXX functions are not documented
 %%\helpref{wxApp::OnIdle}{wxapponidle}

-\helpref{wxWindow::OnIdle}{wxwindowonidle},\rtfsp

 \helpref{wxIdleEvent}{wxidleevent}
 
 \membersection{wxApp::SetAppName}\label{wxappsetappname}
 \helpref{wxIdleEvent}{wxidleevent}
 
 \membersection{wxApp::SetAppName}\label{wxappsetappname}


@@ -571,20 +569,6 @@ wxWindows.
 
 \helpref{wxApp::GetVendorName}{wxappgetvendorname}
 
 
 \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}}
 \membersection{wxApp::SetUseBestVisual}\label{wxappsetusebestvisual}
 
 \func{void}{SetUseBestVisual}{\param{bool}{ flag}}


@@ -603,3 +587,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.
+