Akonadi::StandardContactActionManager
#include <standardcontactactionmanager.h>

Public Types | |
enum | Type { CreateContact = StandardActionManager::LastType + 1, CreateContactGroup, EditItem, LastType } |
Signals | |
void | actionStateUpdated () |
Public Member Functions | |
StandardContactActionManager (KActionCollection *actionCollection, QWidget *parent=nullptr) | |
~StandardContactActionManager () override | |
QAction * | action (StandardActionManager::Type type) const |
QAction * | action (Type type) const |
QAction * | createAction (StandardActionManager::Type type) |
QAction * | createAction (Type type) |
void | createAllActions () |
void | interceptAction (StandardActionManager::Type type, bool intercept=true) |
void | interceptAction (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) |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, 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 QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () 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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (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) |
QThread * | thread () const const |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
typedef | QObjectList |
![]() | |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Manages contact specific actions for collection and item views.
- Since
- 4.6
Definition at line 35 of file standardcontactactionmanager.h.
Member Enumeration Documentation
◆ Type
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 43 of file standardcontactactionmanager.h.
Constructor & Destructor Documentation
◆ StandardContactActionManager()
|
explicit |
Creates a new standard contact action manager.
- Parameters
-
actionCollection The action collection to operate on. parent The parent widget.
Definition at line 479 of file standardcontactactionmanager.cpp.
◆ ~StandardContactActionManager()
|
overridedefault |
Destroys the standard contact action manager.
Member Function Documentation
◆ action() [1/2]
QAction * StandardContactActionManager::action | ( | StandardActionManager::Type | type | ) | const |
Returns the action of the given type, 0 if it has not been created (yet).
- Parameters
-
type the type of action to return
Definition at line 604 of file standardcontactactionmanager.cpp.
◆ action() [2/2]
Returns the action of the given type, 0 if it has not been created (yet).
Definition at line 595 of file standardcontactactionmanager.cpp.
◆ 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.
◆ createAction() [1/2]
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
-
type the type of action to create
Definition at line 573 of file standardcontactactionmanager.cpp.
◆ createAction() [2/2]
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 the type of action to create
Definition at line 517 of file standardcontactactionmanager.cpp.
◆ createAllActions()
void StandardContactActionManager::createAllActions | ( | ) |
Convenience method to create all standard actions.
- See also
- createAction()
Definition at line 583 of file standardcontactactionmanager.cpp.
◆ interceptAction() [1/2]
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
-
intercept If false
, the default implementation will be executed, iftrue
no action is taken.
Definition at line 623 of file standardcontactactionmanager.cpp.
◆ interceptAction() [2/2]
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
-
intercept If false
, the default implementation will be executed, iftrue
no action is taken.
Definition at line 614 of file standardcontactactionmanager.cpp.
◆ selectedCollections()
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 628 of file standardcontactactionmanager.cpp.
◆ selectedItems()
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 633 of file standardcontactactionmanager.cpp.
◆ setActionText()
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:
Definition at line 609 of file standardcontactactionmanager.cpp.
◆ setCollectionPropertiesPageNames()
void StandardContactActionManager::setCollectionPropertiesPageNames | ( | const QStringList & | names | ) |
- Parameters
-
names the list of names to set as collection properties page names
- Since
- 4.8.2
Definition at line 638 of file standardcontactactionmanager.cpp.
◆ setCollectionSelectionModel()
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
-
selectionModel the selection model for collections
Definition at line 487 of file standardcontactactionmanager.cpp.
◆ setItemSelectionModel()
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
-
selectionModel the selection model for items
Definition at line 505 of file standardcontactactionmanager.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Mar 26 2023 03:56:46 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.