Inheritance diagram for Digikam::ProgressManager:

Public Slots
void	slotAbortAll ()

void	slotStandardCancelHandler (ProgressItem *item)

Signals
void	completeTransactionDeferred (ProgressItem *item)

void	progressItemAdded (ProgressItem *)

void	progressItemCanceled (ProgressItem *)

void	progressItemCompleted (ProgressItem *)

void	progressItemLabel (ProgressItem *, const QString &)

void	progressItemProgress (ProgressItem *, unsigned int)

void	progressItemStatus (ProgressItem *, const QString &)

void	progressItemThumbnail (ProgressItem *, const QPixmap &)

void	progressItemUsesBusyIndicator (ProgressItem *, bool)

void	showProgressView ()

Public Member Functions
ProgressItem *	findItembyId (const QString &id) const

QString	getUniqueID ()

bool	isEmpty () const

ProgressItem *	singleItem () const

Static Public Member Functions
static bool	addProgressItem (ProgressItem const t, ProgressItem const parent=nullptr)

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

static ProgressItem *	createProgressItem (const QString &label, const QString &status=QString(), bool canBeCanceled=true, bool hasThumb=false)

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

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

static void	emitShowProgressView ()

static ProgressManager *	instance ()

Friends
class	ProgressManagerCreator

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 every time 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.

Member Function Documentation

◆ addProgressItem()

bool Digikam::ProgressManager::addProgressItem	(	ProgressItem *const	t,
		ProgressItem *const	parent = `nullptr`
	)

static

Add a created progressItem outside manager with the given parent.

Parameters

t	The process to add on manager.
parent	Specify an already existing item as the parent of this one (can be null).

Returns: true if ProgressItem have been added to manager, else false.

References findItembyId(), Digikam::ProgressItem::id(), instance(), and Digikam::ProgressItem::setComplete().

Referenced by Digikam::PrivateProgressItemCreator::addProgressItem(), Digikam::AlbumParser::AlbumParser(), Digikam::FacesDetector::FacesDetector(), Digikam::FileActionProgress::FileActionProgress(), Digikam::FingerPrintsGenerator::FingerPrintsGenerator(), Digikam::ImageQualitySorter::ImageQualitySorter(), and Digikam::NewItemsFinder::NewItemsFinder().

◆ completeTransactionDeferred

void Digikam::ProgressManager::completeTransactionDeferred ( ProgressItem * item )

signal

◆ createProgressItem() [1/4]

ProgressItem * Digikam::ProgressManager::createProgressItem	(	const QString &	id,
		const QString &	label,
		const QString &	status = `QString()`,
		bool	canBeCanceled = `true`,
		bool	hasThumb = `false`
	)

static

Version without a parent.

References instance().

◆ createProgressItem() [2/4]

ProgressItem * Digikam::ProgressManager::createProgressItem	(	const QString &	label,
		const QString &	status = `QString()`,
		bool	canBeCanceled = `true`,
		bool	hasThumb = `false`
	)

static

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.

Parameters

label	The text to be displayed by progress handlers
status	Additional text to be displayed for the item.
canBeCanceled	can the user cancel this operation? Cancelling the parent will cancel the children as well (if they can be canceled) and ongoing children prevent parents from finishing.

Returns: The ProgressItem representing the operation.

References getUniqueID(), and instance().

Referenced by Digikam::DProgressWdg::progressScheduled(), and Digikam::StatusProgressBar::setProgressBarMode().

◆ createProgressItem() [3/4]

ProgressItem * Digikam::ProgressManager::createProgressItem	(	const QString &	parent,
		const QString &	id,
		const QString &	label,
		const QString &	status = `QString()`,
		bool	canBeCanceled = `true`,
		bool	hasThumb = `false`
	)

static

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

References instance().

◆ createProgressItem() [4/4]

ProgressItem * Digikam::ProgressManager::createProgressItem	(	ProgressItem *const	parent,
		const QString &	id,
		const QString &	label,
		const QString &	status = `QString()`,
		bool	canBeCanceled = `true`,
		bool	hasThumb = `false`
	)

static

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
status	Additional text to be displayed for the item.
canBeCanceled	can the user cancel this operation? Cancelling the parent will cancel the children as well (if they can be canceled) and ongoing children prevent parents from finishing.

Returns: The ProgressItem representing the operation.

References instance().

◆ emitShowProgressView()

void Digikam::ProgressManager::emitShowProgressView ( )

static

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

References instance().

◆ findItembyId()

ProgressItem * Digikam::ProgressManager::findItembyId ( const QString & id ) const

Returns: the progressitem for this id if it exist, else null.

References isEmpty().

Referenced by addProgressItem(), and Digikam::DFileOperations::copyFolderRecursively().

◆ getUniqueID()

QString Digikam::ProgressManager::getUniqueID ( )

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

Referenced by createProgressItem().

◆ instance()

ProgressManager * Digikam::ProgressManager::instance ( )

static

Returns: The singleton instance of this class.

Referenced by addProgressItem(), Digikam::StatusbarProgressWidget::connectSingleItem(), Digikam::DFileOperations::copyFolderRecursively(), Digikam::PrivateProgressItemCreator::createProgressItem(), createProgressItem(), Digikam::DigikamApp::DigikamApp(), emitShowProgressView(), Digikam::MaintenanceMngr::MaintenanceMngr(), Digikam::AlbumManager::mergeTAlbum(), Digikam::AlbumManager::moveTAlbum(), Digikam::ProgressView::ProgressView(), Digikam::StatusbarProgressWidget::slotClean(), Digikam::StatusbarProgressWidget::slotProgressItemCompleted(), Digikam::StatusbarProgressWidget::slotShowItemDelayed(), Digikam::StatusbarProgressWidget::StatusbarProgressWidget(), and Digikam::DigikamApp::~DigikamApp().

◆ isEmpty()

bool Digikam::ProgressManager::isEmpty ( ) const

Returns: true when there are no more progress items.

Referenced by findItembyId(), and Digikam::StatusbarProgressWidget::slotShowItemDelayed().

◆ progressItemAdded

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

signal

See also: ProgressItem::progressItemAdded()

◆ progressItemCanceled

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

signal

See also: ProgressItem::progressItemCanceled()

◆ progressItemCompleted

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

signal

See also: ProgressItem::progressItemCompleted()

◆ progressItemLabel

void Digikam::ProgressManager::progressItemLabel	(	ProgressItem *	,
		const QString &
	)

signal

See also: ProgressItem::progressItemLabel()

◆ progressItemProgress

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

signal

See also: ProgressItem::progressItemProgress()

◆ progressItemStatus

void Digikam::ProgressManager::progressItemStatus	(	ProgressItem *	,
		const QString &
	)

signal

See also: ProgressItem::progressItemStatus()

◆ progressItemThumbnail

void Digikam::ProgressManager::progressItemThumbnail	(	ProgressItem *	,
		const QPixmap &
	)

signal

See also: ProgressItem::progressItemThumbnail

◆ progressItemUsesBusyIndicator

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

signal

See also: ProgressItem::progressItemUsesBusyIndicator

◆ showProgressView

void Digikam::ProgressManager::showProgressView ( )

signal

Emitted when an operation requests the listeners to be shown. Use emitShowProgressView() to trigger it.

◆ singleItem()

ProgressItem * Digikam::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.

Referenced by Digikam::StatusbarProgressWidget::connectSingleItem().

◆ slotAbortAll

void Digikam::ProgressManager::slotAbortAll ( )

slot

Aborts all running jobs. Bound to "Esc"

Referenced by Digikam::DigikamApp::~DigikamApp().

◆ slotStandardCancelHandler

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

slot

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

Parameters

item	the canceled item.

References Digikam::ProgressItem::setComplete().

Friends And Related Function Documentation

◆ ProgressManagerCreator

friend class ProgressManagerCreator

friend

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

core/libs/progressmanager/progressmanager.h
core/libs/progressmanager/progressmanager.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ addProgressItem()

◆ completeTransactionDeferred

◆ createProgressItem() [1/4]

◆ createProgressItem() [2/4]

◆ createProgressItem() [3/4]

◆ createProgressItem() [4/4]

◆ emitShowProgressView()

◆ findItembyId()

◆ getUniqueID()

◆ instance()

◆ isEmpty()

◆ progressItemAdded

◆ progressItemCanceled

◆ progressItemCompleted

◆ progressItemLabel

◆ progressItemProgress

◆ progressItemStatus

◆ progressItemThumbnail

◆ progressItemUsesBusyIndicator

◆ showProgressView

◆ singleItem()

◆ slotAbortAll

◆ slotStandardCancelHandler

Friends And Related Function Documentation

◆ ProgressManagerCreator