dinfointerface.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2017-05-06
 * Description : abstract interface to image information.
 *               This class do not depend of digiKam database library
 *               to permit to re-use plugins with Showfoto.
 *
 * Copyright (C) 2017-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2019-2020 by Minh Nghia Duong <minhnghiaduong997 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_DINFO_INTERFACE_H
#define DIGIKAM_DINFO_INTERFACE_H
 
// Qt includes
 
#include <QMap>
#include <QString>
#include <QObject>
#include <QVariant>
#include <QUrl>
#include <QSize>
#include <QList>
#include <QDateTime>
#include <QDate>
#include <QAbstractItemModel>
 
// Local includes
 
#include "digikam_export.h"
#include "digikam_config.h"
 
#ifdef HAVE_MARBLE
#   include "gpsitemcontainer.h"
#endif
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DInfoInterface : public QObject
{
    Q_OBJECT
 
 
public:
 
    typedef QMap<QString, QVariant> DInfoMap;       
    typedef QList<int>              DAlbumIDs;      
 
public:
 
    explicit DInfoInterface(QObject* const parent);
    ~DInfoInterface() override;
 
public:
 
    Q_SLOT virtual void slotDateTimeForUrl(const QUrl& url,
                                           const QDateTime& dt,
                                           bool updModDate);
 
    Q_SLOT virtual void slotMetadataChangedForUrl(const QUrl& url);
 
    Q_SIGNAL void signalAlbumItemsRecursiveCompleted(const QList<QUrl>& imageList);
 
    Q_SIGNAL void signalShortcutPressed(const QString& shortcut, int val);
 
public:
 
 
    virtual QList<QUrl> currentSelectedItems()                                  const;
    virtual QList<QUrl> currentAlbumItems()                                     const;
    virtual void        parseAlbumItemsRecursive();
 
    virtual QList<QUrl> albumItems(int)                                         const;
    virtual QList<QUrl> albumsItems(const DAlbumIDs&)                           const;
    virtual QList<QUrl> allAlbumItems()                                         const;
 
    virtual DInfoMap albumInfo(int)                                             const;
    virtual void     setAlbumInfo(int, const DInfoMap&)                         const;
 
    virtual DInfoMap itemInfo(const QUrl&)                                      const;
    virtual void     setItemInfo(const QUrl&, const DInfoMap&)                  const;
 
    Q_SIGNAL void signalLastItemUrl(const QUrl&);
 
public:
 
 
    virtual QWidget*  albumChooser(QWidget* const parent)                       const;
    virtual DAlbumIDs albumChooserItems()                                       const;
    virtual bool      supportAlbums()                                           const;
 
    Q_SIGNAL void signalAlbumChooserSelectionChanged();
 
public:
 
 
    virtual QWidget* uploadWidget(QWidget* const parent)                        const;
    virtual QUrl     uploadUrl()                                                const;
 
    Q_SIGNAL void signalUploadUrlChanged();
 
    virtual QUrl     defaultUploadUrl()                                         const;
 
    Q_SIGNAL void signalImportedImage(const QUrl&);
 
public:
 
    virtual QAbstractItemModel* tagFilterModel();
 
#ifdef HAVE_MARBLE
 
    virtual QList<GPSItemContainer*> currentGPSItems()                          const;
 
#endif
 
public:
 
    virtual QMap<QString, QString> passShortcutActionsToWidget(QWidget* const)  const;
 
public:
 
    virtual void deleteImage(const QUrl& url);
 
public:
 
    enum SetupPage
    {
        ExifToolPage = 0
    };
 
    virtual void openSetupPage(SetupPage page);
 
    Q_SIGNAL void signalSetupChanged();
};
 
// -------------------------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT DItemInfo
{
 
public:
 
    explicit DItemInfo(const DInfoInterface::DInfoMap&);
    ~DItemInfo();
 
public:
 
    QString            name()                 const;
    QString            title()                const;
    QString            comment()              const;
    QSize              dimensions()           const;
    QDateTime          dateTime()             const;
    QStringList        tagsPath()             const;
    QStringList        keywords()             const;
 
    int                albumId()              const;
    int                orientation()          const;
    void               setOrientation(int);
    int                rating()               const;
    void               setRating(int);
    int                colorLabel()           const;
    void               setColorLabel(int);
    int                pickLabel()            const;
    void               setPickLabel(int);
 
    double             latitude()             const;
    double             longitude()            const;
    double             altitude()             const;
    qlonglong          fileSize()             const;
    QStringList        creators()             const;
    QString            credit()               const;
    QString            rights()               const;
    QString            source()               const;
    QString            lens()                 const;
    QString            make()                 const;
    QString            model()                const;
    QString            exposureTime()         const;
    QString            sensitivity()          const;
    QString            aperture()             const;
    QString            focalLength()          const;
    QString            focalLength35mm()      const;
    QString            videoCodec()           const;
 
    bool hasGeolocationInfo()                 const;
 
private:
 
    QVariant parseInfoMap(const QString& key) const;
 
private:
 
    DInfoInterface::DInfoMap m_info;
};
 
// -----------------------------------------------------------------
 
class DIGIKAM_EXPORT DAlbumInfo
{
 
public:
 
    explicit DAlbumInfo(const DInfoInterface::DInfoMap&);
    ~DAlbumInfo();
 
public:
 
    QString title()                           const;
    QString caption()                         const;
    QDate   date()                            const;
    QString path()                            const;
    QString albumPath()                       const;
 
private:
 
    DInfoInterface::DInfoMap m_info;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DINFO_INTERFACE_H