calendarsupport/utils.h

   1 /*
   2   Copyright (c) 2009, 2010 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
   3     Author: Frank Osterfeld <osterfeld@kde.org>
   4     Author: Andras Mantia <andras@kdab.com>
   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 CALENDARSUPPORT_UTILS_H
  25 #define CALENDARSUPPORT_UTILS_H
  26
  27 #include "calendarsupport_export.h"
  28
  29 #include <Collection>
  30 #include <Item>
  31 #include <Akonadi/Calendar/ETMCalendar>
  32
  33 #include <KCalCore/Event>
  34 #include <KCalCore/Incidence>
  35 #include <KCalCore/Journal>
  36 #include <KCalCore/ScheduleMessage>
  37 #include <KCalCore/Todo>
  38
  39 #include <KDateTime>
  40
  41 #include <QModelIndex>
  42
  43 namespace KCalCore
  44 {
  45 class CalFilter;
  46 }
  47
  48 namespace Akonadi
  49 {
  50 class ETMCalendar;
  51 }
  52
  53 class QAbstractItemModel;
  54 class QDrag;
  55 class QMimeData;
  56
  57 typedef QList<QModelIndex> QModelIndexList;
  58
  59 namespace CalendarSupport
  60 {
  61
  62 class Calendar;
  63 /**
  64  * returns the incidence from an akonadi item, or a null pointer if the item has no such payload
  65  */
  66 CALENDARSUPPORT_EXPORT KCalCore::Incidence::Ptr incidence(const Akonadi::Item &item);
  67
  68 /**
  69  * returns the event from an akonadi item, or a null pointer if the item has no such payload
  70  */
  71 CALENDARSUPPORT_EXPORT KCalCore::Event::Ptr event(const Akonadi::Item &item);
  72
  73 /**
  74  * returns the event from an incidence, or a null pointer if the item has no such payload
  75  */
  76 CALENDARSUPPORT_EXPORT KCalCore::Event::Ptr event(const KCalCore::Incidence::Ptr &incidence);
  77
  78 /**
  79  * returns event pointers from an akonadi item, or a null pointer if the item has no such payload
  80  */
  81 CALENDARSUPPORT_EXPORT KCalCore::Event::List eventsFromItems(const Akonadi::Item::List &items);
  82
  83 /**
  84  * returns incidence pointers from an akonadi item.
  85  */
  86 CALENDARSUPPORT_EXPORT KCalCore::Incidence::List incidencesFromItems(
  87     const Akonadi::Item::List &items);
  88
  89 /**
  90  * returns the todo from an akonadi item, or a null pointer if the item has no such payload
  91  */
  92 CALENDARSUPPORT_EXPORT KCalCore::Todo::Ptr todo(const Akonadi::Item &item);
  93
  94 /**
  95  * returns the todo from an incidence, or a null pointer if the item has no such payload
  96  */
  97 CALENDARSUPPORT_EXPORT KCalCore::Todo::Ptr todo(const KCalCore::Incidence::Ptr &incidence);
  98
  99 /**
 100  * returns the journal from an akonadi item, or a null pointer if the item has no such payload
 101  */
 102 CALENDARSUPPORT_EXPORT KCalCore::Journal::Ptr journal(const Akonadi::Item &item);
 103
 104 /**
 105  * returns the journal from an incidence, or a null pointer if the item has no such payload
 106  */
 107 CALENDARSUPPORT_EXPORT KCalCore::Journal::Ptr journal(const KCalCore::Incidence::Ptr &incidence);
 108
 109 /**
 110  * returns whether an Akonadi item contains an incidence
 111  */
 112 CALENDARSUPPORT_EXPORT bool hasIncidence(const Akonadi::Item &item);
 113
 114 /**
 115  * returns whether an Akonadi item contains an event
 116  */
 117 CALENDARSUPPORT_EXPORT bool hasEvent(const Akonadi::Item &item);
 118
 119 /**
 120  * returns whether an incidence contains an event
 121  */
 122 CALENDARSUPPORT_EXPORT bool hasEvent(const KCalCore::Incidence::Ptr &incidence);
 123
 124 /**
 125  * returns whether an Akonadi item contains a todo
 126  */
 127 CALENDARSUPPORT_EXPORT bool hasTodo(const Akonadi::Item &item);
 128
 129 /**
 130  * returns whether an incidence contains a todo
 131  */
 132 CALENDARSUPPORT_EXPORT bool hasTodo(const KCalCore::Incidence::Ptr &incidence);
 133
 134 /**
 135  * returns whether an Akonadi item contains a journal
 136  */
 137 CALENDARSUPPORT_EXPORT bool hasJournal(const Akonadi::Item &item);
 138
 139 /**
 140  * returns whether an incidence contains a journal
 141  */
 142 CALENDARSUPPORT_EXPORT bool hasJournal(const KCalCore::Incidence::Ptr &incidence);
 143
 144 /**
 145  * returns whether this item can be deleted
 146  */
 147 CALENDARSUPPORT_EXPORT bool hasDeleteRights(const Akonadi::Item &item);
 148
 149 /**
 150  * returns whether this item can be changed
 151  */
 152 CALENDARSUPPORT_EXPORT bool hasChangeRights(const Akonadi::Item &item);
 153
 154 /**
 155  * returns @p true if the URL represents an Akonadi item and has one of the given mimetypes.
 156  */
 157 CALENDARSUPPORT_EXPORT bool isValidIncidenceItemUrl(const QUrl &url,
 158         const QStringList &supportedMimeTypes);
 159
 160 CALENDARSUPPORT_EXPORT bool isValidIncidenceItemUrl(const QUrl &url);
 161
 162 /**
 163  * returns @p true if the mime data object contains any of the following:
 164  *
 165  * - an Akonadi item with a supported KCal mimetype
 166  * - an iCalendar
 167  * - a VCard
 168  */
 169 CALENDARSUPPORT_EXPORT bool canDecode(const QMimeData *mimeData);
 170
 171 CALENDARSUPPORT_EXPORT QList<QUrl> incidenceItemUrls(const QMimeData *mimeData);
 172
 173 CALENDARSUPPORT_EXPORT QList<QUrl> todoItemUrls(const QMimeData *mimeData);
 174
 175 CALENDARSUPPORT_EXPORT bool mimeDataHasIncidence(const QMimeData *mimeData);
 176 CALENDARSUPPORT_EXPORT bool mimeDataHasTodo(const QMimeData *mimeData);
 177
 178 CALENDARSUPPORT_EXPORT KCalCore::Todo::List todos(const QMimeData *mimeData,
 179         const KDateTime::Spec &timeSpec);
 180
 181 CALENDARSUPPORT_EXPORT KCalCore::Incidence::List incidences(const QMimeData *mimeData,
 182         const KDateTime::Spec &timeSpec);
 183
 184 /**
 185 * returns @p true if the URL represents an Akonadi item and has one of the given mimetypes.
 186 */
 187 CALENDARSUPPORT_EXPORT bool isValidTodoItemUrl(const QUrl &url);
 188
 189 /**
 190 * creates mime data object for dragging an akonadi item containing an incidence
 191 */
 192 CALENDARSUPPORT_EXPORT QMimeData *createMimeData(const Akonadi::Item &item,
 193         const KDateTime::Spec &timeSpec);
 194
 195 /**
 196 * creates mime data object for dragging akonadi items containing an incidence
 197 */
 198 CALENDARSUPPORT_EXPORT QMimeData *createMimeData(const Akonadi::Item::List &items,
 199         const KDateTime::Spec &timeSpec);
 200
 201 #ifndef QT_NO_DRAGANDDROP
 202 /**
 203  * creates a drag object for dragging an akonadi item containing an incidence
 204  */
 205 CALENDARSUPPORT_EXPORT QDrag *createDrag(const Akonadi::Item &item,
 206         const KDateTime::Spec &timeSpec, QWidget *parent);
 207
 208 /**
 209  * creates a drag object for dragging akonadi items containing an incidence
 210  */
 211 CALENDARSUPPORT_EXPORT QDrag *createDrag(const Akonadi::Item::List &items,
 212         const KDateTime::Spec &timeSpec, QWidget *parent);
 213 #endif
 214 /**
 215   Applies a filter to a list of items containing incidences.
 216   Items not containing incidences or not matching the filter are removed.
 217   Helper method anologous to KCalCore::CalFilter::apply()
 218   @see KCalCore::CalFilter::apply()
 219   @param items the list of items to filter
 220   @param filter the filter to apply to the list of items
 221   @return the filtered list of items
 222 */
 223 CALENDARSUPPORT_EXPORT Akonadi::Item::List applyCalFilter(const Akonadi::Item::List &items,
 224         const KCalCore::CalFilter *filter);
 225
 226 /**
 227   Shows a modal dialog that allows to select a collection.
 228
 229   @param will contain the dialogCode, QDialog::Accepted if the user pressed Ok,
 230   QDialog::Rejected otherwise
 231   @param parent The optional parent of the modal dialog.
 232   @return The select collection or an invalid collection if
 233   there was no collection selected.
 234 */
 235 CALENDARSUPPORT_EXPORT Akonadi::Collection selectCollection(
 236     QWidget *parent, int &dialogCode,
 237     const QStringList &mimeTypes,
 238     const Akonadi::Collection &defaultCollection = Akonadi::Collection());
 239
 240 CALENDARSUPPORT_EXPORT Akonadi::Item itemFromIndex(const QModelIndex &index);
 241
 242 CALENDARSUPPORT_EXPORT Akonadi::Item::List itemsFromModel(
 243     const QAbstractItemModel *model,
 244     const QModelIndex &parentIndex = QModelIndex(),
 245     int start = 0,
 246     int end = -1);
 247
 248 CALENDARSUPPORT_EXPORT Akonadi::Collection::List collectionsFromModel(
 249     const QAbstractItemModel *model,
 250     const QModelIndex &parentIndex = QModelIndex(),
 251     int start = 0,
 252     int end = -1);
 253
 254 CALENDARSUPPORT_EXPORT Akonadi::Collection collectionFromIndex(const QModelIndex &index);
 255
 256 CALENDARSUPPORT_EXPORT Akonadi::Collection::Id collectionIdFromIndex(const QModelIndex &index);
 257
 258 CALENDARSUPPORT_EXPORT Akonadi::Collection::List collectionsFromIndexes(
 259     const QModelIndexList &indexes);
 260
 261 CALENDARSUPPORT_EXPORT QString displayName(Akonadi::ETMCalendar *calendar,
 262         const Akonadi::Collection &coll);
 263
 264 CALENDARSUPPORT_EXPORT QString subMimeTypeForIncidence(
 265     const KCalCore::Incidence::Ptr &incidence);
 266
 267 /**
 268  * Returns a list containing work days between @p start and @end.
 269  */
 270 CALENDARSUPPORT_EXPORT QList<QDate> workDays(const QDate &start, const QDate &end);
 271
 272 /**
 273  * Returns a list of holidays that occur at @param date.
 274  */
 275 CALENDARSUPPORT_EXPORT QStringList holiday(const QDate &date);
 276
 277 CALENDARSUPPORT_EXPORT void saveAttachments(const Akonadi::Item &item,
 278         QWidget *widget = Q_NULLPTR);
 279
 280 CALENDARSUPPORT_EXPORT QStringList categories(const KCalCore::Incidence::List &incidences);
 281
 282 CALENDARSUPPORT_EXPORT bool mergeCalendar(const QString &srcFilename, const KCalCore::Calendar::Ptr &destCalendar);
 283 }
 284
 285 #endif