wxGenericProgressDialog Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/progdlg.h>

Inheritance diagram for wxGenericProgressDialog:

---

Detailed Description

This class represents a dialog that shows a short message and a progress bar.

Optionally, it can display ABORT and SKIP buttons, and the elapsed, remaining and estimated time for the end of the progress.

This class provides a generic implementation of the progress dialog. If the platform has a native progress dialog available then it will be accessible using the wxProgressDialog class, otherwise it will essentially be the same as this class.

Note that you must be aware that wxProgressDialog internally calls wxEventLoopBase::YieldFor with wxEVT_CATEGORY_UI and wxEVT_CATEGORY_USER_INPUT and this may cause unwanted re-entrancies or the out-of-order processing of pending events (to help preventing the last problem if you're using wxProgressDialog in a multi-threaded application you should be sure to use wxThreadEvent for your inter-threads communications).

Styles

This class supports the following styles:

• wxPD_APP_MODAL:
  Make the progress dialog modal. If this flag is not given, it is only "locally" modal - that is the input to the parent window is disabled, but not to the other ones.
• wxPD_AUTO_HIDE:
  Causes the progress dialog to disappear from screen as soon as the maximum value of the progress meter has been reached. If this style is not present, the dialog will become a modal dialog (see wxDialog::ShowModal) once the maximum value has been reached and wait for the user to dismiss it.
• wxPD_SMOOTH:
  Causes smooth progress of the gauge control (uses a wxGauge with the wxGA_SMOOTH style).
• wxPD_CAN_ABORT:
  This flag tells the dialog that it should have a "Cancel" button which the user may press. If this happens, the next call to Update() will return false.
• wxPD_CAN_SKIP:
  This flag tells the dialog that it should have a "Skip" button which the user may press. If this happens, the next call to Update() will return true in its skip parameter.
• wxPD_ELAPSED_TIME:
  This flag tells the dialog that it should show elapsed time (since creating the dialog).
• wxPD_ESTIMATED_TIME:
  This flag tells the dialog that it should show estimated time.
• wxPD_REMAINING_TIME:
  This flag tells the dialog that it should show remaining time.

Library:  wxBase

Category:  Common Dialogs

Public Member Functions
	wxGenericProgressDialog (const wxString &title, const wxString &message, int maximum=100, wxWindow *parent=NULL, int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL)
	Constructor.
virtual	~wxGenericProgressDialog ()
	Destructor.
int	GetValue () const
	Returns the last value passed to the Update() function or wxNOT_FOUND if the dialog has no progress bar.
int	GetRange () const
	Returns the maximum value of the progress meter, as passed to the constructor or wxNOT_FOUND if the dialog has no progress bar.
wxString	GetMessage () const
	Returns the last message passed to the Update() function; if you always passed wxEmptyString to Update() then the message set through the constructor is returned.
virtual bool	Pulse (const wxString &newmsg=wxEmptyString, bool *skip=NULL)
	Like Update() but makes the gauge control run in indeterminate mode.
void	Resume ()
	Can be used to continue with the dialog, after the user had clicked the "Abort" button.
void	SetRange (int maximum)
	Changes the maximum value of the progress meter given in the constructor.
bool	WasCancelled () const
	Returns true if the "Cancel" button was pressed.
bool	WasSkipped () const
	Returns true if the "Skip" button was pressed.
virtual bool	Update (int value, const wxString &newmsg=wxEmptyString, bool *skip=NULL)
	Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.

List of all members.

---

Constructor & Destructor Documentation

wxGenericProgressDialog::wxGenericProgressDialog	(	const wxString &	title,
		const wxString &	message,
		int	maximum = 100,
		wxWindow *	parent = NULL,
		int	style = wxPD_AUTO_HIDE|wxPD_APP_MODAL
	)

Constructor.

Creates the dialog, displays it and disables user input for other windows, or, if wxPD_APP_MODAL flag is not given, for its parent window only.

Parameters:

title	Dialog title to show in titlebar.
message	Message displayed above the progress bar.
maximum	Maximum value for the progress bar. In the generic implementation the progress bar is constructed only if this value is greater than zero.
parent	Parent window.
style	The dialog style. See wxProgressDialog.

virtual wxGenericProgressDialog::~wxGenericProgressDialog

(

)

[virtual]

Destructor.

Deletes the dialog and enables all top level windows.

---

Member Function Documentation

wxString wxGenericProgressDialog::GetMessage

(

)

const

Returns the last message passed to the Update() function; if you always passed wxEmptyString to Update() then the message set through the constructor is returned.

Since:

2.9.0

int wxGenericProgressDialog::GetRange

(

)

const

Returns the maximum value of the progress meter, as passed to the constructor or wxNOT_FOUND if the dialog has no progress bar.

Since:

2.9.0

int wxGenericProgressDialog::GetValue

(

)

const

Returns the last value passed to the Update() function or wxNOT_FOUND if the dialog has no progress bar.

Since:

2.9.0

virtual bool wxGenericProgressDialog::Pulse	(	const wxString &	newmsg = wxEmptyString,
		bool *	skip = NULL
	)		[virtual]

Like Update() but makes the gauge control run in indeterminate mode.

In indeterminate mode the remaining and the estimated time labels (if present) are set to "Unknown" or to newmsg (if it's non-empty). Each call to this function moves the progress bar a bit to indicate that some progress was done.

参照:

wxGauge::Pulse(), Update()

void wxGenericProgressDialog::Resume

(

)

Can be used to continue with the dialog, after the user had clicked the "Abort" button.

void wxGenericProgressDialog::SetRange

(

int

maximum

)

Changes the maximum value of the progress meter given in the constructor.

This function can only be called (with a positive value) if the value passed in the constructor was positive.

Since:

2.9.1

virtual bool wxGenericProgressDialog::Update	(	int	value,
		const wxString &	newmsg = wxEmptyString,
		bool *	skip = NULL
	)		[virtual]

Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.

Returns true unless the "Cancel" button has been pressed.

If false is returned, the application can either immediately destroy the dialog or ask the user for the confirmation and if the abort is not confirmed the dialog may be resumed with Resume() function.

If value is the maximum value for the dialog, the behaviour of the function depends on whether wxPD_AUTO_HIDE was used when the dialog was created. If it was, the dialog is hidden and the function returns immediately. If it was not, the dialog becomes a modal dialog and waits for the user to dismiss it, meaning that this function does not return until this happens.

Notice that you may want to call Fit() to change the dialog size to conform to the length of the new message if desired. The dialog does not do this automatically.

Parameters:

value	The new value of the progress meter. It should be less than or equal to the maximum value given to the constructor.
newmsg	The new messages for the progress dialog text, if it is empty (which is the default) the message is not changed.
skip	If "Skip" button was pressed since last Update() call, this is set to true.

bool wxGenericProgressDialog::WasCancelled

(

)

const

Returns true if the "Cancel" button was pressed.

Normally a Cancel button press is indicated by Update() returning false but sometimes it may be more convenient to check if the dialog was cancelled from elsewhere in the code and this function allows to do it.

It always returns false if the Cancel button is not shown at all.

Since:

2.9.1

bool wxGenericProgressDialog::WasSkipped

(

)

const

Returns true if the "Skip" button was pressed.

This is similar to WasCancelled() but returns true if the "Skip" button was pressed, not the "Cancel" one.

Since:

2.9.1