include/wx/generic/progdlgg.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        progdlgg.h
   3 // Purpose:     wxProgressDialog class
   4 // Author:      Karsten Ballueder
   5 // Modified by: Francesco Montorsi
   6 // Created:     09.05.1999
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Karsten Ballueder
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __PROGDLGH_G__
  13 #define __PROGDLGH_G__
  14
  15 #include "wx/defs.h"
  16 #include "wx/progdlg.h"
  17
  18 #if wxUSE_PROGRESSDLG
  19
  20 #include "wx/dialog.h"
  21
  22 class WXDLLIMPEXP_FWD_CORE wxButton;
  23 class WXDLLIMPEXP_FWD_CORE wxGauge;
  24 class WXDLLIMPEXP_FWD_CORE wxStaticText;
  25
  26 /*
  27     Progress dialog which shows a moving progress bar.
  28     Taken from the Mahogany project.
  29 */
  30 class WXDLLIMPEXP_CORE wxProgressDialog : public wxDialog
  31 {
  32 public:
  33     wxProgressDialog(const wxString& title, const wxString& message,
  34                      int maximum = 100,
  35                      wxWindow *parent = NULL,
  36                      int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE);
  37
  38     virtual ~wxProgressDialog();
  39
  40     virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL);
  41     virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool *skip = NULL);
  42
  43     void Resume();
  44
  45     int GetValue() const;
  46     int GetRange() const;
  47     wxString GetMessage() const;
  48
  49     void SetRange(int maximum);
  50
  51     // Must provide overload to avoid hiding it (and warnings about it)
  52     virtual void Update() { wxDialog::Update(); }
  53
  54     virtual bool Show( bool show = true );
  55
  56 protected:
  57     // callback for optional abort button
  58     void OnCancel(wxCommandEvent&);
  59
  60     // callback for optional skip button
  61     void OnSkip(wxCommandEvent&);
  62
  63     // callback to disable "hard" window closing
  64     void OnClose(wxCloseEvent&);
  65
  66     // must be called to reenable the other windows temporarily disabled while
  67     // the dialog was shown
  68     void ReenableOtherWindows();
  69
  70 private:
  71     // create the label with given text and another one to show the time nearby
  72     // as the next windows in the sizer, returns the created control
  73     wxStaticText *CreateLabel(const wxString& text, wxSizer *sizer);
  74
  75     // updates the label message
  76     void UpdateMessage(const wxString &newmsg);
  77
  78     // common part of Update() and Pulse(), returns true if not cancelled
  79     bool DoAfterUpdate(bool *skip);
  80
  81     // shortcuts for enabling buttons
  82     void EnableClose();
  83     void EnableSkip(bool enable = true);
  84     void EnableAbort(bool enable = true);
  85     void DisableSkip() { EnableSkip(false); }
  86     void DisableAbort() { EnableAbort(false); }
  87
  88     // the widget displaying current status (may be NULL)
  89     wxGauge *m_gauge;
  90     // the message displayed
  91     wxStaticText *m_msg;
  92     // displayed elapsed, estimated, remaining time
  93     wxStaticText *m_elapsed,
  94                  *m_estimated,
  95                  *m_remaining;
  96     // time when the dialog was created
  97     unsigned long m_timeStart;
  98     // time when the dialog was closed or cancelled
  99     unsigned long m_timeStop;
 100     // time between the moment the dialog was closed/cancelled and resume
 101     unsigned long m_break;
 102
 103     // parent top level window (may be NULL)
 104     wxWindow *m_parentTop;
 105
 106     // continue processing or not (return value for Update())
 107     enum
 108     {
 109         Uncancelable = -1,   // dialog can't be canceled
 110         Canceled,            // can be cancelled and, in fact, was
 111         Continue,            // can be cancelled but wasn't
 112         Finished             // finished, waiting to be removed from screen
 113     } m_state;
 114
 115     // skip some portion
 116     bool m_skip;
 117
 118 #if !defined(__SMARTPHONE__)
 119     // the abort and skip buttons (or NULL if none)
 120     wxButton *m_btnAbort;
 121     wxButton *m_btnSkip;
 122 #endif
 123
 124     // the maximum value
 125     int m_maximum;
 126
 127     // saves the time when elapsed time was updated so there is only one
 128     // update per second
 129     unsigned long m_last_timeupdate;
 130     // tells how often a change of the estimated time has to be confirmed
 131     // before it is actually displayed - this reduces the frequence of updates
 132     // of estimated and remaining time
 133     const int m_delay;
 134     // counts the confirmations
 135     int m_ctdelay;
 136     unsigned long m_display_estimated;
 137
 138     bool m_hasAbortButton,
 139          m_hasSkipButton;
 140
 141 #if defined(__WXMSW__ ) || defined(__WXPM__)
 142     // the factor we use to always keep the value in 16 bit range as the native
 143     // control only supports ranges from 0 to 65,535
 144     size_t m_factor;
 145 #endif // __WXMSW__
 146
 147     // for wxPD_APP_MODAL case
 148     class WXDLLIMPEXP_FWD_CORE wxWindowDisabler *m_winDisabler;
 149
 150     DECLARE_EVENT_TABLE()
 151     DECLARE_DYNAMIC_CLASS(wxProgressDialog)
 152     wxDECLARE_NO_COPY_CLASS(wxProgressDialog);
 153 };
 154
 155 #endif // wxUSE_PROGRESSDLG
 156
 157 #endif // __PROGDLGH_G__