Akonadi::StandardMailActionManager
#include <standardmailactionmanager.h>
Public Types | |
enum | Type { MarkMailAsRead = StandardActionManager::LastType + 1 , MarkMailAsUnread , MarkMailAsImportant , MarkMailAsActionItem , MarkAllMailAsRead , MarkAllMailAsReadRecursive , MarkAllMailAsUnread , MarkAllMailAsImportant , MarkAllMailAsActionItem , MoveToTrash , MoveAllToTrash , RemoveDuplicates , EmptyAllTrash , EmptyTrash , LastType } |
Public Types inherited from QObject | |
typedef | QObjectList |
Signals | |
void | actionStateUpdated () |
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 *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) |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Manages emails specific actions for collection and item views.
- Since
- 4.6
Definition at line 35 of file standardmailactionmanager.h.
Member Enumeration Documentation
◆ Type
Describes the supported actions.
Definition at line 43 of file standardmailactionmanager.h.
Constructor & Destructor Documentation
◆ StandardMailActionManager()
|
explicit |
Creates a new standard mail action manager.
- Parameters
-
actionCollection The action collection to operate on. parent The parent widget.
Definition at line 639 of file standardmailactionmanager.cpp.
◆ ~StandardMailActionManager()
|
overridedefault |
Destroys the standard mail action manager.
Member Function Documentation
◆ action() [1/2]
|
nodiscard |
Returns the action of the given type, 0 if it has not been created (yet).
- Parameters
-
type action type
Definition at line 925 of file standardmailactionmanager.cpp.
◆ action() [2/2]
Returns the action of the given type, 0 if it has not been created (yet).
- Parameters
-
type action type
Definition at line 920 of file standardmailactionmanager.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 * StandardMailActionManager::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 action type
Definition at line 887 of file standardmailactionmanager.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 action type
Definition at line 683 of file standardmailactionmanager.cpp.
◆ createAllActions()
void StandardMailActionManager::createAllActions | ( | ) |
Convenience method to create all standard actions.
- See also
- createAction()
Definition at line 897 of file standardmailactionmanager.cpp.
◆ interceptAction() [1/2]
void StandardMailActionManager::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
-
type action type intercept If false
, the default implementation will be executed, iftrue
no action is taken.
Definition at line 944 of file standardmailactionmanager.cpp.
◆ interceptAction() [2/2]
void StandardMailActionManager::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 935 of file standardmailactionmanager.cpp.
◆ markAllItemsAs()
void StandardMailActionManager::markAllItemsAs | ( | const QByteArray & | typeStr, |
const Akonadi::Collection::List & | collections, | ||
bool | checkIntercept = true ) |
Definition at line 984 of file standardmailactionmanager.cpp.
◆ markItemsAs()
void StandardMailActionManager::markItemsAs | ( | const QByteArray & | typeStr, |
const Akonadi::Item::List & | items, | ||
bool | checkIntercept = true ) |
Definition at line 979 of file standardmailactionmanager.cpp.
◆ selectedCollections()
|
nodiscard |
Returns the list of collections that are currently selected.
The list is empty if no collection is currently selected.
Definition at line 949 of file standardmailactionmanager.cpp.
◆ selectedItems()
|
nodiscard |
Returns the list of items that are currently selected.
The list is empty if no item is currently selected.
Definition at line 954 of file standardmailactionmanager.cpp.
◆ setActionText()
void StandardMailActionManager::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:
- Parameters
-
type action type text localized text for action
Definition at line 930 of file standardmailactionmanager.cpp.
◆ setCollectionPropertiesPageNames()
void StandardMailActionManager::setCollectionPropertiesPageNames | ( | const QStringList & | names | ) |
Definition at line 969 of file standardmailactionmanager.cpp.
◆ setCollectionSelectionModel()
void StandardMailActionManager::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 selection model for collections
Definition at line 647 of file standardmailactionmanager.cpp.
◆ setFavoriteCollectionsModel()
void StandardMailActionManager::setFavoriteCollectionsModel | ( | FavoriteCollectionsModel * | favoritesModel | ) |
Sets the favorite collections model based on which the collection relatedactions should operate.
If none is set, the "Add to Favorite Folders" action will be disabled.
- Parameters
-
favoritesModel model for a user's favorite mail collections
Definition at line 959 of file standardmailactionmanager.cpp.
◆ setFavoriteSelectionModel()
void StandardMailActionManager::setFavoriteSelectionModel | ( | QItemSelectionModel * | selectionModel | ) |
Sets the favorite collection selection model based on which the favorite collection related actions should operate.
If none is set, all favorite modifications actions will be disabled.
- Parameters
-
selection model for favorite collections
Definition at line 964 of file standardmailactionmanager.cpp.
◆ setItems()
void StandardMailActionManager::setItems | ( | const Item::List & | selectedItems | ) |
Definition at line 663 of file standardmailactionmanager.cpp.
◆ setItemSelectionModel()
void StandardMailActionManager::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 selection model for items
Definition at line 668 of file standardmailactionmanager.cpp.
◆ standardActionManager()
|
nodiscard |
Definition at line 974 of file standardmailactionmanager.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:12:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.