digiKam
Loading...
Searching...
No Matches
Digikam::DItemInfo Class Reference

#include <dinfointerface.h>

Public Member Functions

int albumId () const
 
double altitude () const
 
QString aperture () const
 
CaptionsMap captions () const
 
int colorLabel () const
 
QString comment () const
 
MetaEngine::AltLangMap copyrightNotices () const
 
MetaEngine::AltLangMap copyrights () const
 
QStringList creators () const
 
QString credit () const
 
QDateTime dateTime () const
 
QSize dimensions () const
 
 DItemInfo ()=default
 
 DItemInfo (const DInfoInterface::DInfoMap &)
 
QString exposureTime () const
 
qlonglong fileSize () const
 
QString focalLength () const
 
QString focalLength35mm () const
 
bool hasGeolocationInfo () const
 
DInfoInterface::DInfoMap infoMap () const
 
QStringList keywords () const
 
double latitude () const
 
QString lens () const
 
double longitude () const
 
QString make () const
 
QString model () const
 
QString name () const
 
int orientation () const
 
int pickLabel () const
 
int rating () const
 
QString rights () const
 
QString sensitivity () const
 
void setCaptions (const CaptionsMap &)
 
void setColorLabel (int)
 
void setCopyrightNotices (const MetaEngine::AltLangMap &map)
 
void setCopyrights (const MetaEngine::AltLangMap &map)
 
void setOrientation (int)
 
void setPickLabel (int)
 
void setRating (int)
 
void setTitles (const CaptionsMap &)
 
QString source () const
 
QStringList tagsPath () const
 
QString title () const
 
CaptionsMap titles () const
 
QString videoCodec () const
 
 ~DItemInfo ()=default
 

Detailed Description

DItemInfo is a class to get item information from host application (Showfoto or digiKam) The interface is re-implemented in host and depend how item information must be retrieved (from a database or by file metadata). The easy way to use this container is given below:

// READ INFO FROM HOST ------------------------------------------—

QUrl itemUrl; // The item url that you want to retrieve information. DInfoInterface* hostIface; // The host application interface instance.

DInfoInterface::DInfoMap info = hostIface->itemInfo(itemUrl); // First stage is to get the information map from host application. DItemInfo item(info); // Second stage, is to create the DIntenInfo instance for this item by url. QString title = item.name(); // Now you can retrieve the title, QString description = item.comment(); // The comment, QDateTime time = item.dateTime(); // The time stamp, etc.

// WRITE INFO TO HOST -------------------------------------------—

QUrl itemUrl; // The item url that you want to retrieve information. DInfoInterface* hostIface; // The host application interface instance.

DItemInfo item; // Create the DIntenInfo instance for this item with an empty internal info map. item.setRating(3); // Store rating to internal info map. item.setColorLabel(1); // Store color label to internal info map. hostIface->setItemInfo(url, item.infoMap()); // Update item information to host using internal info map.

Constructor & Destructor Documentation

◆ DItemInfo() [1/2]

Digikam::DItemInfo::DItemInfo ( )
default

◆ DItemInfo() [2/2]

Digikam::DItemInfo::DItemInfo ( const DInfoInterface::DInfoMap info)
explicit

◆ ~DItemInfo()

Digikam::DItemInfo::~DItemInfo ( )
default

Member Function Documentation

◆ albumId()

int Digikam::DItemInfo::albumId ( ) const

◆ altitude()

double Digikam::DItemInfo::altitude ( ) const

◆ aperture()

QString Digikam::DItemInfo::aperture ( ) const

◆ captions()

CaptionsMap Digikam::DItemInfo::captions ( ) const

◆ colorLabel()

int Digikam::DItemInfo::colorLabel ( ) const

References Digikam::NoColorLabel.

◆ comment()

QString Digikam::DItemInfo::comment ( ) const

◆ copyrightNotices()

MetaEngine::AltLangMap Digikam::DItemInfo::copyrightNotices ( ) const

◆ copyrights()

MetaEngine::AltLangMap Digikam::DItemInfo::copyrights ( ) const

◆ creators()

QStringList Digikam::DItemInfo::creators ( ) const

◆ credit()

QString Digikam::DItemInfo::credit ( ) const

◆ dateTime()

QDateTime Digikam::DItemInfo::dateTime ( ) const

◆ dimensions()

QSize Digikam::DItemInfo::dimensions ( ) const

◆ exposureTime()

QString Digikam::DItemInfo::exposureTime ( ) const

◆ fileSize()

qlonglong Digikam::DItemInfo::fileSize ( ) const

◆ focalLength()

QString Digikam::DItemInfo::focalLength ( ) const

◆ focalLength35mm()

QString Digikam::DItemInfo::focalLength35mm ( ) const

◆ hasGeolocationInfo()

bool Digikam::DItemInfo::hasGeolocationInfo ( ) const

References latitude(), and longitude().

◆ infoMap()

DInfoInterface::DInfoMap Digikam::DItemInfo::infoMap ( ) const

◆ keywords()

QStringList Digikam::DItemInfo::keywords ( ) const

◆ latitude()

double Digikam::DItemInfo::latitude ( ) const

Referenced by hasGeolocationInfo().

◆ lens()

QString Digikam::DItemInfo::lens ( ) const

◆ longitude()

double Digikam::DItemInfo::longitude ( ) const

Referenced by hasGeolocationInfo().

◆ make()

QString Digikam::DItemInfo::make ( ) const

◆ model()

QString Digikam::DItemInfo::model ( ) const

◆ name()

QString Digikam::DItemInfo::name ( ) const

◆ orientation()

int Digikam::DItemInfo::orientation ( ) const

◆ pickLabel()

int Digikam::DItemInfo::pickLabel ( ) const

References Digikam::NoPickLabel.

◆ rating()

int Digikam::DItemInfo::rating ( ) const

◆ rights()

QString Digikam::DItemInfo::rights ( ) const

◆ sensitivity()

QString Digikam::DItemInfo::sensitivity ( ) const

◆ setCaptions()

void Digikam::DItemInfo::setCaptions ( const CaptionsMap map)

◆ setColorLabel()

void Digikam::DItemInfo::setColorLabel ( int  color)

◆ setCopyrightNotices()

void Digikam::DItemInfo::setCopyrightNotices ( const MetaEngine::AltLangMap map)

◆ setCopyrights()

void Digikam::DItemInfo::setCopyrights ( const MetaEngine::AltLangMap map)

◆ setOrientation()

void Digikam::DItemInfo::setOrientation ( int  val)

◆ setPickLabel()

void Digikam::DItemInfo::setPickLabel ( int  pick)

◆ setRating()

void Digikam::DItemInfo::setRating ( int  rating)

References rating().

◆ setTitles()

void Digikam::DItemInfo::setTitles ( const CaptionsMap map)

◆ source()

QString Digikam::DItemInfo::source ( ) const

◆ tagsPath()

QStringList Digikam::DItemInfo::tagsPath ( ) const

◆ title()

QString Digikam::DItemInfo::title ( ) const

◆ titles()

CaptionsMap Digikam::DItemInfo::titles ( ) const

◆ videoCodec()

QString Digikam::DItemInfo::videoCodec ( ) const

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