]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/progdlg.tex
added SetStatusText method (avoiding dc.Clear)
[wxWidgets.git] / docs / latex / wx / progdlg.tex
CommitLineData
8fa2e6a2
KB
1\section{\class{wxProgressDialog}}\label{wxprogressdialog}
2
3This class represents a dialog that shows a short message and a
4progress 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
2723cfeb
JS
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}}
8fa2e6a2
KB
26
27Constructor. Creates the dialog, displays it and disables user input
88ac883a 28for other windows, or, if wxPD\_APP\_MODAL flag is not given, for its parent
8fa2e6a2
KB
29window 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{message}{Message to show on the dialog.}
42
88ac883a 43\docparam{style}{The dialog style. This is the combination of the following
2723cfeb 44bitmask constants defined in wx/defs.h:
88ac883a
VZ
45
46\twocolwidtha{7cm}
47\begin{twocollist}\itemsep=0pt
fa482912 48\twocolitem{{\bf wxPD\_APP\_MODAL}}{Make the progress dialog modal. If this flag is
2723cfeb
JS
49not given, it is only "locally" modal - that is the input to the parent
50window is disabled, but not to the other ones.}
6a611b39 51\twocolitem{{\bf wxPD\_AUTO\_HIDE}}{Causes the progress dialog to disappear
2723cfeb 52from screen as soon as the maximum value of the progress meter has been
6a611b39 53reached.}
fa482912 54\twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a
2723cfeb
JS
55"Cancel" button which the user may press. If this happens, the next call to
56 \helpref{Update()}{wxprogressdialogupdate} will return FALSE.}
fa482912
JS
57\twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
58\twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
59\twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
6a611b39
JS
60%\twocolitem{{\bf wxPD\_SMOOTH}}{This flag tells the dialog that it should use
61%smooth gauge (has effect only under 32bit Windows).}
88ac883a
VZ
62\end{twocollist}%
63}
8fa2e6a2
KB
64
65\membersection{wxProgressDialog::\destruct{wxProgressDialog}}
66
67\func{}{\destruct{wxMessageDialog}}{\void}
2723cfeb
JS
68
69Destructor. Deletes the dialog and enables all top level windows.
8fa2e6a2
KB
70
71\membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
72
73\func{bool}{Update}{
74 \param{int }{value = -1},\rtfsp
75 \param{const char * }{newmsg = NULL}, }
76
77Updates the dialog, setting the progress bar to the new value and, if
88ac883a 78given changes the message above it. Returns TRUE if the ABORT button
8fa2e6a2
KB
79has \emph{not} been pressed.
80
88ac883a
VZ
81If FALSE is returned, the application can either immediately destroy the dialog
82or ask the user for the confirmation and if the abort is not confirmed the
83dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
84
85\docparam{value}{The new value of the progress meter. It must be strictly less
2723cfeb
JS
86than the maximum value given to the constructor (i.e., as usual in C, the
87index runs from $0$ to $maximum-1$).}
88ac883a 88\docparam{newmsg}{The new messages for the progress dialog text, if none is
2723cfeb 89given the message is not changed.}
8fa2e6a2
KB
90
91\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
92
93\func{void}{Resume}{\void}
88ac883a 94
8fa2e6a2
KB
95Can be used to continue with the dialog, after the user had chosen
96ABORT.
97