remove unused variable assignment, closes #14928

[wxWidgets.git] / include / wx / generic / progdlgg.h

diff --git a/include/wx/generic/progdlgg.h b/include/wx/generic/progdlgg.h
index ba03308d49a0197bf5309ce44940e9925d5670cc..4e3c3e183b5e2ec28eb774882a42ab672f6f78b3 100644 (file)
--- a/include/wx/generic/progdlgg.h
+++ b/include/wx/generic/progdlgg.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        progdlgg.h
+// Name:        wx/generic/progdlgg.h

 // Purpose:     wxGenericProgressDialog class
 // Author:      Karsten Ballueder
 // Modified by: Francesco Montorsi
 // Purpose:     wxGenericProgressDialog class
 // Author:      Karsten Ballueder
 // Modified by: Francesco Montorsi


@@ -27,6 +27,7 @@ class WXDLLIMPEXP_FWD_CORE wxWindowDisabler;
 class WXDLLIMPEXP_CORE wxGenericProgressDialog : public wxDialog
 {
 public:
 class WXDLLIMPEXP_CORE wxGenericProgressDialog : public wxDialog
 {
 public:

+    wxGenericProgressDialog();

     wxGenericProgressDialog(const wxString& title, const wxString& message,
                             int maximum = 100,
                             wxWindow *parent = NULL,
     wxGenericProgressDialog(const wxString& title, const wxString& message,
                             int maximum = 100,
                             wxWindow *parent = NULL,


@@ -34,6 +35,12 @@ public:
 
     virtual ~wxGenericProgressDialog();
 
 
     virtual ~wxGenericProgressDialog();
 

+    bool Create(const wxString& title,
+                const wxString& message,
+                int maximum = 100,
+                wxWindow *parent = NULL,
+                int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE);
+

     virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL);
     virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool *skip = NULL);
 
     virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL);
     virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool *skip = NULL);
 


@@ -57,30 +64,36 @@ public:
 
     // This enum is an implementation detail and should not be used
     // by user code.
 
     // This enum is an implementation detail and should not be used
     // by user code.

-    enum ProgressDialogState
+    enum State

     {
         Uncancelable = -1,   // dialog can't be canceled
         Canceled,            // can be cancelled and, in fact, was
         Continue,            // can be cancelled but wasn't
     {
         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
+        Finished,            // finished, waiting to be removed from screen
+        Dismissed            // was closed by user after finishing

     };
 
 protected:
     };
 
 protected:

-    // This ctor is used by the native MSW implementation only.
-    wxGenericProgressDialog(wxWindow *parent, int maximum, 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.
 
     // 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:"); }
+    static wxString GetElapsedLabel() { return wxGetTranslation("Elapsed time:"); }
+    static wxString GetEstimatedLabel() { return wxGetTranslation("Estimated time:"); }
+    static wxString GetRemainingLabel() { return wxGetTranslation("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; }
+    void SetPDStyle(int pdStyle) { m_pdStyle = pdStyle; }

 
     // Updates estimated times from a given progress bar value and stores the
     // results in provided arguments.
 
     // Updates estimated times from a given progress bar value and stores the
     // results in provided arguments.


@@ -108,12 +121,16 @@ protected:
     // the dialog was shown
     void ReenableOtherWindows();
 
     // the dialog was shown
     void ReenableOtherWindows();
 

+    // Set the top level parent we store from the parent window provided when
+    // creating the dialog.
+    void SetTopParent(wxWindow* parent);
+

     // 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())
     // 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())

-    ProgressDialogState m_state;
+    State m_state;

 
     // the maximum value
     int m_maximum;
 
     // the maximum value
     int m_maximum;


@@ -136,7 +153,7 @@ private:
     static void SetTimeLabel(unsigned long val, wxStaticText *label);
 
     // common part of all ctors
     static void SetTimeLabel(unsigned long val, wxStaticText *label);
 
     // common part of all ctors

-    void Init(wxWindow *parent, int maximum, int style);
+    void Init();

 
     // create the label with given text and another one to show the time nearby
     // as the next windows in the sizer, returns the created control
 
     // create the label with given text and another one to show the time nearby
     // as the next windows in the sizer, returns the created control


@@ -170,6 +187,12 @@ private:
     // parent top level window (may be NULL)
     wxWindow *m_parentTop;
 
     // parent top level window (may be NULL)
     wxWindow *m_parentTop;
 

+    // Progress dialog styles: this is not the same as m_windowStyle because
+    // wxPD_XXX constants clash with the existing TLW styles so to be sure we
+    // don't have any conflicts we just use a separate variable for storing
+    // them.
+    int m_pdStyle;
+

     // skip some portion
     bool m_skip;
 
     // skip some portion
     bool m_skip;
 


@@ -192,9 +215,6 @@ private:
     int m_ctdelay;
     unsigned long m_display_estimated;
 
     int m_ctdelay;
     unsigned long m_display_estimated;
 

-    bool m_hasAbortButton,
-         m_hasSkipButton;
-

     // for wxPD_APP_MODAL case
     wxWindowDisabler *m_winDisabler;
 
     // for wxPD_APP_MODAL case
     wxWindowDisabler *m_winDisabler;