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

akonadi

  • akonadi
  • calendar
calendarclipboard.cpp
1/*
2 Copyright (C) 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#include "calendarclipboard_p.h"
21#include <kcalutils/dndfactory.h>
22#include <kcalutils/icaldrag.h>
23
24#include <KLocalizedString>
25#include <KMessageBox>
26
27#include <QApplication>
28#include <QClipboard>
29
30using namespace Akonadi;
31
32CalendarClipboard::Private::Private(const Akonadi::CalendarBase::Ptr &calendar,
33 Akonadi::IncidenceChanger *changer,
34 CalendarClipboard *qq) : QObject(qq)
35 , m_calendar(calendar)
36 , m_changer(changer)
37 , m_abortCurrentOperation(false)
38 , q(qq)
39{
40 Q_ASSERT(m_calendar);
41 if (!m_changer) {
42 m_changer = new Akonadi::IncidenceChanger(this);
43 m_changer->setHistoryEnabled(false);
44 m_changer->setGroupwareCommunication(false);
45 }
46
47 m_dndfactory = new KCalUtils::DndFactory(m_calendar);
48
49 connect(m_changer,
50 SIGNAL(modifyFinished(int,Akonadi::Item,Akonadi::IncidenceChanger::ResultCode,QString)),
51 SLOT(slotModifyFinished(int,Akonadi::Item,Akonadi::IncidenceChanger::ResultCode,QString)));
52
53 connect(m_changer,
54 SIGNAL(deleteFinished(int,QVector<Akonadi::Item::Id>,Akonadi::IncidenceChanger::ResultCode,QString)),
55 SLOT(slotDeleteFinished(int,QVector<Akonadi::Item::Id>,Akonadi::IncidenceChanger::ResultCode,QString)));
56}
57
58CalendarClipboard::Private::~Private()
59{
60 delete m_dndfactory;
61}
62
63void CalendarClipboard::Private::getIncidenceHierarchy(const KCalCore::Incidence::Ptr &incidence,
64 QStringList &uids)
65{
66 // protecion against looping hierarchies
67 if (incidence && !uids.contains(incidence->uid())) {
68 KCalCore::Incidence::List immediateChildren = m_calendar->childIncidences(incidence->uid());
69
70 foreach(const KCalCore::Incidence::Ptr &child, immediateChildren) {
71 getIncidenceHierarchy(child, uids);
72 }
73 uids.append(incidence->uid());
74 }
75}
76
77void CalendarClipboard::Private::cut(const KCalCore::Incidence::List &incidences)
78{
79 const bool result = m_dndfactory->copyIncidences(incidences);
80 m_pendingChangeIds.clear();
81 // Note: Don't use DndFactory::cutIncidences(), it doesn't use IncidenceChanger for deletion
82 // we would loose async error handling and redo/undo features
83 if (result) {
84 Akonadi::Item::List items = m_calendar->itemList(incidences);
85 const int result = m_changer->deleteIncidences(items);
86 if (result == -1) {
87 emit q->cutFinished(false, i18n("Error performing deletion."));
88 } else {
89 m_pendingChangeIds << result;
90 }
91 } else {
92 emit q->cutFinished(false, i18n("Error performing copy."));
93 }
94}
95
96void CalendarClipboard::Private::cut(const KCalCore::Incidence::Ptr &incidence)
97{
98 KCalCore::Incidence::List incidences;
99 incidences << incidence;
100 cut(incidences);
101}
102
103void CalendarClipboard::Private::makeChildsIndependent(const KCalCore::Incidence::Ptr &incidence)
104{
105 Q_ASSERT(incidence);
106 const KCalCore::Incidence::List childs = m_calendar->childIncidences(incidence->uid());
107
108 if (childs.isEmpty()) {
109 cut(incidence);
110 } else {
111 m_pendingChangeIds.clear();
112 m_abortCurrentOperation = false;
113 foreach(const KCalCore::Incidence::Ptr &child, childs) {
114 Akonadi::Item childItem = m_calendar->item(incidence);
115 if (!childItem.isValid()) {
116 emit q->cutFinished( false, i18n("Can't find item: %1", childItem.id()));
117 return;
118 }
119
120 KCalCore::Incidence::Ptr newIncidence(child->clone());
121 newIncidence->setRelatedTo(QString());
122 childItem.setPayload<KCalCore::Incidence::Ptr>(newIncidence);
123 const int changeId = m_changer->modifyIncidence(childItem, /*originalPayload*/child);
124 if (changeId == -1) {
125 m_abortCurrentOperation = true;
126 break;
127 } else {
128 m_pendingChangeIds << changeId;
129 }
130 }
131 if (m_pendingChangeIds.isEmpty() && m_abortCurrentOperation) {
132 emit q->cutFinished(false, i18n("Error while removing relations."));
133 } // if m_pendingChangeIds isn't empty, we wait for all jobs to finish first.
134 }
135}
136
137void CalendarClipboard::Private::slotModifyFinished(int changeId, const Akonadi::Item &item,
138 IncidenceChanger::ResultCode resultCode,
139 const QString &errorMessage)
140{
141 if (!m_pendingChangeIds.contains(changeId))
142 return; // Not ours, someone else deleted something, not our business.
143
144 m_pendingChangeIds.remove(changeId);
145 const bool isLastChange = m_pendingChangeIds.isEmpty();
146
147 Q_UNUSED(item);
148 Q_UNUSED(errorMessage);
149 if (m_abortCurrentOperation && isLastChange) {
150 emit q->cutFinished(false, i18n("Error while removing relations."));
151 } else if (!m_abortCurrentOperation) {
152 if (resultCode == IncidenceChanger::ResultCodeSuccess) {
153 if (isLastChange) {
154 // All children are unparented, lets cut.
155 Q_ASSERT(item.isValid() && item.hasPayload());
156 cut(item.payload<KCalCore::Incidence::Ptr>());
157 }
158 } else {
159 m_abortCurrentOperation = true;
160 }
161 }
162}
163
164void CalendarClipboard::Private::slotDeleteFinished(int changeId, const QVector<Akonadi::Item::Id> &ids,
165 Akonadi::IncidenceChanger::ResultCode result,
166 const QString &errorMessage)
167{
168 if (!m_pendingChangeIds.contains(changeId))
169 return; // Not ours, someone else deleted something, not our business.
170
171 m_pendingChangeIds.remove(changeId);
172
173 Q_UNUSED(ids);
174 if (result == IncidenceChanger::ResultCodeSuccess) {
175 emit q->cutFinished(true, QString());
176 } else {
177 emit q->cutFinished(false, i18n("Error while deleting incidences: %1",
178 errorMessage));
179 }
180}
181
182CalendarClipboard::CalendarClipboard(const Akonadi::CalendarBase::Ptr &calendar,
183 Akonadi::IncidenceChanger *changer,
184 QObject *parent) : QObject(parent)
185 , d(new Private(calendar, changer, this))
186{
187
188}
189
190CalendarClipboard::~CalendarClipboard()
191{
192}
193
194void CalendarClipboard::cutIncidence(const KCalCore::Incidence::Ptr &incidence,
195 CalendarClipboard::Mode mode)
196{
197 const bool hasChildren = !d->m_calendar->childIncidences(incidence->uid()).isEmpty();
198 if (mode == AskMode && hasChildren) {
199 const int km = KMessageBox::questionYesNoCancel(0,
200 i18n("The item \"%1\" has sub-to-dos. "
201 "Do you want to cut just this item and "
202 "make all its sub-to-dos independent, or "
203 "cut the to-do with all its sub-to-dos?",
204 incidence->summary()),
205 i18n("KOrganizer Confirmation"),
206 KGuiItem(i18n("Cut Only This")),
207 KGuiItem(i18n("Cut All")));
208
209 if (km == KMessageBox::Cancel) {
210 emit cutFinished(/*success=*/true, QString());
211 return;
212 }
213 mode = km == KMessageBox::Yes ? SingleMode : RecursiveMode;
214 } else if (mode == AskMode) {
215 mode = SingleMode; // Doesn't have children, don't ask
216 }
217
218 if (mode == SingleMode) {
219 d->makeChildsIndependent(incidence); // Will call d->cut(incidence) when it finishes.
220 } else {
221 QStringList uids;
222 d->getIncidenceHierarchy(incidence, uids);
223 Q_ASSERT(!uids.isEmpty());
224 KCalCore::Incidence::List incidencesToCut;
225 foreach(const QString &uid, uids) {
226 KCalCore::Incidence::Ptr child = d->m_calendar->incidence(uid);
227 if (child)
228 incidencesToCut << child;
229 }
230 d->cut(incidencesToCut);
231 }
232}
233
234bool CalendarClipboard::copyIncidence(const KCalCore::Incidence::Ptr &incidence,
235 CalendarClipboard::Mode mode)
236{
237 const bool hasChildren = !d->m_calendar->childIncidences(incidence->uid()).isEmpty();
238 if (mode == AskMode && hasChildren) {
239 const int km = KMessageBox::questionYesNoCancel(0,
240 i18n("The item \"%1\" has sub-to-dos. "
241 "Do you want to copy just this item or "
242 "copy the to-do with all its sub-to-dos?",
243 incidence->summary()),
244 i18n("KOrganizer Confirmation"),
245 KGuiItem(i18n("Copy Only This")),
246 KGuiItem(i18n("Copy All")));
247 if (km == KMessageBox::Cancel) {
248 return true;
249 }
250 mode = km == KMessageBox::Yes ? SingleMode : RecursiveMode;
251 } else if (mode == AskMode) {
252 mode = SingleMode; // Doesn't have children, don't ask
253 }
254
255 KCalCore::Incidence::List incidencesToCopy;
256 if (mode == SingleMode) {
257 incidencesToCopy << incidence;
258 } else {
259 QStringList uids;
260 d->getIncidenceHierarchy(incidence, uids);
261 Q_ASSERT(!uids.isEmpty());
262 foreach(const QString &uid, uids) {
263 KCalCore::Incidence::Ptr child = d->m_calendar->incidence(uid);
264 if (child)
265 incidencesToCopy << child;
266 }
267 }
268
269 return d->m_dndfactory->copyIncidences(incidencesToCopy);
270}
271
272bool CalendarClipboard::pasteAvailable() const
273{
274 return KCalUtils::ICalDrag::canDecode(QApplication::clipboard()->mimeData());
275}
Akonadi::CalendarClipboard
Class to copy or cut calendar incidences.
Definition: calendarclipboard.h:39
Akonadi::CalendarClipboard::copyIncidence
bool copyIncidence(const KCalCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode=RecursiveMode)
Copies the specified incidence into the clipboard.
Definition: calendarclipboard.cpp:234
Akonadi::CalendarClipboard::Mode
Mode
Definition: calendarclipboard.h:43
Akonadi::CalendarClipboard::AskMode
@ AskMode
The user is asked if he wants children to be cut/copied too.
Definition: calendarclipboard.h:46
Akonadi::CalendarClipboard::SingleMode
@ SingleMode
Only the specified incidence is cut/copied.
Definition: calendarclipboard.h:44
Akonadi::CalendarClipboard::RecursiveMode
@ RecursiveMode
The specified incidence's children are also cut/copied.
Definition: calendarclipboard.h:45
Akonadi::CalendarClipboard::~CalendarClipboard
~CalendarClipboard()
Destroys the CalendarClipboard instance.
Definition: calendarclipboard.cpp:190
Akonadi::CalendarClipboard::cutFinished
void cutFinished(bool success, const QString &errorMessage)
Emitted after cutIncidences() finishes.
Akonadi::CalendarClipboard::cutIncidence
void cutIncidence(const KCalCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode=RecursiveMode)
Copies the specified incidence into the clipboard and then deletes it from akonadi.
Definition: calendarclipboard.cpp:194
Akonadi::CalendarClipboard::pasteAvailable
bool pasteAvailable() const
Returns if there's any ical mime data available for pasting.
Definition: calendarclipboard.cpp:272
Akonadi::CalendarClipboard::CalendarClipboard
CalendarClipboard(const Akonadi::CalendarBase::Ptr &calendar, Akonadi::IncidenceChanger *changer=0, QObject *parent=0)
Constructs a new CalendarClipboard.
Definition: calendarclipboard.cpp:182
Akonadi
FreeBusyManager::Singleton.
Definition: actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.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.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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