Add documentation of emitted events to wxScrolled documentation.

[wxWidgets.git] / interface / wx / busyinfo.h

diff --git a/interface/wx/busyinfo.h b/interface/wx/busyinfo.h
index 88c88810e32e3ac6084cf16e28bd2628b1abee05..3f1aa1acfa9e1898342be5accb54727075072776 100644 (file)
--- a/interface/wx/busyinfo.h
+++ b/interface/wx/busyinfo.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxBusyInfo
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxBusyInfo
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxBusyInfo
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxBusyInfo

-    @wxheader{busyinfo.h}

 
     This class makes it easy to tell your user that the program is temporarily busy.
     Just create a wxBusyInfo object on the stack, and within the current scope,
 
     This class makes it easy to tell your user that the program is temporarily busy.
     Just create a wxBusyInfo object on the stack, and within the current scope,


@@ -28,13 +27,12 @@
     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
+    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;
     periodically (in case it had been obscured by other windows, for
     example) like this:
 
     @code
         wxWindowDisabler disableAll;

-

         wxBusyInfo wait("Please wait, working...");
 
         for (int i = 0; i < 100000; i++)
         wxBusyInfo wait("Please wait, working...");
 
         for (int i = 0; i < 100000; i++)


@@ -42,7 +40,7 @@
             DoACalculation();
 
             if ( !(i % 1000) )
             DoACalculation();
 
             if ( !(i % 1000) )

-                wxTheApp-Yield();
+                wxTheApp->Yield();

         }
     @endcode
 
         }
     @endcode
 


@@ -50,6 +48,9 @@
     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.
 

+    Note that a wxBusyInfo is always built with the @c wxSTAY_ON_TOP window style
+    (see wxFrame window styles for more info).
+

     @library{wxcore}
     @category{cmndlg}
 */
     @library{wxcore}
     @category{cmndlg}
 */