Add the getters

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

diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h
index 7847a230c2ba73e38e75e3af7d58447a971b6460..321a21cd10a2bd8492122d16fe7f02191036225e 100644 (file)
--- a/interface/wx/progdlg.h
+++ b/interface/wx/progdlg.h
@@ -3,9 +3,18 @@
 // 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 wxProgressDialog
 


@@ -29,9 +38,8 @@
            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
            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;
-           this results in processing of pending events and may cause
-           unwanted re-entrancies.
+           (see wxDialog::ShowModal) once the maximum value has been reached
+           and wait for the user to dismiss it.

     @style{wxPD_SMOOTH}
            Causes smooth progress of the gauge control (uses a wxGauge with the
            @c wxGA_SMOOTH style).
     @style{wxPD_SMOOTH}
            Causes smooth progress of the gauge control (uses a wxGauge with the
            @c wxGA_SMOOTH style).


@@ -115,7 +123,7 @@ public:
         Like Update() but makes the gauge control run in indeterminate mode.
 
         In indeterminate mode the remaining and the estimated time labels (if
         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 to "Unknown" or to @a newmsg (if it's non-empty).
+        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.
 
         Each call to this function moves the progress bar a bit to indicate
         that some progress was done.
 


@@ -137,6 +145,32 @@ public:
     */
     void SetRange(int maximum);
 
     */
     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.
     /**
         Updates the dialog, setting the progress bar to the new value and
         updating the message if new one is specified.


@@ -147,6 +181,13 @@ public:
         dialog or ask the user for the confirmation and if the abort is not confirmed
         the dialog may be resumed with Resume() function.
 
         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.
         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.


@@ -154,8 +195,6 @@ public:
         @param value
             The new value of the progress meter. It should be less than or equal to
             the maximum value given to the constructor.
         @param value
             The new value of the progress meter. It should be less than or equal to
             the maximum value given to the constructor.

-            See @c wxPD_AUTO_HIDE style for more info about the behaviour of
-            wxProgressDialog when @a value is the maximum value given in the ctor.

         @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.