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 licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 #define wxPD_CAN_ABORT          0x0001
  10 #define wxPD_APP_MODAL          0x0002
  11 #define wxPD_AUTO_HIDE          0x0004
  12 #define wxPD_ELAPSED_TIME       0x0008
  13 #define wxPD_ESTIMATED_TIME     0x0010
  14 #define wxPD_SMOOTH             0x0020
  15 #define wxPD_REMAINING_TIME     0x0040
  16 #define wxPD_CAN_SKIP           0x0080
  17
  18 /**
  19     @class wxProgressDialog
  20
  21     This class represents a dialog that shows a short message and a
  22     progress bar. Optionally, it can display ABORT and SKIP buttons, and
  23     the elapsed, remaining and estimated time for the end of the progress.
  24
  25     Note that you must be aware that wxProgressDialog internally calls
  26     wxEventLoopBase::YieldFor with @c wxEVT_CATEGORY_UI and @c wxEVT_CATEGORY_USER_INPUT
  27     and this may cause unwanted re-entrancies or the out-of-order processing
  28     of pending events (to help preventing the last problem if you're using
  29     wxProgressDialog in a multi-threaded application you should be sure to use
  30     wxThreadEvent for your inter-threads communications).
  31
  32     @beginStyleTable
  33     @style{wxPD_APP_MODAL}
  34            Make the progress dialog modal. If this flag is not given, it is
  35            only "locally" modal - that is the input to the parent window is
  36            disabled, but not to the other ones.
  37     @style{wxPD_AUTO_HIDE}
  38            Causes the progress dialog to disappear from screen as soon as the
  39            maximum value of the progress meter has been reached.
  40            If this style is not present, the dialog will become a modal dialog
  41            (see wxDialog::ShowModal) once the maximum value has been reached
  42            and wait for the user to dismiss it.
  43     @style{wxPD_SMOOTH}
  44            Causes smooth progress of the gauge control (uses a wxGauge with the
  45            @c wxGA_SMOOTH style).
  46     @style{wxPD_CAN_ABORT}
  47            This flag tells the dialog that it should have a "Cancel" button
  48            which the user may press. If this happens, the next call to
  49            Update() will return @false.
  50     @style{wxPD_CAN_SKIP}
  51            This flag tells the dialog that it should have a "Skip" button
  52            which the user may press. If this happens, the next call to
  53            Update() will return @true in its skip parameter.
  54     @style{wxPD_ELAPSED_TIME}
  55            This flag tells the dialog that it should show elapsed time (since
  56            creating the dialog).
  57     @style{wxPD_ESTIMATED_TIME}
  58            This flag tells the dialog that it should show estimated time.
  59     @style{wxPD_REMAINING_TIME}
  60            This flag tells the dialog that it should show remaining time.
  61     @endStyleTable
  62
  63     @library{wxbase}
  64     @category{cmndlg}
  65 */
  66 class wxProgressDialog : public wxDialog
  67 {
  68 public:
  69     /**
  70         Constructor. Creates the dialog, displays it and disables user input
  71         for other windows, or, if @c wxPD_APP_MODAL flag is not given, for its
  72         parent window only.
  73
  74         @param title
  75             Dialog title to show in titlebar.
  76         @param message
  77             Message displayed above the progress bar.
  78         @param maximum
  79             Maximum value for the progress bar.
  80             In the generic implementation the progress bar is constructed
  81             only if this value is greater than zero.
  82         @param parent
  83             Parent window.
  84         @param style
  85             The dialog style. See wxProgressDialog.
  86     */
  87     wxProgressDialog(const wxString& title, const wxString& message,
  88                      int maximum = 100,
  89                      wxWindow* parent = NULL,
  90                      int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL);
  91
  92     /**
  93         Destructor. Deletes the dialog and enables all top level windows.
  94     */
  95     virtual ~wxProgressDialog();
  96
  97     /**
  98         Returns the last value passed to the Update() function or
  99         @c wxNOT_FOUND if the dialog has no progress bar.
 100
 101         @since 2.9.0
 102     */
 103     int GetValue() const;
 104
 105     /**
 106         Returns the maximum value of the progress meter, as passed to
 107         the constructor or @c wxNOT_FOUND if the dialog has no progress bar.
 108
 109         @since 2.9.0
 110     */
 111     int GetRange() const;
 112
 113     /**
 114         Returns the last message passed to the Update() function;
 115         if you always passed wxEmptyString to Update() then the message
 116         set through the constructor is returned.
 117
 118         @since 2.9.0
 119     */
 120     wxString GetMessage() const;
 121
 122     /**
 123         Like Update() but makes the gauge control run in indeterminate mode.
 124
 125         In indeterminate mode the remaining and the estimated time labels (if
 126         present) are set to "Unknown" or to @a newmsg (if it's non-empty).
 127         Each call to this function moves the progress bar a bit to indicate
 128         that some progress was done.
 129
 130         @see wxGauge::Pulse(), Update()
 131     */
 132     virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool* skip = NULL);
 133
 134     /**
 135         Can be used to continue with the dialog, after the user had clicked the "Abort" button.
 136     */
 137     void Resume();
 138
 139     /**
 140         Changes the maximum value of the progress meter given in the constructor.
 141         This function can only be called (with a positive value) if the value passed
 142         in the constructor was positive.
 143
 144         @since 2.9.1
 145     */
 146     void SetRange(int maximum);
 147
 148
 149       /**
 150          Returns true if the "Cancel" button was pressed.
 151
 152          Normally a Cancel button press is indicated by Update() returning
 153          @false but sometimes it may be more convenient to check if the dialog
 154          was cancelled from elsewhere in the code and this function allows to
 155          do it.
 156
 157          It always returns @false if the Cancel button is not shown at all.
 158
 159          @since 2.9.1
 160      */
 161     bool WasCancelled() const;
 162
 163      /**
 164          Returns true if the "Skip" button was pressed.
 165
 166          This is similar to WasCancelled() but returns @true if the "Skip"
 167          button was pressed, not the "Cancel" one.
 168
 169          @since 2.9.1
 170      */
 171     bool WasSkipped() const;
 172
 173
 174     /**
 175         Updates the dialog, setting the progress bar to the new value and
 176         updating the message if new one is specified.
 177
 178         Returns @true unless the "Cancel" button has been pressed.
 179
 180         If @false is returned, the application can either immediately destroy the
 181         dialog or ask the user for the confirmation and if the abort is not confirmed
 182         the dialog may be resumed with Resume() function.
 183
 184         If @a value is the maximum value for the dialog, the behaviour of the
 185         function depends on whether @c wxPD_AUTO_HIDE was used when the dialog
 186         was created. If it was, the dialog is hidden and the function returns
 187         immediately. If it was not, the dialog becomes a modal dialog and waits
 188         for the user to dismiss it, meaning that this function does not return
 189         until this happens.
 190
 191         Notice that you may want to call Fit() to change the dialog size to
 192         conform to the length of the new message if desired. The dialog does
 193         not do this automatically.
 194
 195         @param value
 196             The new value of the progress meter. It should be less than or equal to
 197             the maximum value given to the constructor.
 198         @param newmsg
 199             The new messages for the progress dialog text, if it is
 200             empty (which is the default) the message is not changed.
 201         @param skip
 202             If "Skip" button was pressed since last Update() call,
 203             this is set to @true.
 204     */
 205     virtual bool Update(int value, const wxString& newmsg = wxEmptyString,
 206                         bool* skip = NULL);
 207 };
 208