X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..7bf2b0881a6bf28138f258504e88b2643daa854e:/interface/busyinfo.h diff --git a/interface/busyinfo.h b/interface/busyinfo.h index 450a1e9d5b..88c88810e3 100644 --- a/interface/busyinfo.h +++ b/interface/busyinfo.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: busyinfo.h -// Purpose: documentation for wxBusyInfo class +// Purpose: interface of wxBusyInfo // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,27 +17,27 @@ For example: @code - wxBusyInfo wait("Please wait, working..."); + wxBusyInfo wait("Please wait, working..."); - for (int i = 0; i 100000; i++) + for (int i = 0; i < 100000; i++) { DoACalculation(); } @endcode - It works by creating a window in the constructor, - and deleting it in the destructor. + It works by creating a window in the constructor, and deleting it + in the destructor. You may also want to call wxTheApp-Yield() to refresh the window periodically (in case it had been obscured by other windows, for example) like this: @code - wxWindowDisabler disableAll; + wxWindowDisabler disableAll; wxBusyInfo wait("Please wait, working..."); - for (int i = 0; i 100000; i++) + for (int i = 0; i < 100000; i++) { DoACalculation(); @@ -47,27 +47,26 @@ @endcode but take care to not cause undesirable reentrancies when doing it (see - wxApp::Yield for more details). The simplest way to do - it is to use wxWindowDisabler class as illustrated - in the above example. + wxApp::Yield for more details). The simplest way to do it is to use + wxWindowDisabler class as illustrated in the above example. @library{wxcore} - @category{FIXME} + @category{cmndlg} */ class wxBusyInfo { public: /** - Constructs a busy info window as child of @e parent and displays @e msg - in it. - - @b NB: If @e parent is not @NULL you must ensure that it is not - closed while the busy info is shown. + Constructs a busy info window as child of @a parent and displays @e msg in it. + + @note If @a parent is not @NULL you must ensure that it is not + closed while the busy info is shown. */ - wxBusyInfo(const wxString& msg, wxWindow* parent = @NULL); + wxBusyInfo(const wxString& msg, wxWindow* parent = NULL); /** Hides and closes the window containing the information text. */ - ~wxBusyInfo(); + virtual ~wxBusyInfo(); }; +