• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • AgentActionManager
Public Types | Signals | Public Member Functions | List of all members
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

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

Creates a new agent action manager.

Parameters
actionCollectionThe action collection to operate on.
parentThe 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.

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 * 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
interceptIf false, the default implementation will be executed, if true 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:
  • agentactionmanager.h
  • agentactionmanager.cpp
This file is part of the KDE documentation.
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.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal