digiKam
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Digikam::ItemExtendedProperties Class Reference

Public Member Functions

QString intellectualGenre ()
 
 ItemExtendedProperties ()
 
 ItemExtendedProperties (qlonglong imageid)
 
QString jobId ()
 
IptcCoreLocationInfo location ()
 
void removeIntellectualGenre ()
 
void removeJobId ()
 
void removeLocation ()
 
void removeScene ()
 
void removeSimilarityTo (const qlonglong imageId)
 
void removeSubjectCode ()
 
QStringList scene ()
 
void setIntellectualGenre (const QString &intellectualGenre)
 
void setJobId (const QString &jobId)
 
void setLocation (const IptcCoreLocationInfo &location)
 
void setScene (const QStringList &scene)
 
void setSimilarityTo (const qlonglong imageId, const double value)
 
void setSubjectCode (const QStringList &subjectCode)
 
double similarityTo (const qlonglong imageId)
 
QStringList subjectCode ()
 

Protected Member Functions

QStringList readFakeListProperty (const QString &property)
 
QString readProperty (const QString &property)
 
void removeProperty (const QString &property)
 
void setFakeListProperty (const QString &property, const QStringList &value)
 
void setProperty (const QString &property, const QString &value)
 

Protected Attributes

qlonglong m_id
 

Constructor & Destructor Documentation

◆ ItemExtendedProperties() [1/2]

Digikam::ItemExtendedProperties::ItemExtendedProperties ( qlonglong  imageid)
explicit

◆ ItemExtendedProperties() [2/2]

Digikam::ItemExtendedProperties::ItemExtendedProperties ( )

Create a null ItemExtendedProperties object

Member Function Documentation

◆ intellectualGenre()

QString Digikam::ItemExtendedProperties::intellectualGenre ( )

Return the Intellectual Genre. This is Photoshop Object Attribute Reference. “ Describes the nature, intellectual or journalistic characteristic of a news object, not specifically its content. Note / Examples: Journalistic genres: actuality, interview, background, feature, summary, wrapup News category related genres: daybook, obituary, press release, transcript It is advised to use terms from a controlled vocabulary.”

References Digikam::MetadataInfo::IptcCoreIntellectualGenre, Digikam::ItemScanner::iptcCorePropertyName(), and readProperty().

Referenced by setIntellectualGenre().

◆ jobId()

QString Digikam::ItemExtendedProperties::jobId ( )

Returns the Job ID. This is Photoshop Transmission Reference. This is IPTC Original Transmission Reference “ Number or identifier for the purpose of improved workflow handling. This ID should be added by the creator or provider for transmission and routing purposes only and should have no significance for archiving.”

References Digikam::MetadataInfo::IptcCoreJobID, Digikam::ItemScanner::iptcCorePropertyName(), and readProperty().

Referenced by setJobId().

◆ location()

IptcCoreLocationInfo Digikam::ItemExtendedProperties::location ( )

Return the IPTC Core Location. This includes Country, Country Code, City, Location and ProvinceState. This includes IPTC Country Name, Country Code, City, SubLocation and ProvinceState.

References Digikam::IptcCoreLocationInfo::city, Digikam::IptcCoreLocationInfo::country, Digikam::IptcCoreLocationInfo::countryCode, Digikam::MetadataInfo::IptcCoreCity, Digikam::MetadataInfo::IptcCoreCountry, Digikam::MetadataInfo::IptcCoreCountryCode, Digikam::MetadataInfo::IptcCoreLocation, Digikam::ItemScanner::iptcCorePropertyName(), Digikam::MetadataInfo::IptcCoreProvinceState, Digikam::IptcCoreLocationInfo::location, Digikam::IptcCoreLocationInfo::provinceState, and readProperty().

Referenced by Digikam::ItemInfo::metadataTemplate(), and setLocation().

◆ readFakeListProperty()

QStringList Digikam::ItemExtendedProperties::readFakeListProperty ( const QString &  property)
protected

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImageProperty(), m_id, QT_SKIP_EMPTY_PARTS, and value.

Referenced by scene(), and subjectCode().

◆ readProperty()

QString Digikam::ItemExtendedProperties::readProperty ( const QString &  property)
protected

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImageProperty(), and m_id.

Referenced by intellectualGenre(), jobId(), and location().

◆ removeIntellectualGenre()

void Digikam::ItemExtendedProperties::removeIntellectualGenre ( )

References setIntellectualGenre().

◆ removeJobId()

void Digikam::ItemExtendedProperties::removeJobId ( )

References setJobId().

◆ removeLocation()

void Digikam::ItemExtendedProperties::removeLocation ( )

References Digikam::MetadataInfo::IptcCoreLocationInfo, and setLocation().

Referenced by Digikam::ItemInfo::removeMetadataTemplate().

◆ removeProperty()

void Digikam::ItemExtendedProperties::removeProperty ( const QString &  property)
protected

References Digikam::CoreDbAccess::db(), m_id, and Digikam::CoreDB::removeImageProperty().

Referenced by setFakeListProperty(), and setProperty().

◆ removeScene()

void Digikam::ItemExtendedProperties::removeScene ( )

References setScene().

◆ removeSimilarityTo()

void Digikam::ItemExtendedProperties::removeSimilarityTo ( const qlonglong  imageId)

References Digikam::SimilarityDbAccess::db(), m_id, and Digikam::SimilarityDb::removeImageSimilarity().

◆ removeSubjectCode()

void Digikam::ItemExtendedProperties::removeSubjectCode ( )

References setSubjectCode().

Referenced by Digikam::ItemInfo::removeMetadataTemplate().

◆ scene()

QStringList Digikam::ItemExtendedProperties::scene ( )

Returns the Scene. “ Describes the scene of a photo content. Specifies one ore more terms from the IPTC ‘Scene-NewsCodes’. Each Scene is represented as a string of 6 digits in an unordered list.”

References Digikam::ItemScanner::iptcCorePropertyName(), Digikam::MetadataInfo::IptcCoreScene, and readFakeListProperty().

Referenced by setScene().

◆ setFakeListProperty()

void Digikam::ItemExtendedProperties::setFakeListProperty ( const QString &  property,
const QStringList &  value 
)
protected

References Digikam::CoreDbAccess::db(), m_id, removeProperty(), Digikam::CoreDB::setImageProperty(), and value.

Referenced by setScene(), and setSubjectCode().

◆ setIntellectualGenre()

void Digikam::ItemExtendedProperties::setIntellectualGenre ( const QString &  intellectualGenre)

References intellectualGenre(), Digikam::MetadataInfo::IptcCoreIntellectualGenre, Digikam::ItemScanner::iptcCorePropertyName(), and setProperty().

Referenced by Digikam::ItemScanner::commitIPTCCore(), and removeIntellectualGenre().

◆ setJobId()

void Digikam::ItemExtendedProperties::setJobId ( const QString &  jobId)

References Digikam::MetadataInfo::IptcCoreJobID, Digikam::ItemScanner::iptcCorePropertyName(), jobId(), and setProperty().

Referenced by Digikam::ItemScanner::commitIPTCCore(), and removeJobId().

◆ setLocation()

void Digikam::ItemExtendedProperties::setLocation ( const IptcCoreLocationInfo &  location)

References Digikam::IptcCoreLocationInfo::city, Digikam::IptcCoreLocationInfo::country, Digikam::IptcCoreLocationInfo::countryCode, Digikam::MetadataInfo::IptcCoreCity, Digikam::MetadataInfo::IptcCoreCountry, Digikam::MetadataInfo::IptcCoreCountryCode, Digikam::MetadataInfo::IptcCoreLocation, Digikam::ItemScanner::iptcCorePropertyName(), Digikam::MetadataInfo::IptcCoreProvinceState, location(), Digikam::IptcCoreLocationInfo::location, Digikam::IptcCoreLocationInfo::provinceState, and setProperty().

Referenced by Digikam::ItemScanner::commitIPTCCore(), removeLocation(), and Digikam::ItemInfo::setMetadataTemplate().

◆ setProperty()

void Digikam::ItemExtendedProperties::setProperty ( const QString &  property,
const QString &  value 
)
protected

References Digikam::CoreDbAccess::db(), m_id, removeProperty(), Digikam::CoreDB::setImageProperty(), and value.

Referenced by setIntellectualGenre(), setJobId(), and setLocation().

◆ setScene()

void Digikam::ItemExtendedProperties::setScene ( const QStringList &  scene)

References Digikam::ItemScanner::iptcCorePropertyName(), Digikam::MetadataInfo::IptcCoreScene, scene(), and setFakeListProperty().

Referenced by Digikam::ItemScanner::commitIPTCCore(), and removeScene().

◆ setSimilarityTo()

void Digikam::ItemExtendedProperties::setSimilarityTo ( const qlonglong  imageId,
const double  value 
)

References Digikam::SimilarityDbAccess::db(), m_id, Digikam::SimilarityDb::setImageSimilarity(), and value.

◆ setSubjectCode()

void Digikam::ItemExtendedProperties::setSubjectCode ( const QStringList &  subjectCode)

References Digikam::ItemScanner::iptcCorePropertyName(), Digikam::MetadataInfo::IptcCoreSubjectCode, setFakeListProperty(), and subjectCode().

Referenced by Digikam::ItemScanner::commitIPTCCore(), removeSubjectCode(), and Digikam::ItemInfo::setMetadataTemplate().

◆ similarityTo()

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

Returns the similarity. of the image to the given image.

References Digikam::SimilarityDbAccess::db(), Digikam::SimilarityDb::getImageSimilarity(), and m_id.

Referenced by Digikam::ItemInfo::similarityTo().

◆ subjectCode()

QStringList Digikam::ItemExtendedProperties::subjectCode ( )

Returns the Subject Code. This is IPTC Subject Reference. “ Specifies one or more Subjects from the IPTC ‘Subject-NewsCodes’ taxonomy to categorize the content. Each Subject is represented as a string of 8 digits in an unordered list. Note: Only Subjects from a controlled vocabulary should be used in this metadata element, free text has to be put into the Keyword element. More about IPTC Subject-NewsCodes at www.newscodes.org.”

References Digikam::ItemScanner::iptcCorePropertyName(), Digikam::MetadataInfo::IptcCoreSubjectCode, and readFakeListProperty().

Referenced by Digikam::ItemInfo::metadataTemplate(), and setSubjectCode().

Member Data Documentation

◆ m_id

qlonglong Digikam::ItemExtendedProperties::m_id
protected

Referenced by readFakeListProperty(), readProperty(), removeProperty(), removeSimilarityTo(), setFakeListProperty(), setProperty(), setSimilarityTo(), and similarityTo().

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