dimagehistory.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 for manipulating modifications changeset for non-destruct. 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_DIMAGE_HISTORY_H
#define DIGIKAM_DIMAGE_HISTORY_H
 
// Qt includes
 
#include <QXmlStreamWriter>
#include <QXmlStreamReader>
#include <QHash>
#include <QList>
#include <QMetaType>
#include <QSharedDataPointer>
#include <QString>
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
#include "filteraction.h"
#include "historyimageid.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DImageHistory
{
public:
 
    class Entry
    {
    public:
 
        FilterAction          action;
        QList<HistoryImageId> referredImages;
    };
 
public:
 
    DImageHistory();
    DImageHistory(const DImageHistory& other);
    ~DImageHistory();
 
    DImageHistory& operator=(const DImageHistory& other);
 
    bool isNull()                                                           const;
 
    bool isEmpty()                                                          const;
 
    bool isValid()                                                          const;
 
    int size()                                                              const;
 
    bool operator==(const DImageHistory& other)                             const;
 
    bool operator!=(const DImageHistory& other)                             const
    {
        return !operator==(other);
    }
 
    bool operator<(const DImageHistory& other)                              const;
    bool operator>(const DImageHistory& other)                              const;
 
    DImageHistory& operator<<(const FilterAction& action);
 
    DImageHistory& operator<<(const HistoryImageId& imageId);
 
    void appendReferredImage(const HistoryImageId& id);
    void insertReferredImage(int entryIndex, const HistoryImageId& id);
 
    void removeLast();
 
    QList<DImageHistory::Entry>&       entries();
    const QList<DImageHistory::Entry>& entries()                            const;
    Entry&                             operator[](int i);
    const Entry&                       operator[](int i)                    const;
 
    bool hasActions()                                                       const;
    bool hasFilters()                                                       const
    {
        return hasActions();
    }
 
    int actionCount()                                                       const;
 
    QList<FilterAction> allActions()                                        const;
    const FilterAction& action(int i)                                       const;
 
    QList<HistoryImageId>& referredImages(int i);
    const QList<HistoryImageId>& referredImages(int i)                      const;
    QList<HistoryImageId> allReferredImages()                               const;
    HistoryImageId currentReferredImage()                                   const;
    HistoryImageId originalReferredImage()                                  const;
    QList<HistoryImageId> referredImagesOfType(HistoryImageId::Type type)   const;
    bool hasReferredImages()                                                const;
    bool hasReferredImageOfType(HistoryImageId::Type type)                  const;
    bool hasCurrentReferredImage()                                          const;
    bool hasOriginalReferredImage()                                         const;
 
    void clearReferredImages();
 
    void adjustReferredImages();
 
    void adjustCurrentUuid(const QString& uuid);
 
    void purgePathFromReferredImages(const QString& path, const QString& fileName);
 
    void moveCurrentReferredImage(const QString& newPath, const QString& newFileName);
 
    QString toXml()                                                         const;
    static DImageHistory fromXml(const QString& xml);
 
public:
 
    class Private;
 
private:
 
    QSharedDataPointer<Private> d;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::DImageHistory)
 
#endif // DIGIKAM_DIMAGE_HISTORY_H