include/wx/generic/progdlgg.h

   1 ////////////////////////////////////////////////////
   2 // Name:        progdlgg.h
   3 // Purpose:     wxProgressDialog class
   4 // Author:      Karsten Ballüder
   5 // Modified by:
   6 // Created:     09.05.1999
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Karsten Ballüder
   9 // Licence:     wxWindows licence
  10 ////////////////////////////////////////////////////
  11
  12 #ifndef __PROGDLGH_G__
  13 #define __PROGDLGH_G__
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "progdlgg.h"
  17 #endif
  18
  19 #include "wx/setup.h"
  20
  21 #if wxUSE_PROGRESSDLG
  22
  23 #include "wx/dialog.h"
  24
  25 class WXDLLEXPORT wxButton;
  26 class WXDLLEXPORT wxGauge;
  27 class WXDLLEXPORT wxStaticText;
  28
  29 /* Progress dialog which shows a moving progress bar.
  30     Taken from the Mahogany project.*/
  31
  32 class WXDLLEXPORT wxProgressDialog : public wxDialog
  33 {
  34 DECLARE_DYNAMIC_CLASS(wxProgressDialog)
  35 public:
  36    /* Creates and displays dialog, disables event handling for other
  37        frames or parent frame to avoid recursion problems.
  38        @param title title for window
  39        @param message message to display in window
  40        @param maximum value for status bar, if <= 0, no bar is shown
  41        @param parent window or NULL
  42        @param style is the bit mask of wxPD_XXX constants from wx/defs.h
  43    */
  44    wxProgressDialog(const wxString &title, wxString const &message,
  45                     int maximum = 100,
  46                     wxWindow *parent = NULL,
  47                     int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE);
  48    /* Destructor.
  49        Re-enables event handling for other windows.
  50    */
  51    ~wxProgressDialog();
  52
  53    /* Update the status bar to the new value.
  54        @param value new value
  55        @param newmsg if used, new message to display
  56        @returns true if ABORT button has not been pressed
  57    */
  58    virtual bool Update(int value, const wxString& newmsg = wxEmptyString);
  59
  60    /* Can be called to continue after the cancel button has been pressed, but
  61        the program decided to continue the operation (e.g., user didn't
  62        confirm it)
  63    */
  64    void Resume();
  65
  66    bool Show( bool show = true );
  67
  68 protected:
  69    // callback for optional abort button
  70    void OnCancel(wxCommandEvent& event);
  71
  72    // callback to disable "hard" window closing
  73    void OnClose(wxCloseEvent& event);
  74
  75    // must be called to reenable the other windows temporarily disabled while
  76    // the dialog was shown
  77    void ReenableOtherWindows();
  78
  79 private:
  80    // create the label with given text and another one to show the time nearby
  81    // as the next windows in the sizer, returns the created control
  82    wxStaticText *CreateLabel(const wxString& text, wxSizer *sizer);
  83
  84    // the status bar
  85    wxGauge *m_gauge;
  86    // the message displayed
  87    wxStaticText *m_msg;
  88    // displayed elapsed, estimated, remaining time
  89    class wxStaticText *m_elapsed,
  90                       *m_estimated,
  91                       *m_remaining;
  92    // time when the dialog was created
  93    unsigned long m_timeStart;
  94    // time when the dialog was closed or cancelled
  95    unsigned long m_timeStop;
  96    // time between the moment the dialog was closed/cancelled and resume
  97    unsigned long m_break;
  98
  99    // parent top level window (may be NULL)
 100    wxWindow *m_parentTop;
 101
 102    // continue processing or not (return value for Update())
 103    enum
 104    {
 105       Uncancelable = -1,   // dialog can't be canceled
 106       Canceled,            // can be cancelled and, in fact, was
 107       Continue,            // can be cancelled but wasn't
 108       Finished             // finished, waiting to be removed from screen
 109    } m_state;
 110
 111    // the abort button (or NULL if none)
 112    wxButton *m_btnAbort;
 113
 114    // the maximum value
 115    int m_maximum;
 116
 117    // saves the time when elapsed time was updated so there is only one
 118    // update per second
 119    unsigned long m_last_timeupdate;
 120    // tells how often a change of the estimated time has to be confirmed
 121    // before it is actually displayed - this reduces the frequence of updates
 122    // of estimated and remaining time
 123    const int m_delay;
 124    // counts the confirmations
 125    int m_ctdelay;
 126    unsigned long m_display_estimated;
 127
 128 #if defined(__WXMSW__ ) || defined(__WXPM__)
 129    // the factor we use to always keep the value in 16 bit range as the native
 130    // control only supports ranges from 0 to 65,535
 131    size_t m_factor;
 132 #endif // __WXMSW__
 133
 134    // for wxPD_APP_MODAL case
 135    class WXDLLEXPORT wxWindowDisabler *m_winDisabler;
 136
 137    DECLARE_EVENT_TABLE()
 138 private:
 139     // Virtual function hiding supression
 140     virtual void Update() { wxDialog::Update(); }
 141
 142     DECLARE_NO_COPY_CLASS(wxProgressDialog)
 143 };
 144 #endif
 145
 146 #endif
 147     // __PROGDLGH_G__