historyimageid.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-06-02
 * Description : class holding properties of referenced files used in non-dest. editing
 *
 * Copyright (C) 2010 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010 by Martin Klapetek <martin dot klapetek 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_HISTORY_IMAGE_ID_H
#define DIGIKAM_HISTORY_IMAGE_ID_H
 
// Qt includes
 
#include <QDateTime>
#include <QMetaType>
#include <QString>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT HistoryImageId
{
public:
 
    enum Type
    {
        InvalidType    = 0,
 
        Original       = 1 << 0,
 
        Intermediate   = 1 << 1,
 
        Source         = 1 << 2,
 
        Current        = 1 << 3
    };
 
    Q_DECLARE_FLAGS(Types, Type)
 
public:
 
    HistoryImageId();
 
    explicit HistoryImageId(const QString& uuid, Type type = Current);
 
    bool isValid()                                  const;
 
    Type type()                                     const;
 
    bool isOriginalFile()                           const
    {
        return (type() == Original);
    }
 
    bool isSourceFile()                             const
    {
        return (type() == Source);
    }
 
    bool isIntermediateFile()                       const
    {
        return (type() == Intermediate);
    }
 
    bool isCurrentFile()                            const
    {
        return (type() == Current);
    }
 
    bool operator==(const HistoryImageId& other)    const;
 
    void setType(HistoryImageId::Type type);
    void setUuid(const QString& uuid);
    void setFileName(const QString& fileName);
    void setCreationDate(const QDateTime& creationDate);
    void setPathOnDisk(const QString& filePath);
    void setPath(const QString& path);
    void setUniqueHash(const QString& uniqueHash, qlonglong fileSize);
 
    bool hasFileOnDisk()                            const;
 
    QString path()                                  const;
 
    QString filePath()                              const;
 
    bool hasFileName()                              const;
 
    QString fileName()                              const;
 
    bool      hasUuid()                             const;
    QString   uuid()                                const;
    bool      hasCreationDate()                     const;
    QDateTime creationDate()                        const;
    bool      hasUniqueHashIdentifier()             const;
    QString   uniqueHash()                          const;
    qlonglong fileSize()                            const;
    QString   originalUuid()                        const;
 
public:
 
    Type      m_type;
 
    QString   m_uuid;
 
    QString   m_fileName;
 
    QDateTime m_creationDate;
 
    QString   m_filePath;
 
    QString   m_uniqueHash;
 
    qlonglong m_fileSize;
 
    QString   m_originalUUID;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::HistoryImageId)
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::HistoryImageId::Types)
 
#endif // DIGIKAM_HISTORY_IMAGE_ID_H