facetags.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2011-08-08
 * Description : Accessing face tags
 *
 * Copyright (C) 2010-2011 by Aditya Bhatt <adityabhatt1991 at gmail dot com>
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_FACE_TAGS_H
#define DIGIKAM_FACE_TAGS_H
 
// Qt includes
 
#include <QList>
#include <QMultiMap>
#include <QRect>
#include <QString>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT FaceTags
{
 
public:
 
    static bool           isPerson(int tagId);
 
    static bool           isTheUnknownPerson(int tagId);
    static int            unknownPersonTagId();
 
    static bool           isTheUnconfirmedPerson(int tagId);
    static int            unconfirmedPersonTagId();
 
    static bool           isTheIgnoredPerson(int tagId);
    static int            ignoredPersonTagId();
 
    static bool           isSystemPersonTagId(int tagId);
 
    static QList<int>     allPersonTags();
 
    static QList<QString> allPersonNames();
 
    static QList<QString> allPersonPaths();
 
    static int            personParentTag();
 
    static int            tagForPerson(const QString& name, int parentId = -1, const QString& fullName = QString());
 
    static int            getOrCreateTagForPerson(const QString& name, int parentId = -1, const QString& fullName = QString());
 
    static void           ensureIsPerson(int tagId, const QString& fullName = QString());
 
    static QString        getNameForRect(qlonglong imageid, const QRect& faceRect);
 
    static int            getOrCreateTagForIdentity(const QMultiMap<QString, QString>& attributes);
    static QMultiMap<QString, QString> identityAttributes(int tagId);
 
    static void applyTagIdentityMapping(int tagId, const QMultiMap<QString, QString>& attributes);
 
    static QString        faceNameForTag(int tagId);
 
    static int            scannedForFacesTagId();
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACE_TAGS_H