template.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-06-20
 * Description : Template information container.
 *
 * 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_TEMPLATE_H
#define DIGIKAM_TEMPLATE_H
 
// Qt includes
 
#include <QMetaType>
#include <QString>
#include <QStringList>
#include <QDebug>
 
// Local includes
 
#include "metadatainfo.h"
#include "digikam_export.h"
#include "metaengine.h"
 
namespace Digikam
{
 
class TemplatePrivate;
 
class DIGIKAM_EXPORT Template
{
public:
 
    explicit Template();
    ~Template();
 
    bool isNull()                               const;
 
    bool isEmpty()                              const;
 
    bool operator==(const Template& t)          const;
 
    void setTemplateTitle(const QString& title);
    QString templateTitle()                     const;
 
    void setAuthors(const QStringList& authors);
    void setAuthorsPosition(const QString& authorPosition);
    void setCredit(const QString& credit);
    void setCopyright(const MetaEngine::AltLangMap& copyright);
    void setRightUsageTerms(const MetaEngine::AltLangMap& rightUsageTerms);
    void setSource(const QString& source);
    void setInstructions(const QString& instructions);
    void setLocationInfo(const IptcCoreLocationInfo& inf);
    void setContactInfo(const IptcCoreContactInfo& inf);
    void setIptcSubjects(const QStringList& subjects);
 
    QStringList            authors()            const;
    QString                authorsPosition()    const;
    QString                credit()             const;
    MetaEngine::AltLangMap copyright()          const;
    MetaEngine::AltLangMap rightUsageTerms()    const;
    QString                source()             const;
    QString                instructions()       const;
    IptcCoreLocationInfo   locationInfo()       const;
    IptcCoreContactInfo    contactInfo()        const;
    QStringList            IptcSubjects()       const;
 
    static QString removeTemplateTitle()
    {
        return QLatin1String("_REMOVE_TEMPLATE_");
    };
 
protected:
 
    QString                  m_templateTitle;
 
    QStringList              m_authors;
 
    QString                  m_authorsPosition;
 
    QString                  m_credit;
 
    MetaEngine::AltLangMap   m_copyright;
 
    MetaEngine::AltLangMap   m_rightUsageTerms;
 
    QString                  m_source;
 
    QString                  m_instructions;
 
    IptcCoreLocationInfo     m_locationInfo;
 
    IptcCoreContactInfo      m_contactInfo;
 
    QStringList              m_subjects;
};
 
DIGIKAM_EXPORT QDebug operator<<(QDebug dbg, const Template& t);
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::Template)
 
#endif // DIGIKAM_TEMPLATE_H