Inheritance diagram for Digikam::TAlbum:

Public Types
enum	Type { PHYSICAL =0 , TAG , DATE , SEARCH , FACE }

Public Member Functions
QList< int >	childAlbumIds (bool recursive=false)

AlbumList	childAlbums (bool recursive=false)

Album *	childAtRow (int row) const

int	childCount () const

CoreDbUrl	databaseUrl () const override

void *	extraData (const void *const key) const

Album *	firstChild () const

int	globalID () const

bool	hasProperty (const QString &key) const

QString	icon () const

qlonglong	iconId () const

int	id () const

bool	isAncestorOf (Album *const album) const

bool	isInternalTag () const

bool	isRoot () const

bool	isTrashAlbum () const

bool	isUsedByLabelsTree () const

Album *	lastChild () const

Album *	next () const

Album *	parent () const

QString	prettyUrl () const

Album *	prev () const

QMap< QString, QString >	properties () const

QString	property (const QString &key) const

void	removeExtraData (const void *const key)

int	rowFromAlbum () const

void	setExtraData (const void const key, void const value)

void	setUsedByLabelsTree (bool isUsed)

QString	standardIconName () const

QList< int >	tagIDs () const

QString	tagPath (bool leadingSlash=true) const

	TAlbum (const QString &title, int id, bool root=false)

QString	title () const

Type	type () const

	~TAlbum () override

Static Public Member Functions
static int	globalID (Type type, int id)
	Produces the global id. More...

Protected Member Functions
void	clear ()

void	insertChild (Album *const child)

void	removeChild (Album *const child)

void	setParent (Album *const parent)

void	setTitle (const QString &title)

Friends
class	AlbumManager

Detailed Description

A Tag Album representation

Member Enumeration Documentation

◆ Type

enum Digikam::Album::Type

inherited

Enumerator
PHYSICAL	A physical album type. See also PAlbum
TAG	A tag album type. See also TAlbum
DATE	A date album type. See also DAlbum
SEARCH	A search album type. See also SAlbum
FACE	A faces album type. See also FAlbum

Constructor & Destructor Documentation

◆ TAlbum()

Digikam::TAlbum::TAlbum	(	const QString &	title,
		int	id,
		bool	root = `false`
	)

References Digikam::Album::setTitle(), and Digikam::Album::title().

◆ ~TAlbum()

Digikam::TAlbum::~TAlbum ( )

override

Member Function Documentation

◆ childAlbumIds()

QList< int > Digikam::Album::childAlbumIds ( bool recursive = false )

inherited

Returns: a list of all child Albums

References Digikam::Album::childAlbums().

Referenced by Digikam::AlbumManager::subTags().

◆ childAlbums()

AlbumList Digikam::Album::childAlbums ( bool recursive = false )

inherited

Returns: a list of all child Albums

Referenced by Digikam::Album::childAlbumIds().

◆ childAtRow()

Album * Digikam::Album::childAtRow ( int row ) const

inherited

Returns: the child of this album at row

Referenced by Digikam::AbstractAlbumModel::index().

◆ childCount()

int Digikam::Album::childCount ( ) const

inherited

Returns: the childCount of the album

Referenced by Digikam::AbstractAlbumModel::rowCount().

◆ clear()

void Digikam::Album::clear ( )

protectedinherited

Delete all child albums and also remove any associated extra data

Referenced by Digikam::Album::~Album().

◆ databaseUrl()

CoreDbUrl Digikam::TAlbum::databaseUrl ( ) const

overridevirtual

Returns: the kde url of the album

Implements Digikam::Album.

References Digikam::CoreDbUrl::fromTagIds(), and tagIDs().

◆ extraData()

void * Digikam::Album::extraData ( const void *const key ) const

inherited

Retrieve the associated extra data associated with key

Parameters

key	the key of the extra data

See also: setExtraData; extraData

Referenced by Digikam::FindDuplicatesView::populateTreeView().

◆ firstChild()

Album * Digikam::Album::firstChild ( ) const

inherited

Returns: the first child of this album or 0 if no children

Referenced by Digikam::AlbumManager::createPAlbum(), Digikam::AbstractSpecificAlbumModel::emitDataChangedForChildren(), Digikam::AlbumManager::findSAlbum(), Digikam::AlbumManager::findSAlbumsBySearchType(), Digikam::AbstractAlbumModel::hasChildren(), Digikam::AlbumManager::mergeTAlbum(), and Digikam::AlbumIterator::operator++().

◆ globalID() [1/2]

int Digikam::Album::globalID ( ) const

inherited

An album ID is only unique among the set of all Albums of its Type. This is a global Identifier which will uniquely identifying the Album among all Albums

Note: If you are adding a new Album Type make sure to update this implementation.

You can always get the ID of the album using something like

int albumID = rootAlbum->globalID() - album->globalID();

Returns: the globalID of the album

See also: id()

Referenced by Digikam::DBInfoIface::albumChooserItems(), Digikam::AbstractAlbumModel::albumData(), Digikam::AlbumManager::createSAlbum(), Digikam::AlbumManager::deleteSAlbum(), Digikam::AlbumManager::findAlbum(), Digikam::AlbumManager::findDAlbum(), Digikam::AlbumManager::findPAlbum(), Digikam::AlbumManager::findSAlbum(), Digikam::AlbumManager::findTAlbum(), Digikam::AlbumThumbnailLoader::getAlbumThumbnailDirectly(), Digikam::AlbumThumbnailLoader::getFaceThumbnailDirectly(), Digikam::AlbumThumbnailLoader::getTagThumbnailDirectly(), Digikam::ImportUI::slotDownload(), Digikam::AlbumThumbnailLoader::slotGotThumbnailFromIcon(), Digikam::AlbumThumbnailLoader::slotIconChanged(), and Digikam::AlbumManager::startScan().

◆ globalID() [2/2]

int Digikam::Album::globalID	(	Type	type,
		int	id
	)

staticinherited

Produces the global id.

Parameters

type	The type of the album
id	the (type-specific) id of the album

Returns: the global id

References Digikam::Album::DATE, Digikam::Album::FACE, Digikam::Album::id(), Digikam::Album::PHYSICAL, Digikam::Album::SEARCH, Digikam::Album::TAG, and Digikam::Album::type().

◆ hasProperty()

bool Digikam::TAlbum::hasProperty ( const QString & key ) const

References Digikam::TagsCache::hasProperty(), and Digikam::TagsCache::instance().

Referenced by Digikam::TagModel::decorationRoleData(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::TagDragDropHandler::dropEvent(), Digikam::TagPropertiesFilterModel::matches(), and standardIconName().

◆ icon()

QString Digikam::TAlbum::icon ( ) const

Referenced by Digikam::AlbumThumbnailLoader::getFaceThumbnailDirectly(), Digikam::AlbumThumbnailLoader::getTagThumbnail(), Digikam::AlbumThumbnailLoader::getTagThumbnailDirectly(), Digikam::TagPropWidget::slotSelectionChanged(), and Digikam::TagEditDlg::TagEditDlg().

◆ iconId()

qlonglong Digikam::TAlbum::iconId ( ) const

Referenced by Digikam::FaceUtils::addNormalTag(), Digikam::AlbumThumbnailLoader::getFaceThumbnailDirectly(), Digikam::AlbumThumbnailLoader::getTagThumbnail(), Digikam::AlbumThumbnailLoader::getTagThumbnailDirectly(), Digikam::FaceUtils::removeNormalTag(), and Digikam::ItemIconView::slotRemoveTag().

◆ id()

int Digikam::Album::id ( ) const

inherited

Each album has a ID uniquely identifying it in the set of Albums of a Type

Note: The ID for a root Album is always 0

Returns: the ID of the album

See also: globalID()

◆ insertChild()

void Digikam::Album::insertChild ( Album *const child )

protectedinherited

Referenced by Digikam::Album::setParent().

◆ isAncestorOf()

bool Digikam::Album::isAncestorOf ( Album *const album ) const

inherited

Returns: true if the album is in the parent hierarchy

Parameters

album the album to check whether it belongs in the child hierarchy

References Digikam::Album::isRoot(), and Digikam::Album::parent().

Referenced by Digikam::AlbumDragDropHandler::accepts(), Digikam::TagDragDropHandler::accepts(), Digikam::AlbumManager::createTAlbum(), Digikam::AlbumManager::moveTAlbum(), Digikam::ItemAlbumModel::slotCollectionImageChange(), and Digikam::ItemAlbumModel::slotImageTagChange().

◆ isInternalTag()

bool Digikam::TAlbum::isInternalTag ( ) const

References Digikam::TagsCache::instance(), and Digikam::TagsCache::isInternalTag().

Referenced by Digikam::AlbumManager::getRecentlyAssignedTags(), Digikam::AlbumFilterModel::matchResult(), Digikam::TagModel::setData(), Digikam::TagEditDlg::TagEditDlg(), Digikam::AlbumManager::tagNames(), and Digikam::AlbumManager::tagPaths().

◆ isRoot()

bool Digikam::Album::isRoot ( ) const

inherited

Returns: true is the album is a Root Album

Referenced by Digikam::AlbumDragDropHandler::accepts(), Digikam::TagDragDropHandler::accepts(), Digikam::ContextMenuHelper::addActionDeleteAlbum(), Digikam::ContextMenuHelper::addActionEditAlbum(), Digikam::ContextMenuHelper::addActionRenameAlbum(), Digikam::ContextMenuHelper::addActionResetAlbumIcon(), Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::AbstractCountingAlbumModel::albumData(), Digikam::AbstractCheckableAlbumModel::albumData(), Digikam::TagModel::albumData(), Digikam::AlbumDragDropHandler::createMimeData(), Digikam::AlbumManager::createPAlbum(), Digikam::TagEditDlg::createTAlbum(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::AlbumThumbnailLoader::getStandardAlbumIcon(), Digikam::AlbumThumbnailLoader::getStandardTagIcon(), Digikam::Album::isAncestorOf(), Digikam::AlbumFilterModel::matchResult(), Digikam::PAlbumPath::PAlbumPath(), Digikam::AlbumSelectDialog::selectAlbum(), Digikam::TagMngrTreeView::setContexMenuItems(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeAdded(), Digikam::AlbumWatch::slotAlbumAboutToBeDeleted(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeDeleted(), Digikam::AlbumWatch::slotAlbumAdded(), Digikam::AlbumModificationHelper::slotAlbumDelete(), Digikam::AlbumModificationHelper::slotAlbumEdit(), Digikam::AlbumModificationHelper::slotAlbumNew(), Digikam::ItemIconView::slotAlbumOpenInFileManager(), Digikam::ItemIconView::slotAlbumSelected(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), Digikam::TagModificationHelper::slotMultipleTagDel(), Digikam::TagPropWidget::slotSelectionChanged(), Digikam::TagModificationHelper::slotTagDelete(), tagIDs(), and tagPath().

◆ isTrashAlbum()

bool Digikam::Album::isTrashAlbum ( ) const

inherited

Returns: true if the album was created to be a trash virtual album

References Digikam::Album::PHYSICAL.

Referenced by Digikam::AlbumDragDropHandler::accepts(), Digikam::AlbumModel::albumData(), Digikam::ToolTipFiller::albumTipContents(), Digikam::AlbumDragDropHandler::createMimeData(), Digikam::AlbumThumbnailLoader::getStandardAlbumIcon(), Digikam::AlbumFilterModel::lessThan(), Digikam::AlbumWatch::slotAlbumAboutToBeDeleted(), Digikam::AlbumWatch::slotAlbumAdded(), and Digikam::ItemIconView::slotAlbumSelected().

◆ isUsedByLabelsTree()

bool Digikam::Album::isUsedByLabelsTree ( ) const

inherited

Returns: true if the Album was created by Labels Tree

◆ lastChild()

Album * Digikam::Album::lastChild ( ) const

inherited

Returns: the last child of this album or 0 if no children

Referenced by Digikam::AlbumManager::createSAlbum(), and Digikam::AlbumManager::moveTAlbum().

◆ next()

Album * Digikam::Album::next ( ) const

inherited

Returns: the next sibling of this album of this album or 0 if no next sibling

See also: AlbumIterator

Referenced by Digikam::AlbumManager::createPAlbum(), Digikam::AbstractSpecificAlbumModel::emitDataChangedForChildren(), Digikam::AlbumManager::findSAlbum(), Digikam::AlbumManager::findSAlbumsBySearchType(), and Digikam::AlbumIterator::operator++().

◆ parent()

Album * Digikam::Album::parent ( ) const

inherited

Returns: the parent album for this album

Referenced by Digikam::TagDragDropHandler::accepts(), Digikam::AlbumModel::albumData(), Digikam::Album::isAncestorOf(), Digikam::AlbumFilterModel::matchResult(), Digikam::AlbumManager::moveTAlbum(), Digikam::AlbumIterator::operator++(), Digikam::AbstractAlbumModel::parent(), Digikam::Album::setParent(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeDeleted(), Digikam::ItemIconView::slotAlbumSelected(), Digikam::TagModificationHelper::slotMultipleTagDel(), tagIDs(), and tagPath().

◆ prettyUrl()

QString Digikam::TAlbum::prettyUrl ( ) const

References tagPath().

◆ prev()

Album * Digikam::Album::prev ( ) const

inherited

Returns: the previous sibling of this album of this album or 0 if no previous sibling

See also: AlbumIterator

◆ properties()

QMap< QString, QString > Digikam::TAlbum::properties ( ) const

References Digikam::TagsCache::instance(), and Digikam::TagsCache::properties().

◆ property()

QString Digikam::TAlbum::property ( const QString & key ) const

References Digikam::TagsCache::instance(), and Digikam::TagsCache::propertyValue().

Referenced by Digikam::AlbumManager::findTagsWithProperty(), Digikam::TagPropWidget::slotSelectionChanged(), and Digikam::TagEditDlg::TagEditDlg().

◆ removeChild()

void Digikam::Album::removeChild ( Album *const child )

protectedinherited

Referenced by Digikam::AlbumManager::moveTAlbum(), and Digikam::Album::~Album().

◆ removeExtraData()

void Digikam::Album::removeExtraData ( const void *const key )

inherited

Remove the associated extra data associated with key

Parameters

key	the key of the extra data

See also: setExtraData; extraData

◆ rowFromAlbum()

int Digikam::Album::rowFromAlbum ( ) const

inherited

Returns: the rowFromAlbum of the album

Referenced by Digikam::ItemAlbumFilterModel::compareInfosCategories(), Digikam::AbstractAlbumModel::indexForAlbum(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeAdded(), and Digikam::AbstractAlbumModel::slotAlbumAboutToBeDeleted().

◆ setExtraData()

void Digikam::Album::setExtraData	(	const void *const	key,
		void *const	value
	)

inherited

This allows to associate some "extra" data to a Album. As one Album can be used by several objects (often views) which all need to add some data, you have to use a key to reference your extra data within the Album.

That way a Album can hold and provide access to all those views separately.

for eg,

album->setExtraData( this, searchFolderItem );

and can later access the searchFolderItem by doing

SearchFolderItem *item = static_cast<SearchFolderItem*>(album->extraData(this));

Note: you have to remove and destroy the data you associated yourself when you don't need it anymore!

Parameters

key	the key of the extra data
value	the value of the extra data

See also: extraData; removeExtraData

References value.

Referenced by Digikam::FindDuplicatesView::populateTreeView().

◆ setParent()

void Digikam::Album::setParent ( Album *const parent )

protectedinherited

References Digikam::Album::insertChild(), and Digikam::Album::parent().

Referenced by Digikam::AlbumManager::createSAlbum(), and Digikam::AlbumManager::moveTAlbum().

◆ setTitle()

void Digikam::Album::setTitle ( const QString & title )

protectedinherited

References Digikam::Album::title().

Referenced by Digikam::DAlbum::DAlbum(), Digikam::PAlbum::PAlbum(), Digikam::AlbumManager::renamePAlbum(), Digikam::AlbumManager::renameTAlbum(), Digikam::SAlbum::SAlbum(), TAlbum(), and Digikam::AlbumManager::updateSAlbum().

◆ setUsedByLabelsTree()

void Digikam::Album::setUsedByLabelsTree ( bool isUsed )

inherited

Sets the property m_usedByLabelsTree to true if the search album was created using the Colors and labels tree view

Parameters

isUsed => the status of the usage

◆ standardIconName()

QString Digikam::TAlbum::standardIconName ( ) const

References hasProperty(), and Digikam::TagPropertyName::person().

Referenced by Digikam::TagFolderView::handleCustomContextMenuAction(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), and Digikam::TagModificationHelper::slotTagToFaceTag().

◆ tagIDs()

QList< int > Digikam::TAlbum::tagIDs ( ) const

References Digikam::Album::isRoot(), and Digikam::Album::parent().

Referenced by databaseUrl().

◆ tagPath()

QString Digikam::TAlbum::tagPath ( bool leadingSlash = true ) const

Returns: The tag path, e.g. "/People/Friend/John" if leadingSlash is true, "People/Friend/John" if leadingSlash if false. The root TAlbum returns "/" resp. "".

References Digikam::Album::isRoot(), Digikam::Album::parent(), and Digikam::Album::title().

Referenced by Digikam::TagEditDlg::createTAlbum(), Digikam::AlbumManager::findTAlbum(), Digikam::AlbumManager::moveTAlbum(), prettyUrl(), Digikam::TagEditDlg::TagEditDlg(), and Digikam::AlbumManager::tagPaths().

◆ title()

QString Digikam::Album::title ( ) const

inherited

Returns: the title aka name of the album

Referenced by Digikam::AbstractAlbumModel::albumData(), Digikam::SearchModel::albumData(), Digikam::DBInfoIface::albumInfo(), Digikam::AbstractCountingAlbumModel::albumName(), Digikam::AlbumPropsEdit::AlbumPropsEdit(), Digikam::ToolTipFiller::albumTipContents(), Digikam::AlbumManager::albumTitles(), Digikam::ListItem::data(), Digikam::AlbumFilterModel::dataForCurrentSortRole(), Digikam::SAlbum::displayTitle(), Digikam::TagDragDropHandler::dropEvent(), Digikam::ImageWindow::dropEvent(), Digikam::ScanController::hintAtMoveOrCopyOfAlbum(), Digikam::SAlbum::isTemporarySearch(), Digikam::lessThanByTitle(), Digikam::TagsManagerFilterModel::matches(), Digikam::AlbumManager::mergeTAlbum(), Digikam::AlbumManager::moveTAlbum(), Digikam::ItemViewUtilities::openInfos(), Digikam::PAlbum::PAlbum(), Digikam::AlbumManager::renamePAlbum(), Digikam::SAlbum::SAlbum(), Digikam::SearchTabHeader::selectedSearchChanged(), Digikam::AddTagsLineEdit::setCurrentTag(), Digikam::Album::setTitle(), Digikam::AlbumModificationHelper::slotAlbumEdit(), Digikam::AlbumModificationHelper::slotAlbumRename(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), Digikam::SearchModificationHelper::slotSearchRename(), Digikam::TagPropWidget::slotSelectionChanged(), Digikam::AddTagsComboBox::slotViewIndexActivated(), Digikam::AbstractAlbumModel::sortRoleData(), Digikam::AlbumManager::tagNames(), tagPath(), TAlbum(), and Digikam::AlbumManager::updateSAlbum().

◆ type()

Album::Type Digikam::Album::type ( ) const

inherited

Returns: the type of album

See also: Type

Referenced by Digikam::ContextMenuHelper::addAlbumCheckUncheckActions(), Digikam::ContextMenuHelper::addGotoMenu(), Digikam::ContextMenuHelper::addStandardActionThumbnail(), Digikam::AbstractAlbumModel::albumData(), Digikam::DBInfoIface::albumItems(), Digikam::ItemInfoJob::allItemsFromAlbum(), Digikam::ItemViewUtilities::createNewAlbumForInfos(), Digikam::AlbumFilterModel::dataForCurrentSortRole(), Digikam::DBInfoIface::defaultUploadUrl(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::AbstractAlbumModel::filterAlbum(), Digikam::SAlbum::getTemporaryTitle(), Digikam::Album::globalID(), Digikam::AlbumFilterModel::lessThan(), Digikam::ItemViewUtilities::setAsAlbumThumbnail(), Digikam::AlbumWatch::slotAlbumAboutToBeDeleted(), Digikam::AlbumWatch::slotAlbumAdded(), Digikam::ItemAlbumModel::slotAlbumDeleted(), Digikam::ItemIconView::slotAlbumOpenInFileManager(), Digikam::AlbumFilterModel::slotAlbumRenamed(), Digikam::FaceGroup::slotAlbumRenamed(), Digikam::ImportUI::slotDownload(), Digikam::AlbumThumbnailLoader::slotIconChanged(), and Digikam::ItemIconView::slotRefresh().

Friends And Related Function Documentation

◆ AlbumManager

friend class AlbumManager

friend

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

core/libs/album/engine/album.h
core/libs/album/engine/album.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ TAlbum()

◆ ~TAlbum()

Member Function Documentation

◆ childAlbumIds()

◆ childAlbums()

◆ childAtRow()

◆ childCount()

◆ clear()

◆ databaseUrl()

◆ extraData()

◆ firstChild()

◆ globalID() [1/2]

◆ globalID() [2/2]

◆ hasProperty()

◆ icon()

◆ iconId()

◆ id()

◆ insertChild()

◆ isAncestorOf()

◆ isInternalTag()

◆ isRoot()

◆ isTrashAlbum()

◆ isUsedByLabelsTree()

◆ lastChild()

◆ next()

◆ parent()

◆ prettyUrl()

◆ prev()

◆ properties()

◆ property()

◆ removeChild()

◆ removeExtraData()

◆ rowFromAlbum()

◆ setExtraData()

◆ setParent()

◆ setTitle()

◆ setUsedByLabelsTree()

◆ standardIconName()

◆ tagIDs()

◆ tagPath()

◆ title()

◆ type()

Friends And Related Function Documentation

◆ AlbumManager