X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/384c96533e84e102a64c5057823a20a7d043e338..df10208f26d2659e5995fd00debeb4eaa11174cc:/docs/latex/wx/progdlg.tex diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex index 24851fe916..0bdf7f669b 100644 --- a/docs/latex/wx/progdlg.tex +++ b/docs/latex/wx/progdlg.tex @@ -16,7 +16,7 @@ progress bar. Optionally, it can display an ABORT button. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogconstr} +\membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogctor} \func{}{wxProgressDialog}{\param{const wxString\& }{title}, \param{const wxString\& }{message},\rtfsp @@ -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: @@ -62,7 +60,7 @@ reached.} \end{twocollist}% } -\membersection{wxProgressDialog::\destruct{wxProgressDialog}} +\membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor} \func{}{\destruct{wxMessageDialog}}{\void} @@ -77,7 +75,7 @@ ABORT. \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate} -\func{bool}{Update}{ +\func{virtual bool}{Update}{ \param{int }{value},\rtfsp \param{const wxString\& }{newmsg = ""}} @@ -91,9 +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.}