iteminfo.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-04-21
 * Description : Handling access to one item and associated data
 *
 * Copyright (C) 2005      by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2007-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2013      by Michael G. Hansen <mike at mghansen dot de>
 *
 * 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_ITEM_INFO_H
#define DIGIKAM_ITEM_INFO_H
 
// Qt includes
 
#include <QUrl>
#include <QList>
#include <QSize>
#include <QString>
#include <QDateTime>
#include <QExplicitlySharedDataPointer>
 
// Local includes
 
#include "digikam_export.h"
#include "coredbalbuminfo.h"
#include "coredburl.h"
#include "coredbfields.h"
#include "iteminfolist.h"
 
namespace Digikam
{
 
class DImageHistory;
class HistoryImageId;
class ItemComments;
class ImageCommonContainer;
class ItemCopyright;
class ItemExtendedProperties;
class ItemInfoData;
class ItemListerRecord;
class ImageMetadataContainer;
class VideoMetadataContainer;
class ItemPosition;
class ItemTagPair;
class PhotoInfoContainer;
class VideoInfoContainer;
class Template;
class ThumbnailIdentifier;
class ThumbnailInfo;
 
class DIGIKAM_DATABASE_EXPORT ItemInfo
{
public:
 
    typedef DatabaseFields::Hash<QVariant> DatabaseFieldsHashRaw;
 
public:
 
    ItemInfo();
 
    explicit ItemInfo(qlonglong ID);
 
    explicit ItemInfo(const ItemListerRecord& record);
 
    ItemInfo(const ItemInfo& info);
 
    ~ItemInfo();
 
    static ItemInfo fromLocalFile(const QString& path);
    static ItemInfo fromUrl(const QUrl& url);
 
    static ItemInfo fromLocationAlbumAndName(int locationId, const QString& album, const QString& name);
 
    ItemInfo& operator=(const ItemInfo& info);
 
    bool operator==(const ItemInfo& info)                                               const;
    bool operator!=(const ItemInfo& info)                                               const;
    bool operator<(const ItemInfo& info)                                                const;
 
    ItemInfo copyItem(int dstAlbumID, const QString& dstFileName);
 
    bool isLocationAvailable()                                                          const;
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    bool isNull()                                                                       const;
 
    QString name()                                                                      const;
 
    QDateTime dateTime()                                                                const;
 
    QDateTime modDateTime()                                                             const;
 
    qlonglong fileSize()                                                                const;
 
    QSize dimensions()                                                                  const;
 
    QUrl fileUrl()                                                                      const;
 
    QString filePath()                                                                  const;
 
    qlonglong id()                                                                      const;
 
    int albumId()                                                                       const;
 
    int albumRootId()                                                                   const;
 
    double aspectRatio()                                                                const;
 
    qlonglong manualOrder()                                                             const;
 
    DatabaseItem::Category category()                                                   const;
 
    QString format()                                                                    const;
 
    bool isVisible()                                                                    const;
 
    bool isRemoved()                                                                    const;
 
    int orientation()                                                                   const;
 
    QString title()                                                                     const;
 
    QString comment()                                                                   const;
 
    int faceCount()                                                                     const;
 
    int unconfirmedFaceCount()                                                          const;
 
    QMap<QString, QString> getSuggestedNames()                                          const;
 
    void setName(const QString& newName);
 
    void setDateTime(const QDateTime& dateTime);
 
    void setModDateTime(const QDateTime& dateTime);
 
    void setManualOrder(qlonglong value);
 
    void setOrientation(int value);
 
    void setVisible(bool isVisible);
 
    DatabaseFieldsHashRaw getDatabaseFieldsRaw(const DatabaseFields::Set& requestedSet) const;
    QVariant getDatabaseFieldRaw(const DatabaseFields::Set& requestedField)             const;
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    ItemPosition imagePosition()                                                        const;
 
    double longitudeNumber()                                                            const;
    double latitudeNumber()                                                             const;
    double altitudeNumber()                                                             const;
    bool   hasCoordinates()                                                             const;
    bool   hasAltitude()                                                                const;
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    DImageHistory imageHistory()                                                        const;
    void setItemHistory(const DImageHistory& history);
    bool hasImageHistory()                                                              const;
 
    QString uuid()                                                                      const;
    void setUuid(const QString& uuid);
 
    HistoryImageId historyImageId()                                                     const;
 
    bool hasDerivedImages()                                                             const;
    bool hasAncestorImages()                                                            const;
 
    QList<ItemInfo> derivedImages()                                                     const;
    QList<ItemInfo> ancestorImages()                                                    const;
 
    QList<QPair<qlonglong, qlonglong> > relationCloud()                                 const;
 
    void markDerivedFrom(const ItemInfo& ancestorImage);
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    bool isGrouped()                                                                    const;
    bool hasGroupedImages()                                                             const;
    int  numberOfGroupedImages()                                                        const;
 
    ItemInfo groupImage()                                                               const;
    qlonglong groupImageId()                                                            const;
 
    QList<ItemInfo> groupedImages()                                                     const;
 
    void addToGroup(const ItemInfo& info);
 
    void removeFromGroup();
 
    void clearGroup();
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    ImageCommonContainer   imageCommonContainer()                                       const;
    ImageMetadataContainer imageMetadataContainer()                                     const;
    VideoMetadataContainer videoMetadataContainer()                                     const;
    PhotoInfoContainer     photoInfoContainer()                                         const;
    VideoInfoContainer     videoInfoContainer()                                         const;
 
    Template metadataTemplate()                                                         const;
 
    void setMetadataTemplate(const Template& t);
 
    void removeMetadataTemplate();
 
    ItemComments imageComments(CoreDbAccess& access)                                    const;
 
    ItemCopyright imageCopyright()                                                      const;
 
    ItemExtendedProperties imageExtendedProperties()                                    const;
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    void setTag(int tagID);
 
    void addTagPaths(const QStringList& tagPaths);
 
    void removeTag(int tagID);
 
    void removeAllTags();
 
    ItemTagPair imageTagPair(int tagId)                                                 const;
    QList<ItemTagPair> availableItemTagPairs()                                          const;
 
    QList<int> tagIds()                                                                 const;
 
private:
 
    void loadTagIds()                                                                   const;
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    int pickLabel()                                                                     const;
 
    int colorLabel()                                                                    const;
 
    int rating()                                                                        const;
 
    void setPickLabel(int value);
 
    void setColorLabel(int value);
 
    void setRating(int value);
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    ThumbnailIdentifier thumbnailIdentifier()                                           const;
    ThumbnailInfo thumbnailInfo()                                                       const;
    static ThumbnailIdentifier thumbnailIdentifier(qlonglong id);
 
 
public:
 
    // -----------------------------------------------------------------------------
 
 
    double similarityTo(const qlonglong imageId)                                        const;
    double currentSimilarity()                                                          const;
 
    qlonglong currentReferenceImage()                                                   const;
 
    uint hash()                                                                         const;
 
    QList<ItemInfo> fromUniqueHash(const QString& uniqueHash, qlonglong fileSize);
 
    QString uniqueHash()                                                                const;
 
 
private:
 
    friend class ItemInfoCache;
    friend class ItemInfoList;
 
    QExplicitlySharedDataPointer<ItemInfoData> m_data;
};
 
inline uint qHash(const ItemInfo& info)
{
    return info.hash();
}
 
DIGIKAM_DATABASE_EXPORT QDebug operator<<(QDebug stream, const ItemInfo& info);
 
} // namespace Digikam
 
Q_DECLARE_TYPEINFO(Digikam::ItemInfo, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(Digikam::ItemInfo)
 
#endif // DIGIKAM_ITEM_INFO_H