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{wxFrame}{wxframe}\\
   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{wxprogressdialogconstr}
  20
  21 \func{}{wxProgressDialog}
  22 {\param{const wxString\& }{title},
  23   \param{const wxString\& }{message},\rtfsp
  24   \param{int }{maximum = 100},
  25   \param{wxWindow * }{parent = NULL},\rtfsp
  26   \param{bool }{disableParentOnly = FALSE},\rtfsp
  27   \param{bool }{abortButton = FALSE}
  28   }
  29
  30 Constructor. Creates the dialog, displays it and disables user input
  31 for other windows, or, if disableParentOnly = TRUE, for its parent
  32 window only.
  33
  34 \wxheading{Parameters}
  35
  36 \docparam{title}{Dialog title to show in titlebar.}
  37
  38 \docparam{message}{Message displayed above the progress bar.}
  39
  40 \docparam{maximum}{Maximum value for the progress bar.}
  41
  42 \docparam{parent}{Parent window.}
  43
  44 \docparam{message}{Message to show on the dialog.}
  45
  46 \docparam{disableParentOnly}{By default, the dialog disables user
  47   input for all other top level windows. If this parameter is TRUE, it
  48   will only disable the window passes as parent.}
  49
  50 \docparam{abortButton}{If TRUE, will display an ABORT button.}
  51
  52 \membersection{wxProgressDialog::\destruct{wxProgressDialog}}
  53
  54 \func{}{\destruct{wxMessageDialog}}{\void}
  55 Destructor.
  56 Deletes the dialog and enables all top level windows.
  57
  58 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
  59
  60 \func{bool}{Update}{
  61   \param{int }{value = -1},\rtfsp
  62   \param{const char * }{newmsg = NULL},  }
  63
  64 Updates the dialog, setting the progress bar to the new value and, if
  65 given exchanges the message above it. Returns TRUE if the ABORT button
  66 has \emph{not} been pressed.
  67
  68
  69 \membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
  70
  71 \func{void}{Resume}{\void}
  72 Can be used to continue with the dialog, after the user had chosen
  73 ABORT.
  74
  75