digiKam
Public Member Functions | List of all members
Digikam::CaptionsMap Class Reference
+ Inheritance diagram for Digikam::CaptionsMap:

Public Member Functions

MetaEngine::AltLangMap authorsList () const
 
 CaptionsMap ()
 
MetaEngine::AltLangMap datesList () const
 
void fromAltLangMap (const MetaEngine::AltLangMap &map)
 
void setAuthorsList (const MetaEngine::AltLangMap &map, const QString &commonAuthor=QString())
 
void setData (const MetaEngine::AltLangMap &comments, const MetaEngine::AltLangMap &authors, const QString &commonAuthor, const MetaEngine::AltLangMap &dates)
 
void setDatesList (const MetaEngine::AltLangMap &map)
 
MetaEngine::AltLangMap toAltLangMap () const
 
 ~CaptionsMap ()
 

Detailed Description

A map used to store a list of Alternative Language values + author and date properties The map key is the language code following RFC3066 notation (like "fr-FR" for French), and the CaptionsMap value all caption properties.

Constructor & Destructor Documentation

◆ CaptionsMap()

Digikam::CaptionsMap::CaptionsMap ( )
explicit

◆ ~CaptionsMap()

Digikam::CaptionsMap::~CaptionsMap ( )

Member Function Documentation

◆ authorsList()

MetaEngine::AltLangMap Digikam::CaptionsMap::authorsList ( ) const

Referenced by Digikam::DMetadata::setItemComments().

◆ datesList()

MetaEngine::AltLangMap Digikam::CaptionsMap::datesList ( ) const

Referenced by Digikam::DMetadata::setItemComments().

◆ fromAltLangMap()

void Digikam::CaptionsMap::fromAltLangMap ( const MetaEngine::AltLangMap &  map)

References Digikam::CaptionValues::caption.

Referenced by setData().

◆ setAuthorsList()

void Digikam::CaptionsMap::setAuthorsList ( const MetaEngine::AltLangMap &  map,
const QString &  commonAuthor = QString() 
)

Sets the author for the comments in the specified languages. If commonAuthor is not null, it will be used to set the author of all comments for which the author is not specified in the map.

Referenced by setData().

◆ setData()

void Digikam::CaptionsMap::setData ( const MetaEngine::AltLangMap &  comments,
const MetaEngine::AltLangMap &  authors,
const QString &  commonAuthor,
const MetaEngine::AltLangMap &  dates 
)

References fromAltLangMap(), setAuthorsList(), and setDatesList().

Referenced by Digikam::DMetadata::getItemComments(), Digikam::DMetadata::getItemTitles(), and Digikam::DMetadata::loadUsingFFmpeg().

◆ setDatesList()

void Digikam::CaptionsMap::setDatesList ( const MetaEngine::AltLangMap &  map)

Referenced by setData().

◆ toAltLangMap()

MetaEngine::AltLangMap Digikam::CaptionsMap::toAltLangMap ( ) const

Referenced by Digikam::DMetadata::setItemComments(), and Digikam::DMetadata::setItemTitles().

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