Public Types
enum	Type { InvalidType = 0 , Original = 1 << 0 , Intermediate = 1 << 1 , Source = 1 << 2 , Current = 1 << 3 }

Public Member Functions
QDateTime	creationDate () const

QString	fileName () const
	If a file on disk is referenced: Returns the file name (without folder) More...

QString	filePath () const
	If a file on disk is referenced: Returns the full file path (folder + filename) More...

qlonglong	fileSize () const

bool	hasCreationDate () const

bool	hasFileName () const

bool	hasFileOnDisk () const

bool	hasUniqueHashIdentifier () const

bool	hasUuid () const

	HistoryImageId ()
	Creates an invalid HistoryImageId. More...

	HistoryImageId (const QString &uuid, Type type=Current)
	Creates an id with the given UUID and type. More...

bool	isCurrentFile () const

bool	isIntermediateFile () const

bool	isOriginalFile () const

bool	isSourceFile () const

bool	isValid () const
	A valid id needs at least a valid type and a UUID or a filename. More...

bool	operator== (const HistoryImageId &other) const

QString	originalUuid () const

QString	path () const
	If a file on disk is referenced: Returns the path, without filename, with a trailing slash. More...

void	setCreationDate (const QDateTime &creationDate)

void	setFileName (const QString &fileName)

void	setPath (const QString &path)

void	setPathOnDisk (const QString &filePath)

void	setType (HistoryImageId::Type type)

void	setUniqueHash (const QString &uniqueHash, qlonglong fileSize)

void	setUuid (const QString &uuid)

Type	type () const

QString	uniqueHash () const

QString	uuid () const

Public Attributes
QDateTime	m_creationDate
	The creationDate of the original image. More...

QString	m_fileName
	The filename of the referred file. More...

QString	m_filePath
	The path of the referred file (NOTE: without file name!, including trailing slash) More...

qlonglong	m_fileSize
	The file size of the referred file. More...

QString	m_originalUUID

Type	m_type
	Type of this History Image Id. More...

QString	m_uniqueHash
	The uniqueHash of the referred file. More...

QString	m_uuid

Member Enumeration Documentation

◆ Type

enum Digikam::HistoryImageId::Type

Enumerator
InvalidType
Original	The original file (typically created by a camera)
Intermediate	A file created during the editing the history, between the original file and the current file.
Source	When a file is created from multiple files, there can be no direct original (panorama) but multiple sources, or one direct original and some other, additional source files. To record source files outside of the direct history, this type is used.
Current	The "current" file. This is a special entry: It refers to the file from which this history was read. It need not be written to the file, because it describes the file itself. There is typically exactly one current entry if the history is associated with an image; there can be no current entry.

Constructor & Destructor Documentation

◆ HistoryImageId() [1/2]

Digikam::HistoryImageId::HistoryImageId ( )

Creates an invalid HistoryImageId.

Note: In this class, the Type is used as a simple enum, but it is also prepared for usage as flags.

◆ HistoryImageId() [2/2]

Digikam::HistoryImageId::HistoryImageId	(	const QString &	uuid,
		Type	type = `Current`
	)

explicit

Creates an id with the given UUID and type.

Member Function Documentation

◆ creationDate()

QDateTime Digikam::HistoryImageId::creationDate ( ) const

References m_creationDate.

Referenced by setCreationDate().

◆ fileName()

QString Digikam::HistoryImageId::fileName ( ) const

If a file on disk is referenced: Returns the file name (without folder)

References m_fileName.

Referenced by setFileName().

◆ filePath()

QString Digikam::HistoryImageId::filePath ( ) const

If a file on disk is referenced: Returns the full file path (folder + filename)

References m_fileName, and m_filePath.

Referenced by Digikam::ItemScanner::resolveHistoryImageId(), and setPathOnDisk().

◆ fileSize()

qlonglong Digikam::HistoryImageId::fileSize ( ) const

References m_fileSize.

Referenced by setUniqueHash().

◆ hasCreationDate()

bool Digikam::HistoryImageId::hasCreationDate ( ) const

References m_creationDate.

Referenced by Digikam::ItemScanner::resolveHistoryImageId(), and Digikam::ItemScanner::sameReferredImage().

◆ hasFileName()

bool Digikam::HistoryImageId::hasFileName ( ) const

References m_fileName.

Referenced by Digikam::ItemScanner::resolveHistoryImageId(), and Digikam::ItemScanner::sameReferredImage().

◆ hasFileOnDisk()

bool Digikam::HistoryImageId::hasFileOnDisk ( ) const

References m_fileName, and m_filePath.

Referenced by Digikam::ItemScanner::resolveHistoryImageId(), and Digikam::ItemScanner::sameReferredImage().

◆ hasUniqueHashIdentifier()

bool Digikam::HistoryImageId::hasUniqueHashIdentifier ( ) const

References m_fileSize, and m_uniqueHash.

Referenced by Digikam::ItemScanner::resolveHistoryImageId(), and Digikam::ItemScanner::sameReferredImage().

◆ hasUuid()

bool Digikam::HistoryImageId::hasUuid ( ) const

References m_uuid.

Referenced by Digikam::EditorCore::ensureHasCurrentUuid(), Digikam::EditorCore::provideCurrentUuid(), Digikam::ItemScanner::resolveHistoryImageId(), and Digikam::ItemScanner::sameReferredImage().

◆ isCurrentFile()

bool Digikam::HistoryImageId::isCurrentFile ( ) const

inline

Referenced by Digikam::DImageHistory::toXml().

◆ isIntermediateFile()

bool Digikam::HistoryImageId::isIntermediateFile ( ) const

inline

◆ isOriginalFile()

bool Digikam::HistoryImageId::isOriginalFile ( ) const

inline

Referenced by Digikam::DImageHistory::fromXml(), and Digikam::DImageHistory::toXml().

◆ isSourceFile()

bool Digikam::HistoryImageId::isSourceFile ( ) const

inline

Referenced by Digikam::DImageHistory::toXml().

◆ isValid()

bool Digikam::HistoryImageId::isValid ( ) const

A valid id needs at least a valid type and a UUID or a filename.

References InvalidType, m_fileName, m_type, and m_uuid.

Referenced by Digikam::ItemHistoryGraph::addHistory(), Digikam::ItemHistoryGraphData::addVertex(), Digikam::DImageHistory::fromXml(), Digikam::ItemScanner::sameReferredImage(), and Digikam::DImageHistory::toXml().

◆ operator==()

bool Digikam::HistoryImageId::operator== ( const HistoryImageId & other ) const

References m_creationDate, m_fileName, m_filePath, m_fileSize, m_originalUUID, m_type, m_uniqueHash, and m_uuid.

◆ originalUuid()

QString Digikam::HistoryImageId::originalUuid ( ) const

References m_originalUUID.

◆ path()

QString Digikam::HistoryImageId::path ( ) const

If a file on disk is referenced: Returns the path, without filename, with a trailing slash.

References m_filePath.

Referenced by Digikam::ItemScanner::resolveHistoryImageId(), and setPath().

◆ setCreationDate()

void Digikam::HistoryImageId::setCreationDate ( const QDateTime & creationDate )

References creationDate(), and m_creationDate.

Referenced by Digikam::DImageHistory::fromXml().

◆ setFileName()

void Digikam::HistoryImageId::setFileName ( const QString & fileName )

References fileName(), and m_fileName.

Referenced by Digikam::DImageHistory::fromXml().

◆ setPath()

void Digikam::HistoryImageId::setPath ( const QString & path )

References m_filePath, and path().

Referenced by Digikam::DImageHistory::fromXml().

◆ setPathOnDisk()

void Digikam::HistoryImageId::setPathOnDisk ( const QString & filePath )

References filePath(), and m_filePath.

◆ setType()

void Digikam::HistoryImageId::setType ( HistoryImageId::Type type )

References m_type, and type().

Referenced by Digikam::ItemScanner::resolvedImageHistory().

◆ setUniqueHash()

void Digikam::HistoryImageId::setUniqueHash	(	const QString &	uniqueHash,
		qlonglong	fileSize
	)

References fileSize(), m_fileSize, m_uniqueHash, and uniqueHash().

Referenced by Digikam::DImageHistory::fromXml().

◆ setUuid()

void Digikam::HistoryImageId::setUuid ( const QString & uuid )

References m_uuid, and uuid().

◆ type()

HistoryImageId::Type Digikam::HistoryImageId::type ( ) const

References m_type.

Referenced by setType().

◆ uniqueHash()

QString Digikam::HistoryImageId::uniqueHash ( ) const

References m_uniqueHash.

Referenced by setUniqueHash().

◆ uuid()

QString Digikam::HistoryImageId::uuid ( ) const

References m_uuid.

Referenced by Digikam::EditorCore::ensureHasCurrentUuid(), and setUuid().

Member Data Documentation

◆ m_creationDate

QDateTime Digikam::HistoryImageId::m_creationDate

The creationDate of the original image.

Referenced by creationDate(), Digikam::DImageHistory::fromXml(), hasCreationDate(), operator==(), Digikam::ItemScanner::resolveHistoryImageId(), Digikam::ItemScanner::sameReferredImage(), setCreationDate(), and Digikam::DImageHistory::toXml().

◆ m_fileName

QString Digikam::HistoryImageId::m_fileName

The filename of the referred file.

Referenced by fileName(), filePath(), hasFileName(), hasFileOnDisk(), isValid(), operator==(), Digikam::ItemScanner::resolveHistoryImageId(), Digikam::ItemScanner::sameReferredImage(), setFileName(), and Digikam::DImageHistory::toXml().

◆ m_filePath

QString Digikam::HistoryImageId::m_filePath

The path of the referred file (NOTE: without file name!, including trailing slash)

Referenced by filePath(), hasFileOnDisk(), operator==(), path(), Digikam::ItemScanner::sameReferredImage(), setPath(), setPathOnDisk(), and Digikam::DImageHistory::toXml().

◆ m_fileSize

qlonglong Digikam::HistoryImageId::m_fileSize

The file size of the referred file.

Referenced by fileSize(), hasUniqueHashIdentifier(), operator==(), Digikam::ItemScanner::resolveHistoryImageId(), Digikam::ItemScanner::sameReferredImage(), setUniqueHash(), and Digikam::DImageHistory::toXml().

◆ m_originalUUID

QString Digikam::HistoryImageId::m_originalUUID

A unique identifier designating the original image from which the referred image was created. Typically, this is a RAW or JPEG created by the camera in the moment of taking the photograph.

Referenced by Digikam::DImageHistory::fromXml(), operator==(), and originalUuid().

◆ m_type

Type Digikam::HistoryImageId::m_type

Type of this History Image Id.

Referenced by Digikam::HistoryVertexProperties::alwaysMarkedAs(), Digikam::DImageHistory::fromXml(), isValid(), Digikam::HistoryVertexProperties::markedAs(), operator==(), setType(), and type().

◆ m_uniqueHash

QString Digikam::HistoryImageId::m_uniqueHash

The uniqueHash of the referred file.

Referenced by hasUniqueHashIdentifier(), operator==(), Digikam::ItemScanner::resolveHistoryImageId(), Digikam::ItemScanner::sameReferredImage(), setUniqueHash(), Digikam::DImageHistory::toXml(), and uniqueHash().

◆ m_uuid

QString Digikam::HistoryImageId::m_uuid

A unique identifier for the referred file. This id shall be changed each time the image is edited.

Referenced by Digikam::DImageHistory::fromXml(), hasUuid(), isValid(), Digikam::HistoryVertexProperties::operator==(), operator==(), Digikam::ItemScanner::resolveHistoryImageId(), Digikam::ItemScanner::sameReferredImage(), setUuid(), Digikam::DImageHistory::toXml(), and uuid().

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

core/libs/dimg/history/historyimageid.h
core/libs/dimg/history/historyimageid.cpp

Public Types

Public Member Functions

Public Attributes

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ HistoryImageId() [1/2]

◆ HistoryImageId() [2/2]

Member Function Documentation

◆ creationDate()

◆ fileName()

◆ filePath()

◆ fileSize()

◆ hasCreationDate()

◆ hasFileName()

◆ hasFileOnDisk()

◆ hasUniqueHashIdentifier()

◆ hasUuid()

◆ isCurrentFile()

◆ isIntermediateFile()

◆ isOriginalFile()

◆ isSourceFile()

◆ isValid()

◆ operator==()

◆ originalUuid()

◆ path()

◆ setCreationDate()

◆ setFileName()

◆ setPath()

◆ setPathOnDisk()

◆ setType()

◆ setUniqueHash()

◆ setUuid()

◆ type()

◆ uniqueHash()

◆ uuid()

Member Data Documentation

◆ m_creationDate

◆ m_fileName

◆ m_filePath

◆ m_fileSize

◆ m_originalUUID

◆ m_type

◆ m_uniqueHash

◆ m_uuid