]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/progdlg.h
remove needless casting (no real change)
[wxWidgets.git] / interface / progdlg.h
index 68bd6909366f761c19eb43504f6f2022e87d4520..64bcabd946e333289285e872bcbd622f14eb3f4e 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        progdlg.h
-// Purpose:     documentation for wxProgressDialog class
+// Purpose:     interface of wxProgressDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,11 +9,11 @@
 /**
     @class wxProgressDialog
     @wxheader{progdlg.h}
-    
+
     This class represents a dialog that shows a short message and a
     progress bar. Optionally, it can display ABORT and SKIP buttons,
     the elapsed, remaining and estimated time for the end of the progress.
-    
+
     @beginStyleTable
     @style{wxPD_APP_MODAL}:
            Make the progress dialog modal. If this flag is not given, it is
@@ -40,7 +40,7 @@
     @style{wxPD_REMAINING_TIME}:
            This flag tells the dialog that it should show remaining time.
     @endStyleTable
-    
+
     @library{wxbase}
     @category{cmndlg}
 */
@@ -51,25 +51,21 @@ public:
         Constructor. Creates the dialog, displays it and disables user input
         for other windows, or, if wxPD_APP_MODAL flag is not given, for its parent
         window only.
-        
-        @param title 
-        Dialog title to show in titlebar.
-        
-        @param message 
-        Message displayed above the progress bar.
-        
-        @param maximum 
-        Maximum value for the progress bar.
-        
-        @param parent 
-        Parent window.
-        
-        @param style 
-        The dialog style. See wxProgressDialog.
+
+        @param title
+            Dialog title to show in titlebar.
+        @param message
+            Message displayed above the progress bar.
+        @param maximum
+            Maximum value for the progress bar.
+        @param parent
+            Parent window.
+        @param style
+            The dialog style. See wxProgressDialog.
     */
     wxProgressDialog(const wxString& title, const wxString& message,
                      int maximum = 100,
-                     wxWindow * parent = @NULL,
+                     wxWindow* parent = NULL,
                      int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL);
 
     /**
@@ -85,7 +81,7 @@ public:
         the progress bar a bit to indicate that some progress was done.
     */
     virtual bool Pulse(const wxString& newmsg = "",
-                       bool * skip = @NULL);
+                       bool* skip = NULL);
 
     /**
         Can be used to continue with the dialog, after the user had chosen
@@ -97,25 +93,24 @@ public:
         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.
-        
         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.
-        
-        @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.
-        
-        @param newmsg 
-        The new messages for the progress dialog text, if it is
-        empty (which is the default) the message is not changed.
-        
-        @param skip 
-        If "Skip" button was pressed since last
-        Update call, this is set to @true.
+
+        @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.
+        @param newmsg
+            The new messages for the progress dialog text, if it is
+            empty (which is the default) the message is not changed.
+        @param skip
+            If "Skip" button was pressed since last
+            Update call, this is set to @true.
     */
     virtual bool Update(int value, const wxString& newmsg = "",
-                        bool * skip = @NULL);
+                        bool* skip = NULL);
 };
+