Akonadi::AgentActionManager Class Reference

#include <agentactionmanager.h>

Inherits QObject.

Public Types
enum	TextContext {   DialogTitle, DialogText, MessageBoxTitle, MessageBoxText,   MessageBoxAlternativeText, ErrorMessageTitle, ErrorMessageText }
enum	Type { CreateAgentInstance, DeleteAgentInstance, ConfigureAgentInstance, LastType }

Signals
void	actionStateUpdated ()

Public Member Functions
	AgentActionManager (KActionCollection *actionCollection, QWidget *parent=0)
	~AgentActionManager ()
KAction *	action (Type type) const
KAction *	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 QString &text)
void	setContextText (Type type, TextContext context, const KLocalizedString &text)
void	setMimeTypeFilter (const QStringList &mimeTypes)
void	setSelectionModel (QItemSelectionModel *model)

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 43 of file agentactionmanager.h.

Member Enumeration Documentation

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 60 of file agentactionmanager.h.

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 50 of file agentactionmanager.h.

Constructor & Destructor Documentation

Akonadi::AgentActionManager::AgentActionManager ( KActionCollection *  actionCollection, QWidget *  parent = 0  )

explicit

Creates a new agent action manager.

Parameters

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

Akonadi::AgentActionManager::~AgentActionManager

(

)

Destroys the agent action manager.

Member Function Documentation

KAction* Akonadi::AgentActionManager::action

(

Type

type

)

const

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

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.

KAction* Akonadi::AgentActionManager::createAction

(

Type

type

)

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

void Akonadi::AgentActionManager::createAllActions

(

)

Convenience method to create all standard actions.

See also

createAction()

void Akonadi::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

Akonadi::AgentInstance::List Akonadi::AgentActionManager::selectedAgentInstances

(

)

const

Returns the list of agent instances that are currently selected.

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

Since

4.6

void Akonadi::AgentActionManager::setCapabilityFilter

(

const QStringList &

capabilities

)

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

void Akonadi::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

void Akonadi::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

void Akonadi::AgentActionManager::setMimeTypeFilter

(

const QStringList &

mimeTypes

)

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

void Akonadi::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

---

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

• agentactionmanager.h