metadatahub.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-01-05
 * Description : Metadata handling
 *
 * Copyright (C) 2007-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2007-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_METADATA_HUB_H
#define DIGIKAM_METADATA_HUB_H
 
// Qt includes
 
#include <QList>
#include <QStringList>
#include <QDateTime>
#include <QMap>
 
// Local includes
 
#include "metaenginesettings.h"
#include "captionvalues.h"
#include "dmetadata.h"
#include "dimg.h"
 
namespace Digikam
{
 
class ApplicationSettings;
class ItemInfo;
class Template;
 
class MetadataHub
{
public:
 
    enum Status
    {
        MetadataInvalid,   
        MetadataAvailable  
    };
 
    enum WriteMode
    {
        FullWrite,
 
        FullWriteIfChanged,
 
        PartialWrite
    };
 
    enum WriteComponents
    {
        WRITE_DATETIME  = 1,
        WRITE_TITLE     = 2,
        WRITE_COMMENTS  = 4,
        WRITE_PICKLABEL = 8,
        WRITE_COLORLABEL= 16,
        WRITE_RATING    = 32,
        WRITE_TEMPLATE  = 64,
        WRITE_TAGS      = 128,
        WRITE_POSITION  = 256,
        WRITE_ALL       = 511
    };
    Q_DECLARE_FLAGS(WriteComponent, WriteComponents)
 
public:
 
    MetadataHub();
    ~MetadataHub();
 
    void reset();
 
    // --------------------------------------------------
 
    void load(const ItemInfo& info);
 
//    /**
//     * Add metadata information from the meta engine object
//     */
//    void load(const DMetadata& metadata);
 
//    /**
//     * Load metadata information from the given file.
//     * (Uses DMetadata, QFileInfo)
//     * @returns True if the metadata could be loaded
//     */
//    bool load(const QString& filePath, const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
    // --------------------------------------------------
 
    bool writeToMetadata(const ItemInfo& info,
                         WriteComponent writeMode = WRITE_ALL,
                         bool ignoreLazySync = false,
                         const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
 
    bool write(const QString& filePath,
               WriteComponent writeMode = WRITE_ALL,
               bool ignoreLazySync = false,
               const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
    bool write(const DImg& image,
               WriteComponent writeMode = WRITE_ALL,
               bool ignoreLazySync = false,
               const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
    bool writeTags(const QString& filePath,
                   WriteComponent writeMode = WRITE_ALL,
                   const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
    bool writeTags(const DMetadata& metadata, bool saveTags);
 
    QStringList cleanupTags(const QStringList& toClean);
 
    bool willWriteMetadata(Digikam::MetadataHub::WriteComponent writeMode = WRITE_ALL,
                           const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings()) const;
 
    void writeToBaloo(const QString& filePath,
                      const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
 
    // --------------------------------------------------
 
    void loadFaceTags(const ItemInfo& info, const QSize& size);
 
    QMultiMap<QString, QVariant> getFaceTags();
 
    void setFaceTags(QMultiMap<QString, QVariant> newFaceTags, QSize size);
 
protected:
 
    bool write(DMetadata& metadata,
               WriteComponent writeMode = WRITE_ALL,
               const MetaEngineSettingsContainer& settings = MetaEngineSettings::instance()->settings());
 
    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>& loadedTagIds);
    void loadTags(const QStringList& loadedTagPaths);
    void notifyTagDeleted(int id);
 
    void applyChangeNotifications();
 
private:
 
    bool writeFaceTagsMap(const DMetadata& metadata, bool saveFaces);
 
private:
 
    class Private;
    Private* const d;
 
private:
 
    Q_DISABLE_COPY(MetadataHub)
};
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::MetadataHub::WriteComponent)
 
#endif // DIGIKAM_METADATA_HUB_H