Akonadi::AgentInstanceModel Class

class Akonadi::AgentInstanceModel

Provides a data model for agent instances. More...

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

Public Types

enum Roles { TypeRole, NameRole, IconNameRole, TypeIdentifierRole, DescriptionRole, …, UserRole }

Public Functions

AgentInstanceModel(QObject *parent = nullptr)
virtual ~AgentInstanceModel() override

Detailed Description

This class provides the interface of a QAbstractItemModel to access all available agent instances: their name, identifier, supported mimetypes and capabilities.

 Akonadi::AgentInstanceModel *model = new Akonadi::AgentInstanceModel( this );

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

To show only agent instances that match a given mime type or special capabilities, use the AgentFilterProxyModel on top of this model.

Author: Tobias Koenig <tokoe@kde.org>

Member Type Documentation

enum AgentInstanceModel::Roles

Describes the roles of this model.

Member Function Documentation

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

Creates a new agent instance model.

parent The parent object.

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

Destroys the agent instance model.