Digikam::DItemInfo Class Reference

Public Member Functions
int	albumId () const
double	altitude () const
QString	aperture () const
int	colorLabel () const
QString	comment () const
QStringList	creators () const
QString	credit () const
QDateTime	dateTime () const
QSize	dimensions () const
	DItemInfo (const DInfoInterface::DInfoMap &)
QString	exposureTime () const
qlonglong	fileSize () const
QString	focalLength () const
QString	focalLength35mm () const
bool	hasGeolocationInfo () 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	setColorLabel (int)
void	setOrientation (int)
void	setPickLabel (int)
void	setRating (int)
QString	source () const
QStringList	tagsPath () const
QString	title () const
QString	videoCodec () const
	~DItemInfo ()

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.

DInfoInterface::DInfoMap info; // First stage is to create an empty information storage map for this item. DItemInfo item(info); // Second stage, is to create the DIntenInfo instance for this item. item.setRating(3); // Store rating to info map. item.setColorLabel(1); // Store color label to info map. hostIface->setItemInfo(url, info); // Update item information to host using map.

Constructor & Destructor Documentation

DItemInfo()

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

explicit

~DItemInfo()

Digikam::DItemInfo::~DItemInfo

(

)

Member Function Documentation

albumId()

int Digikam::DItemInfo::albumId

(

)

const

Referenced by DigikamGenericFileCopyPlugin::FCTask::run().

altitude()

double Digikam::DItemInfo::altitude

(

)

const

Referenced by DigikamGenericGeolocationEditPlugin::KmlExport::generate(), and DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb().

aperture()

QString Digikam::DItemInfo::aperture

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

colorLabel()

int Digikam::DItemInfo::colorLabel

(

)

const

References Digikam::NoColorLabel.

Referenced by DigikamGenericSlideShowPlugin::SlideOSD::setCurrentUrl().

comment()

QString Digikam::DItemInfo::comment

(

)

const

Referenced by DigikamGenericPiwigoPlugin::PiwigoTalker::addPhoto(), DigikamGenericPrintCreatorPlugin::AdvPrintCaptionPage::captionFormatter(), DigikamGenericHtmlGalleryPlugin::GalleryElement::GalleryElement(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), DigikamGenericUnifiedPlugin::WSAuthentication::getImageCaption(), DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD(), and Digikam::DItemsListViewItem::updateInformation().

creators()

QStringList Digikam::DItemInfo::creators

(

)

const

Referenced by DigikamGenericPiwigoPlugin::PiwigoTalker::addPhoto().

credit()

QString Digikam::DItemInfo::credit

(

)

const

dateTime()

QDateTime Digikam::DItemInfo::dateTime

(

)

const

Referenced by DigikamGenericPiwigoPlugin::PiwigoTalker::addPhoto(), DigikamGenericINatPlugin::INatTalker::computerVision(), DigikamGenericHtmlGalleryPlugin::GalleryElement::GalleryElement(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo(), and DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

dimensions()

QSize Digikam::DItemInfo::dimensions

(

)

const

Referenced by DigikamGenericPrintCreatorPlugin::AdvPrintCaptionPage::captionFormatter().

exposureTime()

QString Digikam::DItemInfo::exposureTime

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

fileSize()

qlonglong Digikam::DItemInfo::fileSize

(

)

const

focalLength()

QString Digikam::DItemInfo::focalLength

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

focalLength35mm()

QString Digikam::DItemInfo::focalLength35mm

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

hasGeolocationInfo()

bool Digikam::DItemInfo::hasGeolocationInfo

(

)

const

References latitude(), and longitude().

Referenced by DigikamGenericINatPlugin::INatTalker::computerVision(), DigikamGenericGeolocationEditPlugin::KmlExport::generate(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), and DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo().

keywords()

QStringList Digikam::DItemInfo::keywords

(

)

const

Referenced by DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo(), DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD(), and Digikam::DItemsListViewItem::updateInformation().

latitude()

double Digikam::DItemInfo::latitude

(

)

const

Referenced by DigikamGenericINatPlugin::INatTalker::computerVision(), DigikamGenericGeolocationEditPlugin::KmlExport::generate(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), hasGeolocationInfo(), and DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo().

lens()

QString Digikam::DItemInfo::lens

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

longitude()

double Digikam::DItemInfo::longitude

(

)

const

Referenced by DigikamGenericINatPlugin::INatTalker::computerVision(), DigikamGenericGeolocationEditPlugin::KmlExport::generate(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), hasGeolocationInfo(), and DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo().

make()

QString Digikam::DItemInfo::make

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

model()

QString Digikam::DItemInfo::model

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

name()

QString Digikam::DItemInfo::name

(

)

const

Referenced by DigikamGenericHtmlGalleryPlugin::GalleryElement::GalleryElement(), DigikamGenericGeolocationEditPlugin::KmlExport::generate(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), and DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo().

orientation()

int Digikam::DItemInfo::orientation

(

)

const

References Digikam::MetaEngine::ORIENTATION_UNSPECIFIED.

Referenced by DigikamGenericHtmlGalleryPlugin::GalleryElement::GalleryElement(), DigikamGenericGeolocationEditPlugin::KmlExport::generateImagesthumb(), Digikam::MediaPlayerView::setCurrentItem(), and Digikam::SlideVideo::setCurrentUrl().

pickLabel()

int Digikam::DItemInfo::pickLabel

(

)

const

References Digikam::NoPickLabel.

Referenced by DigikamGenericSlideShowPlugin::SlideOSD::setCurrentUrl().

rating()

int Digikam::DItemInfo::rating

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD(), DigikamGenericSlideShowPlugin::SlideOSD::setCurrentUrl(), setRating(), and Digikam::DItemsListViewItem::updateInformation().

rights()

QString Digikam::DItemInfo::rights

(

)

const

sensitivity()

QString Digikam::DItemInfo::sensitivity

(

)

const

Referenced by DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

setColorLabel()

void Digikam::DItemInfo::setColorLabel

(

int

color

)

setOrientation()

void Digikam::DItemInfo::setOrientation

(

int

val

)

Referenced by DigikamGenericGLViewerPlugin::GLViewerTexture::rotate().

setPickLabel()

void Digikam::DItemInfo::setPickLabel

(

int

pick

)

setRating()

void Digikam::DItemInfo::setRating

(

int

rating

)

References rating().

source()

QString Digikam::DItemInfo::source

(

)

const

tagsPath()

QStringList Digikam::DItemInfo::tagsPath

(

)

const

title()

QString Digikam::DItemInfo::title

(

)

const

Referenced by DigikamGenericPiwigoPlugin::PiwigoTalker::addPhoto(), DigikamGenericUnifiedPlugin::WSAuthentication::getImageCaption(), DigikamGenericMediaWikiPlugin::MediaWikiWidget::loadItemInfo(), and DigikamGenericMjpegStreamPlugin::MjpegFrameOsd::PopulateOSD().

videoCodec()

QString Digikam::DItemInfo::videoCodec

(

)

const

Referenced by Digikam::MediaPlayerView::setCurrentItem(), and Digikam::SlideVideo::setCurrentUrl().

---

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

• core/libs/dplugins/iface/dinfointerface.h
• core/libs/dplugins/iface/dinfointerface.cpp