solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Fix references to wxEventLoop::YieldFor() in the documentation

Browse source 
It was incorrectly called wxAppConsole::YieldFor() but the function was
moved from wxAppConsole to wxEventLoopBase back in dde19c2180 (second
part of #10320: move wxApp event handling functions to wxEventLoopBase
(in particular move Yield() functions); add backward compatible
redirections to wxApp; update docs; remove global lists wxPendingEvents
and wxPendingEventsLocker, 2009-02-15).

Closes #24095.
This commit is contained in:
taler21 2023-11-27 18:38:06 +01:00 • committed by Vadim Zeitlin
parent 8cd33455fe
commit 7a1c8d39f8
2 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/doxygen/overviews/thread.h
View file

@ -36,7 +36,7 @@ To implement non-blocking operations @e without using multiple threads you have
two possible implementation choices: two possible implementation choices:
- use wxIdleEvent (e.g. to perform a long calculation while updating a progress dialog) - use wxIdleEvent (e.g. to perform a long calculation while updating a progress dialog)
- do everything at once but call wxWindow::Update() or wxApp::YieldFor(wxEVT_CATEGORY_UI) - do everything at once but call wxWindow::Update() or wxEventLoopBase::YieldFor(wxEVT_CATEGORY_UI)
periodically to update the screen. periodically to update the screen.
However, it is generally much better to run time-consuming tasks in worker threads instead However, it is generally much better to run time-consuming tasks in worker threads instead

2
interface/wx/app.h
View file

@ -936,7 +936,7 @@ public:
Works like SafeYield() with @e onlyIfNeeded == @true except that Works like SafeYield() with @e onlyIfNeeded == @true except that
it allows the caller to specify a mask of events to be processed. it allows the caller to specify a mask of events to be processed.
See wxAppConsole::YieldFor for more info. See wxEventLoopBase::YieldFor() for more info.
*/ */
virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess); virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);