Akonadi::StandardMailActionManager Class Reference

#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)
Akonadi::StandardActionManager *	standardActionManager () const

Detailed Description

Manages emails specific actions for collection and item views.

Author

Andras Mantia amant.nosp@m.ia@k.nosp@m.de.or.nosp@m.g

Since

4.6

Definition at line 47 of file standardmailactionmanager.h.

Member Enumeration Documentation

enum Akonadi::StandardMailActionManager::Type

Describes the supported actions.

Enumerator
MarkMailAsRead	Marks a mail as read.
MarkMailAsUnread	Marks a mail as unread.
MarkMailAsImportant	Marks a mail as important.
MarkMailAsActionItem	Marks a mail as action item.
MarkAllMailAsRead	Marks all mails in a folder as read.
MarkAllMailAsUnread	Marks all mails in a folder as unread.
MarkAllMailAsImportant	Marks all mails in a folder as important.
MarkAllMailAsActionItem	Marks all mails in a folder as action item.
MoveToTrash	Move all selected messages and folders to trash.
MoveAllToTrash	Move all messages of the current folder to trash.
RemoveDuplicates	Removes all duplicated messages.
EmptyAllTrash	Empties trash folders on all accounts.
EmptyTrash	Empties the trash folder, if a trash folder was selected.
LastType	Marks last action.

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 668 of file standardmailactionmanager.cpp.

StandardMailActionManager::~StandardMailActionManager

(

)

Destroys the standard mail action manager.

Definition at line 673 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).

Parameters

type	action type

Definition at line 903 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).

Parameters

type	action type

Definition at line 912 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

(

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 708 of file standardmailactionmanager.cpp.

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.

Parameters

type	action type

Definition at line 872 of file standardmailactionmanager.cpp.

void StandardMailActionManager::createAllActions

(

)

Convenience method to create all standard actions.

See also

createAction()

Definition at line 881 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, if true no action is taken.

Definition at line 922 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

type	action type
intercept	If false, the default implementation will be executed, if true no action is taken.

Definition at line 931 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 936 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 941 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" ) );

Parameters

type	action type
text	localized text for action

Definition at line 917 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.

Parameters

selectionModel

selection model for collections

Definition at line 678 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.

Parameters

favoritesModel

model for a user's favorite mail collections

Definition at line 946 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.

Parameters

selection

model for favorite collections

Definition at line 951 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.

Parameters

selectionModel

selection model for items

Definition at line 693 of file standardmailactionmanager.cpp.

---

The documentation for this class was generated from the following files:

• standardmailactionmanager.h
• standardmailactionmanager.cpp