captionvalues.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-07-13
 * Description : caption values 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_CAPTION_VALUES_H
#define DIGIKAM_CAPTION_VALUES_H
 
// Qt includes
 
#include <QMap>
#include <QString>
#include <QDateTime>
#include <QDebug>
 
// Local includes
 
#include "digikam_export.h"
#include "metaengine.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT CaptionValues
{
public:
 
    explicit CaptionValues();
    ~CaptionValues();
 
    bool operator==(const CaptionValues& val) const;
 
public:
 
    QString   caption;
    QString   author;
    QDateTime date;
};
 
DIGIKAM_EXPORT QDebug operator<<(QDebug dbg, const CaptionValues& val);
 
// --------------------------------------------------------------------
 
class DIGIKAM_EXPORT CaptionsMap : public QMap<QString, CaptionValues>
{
public:
 
    explicit CaptionsMap();
    ~CaptionsMap();
 
    void setData(const MetaEngine::AltLangMap& comments,
                 const MetaEngine::AltLangMap& authors,
                 const QString& commonAuthor,
                 const MetaEngine::AltLangMap& dates);
 
    void fromAltLangMap(const MetaEngine::AltLangMap& map);
    MetaEngine::AltLangMap toAltLangMap()   const;
 
    void setAuthorsList(const MetaEngine::AltLangMap& map, const QString& commonAuthor = QString());
    MetaEngine::AltLangMap authorsList()    const;
 
    void setDatesList(const MetaEngine::AltLangMap& map);
    MetaEngine::AltLangMap datesList()      const;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::CaptionValues)
Q_DECLARE_METATYPE(Digikam::CaptionsMap)
 
#endif // DIGIKAM_CAPTION_VALUES_H