itemtagpair.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 an Item / Tag pair, i.e., a tag associated to an item
 *
 * Copyright (C) 2010 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_ITEM_TAG_PAIR_H
#define DIGIKAM_ITEM_TAG_PAIR_H
 
// Qt includes
 
#include <QString>
#include <QStringList>
#include <QList>
#include <QExplicitlySharedDataPointer>
#include <QMultiMap>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class ItemInfo;
class ItemTagPairPriv;
 
class DIGIKAM_DATABASE_EXPORT ItemTagPair
{
public:
 
    ItemTagPair();
 
    ItemTagPair(qlonglong imageId, int tagId);
    ItemTagPair(const ItemInfo& info, int tagId);
 
    ~ItemTagPair();
    ItemTagPair(const ItemTagPair& other);
    ItemTagPair& operator=(const ItemTagPair& other);
 
    bool isNull() const;
 
    static QList<ItemTagPair> availablePairs(qlonglong imageId);
    static QList<ItemTagPair> availablePairs(const ItemInfo& info);
 
    qlonglong imageId() const;
    int tagId() const;
 
    bool isAssigned() const;
 
    void assignTag();
 
    void unAssignTag();
 
    bool hasProperty(const QString& key) const;
    bool hasAnyProperty(const QStringList& keys) const;
    bool hasValue(const QString& key, const QString& value) const;
    QString value(const QString& key) const;
    QStringList allValues(const QStringList& keys) const;
    QStringList values(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);
    void clearProperties();
 
private:
 
    QExplicitlySharedDataPointer<ItemTagPairPriv> d;
};
 
} // namespace
 
#endif // DIGIKAM_ITEM_TAG_PAIR_H