Inheritance diagram for Digikam::MaintenanceTool:

Public Slots
void	start ()

Signals
void	progressItemAdded (ProgressItem *)

void	progressItemCanceled (ProgressItem *)

void	progressItemCanceledById (const QString &id)

void	progressItemCompleted (ProgressItem *)

void	progressItemLabel (ProgressItem *, const QString &)

void	progressItemProgress (ProgressItem *, unsigned int)

void	progressItemStatus (ProgressItem *, const QString &)

void	progressItemThumbnail (ProgressItem *item, const QPixmap &thumb)

void	progressItemUsesBusyIndicator (ProgressItem *item, bool value)

void	signalCanceled ()

void	signalComplete ()

Public Member Functions
void	addChild (ProgressItem *const kiddo)

bool	advance (unsigned int v)

bool	canBeCanceled () const

void	cancel ()

bool	canceled () const

unsigned int	completedItems () const

bool	hasThumbnail () const

const QString &	id () const

bool	incCompletedItems (unsigned int v=1)

void	incTotalItems (unsigned int v=1)

const QString &	label () const

	MaintenanceTool (const QString &id, ProgressItem *const parent=nullptr)

ProgressItem *	parent () const

unsigned int	progress () const

void	removeChild (ProgressItem *const kiddo)

void	reset ()

void	setComplete ()

bool	setCompletedItems (unsigned int v)

void	setLabel (const QString &v)

void	setNotificationEnabled (bool b)

void	setProgress (unsigned int v)

void	setShowAtStart (bool showAtStart)

void	setStatus (const QString &v)

void	setThumbnail (const QIcon &icon)

void	setTotalItems (unsigned int v)

virtual void	setUseMultiCoreCPU (bool)

void	setUsesBusyIndicator (bool useBusyIndicator)

bool	showAtStart () const

const QString &	status () const

bool	totalCompleted () const

unsigned int	totalItems () const

void	updateProgress ()

bool	usesBusyIndicator () const

	~MaintenanceTool () override

Protected Slots
virtual void	slotCancel ()

virtual void	slotDone ()

virtual void	slotStart ()

Constructor & Destructor Documentation

◆ MaintenanceTool()

Digikam::MaintenanceTool::MaintenanceTool	(	const QString &	id,
		ProgressItem *const	parent = `nullptr`
	)

explicit

References Digikam::ProgressItem::progressItemCanceledById(), and slotCancel().

◆ ~MaintenanceTool()

Digikam::MaintenanceTool::~MaintenanceTool ( )

override

Member Function Documentation

◆ addChild()

void Digikam::ProgressItem::addChild ( ProgressItem *const kiddo )

inherited

◆ advance()

bool Digikam::ProgressItem::advance ( unsigned int v )

inherited

Advance total items processed by n values and update percentage in progressbar.

Parameters

v	The value to advance.

Returns: true if totalCompleted()

References Digikam::ProgressItem::incCompletedItems(), and Digikam::ProgressItem::updateProgress().

Referenced by Digikam::DFileOperations::copyFolderRecursively().

◆ canBeCanceled()

bool Digikam::ProgressItem::canBeCanceled ( ) const

inherited

Returns: Whether this item can be canceled.

Referenced by Digikam::ProgressItem::cancel(), Digikam::ProgressItem::ProgressItem(), and Digikam::TransactionItem::TransactionItem().

◆ cancel()

void Digikam::ProgressItem::cancel ( )

inherited

References Digikam::ProgressItem::canBeCanceled(), Digikam::ProgressItem::cancel(), Digikam::ProgressItem::progressItemCanceled(), Digikam::ProgressItem::progressItemCanceledById(), and Digikam::ProgressItem::setStatus().

Referenced by Digikam::ProgressItem::cancel().

◆ canceled()

bool Digikam::ProgressItem::canceled ( ) const

inherited

◆ completedItems()

unsigned int Digikam::ProgressItem::completedItems ( ) const

inherited

◆ hasThumbnail()

bool Digikam::ProgressItem::hasThumbnail ( ) const

inherited

Returns: whether this item has a thumbnail.

Referenced by Digikam::ProgressItem::setThumbnail(), and Digikam::TransactionItem::TransactionItem().

◆ id()

const QString & Digikam::ProgressItem::id ( ) const

inherited

Returns: The id string which uniquely identifies the operation represented by this item.

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

◆ incCompletedItems()

bool Digikam::ProgressItem::incCompletedItems ( unsigned int v = 1 )

inherited

Referenced by Digikam::ProgressItem::advance().

◆ incTotalItems()

void Digikam::ProgressItem::incTotalItems ( unsigned int v = 1 )

inherited

Referenced by Digikam::DFileOperations::copyFolderRecursively(), and Digikam::TwoProgressItemsContainer::scheduleOnProgressItem().

◆ label()

const QString & Digikam::ProgressItem::label ( ) const

inherited

Returns: The user visible string to be used to represent this item.

Referenced by Digikam::ProgressItem::ProgressItem(), slotDone(), and Digikam::TransactionItem::TransactionItem().

◆ parent()

ProgressItem * Digikam::ProgressItem::parent ( ) const

inherited

Returns: The parent item of this one, if there is one.

Referenced by Digikam::ProgressItem::ProgressItem(), Digikam::StatusbarProgressWidget::slotProgressItemAdded(), Digikam::StatusbarProgressWidget::slotProgressItemCompleted(), and Digikam::ProgressView::slotTransactionAdded().

◆ progress()

unsigned int Digikam::ProgressItem::progress ( ) const

inherited

Returns: The current progress value of this item in percent.

Referenced by Digikam::TransactionItem::TransactionItem().

◆ progressItemAdded

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

signalinherited

Emitted when a new ProgressItem is added.

Parameters

The	ProgressItem that was added.

◆ progressItemCanceled

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

signalinherited

Emitted when an item was canceled. It will not go away immediately, only when the owner sets it complete, which will usually happen. Can be used to visually indicate the canceled status of an item. Should be used by the owner of the item to make sure it is set completed even if it is canceled. There is a ProgressManager::slotStandardCancelHandler which simply sets the item completed and can be used if no other work needs to be done on cancel.

Parameters

The	canceled item;

Referenced by Digikam::ProgressItem::cancel(), Digikam::FacesDetector::FacesDetector(), and Digikam::FileActionProgress::FileActionProgress().

◆ progressItemCanceledById

void Digikam::ProgressItem::progressItemCanceledById ( const QString & id )

signalinherited

Referenced by Digikam::ProgressItem::cancel(), and MaintenanceTool().

◆ progressItemCompleted

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

signalinherited

Emitted when a progress item was completed. The item will be deleted afterwards, so slots connected to this are the last chance to work with this item.

Parameters

The	completed item.

Referenced by Digikam::ProgressItem::removeChild(), and Digikam::ProgressItem::setComplete().

◆ progressItemLabel

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

signalinherited

Emitted when the label of an item changed. Should be used by progress dialogs to update the label of an item.

Parameters

The	updated item.
The	new label.

Referenced by Digikam::ProgressItem::setLabel().

◆ progressItemProgress

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

signalinherited

Emitted when the progress value of an item changes.

Parameters

The	item which got a new value.
The	value, for convenience.

Referenced by Digikam::ProgressItem::setProgress().

◆ progressItemStatus

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

signalinherited

Emitted when the status message of an item changed. Should be used by progress dialogs to update the status message for an item.

Parameters

The	updated item.
The	new message.

Referenced by Digikam::ProgressItem::setStatus().

◆ progressItemThumbnail

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

signalinherited

Emitted when the thumbnail data must be set in item.

Parameters

item	The updated item
thumb	thumbnail data

Referenced by Digikam::ProgressItem::setThumbnail().

◆ progressItemUsesBusyIndicator

void Digikam::ProgressItem::progressItemUsesBusyIndicator	(	ProgressItem *	item,
		bool	value
	)

signalinherited

Emitted when the busy indicator state of an item changes. Should be used by progress dialogs so that they can adjust the display of the progress bar to the new mode.

Parameters

item	The updated item
value	True if the item uses a busy indicator now, false otherwise

Referenced by Digikam::ProgressItem::setUsesBusyIndicator().

◆ removeChild()

void Digikam::ProgressItem::removeChild ( ProgressItem *const kiddo )

inherited

References Digikam::ProgressItem::progressItemCompleted().

◆ reset()

void Digikam::ProgressItem::reset ( )

inherited

Reset the progress value of this item to 0 and the status string to the empty string.

References Digikam::ProgressItem::setProgress(), and Digikam::ProgressItem::setStatus().

◆ setComplete()

void Digikam::ProgressItem::setComplete ( )

inherited

Tell the item it has finished. This will emit progressItemCompleted() result in the destruction of the item after all slots connected to this signal have executed. This is the only way to get rid of an item and needs to be called even if the item is canceled. Don't use the item after this has been called on it.

References Digikam::ProgressItem::progressItemCompleted(), and Digikam::ProgressItem::setProgress().

Referenced by Digikam::ProgressManager::addProgressItem(), Digikam::TwoProgressItemsContainer::advance(), Digikam::DProgressWdg::progressCompleted(), Digikam::StatusProgressBar::setProgressBarMode(), slotCancel(), slotDone(), Digikam::PrivateProgressItemCreator::slotProgressItemCanceled(), and Digikam::ProgressManager::slotStandardCancelHandler().

◆ setCompletedItems()

bool Digikam::ProgressItem::setCompletedItems ( unsigned int v )

inherited

Referenced by Digikam::StatusProgressBar::setProgressBarMode(), and Digikam::StatusProgressBar::setProgressValue().

◆ setLabel()

void Digikam::ProgressItem::setLabel ( const QString & v )

inherited

Parameters

v	Set the user visible string identifying this item.

References Digikam::ProgressItem::progressItemLabel().

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

◆ setNotificationEnabled()

void Digikam::MaintenanceTool::setNotificationEnabled ( bool b )

If true, show a notification message on desktop notification manager with time elpased to run process.

◆ setProgress()

void Digikam::ProgressItem::setProgress ( unsigned int v )

inherited

Set the progress (percentage of completion) value of this item.

Parameters

v	The percentage value.

References Digikam::ProgressItem::progressItemProgress().

Referenced by Digikam::ProgressItem::reset(), Digikam::ProgressItem::setComplete(), and Digikam::ProgressItem::updateProgress().

◆ setShowAtStart()

void Digikam::ProgressItem::setShowAtStart ( bool showAtStart )

inherited

Set the property to pop-up item when it's added in progress manager. Use this method if you consider that item is important to be notified to end-user.

References Digikam::ProgressItem::showAtStart().

Referenced by Digikam::NewItemsFinder::NewItemsFinder().

◆ setStatus()

void Digikam::ProgressItem::setStatus ( const QString & v )

inherited

Set the string to be used for showing this item's current status.

Parameters

v	The status string.

References Digikam::ProgressItem::progressItemStatus().

Referenced by Digikam::ProgressItem::cancel(), Digikam::DProgressWdg::progressStatusChanged(), Digikam::ProgressItem::reset(), and Digikam::StatusProgressBar::setProgressText().

◆ setThumbnail()

void Digikam::ProgressItem::setThumbnail ( const QIcon & icon )

inherited

Sets whether this item has a thumbnail.

References Digikam::ProgressItem::hasThumbnail(), and Digikam::ProgressItem::progressItemThumbnail().

Referenced by Digikam::FileActionProgress::FileActionProgress(), Digikam::NewItemsFinder::NewItemsFinder(), Digikam::DProgressWdg::progressThumbnailChanged(), and Digikam::StatusProgressBar::setProgressBarMode().

◆ setTotalItems()

void Digikam::ProgressItem::setTotalItems ( unsigned int v )

inherited

Referenced by Digikam::StatusProgressBar::setProgressBarMode(), and Digikam::StatusProgressBar::setProgressTotalSteps().

◆ setUseMultiCoreCPU()

virtual void Digikam::MaintenanceTool::setUseMultiCoreCPU ( bool )

inlinevirtual

Re-implement this method if your tool is able to use multi-core CPU to process item in parallel

Reimplemented in Digikam::ThumbsGenerator, Digikam::MetadataSynchronizer, Digikam::ImageQualitySorter, Digikam::FingerPrintsGenerator, and Digikam::DbCleaner.

◆ setUsesBusyIndicator()

void Digikam::ProgressItem::setUsesBusyIndicator ( bool useBusyIndicator )

inherited

Sets whether this item uses a busy indicator instead of real progress for its progress bar. If it uses a busy indicator, you are still responsible for calling setProgress() from time to time to update the busy indicator.

References Digikam::ProgressItem::progressItemUsesBusyIndicator().

◆ showAtStart()

bool Digikam::ProgressItem::showAtStart ( ) const

inherited

Returns: true if item must be pop-up when it's added in progress manager.

Referenced by Digikam::ProgressItem::setShowAtStart(), and Digikam::ProgressView::slotTransactionAdded().

◆ signalCanceled

void Digikam::MaintenanceTool::signalCanceled ( )

signal

Emit when process is canceled.

Referenced by slotCancel().

◆ signalComplete

void Digikam::MaintenanceTool::signalComplete ( )

signal

Emit when process is done (not canceled).

Referenced by slotDone().

◆ slotCancel

void Digikam::MaintenanceTool::slotCancel ( )

protectedvirtualslot

References Digikam::ProgressItem::setComplete(), and signalCanceled().

Referenced by MaintenanceTool().

◆ slotDone

void Digikam::MaintenanceTool::slotDone ( )

protectedvirtualslot

References Digikam::DNotificationWrapper(), Digikam::ProgressItem::label(), Digikam::ProgressItem::setComplete(), and signalComplete().

Referenced by Digikam::ImageQualitySorter::ImageQualitySorter().

◆ slotStart

void Digikam::MaintenanceTool::slotStart ( )

protectedvirtualslot

Referenced by start().

◆ start

void Digikam::MaintenanceTool::start ( )

slot

References slotStart().

Referenced by Digikam::SetupCollectionModel::apply(), Digikam::MetadataHubMngr::requestShutDown(), Digikam::ItemIconView::slotAlbumReadMetadata(), Digikam::ItemIconView::slotAlbumWriteMetadata(), Digikam::MetadataHubMngr::slotApplyPending(), Digikam::ItemIconView::slotImageReadMetadata(), Digikam::ItemIconView::slotImageScanForFaces(), Digikam::ItemIconView::slotImageWriteMetadata(), and Digikam::ItemIconView::slotRefresh().

◆ status()

const QString & Digikam::ProgressItem::status ( ) const

inherited

Returns: The string to be used for showing this item's current status.

Referenced by Digikam::ProgressItem::ProgressItem(), and Digikam::TransactionItem::TransactionItem().

◆ totalCompleted()

bool Digikam::ProgressItem::totalCompleted ( ) const

inherited

◆ totalItems()

unsigned int Digikam::ProgressItem::totalItems ( ) const

inherited

◆ updateProgress()

void Digikam::ProgressItem::updateProgress ( )

inherited

Recalculate progress according to total/completed items and update.

References Digikam::ProgressItem::setProgress().

Referenced by Digikam::ProgressItem::advance(), and Digikam::StatusProgressBar::setProgressValue().

◆ usesBusyIndicator()

bool Digikam::ProgressItem::usesBusyIndicator ( ) const

inherited

Returns: whether this item uses a busy indicator instead of real progress display

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

core/utilities/maintenance/maintenancetool.h
core/utilities/maintenance/maintenancetool.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Constructor & Destructor Documentation

◆ MaintenanceTool()

◆ ~MaintenanceTool()

Member Function Documentation

◆ addChild()

◆ advance()

◆ canBeCanceled()

◆ cancel()

◆ canceled()

◆ completedItems()

◆ hasThumbnail()

◆ id()

◆ incCompletedItems()

◆ incTotalItems()

◆ label()

◆ parent()

◆ progress()

◆ progressItemAdded

◆ progressItemCanceled

◆ progressItemCanceledById

◆ progressItemCompleted

◆ progressItemLabel

◆ progressItemProgress

◆ progressItemStatus

◆ progressItemThumbnail

◆ progressItemUsesBusyIndicator

◆ removeChild()

◆ reset()

◆ setComplete()

◆ setCompletedItems()

◆ setLabel()

◆ setNotificationEnabled()

◆ setProgress()

◆ setShowAtStart()

◆ setStatus()

◆ setThumbnail()

◆ setTotalItems()

◆ setUseMultiCoreCPU()

◆ setUsesBusyIndicator()

◆ showAtStart()

◆ signalCanceled

◆ signalComplete

◆ slotCancel

◆ slotDone

◆ slotStart

◆ start

◆ status()

◆ totalCompleted()

◆ totalItems()

◆ updateProgress()

◆ usesBusyIndicator()