Akonadi::RecursiveCollectionFilterProxyModel Class

class Akonadi::RecursiveCollectionFilterProxyModel

A model to filter out collections of non-matching content types. More...

Header: #include <Akonadi/RecursiveCollectionFilterProxyModel>
CMake: find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore)
Inherits: QSortFilterProxyModel

Public Functions

RecursiveCollectionFilterProxyModel(QObject *parent = nullptr)
virtual ~RecursiveCollectionFilterProxyModel() override
void addContentMimeTypeInclusionFilter(const QString &mimeType)
void addContentMimeTypeInclusionFilters(const QStringList &mimeTypes)
void clearFilters()
QStringList contentMimeTypeInclusionFilters() const
void setContentMimeTypeInclusionFilters(const QStringList &mimeTypes)
void setExcludeUnifiedMailBox(bool exclude)
void setIncludeCheckedOnly(bool checked)
void setSearchPattern(const QString &pattern)

Detailed Description

Author: Stephen Kelly <steveire@gmail.com>

Member Function Documentation

[explicit] RecursiveCollectionFilterProxyModel::RecursiveCollectionFilterProxyModel(QObject *parent = nullptr)

Creates a new recursive collection filter proxy model.

parent The parent object.

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

Destroys the recursive collection filter proxy model.

void RecursiveCollectionFilterProxyModel::addContentMimeTypeInclusionFilter(const QString &mimeType)

Add content mime type to be shown by the filter.

mimeType A mime type to be shown.

void RecursiveCollectionFilterProxyModel::addContentMimeTypeInclusionFilters(const QStringList &mimeTypes)

Add content mime types to be shown by the filter.

mimeTypes A list of content mime types to be included.

void RecursiveCollectionFilterProxyModel::clearFilters()

Clears the current filters.

QStringList RecursiveCollectionFilterProxyModel::contentMimeTypeInclusionFilters() const

Returns the currently included mimetypes in the filter.

See also setContentMimeTypeInclusionFilters().

void RecursiveCollectionFilterProxyModel::setContentMimeTypeInclusionFilters(const QStringList &mimeTypes)

Replace the content mime types to be shown by the filter.

mimeTypes A list of content mime types to be included.

See also contentMimeTypeInclusionFilters().

void RecursiveCollectionFilterProxyModel::setExcludeUnifiedMailBox(bool exclude)

Don't show unified mailbox

void RecursiveCollectionFilterProxyModel::setIncludeCheckedOnly(bool checked)

Show only checked item checked only shows checked item if set as \ true

void RecursiveCollectionFilterProxyModel::setSearchPattern(const QString &pattern)

Add search pattern pattern the search pattern to add