added wxApp::Yield()
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12095 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -2143,22 +2143,10 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
|
||||
|
||||
\func{bool}{wxYield}{\void}
|
||||
|
||||
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.
|
||||
Calls \helpref{wxApp::Yield}{wxappyield}.
|
||||
|
||||
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 wxYield will not flush the message logs. This is intentional as
|
||||
calling wxYield 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}.
|
||||
This function is kept only for backwards compatibility, please use the
|
||||
wxApp method instead in any new code.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
|
Reference in New Issue
Block a user