Digikam::ImageInfo Class Reference

The ImageInfo class contains provides access to the database for a single image. More...

#include <imageinfo.h>

List of all members.

Public Member Functions
	ImageInfo (const ImageInfo &info)
	ImageInfo (const ImageListerRecord &record)
	ImageInfo (const KUrl &url)
	ImageInfo (qlonglong ID)
	ImageInfo ()
	~ImageInfo ()
void	addTagPaths (const QStringList &tagPaths)
int	albumId () const
int	albumRootId () const
DatabaseItem::Category	category () const
QString	comment () const
ImageInfo	copyItem (int dstAlbumID, const QString &dstFileName)
DatabaseUrl	databaseUrl () const
QDateTime	dateTime () const
QSize	dimensions () const
QString	filePath () const
uint	fileSize () const
KUrl	fileUrl () const
QString	format () const
uint	hash () const
qlonglong	id () const
ImageComments	imageComments (DatabaseAccess &access) const
ImageCommonContainer	imageCommonContainer () const
ImageCopyright	imageCopyright () const
ImageExtendedProperties	imageExtendedProperties () const
ImageMetadataContainer	imageMetadataContainer () const
ImagePosition	imagePosition () const
bool	isNull () const
Template	metadataTemplate () const
QDateTime	modDateTime () const
QString	name () const
bool	operator< (const ImageInfo &info) const
ImageInfo &	operator= (const ImageInfo &info)
bool	operator== (const ImageInfo &info) const
PhotoInfoContainer	photoInfoContainer () const
int	rating () const
void	removeAllTags ()
void	removeMetadataTemplate ()
void	removeTag (int tagID)
void	setDateTime (const QDateTime &dateTime)
void	setMetadataTemplate (const Template &t)
void	setRating (int value)
void	setTag (int tagID)
QList< int >	tagIds () const

---

Detailed Description

The ImageInfo class contains provides access to the database for a single image.

The properties can be read and written. Information will be cached.

Definition at line 64 of file imageinfo.h.

---

Constructor & Destructor Documentation

Digikam::ImageInfo::ImageInfo

(

)

Constructor Creates a null image info.

Definition at line 69 of file imageinfo.cpp.

Digikam::ImageInfo::ImageInfo

(

qlonglong

ID

)

[explicit]

Constructor.

Creates an ImageInfo object without any cached data initially.

Parameters:

ID

unique ID for this image

Definition at line 100 of file imageinfo.cpp.

Digikam::ImageInfo::ImageInfo

(

const KUrl &

url

)

Constructor.

Creates an ImageInfo object from a file url.

Definition at line 126 of file imageinfo.cpp.

Digikam::ImageInfo::ImageInfo

(

const ImageListerRecord &

record

)

Constructor.

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

Definition at line 74 of file imageinfo.cpp.

Digikam::ImageInfo::ImageInfo

(

const ImageInfo &

info

)

Definition at line 175 of file imageinfo.cpp.

Digikam::ImageInfo::~ImageInfo

(

)

Destructor.

Definition at line 168 of file imageinfo.cpp.

---

Member Function Documentation

void Digikam::ImageInfo::addTagPaths

(

const QStringList &

tagPaths

)

Adds tags in the list to the item.

Tags are created if they do not yet exist

Definition at line 618 of file imageinfo.cpp.

int Digikam::ImageInfo::albumId

(

)

const

Returns:

the id of the PAlbum to which this item belongs

Definition at line 248 of file imageinfo.cpp.

int Digikam::ImageInfo::albumRootId

(

)

const

The album root id.

Definition at line 253 of file imageinfo.cpp.

DatabaseItem::Category Digikam::ImageInfo::category

(

)

const

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

Definition at line 331 of file imageinfo.cpp.

QString Digikam::ImageInfo::comment

(

)

const

Returns:

the caption for this item

Definition at line 284 of file imageinfo.cpp.

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

Copy database information of this item to a newly created item.

Parameters:

	dstAlbum	destination album
	dstFileName	new filename

Returns:

an ImageInfo object of the new item

Definition at line 629 of file imageinfo.cpp.

DatabaseUrl Digikam::ImageInfo::databaseUrl

(

)

const

Returns the digikamalbums:// URL.

The returned object can be used as a KUrl. Always use this for KIO operations

Definition at line 409 of file imageinfo.cpp.

QDateTime Digikam::ImageInfo::dateTime

(

)

const

Returns:

the datetime of the image

Definition at line 347 of file imageinfo.cpp.

QSize Digikam::ImageInfo::dimensions

(

)

const

Returns:

the dimensions of the image (valid only if dimensions have been requested)

Definition at line 379 of file imageinfo.cpp.

QString Digikam::ImageInfo::filePath

(

)

const

Equivalent to fileUrl().path().

Definition at line 427 of file imageinfo.cpp.

uint Digikam::ImageInfo::fileSize

(

)

const

Returns:

the filesize of the image

Definition at line 267 of file imageinfo.cpp.

KUrl Digikam::ImageInfo::fileUrl

(

)

const

Returns the file:// url.

This is equivalent to databaseUrl().fileUrl()

Definition at line 422 of file imageinfo.cpp.

QString Digikam::ImageInfo::format

(

)

const

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

Definition at line 315 of file imageinfo.cpp.

uint Digikam::ImageInfo::hash

(

)

const

Definition at line 229 of file imageinfo.cpp.

qlonglong Digikam::ImageInfo::id

(

)

const

Access rules for all methods in this class: ImageInfoData members shall be accessed only under DatabaseAccess lock.

Returns:

the unique image id for this item

The id and albumId are the exception to this rule, as they are primitive and will never change during the lifetime of an object.

Definition at line 243 of file imageinfo.cpp.

ImageComments Digikam::ImageInfo::imageComments

(

DatabaseAccess &

access

)

const

Retrieve the ImageComments object for this item.

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

Definition at line 447 of file imageinfo.cpp.

ImageCommonContainer Digikam::ImageInfo::imageCommonContainer

(

)

const

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

Definition at line 479 of file imageinfo.cpp.

ImageCopyright Digikam::ImageInfo::imageCopyright

(

)

const

Retrieve the ImageCopyright object for this item.

This object allows full read and write access to all copyright values.

Definition at line 455 of file imageinfo.cpp.

ImageExtendedProperties Digikam::ImageInfo::imageExtendedProperties

(

)

const

Retrieve the ImageExtendedProperties object for this item.

This object allows full read and write access to all extended properties values.

Definition at line 463 of file imageinfo.cpp.

ImageMetadataContainer Digikam::ImageInfo::imageMetadataContainer

(

)

const

Definition at line 489 of file imageinfo.cpp.

ImagePosition Digikam::ImageInfo::imagePosition

(

)

const

Retrieve the ImagePosition object for this item.

Definition at line 471 of file imageinfo.cpp.

bool Digikam::ImageInfo::isNull

(

)

const

Returns if this objects contains valid data.

Definition at line 192 of file imageinfo.cpp.

Template Digikam::ImageInfo::metadataTemplate

(

)

const

Retrieve metadata template information about the image.

Definition at line 524 of file imageinfo.cpp.

QDateTime Digikam::ImageInfo::modDateTime

(

)

const

Returns:

the modification datetime of the image

Definition at line 363 of file imageinfo.cpp.

QString Digikam::ImageInfo::name

(

)

const

Returns:

the name of the image

Definition at line 258 of file imageinfo.cpp.

bool Digikam::ImageInfo::operator<

(

const ImageInfo &

info

)

const

Definition at line 211 of file imageinfo.cpp.

ImageInfo & Digikam::ImageInfo::operator=

(

const ImageInfo &

info

)

Definition at line 180 of file imageinfo.cpp.

bool Digikam::ImageInfo::operator==

(

const ImageInfo &

info

)

const

Definition at line 197 of file imageinfo.cpp.

PhotoInfoContainer Digikam::ImageInfo::photoInfoContainer

(

)

const

Definition at line 499 of file imageinfo.cpp.

int Digikam::ImageInfo::rating

(

)

const

Returns the rating.

Definition at line 299 of file imageinfo.cpp.

void Digikam::ImageInfo::removeAllTags

(

)

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

Definition at line 609 of file imageinfo.cpp.

void Digikam::ImageInfo::removeMetadataTemplate

(

)

Remove all template info about the image from database.

Definition at line 552 of file imageinfo.cpp.

void Digikam::ImageInfo::removeTag

(

int

tagID

)

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

Parameters:

tagID

the ID of the tag to remove

Definition at line 600 of file imageinfo.cpp.

void Digikam::ImageInfo::setDateTime

(

const QDateTime &

dateTime

)

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

Parameters:

dateTime

the new date and time.

Definition at line 576 of file imageinfo.cpp.

void Digikam::ImageInfo::setMetadataTemplate

(

const Template &

t

)

Set metadata template information (write it to database).

Parameters:

t

the new template data.

Definition at line 538 of file imageinfo.cpp.

void Digikam::ImageInfo::setRating

(

int

value

)

Set the rating for the item.

Definition at line 564 of file imageinfo.cpp.

void Digikam::ImageInfo::setTag

(

int

tagID

)

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

Parameters:

tagID

the ID of the tag to add

Definition at line 591 of file imageinfo.cpp.

QList< int > Digikam::ImageInfo::tagIds

(

)

const

Returns:

a list of IDs of tags assigned to this item

See also:

tagNames

tagPaths

Album::id()

Definition at line 395 of file imageinfo.cpp.

---

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

• imageinfo.h
• imageinfo.cpp