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