• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs 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>

Inheritance diagram for Akonadi::StandardCalendarActionManager:
Inheritance graph
[legend]

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 (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 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)
 
 QObject (QObject *parent, const char *name)
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
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) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
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)
 
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
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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

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

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

Destroys the standard calendar action manager.

Definition at line 523 of file standardcalendaractionmanager.cpp.

Member Function Documentation

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.

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.

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.

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.

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.

void StandardCalendarActionManager::createAllActions ( )

Convenience method to create all standard actions.

See also
createAction()

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

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

Definition at line 663 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 668 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 673 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 649 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
selectionModelthe selection model for collections

Definition at line 528 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 678 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 683 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
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-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:05 by doxygen 1.8.7 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
  • Modules
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs 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

Search



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