Akonadi::StandardContactActionManager

Akonadi::StandardContactActionManager Class Reference

#include <standardcontactactionmanager.h>

Inheritance diagram for Akonadi::StandardContactActionManager:

Public Types

enum  Type { CreateContact = StandardActionManager::LastType + 1, CreateContactGroup, EditItem, LastType }
 

Signals

void actionStateUpdated ()
 

Public Member Functions

 StandardContactActionManager (KActionCollection *actionCollection, QWidget *parent=nullptr)
 
 ~StandardContactActionManager ()
 
QActionaction (Type type) const
 
QActionaction (StandardActionManager::Type type) const
 
QActioncreateAction (Type type)
 
QActioncreateAction (StandardActionManager::Type type)
 
void createAllActions ()
 
void interceptAction (Type type, bool intercept=true)
 
void interceptAction (StandardActionManager::Type type, bool intercept=true)
 
Akonadi::Collection::List selectedCollections () const
 
Akonadi::Item::List selectedItems () const
 
void setActionText (StandardActionManager::Type type, const KLocalizedString &text)
 
void setCollectionPropertiesPageNames (const QStringList &names)
 
void setCollectionSelectionModel (QItemSelectionModel *selectionModel)
 
void setItemSelectionModel (QItemSelectionModel *selectionModel)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () 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 *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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Manages contact specific actions for collection and item views.

Author
Tobias Koenig tokoe[email protected]@kde[email protected].org
Since
4.6

Definition at line 45 of file standardcontactactionmanager.h.

Member Enumeration Documentation

Describes the supported actions.

Enumerator
CreateContact 

Creates a new contact.

CreateContactGroup 

Creates a new contact group.

EditItem 

Edits the selected contact resp. contact group.

LastType 

Marks last action.

Definition at line 53 of file standardcontactactionmanager.h.

Constructor & Destructor Documentation

StandardContactActionManager::StandardContactActionManager ( KActionCollection actionCollection,
QWidget parent = nullptr 
)
explicit

Creates a new standard contact action manager.

Parameters
actionCollectionThe action collection to operate on.
parentThe parent widget.

Definition at line 541 of file standardcontactactionmanager.cpp.

StandardContactActionManager::~StandardContactActionManager ( )

Destroys the standard contact action manager.

Definition at line 547 of file standardcontactactionmanager.cpp.

Member Function Documentation

QAction * StandardContactActionManager::action ( Type  type) const

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

Definition at line 657 of file standardcontactactionmanager.cpp.

QAction * StandardContactActionManager::action ( StandardActionManager::Type  type) const

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

Parameters
typethe type of action to return

Definition at line 666 of file standardcontactactionmanager.cpp.

void Akonadi::StandardContactActionManager::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 * StandardContactActionManager::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
typethe type of action to create

Definition at line 582 of file standardcontactactionmanager.cpp.

QAction * StandardContactActionManager::createAction ( StandardActionManager::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
typethe type of action to create

Definition at line 635 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::createAllActions ( )

Convenience method to create all standard actions.

See also
createAction()

Definition at line 645 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::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.

Definition at line 676 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::interceptAction ( StandardActionManager::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.

Definition at line 685 of file standardcontactactionmanager.cpp.

Akonadi::Collection::List StandardContactActionManager::selectedCollections ( ) const

Returns the list of collections that are currently selected.

The list is empty if no collection is currently selected.

Definition at line 690 of file standardcontactactionmanager.cpp.

Akonadi::Item::List StandardContactActionManager::selectedItems ( ) const

Returns the list of items that are currently selected.

The list is empty if no item is currently selected.

Definition at line 695 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::setActionText ( StandardActionManager::Type  type,
const KLocalizedString text 
)

Sets the label of the action type to text, which is used during updating the action state and substituted according to the number of selected objects.

This is mainly useful to customize the label of actions that can operate on multiple objects.

Example:

ki18np( "Copy Item", "Copy %1 Items" ) );

Definition at line 671 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::setCollectionPropertiesPageNames ( const QStringList names)
Parameters
namesthe list of names to set as collection properties page names
Since
4.8.2

Definition at line 700 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::setCollectionSelectionModel ( QItemSelectionModel selectionModel)

Sets the collection selection model based on which the collection related actions should operate.

If none is set, all collection actions will be disabled.

Parameters
selectionModelthe selection model for collections

Definition at line 552 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::setItemSelectionModel ( QItemSelectionModel selectionModel)

Sets the item selection model based on which the item related actions should operate.

If none is set, all item actions will be disabled.

Parameters
selectionModelthe selection model for items

Definition at line 570 of file standardcontactactionmanager.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Aug 7 2020 23:06:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.