KDE 4.2 API Reference digikam
Digikam::CollectionImageChangeset Class Reference
#include <databasechangesets.h>
Detailed Description
Definition at line 125 of file databasechangesets.h.
Public Types | |
| enum | Operation { Unknown, Added, Removed, RemovedAll, Deleted, RemovedDeleted, Moved, Copied } |
Public Member Functions | |
| QList< int > | albums () const |
| CollectionImageChangeset (qlonglong id, int album, Operation operation) | |
| CollectionImageChangeset (QList< qlonglong > ids, int album, Operation operation) | |
| CollectionImageChangeset (QList< qlonglong > ids, QList< int > albums, Operation operation) | |
| CollectionImageChangeset () | |
| bool | containsAlbum (int id) const |
| bool | containsImage (qlonglong id) const |
| QList< qlonglong > | ids () const |
| Operation | operation () const |
| CollectionImageChangeset & | operator<< (const QDBusArgument &argument) |
| CollectionImageChangeset & | operator<< (const CollectionImageChangeset &other) |
| const CollectionImageChangeset & | operator>> (QDBusArgument &argument) const |
Member Enumeration Documentation
- Enumerator:
-
Unknown Added "Added" indicates that images have been added to albums. Removed "Removed" indicates that an image has been removed from the given album, and has possibly set a status of Removed and a null Album (though this can already have changed to valid values), but the image-specific tables have not been removed. RemovedAll "RemovedAll" indicates that for all entries in the specified album, the "Removed" operation has been carried out. This is equivalent to a "Removed" changesets with all image ids in the list, but for RemovedAll, the list may not be explicitly given (may be empty).
Deleted "Deleted" indicates that the image-specific tables have been removed from the database. While "Removed" means all data is still there, though possibly not accessible from an album, this means all data has been irreversibly deleted.
RemovedDeleted Special combination: Images which has the "Removed" status have now been "Delete"d. A changeset with Removed or RemovedAll is guaranteed to have been sent anytime before. Image ids nor albums ids may or may be not available in any combination.
Moved Images have been moved. This is extra information; a Removed and then an Added changeset are guaranteed to be sent subsequently. Album is the source album.
Copied Images have been copied. This is extra information; an Added changeset is guaranteed to be sent subsequently. Album is the source album.
Definition at line 129 of file databasechangesets.h.
Constructor & Destructor Documentation
| Digikam::CollectionImageChangeset::CollectionImageChangeset | ( | ) |
An CollectionImageChangeset covers adding and removing an image to/from the collection.
It is described by a list of affected image ids, a list of affected albums, and an operation. Special Case "RemovedAll": If all images have been removed from an album, operation is RemovedAll, the album list contains the (now empty) albums, ids() is empty, but containsImage() always returns true. Special Case "RemovedDeleted": Images with the "Removed" status are now irreversibly deleted. ids() and/or albums() may be empty (this means information is not available).
Definition at line 158 of file databasechangesets.cpp.
| Digikam::CollectionImageChangeset::CollectionImageChangeset | ( | QList< qlonglong > | ids, | |
| QList< int > | albums, | |||
| Operation | operation | |||
| ) |
Definition at line 163 of file databasechangesets.cpp.
| Digikam::CollectionImageChangeset::CollectionImageChangeset | ( | QList< qlonglong > | ids, | |
| int | album, | |||
| Operation | operation | |||
| ) |
Definition at line 168 of file databasechangesets.cpp.
| Digikam::CollectionImageChangeset::CollectionImageChangeset | ( | qlonglong | id, | |
| int | album, | |||
| Operation | operation | |||
| ) |
Definition at line 174 of file databasechangesets.cpp.
Member Function Documentation
| QList< int > Digikam::CollectionImageChangeset::albums | ( | ) | const |
Definition at line 220 of file databasechangesets.cpp.
| bool Digikam::CollectionImageChangeset::containsAlbum | ( | int | id | ) | const |
Definition at line 225 of file databasechangesets.cpp.
| bool Digikam::CollectionImageChangeset::containsImage | ( | qlonglong | id | ) | const |
Definition at line 215 of file databasechangesets.cpp.
| QList< qlonglong > Digikam::CollectionImageChangeset::ids | ( | ) | const |
Specification of this changeset.
All special cases where the returned list may be empty are noted above. The lists are valid unless such a case is explicitly mentioned.
Definition at line 210 of file databasechangesets.cpp.
| CollectionImageChangeset::Operation Digikam::CollectionImageChangeset::operation | ( | ) | const |
Definition at line 230 of file databasechangesets.cpp.
| CollectionImageChangeset & Digikam::CollectionImageChangeset::operator<< | ( | const QDBusArgument & | argument | ) |
Definition at line 192 of file databasechangesets.cpp.
| CollectionImageChangeset & Digikam::CollectionImageChangeset::operator<< | ( | const CollectionImageChangeset & | other | ) |
Combines two CollectionImageChangesets.
The operations shall not differ between the two sets; the operation is set to Unknown if it differs. This is especially not suitable for RemovedAll changesets.
Definition at line 181 of file databasechangesets.cpp.
| const CollectionImageChangeset & Digikam::CollectionImageChangeset::operator>> | ( | QDBusArgument & | argument | ) | const |
Definition at line 202 of file databasechangesets.cpp.
The documentation for this class was generated from the following files:
