fixed Update() signature

[wxWidgets.git] / docs / latex / wx / progdlg.tex

diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex
index fc7f5a5fe5db174ddb93f1c9a5c6ec690f332de8..b3c7a6aae3928e255f2a20a04c9faa0a88f553db 100644 (file)
--- a/docs/latex/wx/progdlg.tex
+++ b/docs/latex/wx/progdlg.tex
@@ -71,22 +71,26 @@ Destructor. Deletes the dialog and enables all top level windows.
 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
 
 \func{bool}{Update}{
-  \param{int }{value = -1},\rtfsp
-  \param{const char * }{newmsg = NULL},  }
+  \param{int }{value},\rtfsp
+  \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 if the ABORT button 
-has \emph{not} been pressed.
+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 \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{newmsg}{The new messages for the progress dialog text, if none is
-given the message is not changed.}
+\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}