album.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2004-06-15
 * Description : digiKam album types
 *
 * Copyright (C) 2004-2005 by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2006-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2014-2015 by Mohamed_Anwer <m_dot_anwer at gmx 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_ALBUM_H
#define DIGIKAM_ALBUM_H
 
// Qt includes
 
#include <QMetaType>
#include <QList>
#include <QString>
#include <QMap>
#include <QUrl>
#include <QVector>
#include <QObject>
 
// Local includes
 
#include "coredbalbuminfo.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class Album;
typedef QList<Album*> AlbumList;
 
class CoreDbUrl;
 
class DIGIKAM_GUI_EXPORT Album
{
public:
 
    enum Type
    {
        PHYSICAL=0, 
        TAG,        
        DATE,       
        SEARCH,     
        FACE        
    };
 
    Album* parent()                         const;
 
    Album* firstChild()                     const;
 
    Album* lastChild()                      const;
 
    Album* next()                           const;
 
    Album* prev()                           const;
 
    Album* childAtRow(int row)              const;
 
    AlbumList childAlbums(bool recursive = false);
 
    QList<int> childAlbumIds(bool recursive = false);
 
    Type type()                             const;
 
    int id()                                const;
 
    int globalID()                          const;
 
    int childCount()                        const;
 
    int rowFromAlbum()                      const;
 
    QString title()                         const;
 
    virtual CoreDbUrl databaseUrl()         const = 0;
 
    bool isRoot()                           const;
 
    bool isAncestorOf(Album* const album)   const;
 
    bool isUsedByLabelsTree()               const;
 
    bool isTrashAlbum()                     const;
 
    void setExtraData(const void* const key, void* const value);
 
    void removeExtraData(const void* const key);
 
    void* extraData(const void* const key)  const;
 
    void setUsedByLabelsTree(bool isUsed);
 
    static int globalID(Type type, int id);
 
protected:
 
    Album(Album::Type type, int id, bool root);
 
    virtual ~Album();
 
    void clear();
 
    void setTitle(const QString& title);
 
    void setParent(Album* const parent);
 
    void insertChild(Album* const child);
 
    void removeChild(Album* const child);
 
private:
 
     // Disable
    Album()                         = delete;
    Album& operator==(const Album&) = delete;
    Q_DISABLE_COPY(Album)
 
private:
 
    bool                     m_root;
    bool                     m_usedByLabelsTree;
 
    int                      m_id;
 
    QString                  m_name;
    QString                  m_title;
 
    QMap<const void*, void*> m_extraMap;
    QVector<Album*>          m_childCache;
 
    Type                     m_type;
 
    Album*                   m_parent;
 
    friend class AlbumManager;
};
 
class DIGIKAM_GUI_EXPORT PAlbum : public Album
{
public:
 
    explicit PAlbum(const QString& title);
 
    PAlbum(int albumRoot, const QString& label);
 
    PAlbum(int albumRoot, const QString& parentPath, const QString& title, int id);
 
    PAlbum(const QString& parentPath, int albumRoot);
    ~PAlbum() override;
 
    void setCaption(const QString& caption);
    void setCategory(const QString& category);
    void setDate(const QDate& date);
 
    QString     albumRootPath()  const;
    QString     albumRootLabel() const;
    int         albumRootId()    const;
    QString     caption()        const;
    QString     category()       const;
    QDate       date()           const;
    QString     albumPath()      const;
    QString     prettyUrl()      const;
    QString     folderPath()     const;
    CoreDbUrl   databaseUrl()    const override;
    QUrl        fileUrl()        const;
    qlonglong   iconId()         const;
    bool        isAlbumRoot()    const;
 
private:
 
    static int m_uniqueTrashId;
 
    bool       m_isAlbumRootAlbum;
 
    int        m_albumRootId;
 
    QString    m_path;
    QString    m_parentPath;
    QString    m_category;
    QString    m_caption;
    qlonglong  m_iconId;
 
    QDate      m_date;
 
    friend class AlbumManager;
};
 
class DIGIKAM_GUI_EXPORT TAlbum : public Album
{
public:
 
    TAlbum(const QString& title, int id, bool root=false);
    ~TAlbum() override;
 
    QString                tagPath(bool leadingSlash = true) const;
    QString                standardIconName()                const;
    CoreDbUrl              databaseUrl()                     const override;
    QString                prettyUrl()                       const;
    QString                icon()                            const;
    qlonglong              iconId()                          const;
    QList<int>             tagIDs()                          const;
 
    bool                   isInternalTag()                   const;
    bool                   hasProperty(const QString& key)   const;
    QString                property(const QString& key)      const;
    QMap<QString, QString> properties()                      const;
 
private:
 
    int       m_pid;
 
    QString   m_icon;
    qlonglong m_iconId;
 
    friend class AlbumManager;
};
 
class DIGIKAM_GUI_EXPORT DAlbum : public Album
{
public:
 
    enum Range
    {
        Month = 0,
        Year
    };
 
public:
 
    explicit DAlbum(const QDate& date, bool root=false, Range range=Month);
    ~DAlbum() override;
 
    QDate     date()        const;
    Range     range()       const;
    CoreDbUrl databaseUrl() const override;
 
private:
 
    static int m_uniqueID;
    QDate      m_date;
    Range      m_range;
 
    friend class AlbumManager;
};
 
class DIGIKAM_GUI_EXPORT SAlbum : public Album
{
public:
 
    SAlbum(const QString& title, int id, bool root=false);
    ~SAlbum() override;
 
    CoreDbUrl            databaseUrl()        const override;
    QString              query()              const;
    DatabaseSearch::Type searchType()         const;
    bool                 isNormalSearch()     const;
    bool                 isAdvancedSearch()   const;
    bool                 isKeywordSearch()    const;
    bool                 isTimelineSearch()   const;
    bool                 isHaarSearch()       const;
    bool                 isMapSearch()        const;
    bool                 isDuplicatesSearch() const;
 
    bool                 isTemporarySearch()  const;
 
    QString              displayTitle()       const;
 
    static QString getTemporaryTitle(DatabaseSearch::Type type,
                                     DatabaseSearch::HaarSearchType haarType = DatabaseSearch::HaarImageSearch);
 
    static QString getTemporaryHaarTitle(DatabaseSearch::HaarSearchType haarType);
 
private:
 
    void setSearch(DatabaseSearch::Type type, const QString& query);
 
private:
 
    QString              m_query;
    DatabaseSearch::Type m_searchType;
 
    friend class AlbumManager;
};
 
class DIGIKAM_GUI_EXPORT AlbumIterator
{
public:
 
    explicit AlbumIterator(Album* const album);
    ~AlbumIterator();
 
    AlbumIterator& operator++();
    Album*         operator*();
    Album*         current() const;
 
private:
 
    // Disable
    AlbumIterator() = delete;
    Q_DISABLE_COPY(AlbumIterator)
 
private:
 
    Album* m_current;
    Album* m_root;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::Album*)
Q_DECLARE_METATYPE(QList<Digikam::TAlbum*>)
 
#endif // DIGIKAM_ALBUM_H