git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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