interface/wx/progdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        progdlg.h
   3 // Purpose:     interface of wxProgressDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxProgressDialog
  11
  12     This class represents a dialog that shows a short message and a
  13     progress bar. Optionally, it can display ABORT and SKIP buttons, and
  14     the elapsed, remaining and estimated time for the end of the progress.
  15
  16     Note that you must be aware that wxProgressDialog internally calls
  17     wxEventLoopBase::YieldFor with @c wxEVT_CATEGORY_UI and @c wxEVT_CATEGORY_USER_INPUT
  18     and this may cause unwanted re-entrancies or the out-of-order processing
  19     of pending events (to help preventing the last problem if you're using
  20     wxProgressDialog in a multi-threaded application you should be sure to use
  21     wxThreadEvent for your inter-threads communications).
  22
  23     @beginStyleTable
  24     @style{wxPD_APP_MODAL}
  25            Make the progress dialog modal. If this flag is not given, it is
  26            only "locally" modal - that is the input to the parent window is
  27            disabled, but not to the other ones.
  28     @style{wxPD_AUTO_HIDE}
  29            Causes the progress dialog to disappear from screen as soon as the
  30            maximum value of the progress meter has been reached.
  31     @style{wxPD_SMOOTH}
  32            Causes smooth progress of the gauge control.
  33     @style{wxPD_CAN_ABORT}
  34            This flag tells the dialog that it should have a "Cancel" button
  35            which the user may press. If this happens, the next call to
  36            Update() will return @false.
  37     @style{wxPD_CAN_SKIP}
  38            This flag tells the dialog that it should have a "Skip" button
  39            which the user may press. If this happens, the next call to
  40            Update() will return @true in its skip parameter.
  41     @style{wxPD_ELAPSED_TIME}
  42            This flag tells the dialog that it should show elapsed time (since
  43            creating the dialog).
  44     @style{wxPD_ESTIMATED_TIME}
  45            This flag tells the dialog that it should show estimated time.
  46     @style{wxPD_REMAINING_TIME}
  47            This flag tells the dialog that it should show remaining time.
  48     @endStyleTable
  49
  50     @library{wxbase}
  51     @category{cmndlg}
  52 */
  53 class wxProgressDialog : public wxDialog
  54 {
  55 public:
  56     /**
  57         Constructor. Creates the dialog, displays it and disables user input
  58         for other windows, or, if @c wxPD_APP_MODAL flag is not given, for its
  59         parent window only.
  60
  61         @param title
  62             Dialog title to show in titlebar.
  63         @param message
  64             Message displayed above the progress bar.
  65         @param maximum
  66             Maximum value for the progress bar.
  67             In the generic implementation the progress bar is constructed
  68             only if this value is greater than zero.
  69         @param parent
  70             Parent window.
  71         @param style
  72             The dialog style. See wxProgressDialog.
  73     */
  74     wxProgressDialog(const wxString& title, const wxString& message,
  75                      int maximum = 100,
  76                      wxWindow* parent = NULL,
  77                      int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL);
  78
  79     /**
  80         Destructor. Deletes the dialog and enables all top level windows.
  81     */
  82     virtual ~wxProgressDialog();
  83
  84     /**
  85         Returns the last value passed to the Update() function or
  86         @c wxNOT_FOUND if the dialog has no progress bar.
  87
  88         @since 2.9.0
  89     */
  90     int GetValue() const;
  91
  92     /**
  93         Returns the maximum value of the progress meter, as passed to
  94         the constructor or @c wxNOT_FOUND if the dialog has no progress bar.
  95
  96         @since 2.9.0
  97     */
  98     int GetRange() const;
  99
 100     /**
 101         Returns the last message passed to the Update() function;
 102         if you always passed wxEmptyString to Update() then the message
 103         set through the constructor is returned.
 104
 105         @since 2.9.0
 106     */
 107     wxString GetMessage() const;
 108
 109     /**
 110         Works like Update() but makes the gauge control run in indeterminate mode
 111         (see wxGauge documentation); sets the remaining and the estimated time labels
 112         (if present) to "Unknown" or to @a newmsg (if it's non-empty); moves the progress
 113         bar a bit to indicate that some progress was done.
 114     */
 115     virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool* skip = NULL);
 116
 117     /**
 118         Can be used to continue with the dialog, after the user had clicked the "Abort" button.
 119     */
 120     void Resume();
 121
 122     /**
 123         Updates the dialog, setting the progress bar to the new value and, if
 124         given changes the message above it. Returns @true unless the "Cancel" button
 125         has been pressed.
 126
 127         If @false is returned, the application can either immediately destroy the
 128         dialog or ask the user for the confirmation and if the abort is not confirmed
 129         the dialog may be resumed with Resume() function.
 130
 131         @param value
 132             The new value of the progress meter. It should be less than or equal to
 133             the maximum value given to the constructor and the dialog is closed if
 134             it is equal to the maximum.
 135         @param newmsg
 136             The new messages for the progress dialog text, if it is
 137             empty (which is the default) the message is not changed.
 138         @param skip
 139             If "Skip" button was pressed since last Update() call,
 140             this is set to @true.
 141     */
 142     virtual bool Update(int value, const wxString& newmsg = wxEmptyString,
 143                         bool* skip = NULL);
 144 };
 145