history.h

/*
  Copyright (C) 2010-2012 Sérgio Martins <iamsergio@gmail.com>

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Library General Public License as published by
  the Free Software Foundation; either version 2 of the License, or (at your
  option) any later version.

  This library 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 Library General Public
  License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to the
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/

#ifndef AKONADI_HISTORY_H
#define AKONADI_HISTORY_H

#include "akonadi-calendar_export.h"
#include "incidencechanger.h"

#include <kcalcore/incidence.h>
#include <akonadi/item.h>
#include <QWidget>

class HistoryTest;

namespace Akonadi {

class IncidenceChanger;

class AKONADI_CALENDAR_EXPORT History : public QObject {
    Q_OBJECT
public:
    enum ResultCode {
        ResultCodeSuccess = 0, 
        ResultCodeError 
    };

    ~History();

    void recordCreation(const Akonadi::Item &item,
                        const QString &description,
                        const uint atomicOperationId = 0);

    void recordModification(const Akonadi::Item &oldItem,
                            const Akonadi::Item &newItem,
                            const QString &description,
                            const uint atomicOperationId = 0);

    void recordDeletion(const Akonadi::Item &item,
                        const QString &description,
                        const uint atomicOperationId = 0);

    void recordDeletions(const Akonadi::Item::List &items,
                         const QString &description,
                         const uint atomicOperationId = 0);

    QString lastErrorString() const;

    void undoAll(QWidget *parent = 0);

    bool undoAvailable() const;

    bool redoAvailable() const;

    QString nextUndoDescription() const;

    QString nextRedoDescription() const;

public Q_SLOTS:
    bool clear();

    void undo(QWidget *parent = 0);

    void redo(QWidget *parent = 0);

Q_SIGNALS:
    void undone(Akonadi::History::ResultCode resultCode);

    void redone(Akonadi::History::ResultCode resultCode);

    void changed();

private:

    friend class ::HistoryTest;
    friend class IncidenceChanger;
    friend class Entry;

    // Only IncidenceChanger can create History classes
    explicit History(QObject *parent = 0);

    // Used by unit-tests
    Akonadi::IncidenceChanger* incidenceChanger() const;

    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

}

#endif