interface/progdlg.h

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