digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
Loading...
Searching...
No Matches
Digikam::ThumbsGenerator Class Reference
+ Inheritance diagram for Digikam::ThumbsGenerator:

Public Member Functions

 ThumbsGenerator (const bool rebuildAll, const AlbumList &list, ProgressItem *const parent=nullptr)
 Constructor using AlbumList as argument.
 
 ThumbsGenerator (const bool rebuildAll, int albumId, ProgressItem *const parent=nullptr)
 Constructor using Album Id as argument.
 
void setUseMultiCoreCPU (bool b) override
 Re-implement this method if your tool is able to use multi-core CPU to process item in parallel.
 
- Public Member Functions inherited from Digikam::MaintenanceTool
 MaintenanceTool (const QString &id, ProgressItem *const parent=nullptr)
 
void setNotificationEnabled (bool b)
 If true, show a notification message on desktop notification manager with time elpased to run process.
 
- Public Member Functions inherited from Digikam::ProgressItem
 ProgressItem (ProgressItem *const parent, const QString &id, const QString &label, const QString &status, bool canBeCanceled, bool hasThumb)
 
void addChild (ProgressItem *const kiddo)
 
bool advance (unsigned int v)
 Advance total items processed by n values and update percentage in progressbar.
 
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
 
ProgressItemparent () const
 
unsigned int progress () const
 
void removeChild (ProgressItem *const kiddo)
 
void reset ()
 Reset the progress value of this item to 0 and the status string to the empty string.
 
void setComplete ()
 Tell the item it has finished.
 
bool setCompletedItems (unsigned int v)
 
void setLabel (const QString &v)
 
void setProgress (unsigned int v)
 Set the progress (percentage of completion) value of this item.
 
void setShowAtStart (bool showAtStart)
 Set the property to pop-up item when it's added in progress manager.
 
void setStatus (const QString &v)
 Set the string to be used for showing this item's current status.
 
void setThumbnail (const QIcon &icon)
 Sets whether this item has a thumbnail.
 
void setTotalItems (unsigned int v)
 
void setUsesBusyIndicator (bool useBusyIndicator)
 Sets whether this item uses a busy indicator instead of real progress for its progress bar.
 
bool showAtStart () const
 
const QString & status () const
 
bool totalCompleted () const
 
unsigned int totalItems () const
 
void updateProgress ()
 Recalculate progress according to total/completed items and update.
 
bool usesBusyIndicator () const
 

Additional Inherited Members

- Public Slots inherited from Digikam::MaintenanceTool
void start ()
 
- Signals inherited from Digikam::MaintenanceTool
void signalCanceled ()
 Emit when process is canceled.
 
void signalComplete ()
 Emit when process is done (not canceled).
 
- Signals inherited from Digikam::ProgressItem
void progressItemAdded (ProgressItem *item)
 Emitted when a new ProgressItem is added.
 
void progressItemCanceled (ProgressItem *item)
 Emitted when an item was canceled.
 
void progressItemCanceledById (const QString &id)
 
void progressItemCompleted (ProgressItem *item)
 Emitted when a progress item was completed.
 
void progressItemLabel (ProgressItem *item, const QString &label)
 Emitted when the label of an item changed.
 
void progressItemProgress (ProgressItem *item, unsigned int v)
 Emitted when the progress value of an item changes.
 
void progressItemStatus (ProgressItem *item, const QString &mess)
 Emitted when the status message of an item changed.
 
void progressItemThumbnail (ProgressItem *item, const QPixmap &thumb)
 Emitted when the thumbnail data must be set in item.
 
void progressItemUsesBusyIndicator (ProgressItem *item, bool value)
 Emitted when the busy indicator state of an item changes.
 
- Protected Slots inherited from Digikam::MaintenanceTool
virtual void slotCancel ()
 
virtual void slotDone ()
 
virtual void slotStart ()
 

Constructor & Destructor Documentation

◆ ThumbsGenerator() [1/2]

Digikam::ThumbsGenerator::ThumbsGenerator ( const bool  rebuildAll,
int  albumId,
ProgressItem *const  parent = nullptr 
)
explicit

If Id = -1, whole Albums collection is processed.

◆ ThumbsGenerator() [2/2]

Digikam::ThumbsGenerator::ThumbsGenerator ( const bool  rebuildAll,
const AlbumList &  list,
ProgressItem *const  parent = nullptr 
)

If list is empty, whole Albums collection is processed.

Member Function Documentation

◆ setUseMultiCoreCPU()

void Digikam::ThumbsGenerator::setUseMultiCoreCPU ( bool  )
overridevirtual

Reimplemented from Digikam::MaintenanceTool.