disjointmetadata.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2015-08-17
 * Description : Helper class for Image Description Editor Tab
 *
 * Copyright (C) 2015 by Veaceslav Munteanu <veaceslav dot munteanu90 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_DISJOINT_METADATA_H
#define DIGIKAM_DISJOINT_METADATA_H
 
// Qt includes
 
#include <QString>
#include <QMap>
#include <QObject>
#include <QDateTime>
 
// Local includes
 
#include "disjointmetadatadatafields.h"
#include "metaenginesettings.h"
 
namespace Digikam
{
 
class ItemInfo;
class CaptionsMap;
class Template;
 
class DisjointMetadata : public QObject
{
    Q_OBJECT
 
public:
 
    enum WriteMode
    {
        FullWrite,
 
        FullWriteIfChanged,
 
        PartialWrite
    };
 
public:
 
    DisjointMetadata();
    ~DisjointMetadata()                                                           override;
 
 
    DisjointMetadataDataFields dataFields()                                 const;
    void setDataFields(const DisjointMetadataDataFields& data);
 
    void reset();
 
    void load(const ItemInfo& info);
 
 
    DisjointMetadataDataFields::Status dateTimeStatus()                     const;
    DisjointMetadataDataFields::Status titlesStatus()                       const;
    DisjointMetadataDataFields::Status commentsStatus()                     const;
    DisjointMetadataDataFields::Status pickLabelStatus()                    const;
    DisjointMetadataDataFields::Status colorLabelStatus()                   const;
    DisjointMetadataDataFields::Status ratingStatus()                       const;
    DisjointMetadataDataFields::Status templateStatus()                     const;
 
    DisjointMetadataDataFields::Status tagStatus(int albumId)               const;
    DisjointMetadataDataFields::Status tagStatus(const QString& tagPath)    const;
 
 
 
    bool dateTimeChanged()                                                  const;
    bool titlesChanged()                                                    const;
    bool commentsChanged()                                                  const;
    bool pickLabelChanged()                                                 const;
    bool colorLabelChanged()                                                const;
    bool ratingChanged()                                                    const;
    bool templateChanged()                                                  const;
    bool tagsChanged()                                                      const;
 
 
 
    void setDateTime(const QDateTime& dateTime,
                     DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setTitles(const CaptionsMap& titles,
                   DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setComments(const CaptionsMap& comments,
                     DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setPickLabel(int pickId,
                      DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setColorLabel(int colorId,
                       DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setRating(int rating,
                   DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setMetadataTemplate(const Template& t,
                             DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
    void setTag(int albumID,
                DisjointMetadataDataFields::Status status = DisjointMetadataDataFields::MetadataAvailable);
 
 
    QDateTime   dateTime()                                                  const;
 
    CaptionsMap titles()                                                    const;
 
    CaptionsMap comments()                                                  const;
 
    int         pickLabel()                                                 const;
 
    int         colorLabel()                                                const;
 
    int         rating()                                                    const;
 
    Template    metadataTemplate()                                          const;
 
    void        dateTimeInterval(QDateTime& lowest,
                                 QDateTime& highest)                        const;
 
    void        pickLabelInterval(int& lowest,
                                  int& highest)                             const;
 
    void        colorLabelInterval(int& lowest,
                                   int& highest)                            const;
 
    void        ratingInterval(int& lowest,
                               int& highest)                                const;
 
    QStringList keywords()                                                  const;
 
    QMap<int, DisjointMetadataDataFields::Status> tags()                    const;
 
    void resetChanged();
 
    bool write(ItemInfo info, WriteMode writeMode = FullWrite);
 
    bool willWriteMetadata(WriteMode writeMode,
                           const MetaEngineSettingsContainer& settings =
                               MetaEngineSettings::instance()->settings()) const;
 
    int changedFlags();
 
private Q_SLOTS:
 
    void slotTagDeleted(int tagId);
    void slotInvalidate();
 
private:
 
    void load(const QDateTime& dateTime,
              const CaptionsMap& titles,
              const CaptionsMap& comment,
              int colorLabel, int pickLabel,
              int rating, const Template& t);
 
    void loadTags(const QList<int>& tagIds);
    void notifyTagDeleted(int id);
    void applyChangeNotifications();
 
private:
 
    // Disable
    explicit DisjointMetadata(QObject*) = delete;
 
    // Disable copy constructor and operator to prevent potential slicing with this class, reported by Clazy static analyzer.
    // https://github.com/KDE/clazy/blob/master/docs/checks/README-copyable-polymorphic.md
    // Use DisjointMetadataDataFields container setter and getter instead.
    // TODO: remove legacy implementations for these methods later if no side effect.
    DisjointMetadata(const DisjointMetadata& other);
    DisjointMetadata& operator=(const DisjointMetadata& other);
 
private:
 
    class Private;
    Private* d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DISJOINT_METADATA_H