X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3f54c58da2475b91a064a9757e52add56ed42527..77e79241e89f1968dd2f5a2faa6513ebd4df2087:/docs/latex/wx/progdlg.tex?ds=sidebyside diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex index 6fb56019c6..3205091c65 100644 --- a/docs/latex/wx/progdlg.tex +++ b/docs/latex/wx/progdlg.tex @@ -5,7 +5,7 @@ progress bar. Optionally, it can display an ABORT button. \wxheading{Derived from} -\helpref{wxFrame}{wxframe}\\ +\helpref{wxDialog}{wxdialog}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} @@ -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 @@ -49,9 +49,13 @@ window is disabled, but not to the other ones.} \twocolitem{{\bf wxPD\_AUTO\_HIDE}}{Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached.} +\twocolitem{{\bf wxPD\_SMOOTH}}{Causes smooth progress of the gauge control.} \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.} +\twocolitem{{\bf wxPD\_CAN\_SKIP}}{This flag tells the dialog that it should have a +"Skip" button which the user may press. If this happens, the next call to + \helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.} \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.} @@ -60,7 +64,7 @@ reached.} \end{twocollist}% } -\membersection{wxProgressDialog::\destruct{wxProgressDialog}} +\membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor} \func{}{\destruct{wxMessageDialog}}{\void} @@ -77,7 +81,8 @@ ABORT. \func{virtual bool}{Update}{ \param{int }{value},\rtfsp - \param{const wxString\& }{newmsg = ""}} + \param{const wxString\& }{newmsg = ""},\rtfsp + \param{bool *}{skip = NULL}} 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 @@ -89,9 +94,11 @@ 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.} +\docparam{skip}{If "Skip" button was pressed since last +\helpref{Update}{wxprogressdialogupdate} call the skip is true.}