#include <standardmailactionmanager.h>

Inheritance diagram for Akonadi::StandardMailActionManager:

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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

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)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

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 674 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 905 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 914 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 709 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 873 of file standardmailactionmanager.cpp.

void StandardMailActionManager::createAllActions ( )

Convenience method to create all standard actions.

See also: createAction()

Definition at line 883 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 924 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 933 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 938 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 943 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 919 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 679 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 948 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 953 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 694 of file standardmailactionmanager.cpp.

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

akonadi/kmime

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

akonadi/kmime

kdepimlibs API Reference

Search