Akonadi::AgentInstanceWidget Class

Provides a widget that lists all available agent instances. More...

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

List of all members, including inherited members

Public Functions

	AgentInstanceWidget(QWidget *parent = nullptr)
virtual	~AgentInstanceWidget() override
Akonadi::AccountActivitiesAbstract *	accountActivitiesAbstract() const
Akonadi::AgentInstanceFilterProxyModel *	agentInstanceFilterProxyModel() const
Akonadi::AgentInstance	currentAgentInstance() const
bool	enablePlasmaActivities() const
QList<Akonadi::AgentInstance>	selectedAgentInstances() const
void	setAccountActivitiesAbstract(Akonadi::AccountActivitiesAbstract *abstract)
void	setEnablePlasmaActivities(bool newEnablePlasmaActivities)
QAbstractItemView *	view() const

Signals

void	clicked(const Akonadi::AgentInstance &current)
void	currentChanged(const Akonadi::AgentInstance &current, const Akonadi::AgentInstance &previous)
void	doubleClicked(const Akonadi::AgentInstance &current)

Detailed Description

The widget is listening on the dbus for changes, so the widget is updated automatically as soon as new agent instances are added to or removed from the system.

 MyWidget::MyWidget( QWidget *parent )
   : QWidget( parent )
 {
   QVBoxLayout *layout = new QVBoxLayout( this );

   mAgentInstanceWidget = new Akonadi::AgentInstanceWidget( this );
   layout->addWidget( mAgentInstanceWidget );

   connect( mAgentInstanceWidget, SIGNAL(doubleClicked(Akonadi::AgentInstance)),
            this, SLOT(slotInstanceSelected(Akonadi::AgentInstance)) );
 }

 ...

 MyWidget::slotInstanceSelected( Akonadi::AgentInstance &instance )
 {
   qCDebug(AKONADIWIDGETS_LOG) << "Selected instance" << instance.name();
 }

Author: Tobias Koenig <tokoe@kde.org>

Member Function Documentation

`[explicit]` AgentInstanceWidget::AgentInstanceWidget(QWidget **parent* = nullptr)

Creates a new agent instance widget.

parent The parent widget.

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

Destroys the agent instance widget.

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

See also setAccountActivitiesAbstract().

Akonadi::AgentInstanceFilterProxyModel *AgentInstanceWidget::agentInstanceFilterProxyModel() const

Returns the agent filter proxy model, use this to filter by agent mimetype or capabilities.

`[signal]` void AgentInstanceWidget::clicked(const Akonadi::AgentInstance &current)

This signal is emitted whenever there is a click on an agent instance.

current The current agent instance.

Akonadi::AgentInstance AgentInstanceWidget::currentAgentInstance() const

Returns the current agent instance or an invalid agent instance if no agent instance is selected.

`[signal]` void AgentInstanceWidget::currentChanged(const Akonadi::AgentInstance &current, const Akonadi::AgentInstance &previous)

This signal is emitted whenever the current agent instance changes.

current The current agent instance. previous The previous agent instance.

`[signal]` void AgentInstanceWidget::doubleClicked(const Akonadi::AgentInstance &current)

This signal is emitted whenever there is a double click on an agent instance.

current The current agent instance.

bool AgentInstanceWidget::enablePlasmaActivities() const

See also setEnablePlasmaActivities().

QList<Akonadi::AgentInstance> AgentInstanceWidget::selectedAgentInstances() const

Returns the selected agent instances.

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

See also accountActivitiesAbstract().

void AgentInstanceWidget::setEnablePlasmaActivities(bool newEnablePlasmaActivities)

See also enablePlasmaActivities().

QAbstractItemView *AgentInstanceWidget::view() const

Returns the view used in the widget.

Contents