• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

digikam

Digikam::ScanController

Digikam::ScanController Class Reference

#include <scancontroller.h>

Inheritance diagram for Digikam::ScanController:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 52 of file scancontroller.h.


Public Types

enum  Advice { Success, ContinueWithoutDatabase, AbortImmediately }

Signals

void completeScanDone ()
void databaseInitialized (bool success)
void errorFromInitialization (const QString &)
void incrementProgressDialog (int)
void progressFromInitialization (const QString &, int)
void triggerShowProgressDialog ()

Public Member Functions

void completeCollectionScan (SplashScreen *splash=0)
Advice databaseInitialization ()
void hintAtMoveOrCopyOfAlbum (const PAlbum *album, const QString &dstPath, const QString &newAlbumName=QString())
void hintAtMoveOrCopyOfAlbum (const PAlbum *album, const PAlbum *dstAlbum, const QString &newAlbumName=QString())
void hintAtMoveOrCopyOfItem (qlonglong id, const PAlbum *dstAlbum, QString itemName)
void hintAtMoveOrCopyOfItems (const QList< qlonglong > ids, const PAlbum *dstAlbum, QStringList itemNames)
void resumeCollectionScan ()
void scheduleCollectionScan (const QString &path)
void shutDown ()
void suspendCollectionScan ()

Static Public Member Functions

static ScanController * instance ()

Protected Member Functions

virtual void run ()

Member Enumeration Documentation

enum Digikam::ScanController::Advice

Enumerator:
Success 
ContinueWithoutDatabase 
AbortImmediately 

Definition at line 61 of file scancontroller.h.


Member Function Documentation

void Digikam::ScanController::completeCollectionScan ( SplashScreen *  splash = 0  ) 

Carries out a complete collection scan, providing progress feedback.

Synchronous, returns when ready. The database will be locked while the scan is running.

Definition at line 276 of file scancontroller.cpp.

void Digikam::ScanController::completeScanDone (  )  [signal]

ScanController::Advice Digikam::ScanController::databaseInitialization (  ) 

Calls DatabaseAccess::checkReadyForUse(), providing progress feedback if schema updating occurs.

Synchronous, returns when ready.

Definition at line 258 of file scancontroller.cpp.

void Digikam::ScanController::databaseInitialized ( bool  success  )  [signal]

void Digikam::ScanController::errorFromInitialization ( const QString &   )  [signal]

void Digikam::ScanController::hintAtMoveOrCopyOfAlbum ( const PAlbum *  album,
const QString &  dstPath,
const QString &  newAlbumName = QString() 
)

Definition at line 541 of file scancontroller.cpp.

void Digikam::ScanController::hintAtMoveOrCopyOfAlbum ( const PAlbum *  album,
const PAlbum *  dstAlbum,
const QString &  newAlbumName = QString() 
)

Hint at the imminent copy, move or rename of an album, so that the collection scanner is informed about this.

If the album is renamed, give the new name in newAlbumName. DstAlbum is the new parent album / dstPath is the new parent directory of the album, so do not include the album name to dstPath.

Definition at line 559 of file scancontroller.cpp.

void Digikam::ScanController::hintAtMoveOrCopyOfItem ( qlonglong  id,
const PAlbum *  dstAlbum,
QString  itemName 
)

Definition at line 577 of file scancontroller.cpp.

void Digikam::ScanController::hintAtMoveOrCopyOfItems ( const QList< qlonglong >  ids,
const PAlbum *  dstAlbum,
QStringList  itemNames 
)

Hint at the imminent copy, move or rename of items, so that the collection scanner is informed about this.

Give the list of existing items, specify the destination with dstAlbum, and give the names at destination in itemNames (Unless for rename, names wont usually change. Give them nevertheless.)

Definition at line 568 of file scancontroller.cpp.

void Digikam::ScanController::incrementProgressDialog ( int   )  [signal]

ScanController * Digikam::ScanController::instance (  )  [static]

Definition at line 164 of file scancontroller.cpp.

void Digikam::ScanController::progressFromInitialization ( const QString &  ,
int   
) [signal]

void Digikam::ScanController::resumeCollectionScan (  ) 

Definition at line 308 of file scancontroller.cpp.

void Digikam::ScanController::run (  )  [protected, virtual]

Reimplemented from QThread.

Definition at line 318 of file scancontroller.cpp.

void Digikam::ScanController::scheduleCollectionScan ( const QString &  path  ) 

Schedules a scan of the specified part of the collection.

Asynchronous, returns immediately.

Definition at line 294 of file scancontroller.cpp.

void Digikam::ScanController::shutDown (  ) 

Definition at line 213 of file scancontroller.cpp.

void Digikam::ScanController::suspendCollectionScan (  ) 

Temporarilly suspend collection scanning.

All scheduled scanning tasks are queued and will be done when resumeCollectionScan() has been called. Calling these methods is recursive, you must resume as often as you called suspend.

Definition at line 302 of file scancontroller.cpp.

void Digikam::ScanController::triggerShowProgressDialog (  )  [signal]


The documentation for this class was generated from the following files:
  • scancontroller.h
  • scancontroller.cpp

digikam

Skip menu "digikam"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • digikam
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal