#include <progressmanager.h>

Inherits TQObject.

Public Slots
void	slotStandardCancelHandler (KPIM::ProgressItem *item)

void	slotAbortAll ()

Signals
void	progressItemAdded (KPIM::ProgressItem *)

void	progressItemProgress (KPIM::ProgressItem *, unsigned int)

void	progressItemCompleted (KPIM::ProgressItem *)

void	progressItemCanceled (KPIM::ProgressItem *)

void	progressItemStatus (KPIM::ProgressItem *, const TQString &)

void	progressItemLabel (KPIM::ProgressItem *, const TQString &)

void	progressItemUsesCrypto (KPIM::ProgressItem *, bool)

void	progressItemUsesBusyIndicator (KPIM::ProgressItem *, bool)

void	showProgressDialog ()

Public Member Functions
bool	isEmpty () const

ProgressItem *	singleItem () const

Static Public Member Functions
static ProgressManager *	instance ()

static TQString	getUniqueID ()

static ProgressItem *	createProgressItem (const TQString &label)

static ProgressItem *	createProgressItem (ProgressItem *parent, const TQString &id, const TQString &label, const TQString &status=TQString(), bool canBeCanceled=true, bool usesCrypto=false)

static ProgressItem *	createProgressItem (const TQString &parent, const TQString &id, const TQString &label, const TQString &status=TQString(), bool canBeCanceled=true, bool usesCrypto=false)

static ProgressItem *	createProgressItem (const TQString &id, const TQString &label, const TQString &status=TQString(), bool canBeCanceled=true, bool usesCrypto=false)

static void	emitShowProgressDialog ()

Detailed Description

The ProgressManager singleton keeps track of all ongoing transactions and notifies observers (progress dialogs) when their progress percent value changes, when they are completed (by their owner), and when they are canceled.

Each ProgressItem emits those signals individually and the singleton broadcasts them. Use the ::createProgressItem() statics to acquire an item and then call ->setProgress( int percent ) on it everytime you want to update the item and ->setComplete() when the operation is done. This will delete the item. Connect to the item's progressItemCanceled() signal to be notified when the user cancels the transaction using one of the observing progress dialogs or by calling item->cancel() in some other way. The owner is responsible for calling setComplete() on the item, even if it is canceled. Use the standardCancelHandler() slot if that is all you want to do on cancel.

Note that if you request an item with a certain id and there is already one with that id, there will not be a new one created but the existing one will be returned. This is convenient for accessing items that are needed regularly without the to store a pointer to them or to add child items to parents by id.

Definition at line 266 of file progressmanager.h.

Member Function Documentation

◆ createProgressItem() [1/4]

static ProgressItem* KPIM::ProgressManager::createProgressItem	(	const TQString &	id,
		const TQString &	label,
		const TQString &	status = `TQString()`,
		bool	canBeCanceled = `true`,
		bool	usesCrypto = `false`
	)

inlinestatic

Version without a parent.

Definition at line 344 of file progressmanager.h.

◆ createProgressItem() [2/4]

static ProgressItem* KPIM::ProgressManager::createProgressItem ( const TQString & label )

inlinestatic

Creates a ProgressItem with a unique id and the given label.

This is the simplest way to acquire a progress item. It will not have a parent and will be set to be cancellable and not using crypto.

Parameters

label The text to be displayed by progress handlers. It will be interpreted as rich text, so it might have to be escaped.

Definition at line 296 of file progressmanager.h.

◆ createProgressItem() [3/4]

static ProgressItem* KPIM::ProgressManager::createProgressItem	(	const TQString &	parent,
		const TQString &	id,
		const TQString &	label,
		const TQString &	status = `TQString()`,
		bool	canBeCanceled = `true`,
		bool	usesCrypto = `false`
	)

inlinestatic

Use this version if you have the id string of the parent and want to add a subjob to it.

Definition at line 331 of file progressmanager.h.

◆ createProgressItem() [4/4]

static ProgressItem* KPIM::ProgressManager::createProgressItem	(	ProgressItem *	parent,
		const TQString &	id,
		const TQString &	label,
		const TQString &	status = `TQString()`,
		bool	canBeCanceled = `true`,
		bool	usesCrypto = `false`
	)

inlinestatic

Creates a new progressItem with the given parent, id, label and initial status.

Parameters

parent	Specify an already existing item as the parent of this one.
id	Used to identify this operation for cancel and progress info.
label	The text to be displayed by progress handlers. It will be interpreted as rich text, so it might have to be escaped.
status	Additional text to be displayed for the item. It will be interpreted as rich text, so it might have to be escaped.
canBeCanceled	can the user cancel this operation?
usesCrypto	does the operation use secure transports (SSL) Cancelling the parent will cancel the children as well (if they can be cancelled) and ongoing children prevent parents from finishing.

Returns: The ProgressItem representing the operation.

Definition at line 317 of file progressmanager.h.

◆ emitShowProgressDialog()

static void KPIM::ProgressManager::emitShowProgressDialog ( )

inlinestatic

Ask all listeners to show the progress dialog, because there is something that wants to be shown.

Definition at line 372 of file progressmanager.h.

◆ getUniqueID()

static TQString KPIM::ProgressManager::getUniqueID ( )

inlinestatic

Use this to acquire a unique id number which can be used to discern an operation from all others going on at the same time.

Use that number as the id string for your progressItem to ensure it is unique.

Returns

Definition at line 286 of file progressmanager.h.

◆ instance()

ProgressManager * KPIM::ProgressManager::instance ( )

static

Returns: The singleton instance of this class.

Definition at line 141 of file progressmanager.cpp.

◆ isEmpty()

bool KPIM::ProgressManager::isEmpty ( ) const

inline

Returns: true when there is no more progress item

Definition at line 357 of file progressmanager.h.

◆ progressItemAdded

void KPIM::ProgressManager::progressItemAdded ( KPIM::ProgressItem * )

signal

See also: ProgressItem::progressItemAdded()

◆ progressItemCanceled

void KPIM::ProgressManager::progressItemCanceled ( KPIM::ProgressItem * )

signal

See also: ProgressItem::progressItemCanceled()

◆ progressItemCompleted

void KPIM::ProgressManager::progressItemCompleted ( KPIM::ProgressItem * )

signal

See also: ProgressItem::progressItemCompleted()

◆ progressItemLabel

void KPIM::ProgressManager::progressItemLabel	(	KPIM::ProgressItem *	,
		const TQString &
	)

signal

See also: ProgressItem::progressItemLabel()

◆ progressItemProgress

void KPIM::ProgressManager::progressItemProgress	(	KPIM::ProgressItem *	,
		unsigned int
	)

signal

See also: ProgressItem::progressItemProgress()

◆ progressItemStatus

void KPIM::ProgressManager::progressItemStatus	(	KPIM::ProgressItem *	,
		const TQString &
	)

signal

See also: ProgressItem::progressItemStatus()

◆ progressItemUsesBusyIndicator

void KPIM::ProgressManager::progressItemUsesBusyIndicator	(	KPIM::ProgressItem *	,
		bool
	)

signal

See also: ProgressItem::progressItemUsesBusyIndicator

◆ progressItemUsesCrypto

void KPIM::ProgressManager::progressItemUsesCrypto	(	KPIM::ProgressItem *	,
		bool
	)

signal

See also: ProgressItem::progressItemUsesCrypto()

◆ showProgressDialog

void KPIM::ProgressManager::showProgressDialog ( )

signal

Emitted when an operation requests the listeners to be shown.

Use emitShowProgressDialog() to trigger it.

◆ singleItem()

ProgressItem * KPIM::ProgressManager::singleItem ( ) const

Returns: the only top level progressitem when there's only one. Returns 0 if there is no item, or more than one top level item. Since this is used to calculate the overall progress, it will also return 0 if there is an item which uses a busy indicator, since that will invalidate the overall progress.

Definition at line 218 of file progressmanager.cpp.

◆ slotAbortAll

void KPIM::ProgressManager::slotAbortAll ( )

slot

Aborts all running jobs.

Bound to "Esc"

Definition at line 238 of file progressmanager.cpp.

◆ slotStandardCancelHandler

void KPIM::ProgressManager::slotStandardCancelHandler ( KPIM::ProgressItem * item )

slot

Calls setCompleted() on the item, to make sure it goes away.

Provided for convenience.

Parameters

item	the canceled item.

Definition at line 213 of file progressmanager.cpp.

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

libtdepim

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ createProgressItem() [1/4]

◆ createProgressItem() [2/4]

◆ createProgressItem() [3/4]

◆ createProgressItem() [4/4]

◆ emitShowProgressDialog()

◆ getUniqueID()

◆ instance()

◆ isEmpty()

◆ progressItemAdded

◆ progressItemCanceled

◆ progressItemCompleted

◆ progressItemLabel

◆ progressItemProgress

◆ progressItemStatus

◆ progressItemUsesBusyIndicator

◆ progressItemUsesCrypto

◆ showProgressDialog

◆ singleItem()

◆ slotAbortAll

◆ slotStandardCancelHandler

libtdepim

libtdepim