versionfileoperation.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-12-20
 * Description : description of actions when saving a file with versioning
 *
 * Copyright (C) 2010-2011 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_VERSION_FILE_OPERATION_H
#define DIGIKAM_VERSION_FILE_OPERATION_H
 
// Qt includes
 
#include <QFlags>
#include <QMap>
#include <QString>
 
// Local includes
 
#include "digikam_export.h"
#include "dimagehistory.h"
 
class QUrl;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT VersionFileInfo
{
public:
 
    explicit VersionFileInfo()
    {
    }
 
    VersionFileInfo(const QString& path, const QString& fileName, const QString& format)
        : path(path),
          fileName(fileName),
          format(format)
    {
    }
 
    bool    isNull() const;
 
    QString filePath() const;
    QUrl    fileUrl() const;
 
    QString path;
    QString fileName;
    QString format;
};
 
// -------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT VersionFileOperation
{
public:
 
    explicit VersionFileOperation()
    {
    }
 
public:
 
    enum Task
    {
        NewFile            = 1 << 0,
        Replace            = 1 << 1,
        SaveAndDelete      = 1 << 2,
        MoveToIntermediate = 1 << 3,
        StoreIntermediates = 1 << 4
    };
    Q_DECLARE_FLAGS(Tasks, Task)
 
public:
 
    Tasks                      tasks;
 
    VersionFileInfo            loadedFile;
 
    VersionFileInfo            saveFile;
 
    VersionFileInfo            intermediateForLoadedFile;
 
    QMap<int, VersionFileInfo> intermediates;
 
    QStringList                allFilePaths() const;
};
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::VersionFileOperation::Tasks)
 
#endif // DIGIKAM_VERSION_FILE_OPERATION_H