File indexing completed on 2025-01-05 04:47:07

 /*
     SPDX-FileCopyrightText: 2008 Ingo Klöcker <kloecker@kde.org>
     SPDX-FileCopyrightText: 2010-2024 Laurent Montel <montel@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "akonadiwidgets_export.h"
 // AkonadiCore
 #include "akonadi/collection.h"
 
 #include <QAbstractItemView>
 #include <QDialog>
 
 #include <memory>
 
 namespace Akonadi
 {
 class CollectionDialogPrivate;
 
 /**
  * @short A collection selection dialog.
  *
  * Provides a dialog that lists collections that are available
  * on the Akonadi storage and allows the selection of one or multiple
  * collections.
  *
  * The list of shown collections can be filtered by mime type and access
  * rights. Note that mime types are not enabled by default, so
  * setMimeTypeFilter() must be called to enable the desired mime types.
  *
  * Example:
  *
  * @code
  *
  * using namespace Akonadi;
  *
  * // Show the user a dialog to select a writable collection of contacts
  * CollectionDialog dlg( this );
  * dlg.setMimeTypeFilter( QStringList() << KContacts::Addressee::mimeType() );
  * dlg.setAccessRightsFilter( Collection::CanCreateItem );
  * dlg.setDescription( i18n( "Select an address book for saving:" ) );
  *
  * if ( dlg.exec() ) {
  *   const Collection collection = dlg.selectedCollection();
  *   ...
  * }
  *
  * @endcode
  *
  * @author Ingo Klöcker <kloecker@kde.org>
  * @since 4.3
  */
 class AKONADIWIDGETS_EXPORT CollectionDialog : public QDialog
 {
     Q_OBJECT
     Q_DISABLE_COPY(CollectionDialog)
 
 public:
     /* @since 4.6
      */
     enum CollectionDialogOption {
         None = 0,
         AllowToCreateNewChildCollection = 1,
         KeepTreeExpanded = 2,
     };
 
     Q_DECLARE_FLAGS(CollectionDialogOptions, CollectionDialogOption)
 
     /**
      * Creates a new collection dialog.
      *
      * @param parent The parent widget.
      */
     explicit CollectionDialog(QWidget *parent = nullptr);
 
     /**
      * Creates a new collection dialog with a custom @p model.
      *
      * The filtering by content mime type and access rights is done
      * on top of the custom model.
      *
      * @param model The custom model to use.
      * @param parent The parent widget.
      *
      * @since 4.4
      */
     explicit CollectionDialog(QAbstractItemModel *model, QWidget *parent = nullptr);
 
     /**
      * Creates a new collection dialog with a custom @p model.
      *
      * The filtering by content mime type and access rights is done
      * on top of the custom model.
      *
      * @param options The collection dialog options.
      * @param model The custom model to use.
      * @param parent The parent widget.
      *
      * @since 4.6
      */
 
     explicit CollectionDialog(CollectionDialogOptions options, QAbstractItemModel *model = nullptr, QWidget *parent = nullptr);
 
     /**
      * Destroys the collection dialog.
      */
     ~CollectionDialog() override;
 
     /**
      * Sets the mime types any of which the selected collection(s) shall support.
      * Note that mime types are not enabled by default.
      * @param mimeTypes MIME type filter values
      */
     void setMimeTypeFilter(const QStringList &mimeTypes);
 
     /**
      * Returns the mime types any of which the selected collection(s) shall support.
      */
     [[nodiscard]] QStringList mimeTypeFilter() const;
 
     /**
      * Sets the access @p rights that the listed collections shall match with.
      * @param rights access rights filter values
      * @since 4.4
      */
     void setAccessRightsFilter(Collection::Rights rights);
 
     /**
      * Sets the access @p rights that the listed collections shall match with.
      *
      * @since 4.4
      */
     [[nodiscard]] Collection::Rights accessRightsFilter() const;
 
     /**
      * Sets the @p text that will be shown in the dialog.
      * @param text the dialog's description text
      * @since 4.4
      */
     void setDescription(const QString &text);
 
     /**
      * Sets the @p collection that shall be selected by default.
      * @param collection the dialog's pre-selected collection
      * @since 4.4
      */
     void setDefaultCollection(const Collection &collection);
 
     /**
      * Sets the selection mode. The initial default mode is
      * QAbstractItemView::SingleSelection.
      * @param mode the selection mode to use
      * @see QAbstractItemView::setSelectionMode()
      */
     void setSelectionMode(QAbstractItemView::SelectionMode mode);
 
     /**
      * Returns the selection mode.
      * @see QAbstractItemView::selectionMode()
      */
     [[nodiscard]] QAbstractItemView::SelectionMode selectionMode() const;
 
     /**
      * Returns the selected collection if the selection mode is
      * QAbstractItemView::SingleSelection. If another selection mode was set,
      * or nothing is selected, an invalid collection is returned.
      */
     [[nodiscard]] Akonadi::Collection selectedCollection() const;
 
     /**
      * Returns the list of selected collections.
      */
     [[nodiscard]] Akonadi::Collection::List selectedCollections() const;
 
     /**
      * Change collection dialog options.
      * @param options the collection dialog options to change
      * @since 4.6
      */
     void changeCollectionDialogOptions(CollectionDialogOptions options);
 
     /**
      * @since 4.13
      */
     void setUseFolderByDefault(bool b);
     /**
      * @since 4.13
      */
     [[nodiscard]] bool useFolderByDefault() const;
     /**
      * Allow to specify collection content mimetype when we create new one.
      * @since 4.14.6
      */
     void setContentMimeTypes(const QStringList &mimetypes);
 
 private:
     /// @cond PRIVATE
     std::unique_ptr<CollectionDialogPrivate> const d;
     /// @endcond
 };
 
 } // namespace Akonadi