Static Public Member Functions
static QList< QString >	allPersonNames ()

static QList< QString >	allPersonPaths ()

static QList< int >	allPersonTags ()

static void	applyTagIdentityMapping (int tagId, const QMultiMap< QString, QString > &attributes)

static void	ensureIsPerson (int tagId, const QString &fullName=QString())

static QString	faceNameForTag (int tagId)

static QString	getNameForRect (qlonglong imageid, const QRect &faceRect)

static int	getOrCreateTagForIdentity (const QMultiMap< QString, QString > &attributes)

static int	getOrCreateTagForPerson (const QString &name, int parentId=-1, const QString &fullName=QString())

static QMultiMap< QString, QString >	identityAttributes (int tagId)

static int	ignoredPersonTagId ()

static bool	isPerson (int tagId)

static bool	isSystemPersonTagId (int tagId)

static bool	isTheIgnoredPerson (int tagId)

static bool	isTheUnconfirmedPerson (int tagId)

static bool	isTheUnknownPerson (int tagId)

static int	personParentTag ()

static int	scannedForFacesTagId ()

static int	tagForPerson (const QString &name, int parentId=-1, const QString &fullName=QString())

static int	unconfirmedPersonTagId ()

static int	unknownPersonTagId ()

Member Function Documentation

◆ allPersonNames()

QList< QString > Digikam::FaceTags::allPersonNames ( )

static

A method to return a list of all person tag names in the DB

References allPersonTags(), Digikam::TagsCache::instance(), and Digikam::TagsCache::tagNames().

◆ allPersonPaths()

QList< QString > Digikam::FaceTags::allPersonPaths ( )

static

A method to return a list of all person tag paths in the DB

References allPersonTags(), Digikam::TagsCache::instance(), and Digikam::TagsCache::tagPaths().

◆ allPersonTags()

QList< int > Digikam::FaceTags::allPersonTags ( )

static

A method to return a list of all person tags in the DB

References Digikam::TagsCache::instance(), Digikam::TagPropertyName::person(), and Digikam::TagsCache::tagsWithProperty().

Referenced by allPersonNames(), allPersonPaths(), personParentTag(), and Digikam::TagsJob::run().

◆ applyTagIdentityMapping()

void Digikam::FaceTags::applyTagIdentityMapping	(	int	tagId,
		const QMultiMap< QString, QString > &	attributes
	)

static

Map an existing tag to a FacesEngine Identity. Subsequently, the Identity can be retrieved via the identityAttributes().

References Digikam::TagPropertyName::faceEngineName(), Digikam::TagPropertyName::faceEngineUuid(), Digikam::TagPropertyName::person(), and Digikam::TagProperties::setProperty().

Referenced by getOrCreateTagForIdentity().

◆ ensureIsPerson()

void Digikam::FaceTags::ensureIsPerson	(	int	tagId,
		const QString &	fullName = `QString()`
	)

static

Ensure that the given tag is a person tag. If not, it will be converted. Optionally, pass the full name. (tag name is not changed)

Referenced by Digikam::FaceTagsEditor::addFaceAndTag(), Digikam::AlbumManager::createTAlbum(), Digikam::AlbumManager::moveTAlbum(), and Digikam::TagModificationHelper::slotTagToFaceTag().

◆ faceNameForTag()

QString Digikam::FaceTags::faceNameForTag ( int tagId )

static

Return a person's name for a tag

References Digikam::TagsCache::instance(), Digikam::TagPropertyName::person(), Digikam::TagsCache::propertyValue(), and Digikam::TagsCache::tagName().

Referenced by Digikam::ItemSortSettings::compareCategories(), Digikam::ItemFilterModel::data(), Digikam::TagDragDropHandler::dropEvent(), Digikam::FaceTagsEditor::getSuggestedNames(), Digikam::MetadataHub::loadFaceTags(), and Digikam::AssignNameWidget::Private::updateContents().

◆ getNameForRect()

static QString Digikam::FaceTags::getNameForRect	(	qlonglong	imageid,
		const QRect &	faceRect
	)

static

◆ getOrCreateTagForIdentity()

int Digikam::FaceTags::getOrCreateTagForIdentity ( const QMultiMap< QString, QString > & attributes )

static

Use attributes as used by FacesEngine to identify or create a person tag; From the database, produce the identity attributes identifying the corresponding identity.

References applyTagIdentityMapping(), Digikam::TagPropertyName::faceEngineName(), Digikam::TagPropertyName::faceEngineUuid(), Digikam::TagPropertyName::person(), and unknownPersonTagId().

Referenced by Digikam::DatabaseWriter::process().

◆ getOrCreateTagForPerson()

int Digikam::FaceTags::getOrCreateTagForPerson	(	const QString &	name,
		int	parentId = `-1`,
		const QString &	fullName = `QString()`
	)

static

First, looks for the given person name in person tags, and returns an ID. If not, creates a new tag. Per default, fullName is the same as name.

Referenced by Digikam::ItemScanner::commitFaces(), Digikam::TagDragDropHandler::dropEvent(), Digikam::AssignNameOverlay::slotAssigned(), and Digikam::FaceGroup::slotAssigned().

◆ identityAttributes()

QMultiMap< QString, QString > Digikam::FaceTags::identityAttributes ( int tagId )

static

References Digikam::TagPropertyName::faceEngineUuid(), Digikam::TagsCache::instance(), Digikam::TagPropertyName::person(), Digikam::TagsCache::propertyValue(), and Digikam::TagsCache::tagName().

Referenced by Digikam::FaceUtils::identityForTag().

◆ ignoredPersonTagId()

int Digikam::FaceTags::ignoredPersonTagId ( )

static

References Digikam::TagsCache::getOrCreateTag(), Digikam::TagPropertyName::ignoredPerson(), Digikam::TagsCache::instance(), Digikam::TagPropertyName::person(), personParentTag(), Digikam::TagProperties::setProperty(), and Digikam::TagsCache::tagsWithPropertyCached().

Referenced by Digikam::TagDragDropHandler::dropEvent(), Digikam::DigikamItemView::ignoreFaces(), isSystemPersonTagId(), Digikam::AlbumFilterModel::lessThan(), Digikam::DigikamItemView::rejectFaces(), Digikam::FaceGroup::slotIgnored(), and Digikam::AssignNameWidget::Private::updateContents().

◆ isPerson()

bool Digikam::FaceTags::isPerson ( int tagId )

static

Returns a boolean value indicating whether the given tagId represents a person

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

Referenced by Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::FaceTagsEditor::changeTag(), Digikam::AlbumManager::deleteTAlbum(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::FaceTagsEditor::faceItemTagPairs(), Digikam::DatabaseWriter::process(), Digikam::TagFolderView::setContexMenuItems(), Digikam::TagModificationHelper::slotTagEdit(), Digikam::TagModificationHelper::slotTagToFaceTag(), and Digikam::FaceTagsIface::typeForId().

◆ isSystemPersonTagId()

bool Digikam::FaceTags::isSystemPersonTagId ( int tagId )

static

References ignoredPersonTagId(), unconfirmedPersonTagId(), and unknownPersonTagId().

Referenced by Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::AlbumManager::deleteTAlbum(), Digikam::AlbumManager::mergeTAlbum(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), and Digikam::ItemIconView::slotRemoveTag().

◆ isTheIgnoredPerson()

bool Digikam::FaceTags::isTheIgnoredPerson ( int tagId )

static

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

Referenced by Digikam::FaceUtils::addNormalTag(), Digikam::FaceTagsEditor::changeTag(), Digikam::DigikamItemView::confirmFaces(), Digikam::FaceTagsEditor::confirmName(), Digikam::FaceUtils::removeNormalTag(), and Digikam::FaceTagsIface::typeForId().

◆ isTheUnconfirmedPerson()

bool Digikam::FaceTags::isTheUnconfirmedPerson ( int tagId )

static

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

Referenced by Digikam::FaceUtils::addNormalTag(), Digikam::FaceTagsEditor::changeSuggestedName(), Digikam::FaceTagsEditor::changeTag(), Digikam::FaceTagsEditor::confirmName(), Digikam::FaceUtils::removeNormalTag(), and Digikam::FaceTagsIface::typeForId().

◆ isTheUnknownPerson()

bool Digikam::FaceTags::isTheUnknownPerson ( int tagId )

static

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

Referenced by Digikam::FaceUtils::addNormalTag(), Digikam::FaceTagsEditor::changeSuggestedName(), Digikam::FaceTagsEditor::changeTag(), Digikam::FaceTagsEditor::confirmName(), Digikam::FaceTagsEditor::faceItemTagPairs(), Digikam::DigikamItemView::rejectFaces(), Digikam::FaceUtils::removeNormalTag(), Digikam::FaceGroup::slotAssigned(), Digikam::FaceTagsIface::typeForId(), and Digikam::FaceUtils::writeUnconfirmedResults().

◆ personParentTag()

int Digikam::FaceTags::personParentTag ( )

static

The suggested parent tag for persons

References allPersonTags(), Digikam::TagsCache::getOrCreateTag(), Digikam::TagsCache::instance(), Digikam::TagsCache::parentTags(), and Digikam::TagsCache::tagForPath().

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget(), Digikam::AlbumManager::createTAlbum(), Digikam::TagDragDropHandler::dropEvent(), ignoredPersonTagId(), Digikam::AlbumManager::moveTAlbum(), unconfirmedPersonTagId(), and unknownPersonTagId().

◆ scannedForFacesTagId()

int Digikam::FaceTags::scannedForFacesTagId ( )

static

References Digikam::TagsCache::getOrCreateInternalTag(), Digikam::TagsCache::instance(), and Digikam::InternalTagName::scannedForFaces().

Referenced by Digikam::FaceUtils::hasBeenScanned(), and Digikam::FaceUtils::markAsScanned().

◆ tagForPerson()

int Digikam::FaceTags::tagForPerson	(	const QString &	name,
		int	parentId = `-1`,
		const QString &	fullName = `QString()`
	)

static

Looks for the given person name under the People tags tree, and returns an ID. Returns 0 if no name found. Per default, fullName is the same as name. As parentId of -1 signals to look for any tag, a valid parentId will limit the search to direct children of this tag. parentId of 0 means top-level tag.

◆ unconfirmedPersonTagId()

int Digikam::FaceTags::unconfirmedPersonTagId ( )

static

References Digikam::TagsCache::getOrCreateTag(), Digikam::TagsCache::instance(), Digikam::TagPropertyName::person(), personParentTag(), Digikam::TagProperties::setProperty(), Digikam::TagsCache::tagsWithPropertyCached(), Digikam::TagPropertyName::unconfirmedPerson(), and unknownPersonTagId().

Referenced by Digikam::FaceTagsEditor::changeRegion(), Digikam::FaceTagsEditor::changeSuggestedName(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::TagDragDropHandler::dropEvent(), isSystemPersonTagId(), Digikam::AlbumFilterModel::lessThan(), Digikam::FaceTagsEditor::removeFaceAndTag(), and Digikam::FaceUtils::writeUnconfirmedResults().

◆ unknownPersonTagId()

int Digikam::FaceTags::unknownPersonTagId ( )

static

References Digikam::TagsCache::getOrCreateTag(), Digikam::TagsCache::instance(), Digikam::TagPropertyName::person(), personParentTag(), Digikam::TagProperties::setProperty(), Digikam::TagsCache::tagsWithPropertyCached(), and Digikam::TagPropertyName::unknownPerson().

Referenced by Digikam::TagModel::albumData(), Digikam::ItemScanner::commitFaces(), Digikam::AlbumManager::deleteTAlbum(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::TagDragDropHandler::dropEvent(), Digikam::FacesDetector::FacesDetector(), Digikam::TagModel::fontRoleData(), getOrCreateTagForIdentity(), isSystemPersonTagId(), Digikam::AlbumFilterModel::lessThan(), Digikam::DatabaseWriter::process(), Digikam::DigikamItemView::rejectFaces(), Digikam::TagsJob::run(), Digikam::FaceTagsEditor::unconfirmedEntry(), unconfirmedPersonTagId(), and Digikam::DigikamItemView::unknownFaces().

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

core/libs/database/tags/facetags.h
core/libs/database/tags/facetags.cpp

Static Public Member Functions

Member Function Documentation

◆ allPersonNames()

◆ allPersonPaths()

◆ allPersonTags()

◆ applyTagIdentityMapping()

◆ ensureIsPerson()

◆ faceNameForTag()

◆ getNameForRect()

◆ getOrCreateTagForIdentity()

◆ getOrCreateTagForPerson()

◆ identityAttributes()

◆ ignoredPersonTagId()

◆ isPerson()

◆ isSystemPersonTagId()

◆ isTheIgnoredPerson()

◆ isTheUnconfirmedPerson()

◆ isTheUnknownPerson()

◆ personParentTag()

◆ scannedForFacesTagId()

◆ tagForPerson()

◆ unconfirmedPersonTagId()

◆ unknownPersonTagId()