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

akonadi

  • Akonadi
  • StandardCalendarActionManager
Public Types | Signals | Public Member Functions | List of all members
Akonadi::StandardCalendarActionManager Class Reference

#include <standardcalendaractionmanager.h>

Inherits QObject.

Public Types

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

Signals

void actionStateUpdated ()
 

Public Member Functions

 StandardCalendarActionManager (KActionCollection *actionCollection, QWidget *parent=0)
 
 ~StandardCalendarActionManager ()
 
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 setContextText (StandardActionManager::Type type, StandardActionManager::TextContext context, const KLocalizedString &text)
 
void setContextText (StandardActionManager::Type type, StandardActionManager::TextContext context, const QString &text)
 
void setItemSelectionModel (QItemSelectionModel *selectionModel)
 

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 49 of file standardcalendaractionmanager.h.

Member Enumeration Documentation

◆ Type

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 56 of file standardcalendaractionmanager.h.

Constructor & Destructor Documentation

◆ StandardCalendarActionManager()

Akonadi::StandardCalendarActionManager::StandardCalendarActionManager ( KActionCollection * actionCollection,
QWidget * parent = 0 )
explicit

Creates a new standard calendar action manager.

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

Definition at line 517 of file standardcalendaractionmanager.cpp.

◆ ~StandardCalendarActionManager()

StandardCalendarActionManager::~StandardCalendarActionManager ( )

Destroys the standard calendar action manager.

Definition at line 523 of file standardcalendaractionmanager.cpp.

Member Function Documentation

◆ action() [1/2]

KAction * StandardCalendarActionManager::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 644 of file standardcalendaractionmanager.cpp.

◆ action() [2/2]

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

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

Definition at line 635 of file standardcalendaractionmanager.cpp.

◆ actionStateUpdated

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.

◆ createAction() [1/2]

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

Definition at line 613 of file standardcalendaractionmanager.cpp.

◆ createAction() [2/2]

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

Definition at line 553 of file standardcalendaractionmanager.cpp.

◆ createAllActions()

void StandardCalendarActionManager::createAllActions ( )

Convenience method to create all standard actions.

See also
createAction()

Definition at line 622 of file standardcalendaractionmanager.cpp.

◆ interceptAction() [1/2]

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

Definition at line 663 of file standardcalendaractionmanager.cpp.

◆ interceptAction() [2/2]

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

Definition at line 654 of file standardcalendaractionmanager.cpp.

◆ selectedCollections()

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 668 of file standardcalendaractionmanager.cpp.

◆ selectedItems()

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 673 of file standardcalendaractionmanager.cpp.

◆ setActionText()

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" ) );
Akonadi::StandardActionManager::CopyItems
@ CopyItems
Copies the selected items.
Definition standardactionmanager.h:139

Definition at line 649 of file standardcalendaractionmanager.cpp.

◆ setCollectionPropertiesPageNames()

void StandardCalendarActionManager::setCollectionPropertiesPageNames ( const QStringList & names)

Definition at line 688 of file standardcalendaractionmanager.cpp.

◆ setCollectionSelectionModel()

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

Definition at line 528 of file standardcalendaractionmanager.cpp.

◆ setContextText() [1/2]

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 683 of file standardcalendaractionmanager.cpp.

◆ setContextText() [2/2]

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 678 of file standardcalendaractionmanager.cpp.

◆ setItemSelectionModel()

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

Definition at line 542 of file standardcalendaractionmanager.cpp.


The documentation for this class was generated from the following files:
  • standardcalendaractionmanager.h
  • standardcalendaractionmanager.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

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • 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