pqProgressManager Class Reference

pqProgressManager is progress manager. More...

#include <pqProgressManager.h>

List of all members.

Public Slots
void	setProgress (const QString &message, int progress)
	Update progress.
void	setEnableProgress (bool)
	Enables progress.
void	beginProgress ()
	Convenience slots that simply call setEnableProgress().
void	endProgress ()
void	setEnableAbort (bool)
	Enables abort.
void	triggerAbort ()
	fires abort().
Signals
void	abort ()
	Emitted to trigger an abort.
void	progress (const QString &message, int progress)
void	enableProgress (bool)
void	enableAbort (bool)
Public Member Functions
	pqProgressManager (QObject *parent=0)
virtual	~pqProgressManager ()
void	lockProgress (QObject *object)
	Locks progress to respond to progress signals set by the object alone.
void	unlockProgress (QObject *object)
	Releases the progress lock.
bool	isLocked () const
	Returns if the progress is currently locked by any object.
void	addNonBlockableObject (QObject *o)
	When progress is enabled, the manager eats all mouse and key events fired except for those objects which are in the non-blockable list.
void	removeNonBlockableObject (QObject *o)
const QList< QPointer< QObject > > &	nonBlockableObjects () const
	Returns the list of non-blockable objects.
Protected Slots
void	onStartProgress ()
	callbacks for signals fired from vtkProcessModule.
void	onEndProgress ()
void	onProgress (vtkObject *)
void	onServerAdded (pqServer *)
Protected Member Functions
bool	eventFilter (QObject *obj, QEvent *event)
	Filter QApplication events.
Protected Attributes
QPointer< QObject >	Lock
QList< QPointer< QObject > >	NonBlockableObjects
int	ProgressCount
bool	InUpdate
double	LastProgressTime
bool	EnableProgress
bool	ReadyEnableProgress

---

Detailed Description

pqProgressManager is progress manager.

It centralizes progress raising/ handling. Provides ability for any object to lock progress so that only progress fired by itself will be notified to the rest of the world. Also, when progress is enabled, it disables handling of mouse/key events except on those objects in the NonBlockableObjects list.

Definition at line 47 of file pqProgressManager.h.

---

Constructor & Destructor Documentation

pqProgressManager::pqProgressManager

(

QObject *

parent = 0

)

virtual pqProgressManager::~pqProgressManager

(

)

[virtual]

---

Member Function Documentation

void pqProgressManager::lockProgress

(

QObject *

object

)

Locks progress to respond to progress signals set by the object alone.

All signals sent by other objects are ignored until Unlock is called.

void pqProgressManager::unlockProgress

(

QObject *

object

)

Releases the progress lock.

bool pqProgressManager::isLocked

(

)

const

Returns if the progress is currently locked by any object.

void pqProgressManager::addNonBlockableObject

(

QObject *

o

)

[inline]

When progress is enabled, the manager eats all mouse and key events fired except for those objects which are in the non-blockable list.

This is the API to add/remove non-blockable objects.

Definition at line 69 of file pqProgressManager.h.

void pqProgressManager::removeNonBlockableObject

(

QObject *

o

)

[inline]

Definition at line 71 of file pqProgressManager.h.

const QList<QPointer<QObject> >& pqProgressManager::nonBlockableObjects

(

)

const [inline]

Returns the list of non-blockable objects.

Definition at line 75 of file pqProgressManager.h.

bool pqProgressManager::eventFilter	(	QObject *	obj,
		QEvent *	event
	)		[protected]

Filter QApplication events.

void pqProgressManager::setProgress	(	const QString &	message,
		int	progress
	)		[slot]

Update progress.

The progress must be enbled by calling enableProgress(true) before calling this method for the progress to be updated.

void pqProgressManager::setEnableProgress

(

bool

)

[slot]

Enables progress.

void pqProgressManager::beginProgress

(

)

[inline, slot]

Convenience slots that simply call setEnableProgress().

Definition at line 91 of file pqProgressManager.h.

void pqProgressManager::endProgress

(

)

[inline, slot]

Definition at line 92 of file pqProgressManager.h.

void pqProgressManager::setEnableAbort

(

bool

)

[slot]

Enables abort.

void pqProgressManager::triggerAbort

(

)

[slot]

fires abort().

Must be called by the GUI that triggers abort.

void pqProgressManager::abort

(

)

[signal]

Emitted to trigger an abort.

void pqProgressManager::progress	(	const QString &	message,
		int	progress
	)		[signal]

void pqProgressManager::enableProgress

(

bool

)

[signal]

void pqProgressManager::enableAbort

(

bool

)

[signal]

void pqProgressManager::onStartProgress

(

)

[protected, slot]

callbacks for signals fired from vtkProcessModule.

void pqProgressManager::onEndProgress

(

)

[protected, slot]

void pqProgressManager::onProgress

(

vtkObject *

)

[protected, slot]

void pqProgressManager::onServerAdded

(

pqServer *

)

[protected, slot]

---

Member Data Documentation

QPointer<QObject> pqProgressManager::Lock [protected]

Definition at line 118 of file pqProgressManager.h.

QList<QPointer<QObject> > pqProgressManager::NonBlockableObjects [protected]

Definition at line 119 of file pqProgressManager.h.

int pqProgressManager::ProgressCount [protected]

Definition at line 120 of file pqProgressManager.h.

bool pqProgressManager::InUpdate [protected]

Definition at line 121 of file pqProgressManager.h.

double pqProgressManager::LastProgressTime [protected]

Definition at line 123 of file pqProgressManager.h.

bool pqProgressManager::EnableProgress [protected]

Definition at line 124 of file pqProgressManager.h.

bool pqProgressManager::ReadyEnableProgress [protected]

Definition at line 125 of file pqProgressManager.h.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqProgressManager.h