]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/progdlg.tex
fixed corrupted file, checked in as text file now
[wxWidgets.git] / docs / latex / wx / progdlg.tex
index b3c7a6aae3928e255f2a20a04c9faa0a88f553db..a34a5b9acd2b7eb77675675482959ff153df1f97 100644 (file)
@@ -38,8 +38,6 @@ window only.
 
 \docparam{parent}{Parent window.}
 
-\docparam{message}{Message to show on the dialog.}
-
 \docparam{style}{The dialog style. This is the combination of the following
 bitmask constants defined in wx/defs.h:
 
@@ -68,11 +66,18 @@ reached.}
 
 Destructor. Deletes the dialog and enables all top level windows.
 
+\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
+
+\func{void}{Resume}{\void}
+
+Can be used to continue with the dialog, after the user had chosen
+ABORT.
+
 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
 
-\func{bool}{Update}{
+\func{virtual bool}{Update}{
   \param{int }{value},\rtfsp
-  \param{const wxString\&}{newmsg = ""},  }
+  \param{const wxString\& }{newmsg = ""}}
 
 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
@@ -84,18 +89,9 @@ dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
 
 \wxheading{Parameters}
 
-\docparam{value}{The new value of the progress meter. It must be strictly less
-than the maximum value given to the constructor (i.e., as usual in C, the
-index runs from $0$ to $maximum-1$).}
+\docparam{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.}
 \docparam{newmsg}{The new messages for the progress dialog text, if it is
 empty (which is the default) the message is not changed.}
 
-\wxheading{Parameters}
-
-\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
-
-\func{void}{Resume}{\void}
-
-Can be used to continue with the dialog, after the user had chosen
-ABORT.
-