Manages emails specific actions for collection and item views. More...
#include <standardmailactionmanager.h>
Inherits QObject.
Public Types | |
enum | Type { MarkMailAsRead = StandardActionManager::LastType + 1, MarkMailAsUnread, MarkMailAsImportant, MarkMailAsActionItem, MarkAllMailAsRead, MarkAllMailAsUnread, MarkAllMailAsImportant, MarkAllMailAsActionItem, MoveToTrash, MoveAllToTrash, RemoveDuplicates, EmptyAllTrash, EmptyTrash, LastType } |
Signals | |
void | actionStateUpdated () |
Public Member Functions | |
StandardMailActionManager (KActionCollection *actionCollection, QWidget *parent=0) | |
~StandardMailActionManager () | |
KAction * | action (Type type) const |
KAction * | action (StandardActionManager::Type type) const |
KAction * | createAction (Type type) |
KAction * | createAction (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 | setFavoriteCollectionsModel (FavoriteCollectionsModel *favoritesModel) |
void | setFavoriteSelectionModel (QItemSelectionModel *selectionModel) |
void | setItemSelectionModel (QItemSelectionModel *selectionModel) |
Detailed Description
Manages emails specific actions for collection and item views.
- Since:
- 4.6
Definition at line 47 of file standardmailactionmanager.h.
Member Enumeration Documentation
Describes the supported actions.
- Enumerator:
Definition at line 55 of file standardmailactionmanager.h.
Constructor & Destructor Documentation
StandardMailActionManager::StandardMailActionManager | ( | KActionCollection * | actionCollection, |
QWidget * | parent = 0 |
||
) | [explicit] |
Creates a new standard mail action manager.
- Parameters:
-
actionCollection The action collection to operate on. parent The parent widget.
Definition at line 521 of file standardmailactionmanager.cpp.
StandardMailActionManager::~StandardMailActionManager | ( | ) |
Destroys the standard mail action manager.
Definition at line 526 of file standardmailactionmanager.cpp.
Member Function Documentation
KAction * StandardMailActionManager::action | ( | Type | type | ) | const |
Returns the action of the given type, 0 if it has not been created (yet).
Definition at line 725 of file standardmailactionmanager.cpp.
KAction * StandardMailActionManager::action | ( | StandardActionManager::Type | type | ) | const |
Returns the action of the given type, 0 if it has not been created (yet).
Definition at line 733 of file standardmailactionmanager.cpp.
void Akonadi::StandardMailActionManager::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 * 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.
Definition at line 699 of file standardmailactionmanager.cpp.
KAction * StandardMailActionManager::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 561 of file standardmailactionmanager.cpp.
void StandardMailActionManager::createAllActions | ( | ) |
Convenience method to create all standard actions.
- See also:
- createAction()
Definition at line 704 of file standardmailactionmanager.cpp.
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 743 of file standardmailactionmanager.cpp.
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:
-
intercept If false
, the default implementation will be executed, iftrue
no action is taken.
Definition at line 751 of file standardmailactionmanager.cpp.
Akonadi::Collection::List StandardMailActionManager::selectedCollections | ( | ) | const |
Returns the list of collections that are currently selected.
The list is empty if no collection is currently selected.
Definition at line 756 of file standardmailactionmanager.cpp.
Akonadi::Item::List StandardMailActionManager::selectedItems | ( | ) | const |
Returns the list of items that are currently selected.
The list is empty if no item is currently selected.
Definition at line 761 of file standardmailactionmanager.cpp.
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:
acctMgr->setActionText( Akonadi::StandardActionManager::CopyItems, ki18np( "Copy Item", "Copy %1 Items" ) );
Definition at line 738 of file standardmailactionmanager.cpp.
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.
Definition at line 531 of file standardmailactionmanager.cpp.
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.
Definition at line 766 of file standardmailactionmanager.cpp.
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.
Definition at line 771 of file standardmailactionmanager.cpp.
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.
Definition at line 546 of file standardmailactionmanager.cpp.
The documentation for this class was generated from the following files: