KDE 4.4 API Reference digikam
Digikam::ScanController Class Reference
#include <scancontroller.h>
Detailed Description
Definition at line 51 of file scancontroller.h.
Member Enumeration Documentation
Definition at line 61 of file scancontroller.h.
Member Function Documentation
| void Digikam::ScanController::abortInitialization | ( | ) |
If the controller is currently processing a database update (typically after first run), cancel this hard and as soon as possible.
Any progress may be lost.
Definition at line 422 of file scancontroller.cpp.
| void Digikam::ScanController::cancelAllAndSuspendCollectionScan | ( | ) |
Cancels all running or scheduled operations and suspends scanning.
This method returns when all scanning has stopped. This includes a call to suspendCollectionScan(). Restart with resumeCollectionScan.
Definition at line 436 of file scancontroller.cpp.
| void Digikam::ScanController::cancelCompleteScan | ( | ) |
If the controller is currently doing a complete scan (typically at startup), stop this operation.
It can be resumed later.
Definition at line 429 of file scancontroller.cpp.
| 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 362 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 334 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 734 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 753 of file scancontroller.cpp.
| void Digikam::ScanController::hintAtMoveOrCopyOfItem | ( | qlonglong | id, | |
| const PAlbum * | dstAlbum, | |||
| QString | itemName | |||
| ) |
Definition at line 771 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 762 of file scancontroller.cpp.
| void Digikam::ScanController::incrementProgressDialog | ( | int | ) | [signal] |
| ScanController * Digikam::ScanController::instance | ( | ) | [static] |
Definition at line 222 of file scancontroller.cpp.
| void Digikam::ScanController::progressFromInitialization | ( | const QString & | , | |
| int | ||||
| ) | [signal] |
| void Digikam::ScanController::resumeCollectionScan | ( | ) |
Definition at line 464 of file scancontroller.cpp.
| void Digikam::ScanController::run | ( | ) | [protected, virtual] |
Reimplemented from QThread.
Definition at line 473 of file scancontroller.cpp.
| void Digikam::ScanController::scanFileDirectly | ( | const QString & | filePath | ) |
The file pointed to by file path will be scanned.
The scan is finished when returning from the method.
Definition at line 411 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 385 of file scancontroller.cpp.
| void Digikam::ScanController::scheduleCollectionScanRelaxed | ( | const QString & | path | ) |
Schedules a scan of the specified part of the collection.
Asynchronous, returns immediately. A small delay may be introduced before the actual scanning starts, so that you can call this often without checking for duplicates. This method must only be used from the main thread.
Definition at line 393 of file scancontroller.cpp.
| void Digikam::ScanController::shutDown | ( | ) |
Wait for the thread to finish.
Returns after all tasks are done.
Definition at line 277 of file scancontroller.cpp.
| void Digikam::ScanController::suspendCollectionScan | ( | ) |
Temporarily 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 458 of file scancontroller.cpp.
| void Digikam::ScanController::triggerShowProgressDialog | ( | ) | [signal] |
The documentation for this class was generated from the following files:
