.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxBusyInfo 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxBusyInfo \- 
.SH DESCRIPTION

  


   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, a message window will be shown.
  
  


   For example:
  
  


  
    wxBusyInfo wait("Please wait, working...");

    for (int i = 0; i < 100000; i++)
    {
        DoACalculation();
    }

  


  


   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:
  
  


  
    wxWindowDisabler disableAll;

    wxBusyInfo wait("Please wait, working...");

    for (int i = 0; i < 100000; i++)
    {
        DoACalculation();

        if ( !(i 
            wxTheApp->Yield();
    }

  


  


   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.
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/busyinfo.h
.SH MEMBERS

  
.SS  wxBusyInfo (const wxString& msgwxWindow* parent = NULL)

     


      Constructs a busy info window as child of
      
       parent
      
      and displays
      
       msg
      
      in it.
     
     


      
       NB:
      
      If
      
       parent
      
      is not
      NULL
      you must ensure that it is not closed while the busy info is shown.
     
    
   
  
.SS  ~wxBusyInfo ()

     


      Hides and closes the window containing the information text.
     
    
 
.SH "SEE ALSO"

.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.