Digikam::CommonKeys Class Reference

Inheritance diagram for Digikam::CommonKeys:

Public Member Functions
QString	collectionName () const
	CommonKeys ()
QString	getValue (const QString &key, ParseSettings &settings)
DbKeyIdsMap	ids () const
	~CommonKeys () override

Protected Member Functions
void	addId (const QString &id, const QString &description)
QString	getDbValue (const QString &key, ParseSettings &settings) override

Constructor & Destructor Documentation

CommonKeys()

Digikam::CommonKeys::CommonKeys ( )

explicit

References Digikam::DbKeysCollection::addId().

~CommonKeys()

Digikam::CommonKeys::~CommonKeys ( )

inlineoverride

Member Function Documentation

addId()

void Digikam::DbKeysCollection::addId ( const QString &  id, const QString &  description  )

protectedinherited

Add an ID to the key collection.

Parameters

id	the id of the database key
description	a short description of the database key

Referenced by CommonKeys(), Digikam::MetadataKeys::MetadataKeys(), and Digikam::PositionKeys::PositionKeys().

collectionName()

QString Digikam::DbKeysCollection::collectionName ( ) const

inherited

Get the name of the DbKeysCollection

Returns

the name of the collection

getDbValue()

QString Digikam::CommonKeys::getDbValue ( const QString &  key, ParseSettings &  settings  )

overrideprotectedvirtual

Abstract method for retrieving the value from the database for the given key.

This method has to be implemented by all child classes. It is called by the getValue() method.

Parameters

key	the key representing the value in the database
settings	the ParseSettings object holding all relevant information about the image.

Returns

the value of the given database key

See also

DbKeysCollection::getValue()

Implements Digikam::DbKeysCollection.

References Digikam::DatabaseItem::Audio, Digikam::ItemCopyright::author(), Digikam::ItemInfo::category(), Digikam::ImageCommonContainer::colorDepth, Digikam::ImageCommonContainer::colorModel, Digikam::ItemInfo::comment(), Digikam::ItemInfo::dimensions(), Digikam::ItemInfo::fileSize(), Digikam::ParseSettings::fileUrl, Digikam::ItemInfo::format(), Digikam::ItemInfo::fromUrl(), Digikam::ImageCommonContainer::height, Digikam::DatabaseItem::Image, Digikam::ItemInfo::imageCommonContainer(), Digikam::ItemInfo::imageCopyright(), Digikam::AlbumManager::instance(), Digikam::ImageCommonContainer::orientation, Digikam::DatabaseItem::Other, Digikam::ItemInfo::rating(), Digikam::ItemInfo::tagIds(), Digikam::AlbumManager::tagNames(), Digikam::AlbumManager::tagPaths(), Digikam::ItemInfo::title(), Digikam::DatabaseItem::UndefinedCategory, Digikam::DatabaseItem::Video, and Digikam::ImageCommonContainer::width.

getValue()

QString Digikam::DbKeysCollection::getValue ( const QString &  key, ParseSettings &  settings  )

inherited

Get a value from the database.

Parameters

key	the key representing the value in the database
settings	the ParseSettings object holding all relevant information about the image.

Returns

the value of the given database key

References Digikam::DbKeysCollection::getDbValue().

ids()

DbKeyIdsMap Digikam::DbKeysCollection::ids ( ) const

inherited

Get all IDs associated with this key collection.

Returns

a map of all associated ids and their description

---

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

• core/utilities/advancedrename/parser/options/database/keys/commonkeys.h
• core/utilities/advancedrename/parser/options/database/keys/commonkeys.cpp