X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6a611b39feadde7d830457b59ffb8f56929acd0a..3c59549689ca9333b0dde255dc7d46e0539183e8:/docs/latex/wx/progdlg.tex diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex index 5cf893f2be..24851fe916 100644 --- a/docs/latex/wx/progdlg.tex +++ b/docs/latex/wx/progdlg.tex @@ -53,7 +53,7 @@ from screen as soon as the maximum value of the progress meter has been reached.} \twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a "Cancel" button which the user may press. If this happens, the next call to - \helpref{Update()}{wxprogressdialogupdate} will return FALSE.} + \helpref{Update()}{wxprogressdialogupdate} will return false.} \twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).} \twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.} \twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.} @@ -68,30 +68,32 @@ 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}{ - \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 +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.} - -\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume} - -\func{void}{Resume}{\void} - -Can be used to continue with the dialog, after the user had chosen -ABORT. +\docparam{newmsg}{The new messages for the progress dialog text, if it is +empty (which is the default) the message is not changed.}