File indexing completed on 2024-05-26 04:49:09

 // SPDX-FileCopyrightText: 2007-2009 Tobias Koenig <tokoe@kde.org>
 // SPDX-License-Identifier: LGPL-2.0-or-later
 
 #pragma once
 
 #include <Akonadi/Collection>
 #include <QSortFilterProxyModel>
 #include <memory>
 #include <qobjectdefs.h>
 #include <QQmlEngine>
 
 namespace Akonadi
 {
 namespace Quick
 {
 class CollectionComboBoxModelPrivate;
 
 /**
  * @short The model for a combobox for selecting an Akonadi collection.
  *
  * This model provides a way easily select a collection
  * from the Akonadi storage.
  * The available collections can be filtered by mime type and
  * access rights.
  *
  * Example:
  *
  * @code{.qml}
  *
  * import QtQuick.Controls 2.15 as QQC2
  * import org.kde.akonadi 1.0 as Akonadi
  *
  * QQC2.ComboBox {
  *     model: AkonadiQuick.ComboBoxModel {
  *         mimeTypeFilter: [Akonadi.MimeTypes.address, Akonadi.MimeTypes.contactGroup]
  *         accessRightsFilter: Akonadi.Collection.CanCreateItem
  *     }
  * }
  * @endcode
  *
  * @author Carl Schwan <carl@carlschwan.eu>
  */
 class CollectionComboBoxModel : public QSortFilterProxyModel
 {
     Q_OBJECT
     QML_ELEMENT
     Q_PROPERTY(QStringList mimeTypeFilter READ mimeTypeFilter WRITE setMimeTypeFilter NOTIFY mimeTypeFilterChanged)
     Q_PROPERTY(int accessRightsFilter READ accessRightsFilter WRITE setAccessRightsFilter NOTIFY accessRightsFilterChanged)
 
     Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentIndexChanged)
     Q_PROPERTY(qint64 defaultCollectionId READ defaultCollectionId WRITE setDefaultCollectionId NOTIFY defaultCollectionIdChanged)
 
 public:
     explicit CollectionComboBoxModel(QObject *parent = nullptr);
     ~CollectionComboBoxModel() override;
 
     /**
      * Sets the content @p mimetypes the collections shall be filtered by.
      */
     void setMimeTypeFilter(const QStringList &mimetypes);
 
     /**
      * Returns the content mimetype the collections are filtered by.
      * Don't assume this list has the original order.
      */
     Q_REQUIRED_RESULT QStringList mimeTypeFilter() const;
 
     /**
      * Sets the access @p rights the collections shall be filtered by.
      */
     void setAccessRightsFilter(int rights);
 
     /**
      * Returns the access rights the collections are filtered by.
      */
     Q_REQUIRED_RESULT int accessRightsFilter() const;
 
     /**
      * Return the default collection id.
      */
     qint64 defaultCollectionId() const;
 
     /**
      * Sets the @p collection that shall be selected by default.
      */
     void setDefaultCollectionId(qint64 collectionId);
 
     /**
      * Sets if the virtual collections are excluded.
      */
     void setExcludeVirtualCollections(bool b);
 
     /**
      * Returns if the virual exollections are excluded
      */
     Q_REQUIRED_RESULT bool excludeVirtualCollections() const;
 
     int currentIndex() const;
     void setCurrentIndex(int currendIndex);
 
 Q_SIGNALS:
     void mimeTypeFilterChanged();
     void accessRightsFilterChanged();
     void defaultCollectionIdChanged();
     void currentIndexChanged();
 
 private:
     std::unique_ptr<CollectionComboBoxModelPrivate> const d;
 };
 
 }
 }