Add wxTimer::StartOnce().

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

diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h
index 221f1edaf1e0601dbe817cd925bd919d0ee2344f..8fab60b62b7f782a140585b26cdd17c80eaf46e8 100644 (file)
--- a/interface/wx/progdlg.h
+++ b/interface/wx/progdlg.h
@@ -3,16 +3,30 @@
 // 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
     progress bar. Optionally, it can display ABORT and SKIP buttons, and
     the elapsed, remaining and estimated time for the end of the progress.
 
 
     This class represents a dialog that shows a short message and a
     progress bar. Optionally, it can display ABORT and SKIP buttons, and
     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
     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


@@ -29,9 +43,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).


@@ -52,10 +65,10 @@
            This flag tells the dialog that it should show remaining time.
     @endStyleTable
 
            This flag tells the dialog that it should show remaining time.
     @endStyleTable
 

-    @library{wxbase}
+    @library{wxcore}

     @category{cmndlg}
 */
     @category{cmndlg}
 */

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

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


@@ -76,15 +89,15 @@ public:
         @param style
             The dialog style. See wxProgressDialog.
     */
         @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.
     */

-    virtual ~wxProgressDialog();
+    virtual ~wxGenericProgressDialog();

 
     /**
         Returns the last value passed to the Update() function or
 
     /**
         Returns the last value passed to the Update() function or


@@ -115,7 +128,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.
 


@@ -173,6 +186,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.


@@ -180,8 +200,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.


@@ -193,3 +211,20 @@ public:
                         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 );
+};