akonadi
#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.
- Since
- 4.6
Definition at line 43 of file agentactionmanager.h.
Member Enumeration Documentation
Describes the text context that can be customized.
Definition at line 60 of file agentactionmanager.h.
Describes the supported actions.
Definition at line 50 of file agentactionmanager.h.
Constructor & Destructor Documentation
|
explicit |
Creates a new agent action manager.
- Parameters
-
actionCollection The action collection to operate on. parent The parent widget.
Definition at line 255 of file agentactionmanager.cpp.
AgentActionManager::~AgentActionManager | ( | ) |
Destroys the agent action manager.
Definition at line 263 of file agentactionmanager.cpp.
Member Function Documentation
KAction * AgentActionManager::action | ( | Type | type | ) | const |
Returns the action of the given type, 0 if it has not been created (yet).
Definition at line 320 of file agentactionmanager.cpp.
|
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 * 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.
Definition at line 285 of file agentactionmanager.cpp.
void AgentActionManager::createAllActions | ( | ) |
Convenience method to create all standard actions.
- See Also
- createAction()
Definition at line 313 of file agentactionmanager.cpp.
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, iftrue
no action is taken.
- Since
- 4.6
Definition at line 326 of file agentactionmanager.cpp.
AgentInstance::List 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
Definition at line 343 of file agentactionmanager.cpp.
void AgentActionManager::setCapabilityFilter | ( | const QStringList & | capabilities | ) |
Sets the capability filter that will be used when creating new agent instances.
Definition at line 280 of file agentactionmanager.cpp.
void AgentActionManager::setContextText | ( | Type | type, |
TextContext | context, | ||
const QString & | text | ||
) |
Sets the text
of the action type
for the given context
.
- Since
- 4.6
Definition at line 348 of file agentactionmanager.cpp.
void AgentActionManager::setContextText | ( | Type | type, |
TextContext | context, | ||
const KLocalizedString & | text | ||
) |
Sets the text
of the action type
for the given context
.
- Since
- 4.8
Definition at line 353 of file agentactionmanager.cpp.
void AgentActionManager::setMimeTypeFilter | ( | const QStringList & | mimeTypes | ) |
Sets the mime type filter that will be used when creating new agent instances.
Definition at line 275 of file agentactionmanager.cpp.
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.
Definition at line 268 of file agentactionmanager.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:27:45 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.