itemcopyright.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-05-12
 * Description : Access to copy-right info of an item in the database
 *
 * Copyright (C) 2008-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_COPY_RIGHT_H
#define DIGIKAM_ITEM_COPY_RIGHT_H
 
// Qt includes
 
#include <QString>
#include <QStringList>
#include <QList>
 
// Local includes
 
#include "metaengine.h"
#include "metadatainfo.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class CopyrightInfo;
class ItemCopyrightCache;
class Template;
 
class DIGIKAM_DATABASE_EXPORT ItemCopyright
{
public:
 
    enum ReplaceMode
    {
        ReplaceAllEntries,         
        ReplaceLanguageEntry,      
        AddEntryToExisting         
    };
 
public:
 
    explicit ItemCopyright(qlonglong imageid);
 
    ItemCopyright();
 
    ItemCopyright(const ItemCopyright& other);
    ~ItemCopyright();
 
    ItemCopyright& operator=(const ItemCopyright& other);
 
    QStringList creator() const;
 
    QStringList author() const
    {
        return creator();
    }
 
    QStringList byLine() const
    {
        return creator();
    }
 
    void setCreator(const QString& creator, ReplaceMode mode = ReplaceAllEntries);
 
    void setAuthor(const QString& author, ReplaceMode mode = ReplaceAllEntries)
    {
        setCreator(author, mode);
    }
 
    void setByLine(const QString& byline, ReplaceMode mode = ReplaceAllEntries)
    {
        setCreator(byline, mode);
    }
 
    void removeCreators();
 
    QString provider() const;
 
    QString credit() const
    {
        return provider();
    }
 
    void setProvider(const QString& provider);
 
    void setCredit(const QString& credit)
    {
        setProvider(credit);
    }
 
    void removeProvider();
 
    QString copyrightNotice(const QString& languageCode = QString());
 
    QString rights(const QString& languageCode = QString())
    {
        return copyrightNotice(languageCode);
    }
 
    MetaEngine::AltLangMap allCopyrightNotices();
 
    void setCopyrightNotice(const QString& notice,
                            const QString& languageCode = QString(),
                            ReplaceMode mode = ReplaceLanguageEntry);
 
    void setRights(const QString& notice,
                   const QString& languageCode = QString(),
                   ReplaceMode mode = ReplaceLanguageEntry)
    {
        setCopyrightNotice(notice, languageCode, mode);
    }
 
    void removeCopyrightNotices();
 
    QString rightsUsageTerms(const QString& languageCode = QString());
    MetaEngine::AltLangMap allRightsUsageTerms();
 
    void setRightsUsageTerms(const QString& term,
                             const QString& languageCode = QString(),
                             ReplaceMode mode = ReplaceLanguageEntry);
 
    void removeRightsUsageTerms();
 
    QString source();
    void setSource(const QString& source);
 
    void removeSource();
 
    QString creatorJobTitle() const;
 
    QString authorsPosition() const
    {
        return creatorJobTitle();
    }
 
    QString byLineTitle()     const
    {
        return creatorJobTitle();
    }
 
    void setCreatorJobTitle(const QString& title);
 
    void setAuthorsPosition(const QString& position)
    {
        setCreatorJobTitle(position);
    }
 
    void setByLineTitle(const QString& title)
    {
        setCreatorJobTitle(title);
    }
 
    void removeCreatorJobTitle();
 
    QString instructions();
    void setInstructions(const QString& instructions);
    void removeInstructions();
 
    IptcCoreContactInfo contactInfo();
    void setContactInfo(const IptcCoreContactInfo& info);
    void removeContactInfo();
 
    void fillTemplate(Template& t);
 
    void setFromTemplate(const Template& t);
 
    void removeAll();
 
    void replaceFrom(const ItemCopyright& source);
 
protected:
 
    CopyrightInfo copyrightInfo(const QString& property)                                  const;
    QList<CopyrightInfo> copyrightInfos(const QString& property)                          const;
    QString readSimpleProperty(const QString& property)                                   const;
    int     languageMatch(const QList<CopyrightInfo>& infos, const QString& languageCode) const;
 
    void    setSimpleProperty(const QString& property, const QString& value);
    QString readLanguageProperty(const QString& property, const QString& languageCode);
    MetaEngine::AltLangMap readLanguageProperties(const QString& property);
 
    void    setLanguageProperty(const QString& property,
                                const QString& value,
                                const QString& languageCode,
                                ReplaceMode mode);
 
    void    removeProperties(const QString& property);
    void    removeLanguageProperty(const QString& property, const QString& languageCode);
 
protected:
 
    friend class ItemCopyrightCache;
 
    qlonglong           m_id;
    ItemCopyrightCache* m_cache;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_COPY_RIGHT_H