collectiondialog.h

/*
    Copyright 2008 Ingo Klöcker <kloecker@kde.org>
    Copyright 2010-2019 Laurent Montel <montel@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#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;

    Q_PRIVATE_SLOT(d, void slotSelectionChanged())
    Q_PRIVATE_SLOT(d, void slotAddChildCollection())
    Q_PRIVATE_SLOT(d, void slotDoubleClicked())
    //@endcond
};

} // namespace Akonadi

#endif // AKONADI_COLLECTIONDIALOG_H