Akonadi::StandardMailActionManager Class Reference

#include <standardmailactionmanager.h>

Inheritance diagram for Akonadi::StandardMailActionManager:

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 ()

Public Member Functions
	StandardMailActionManager (KActionCollection *actionCollection, QWidget *parent=nullptr)
	~StandardMailActionManager () 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)
void	markAllItemsAs (const QByteArray &typeStr, const Akonadi::Collection::List &collections, bool checkIntercept=true)
void	markItemsAs (const QByteArray &typeStr, const Akonadi::Item::List &items, bool checkIntercept=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	setItems (const Item::List &selectedItems)
void	setItemSelectionModel (QItemSelectionModel *selectionModel)
Akonadi::StandardActionManager *	standardActionManager () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
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 () const const
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 QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
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_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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	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	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

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.

Author

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

Since

4.6

Definition at line 35 of file standardmailactionmanager.h.

Member Enumeration Documentation

Type

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.
MarkAllMailAsReadRecursive	Marks all mails in a folder and its subfolders 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 43 of file standardmailactionmanager.h.

Constructor & Destructor Documentation

StandardMailActionManager()

StandardMailActionManager::StandardMailActionManager ( KActionCollection * actionCollection, QWidget * parent = nullptr )

explicit

Creates a new standard mail action manager.

Parameters

actionCollection	The action collection to operate on.
parent	The parent widget.

Definition at line 638 of file standardmailactionmanager.cpp.

~StandardMailActionManager()

StandardMailActionManager::~StandardMailActionManager ( )

overridedefault

Destroys the standard mail action manager.

Member Function Documentation

action() [1/2]

QAction * StandardMailActionManager::action ( StandardActionManager::Type type ) const

nodiscard

Returns the action of the given type, 0 if it has not been created (yet).

Parameters

type	action type

Definition at line 924 of file standardmailactionmanager.cpp.

action() [2/2]

QAction * StandardMailActionManager::action ( Type type ) const

nodiscard

Returns the action of the given type, 0 if it has not been created (yet).

Parameters

type	action type

Definition at line 919 of file standardmailactionmanager.cpp.

actionStateUpdated

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.

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

createAction() [2/2]

QAction * 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 682 of file standardmailactionmanager.cpp.

createAllActions()

void StandardMailActionManager::createAllActions

(

)

Convenience method to create all standard actions.

See also

createAction()

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

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

Definition at line 934 of file standardmailactionmanager.cpp.

markAllItemsAs()

void StandardMailActionManager::markAllItemsAs	(	const QByteArray &	typeStr,
		const Akonadi::Collection::List &	collections,
		bool	checkIntercept = true )

Definition at line 983 of file standardmailactionmanager.cpp.

markItemsAs()

void StandardMailActionManager::markItemsAs	(	const QByteArray &	typeStr,
		const Akonadi::Item::List &	items,
		bool	checkIntercept = true )

Definition at line 978 of file standardmailactionmanager.cpp.

selectedCollections()

Akonadi::Collection::List StandardMailActionManager::selectedCollections ( ) const

nodiscard

Returns the list of collections that are currently selected.

The list is empty if no collection is currently selected.

Definition at line 948 of file standardmailactionmanager.cpp.

selectedItems()

Akonadi::Item::List StandardMailActionManager::selectedItems ( ) const

nodiscard

Returns the list of items that are currently selected.

The list is empty if no item is currently selected.

Definition at line 953 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:

acctMgr->setActionText( Akonadi::StandardActionManager::CopyItems,
                        ki18np( "Copy Item", "Copy %1 Items" ) );

Parameters

type	action type
text	localized text for action

Definition at line 929 of file standardmailactionmanager.cpp.

setCollectionPropertiesPageNames()

void StandardMailActionManager::setCollectionPropertiesPageNames

(

const QStringList &

names

)

Definition at line 968 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 646 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 958 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 963 of file standardmailactionmanager.cpp.

setItems()

void StandardMailActionManager::setItems

(

const Item::List &

selectedItems

)

Definition at line 662 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 667 of file standardmailactionmanager.cpp.

standardActionManager()

Akonadi::StandardActionManager * StandardMailActionManager::standardActionManager ( ) const

nodiscard

Definition at line 973 of file standardmailactionmanager.cpp.

---

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

• standardmailactionmanager.h
• standardmailactionmanager.cpp