we need our own imaglist implementation because in wxmac wxIcon does not inherit...

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

diff --git a/include/wx/generic/progdlgg.h b/include/wx/generic/progdlgg.h
index 2401275d14d9a0333fa1eeb588e3b571896b4d50..4256feee73944ff1494313a9c3627efb98843ef1 100644 (file)
--- a/include/wx/generic/progdlgg.h
+++ b/include/wx/generic/progdlgg.h
@@ -1,4 +1,4 @@
-/////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////

 // Name:        progdlgg.h
 // Purpose:     wxProgressDialog class
 // Author:      Karsten Ballüder
 // Name:        progdlgg.h
 // Purpose:     wxProgressDialog class
 // Author:      Karsten Ballüder


@@ -6,85 +6,161 @@
 // Created:     09.05.1999
 // RCS-ID:      $Id$
 // Copyright:   (c) Karsten Ballüder
 // Created:     09.05.1999
 // RCS-ID:      $Id$
 // Copyright:   (c) Karsten Ballüder

-// Licence:    wxWindows license
-/////////////////////////////////////////////////////////////////////////////
+// Licence:     wxWindows licence
+////////////////////////////////////////////////////

 
 #ifndef __PROGDLGH_G__
 #define __PROGDLGH_G__
 
 
 #ifndef __PROGDLGH_G__
 #define __PROGDLGH_G__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "progdlgg.h"
 #endif
 
 #pragma interface "progdlgg.h"
 #endif
 

-#include "wx/setup.h"
-#include "wx/frame.h"
+#include "wx/defs.h"

 
 

+#if wxUSE_PROGRESSDLG

 
 

+#include "wx/dialog.h"

 
 

-/** Progress dialog which shows a moving progress bar.
+class WXDLLEXPORT wxButton;
+class WXDLLEXPORT wxGauge;
+class WXDLLEXPORT wxStaticText;
+
+/* Progress dialog which shows a moving progress bar.

     Taken from the Mahogany project.*/
 
     Taken from the Mahogany project.*/
 

-class WXDLLEXPORT wxProgressDialog : public wxFrame
+class WXDLLEXPORT wxProgressDialog : public wxDialog

 {
 DECLARE_DYNAMIC_CLASS(wxProgressDialog)
 public:
 {
 DECLARE_DYNAMIC_CLASS(wxProgressDialog)
 public:

-   /** Creates and displays dialog, disables event handling for other
+   /* 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
        frames or parent frame to avoid recursion problems.
        @param title title for window
        @param message message to display in window

-       @param maximum maximum value for status bar, if <= 0, no bar is shown
+       @param maximum value for status bar, if <= 0, no bar is shown

        @param parent window or NULL
        @param parent window or NULL

-       @param disableParentOnly if true, only disable parent window's
-       event handling
-       @param abortButton if true, dialog will show an abort button
+       @param style is the bit mask of wxPD_XXX constants from wx/defs.h

    */
    wxProgressDialog(const wxString &title, wxString const &message,
    */
    wxProgressDialog(const wxString &title, wxString const &message,

-                   int maximum = 100,
-                   wxWindow *parent = NULL,
-                   bool disableParentOnly = FALSE,
-                   bool abortButton = FALSE);
-   /** Destructor.
+                    int maximum = 100,
+                    wxWindow *parent = NULL,
+                    int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE);
+   /* Destructor.

        Re-enables event handling for other windows.
    */
    ~wxProgressDialog();
 
        Re-enables event handling for other windows.
    */
    ~wxProgressDialog();
 

-   /** Update the status bar to the new value.
+   /* 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
    */
        @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 char *newmsg = NULL);
+   virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL);

 
 

-   /** Can be called to continue after the cancel button has been pressed, but
+   /* 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
        the program decided to continue the operation (e.g., user didn't

-       configrm it)
+       confirm it)

    */
    */

-   void Resume() { m_state = Continue; }
+   void Resume();
+
+   virtual bool Show( bool show = true );
+
+protected:
+   // callback for optional abort button
+   void OnCancel(wxCommandEvent& event);

 
 

-   /// Callback for optional abort button
-   void OnCancel(wxEvent& WXUNUSED(event)) { m_state = Canceled; }
+   // callback for optional skip button
+   void OnSkip(wxCommandEvent& event);

 
 

-   /// callback to disable "hard" window closing
+   // callback to disable "hard" window closing

    void OnClose(wxCloseEvent& event);
 
    void OnClose(wxCloseEvent& event);
 

+   // must be called to reenable the other windows temporarily disabled while
+   // the dialog was shown
+   void ReenableOtherWindows();
+

 private:
 private:

-   /// the status bar
-   class wxGauge *m_gauge;
-   /// the message displayed
-   class wxStaticText *m_msg;
-   /// disable all or parent window only
-   bool m_disableParentOnly;
-   /// parent window
-   class wxWindow *m_parent;
-   /// continue processing or not (return value for Update())
-   enum
-   {
-      Uncancelable = -1,   // dialog can't be canceled
-      Canceled,            // can be cancelled and, in fact, was
-      Continue             // can be cancelled but wasn't
-   } m_state;
-
-   DECLARE_EVENT_TABLE()
-};
+   // 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
+   wxStaticText *CreateLabel(const wxString& text, wxSizer *sizer);
+
+   // shortcuts for enabling buttons
+   void EnableClose();
+   void EnableSkip(bool enable=true);
+   void EnableAbort(bool enable=true);
+   inline void DisableSkip() { EnableSkip(false); }
+   inline void DisableAbort() { EnableAbort(false); }
+
+   // the status bar
+   wxGauge *m_gauge;
+   // the message displayed
+   wxStaticText *m_msg;
+   // displayed elapsed, estimated, remaining time
+   class wxStaticText *m_elapsed,
+                      *m_estimated,
+                      *m_remaining;
+   // 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;
+
+   // parent top level window (may be NULL)
+   wxWindow *m_parentTop;
+
+    // continue processing or not (return value for Update())
+    enum
+    {
+        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
+    } m_state;
+
+    // skip some portion
+    bool m_skip;
+
+#if !defined(__SMARTPHONE__)
+    // the abort and skip buttons (or NULL if none)
+    wxButton *m_btnAbort;
+    wxButton *m_btnSkip;

 #endif
 #endif

-    // __PROGDLGH_G__
+
+    // the maximum value
+    int m_maximum;
+
+    // saves the time when elapsed time was updated so there is only one
+    // update per second
+    unsigned long m_last_timeupdate;
+    // tells how often a change of the estimated time has to be confirmed
+    // before it is actually displayed - this reduces the frequence of updates
+    // of estimated and remaining time
+    const int m_delay;
+    // counts the confirmations
+    int m_ctdelay;
+    unsigned long m_display_estimated;
+
+    bool m_hasAbortButton,
+         m_hasSkipButton;
+
+#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__
+
+    // for wxPD_APP_MODAL case
+    class WXDLLEXPORT wxWindowDisabler *m_winDisabler;
+
+    DECLARE_EVENT_TABLE()
+private:
+    // Virtual function hiding supression
+    virtual void Update() { wxDialog::Update(); }
+
+    DECLARE_NO_COPY_CLASS(wxProgressDialog)
+};
+
+#endif // wxUSE_PROGRESSDLG
+
+#endif // __PROGDLGH_G__