wxXML load/save improvements: added ability to not ignore whitespace and specify...

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

diff --git a/include/wx/generic/progdlgg.h b/include/wx/generic/progdlgg.h
index 11c64d291efbedff7f37d5a61db65a647dbe4852..44467b1836a60eb2a338102c770c6f5ee0bd1202 100644 (file)
--- a/include/wx/generic/progdlgg.h
+++ b/include/wx/generic/progdlgg.h
@@ -6,17 +6,14 @@
 // 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__
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "progdlgg.h"
-#endif
-
-#include "wx/setup.h"
+#include "wx/defs.h"
+#include "wx/progdlg.h"

 
 #if wxUSE_PROGRESSDLG
 
 
 #if wxUSE_PROGRESSDLG
 


@@ -48,14 +45,21 @@ public:
    /* Destructor.
        Re-enables event handling for other windows.
    */
    /* Destructor.
        Re-enables event handling for other windows.
    */

-   ~wxProgressDialog();
+   virtual ~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
    */
 
    /* 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, const wxString& newmsg = wxT(""));
+   virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL);
+
+    /* Switches the dialog to use a gauge in indeterminate mode and calls
+       wxGauge::Pulse() to show to the user a bit of progress */
+    virtual bool UpdatePulse(const wxString& newmsg = wxEmptyString, bool *skip = NULL);
+
+    // Must provide overload to avoid hiding it (and warnings about it)
+    virtual void Update() { wxDialog::Update(); }

 
    /* 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
 
    /* 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


@@ -63,12 +67,15 @@ public:
    */
    void Resume();
 
    */
    void Resume();
 

-   bool Show( bool show = TRUE );
+   virtual bool Show( bool show = true );

 
 protected:
    // callback for optional abort button
    void OnCancel(wxCommandEvent& event);
 
 
 protected:
    // callback for optional abort button
    void OnCancel(wxCommandEvent& event);
 

+   // callback for optional skip button
+   void OnSkip(wxCommandEvent& event);
+

    // callback to disable "hard" window closing
    void OnClose(wxCloseEvent& event);
 
    // callback to disable "hard" window closing
    void OnClose(wxCloseEvent& event);
 


@@ -78,9 +85,18 @@ protected:
 
 private:
    // create the label with given text and another one to show the time nearby
 
 private:
    // create the label with given text and another one to show the time nearby

-   // under the lastWindow and modify it to be the same as the control created
-   // (which is returned)
-   wxStaticText *CreateLabel(const wxString& text, wxWindow **lastWindow);
+   // as the next windows in the sizer, returns the created control
+   wxStaticText *CreateLabel(const wxString& text, wxSizer *sizer);
+
+    // updates the label message
+   void UpdateMessage(const wxString &newmsg);
+
+   // 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 status bar
    wxGauge *m_gauge;


@@ -92,40 +108,62 @@ private:
                       *m_remaining;
    // time when the dialog was created
    unsigned long m_timeStart;
                       *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;
 
 
    // 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;
+    // 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
+
+    // the maximum value
+    int m_maximum;

 
 

-   // the abort button (or NULL if none)
-   wxButton *m_btnAbort;
+    // 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;

 
 

-   // the maximum value
-   int m_maximum;
+    bool m_hasAbortButton,
+         m_hasSkipButton;

 
 #if defined(__WXMSW__ ) || defined(__WXPM__)
 
 #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;
+    // 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__
 
 #endif // __WXMSW__
 

-   // for wxPD_APP_MODAL case
-   class WXDLLEXPORT wxWindowDisabler *m_winDisabler;
+    // for wxPD_APP_MODAL case
+    class WXDLLEXPORT wxWindowDisabler *m_winDisabler;

 
 

-   DECLARE_EVENT_TABLE()
-private:
-    // Virtual function hiding supression
-    virtual void Update() { wxDialog::Update(); }
+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxProgressDialog)

 };
 };

-#endif

 
 

-#endif
-    // __PROGDLGH_G__
+#endif // wxUSE_PROGRESSDLG
+
+#endif // __PROGDLGH_G__