kalarm/collectionmodel.h

   1 /*
   2  *  collectionmodel.h  -  Akonadi collection models
   3  *  Program:  kalarm
   4  *  Copyright © 2010-2014 by David Jarvie <djarvie@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
  21 #ifndef COLLECTIONMODEL_H
  22 #define COLLECTIONMODEL_H
  23
  24 #include "akonadimodel.h"
  25
  26 #include <kalarmcal/kacalendar.h>
  27
  28 #include <AkonadiCore/favoritecollectionsmodel.h>
  29 #include <kcheckableproxymodel.h>
  30 #include <kdescendantsproxymodel.h>
  31
  32 #include <QSortFilterProxyModel>
  33 #include <QListView>
  34
  35 using namespace KAlarmCal;
  36
  37 class QEventLoop;
  38 namespace Akonadi
  39 {
  40     class EntityMimeTypeFilterModel;
  41 }
  42
  43 /*=============================================================================
  44 = Class: CollectionListModel
  45 = Proxy model converting the AkonadiModel collection tree into a flat list.
  46 = The model may be restricted to specified content mime types.
  47 = It can optionally be restricted to writable and/or enabled Collections.
  48 =============================================================================*/
  49 class CollectionListModel : public KDescendantsProxyModel
  50 {
  51         Q_OBJECT
  52     public:
  53         explicit CollectionListModel(QObject* parent = Q_NULLPTR);
  54         void setEventTypeFilter(CalEvent::Type);
  55         void setFilterWritable(bool writable);
  56         void setFilterEnabled(bool enabled);
  57         void useCollectionColour(bool use)   { mUseCollectionColour = use; }
  58         Akonadi::Collection collection(int row) const;
  59         Akonadi::Collection collection(const QModelIndex&) const;
  60         QModelIndex collectionIndex(const Akonadi::Collection&) const;
  61         virtual bool isDescendantOf(const QModelIndex& ancestor, const QModelIndex& descendant) const;
  62         QVariant data(const QModelIndex&, int role = Qt::DisplayRole) const Q_DECL_OVERRIDE;
  63
  64     private:
  65         bool mUseCollectionColour;
  66 };
  67
  68
  69 /*=============================================================================
  70 = Class: CollectionCheckListModel
  71 = Proxy model providing a checkable list of all Collections. A Collection's
  72 = checked status is equivalent to whether it is selected or not.
  73 = An alarm type is specified, whereby Collections which are enabled for that
  74 = alarm type are checked; Collections which do not contain that alarm type, or
  75 = which are disabled for that alarm type, are unchedked.
  76 =============================================================================*/
  77 class CollectionCheckListModel : public KCheckableProxyModel
  78 {
  79         Q_OBJECT
  80     public:
  81         explicit CollectionCheckListModel(CalEvent::Type, QObject* parent = Q_NULLPTR);
  82         ~CollectionCheckListModel();
  83         Akonadi::Collection collection(int row) const;
  84         Akonadi::Collection collection(const QModelIndex&) const;
  85         QVariant data(const QModelIndex&, int role = Qt::DisplayRole) const Q_DECL_OVERRIDE;
  86         bool setData(const QModelIndex&, const QVariant& value, int role) Q_DECL_OVERRIDE;
  87
  88     Q_SIGNALS:
  89         void collectionTypeChange(CollectionCheckListModel*);
  90
  91     private Q_SLOTS:
  92         void selectionChanged(const QItemSelection& selected, const QItemSelection& deselected);
  93         void slotRowsInserted(const QModelIndex& parent, int start, int end);
  94         void collectionStatusChanged(const Akonadi::Collection&, AkonadiModel::Change, const QVariant& value, bool inserted);
  95
  96     private:
  97         void setSelectionStatus(const Akonadi::Collection&, const QModelIndex&);
  98
  99         static CollectionListModel* mModel;
 100         static int             mInstanceCount;
 101         CalEvent::Type mAlarmType;     // alarm type contained in this model
 102         QItemSelectionModel*   mSelectionModel;
 103 };
 104
 105
 106 /*=============================================================================
 107 = Class: CollectionFilterCheckListModel
 108 = Proxy model providing a checkable collection list. The model contains all
 109 = alarm types, but returns only one type at any given time. The selected alarm
 110 = type may be changed as desired.
 111 =============================================================================*/
 112 class CollectionFilterCheckListModel : public QSortFilterProxyModel
 113 {
 114         Q_OBJECT
 115     public:
 116         explicit CollectionFilterCheckListModel(QObject* parent = Q_NULLPTR);
 117         void setEventTypeFilter(CalEvent::Type);
 118         Akonadi::Collection collection(int row) const;
 119         Akonadi::Collection collection(const QModelIndex&) const;
 120         QVariant data(const QModelIndex&, int role = Qt::DisplayRole) const Q_DECL_OVERRIDE;
 121
 122     protected:
 123         bool filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const Q_DECL_OVERRIDE;
 124
 125     private Q_SLOTS:
 126         void collectionTypeChanged(CollectionCheckListModel*);
 127
 128     private:
 129         CollectionCheckListModel* mActiveModel;
 130         CollectionCheckListModel* mArchivedModel;
 131         CollectionCheckListModel* mTemplateModel;
 132         CalEvent::Type    mAlarmType;     // alarm type contained in this model
 133 };
 134
 135
 136 /*=============================================================================
 137 = Class: CollectionView
 138 = View for a CollectionFilterCheckListModel.
 139 =============================================================================*/
 140 class CollectionView : public QListView
 141 {
 142         Q_OBJECT
 143     public:
 144         explicit CollectionView(CollectionFilterCheckListModel*, QWidget* parent = Q_NULLPTR);
 145         CollectionFilterCheckListModel* collectionModel() const  { return static_cast<CollectionFilterCheckListModel*>(model()); }
 146         Akonadi::Collection  collection(int row) const;
 147         Akonadi::Collection  collection(const QModelIndex&) const;
 148
 149     protected:
 150         void setModel(QAbstractItemModel*) Q_DECL_OVERRIDE;
 151         void mouseReleaseEvent(QMouseEvent*) Q_DECL_OVERRIDE;
 152         bool viewportEvent(QEvent*) Q_DECL_OVERRIDE;
 153 };
 154
 155
 156 /*=============================================================================
 157 = Class: CollectionControlModel
 158 = Proxy model to select which Collections will be enabled. Disabled Collections
 159 = are not populated or monitored; their contents are ignored. The set of
 160 = enabled Collections is stored in the config file's "Collections" group.
 161 = Note that this model is not used directly for displaying - its purpose is to
 162 = allow collections to be disabled, which will remove them from the other
 163 = collection models.
 164 = This model also controls which collections are standard for their type,
 165 = ensuring that there is only one standard collection for any given type.
 166 =============================================================================*/
 167 class CollectionControlModel : public Akonadi::FavoriteCollectionsModel
 168 {
 169         Q_OBJECT
 170     public:
 171         static CollectionControlModel* instance();
 172
 173         /** Return whether a collection is enabled (and valid). */
 174         static bool isEnabled(const Akonadi::Collection&, CalEvent::Type);
 175
 176         /** Enable or disable a collection (if it is valid) for specified alarm types.
 177          *  Note that this only changes the status for the specified alarm types.
 178          *  @return alarm types which can be enabled
 179          */
 180         static CalEvent::Types setEnabled(const Akonadi::Collection&, CalEvent::Types, bool enabled);
 181
 182         /** Return whether a collection is both enabled and fully writable for a
 183          *  given alarm type, i.e. with create/delete/change rights and compatible
 184          *  with the current KAlarm calendar format.
 185          *  Optionally, the enabled status can be ignored.
 186          *
 187          *  @return 1 = fully enabled and writable,
 188          *          0 = enabled and writable except that backend calendar is in an
 189          *              old KAlarm format,
 190          *         -1 = read-only, disabled or incompatible format.
 191          */
 192         static int isWritableEnabled(const Akonadi::Collection&, CalEvent::Type);
 193
 194         /** Return whether a collection is both enabled and fully writable for a
 195          *  given alarm type, i.e. with create/delete/change rights and compatible
 196          *  with the current KAlarm calendar format.
 197          *  Optionally, the enabled status can be ignored.
 198          *
 199          *  @param format  If the reply is false, and the calendar is not read-only
 200          *                 but its backend calendar storage format is not the
 201          *                 current KAlarm format, @p format is set to the calendar
 202          *                 format used by the backend. If the calendar is
 203          *                 non-writable for any other reason, @p format is set
 204          *                 to KACalendar::Current.
 205          *  @return 1 = fully enabled and writable,
 206          *          0 = enabled and writable except that backend calendar is in an
 207          *              old KAlarm format,
 208          *         -1 = read-only (if @p format == KACalendar::Current), or
 209          *              disabled or incompatible format.
 210          */
 211         static int isWritableEnabled(const Akonadi::Collection&, CalEvent::Type, KACalendar::Compat& format);
 212
 213         /** Return the standard collection for a specified mime type.
 214          *  @param useDefault false to return the defined standard collection, if any;
 215          *                    true to return the standard or only collection for the type.
 216          *  Reply = invalid collection if there is no standard collection.
 217          */
 218         static Akonadi::Collection getStandard(CalEvent::Type, bool useDefault = false);
 219
 220         /** Return whether a collection is the standard collection for a specified
 221          *  mime type. */
 222         static bool isStandard(Akonadi::Collection&, CalEvent::Type);
 223
 224         /** Return the alarm type(s) for which a collection is the standard collection.
 225          *  @param useDefault false to return the defined standard types, if any;
 226          *                    true to return the types for which it is the standard or
 227          *                    only collection.
 228          */
 229         static CalEvent::Types standardTypes(const Akonadi::Collection&, bool useDefault = false);
 230
 231         /** Set or clear a collection as the standard collection for a specified
 232          *  mime type. This does not affect its status for other mime types.
 233          */
 234         static void setStandard(Akonadi::Collection&, CalEvent::Type, bool standard);
 235
 236         /** Set which mime types a collection is the standard collection for.
 237          *  Its standard status is cleared for other mime types.
 238          */
 239         static void setStandard(Akonadi::Collection&, CalEvent::Types);
 240
 241         /** Set whether the user should be prompted for the destination collection
 242          *  to add alarms to.
 243          *  @param ask true = prompt for which collection to add to;
 244          *             false = add to standard collection.
 245          */
 246         static void setAskDestinationPolicy(bool ask)  { mAskDestination = ask; }
 247
 248         /** Find the collection to be used to store an event of a given type.
 249          *  This will be the standard collection for the type, but if this is not valid,
 250          *  the user will be prompted to select a collection.
 251          *  @param noPrompt  don't prompt the user even if the standard collection is not valid
 252          *  @param cancelled If non-null: set to true if the user cancelled
 253          *             the prompt dialogue; set to false if any other error.
 254          */
 255         static Akonadi::Collection destination(CalEvent::Type, QWidget* promptparent = Q_NULLPTR, bool noPrompt = false, bool* cancelled = Q_NULLPTR);
 256
 257         /** Return the enabled collections which contain a specified mime type.
 258          *  If 'writable' is true, only writable collections are included.
 259          */
 260         static Akonadi::Collection::List enabledCollections(CalEvent::Type, bool writable);
 261
 262         /** Return the collection ID for a given resource ID.
 263          *  @return  collection ID, or -1 if the resource is not in KAlarm's list.
 264          */
 265         static Akonadi::Collection collectionForResource(const QString& resourceId);
 266
 267         /** Return whether one or all enabled collections have been populated,
 268          *  i.e. whether their items have been fetched.
 269          */
 270         static bool isPopulated(Akonadi::Collection::Id);
 271
 272         /** Wait until one or all enabled collections have been populated,
 273          *  i.e. whether their items have been fetched.
 274          *  @param   colId    collection ID, or -1 for all collections
 275          *  @param   timeout  timeout in seconds, or 0 for no timeout
 276          *  @return  true if successful.
 277          */
 278         bool waitUntilPopulated(Akonadi::Collection::Id colId = -1, int timeout = 0);
 279
 280         QVariant data(const QModelIndex&, int role = Qt::DisplayRole) const Q_DECL_OVERRIDE;
 281
 282         /** Return a bulleted list of alarm types for inclusion in an i18n message. */
 283         static QString typeListForDisplay(CalEvent::Types);
 284
 285     private Q_SLOTS:
 286         void reset();
 287         void statusChanged(const Akonadi::Collection&, AkonadiModel::Change, const QVariant& value, bool inserted);
 288         void collectionPopulated();
 289
 290     private:
 291         explicit CollectionControlModel(QObject* parent = Q_NULLPTR);
 292         void findEnabledCollections(const Akonadi::EntityMimeTypeFilterModel*, const QModelIndex& parent, Akonadi::Collection::List&) const;
 293         CalEvent::Types setEnabledStatus(const Akonadi::Collection&, CalEvent::Types, bool inserted);
 294         static CalEvent::Types checkTypesToEnable(const Akonadi::Collection&, const Akonadi::Collection::List&, CalEvent::Types);
 295
 296         static CollectionControlModel* mInstance;
 297         static bool mAskDestination;
 298         QEventLoop* mPopulatedCheckLoop;
 299 };
 300
 301 #endif // COLLECTIONMODEL_H
 302
 303 // vim: et sw=4: