Akonadi::AgentActionManager Class Reference

#include <agentactionmanager.h>

Inheritance diagram for Akonadi::AgentActionManager:

Public Types
enum	TextContext {   DialogTitle , DialogText , MessageBoxTitle , MessageBoxText ,   MessageBoxAlternativeText , ErrorMessageTitle , ErrorMessageText }
enum	Type { CreateAgentInstance , DeleteAgentInstance , ConfigureAgentInstance , LastType }
Public Types inherited from QObject
typedef	QObjectList

Signals
void	actionStateUpdated ()

Public Member Functions
	AgentActionManager (KActionCollection *actionCollection, QWidget *parent=nullptr)
	~AgentActionManager () override
QAction *	action (Type type) const
QAction *	createAction (Type type)
void	createAllActions ()
void	interceptAction (Type type, bool intercept=true)
Akonadi::AgentInstance::List	selectedAgentInstances () const
void	setCapabilityFilter (const QStringList &capabilities)
void	setContextText (Type type, TextContext context, const KLocalizedString &text)
void	setContextText (Type type, TextContext context, const QString &text)
void	setMimeTypeFilter (const QStringList &mimeTypes)
void	setSelectionModel (QItemSelectionModel *model)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Manages generic actions for agent and agent instance views.

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.6

Definition at line 33 of file agentactionmanager.h.

Member Enumeration Documentation

TextContext

enum Akonadi::AgentActionManager::TextContext

Describes the text context that can be customized.

Enumerator
DialogTitle	The window title of a dialog.
DialogText	The text of a dialog.
MessageBoxTitle	The window title of a message box.
MessageBoxText	The text of a message box.
MessageBoxAlternativeText	An alternative text of a message box.
ErrorMessageTitle	The window title of an error message.
ErrorMessageText	The text of an error message.

Definition at line 50 of file agentactionmanager.h.

Type

enum Akonadi::AgentActionManager::Type

Describes the supported actions.

Enumerator
CreateAgentInstance	Creates an agent instance.
DeleteAgentInstance	Deletes the selected agent instance.
ConfigureAgentInstance	Configures the selected agent instance.
LastType	Marks last action.

Definition at line 40 of file agentactionmanager.h.

Constructor & Destructor Documentation

AgentActionManager()

AgentActionManager::AgentActionManager ( KActionCollection * actionCollection, QWidget * parent = nullptr )

explicit

Creates a new agent action manager.

Parameters

actionCollection	The action collection to operate on.
parent	The parent widget.

Definition at line 217 of file agentactionmanager.cpp.

~AgentActionManager()

AgentActionManager::~AgentActionManager ( )

overridedefault

Destroys the agent action manager.

Member Function Documentation

action()

QAction * AgentActionManager::action ( Type type ) const

nodiscard

Returns the action of the given type, 0 if it has not been created (yet).

Definition at line 281 of file agentactionmanager.cpp.

actionStateUpdated

void Akonadi::AgentActionManager::actionStateUpdated ( )

signal

This signal is emitted whenever the action state has been updated.

In case you have special needs for changing the state of some actions, connect to this signal and adjust the action state.

createAction()

QAction * AgentActionManager::createAction ( Type type )

nodiscard

Creates the action of the given type and adds it to the action collection specified in the constructor if it does not exist yet.

The action is connected to its default implementation provided by this class.

Parameters

type	action type

Definition at line 245 of file agentactionmanager.cpp.

createAllActions()

void AgentActionManager::createAllActions

(

)

Convenience method to create all standard actions.

See also

createAction()

Definition at line 273 of file agentactionmanager.cpp.

interceptAction()

void AgentActionManager::interceptAction	(	Type	type,
		bool	intercept = true )

Sets whether the default implementation for the given action type shall be executed when the action is triggered.

Parameters

intercept

If false, the default implementation will be executed, if true no action is taken.

Since

4.6

Definition at line 287 of file agentactionmanager.cpp.

selectedAgentInstances()

AgentInstance::List AgentActionManager::selectedAgentInstances ( ) const

nodiscard

Returns the list of agent instances that are currently selected.

The list is empty if no agent instance is currently selected.

Since

4.6

Definition at line 304 of file agentactionmanager.cpp.

setCapabilityFilter()

void AgentActionManager::setCapabilityFilter

(

const QStringList &

capabilities

)

Sets the capability filter that will be used when creating new agent instances.

Definition at line 240 of file agentactionmanager.cpp.

setContextText() [1/2]

void AgentActionManager::setContextText	(	Type	type,
		TextContext	context,
		const KLocalizedString &	text )

Sets the text of the action type for the given context.

Since

4.8

Parameters

type	action type
context	context of the given action type
text	localized text for the given action type

Definition at line 314 of file agentactionmanager.cpp.

setContextText() [2/2]

void AgentActionManager::setContextText	(	Type	type,
		TextContext	context,
		const QString &	text )

Sets the text of the action type for the given context.

Parameters

type	action type
context	context of the given action
text	text for the given action type

Since

4.6

Definition at line 309 of file agentactionmanager.cpp.

setMimeTypeFilter()

void AgentActionManager::setMimeTypeFilter

(

const QStringList &

mimeTypes

)

Sets the mime type filter that will be used when creating new agent instances.

Definition at line 235 of file agentactionmanager.cpp.

setSelectionModel()

void AgentActionManager::setSelectionModel

(

QItemSelectionModel *

model

)

Sets the agent selection model based on which the actions should operate.

If none is set, all actions will be disabled.

Parameters

model

model based on which actions should operate

Definition at line 227 of file agentactionmanager.cpp.

---

The documentation for this class was generated from the following files:

• agentactionmanager.h
• agentactionmanager.cpp