digiKam
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Digikam::ItemInfo Class Reference

Public Types

typedef DatabaseFields::Hash< QVariant > DatabaseFieldsHashRaw
 

Public Member Functions

ItemInfo copyItem (int dstAlbumID, const QString &dstFileName)
 
bool isLocationAvailable () const
 
 ItemInfo ()
 
 ItemInfo (const ItemInfo &info)
 
 ItemInfo (const ItemListerRecord &record)
 
 ItemInfo (qlonglong ID)
 
bool operator!= (const ItemInfo &info) const
 
bool operator< (const ItemInfo &info) const
 
ItemInfo & operator= (const ItemInfo &info)
 
bool operator== (const ItemInfo &info) const
 
 ~ItemInfo ()
 
Operations with Properties
bool isNull () const
 
QString name () const
 
QDateTime dateTime () const
 
QDateTime modDateTime () const
 
qlonglong fileSize () const
 
QSize dimensions () const
 
QUrl fileUrl () const
 
QString filePath () const
 
qlonglong id () const
 
int albumId () const
 
int albumRootId () const
 
double aspectRatio () const
 
qlonglong manualOrder () const
 
DatabaseItem::Category category () const
 
QString format () const
 
bool isVisible () const
 
bool isRemoved () const
 
int orientation () const
 
QString title () const
 
QString comment () const
 
int faceCount () const
 
int unconfirmedFaceCount () const
 
QMap< QString, QString > getSuggestedNames () const
 
void setName (const QString &newName)
 
void setDateTime (const QDateTime &dateTime)
 
void setModDateTime (const QDateTime &dateTime)
 
void setManualOrder (qlonglong value)
 
void setOrientation (int value)
 
void setVisible (bool isVisible)
 
DatabaseFieldsHashRaw getDatabaseFieldsRaw (const DatabaseFields::Set &requestedSet) const
 
QVariant getDatabaseFieldRaw (const DatabaseFields::Set &requestedField) const
 
Operations with Geolocation
ItemPosition imagePosition () const
 
double longitudeNumber () const
 
double latitudeNumber () const
 
double altitudeNumber () const
 
bool hasCoordinates () const
 
bool hasAltitude () const
 
Operations with History
DImageHistory imageHistory () const
 
void setItemHistory (const DImageHistory &history)
 
bool hasImageHistory () const
 
QString uuid () const
 
void setUuid (const QString &uuid)
 
HistoryImageId historyImageId () const
 
bool hasDerivedImages () const
 
bool hasAncestorImages () const
 
QList< ItemInfo > derivedImages () const
 
QList< ItemInfo > ancestorImages () const
 
QList< QPair< qlonglong, qlonglong > > relationCloud () const
 
void markDerivedFrom (const ItemInfo &ancestorImage)
 
Operations with Groups
bool isGrouped () const
 
bool hasGroupedImages () const
 
int numberOfGroupedImages () const
 
ItemInfo groupImage () const
 
qlonglong groupImageId () const
 
QList< ItemInfo > groupedImages () const
 
void addToGroup (const ItemInfo &info)
 
void removeFromGroup ()
 
void clearGroup ()
 
Operations with Containers
ImageCommonContainer imageCommonContainer () const
 
ImageMetadataContainer imageMetadataContainer () const
 
VideoMetadataContainer videoMetadataContainer () const
 
PhotoInfoContainer photoInfoContainer () const
 
VideoInfoContainer videoInfoContainer () const
 
Template metadataTemplate () const
 
void setMetadataTemplate (const Template &t)
 
void removeMetadataTemplate ()
 
ItemComments imageComments (CoreDbAccess &access) const
 
ItemCopyright imageCopyright () const
 
ItemExtendedProperties imageExtendedProperties () const
 
Operations with Labels
int pickLabel () const
 
int colorLabel () const
 
int rating () const
 
void setPickLabel (int value)
 
void setColorLabel (int value)
 
void setRating (int value)
 

Static Public Member Functions

static ItemInfo fromLocalFile (const QString &path)
 
static ItemInfo fromLocationAlbumAndName (int locationId, const QString &album, const QString &name)
 
static ItemInfo fromUrl (const QUrl &url)
 

Operations with Similarity

class ItemInfoCache
 
class ItemInfoList
 
double similarityTo (const qlonglong imageId) const
 
double currentSimilarity () const
 
qlonglong currentReferenceImage () const
 
uint hash () const
 
QList< ItemInfo > fromUniqueHash (const QString &uniqueHash, qlonglong fileSize)
 
QString uniqueHash () const
 

Operations with Tags

void setTag (int tagID)
 
void addTagPaths (const QStringList &tagPaths)
 
void removeTag (int tagID)
 
void removeAllTags ()
 
ItemTagPair imageTagPair (int tagId) const
 
QList< ItemTagPair > availableItemTagPairs () const
 
QList< int > tagIds () const
 

Operations with Thumbnails

ThumbnailIdentifier thumbnailIdentifier () const
 
ThumbnailInfo thumbnailInfo () const
 
static ThumbnailIdentifier thumbnailIdentifier (qlonglong id)
 

Detailed Description

The ItemInfo class contains provides access to the database for a single image. The properties can be read and written. Information will be cached.

NOTE: access rules for all methods in this class: ItemInfoData members shall be accessed only under CoreDbAccess lock. The id and albumId are the exception to this rule, as they are primitive and will never change during the lifetime of an object.

Member Typedef Documentation

◆ DatabaseFieldsHashRaw

typedef DatabaseFields::Hash<QVariant> Digikam::ItemInfo::DatabaseFieldsHashRaw

Constructor & Destructor Documentation

◆ ItemInfo() [1/4]

Digikam::ItemInfo::ItemInfo ( )

Constructor Creates a null image info

Referenced by copyItem(), fromLocalFile(), fromLocationAlbumAndName(), fromUniqueHash(), and groupImage().

◆ ItemInfo() [2/4]

Digikam::ItemInfo::ItemInfo ( qlonglong  ID)
explicit

Constructor. Creates an ItemInfo object without any cached data initially.

Parameters
IDthe unique ID for this image

◆ ItemInfo() [3/4]

Digikam::ItemInfo::ItemInfo ( const ItemListerRecord &  record)
explicit

Constructor. Creates an ItemInfo object where the provided information will initially be available cached, without database access.

References Digikam::ItemListerRecord::albumID, Digikam::ItemListerRecord::albumRootID, Digikam::ItemInfoStatic::cache(), Digikam::ItemInfoCache::cacheByName(), Digikam::ItemListerRecord::category, Digikam::ItemListerRecord::creationDate, Digikam::ItemListerRecord::currentFuzzySearchReferenceImage, Digikam::ItemListerRecord::currentSimilarity, Digikam::ItemListerRecord::fileSize, Digikam::ItemListerRecord::format, Digikam::ItemListerRecord::imageID, Digikam::DatabaseFields::ImageMetadataNone, Digikam::ItemListerRecord::imageSize, Digikam::ItemInfoCache::infoForId(), Digikam::ItemListerRecord::modificationDate, Digikam::ItemListerRecord::name, Digikam::ItemListerRecord::rating, and Digikam::DatabaseFields::VideoMetadataNone.

◆ ItemInfo() [4/4]

Digikam::ItemInfo::ItemInfo ( const ItemInfo &  info)

Copy constructor.

◆ ~ItemInfo()

Digikam::ItemInfo::~ItemInfo ( )

Destructor

References Digikam::ItemInfoStatic::cache(), and Digikam::ItemInfoCache::dropInfo().

Member Function Documentation

◆ addTagPaths()

void Digikam::ItemInfo::addTagPaths ( const QStringList &  tagPaths)

Adds tags in the list to the item. Tags are created if they do not yet exist

References Digikam::CoreDB::addTagsToItems(), Digikam::CoreDbAccess::db(), Digikam::TagsCache::instance(), tagIds(), and Digikam::TagsCache::tagsForPaths().

◆ addToGroup()

void Digikam::ItemInfo::addToGroup ( const ItemInfo &  info)

Group this image behind the given image

References Digikam::CoreDB::addImageRelation(), Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesRelatingTo(), Digikam::DatabaseRelation::Grouped, groupImage(), groupImageId(), id(), isGrouped(), isNull(), Digikam::CoreDB::removeAllImageRelationsFrom(), and removeFromGroup().

Referenced by Digikam::FileActionMngrDatabaseWorker::editGroup().

◆ albumId()

int Digikam::ItemInfo::albumId ( ) const
Returns
the id of the PAlbum to which this item belongs

Referenced by Digikam::ContextMenuHelper::addGotoMenu(), Digikam::ItemFilterModel::categoryIdentifier(), Digikam::ItemSortSettings::compareCategories(), Digikam::ItemAlbumFilterModel::compareInfosCategories(), Digikam::ItemDragDropHandler::createMimeData(), Digikam::AlbumDragDropHandler::dropEvent(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::DBInfoIface::itemInfo(), Digikam::ItemFilterSettings::matches(), Digikam::LessThanByProximityToSubject::operator()(), Digikam::EmptyDTrashItemsJob::run(), Digikam::CollectionScanner::scanFile(), Digikam::AlbumHistory::slotClearSelectPAlbum(), and Digikam::ItemIconView::slotGotoAlbumAndItem().

◆ albumRootId()

int Digikam::ItemInfo::albumRootId ( ) const

The album root id

Referenced by Digikam::LessThanByProximityToSubject::operator()(), and Digikam::ItemScanner::resolvedImageHistory().

◆ altitudeNumber()

double Digikam::ItemInfo::altitudeNumber ( ) const

References imagePosition().

Referenced by Digikam::TableViewColumns::ColumnGeoProperties::compare(), and Digikam::TableViewColumns::ColumnGeoProperties::data().

◆ ancestorImages()

QList< ItemInfo > Digikam::ItemInfo::ancestorImages ( ) const

References Digikam::DatabaseRelation::DerivedFrom, and ItemInfoList.

◆ aspectRatio()

double Digikam::ItemInfo::aspectRatio ( ) const
Returns
the id of the Aspect Ratio for this item

References RETURN_ASPECTRATIO_IF_IMAGESIZE_CACHED.

Referenced by Digikam::ItemFilterSettings::matches().

◆ availableItemTagPairs()

QList< ItemTagPair > Digikam::ItemInfo::availableItemTagPairs ( ) const

References Digikam::ItemTagPair::availablePairs().

◆ category()

DatabaseItem::Category Digikam::ItemInfo::category ( ) const

Returns the category of the item: Image, Audio, Video

References Digikam::DatabaseFields::Category, Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesFields(), RETURN_IF_CACHED, STORE_IN_CACHE_AND_RETURN, and Digikam::DatabaseItem::UndefinedCategory.

Referenced by Digikam::ItemFullScreenOverlay::checkIndex(), Digikam::ItemRotateOverlay::checkIndex(), Digikam::CommonKeys::getDbValue(), Digikam::ItemFilterSettings::matches(), Digikam::FingerprintsTask::run(), Digikam::ItemPreviewView::setItemInfo(), Digikam::StackedView::setPreviewItem(), and thumbnailInfo().

◆ clearGroup()

void Digikam::ItemInfo::clearGroup ( )

This image hasGroupedImages(): Split up the group, remove all groupedImages() from this image's group.

References Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::Grouped, hasGroupedImages(), and Digikam::CoreDB::removeAllImageRelationsTo().

Referenced by Digikam::FileActionMngrDatabaseWorker::editGroup().

◆ colorLabel()

int Digikam::ItemInfo::colorLabel ( ) const

Returns the Color Label Id (see ColorLabel values in globals.h)

References Digikam::TagsCache::colorLabelFromTags(), Digikam::TagsCache::instance(), Digikam::NoColorLabel, RETURN_IF_CACHED, and tagIds().

Referenced by Digikam::TableViewColumns::ColumnDigikamProperties::compare(), Digikam::CollectionScanner::copyFileProperties(), Digikam::TableViewColumns::ColumnDigikamProperties::data(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::load(), Digikam::DisjointMetadata::load(), Digikam::ItemDelegate::paint(), and Digikam::ItemIconView::slotAssignColorLabel().

◆ comment()

QString Digikam::ItemInfo::comment ( ) const
Returns
the default comment for this item

References Digikam::ItemComments::defaultComment(), and RETURN_IF_CACHED.

Referenced by Digikam::TableViewColumns::ColumnDigikamProperties::data(), Digikam::CommonKeys::getDbValue(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::DBInfoIface::itemInfo(), Digikam::ItemFilterSettings::matches(), Digikam::ItemDelegate::paint(), and Digikam::ItemFilterModelPreparer::process().

◆ copyItem()

ItemInfo Digikam::ItemInfo::copyItem ( int  dstAlbumID,
const QString &  dstFileName 
)

Copy database information of this item to a newly created item

Parameters
dstAlbumIDdestination album id
dstFileNamenew filename
Returns
an ItemInfo object of the new item

References Digikam::CoreDB::copyItem(), Digikam::CoreDbAccess::db(), and ItemInfo().

◆ currentReferenceImage()

qlonglong Digikam::ItemInfo::currentReferenceImage ( ) const

Returns the id of the current fuzzy search reference image.

Referenced by Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnItemProperties::compare(), Digikam::TableViewColumns::ColumnItemProperties::data(), and Digikam::ItemDelegate::paint().

◆ currentSimilarity()

double Digikam::ItemInfo::currentSimilarity ( ) const

Referenced by Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnItemProperties::compare(), and Digikam::TableViewColumns::ColumnItemProperties::data().

◆ dateTime()

QDateTime Digikam::ItemInfo::dateTime ( ) const
Returns
the datetime of the image

References Digikam::DatabaseFields::CreationDate, Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemInformation(), RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::ItemFilterModel::categoryIdentifier(), Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnItemProperties::compare(), Digikam::ItemSortSettings::compareCategories(), Digikam::TableViewColumns::ColumnItemProperties::data(), Digikam::HaarIface::findDuplicates(), historyImageId(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::load(), Digikam::DisjointMetadata::load(), Digikam::ItemGPS::loadImageData(), Digikam::ItemFilterSettings::matches(), Digikam::ItemDelegate::paint(), Digikam::DateOption::parseOperation(), photoInfoContainer(), Digikam::CollectionScanner::scanAlbum(), setDateTime(), setModDateTime(), and Digikam::ItemIconView::slotGotoDateAndItem().

◆ derivedImages()

QList< ItemInfo > Digikam::ItemInfo::derivedImages ( ) const

References Digikam::DatabaseRelation::DerivedFrom, and ItemInfoList.

◆ dimensions()

QSize Digikam::ItemInfo::dimensions ( ) const
Returns
the dimensions of the image (valid only if dimensions have been requested)

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemInformation(), Digikam::DatabaseFields::Height, RETURN_IF_CACHED, and Digikam::DatabaseFields::Width.

Referenced by Digikam::FaceGroup::applyItemGeometryChanges(), Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnItemProperties::compare(), Digikam::FaceGroup::Private::createItem(), Digikam::FocusPointGroup::Private::createItem(), Digikam::TableViewColumns::ColumnItemProperties::data(), Digikam::DatabaseLoadSaveFileInfoProvider::dimensionsHint(), Digikam::HaarIface::findDuplicates(), Digikam::CommonKeys::getDbValue(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::load(), Digikam::ItemFilterSettings::matches(), Digikam::TableViewColumns::ColumnThumbnail::paint(), Digikam::ItemDelegate::paint(), Digikam::FaceGroup::rejectAll(), Digikam::FaceUtils::rotateFaces(), Digikam::FaceGroup::slotAddItemFinished(), Digikam::FocusPointGroup::slotAddItemFinished(), and Digikam::FileActionMngrFileWorker::transform().

◆ faceCount()

int Digikam::ItemInfo::faceCount ( ) const
Returns
the number of Faces in this item.

References Digikam::FaceTagsEditor::databaseFaces(), and RETURN_IF_CACHED.

Referenced by Digikam::ItemFilterModel::categoryIdentifier(), and Digikam::ItemSortSettings::compareCategories().

◆ filePath()

QString Digikam::ItemInfo::filePath ( ) const

Returns the file path to the image

References Digikam::ItemInfoCache::albumRelativePath(), Digikam::CollectionManager::albumRootPath(), Digikam::ItemInfoStatic::cache(), and Digikam::CollectionManager::instance().

Referenced by Digikam::ScanController::beginFileMetadataWrite(), Digikam::FacePipeline::Private::buildPackage(), Digikam::ItemSortSettings::compare(), Digikam::SearchModificationHelper::createFuzzySearchFromImage(), fileUrl(), Digikam::ScanController::finishFileMetadataWrite(), Digikam::SimilarityDb::getDirtyOrMissingFingerprintURLs(), historyImageId(), Digikam::ItemModel::imageInfo(), Digikam::ItemModel::imageInfos(), Digikam::FocusPointGroup::isAllowedToAddFocusPoint(), Digikam::FocusPointGroup::load(), Digikam::ItemViewUtilities::openInfos(), Digikam::operator<<(), Digikam::TableViewTreeView::pixmapForDrag(), Digikam::FacePipeline::process(), Digikam::FaceGroup::rejectAll(), Digikam::DatabaseTask::run(), Digikam::FingerprintsTask::run(), Digikam::MetadataTask::run(), Digikam::CollectionScanner::scanFile(), Digikam::ItemPreviewCanvas::setItemInfo(), Digikam::ItemPreviewView::setItemInfo(), Digikam::FocusPointGroup::slotAddItemFinished(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), thumbnailIdentifier(), thumbnailInfo(), Digikam::FileActionMngrFileWorker::transform(), Digikam::FileActionMngrFileWorker::writeMetadataToFiles(), Digikam::FileActionMngrFileWorker::writeOrientationToFiles(), and Digikam::MetadataHub::writeToMetadata().

◆ fileSize()

qlonglong Digikam::ItemInfo::fileSize ( ) const
Returns
the filesize of the image

References Digikam::CoreDbAccess::db(), Digikam::DatabaseFields::FileSize, Digikam::CoreDB::getImagesFields(), RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnFileProperties::compare(), Digikam::TableViewColumns::ColumnFileProperties::data(), Digikam::HaarIface::findDuplicates(), fromUniqueHash(), Digikam::CommonKeys::getDbValue(), Digikam::DBInfoIface::itemInfo(), Digikam::ItemDelegate::paint(), Digikam::CollectionScannerHintContainerImplementation::recordHint(), Digikam::DatabaseTask::run(), and thumbnailInfo().

◆ fileUrl()

QUrl Digikam::ItemInfo::fileUrl ( ) const

Returns the file:// url. This is equivalent to QUrl::fromLocalFile(filePath())

References filePath().

Referenced by Digikam::ItemDragDropHandler::createMimeData(), Digikam::ItemCategorizedView::currentUrl(), Digikam::ItemIconView::currentUrl(), Digikam::TableViewColumns::ColumnFileProperties::data(), Digikam::ItemViewUtilities::deleteImages(), Digikam::QueueListView::findItemByUrl(), Digikam::IOJobData::findItemInfo(), Digikam::IOJobData::IOJobData(), Digikam::ItemPropertiesSideBarDB::itemChanged(), Digikam::ItemFilterSettings::matches(), Digikam::ItemViewUtilities::openInfosWithDefaultApplication(), Digikam::FindDuplicatesAlbum::removeDuplicates(), Digikam::DigikamItemView::rename(), Digikam::IOJobData::setItemInfos(), Digikam::StackedView::setPreviewItem(), Digikam::LightTableWindow::slotFileChanged(), Digikam::TableView::slotSetCurrentUrlWhenAvailable(), Digikam::ItemInfoList::toImageUrlList(), and Digikam::FileActionMngrFileWorker::transform().

◆ format()

QString Digikam::ItemInfo::format ( ) const

Returns the image format / mimetype as a standardized string (see project/documents/DBSCHEMA.ODS).

References Digikam::CoreDbAccess::db(), Digikam::DatabaseFields::Format, Digikam::CoreDB::getItemInformation(), RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::ItemFilterModel::categoryIdentifier(), Digikam::ItemSortSettings::compareCategories(), Digikam::CommonKeys::getDbValue(), Digikam::ItemFilterSettings::matches(), Digikam::ItemDelegate::paint(), and Digikam::FileActionMngrFileWorker::transform().

◆ fromLocalFile()

ItemInfo Digikam::ItemInfo::fromLocalFile ( const QString &  path)
static

Creates an ItemInfo object from a file url.

References Digikam::CollectionManager::album(), fromLocationAlbumAndName(), Digikam::CollectionManager::instance(), ItemInfo(), Digikam::RedEye::location(), Digikam::CollectionManager::locationForPath(), and name().

Referenced by Digikam::DatabaseLoadSaveFileInfoProvider::dimensionsHint(), fromUrl(), Digikam::HaarIface::indexImage(), Digikam::DatabaseLoadSaveFileInfoProvider::orientationHint(), Digikam::ImageQualityTask::run(), Digikam::ScanController::scannedInfo(), Digikam::ThumbsDbInfoProvider::thumbnailInfo(), and Digikam::MetadataHub::write().

◆ fromLocationAlbumAndName()

ItemInfo Digikam::ItemInfo::fromLocationAlbumAndName ( int  locationId,
const QString &  album,
const QString &  name 
)
static

Create an ItemInfo object from the given combination, which must be cleaned and corresponding to the values in the database

References Digikam::ItemShortInfo::albumID, Digikam::ItemShortInfo::albumRootID, Digikam::ItemInfoStatic::cache(), Digikam::ItemInfoCache::cacheByName(), Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemShortInfo(), Digikam::ItemShortInfo::id, Digikam::ItemInfoCache::infoForId(), Digikam::ItemInfoCache::infoForPath(), ItemInfo(), Digikam::ItemShortInfo::itemName, and name().

Referenced by fromLocalFile().

◆ fromUniqueHash()

QList< ItemInfo > Digikam::ItemInfo::fromUniqueHash ( const QString &  uniqueHash,
qlonglong  fileSize 
)

Scans the database for items with the given signature.

References Digikam::CoreDbAccess::db(), fileSize(), Digikam::CoreDB::getIdenticalFiles(), Digikam::ItemScanInfo::id, ItemInfo(), and uniqueHash().

◆ fromUrl()

ItemInfo Digikam::ItemInfo::fromUrl ( const QUrl &  url)
static

References fromLocalFile().

Referenced by Digikam::DBInfoIface::deleteImage(), Digikam::CommonKeys::getDbValue(), Digikam::MetadataKeys::getDbValue(), Digikam::PositionKeys::getDbValue(), Digikam::DBInfoIface::itemInfo(), Digikam::CameraNameOption::parseOperation(), Digikam::DateOption::parseOperation(), Digikam::DIO::rename(), Digikam::Task::run(), Digikam::DBInfoIface::setItemInfo(), Digikam::LightTableThumbBar::slotColorLabelChanged(), Digikam::DBInfoIface::slotDateTimeForUrl(), Digikam::LightTableThumbBar::slotPickLabelChanged(), Digikam::LightTableThumbBar::slotRatingChanged(), and Digikam::LightTableThumbBar::slotToggleTag().

◆ getDatabaseFieldRaw()

QVariant Digikam::ItemInfo::getDatabaseFieldRaw ( const DatabaseFields::Set &  requestedField) const

References getDatabaseFieldsRaw(), and value.

◆ getDatabaseFieldsRaw()

ItemInfo::DatabaseFieldsHashRaw Digikam::ItemInfo::getDatabaseFieldsRaw ( const DatabaseFields::Set &  requestedSet) const

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImageMetadata(), Digikam::CoreDB::getVideoMetadata(), Digikam::DatabaseFields::ImageMetadataAll, Digikam::DatabaseFields::ImageMetadataNone, Digikam::DatabaseFields::VideoMetadataAll, and Digikam::DatabaseFields::VideoMetadataNone.

Referenced by getDatabaseFieldRaw(), imageMetadataContainer(), Digikam::TableViewModel::itemDatabaseFieldsRaw(), and videoMetadataContainer().

◆ getSuggestedNames()

QMap< QString, QString > Digikam::ItemInfo::getSuggestedNames ( ) const
Returns
the map of Tag Region (in XML form) to Suggested Names for all Faces in the Image. Used to categorize images based on Face Suggestions.

References Digikam::FaceTagsEditor::getSuggestedNames(), and RETURN_IF_CACHED.

Referenced by Digikam::ItemFilterModel::categoryIdentifier(), and Digikam::ItemSortSettings::compareCategories().

◆ groupedImages()

QList< ItemInfo > Digikam::ItemInfo::groupedImages ( ) const

Returns the list of images grouped behind this image (not including this image itself) and an empty list if there is none.

References Digikam::DatabaseRelation::Grouped, hasGroupedImages(), and ItemInfoList.

Referenced by Digikam::ItemModel::ensureHasGroupedImages(), Digikam::GroupingViewImplementation::getHiddenGroupedInfos(), Digikam::GroupedImagesFinder::GroupedImagesFinder(), and Digikam::ItemInfoList::singleGroupMainItem().

◆ groupImage()

ItemInfo Digikam::ItemInfo::groupImage ( ) const

Returns the leading image of the group. Returns a null image if this image is not grouped (isGrouped())

References groupImageId(), and ItemInfo().

Referenced by addToGroup(), groupImageId(), Digikam::GroupItemFilterSettings::matches(), and Digikam::ItemInfoList::singleGroupMainItem().

◆ groupImageId()

qlonglong Digikam::ItemInfo::groupImageId ( ) const

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesRelatedFrom(), Digikam::DatabaseRelation::Grouped, groupImage(), and RETURN_IF_CACHED.

Referenced by addToGroup(), Digikam::ItemFilterModel::categoryIdentifier(), Digikam::ItemFilterModel::compareCategories(), groupImage(), isGrouped(), and Digikam::ItemFilterModel::subSortLessThan().

◆ hasAltitude()

bool Digikam::ItemInfo::hasAltitude ( ) const

References imagePosition().

Referenced by Digikam::TableViewColumns::ColumnGeoProperties::compare(), and Digikam::TableViewColumns::ColumnGeoProperties::data().

◆ hasAncestorImages()

bool Digikam::ItemInfo::hasAncestorImages ( ) const

References Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::DerivedFrom, and Digikam::CoreDB::hasImagesRelatedFrom().

◆ hasCoordinates()

bool Digikam::ItemInfo::hasCoordinates ( ) const

References imagePosition().

Referenced by Digikam::ItemCoordinatesOverlay::checkIndex(), Digikam::TableViewColumns::ColumnGeoProperties::data(), Digikam::MapViewModelHelper::itemCoordinates(), Digikam::ItemFilterSettings::matches(), and Digikam::ItemDelegate::paint().

◆ hasDerivedImages()

bool Digikam::ItemInfo::hasDerivedImages ( ) const

Retrieve information about images from which this image is derived (ancestorImages) and images that have been derived from this images (derivedImages).

References Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::DerivedFrom, and Digikam::CoreDB::hasImagesRelatingTo().

◆ hasGroupedImages()

bool Digikam::ItemInfo::hasGroupedImages ( ) const

The image is the leading image of a group, there are other images grouped behind this one.

References numberOfGroupedImages().

Referenced by Digikam::GroupIndicatorOverlay::checkIndex(), clearGroup(), groupedImages(), Digikam::DigikamItemView::hasHiddenGroupedImages(), Digikam::TableViewTreeView::hasHiddenGroupedImages(), and Digikam::ItemDelegate::paint().

◆ hash()

uint Digikam::ItemInfo::hash ( ) const

Return a signature for the item.

References qHash().

Referenced by Digikam::qHash().

◆ hasImageHistory()

bool Digikam::ItemInfo::hasImageHistory ( ) const

References Digikam::CoreDbAccess::db(), and Digikam::CoreDB::hasImageHistory().

◆ historyImageId()

HistoryImageId Digikam::ItemInfo::historyImageId ( ) const

Constructs a HistoryImageId with all available information for this image.

References dateTime(), Digikam::CoreDbAccess::db(), filePath(), Digikam::ItemScanInfo::fileSize, Digikam::CoreDB::getItemScanInfo(), id(), name(), Digikam::ItemScanInfo::uniqueHash, and uuid().

Referenced by Digikam::ItemHistoryGraph::addHistory(), Digikam::ItemHistoryGraphData::addVertex(), and Digikam::ItemScanner::resolvedImageHistory().

◆ id()

qlonglong Digikam::ItemInfo::id ( ) const
Returns
the unique image id for this item

Referenced by Digikam::FacePipeline::addManually(), Digikam::MetadataHubMngr::addPending(), addToGroup(), Digikam::ItemHistoryGraph::allImageIds(), Digikam::FileActionMngrDatabaseWorker::assignColorLabel(), Digikam::FileActionMngrDatabaseWorker::assignPickLabel(), Digikam::FileActionMngrDatabaseWorker::assignRating(), Digikam::ItemTagPair::availablePairs(), Digikam::ScanController::beginFileMetadataWrite(), Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnItemProperties::compare(), Digikam::CollectionScanner::copyFileProperties(), Digikam::SearchModificationHelper::createFuzzySearchFromImage(), Digikam::ItemDragDropHandler::createMimeData(), Digikam::TableViewColumns::ColumnItemProperties::data(), Digikam::ItemViewUtilities::deleteImages(), Digikam::ItemViewUtilities::deleteImagesDirectly(), Digikam::DigikamItemView::dragDropSort(), Digikam::ScanStateFilter::filter(), Digikam::QueueListView::findItemById(), Digikam::ScanController::finishFileMetadataWrite(), Digikam::SimilarityDb::getDirtyOrMissingFingerprints(), Digikam::SimilarityDb::getDirtyOrMissingFingerprintURLs(), Digikam::GroupedImagesFinder::GroupedImagesFinder(), Digikam::DigikamItemView::groupIndicatorClicked(), Digikam::SimilarityDb::hasDirtyOrMissingFingerprint(), Digikam::DigikamItemView::hasHiddenGroupedImages(), Digikam::TableViewTreeView::hasHiddenGroupedImages(), Digikam::ItemModel::hasImage(), historyImageId(), Digikam::ItemModel::indexesForItemInfo(), Digikam::ItemModel::indexForItemInfo(), Digikam::HaarIface::indexImage(), Digikam::FaceGroup::load(), Digikam::MetadataHub::loadFaceTags(), Digikam::LightTableWindow::loadItemInfos(), markDerivedFrom(), Digikam::VersionItemFilterSettings::matches(), Digikam::GroupItemFilterSettings::matches(), Digikam::ItemFilterSettings::matches(), Digikam::ItemModel::numberOfIndexesForItemInfo(), Digikam::LessThanByProximityToSubject::operator()(), Digikam::operator<<(), Digikam::HistoryVertexProperties::operator==(), Digikam::ItemDelegate::paint(), Digikam::GPSMarkerTiler::pixmapFromRepresentativeIndex(), Digikam::ItemFilterModelFilterer::process(), Digikam::FaceGroup::rejectAll(), Digikam::ItemHistoryGraph::relationCloud(), Digikam::ItemHistoryGraph::relationCloudParallel(), Digikam::QueueListView::removeItemById(), Digikam::QueueListView::removeItemByInfo(), Digikam::ItemModel::removeItemInfos(), Digikam::FaceUtils::rotateFaces(), Digikam::FingerprintsTask::run(), Digikam::ItemGPS::saveChanges(), Digikam::CollectionScanner::scanFile(), Digikam::ItemViewUtilities::setAsAlbumThumbnail(), Digikam::ItemAlbumModel::slotData(), Digikam::ItemIconView::slotGotoAlbumAndItem(), Digikam::ItemIconView::slotGotoDateAndItem(), Digikam::TableView::slotSetCurrentUrlWhenAvailable(), Digikam::FileActionMngr::Private::startingToWrite(), Digikam::ItemFilterModel::subSortLessThan(), thumbnailIdentifier(), Digikam::ItemInfoList::toImageIdList(), and Digikam::ItemModel::uniqueItemInfos().

◆ imageComments()

ItemComments Digikam::ItemInfo::imageComments ( CoreDbAccess &  access) const

Retrieve the ItemComments object for this item. This object allows full read and write access to all comments and their properties. You need to hold CoreDbAccess to ensure the validity. For simple, cached read access see comment().

Referenced by Digikam::MetadataHub::load(), Digikam::DisjointMetadata::load(), and Digikam::DisjointMetadata::write().

◆ imageCommonContainer()

ImageCommonContainer Digikam::ItemInfo::imageCommonContainer ( ) const

Retrieve information about the image, in form of numbers and user presentable strings, for certain defined fields of information (see databaseinfocontainers.h)

References Digikam::ItemScanner::fillCommonContainer().

Referenced by Digikam::TableViewColumns::ColumnItemProperties::compare(), Digikam::TableViewColumns::ColumnItemProperties::data(), Digikam::CommonKeys::getDbValue(), and Digikam::ToolTipFiller::imageInfoTipContents().

◆ imageCopyright()

ItemCopyright Digikam::ItemInfo::imageCopyright ( ) const

Retrieve the ItemCopyright object for this item. This object allows full read and write access to all copyright values.

Referenced by Digikam::CommonKeys::getDbValue(), Digikam::DBInfoIface::itemInfo(), metadataTemplate(), removeMetadataTemplate(), and setMetadataTemplate().

◆ imageExtendedProperties()

ItemExtendedProperties Digikam::ItemInfo::imageExtendedProperties ( ) const

Retrieve the ItemExtendedProperties object for this item. This object allows full read and write access to all extended properties values.

Referenced by metadataTemplate(), removeMetadataTemplate(), setMetadataTemplate(), and similarityTo().

◆ imageHistory()

DImageHistory Digikam::ItemInfo::imageHistory ( ) const

Retrieves and sets the image history from the database. Note: The image history retrieved here does typically include all steps from the original to this image, but does not reference this image itself.

References Digikam::CoreDbAccess::db(), Digikam::DImageHistory::fromXml(), Digikam::CoreDB::getItemHistory(), and Digikam::ImageHistoryEntry::history.

Referenced by Digikam::ItemHistoryGraph::fromInfo(), and Digikam::ItemPropertiesVersionsTab::setItem().

◆ imageMetadataContainer()

ImageMetadataContainer Digikam::ItemInfo::imageMetadataContainer ( ) const

References Digikam::ImageMetadataContainer::allFieldsNull, Digikam::DatabaseFields::Aperture, Digikam::ImageMetadataContainer::aperture, Digikam::DatabaseImageMetadataFieldsToMetadataInfoField(), Digikam::DatabaseFields::ExposureMode, Digikam::ImageMetadataContainer::exposureMode, Digikam::DatabaseFields::ExposureProgram, Digikam::ImageMetadataContainer::exposureProgram, Digikam::DatabaseFields::ExposureTime, Digikam::ImageMetadataContainer::exposureTime, Digikam::DatabaseFields::FlashMode, Digikam::ImageMetadataContainer::flashMode, Digikam::DatabaseFields::FocalLength, Digikam::ImageMetadataContainer::focalLength, Digikam::DatabaseFields::FocalLength35, Digikam::ImageMetadataContainer::focalLength35, getDatabaseFieldsRaw(), Digikam::DatabaseFields::ImageMetadataAll, Digikam::DatabaseFields::Lens, Digikam::ImageMetadataContainer::lens, Digikam::DatabaseFields::Make, Digikam::ImageMetadataContainer::make, Digikam::DatabaseFields::Model, Digikam::ImageMetadataContainer::model, Digikam::DatabaseFields::Sensitivity, Digikam::ImageMetadataContainer::sensitivity, Digikam::DatabaseFields::SubjectDistance, Digikam::ImageMetadataContainer::subjectDistance, Digikam::DatabaseFields::SubjectDistanceCategory, Digikam::ImageMetadataContainer::subjectDistanceCategory, Digikam::DMetadata::valueToString(), Digikam::DatabaseFields::WhiteBalance, Digikam::ImageMetadataContainer::whiteBalance, Digikam::DatabaseFields::WhiteBalanceColorTemperature, and Digikam::ImageMetadataContainer::whiteBalanceColorTemperature.

Referenced by Digikam::MetadataKeys::getDbValue(), Digikam::ToolTipFiller::imageInfoTipContents(), and photoInfoContainer().

◆ imagePosition()

ItemPosition Digikam::ItemInfo::imagePosition ( ) const

Retrieve the ItemPosition object for this item.

References Digikam::ItemPosition::altitude(), Digikam::ItemPosition::hasAltitude(), Digikam::ItemPosition::hasCoordinates(), Digikam::ItemPosition::latitudeNumber(), and Digikam::ItemPosition::longitudeNumber().

Referenced by altitudeNumber(), Digikam::PositionKeys::getDbValue(), hasAltitude(), hasCoordinates(), Digikam::DBInfoIface::itemInfo(), latitudeNumber(), Digikam::MetadataHub::load(), Digikam::ItemGPS::loadImageData(), longitudeNumber(), and Digikam::ItemGPS::saveChanges().

◆ imageTagPair()

ItemTagPair Digikam::ItemInfo::imageTagPair ( int  tagId) const

Retrieve an ItemTagPair object for a single tag, or for all image/tag pairs for which properties are available (not necessarily the assigned tags)

◆ isGrouped()

bool Digikam::ItemInfo::isGrouped ( ) const

The image is grouped in the group of another (leading) image.

References groupImageId().

Referenced by addToGroup(), Digikam::GroupItemFilterSettings::matches(), and removeFromGroup().

◆ isLocationAvailable()

bool Digikam::ItemInfo::isLocationAvailable ( ) const

Returns true if this is a valid ItemInfo, and the location of the image is currently available (information freshly obtained from CollectionManager)

References Digikam::CollectionManager::instance(), Digikam::CollectionLocation::isAvailable(), and Digikam::CollectionManager::locationForAlbumRootId().

Referenced by Digikam::CollectionScanner::scanFile().

◆ isNull()

bool Digikam::ItemInfo::isNull ( ) const

Returns if this objects contains valid data

Referenced by Digikam::DigikamItemView::activated(), Digikam::ContextMenuHelper::addGotoMenu(), addToGroup(), Digikam::ItemTagPair::availablePairs(), Digikam::LightTableView::checkForSelection(), Digikam::CollectionScanner::copyFileProperties(), Digikam::SearchModificationHelper::createFuzzySearchFromImage(), Digikam::ItemThumbnailModel::data(), Digikam::DigikamItemView::dragDropSort(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::LightTableThumbBar::findItemByInfo(), Digikam::DigikamItemView::groupIndicatorClicked(), Digikam::ItemIconView::hasCurrentItem(), Digikam::ItemCategorizedView::hintAt(), Digikam::ItemCategorizedView::indexActivated(), Digikam::ItemHistoryGraphModel::indexForInfo(), Digikam::HaarIface::indexImage(), Digikam::ItemViewUtilities::insertToLightTableAuto(), Digikam::MapViewModelHelper::itemCoordinates(), Digikam::DBInfoIface::itemInfo(), Digikam::FaceGroup::load(), Digikam::FocusPointGroup::load(), Digikam::LightTableWindow::loadItemInfos(), markDerivedFrom(), Digikam::FuzzySearchSideBarWidget::newSimilarSearch(), Digikam::ItemViewUtilities::openInfos(), Digikam::LessThanByProximityToSubject::operator()(), Digikam::HistoryVertexProperties::operator+=(), Digikam::TableViewColumns::ColumnThumbnail::paint(), Digikam::ItemDelegate::paint(), Digikam::CameraNameOption::parseOperation(), Digikam::DateOption::parseOperation(), Digikam::MapViewModelHelper::pixmapFromRepresentativeIndex(), Digikam::LightTableThumbBar::removeItemByInfo(), Digikam::MetadataHubMngr::requestShutDown(), Digikam::ItemScanner::resolvedImageHistory(), Digikam::DatabaseTask::run(), Digikam::MetadataTask::run(), Digikam::CollectionScanner::scanFile(), Digikam::ScanController::scannedInfo(), Digikam::ItemPropertiesVersionsTab::setItem(), Digikam::ItemDescEditTab::setItem(), Digikam::ItemPreviewView::setItemInfo(), Digikam::LightTableView::setLeftItemInfo(), Digikam::StackedView::setPreviewItem(), Digikam::LightTableView::setRightItemInfo(), Digikam::MetadataHubMngr::slotApplyPending(), Digikam::DBInfoIface::slotDateTimeForUrl(), Digikam::ItemIconView::slotEditor(), Digikam::LightTableWindow::slotFileChanged(), Digikam::ItemIconView::slotImageFindSimilar(), Digikam::TableView::slotItemActivated(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), Digikam::ItemIconView::slotQueueMgr(), Digikam::VersionsWidget::slotViewCurrentChanged(), Digikam::ItemScanner::sortByProximity(), Digikam::ItemScanner::tagItemHistoryGraph(), and Digikam::ThumbsDbInfoProvider::thumbnailInfo().

◆ isRemoved()

bool Digikam::ItemInfo::isRemoved ( ) const

Returns true if the corresponding file was not deleted.

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesFields(), Digikam::DatabaseItem::Obsolete, Digikam::DatabaseFields::Status, Digikam::DatabaseItem::Trashed, and value.

Referenced by Digikam::FindDuplicatesAlbumItem::calculateInfos(), Digikam::MetadataHubMngr::requestShutDown(), and Digikam::MetadataHubMngr::slotApplyPending().

◆ isVisible()

bool Digikam::ItemInfo::isVisible ( ) const

Returns true if the image is marked as visible in the database.

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesFields(), Digikam::DatabaseFields::Status, value, and Digikam::DatabaseItem::Visible.

Referenced by Digikam::FingerprintsTask::run(), and setVisible().

◆ latitudeNumber()

double Digikam::ItemInfo::latitudeNumber ( ) const

References imagePosition().

Referenced by Digikam::TableViewColumns::ColumnGeoProperties::data(), and Digikam::MapViewModelHelper::itemCoordinates().

◆ longitudeNumber()

double Digikam::ItemInfo::longitudeNumber ( ) const

Retrieves the coordinates and the altitude. Returns 0 if hasCoordinates(), or hasAltitude resp, is false.

References imagePosition().

Referenced by Digikam::TableViewColumns::ColumnGeoProperties::data(), and Digikam::MapViewModelHelper::itemCoordinates().

◆ manualOrder()

qlonglong Digikam::ItemInfo::manualOrder ( ) const

Returns the manual sort order

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesFields(), Digikam::DatabaseFields::ManualOrder, RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::ItemSortSettings::compare(), and Digikam::DigikamItemView::dragDropSort().

◆ markDerivedFrom()

void Digikam::ItemInfo::markDerivedFrom ( const ItemInfo &  ancestorImage)

Add a relation to the database: This image is derived from the ancestorImage.

References Digikam::CoreDB::addImageRelation(), Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::DerivedFrom, id(), and isNull().

◆ metadataTemplate()

Template Digikam::ItemInfo::metadataTemplate ( ) const

Retrieve metadata template information about the image.

References Digikam::ItemCopyright::fillTemplate(), imageCopyright(), imageExtendedProperties(), Digikam::ItemExtendedProperties::location(), Digikam::Template::setIptcSubjects(), Digikam::Template::setLocationInfo(), and Digikam::ItemExtendedProperties::subjectCode().

Referenced by Digikam::MetadataHub::load(), and Digikam::DisjointMetadata::load().

◆ modDateTime()

QDateTime Digikam::ItemInfo::modDateTime ( ) const
Returns
the modification datetime of the image

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesFields(), Digikam::DatabaseFields::ModificationDate, RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnFileProperties::compare(), Digikam::TableViewColumns::ColumnFileProperties::data(), Digikam::SimilarityDb::getDirtyOrMissingFingerprints(), Digikam::SimilarityDb::getDirtyOrMissingFingerprintURLs(), Digikam::SimilarityDb::hasDirtyOrMissingFingerprint(), Digikam::LessThanByProximityToSubject::operator()(), Digikam::ItemDelegate::paint(), Digikam::CollectionScannerHintContainerImplementation::recordHint(), and thumbnailInfo().

◆ name()

QString Digikam::ItemInfo::name ( ) const
Returns
the name of the image

Referenced by Digikam::ItemSortSettings::compare(), fromLocalFile(), fromLocationAlbumAndName(), historyImageId(), Digikam::DBInfoIface::itemInfo(), Digikam::ItemFilterSettings::matches(), Digikam::ItemInfoList::namefileLessThan(), Digikam::LessThanByProximityToSubject::operator()(), Digikam::ItemDelegate::paint(), thumbnailInfo(), Digikam::FileActionMngrFileWorker::transform(), and Digikam::FileActionMngrFileWorker::writeOrientationToFiles().

◆ numberOfGroupedImages()

int Digikam::ItemInfo::numberOfGroupedImages ( ) const

References Digikam::ItemInfoStatic::cache(), and Digikam::ItemInfoCache::getImageGroupedCount().

Referenced by Digikam::GroupIndicatorOverlay::checkIndex(), hasGroupedImages(), and Digikam::ItemDelegate::paint().

◆ operator!=()

bool Digikam::ItemInfo::operator!= ( const ItemInfo &  info) const

◆ operator<()

bool Digikam::ItemInfo::operator< ( const ItemInfo &  info) const

◆ operator=()

ItemInfo & Digikam::ItemInfo::operator= ( const ItemInfo &  info)

References Digikam::ItemInfoStatic::cache(), and Digikam::ItemInfoCache::dropInfo().

◆ operator==()

bool Digikam::ItemInfo::operator== ( const ItemInfo &  info) const

◆ orientation()

int Digikam::ItemInfo::orientation ( ) const

Returns the orientation of the image, (MetaEngine::ImageOrientation, EXIF standard)

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemInformation(), Digikam::DatabaseFields::Orientation, RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::FaceGroup::applyItemGeometryChanges(), Digikam::FaceGroup::Private::createItem(), Digikam::FocusPointGroup::Private::createItem(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::loadFaceTags(), Digikam::DatabaseLoadSaveFileInfoProvider::orientationHint(), Digikam::TableViewColumns::ColumnThumbnail::paint(), Digikam::FileActionMngrDatabaseWorker::setExifOrientation(), Digikam::FaceGroup::slotAddItemFinished(), Digikam::FocusPointGroup::slotAddItemFinished(), thumbnailInfo(), and Digikam::FileActionMngrFileWorker::transform().

◆ photoInfoContainer()

PhotoInfoContainer Digikam::ItemInfo::photoInfoContainer ( ) const

References Digikam::ImageMetadataContainer::aperture, Digikam::PhotoInfoContainer::aperture, dateTime(), Digikam::PhotoInfoContainer::dateTime, Digikam::ImageMetadataContainer::exposureMode, Digikam::PhotoInfoContainer::exposureMode, Digikam::ImageMetadataContainer::exposureProgram, Digikam::PhotoInfoContainer::exposureProgram, Digikam::ImageMetadataContainer::exposureTime, Digikam::PhotoInfoContainer::exposureTime, Digikam::PhotoInfoContainer::flash, Digikam::ImageMetadataContainer::flashMode, Digikam::ImageMetadataContainer::focalLength, Digikam::PhotoInfoContainer::focalLength, Digikam::ImageMetadataContainer::focalLength35, Digikam::PhotoInfoContainer::focalLength35mm, imageMetadataContainer(), Digikam::ImageMetadataContainer::lens, Digikam::PhotoInfoContainer::lens, Digikam::ImageMetadataContainer::make, Digikam::PhotoInfoContainer::make, Digikam::ImageMetadataContainer::model, Digikam::PhotoInfoContainer::model, Digikam::ImageMetadataContainer::sensitivity, Digikam::PhotoInfoContainer::sensitivity, Digikam::ImageMetadataContainer::whiteBalance, and Digikam::PhotoInfoContainer::whiteBalance.

Referenced by Digikam::DBInfoIface::itemInfo(), and Digikam::CameraNameOption::parseOperation().

◆ pickLabel()

int Digikam::ItemInfo::pickLabel ( ) const

Returns the Pick Label Id (see PickLabel values in globals.h)

References Digikam::TagsCache::instance(), Digikam::NoPickLabel, Digikam::TagsCache::pickLabelFromTags(), RETURN_IF_CACHED, and tagIds().

Referenced by Digikam::TableViewColumns::ColumnDigikamProperties::compare(), Digikam::CollectionScanner::copyFileProperties(), Digikam::TableViewColumns::ColumnDigikamProperties::data(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::load(), Digikam::DisjointMetadata::load(), Digikam::ItemDelegate::paint(), and Digikam::ItemIconView::slotAssignPickLabel().

◆ rating()

int Digikam::ItemInfo::rating ( ) const

Returns the rating

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemInformation(), Digikam::DatabaseFields::Rating, RETURN_IF_CACHED, and STORE_IN_CACHE_AND_RETURN.

Referenced by Digikam::ItemSortSettings::compare(), Digikam::TableViewColumns::ColumnDigikamProperties::compare(), Digikam::TableViewColumns::ColumnDigikamProperties::data(), Digikam::CommonKeys::getDbValue(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::load(), Digikam::DisjointMetadata::load(), Digikam::ItemFilterSettings::matches(), Digikam::ItemDelegate::paint(), Digikam::ItemIconView::slotAssignRating(), and Digikam::ItemRatingOverlay::updateRating().

◆ relationCloud()

QList< QPair< qlonglong, qlonglong > > Digikam::ItemInfo::relationCloud ( ) const

Returns the cloud of all directly or indirectly related images, derived images or ancestors, in from of "a derived from b" pairs.

References Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::DerivedFrom, and Digikam::CoreDB::getRelationCloud().

Referenced by Digikam::ItemHistoryGraph::fromInfo().

◆ removeAllTags()

void Digikam::ItemInfo::removeAllTags ( )

Remove all tags from the item (removes it from database)

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::removeItemAllTags(), and tagIds().

◆ removeFromGroup()

void Digikam::ItemInfo::removeFromGroup ( )

This image is grouped behind another image: Remove this image from its group

References Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::Grouped, isGrouped(), and Digikam::CoreDB::removeAllImageRelationsFrom().

Referenced by addToGroup(), and Digikam::FileActionMngrDatabaseWorker::editGroup().

◆ removeMetadataTemplate()

void Digikam::ItemInfo::removeMetadataTemplate ( )

Remove all template info about the image from database.

References imageCopyright(), imageExtendedProperties(), Digikam::ItemCopyright::removeAll(), Digikam::ItemExtendedProperties::removeLocation(), and Digikam::ItemExtendedProperties::removeSubjectCode().

Referenced by setMetadataTemplate(), and Digikam::DisjointMetadata::write().

◆ removeTag()

void Digikam::ItemInfo::removeTag ( int  tagID)

Remove a tag from the item (removes it from database)

Parameters
tagIDthe ID of the tag to remove

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::removeImageTagProperties(), and Digikam::CoreDB::removeItemTag().

Referenced by Digikam::FaceUtils::markAsScanned(), Digikam::AlbumManager::mergeTAlbum(), Digikam::FaceTagsEditor::removeNormalTag(), Digikam::FaceTagsEditor::removeNormalTags(), setColorLabel(), setPickLabel(), Digikam::ShowHideVersionsOverlay::slotClicked(), and Digikam::DisjointMetadata::write().

◆ setColorLabel()

void Digikam::ItemInfo::setColorLabel ( int  value)

Set the color Label Id for the item (see ColorLabel values from globals.h)

References Digikam::TagsCache::colorLabelTags(), Digikam::FirstColorLabel, Digikam::TagsCache::instance(), Digikam::LastColorLabel, removeTag(), setTag(), and tagIds().

Referenced by Digikam::CollectionScanner::copyFileProperties(), Digikam::DBInfoIface::setItemInfo(), and Digikam::DisjointMetadata::write().

◆ setDateTime()

void Digikam::ItemInfo::setDateTime ( const QDateTime &  dateTime)

Set the date and time (write it to database)

Parameters
dateTimethe new date and time.

References Digikam::CoreDB::changeItemInformation(), Digikam::DatabaseFields::CreationDate, dateTime(), and Digikam::CoreDbAccess::db().

Referenced by Digikam::DBInfoIface::slotDateTimeForUrl(), and Digikam::DisjointMetadata::write().

◆ setItemHistory()

void Digikam::ItemInfo::setItemHistory ( const DImageHistory &  history)

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::setItemHistory(), and Digikam::DImageHistory::toXml().

◆ setManualOrder()

void Digikam::ItemInfo::setManualOrder ( qlonglong  value)

Set the manual sorting order for the item

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::setItemManualOrder(), and value.

Referenced by Digikam::DigikamItemView::dragDropSort().

◆ setMetadataTemplate()

void Digikam::ItemInfo::setMetadataTemplate ( const Template &  t)

Set metadata template information (write it to database)

Parameters
tthe new template data.

References imageCopyright(), imageExtendedProperties(), Digikam::Template::IptcSubjects(), Digikam::Template::locationInfo(), removeMetadataTemplate(), Digikam::ItemCopyright::setFromTemplate(), Digikam::ItemExtendedProperties::setLocation(), and Digikam::ItemExtendedProperties::setSubjectCode().

Referenced by Digikam::DisjointMetadata::write().

◆ setModDateTime()

void Digikam::ItemInfo::setModDateTime ( const QDateTime &  dateTime)

Set the modification date and time (write it to database)

Parameters
dateTimethe new modification date and time.

References dateTime(), Digikam::CoreDbAccess::db(), and Digikam::CoreDB::setItemModificationDate().

Referenced by Digikam::DBInfoIface::slotDateTimeForUrl().

◆ setName()

void Digikam::ItemInfo::setName ( const QString &  newName)

Set the name (write it to database)

Parameters
newNamethe new name.

References Digikam::ItemInfoStatic::cache(), Digikam::ItemInfoCache::cacheByName(), Digikam::CoreDbAccess::db(), and Digikam::CoreDB::renameItem().

◆ setOrientation()

void Digikam::ItemInfo::setOrientation ( int  value)

Set the orientation for the item

References Digikam::CoreDB::changeItemInformation(), Digikam::CoreDbAccess::db(), Digikam::DatabaseFields::Orientation, and value.

Referenced by Digikam::FileActionMngrDatabaseWorker::setExifOrientation(), Digikam::DBInfoIface::setItemInfo(), and Digikam::FileActionMngrFileWorker::transform().

◆ setPickLabel()

void Digikam::ItemInfo::setPickLabel ( int  value)

Set the pick Label Id for the item (see PickLabel values from globals.h)

References Digikam::FirstPickLabel, Digikam::TagsCache::instance(), Digikam::LastPickLabel, Digikam::TagsCache::pickLabelTags(), removeTag(), setTag(), and tagIds().

Referenced by Digikam::CollectionScanner::copyFileProperties(), Digikam::ImageQualityTask::run(), Digikam::DBInfoIface::setItemInfo(), and Digikam::DisjointMetadata::write().

◆ setRating()

void Digikam::ItemInfo::setRating ( int  value)

Set the rating for the item

References Digikam::CoreDB::changeItemInformation(), Digikam::CoreDbAccess::db(), Digikam::DatabaseFields::Rating, and value.

Referenced by Digikam::DBInfoIface::setItemInfo(), and Digikam::DisjointMetadata::write().

◆ setTag()

void Digikam::ItemInfo::setTag ( int  tagID)

Adds a tag to the item (writes it to database)

Parameters
tagIDthe ID of the tag to add

References Digikam::CoreDB::addItemTag(), Digikam::CoreDbAccess::db(), and tagIds().

Referenced by Digikam::FaceTagsEditor::addNormalTag(), Digikam::ItemScanner::commitFaces(), Digikam::CollectionScanner::copyFileProperties(), Digikam::FaceUtils::markAsScanned(), Digikam::AlbumManager::mergeTAlbum(), setColorLabel(), setPickLabel(), Digikam::ShowHideVersionsOverlay::slotClicked(), and Digikam::DisjointMetadata::write().

◆ setUuid()

void Digikam::ItemInfo::setUuid ( const QString &  uuid)

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::setImageUuid(), and uuid().

◆ setVisible()

void Digikam::ItemInfo::setVisible ( bool  isVisible)

Set the visibility flag - triggers between Visible and Hidden

References Digikam::CoreDbAccess::db(), Digikam::DatabaseItem::Hidden, isVisible(), Digikam::CoreDB::setItemStatus(), and Digikam::DatabaseItem::Visible.

◆ similarityTo()

double Digikam::ItemInfo::similarityTo ( const qlonglong  imageId) const

References imageExtendedProperties(), and Digikam::ItemExtendedProperties::similarityTo().

Referenced by Digikam::FindDuplicatesAlbumItem::calculateInfos().

◆ tagIds()

QList< int > Digikam::ItemInfo::tagIds ( ) const
Returns
a list of IDs of tags assigned to this item
See also
tagNames
tagPaths
Album::id()

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemTagIDs(), and RETURN_IF_CACHED.

Referenced by addTagPaths(), colorLabel(), Digikam::CollectionScanner::copyFileProperties(), Digikam::TableViewColumns::ColumnDigikamProperties::data(), Digikam::TagDragDropHandler::dropEvent(), Digikam::CommonKeys::getDbValue(), Digikam::FaceUtils::hasBeenScanned(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::VersionItemFilterSettings::isExemptedBySettings(), Digikam::VersionItemFilterSettings::isHiddenBySettings(), Digikam::DBInfoIface::itemInfo(), Digikam::MetadataHub::load(), Digikam::DisjointMetadata::load(), Digikam::VersionItemFilterSettings::matches(), Digikam::ItemFilterSettings::matches(), Digikam::ItemDelegate::paint(), pickLabel(), removeAllTags(), setColorLabel(), Digikam::DBInfoIface::setItemInfo(), setPickLabel(), setTag(), and Digikam::ItemIconView::toggleTag().

◆ thumbnailIdentifier() [1/2]

ThumbnailIdentifier Digikam::ItemInfo::thumbnailIdentifier ( ) const

Fills a ThumbnailIdentifier / ThumbnailInfo from this ItemInfo

References filePath(), and id().

Referenced by Digikam::ItemThumbnailModel::data(), Digikam::FaceItemRetriever::getThumbnails(), Digikam::TableViewColumns::ColumnThumbnail::paint(), Digikam::TableViewTreeView::pixmapForDrag(), Digikam::MapViewModelHelper::pixmapFromRepresentativeIndex(), Digikam::GPSMarkerTiler::pixmapFromRepresentativeIndex(), Digikam::ItemThumbnailModel::preloadThumbnails(), Digikam::ItemThumbnailModel::prepareThumbnails(), and thumbnailIdentifier().

◆ thumbnailIdentifier() [2/2]

ThumbnailIdentifier Digikam::ItemInfo::thumbnailIdentifier ( qlonglong  id)
static

References thumbnailIdentifier().

◆ thumbnailInfo()

ThumbnailInfo Digikam::ItemInfo::thumbnailInfo ( ) const

References category(), Digikam::ThumbnailInfo::fileName, filePath(), Digikam::ThumbnailIdentifier::filePath, fileSize(), Digikam::ThumbnailInfo::fileSize, Digikam::ThumbnailIdentifier::id, Digikam::DatabaseItem::Image, Digikam::CollectionManager::instance(), Digikam::ThumbnailInfo::isAccessible, Digikam::CollectionLocation::isAvailable(), Digikam::CollectionManager::locationForAlbumRootId(), Digikam::ThumbnailInfo::mimeType, modDateTime(), Digikam::ThumbnailInfo::modificationDate, name(), orientation(), Digikam::ThumbnailInfo::orientationHint, uniqueHash(), Digikam::ThumbnailInfo::uniqueHash, and Digikam::DatabaseItem::Video.

Referenced by Digikam::ThumbsDbInfoProvider::thumbnailInfo().

◆ title()

QString Digikam::ItemInfo::title ( ) const
Returns
the default title for this item

References Digikam::ItemComments::defaultComment(), RETURN_IF_CACHED, and Digikam::DatabaseComment::Title.

Referenced by Digikam::TableViewColumns::ColumnDigikamProperties::data(), Digikam::CommonKeys::getDbValue(), Digikam::ToolTipFiller::imageInfoTipContents(), Digikam::DBInfoIface::itemInfo(), Digikam::ItemFilterSettings::matches(), and Digikam::ItemDelegate::paint().

◆ unconfirmedFaceCount()

int Digikam::ItemInfo::unconfirmedFaceCount ( ) const
Returns
the number of Unconfirmed Faces in this item.

References RETURN_IF_CACHED, and Digikam::FaceTagsEditor::unconfirmedNameFaceTagsIfaces().

Referenced by Digikam::ItemSortSettings::compare().

◆ uniqueHash()

QString Digikam::ItemInfo::uniqueHash ( ) const
Returns
the unique hash signature as string of the image.

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImagesFields(), RETURN_IF_CACHED, STORE_IN_CACHE_AND_RETURN, and Digikam::DatabaseFields::UniqueHash.

Referenced by fromUniqueHash(), Digikam::SimilarityDb::getDirtyOrMissingFingerprints(), Digikam::SimilarityDb::getDirtyOrMissingFingerprintURLs(), Digikam::SimilarityDb::hasDirtyOrMissingFingerprint(), Digikam::DatabaseTask::run(), and thumbnailInfo().

◆ uuid()

QString Digikam::ItemInfo::uuid ( ) const

Retrieves and sets this' images UUID

References Digikam::CoreDbAccess::db(), and Digikam::CoreDB::getImageUuid().

Referenced by Digikam::ItemHistoryGraphData::addVertex(), historyImageId(), and setUuid().

◆ videoInfoContainer()

VideoInfoContainer Digikam::ItemInfo::videoInfoContainer ( ) const

References Digikam::VideoMetadataContainer::aspectRatio, Digikam::VideoInfoContainer::aspectRatio, Digikam::VideoMetadataContainer::audioBitRate, Digikam::VideoInfoContainer::audioBitRate, Digikam::VideoMetadataContainer::audioChannelType, Digikam::VideoInfoContainer::audioChannelType, Digikam::VideoMetadataContainer::audioCodec, Digikam::VideoInfoContainer::audioCodec, Digikam::VideoMetadataContainer::duration, Digikam::VideoInfoContainer::duration, Digikam::VideoMetadataContainer::frameRate, Digikam::VideoInfoContainer::frameRate, Digikam::VideoMetadataContainer::videoCodec, Digikam::VideoInfoContainer::videoCodec, and videoMetadataContainer().

Referenced by Digikam::DBInfoIface::itemInfo().

◆ videoMetadataContainer()

VideoMetadataContainer Digikam::ItemInfo::videoMetadataContainer ( ) const

References Digikam::VideoMetadataContainer::allFieldsNull, Digikam::DatabaseFields::AspectRatio, Digikam::VideoMetadataContainer::aspectRatio, Digikam::DatabaseFields::AudioBitRate, Digikam::VideoMetadataContainer::audioBitRate, Digikam::DatabaseFields::AudioChannelType, Digikam::VideoMetadataContainer::audioChannelType, Digikam::DatabaseFields::AudioCodec, Digikam::VideoMetadataContainer::audioCodec, Digikam::DatabaseVideoMetadataFieldsToMetadataInfoField(), Digikam::DatabaseFields::Duration, Digikam::VideoMetadataContainer::duration, Digikam::DatabaseFields::FrameRate, Digikam::VideoMetadataContainer::frameRate, getDatabaseFieldsRaw(), Digikam::DMetadata::valueToString(), Digikam::DatabaseFields::VideoCodec, Digikam::VideoMetadataContainer::videoCodec, and Digikam::DatabaseFields::VideoMetadataAll.

Referenced by Digikam::MetadataKeys::getDbValue(), Digikam::ToolTipFiller::imageInfoTipContents(), and videoInfoContainer().

Friends And Related Function Documentation

◆ ItemInfoCache

friend class ItemInfoCache
friend

◆ ItemInfoList

friend class ItemInfoList
friend

Referenced by ancestorImages(), derivedImages(), and groupedImages().

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