docs/latex/wx/progdlg.tex

   1 \section{\class{wxProgressDialog}}\label{wxprogressdialog}
   2
   3 This class represents a dialog that shows a short message and a
   4 progress bar. Optionally, it can display an ABORT button.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxDialog}{wxdialog}\\
   9 \helpref{wxWindow}{wxwindow}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/progdlg.h>
  16
  17 \latexignore{\rtfignore{\wxheading{Members}}}
  18
  19 \membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogctor}
  20
  21 \func{}{wxProgressDialog}{\param{const wxString\& }{title},
  22  \param{const wxString\& }{message},\rtfsp
  23  \param{int }{maximum = 100},
  24  \param{wxWindow * }{parent = NULL},\rtfsp
  25  \param{int }{style = wxPD\_AUTO\_HIDE | wxPD\_APP\_MODAL}}
  26
  27 Constructor. Creates the dialog, displays it and disables user input
  28 for other windows, or, if wxPD\_APP\_MODAL flag is not given, for its parent
  29 window only.
  30
  31 \wxheading{Parameters}
  32
  33 \docparam{title}{Dialog title to show in titlebar.}
  34
  35 \docparam{message}{Message displayed above the progress bar.}
  36
  37 \docparam{maximum}{Maximum value for the progress bar.}
  38
  39 \docparam{parent}{Parent window.}
  40
  41 \docparam{style}{The dialog style. This is the combination of the following
  42 bitmask constants defined in wx/defs.h:
  43
  44 \twocolwidtha{7cm}
  45 \begin{twocollist}\itemsep=0pt
  46 \twocolitem{{\bf wxPD\_APP\_MODAL}}{Make the progress dialog modal. If this flag is
  47 not given, it is only "locally" modal - that is the input to the parent
  48 window is disabled, but not to the other ones.}
  49 \twocolitem{{\bf wxPD\_AUTO\_HIDE}}{Causes the progress dialog to disappear
  50 from screen as soon as the maximum value of the progress meter has been
  51 reached.}
  52 \twocolitem{{\bf wxPD\_SMOOTH}}{Causes smooth progress of the gauge control.}
  53 \twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a
  54 "Cancel" button which the user may press. If this happens, the next call to
  55  \helpref{Update()}{wxprogressdialogupdate} will return false.}
  56 \twocolitem{{\bf wxPD\_CAN\_SKIP}}{This flag tells the dialog that it should have a
  57 "Skip" button which the user may press. If this happens, the next call to
  58  \helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.}
  59 \twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
  60 \twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
  61 \twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
  62 %\twocolitem{{\bf wxPD\_SMOOTH}}{This flag tells the dialog that it should use
  63 %smooth gauge (has effect only under 32bit Windows).}
  64 \end{twocollist}%
  65 }
  66
  67 \membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor}
  68
  69 \func{}{\destruct{wxMessageDialog}}{\void}
  70
  71 Destructor. Deletes the dialog and enables all top level windows.
  72
  73 \membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
  74
  75 \func{void}{Resume}{\void}
  76
  77 Can be used to continue with the dialog, after the user had chosen
  78 ABORT.
  79
  80 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
  81
  82 \func{virtual bool}{Update}{
  83   \param{int }{value},\rtfsp
  84   \param{const wxString\& }{newmsg = ""},\rtfsp
  85   \param{bool *}{skip = NULL}}
  86
  87 Updates the dialog, setting the progress bar to the new value and, if
  88 given changes the message above it. Returns true unless the Cancel button
  89 has been pressed.
  90
  91 If false is returned, the application can either immediately destroy the dialog
  92 or ask the user for the confirmation and if the abort is not confirmed the
  93 dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
  94
  95 \wxheading{Parameters}
  96
  97 \docparam{value}{The new value of the progress meter. It should be less than or
  98 equal to the maximum value given to the constructor and the dialog is closed if
  99 it is equal to the maximum.}
 100 \docparam{newmsg}{The new messages for the progress dialog text, if it is
 101 empty (which is the default) the message is not changed.}
 102 \docparam{skip}{If "Skip" button was pressed since last
 103 \helpref{Update}{wxprogressdialogupdate} call the skip is true.}
 104