synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / progdlg.h

diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h
index 89db9197ef8dad056c22d0dd6246e5b30163f9bf..99547a929b1fd61b0f935271caaf85365314f9a2 100644 (file)
--- a/interface/wx/progdlg.h
+++ b/interface/wx/progdlg.h
@@ -3,16 +3,37 @@
 // Purpose:     interface of wxProgressDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxProgressDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#define wxPD_CAN_ABORT          0x0001
+#define wxPD_APP_MODAL          0x0002
+#define wxPD_AUTO_HIDE          0x0004
+#define wxPD_ELAPSED_TIME       0x0008
+#define wxPD_ESTIMATED_TIME     0x0010
+#define wxPD_SMOOTH             0x0020
+#define wxPD_REMAINING_TIME     0x0040
+#define wxPD_CAN_SKIP           0x0080
+

 /**
 /**

-    @class wxProgressDialog
+    @class wxGenericProgressDialog

 
     This class represents a dialog that shows a short message and a
 
     This class represents a dialog that shows a short message and a

-    progress bar. Optionally, it can display ABORT and SKIP buttons,
+    progress bar. Optionally, it can display ABORT and SKIP buttons, and

     the elapsed, remaining and estimated time for the end of the progress.
 
     the elapsed, remaining and estimated time for the end of the progress.
 

+    This class provides a generic implementation of the progress dialog.  If
+    the platform has a native progress dialog available then it will be
+    accessible using the @a wxProgressDialog class, otherwise it will
+    essentially be the same as this class.
+
+    Note that you must be aware that wxProgressDialog internally calls
+    wxEventLoopBase::YieldFor with @c wxEVT_CATEGORY_UI and @c wxEVT_CATEGORY_USER_INPUT
+    and this may cause unwanted re-entrancies or the out-of-order processing
+    of pending events (to help preventing the last problem if you're using
+    wxProgressDialog in a multi-threaded application you should be sure to use
+    wxThreadEvent for your inter-threads communications).
+

     @beginStyleTable
     @style{wxPD_APP_MODAL}
            Make the progress dialog modal. If this flag is not given, it is
     @beginStyleTable
     @style{wxPD_APP_MODAL}
            Make the progress dialog modal. If this flag is not given, it is


@@ -21,8 +42,12 @@
     @style{wxPD_AUTO_HIDE}
            Causes the progress dialog to disappear from screen as soon as the
            maximum value of the progress meter has been reached.
     @style{wxPD_AUTO_HIDE}
            Causes the progress dialog to disappear from screen as soon as the
            maximum value of the progress meter has been reached.

+           If this style is not present, the dialog will become a modal dialog
+           (see wxDialog::ShowModal) once the maximum value has been reached
+           and wait for the user to dismiss it.

     @style{wxPD_SMOOTH}
     @style{wxPD_SMOOTH}

-           Causes smooth progress of the gauge control.
+           Causes smooth progress of the gauge control (uses a wxGauge with the
+           @c wxGA_SMOOTH style).

     @style{wxPD_CAN_ABORT}
            This flag tells the dialog that it should have a "Cancel" button
            which the user may press. If this happens, the next call to
     @style{wxPD_CAN_ABORT}
            This flag tells the dialog that it should have a "Cancel" button
            which the user may press. If this happens, the next call to


@@ -43,7 +68,7 @@
     @library{wxbase}
     @category{cmndlg}
 */
     @library{wxbase}
     @category{cmndlg}
 */

-class wxProgressDialog : public wxDialog
+class wxGenericProgressDialog : public wxDialog

 {
 public:
     /**
 {
 public:
     /**


@@ -57,29 +82,59 @@ public:
             Message displayed above the progress bar.
         @param maximum
             Maximum value for the progress bar.
             Message displayed above the progress bar.
         @param maximum
             Maximum value for the progress bar.

+            In the generic implementation the progress bar is constructed
+            only if this value is greater than zero.

         @param parent
             Parent window.
         @param style
             The dialog style. See wxProgressDialog.
     */
         @param parent
             Parent window.
         @param style
             The dialog style. See wxProgressDialog.
     */

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

 
     /**
         Destructor. Deletes the dialog and enables all top level windows.
     */
 
     /**
         Destructor. Deletes the dialog and enables all top level windows.
     */

-    ~wxProgressDialog();
+    virtual ~wxGenericProgressDialog();
+
+    /**
+        Returns the last value passed to the Update() function or
+        @c wxNOT_FOUND if the dialog has no progress bar.
+
+        @since 2.9.0
+    */
+    int GetValue() const;
+
+    /**
+        Returns the maximum value of the progress meter, as passed to
+        the constructor or @c wxNOT_FOUND if the dialog has no progress bar.
+
+        @since 2.9.0
+    */
+    int GetRange() const;

 
     /**
 
     /**

-        Works like Update() but makes the gauge control run in indeterminate mode
-        (see wxGauge documentation); sets the remaining and the estimated time labels
-        (if present) to "Unknown" or to @a newmsg (if it's non-empty); moves the progress
-        bar a bit to indicate that some progress was done.
+        Returns the last message passed to the Update() function;
+        if you always passed wxEmptyString to Update() then the message
+        set through the constructor is returned.
+
+        @since 2.9.0

     */
     */

-    virtual bool Pulse(const wxString& newmsg = "",
-                       bool* skip = NULL);
+    wxString GetMessage() const;
+
+    /**
+        Like Update() but makes the gauge control run in indeterminate mode.
+
+        In indeterminate mode the remaining and the estimated time labels (if
+        present) are set to "Unknown" or to @a newmsg (if it's non-empty).
+        Each call to this function moves the progress bar a bit to indicate
+        that some progress was done.
+
+        @see wxGauge::Pulse(), Update()
+    */
+    virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool* skip = NULL);

 
     /**
         Can be used to continue with the dialog, after the user had clicked the "Abort" button.
 
     /**
         Can be used to continue with the dialog, after the user had clicked the "Abort" button.


@@ -87,18 +142,64 @@ public:
     void Resume();
 
     /**
     void Resume();
 
     /**

-        Updates the dialog, setting the progress bar to the new value and, if
-        given changes the message above it. Returns @true unless the "Cancel" button
-        has been pressed.
+        Changes the maximum value of the progress meter given in the constructor.
+        This function can only be called (with a positive value) if the value passed 
+        in the constructor was positive.
+
+        @since 2.9.1
+    */
+    void SetRange(int maximum);
+
+
+      /**
+         Returns true if the "Cancel" button was pressed.
+
+         Normally a Cancel button press is indicated by Update() returning
+         @false but sometimes it may be more convenient to check if the dialog
+         was cancelled from elsewhere in the code and this function allows to
+         do it.
+
+         It always returns @false if the Cancel button is not shown at all.
+
+         @since 2.9.1
+     */
+    bool WasCancelled() const;
+
+     /**
+         Returns true if the "Skip" button was pressed.
+
+         This is similar to WasCancelled() but returns @true if the "Skip"
+         button was pressed, not the "Cancel" one.
+
+         @since 2.9.1
+     */
+    bool WasSkipped() const;
+
+
+    /**
+        Updates the dialog, setting the progress bar to the new value and
+        updating the message if new one is specified.
+
+        Returns @true unless the "Cancel" button has been pressed.

 
         If @false is returned, the application can either immediately destroy the
         dialog or ask the user for the confirmation and if the abort is not confirmed
         the dialog may be resumed with Resume() function.
 
 
         If @false is returned, the application can either immediately destroy the
         dialog or ask the user for the confirmation and if the abort is not confirmed
         the dialog may be resumed with Resume() function.
 

+        If @a value is the maximum value for the dialog, the behaviour of the
+        function depends on whether @c wxPD_AUTO_HIDE was used when the dialog
+        was created. If it was, the dialog is hidden and the function returns
+        immediately. If it was not, the dialog becomes a modal dialog and waits
+        for the user to dismiss it, meaning that this function does not return
+        until this happens.
+
+        Notice that you may want to call Fit() to change the dialog size to
+        conform to the length of the new message if desired. The dialog does
+        not do this automatically.
+

         @param value
             The new value of the progress meter. It should be less than or equal to
         @param value
             The new value of the progress meter. It should be less than or equal to

-            the maximum value given to the constructor and the dialog is closed if
-            it is equal to the maximum.
+            the maximum value given to the constructor.

         @param newmsg
             The new messages for the progress dialog text, if it is
             empty (which is the default) the message is not changed.
         @param newmsg
             The new messages for the progress dialog text, if it is
             empty (which is the default) the message is not changed.


@@ -106,7 +207,24 @@ public:
             If "Skip" button was pressed since last Update() call,
             this is set to @true.
     */
             If "Skip" button was pressed since last Update() call,
             this is set to @true.
     */

-    virtual bool Update(int value, const wxString& newmsg = "",
+    virtual bool Update(int value, const wxString& newmsg = wxEmptyString,

                         bool* skip = NULL);
 };
 
                         bool* skip = NULL);
 };
 

+
+
+
+/**
+    @class wxProgressDialog
+
+    If supported by the platform this class will provide the platform's native
+    progress dialog, else it will simply be the @a wxGenericProgressDialog.
+*/
+class wxProgressDialog : public wxGenericProgressDialog
+{
+public:
+    wxProgressDialog( const wxString& title, const wxString& message,
+                      int maximum = 100,
+                      wxWindow *parent = NULL,
+                      int style = wxPD_APP_MODAL | wxPD_AUTO_HIDE );
+};