• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.11.3 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
  • calendar
history.h
1 /*
2  Copyright (C) 2010-2012 Sérgio Martins <iamsergio@gmail.com>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #ifndef AKONADI_HISTORY_H
21 #define AKONADI_HISTORY_H
22 
23 #include "akonadi-calendar_export.h"
24 #include "incidencechanger.h"
25 
26 #include <kcalcore/incidence.h>
27 #include <akonadi/item.h>
28 #include <QWidget>
29 
30 namespace Akonadi {
31 
32 class IncidenceChanger;
33 
56 class AKONADI_CALENDAR_EXPORT History : public QObject {
57  Q_OBJECT
58 public:
65  enum ResultCode {
66  ResultCodeSuccess = 0,
67  ResultCodeError
68  };
69 
73  ~History();
74 
86  void recordCreation( const Akonadi::Item &item,
87  const QString &description,
88  const uint atomicOperationId = 0 );
89 
104  void recordModification( const Akonadi::Item &oldItem,
105  const Akonadi::Item &newItem,
106  const QString &description,
107  const uint atomicOperationId = 0 );
108 
121  void recordDeletion( const Akonadi::Item &item,
122  const QString &description,
123  const uint atomicOperationId = 0 );
124 
135  void recordDeletions( const Akonadi::Item::List &items,
136  const QString &description,
137  const uint atomicOperationId = 0 );
138 
147  QString lastErrorString() const;
148 
155  void undoAll( QWidget *parent = 0 );
156 
160  bool undoAvailable() const;
161 
165  bool redoAvailable() const;
166 
175  QString nextUndoDescription() const;
176 
185  QString nextRedoDescription() const;
186 
187 public Q_SLOTS:
194  bool clear();
195 
209  void undo( QWidget *parent = 0 );
210 
224  void redo( QWidget *parent = 0 );
225 
226 Q_SIGNALS:
232  void undone( Akonadi::History::ResultCode resultCode );
233 
239  void redone( Akonadi::History::ResultCode resultCode );
240 
244  void changed();
245 
246 private:
247 
248  friend class IncidenceChanger;
249  friend class Entry;
250 
251  // Only IncidenceChanger can create History classes
252  explicit History( QObject *parent = 0 );
253 
254  // Used by unit-tests
255  Akonadi::IncidenceChanger* incidenceChanger() const;
256 
257  //@cond PRIVATE
258  class Private;
259  Private *const d;
260  //@endcond
261 };
262 
263 }
264 
265 #endif
Akonadi::History
History class for implementing undo/redo of calendar operations.
Definition: history.h:56
Akonadi::History::ResultCode
ResultCode
This enum describes the possible result codes (success/error values) for an undo or redo operation...
Definition: history.h:65
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:17 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.11.3 API Reference

Skip menu "kdepimlibs-4.11.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal