Akonadi::AgentInstanceFilterProxyModel Class

class Akonadi::AgentInstanceFilterProxyModel

A proxy model for filtering AgentType or AgentInstance. More...

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

List of all members, including inherited members

Public Functions

	AgentInstanceFilterProxyModel(QObject *parent = nullptr)
virtual	~AgentInstanceFilterProxyModel() override
Akonadi::AccountActivitiesAbstract *	accountActivitiesAbstract() const
void	addCapabilityFilter(const QString &capability)
void	addMimeTypeFilter(const QString &mimeType)
void	clearFilters()
bool	enablePlasmaActivities() const
void	excludeCapabilities(const QString &capability)
void	setAccountActivitiesAbstract(Akonadi::AccountActivitiesAbstract *abstract)
void	setEnablePlasmaActivities(bool newEnablePlasmaActivities)

Detailed Description

This filter proxy model works on top of a AgentTypeModel or AgentInstanceModel and can be used to show only AgentType or AgentInstance objects which provide a given mime type or capability.

 // Show only running agent instances that provide contacts
 Akonadi::AgentInstanceModel *model = new Akonadi::AgentInstanceModel( this );

 Akonadi::AgentInstanceFilterProxyModel *proxy = new Akonadi::AgentInstanceFilterProxyModel( this );
 proxy->addMimeTypeFilter( "text/directory" );

 proxy->setSourceModel( model );

 QListView *view = new QListView( this );
 view->setModel( proxy );

Author: Volker Krause <vkrause@kde.org>

Member Function Documentation

`[explicit]` AgentInstanceFilterProxyModel::AgentInstanceFilterProxyModel(QObject **parent* = nullptr)

Create a new agent filter proxy model. By default no filtering is done. parent parent object

`[override virtual noexcept]` AgentInstanceFilterProxyModel::~AgentInstanceFilterProxyModel()

Destroys the agent filter proxy model.

Akonadi::AccountActivitiesAbstract *AgentInstanceFilterProxyModel::accountActivitiesAbstract() const

See also setAccountActivitiesAbstract().

void AgentInstanceFilterProxyModel::addCapabilityFilter(const QString &capability)

Accept agents with the given capability.

void AgentInstanceFilterProxyModel::addMimeTypeFilter(const QString &mimeType)

Accept agents supporting mimeType.

void AgentInstanceFilterProxyModel::clearFilters()

Clear the filters ( mimeTypes & capabilities ).

bool AgentInstanceFilterProxyModel::enablePlasmaActivities() const

See also setEnablePlasmaActivities().

void AgentInstanceFilterProxyModel::excludeCapabilities(const QString &capability)

Excludes agents with the given capability. capability undesired agent capability

void AgentInstanceFilterProxyModel::setAccountActivitiesAbstract(Akonadi::AccountActivitiesAbstract **abstract*)

See also accountActivitiesAbstract().

void AgentInstanceFilterProxyModel::setEnablePlasmaActivities(bool newEnablePlasmaActivities)

See also enablePlasmaActivities().

Contents