casa::QtProgressWidget Class Reference

GUI for displaying progress information. More...

#include <QtProgressWidget.qo.h>

Inheritance diagram for casa::QtProgressWidget:

List of all members.

Public Slots
void	initialize (const QString &operationName)
	Initializes the GUI with the given operation name.
void	setStatus (const QString &status)
	Sets the status to the given.
void	setProgress (unsigned int progress)
	Sets the progress percentage (0 - 100) to the given.
void	setProgress (unsigned int progress, const QString &status)
	Sets the progress percentage (0 - 100) and the status to the given.
void	finalize ()
	Finalizes the GUI.
Signals
void	backgroundRequested ()
	Signal for when the user requests "background" for the thread.
void	pauseRequested ()
	Signal for when the user requests "pause" for the thread.
void	resumeRequested ()
	Signal for when the user requests "resume" for the thread.
void	cancelRequested ()
	Signal for when the user requests "cancel" for the thread.
Public Member Functions
	QtProgressWidget (bool allowBackground=true, bool allowPauseResume=true, bool allowCancel=true, bool isDialog=true, bool useCompact=false, QWidget *parent=NULL)
	Constructor which takes the PlotMS parent an optional parent widget.
	~QtProgressWidget ()
	Destructor.
void	setAllowedOperations (bool background, bool pauseResume, bool cancel)
	Sets which operations the user can request using this widget.
QMutex &	mutex ()
	Returns the mutex used for this widget.
void	initialize (const String &operationName)
	Initialize the monitor with the identifying operation.
void	setProgress (unsigned int progress, const String &status)
	Set the progress to a specific amount and status.
Protected Member Functions
void	closeEvent (QCloseEvent *event)
	Overrides QWidget::closeEvent().
Private Slots
void	background ()
	For the "background" button.
void	pauseResume (bool pause)
	For the "pause"/"resume" button.
void	cancel ()
	For the "cancel" button.
Private Attributes
QMutex	itsMutex_
	Mutex.
Ui::ProgressWidget *	itsProgress_
	Normal widget.
Ui::ProgressCompactWidget *	itsCompactProgress_
	Compact widget.

---

Detailed Description

GUI for displaying progress information.

It also shows "background", "cancel", and "pause/resume" buttons for the user. The parent of this widget is responsible for implementing these behaviors as needed.

Definition at line 41 of file QtProgressWidget.qo.h.

---

Constructor & Destructor Documentation

casa::QtProgressWidget::QtProgressWidget	(	bool	allowBackground = true,
		bool	allowPauseResume = true,
		bool	allowCancel = true,
		bool	isDialog = true,
		bool	useCompact = false,
		QWidget *	parent = NULL
	)

Constructor which takes the PlotMS parent an optional parent widget.

casa::QtProgressWidget::~QtProgressWidget

(

)

Destructor.

---

Member Function Documentation

void casa::QtProgressWidget::background

(

)

[private, slot]

For the "background" button.

void casa::QtProgressWidget::backgroundRequested

(

)

[signal]

Signal for when the user requests "background" for the thread.

void casa::QtProgressWidget::cancel

(

)

[private, slot]

For the "cancel" button.

void casa::QtProgressWidget::cancelRequested

(

)

[signal]

Signal for when the user requests "cancel" for the thread.

void casa::QtProgressWidget::closeEvent

(

QCloseEvent *

event

)

[protected]

Overrides QWidget::closeEvent().

Connects closing to the "background" signal.

void casa::QtProgressWidget::finalize

(

)

[virtual, slot]

Finalizes the GUI.

Should be called after the operation ends.

Implements casa::ProgressMonitor.

void casa::QtProgressWidget::initialize

(

const QString &

operationName

)

[slot]

Initializes the GUI with the given operation name.

Should be called before the operation starts.

void casa::QtProgressWidget::initialize

(

const String &

)

[virtual]

Initialize the monitor with the identifying operation.

Implements casa::ProgressMonitor.

QMutex& casa::QtProgressWidget::mutex

(

)

Returns the mutex used for this widget.

void casa::QtProgressWidget::pauseRequested

(

)

[signal]

Signal for when the user requests "pause" for the thread.

void casa::QtProgressWidget::pauseResume

(

bool

pause

)

[private, slot]

For the "pause"/"resume" button.

void casa::QtProgressWidget::resumeRequested

(

)

[signal]

Signal for when the user requests "resume" for the thread.

void casa::QtProgressWidget::setAllowedOperations	(	bool	background,
		bool	pauseResume,
		bool	cancel
	)			[virtual]

Sets which operations the user can request using this widget.

Implements casa::ProgressMonitor.

void casa::QtProgressWidget::setProgress	(	unsigned int	progress,
		const QString &	status
	)			[slot]

Sets the progress percentage (0 - 100) and the status to the given.

void casa::QtProgressWidget::setProgress

(

unsigned int

progress

)

[slot]

Sets the progress percentage (0 - 100) to the given.

void casa::QtProgressWidget::setProgress	(	unsigned int	int,
		const String &
	)			[virtual]

Set the progress to a specific amount and status.

Implements casa::ProgressMonitor.

void casa::QtProgressWidget::setStatus

(

const QString &

status

)

[slot]

Sets the status to the given.

---

Member Data Documentation

Ui::ProgressCompactWidget* casa::QtProgressWidget::itsCompactProgress_ [private]

Compact widget.

Definition at line 107 of file QtProgressWidget.qo.h.

QMutex casa::QtProgressWidget::itsMutex_ [private]

Mutex.

Definition at line 101 of file QtProgressWidget.qo.h.

Ui::ProgressWidget* casa::QtProgressWidget::itsProgress_ [private]

Normal widget.

Definition at line 104 of file QtProgressWidget.qo.h.

---

The documentation for this class was generated from the following file:

• code/casaqt/QtUtilities/QtProgressWidget.qo.h