• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. KDE PIM
  3. Akonadi
  • KDE Home
  • Contact Us

Quick Links

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

Class Picker

About

PIM Storage Framework

Maintainer
Daniel Vrátil
Supported platforms
Linux
Community
IRC: #akonadi on Freenode
Mailing list: kde-pim
Use with CMake
find_package(KF5AkonadiCore)
target_link_libraries(yourapp KF5::AkonadiCore)
Use with QMake
QT += AkonadiCore 
Clone
git clone git://anongit.kde.org/akonadi.git
Browse source
Akonadi on cgit.kde.org

Akonadi

  • View on LXR
  • Akonadi
  • AgentActionManager
Public Types | Signals | Public Member Functions | List of all members
Akonadi::AgentActionManager Class Reference

#include <agentactionmanager.h>

Inheritance diagram for Akonadi::AgentActionManager:
Inheritance graph
[legend]

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=nullptr)
 
 ~AgentActionManager ()
 
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 QString &text)
 
void setContextText (Type type, TextContext context, const KLocalizedString &text)
 
void setMimeTypeFilter (const QStringList &mimeTypes)
 
void setSelectionModel (QItemSelectionModel *model)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectList & children () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
 
bool inherits (const char *className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType)
 
QThread * thread () 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (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
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Manages generic actions for agent and agent instance views.

Author
Tobias Koenig tokoe[email protected]@kde[email protected].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 = nullptr 
)
explicit

Creates a new agent action manager.

Parameters
actionCollectionThe action collection to operate on.
parentThe parent widget.
Akonadi::AgentActionManager::~AgentActionManager ( )

Destroys the agent action manager.

Member Function Documentation

QAction* 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.

QAction* 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
typeaction 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
interceptIf 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
typeaction type
contextcontext of the given action
texttext 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
typeaction type
contextcontext of the given action type
textlocalized 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
modelmodel based on which actions should operate

The documentation for this class was generated from the following file:
  • agentactionmanager.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Tue Dec 10 2019 03:42:11 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

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