-class WXDLLEXPORT wxProgressDialog : public wxDialog
-{
-DECLARE_DYNAMIC_CLASS(wxProgressDialog)
-public:
- /* Creates and displays dialog, disables event handling for other
- frames or parent frame to avoid recursion problems.
- @param title title for window
- @param message message to display in window
- @param maximum value for status bar, if <= 0, no bar is shown
- @param parent window or NULL
- @param style is the bit mask of wxPD_XXX constants from wx/defs.h
- */
- wxProgressDialog(const wxString &title, wxString const &message,
- int maximum = 100,
- wxWindow *parent = NULL,
- int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE);
- /* Destructor.
- Re-enables event handling for other windows.
- */
- ~wxProgressDialog();
-
- /* Update the status bar to the new value.
- @param value new value
- @param newmsg if used, new message to display
- @returns true if ABORT button has not been pressed
- */
- bool Update(int value = -1, const wxString& newmsg = wxT(""));
-
- /* Can be called to continue after the cancel button has been pressed, but
- the program decided to continue the operation (e.g., user didn't
- confirm it)
- */
- void Resume() { m_state = Continue; }
-
- // implementation from now on
- // callback for optional abort button
- void OnCancel(wxCommandEvent& event);
- // callback to disable "hard" window closing
- void OnClose(wxCloseEvent& event);
+ void SetRange(int maximum);
+
+ // Return whether "Cancel" or "Skip" button was pressed, always return
+ // false if the corresponding button is not shown.
+ bool WasCancelled() const;
+ bool WasSkipped() const;
+
+ // Must provide overload to avoid hiding it (and warnings about it)
+ virtual void Update() { wxDialog::Update(); }
+
+ virtual bool Show( bool show = true );
+
+ // This enum is an implementation detail and should not be used
+ // by user code.
+ enum State
+ {
+ Uncancelable = -1, // dialog can't be canceled
+ Canceled, // can be cancelled and, in fact, was
+ Continue, // can be cancelled but wasn't
+ Finished, // finished, waiting to be removed from screen
+ Dismissed // was closed by user after finishing
+ };
+
+protected:
+ // This ctor is used by the native MSW implementation only.
+ wxGenericProgressDialog(wxWindow *parent, int style);
+
+ void Create(const wxString& title,
+ const wxString& message,
+ int maximum,
+ wxWindow *parent,
+ int style);
+
+ // Update just the m_maximum field, this is used by public SetRange() but,
+ // unlike it, doesn't update the controls state. This makes it useful for
+ // both this class and its derived classes that don't use m_gauge to
+ // display progress.
+ void SetMaximum(int maximum);
+
+ // Return the labels to use for showing the elapsed/estimated/remaining
+ // times respectively.
+ static wxString GetElapsedLabel() { return _("Elapsed time:"); }
+ static wxString GetEstimatedLabel() { return _("Estimated time:"); }
+ static wxString GetRemainingLabel() { return _("Remaining time:"); }
+
+
+ // Similar to wxWindow::HasFlag() but tests for a presence of a wxPD_XXX
+ // flag in our (separate) flags instead of using m_windowStyle.
+ bool HasPDFlag(int flag) const { return (m_pdStyle & flag) != 0; }
+
+ // Return the progress dialog style. Prefer to use HasPDFlag() if possible.
+ int GetPDStyle() const { return m_pdStyle; }
+
+
+ // Updates estimated times from a given progress bar value and stores the
+ // results in provided arguments.
+ void UpdateTimeEstimates(int value,
+ unsigned long &elapsedTime,
+ unsigned long &estimatedTime,
+ unsigned long &remainingTime);
+
+ // Converts seconds to HH:mm:ss format.
+ static wxString GetFormattedTime(unsigned long timeInSec);
+
+ // callback for optional abort button
+ void OnCancel(wxCommandEvent&);
+
+ // callback for optional skip button
+ void OnSkip(wxCommandEvent&);
+
+ // callback to disable "hard" window closing
+ void OnClose(wxCloseEvent&);
+
+ // called to disable the other windows while this dialog is shown
+ void DisableOtherWindows();
+
+ // must be called to reenable the other windows temporarily disabled while
+ // the dialog was shown
+ void ReenableOtherWindows();
+
+ // return the top level parent window of this dialog (may be NULL)
+ wxWindow *GetTopParent() const { return m_parentTop; }
+
+
+ // continue processing or not (return value for Update())
+ State m_state;
+
+ // the maximum value
+ int m_maximum;
+
+#if defined(__WXMSW__ ) || defined(__WXPM__)
+ // the factor we use to always keep the value in 16 bit range as the native
+ // control only supports ranges from 0 to 65,535
+ size_t m_factor;
+#endif // __WXMSW__
+
+ // time when the dialog was created
+ unsigned long m_timeStart;
+ // time when the dialog was closed or cancelled
+ unsigned long m_timeStop;
+ // time between the moment the dialog was closed/cancelled and resume
+ unsigned long m_break;