Akonadi::CollectionRequester Class

Header: #include <Akonadi/CollectionRequester>
CMake: find_package(KPim6 REQUIRED COMPONENTS AkonadiWidgets)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiWidgets)

Public Functions

CollectionRequester(QWidget *parent = nullptr)
CollectionRequester(const Akonadi::Collection &collection, QWidget *parent = nullptr)
virtual ~CollectionRequester() override
Akonadi::Collection::Rights accessRightsFilter() const
void changeCollectionDialogOptions(Akonadi::CollectionDialog::CollectionDialogOptions options)
Akonadi::Collection collection() const
QStringList mimeTypeFilter() const
void setAccessRightsFilter(Akonadi::Collection::Rights rights)
void setContentMimeTypes(const QStringList &mimetypes)
void setMimeTypeFilter(const QStringList &mimeTypes)

Public Slots

void setCollection(const Akonadi::Collection &collection)

Signals

void collectionChanged(const Akonadi::Collection &collection)

Member Function Documentation

[explicit] CollectionRequester::CollectionRequester(QWidget *parent = nullptr)

Creates a collection requester.

parent The parent widget.

[explicit] CollectionRequester::CollectionRequester(const Akonadi::Collection &collection, QWidget *parent = nullptr)

Creates a collection requester with an initial collection.

collection The initial collection. parent The parent widget.

[override virtual noexcept] CollectionRequester::~CollectionRequester()

Destroys the collection requester.

Akonadi::Collection::Rights CollectionRequester::accessRightsFilter() const

Returns the access rights that the listed collections shall match with.

See also setAccessRightsFilter().

void CollectionRequester::changeCollectionDialogOptions(Akonadi::CollectionDialog::CollectionDialogOptions options)

options new collection dialog options

Akonadi::Collection CollectionRequester::collection() const

Returns the currently chosen collection, or an empty collection if none none was chosen.

See also setCollection().

[signal] void CollectionRequester::collectionChanged(const Akonadi::Collection &collection)

This signal is emitted when the selected collection has changed.

collection The selected collection.

QStringList CollectionRequester::mimeTypeFilter() const

Returns the mime types any of which the selected collection shall support.

See also setMimeTypeFilter().

void CollectionRequester::setAccessRightsFilter(Akonadi::Collection::Rights rights)

Sets the access rights that the listed collections shall match with. rights the access rights to set

See also accessRightsFilter().

[slot] void CollectionRequester::setCollection(const Akonadi::Collection &collection)

Sets the collection of the requester.

See also collection().

void CollectionRequester::setContentMimeTypes(const QStringList &mimetypes)

Allow to specify collection content mimetype when we create new one.

void CollectionRequester::setMimeTypeFilter(const QStringList &mimeTypes)

Sets the mime types any of which the selected collection shall support.

See also mimeTypeFilter().