itemextendedproperties.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-07-04
 * Description : Access to extended properties of an item in the database
 *
 * Copyright (C) 2009-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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_ITEM_EXTENDED_PROPERTIES_H
#define DIGIKAM_ITEM_EXTENDED_PROPERTIES_H
 
// Qt includes
 
#include <QString>
#include <QStringList>
#include <QList>
 
// Local includes
 
#include "template.h"
#include "metadatainfo.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT ItemExtendedProperties
{
 
public:
 
    explicit ItemExtendedProperties(qlonglong imageid);
 
    ItemExtendedProperties();
 
    QString intellectualGenre();
    void setIntellectualGenre(const QString& intellectualGenre);
    void removeIntellectualGenre();
 
    QString jobId();
    void setJobId(const QString& jobId);
    void removeJobId();
 
    QStringList scene();
    void setScene(const QStringList& scene);
    void removeScene();
 
    QStringList subjectCode();
    void setSubjectCode(const QStringList& subjectCode);
    void removeSubjectCode();
 
    double similarityTo(const qlonglong imageId);
    void setSimilarityTo(const qlonglong imageId, const double value);
    void removeSimilarityTo(const qlonglong imageId);
 
    IptcCoreLocationInfo location();
    void setLocation(const IptcCoreLocationInfo& location);
    void removeLocation();
 
protected:
 
    QString     readProperty(const QString& property);
    void        setProperty(const QString& property, const QString& value);
    QStringList readFakeListProperty(const QString& property);
    void        setFakeListProperty(const QString& property, const QStringList& value);
    void        removeProperty(const QString& property);
 
protected:
 
    qlonglong m_id;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_EXTENDED_PROPERTIES_H