Akonadi Calendar

View on LXR

#include <standardcalendaractionmanager.h>

Inheritance diagram for Akonadi::StandardCalendarActionManager:

Public Types
enum	Type { CreateEvent = StandardActionManager::LastType + 1, CreateTodo, CreateSubTodo, CreateJournal, EditIncidence, LastType }

Signals
void	actionStateUpdated ()

Public Member Functions
	StandardCalendarActionManager (KActionCollection actionCollection, QWidget parent=nullptr)

	~StandardCalendarActionManager ()

QAction *	action (Type type) const

QAction *	action (StandardActionManager::Type type) const

QAction *	createAction (Type type)

QAction *	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	setContextText (StandardActionManager::Type type, StandardActionManager::TextContext context, const QString &text)

void	setContextText (StandardActionManager::Type type, StandardActionManager::TextContext context, const KLocalizedString &text)

void	setItemSelectionModel (QItemSelectionModel *selectionModel)

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

bool	blockSignals (bool block)

const QObjectList &	children () const

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

void	deleteLater ()

void	destroyed (QObject *obj)

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

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

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, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () 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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction 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
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

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Manages calendar specific actions for collection and item views.

Author: Casey Link unnam.nosp@m.edra.nosp@m.mbler.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Since: 4.6

Definition at line 50 of file standardcalendaractionmanager.h.

Member Enumeration Documentation

enum Akonadi::StandardCalendarActionManager::Type

Describes the supported actions.

Enumerator
CreateEvent	Creates a new event.
CreateTodo	Creates a new todo.
CreateSubTodo	Creates a new sub-todo.
CreateJournal	Creates a new journal.
EditIncidence	Edit currently selected event/todo/journal.
LastType	Marks last action.

Definition at line 57 of file standardcalendaractionmanager.h.

Constructor & Destructor Documentation

Akonadi::StandardCalendarActionManager::StandardCalendarActionManager	(	KActionCollection *	actionCollection,
		QWidget *	parent = `nullptr`
	)

explicit

Creates a new standard calendar action manager.

Parameters

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

Definition at line 540 of file standardcalendaractionmanager.cpp.

StandardCalendarActionManager::~StandardCalendarActionManager ( )

Destroys the standard calendar action manager.

Definition at line 546 of file standardcalendaractionmanager.cpp.

Member Function Documentation

QAction * StandardCalendarActionManager::action ( StandardCalendarActionManager::Type type ) const

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

Definition at line 655 of file standardcalendaractionmanager.cpp.

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

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

Parameters

type	the type of action to return

Definition at line 660 of file standardcalendaractionmanager.cpp.

void Akonadi::StandardCalendarActionManager::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.

QAction * StandardCalendarActionManager::createAction ( StandardCalendarActionManager::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	the type of action to create

Definition at line 572 of file standardcalendaractionmanager.cpp.

QAction * StandardCalendarActionManager::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	the type of action to create

Definition at line 632 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::createAllActions ( )

Convenience method to create all standard actions.

See also: createAction()

Definition at line 642 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::interceptAction	(	StandardCalendarActionManager::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 670 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::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, if true no action is taken.

Definition at line 679 of file standardcalendaractionmanager.cpp.

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

Returns the list of collections that are currently selected.

The list is empty if no collection is currently selected.

Definition at line 684 of file standardcalendaractionmanager.cpp.

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

Returns the list of items that are currently selected.

The list is empty if no item is currently selected.

Definition at line 689 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::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 665 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::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 the selection model for collections

Definition at line 551 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::setContextText	(	StandardActionManager::Type	type,
		StandardActionManager::TextContext	context,
		const QString &	text
	)

Sets the text of the action type for the given context.

Definition at line 694 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::setContextText	(	StandardActionManager::Type	type,
		StandardActionManager::TextContext	context,
		const KLocalizedString &	text
	)

Sets the text of the action type for the given context.

Definition at line 699 of file standardcalendaractionmanager.cpp.

void StandardCalendarActionManager::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 the selection model for items

Definition at line 562 of file standardcalendaractionmanager.cpp.

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

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation