X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3492e7c80401840b067dfd928734c1694cc0236e..8c8d66c5f06ed3b4f7b2d14966bf84333f60606f:/docs/latex/wx/progdlg.tex?ds=sidebyside diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex index b3c7a6aae3..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,17 +60,24 @@ reached.} \end{twocollist}% } -\membersection{wxProgressDialog::\destruct{wxProgressDialog}} +\membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor} \func{}{\destruct{wxMessageDialog}}{\void} 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. -