collectiondialog.h

/*
    SPDX-FileCopyrightText: 2008 Ingo Klöcker <[email protected]>
    SPDX-FileCopyrightText: 2010-2020 Laurent Montel <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef AKONADI_COLLECTIONDIALOG_H
#define AKONADI_COLLECTIONDIALOG_H

#include "akonadiwidgets_export.h"
#include "collection.h"

#include <QDialog>
#include <QAbstractItemView>

namespace Akonadi
{

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)

    
    explicit CollectionDialog(QWidget *parent = nullptr);

    explicit CollectionDialog(QAbstractItemModel *model, QWidget *parent = nullptr);

    explicit CollectionDialog(CollectionDialogOptions options, QAbstractItemModel *model = nullptr, QWidget *parent = nullptr);

    ~CollectionDialog();

    void setMimeTypeFilter(const QStringList &mimeTypes);

    Q_REQUIRED_RESULT QStringList mimeTypeFilter() const;

    void setAccessRightsFilter(Collection::Rights rights);

    Q_REQUIRED_RESULT Collection::Rights accessRightsFilter() const;

    void setDescription(const QString &text);

    void setDefaultCollection(const Collection &collection);

    void setSelectionMode(QAbstractItemView::SelectionMode mode);

    Q_REQUIRED_RESULT QAbstractItemView::SelectionMode selectionMode() const;

    Q_REQUIRED_RESULT Akonadi::Collection selectedCollection() const;

    Q_REQUIRED_RESULT Akonadi::Collection::List selectedCollections() const;

    void changeCollectionDialogOptions(CollectionDialogOptions options);

    void setUseFolderByDefault(bool b);
    Q_REQUIRED_RESULT bool useFolderByDefault() const;
    void setContentMimeTypes(const QStringList &mimetypes);

private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

} // namespace Akonadi

#endif // AKONADI_COLLECTIONDIALOG_H