Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/busyinfo.h b/interface/wx/busyinfo.h
index 9b3b901583ea8393c3f72393bfec9895bf8b2d30..0953d49f9d77107ad973bba3a7a52c5158b0d16d 100644 (file)
--- a/interface/wx/busyinfo.h
+++ b/interface/wx/busyinfo.h
@@ -2,8 +2,7 @@
 // Name:        busyinfo.h
 // Purpose:     interface of wxBusyInfo
 // Author:      wxWidgets team
 // Name:        busyinfo.h
 // Purpose:     interface of wxBusyInfo
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -27,13 +26,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++)


@@ -41,7 +39,7 @@
             DoACalculation();
 
             if ( !(i % 1000) )
             DoACalculation();
 
             if ( !(i % 1000) )

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

         }
     @endcode
 
         }
     @endcode
 


@@ -49,6 +47,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}
 */