Akonadi::StandardContactActionManager Class Reference

#include <standardcontactactionmanager.h>

Inherits QObject.

Public Types
enum	Type { CreateContact = StandardActionManager::LastType + 1, CreateContactGroup, EditItem, LastType }

Signals
void	actionStateUpdated ()

Public Member Functions
	StandardContactActionManager (KActionCollection *actionCollection, QWidget *parent=0)
	~StandardContactActionManager ()
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	setItemSelectionModel (QItemSelectionModel *selectionModel)

Detailed Description

Manages contact specific actions for collection and item views.

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.6

Definition at line 46 of file standardcontactactionmanager.h.

Member Enumeration Documentation

enum Akonadi::StandardContactActionManager::Type

Describes the supported actions.

Enumerator
CreateContact	Creates a new contact.
CreateContactGroup	Creates a new contact group.
EditItem	Edits the selected contact resp. contact group.
LastType	Marks last action.

Definition at line 54 of file standardcontactactionmanager.h.

Constructor & Destructor Documentation

StandardContactActionManager::StandardContactActionManager ( KActionCollection *  actionCollection, QWidget *  parent = 0  )

explicit

Creates a new standard contact action manager.

Parameters

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

Definition at line 528 of file standardcontactactionmanager.cpp.

StandardContactActionManager::~StandardContactActionManager

(

)

Destroys the standard contact action manager.

Definition at line 533 of file standardcontactactionmanager.cpp.

Member Function Documentation

KAction * StandardContactActionManager::action

(

Type

type

)

const

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

Definition at line 632 of file standardcontactactionmanager.cpp.

KAction * StandardContactActionManager::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 641 of file standardcontactactionmanager.cpp.

void Akonadi::StandardContactActionManager::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 * StandardContactActionManager::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	the type of action to create

Definition at line 564 of file standardcontactactionmanager.cpp.

KAction * StandardContactActionManager::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 611 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::createAllActions

(

)

Convenience method to create all standard actions.

See also

createAction()

Definition at line 620 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::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 651 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::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 660 of file standardcontactactionmanager.cpp.

Akonadi::Collection::List StandardContactActionManager::selectedCollections

(

)

const

Returns the list of collections that are currently selected.

The list is empty if no collection is currently selected.

Definition at line 665 of file standardcontactactionmanager.cpp.

Akonadi::Item::List StandardContactActionManager::selectedItems

(

)

const

Returns the list of items that are currently selected.

The list is empty if no item is currently selected.

Definition at line 670 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::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 646 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::setCollectionPropertiesPageNames

(

const QStringList &

names

)

Parameters

names

the list of names to set as collection properties page names

Since

4.8.2

Definition at line 675 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::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 538 of file standardcontactactionmanager.cpp.

void StandardContactActionManager::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 553 of file standardcontactactionmanager.cpp.

---

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

• standardcontactactionmanager.h
• standardcontactactionmanager.cpp