docs/latex/wx/progdlg.tex

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