• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi/contact

  • Akonadi
  • StandardContactActionManager
Public Types | Signals | Public Member Functions | List of all members
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 (StandardActionManager::Type type) const
 
KAction * action (Type type) const
 
KAction * createAction (StandardActionManager::Type type)
 
KAction * createAction (Type type)
 
void createAllActions ()
 
void interceptAction (StandardActionManager::Type type, bool intercept=true)
 
void interceptAction (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

◆ Type

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::StandardContactActionManager ( KActionCollection * actionCollection,
QWidget * parent = 0 )
explicit

Creates a new standard contact action manager.

Parameters
actionCollectionThe action collection to operate on.
parentThe parent widget.

Definition at line 533 of file standardcontactactionmanager.cpp.

◆ ~StandardContactActionManager()

StandardContactActionManager::~StandardContactActionManager ( )

Destroys the standard contact action manager.

Definition at line 538 of file standardcontactactionmanager.cpp.

Member Function Documentation

◆ action() [1/2]

KAction * StandardContactActionManager::action ( StandardActionManager::Type type) const

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

Parameters
typethe type of action to return

Definition at line 646 of file standardcontactactionmanager.cpp.

◆ action() [2/2]

KAction * StandardContactActionManager::action ( Type type) const

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

Definition at line 637 of file standardcontactactionmanager.cpp.

◆ actionStateUpdated

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.

◆ createAction() [1/2]

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
typethe type of action to create

Definition at line 616 of file standardcontactactionmanager.cpp.

◆ createAction() [2/2]

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
typethe type of action to create

Definition at line 569 of file standardcontactactionmanager.cpp.

◆ createAllActions()

void StandardContactActionManager::createAllActions ( )

Convenience method to create all standard actions.

See also
createAction()

Definition at line 625 of file standardcontactactionmanager.cpp.

◆ interceptAction() [1/2]

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
interceptIf false, the default implementation will be executed, if true no action is taken.

Definition at line 665 of file standardcontactactionmanager.cpp.

◆ interceptAction() [2/2]

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
interceptIf false, the default implementation will be executed, if true no action is taken.

Definition at line 656 of file standardcontactactionmanager.cpp.

◆ selectedCollections()

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 670 of file standardcontactactionmanager.cpp.

◆ selectedItems()

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 675 of file standardcontactactionmanager.cpp.

◆ setActionText()

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

◆ setCollectionPropertiesPageNames()

void StandardContactActionManager::setCollectionPropertiesPageNames ( const QStringList & names)
Parameters
namesthe list of names to set as collection properties page names
Since
4.8.2

Definition at line 680 of file standardcontactactionmanager.cpp.

◆ setCollectionSelectionModel()

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
selectionModelthe selection model for collections

Definition at line 543 of file standardcontactactionmanager.cpp.

◆ setItemSelectionModel()

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
selectionModelthe selection model for items

Definition at line 558 of file standardcontactactionmanager.cpp.


The documentation for this class was generated from the following files:
  • standardcontactactionmanager.h
  • standardcontactactionmanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi/contact

Skip menu "akonadi/contact"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal