tagproperties.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-07-05
 * Description : Access to the properties of a tag in the database
 *
 * 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_TAG_PROPERTIES_H
#define DIGIKAM_TAG_PROPERTIES_H
 
// Qt includes
 
#include <QString>
#include <QStringList>
#include <QList>
#include <QExplicitlySharedDataPointer>
#include <QMultiMap>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT TagProperties
{
public:
 
    TagProperties();
 
    explicit TagProperties(int tagId);
 
    ~TagProperties();
    TagProperties(const TagProperties& other);
    TagProperties& operator=(const TagProperties& other);
 
    bool isNull()                                               const;
 
    int tagId()                                                 const;
 
    static TagProperties getOrCreate(const QString& tagPath);
 
    bool hasProperty(const QString& key)                        const;
 
    bool hasProperty(const QString& key, const QString& value)  const;
 
    QString value(const QString& key)                           const;
 
    QStringList propertyKeys()                                  const;
 
    QMultiMap<QString, QString> properties()                    const;
 
    void setProperty(const QString& key, const QString& value);
 
    void addProperty(const QString& key, const QString& value);
 
    void removeProperty(const QString& key, const QString& value);
 
    void removeProperties(const QString& key);
 
public:
 
    class TagPropertiesPriv;
 
private:
 
    QExplicitlySharedDataPointer<TagPropertiesPriv> d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_TAG_PROPERTIES_H