korganizer/history.h

   1 /*
   2   This file is part of KOrganizer.
   3
   4   Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
   5
   6   This program is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation; either version 2 of the License, or
   9   (at your option) any later version.
  10
  11   This program is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License along
  17   with this program; if not, write to the Free Software Foundation, Inc.,
  18   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20   As a special exception, permission is given to link this program
  21   with any edition of Qt, and distribute the resulting executable,
  22   without including the source code for Qt in the source distribution.
  23 */
  24 #ifndef KORG_HISTORY_H
  25 #define KORG_HISTORY_H
  26
  27 #include <calendarsupport/incidencechanger.h>
  28
  29 #include <Akonadi/Item>
  30 #include <Akonadi/Collection>
  31
  32 #include <KCalCore/Incidence>
  33
  34 #include <QObject>
  35 #include <QStack>
  36 #include <QList>
  37
  38 namespace CalendarSupport {
  39   class Calendar;
  40 }
  41
  42 namespace KOrg {
  43
  44 class History : public QObject
  45 {
  46   Q_OBJECT
  47   public:
  48     History( CalendarSupport::Calendar *, QWidget *parent );
  49
  50     void recordDelete( const Akonadi::Item & );
  51     void recordAdd( const Akonadi::Item & );
  52     void recordEdit( const Akonadi::Item &oldItem,
  53                      const Akonadi::Item &newItem );
  54     void startMultiModify( const QString &description );
  55     void endMultiModify();
  56
  57   public slots:
  58     void undo();
  59     void redo();
  60   private slots:
  61     void incidenceChangeFinished( const Akonadi::Item &,
  62                                   const Akonadi::Item &,
  63                                   CalendarSupport::IncidenceChanger::WhatChanged,
  64                                   bool);
  65
  66     void incidenceAddFinished( const Akonadi::Item &, bool );
  67
  68     void incidenceDeleteFinished( const Akonadi::Item &, bool );
  69
  70   signals:
  71     void undone();
  72     void redone();
  73
  74     void undoAvailable( const QString & );
  75     void redoAvailable( const QString & );
  76
  77   private:
  78    class Entry;
  79    void disableHistory();
  80
  81    // Called as soon as the modify jobs finish
  82    void finishUndo( bool success );
  83    void finishRedo( bool success );
  84
  85   protected:
  86     void truncate();
  87     void addEntry( Entry *entry );
  88
  89   private:
  90
  91     class Entry
  92     {
  93       public:
  94         Entry( CalendarSupport::Calendar *, CalendarSupport::IncidenceChanger * );
  95         virtual ~Entry();
  96
  97         virtual bool undo() = 0;
  98         virtual bool redo() = 0;
  99
 100         virtual QString text() = 0;
 101
 102         void setItemId( Akonadi::Item::Id );
 103         Akonadi::Item::Id itemId();
 104
 105       protected:
 106         CalendarSupport::Calendar *mCalendar;
 107         CalendarSupport::IncidenceChanger *mChanger;
 108         Akonadi::Item::Id mItemId;
 109     };
 110
 111     class EntryDelete : public Entry
 112     {
 113       public:
 114         EntryDelete( CalendarSupport::Calendar *, CalendarSupport::IncidenceChanger *, const Akonadi::Item & );
 115         ~EntryDelete();
 116
 117         bool undo();
 118         bool redo();
 119
 120         QString text();
 121
 122       private:
 123         KCalCore::Incidence::Ptr mIncidence;
 124         Akonadi::Collection mCollection;
 125         QString mParentUid;
 126     };
 127
 128     class EntryAdd : public Entry
 129     {
 130       public:
 131         EntryAdd( CalendarSupport::Calendar *, CalendarSupport::IncidenceChanger *, const Akonadi::Item & );
 132         ~EntryAdd();
 133
 134         bool undo();
 135         bool redo();
 136
 137         QString text();
 138       private:
 139         KCalCore::Incidence::Ptr mIncidence;
 140         Akonadi::Collection mCollection;
 141         QString mParentUid;
 142     };
 143
 144     class EntryEdit : public Entry
 145     {
 146       public:
 147         EntryEdit( CalendarSupport::Calendar *calendar,
 148                    CalendarSupport::IncidenceChanger *,
 149                    const Akonadi::Item &oldItem,
 150                    const Akonadi::Item &newItem );
 151         ~EntryEdit();
 152
 153         bool undo();
 154         bool redo();
 155
 156         QString text();
 157
 158       private:
 159         KCalCore::Incidence::Ptr mOldIncidence;
 160         KCalCore::Incidence::Ptr mNewIncidence;
 161     };
 162
 163     class MultiEntry : public Entry
 164     {
 165       public:
 166         MultiEntry( CalendarSupport::Calendar *calendar, const QString &text );
 167         ~MultiEntry();
 168
 169         void appendEntry( Entry *entry );
 170         bool undo();
 171         bool redo();
 172
 173         QString text();
 174         void itemCreated( Akonadi::Item::Id );
 175
 176       private:
 177         QList<Entry*> mEntries;
 178         QString mText;
 179     };
 180
 181     CalendarSupport::Calendar *mCalendar;
 182     MultiEntry *mCurrentMultiEntry;
 183     QWidget *mParent;
 184     CalendarSupport::IncidenceChanger *mChanger;
 185
 186     QStack<Entry*> mUndoEntries;
 187     QStack<Entry*> mRedoEntries;
 188
 189     // If this is not 0 there's a modify job running that didn't end yet
 190     Entry *mCurrentRunningEntry;
 191
 192     enum Operation {
 193       UNDO,
 194       REDO
 195     };
 196
 197     // When the job ends we must know if we were doing a undo or redo
 198     Operation mCurrentRunningOperation;
 199 };
 200
 201 }
 202 #endif