akonadi
Akonadi::StandardCalendarActionManager Class Reference
Manages calendar specific actions for collection and item views. More...
#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 (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) |
Detailed Description
Manages calendar specific actions for collection and item views.
- Since:
- 4.6
Definition at line 49 of file standardcalendaractionmanager.h.
Member Enumeration Documentation
Describes the supported actions.
- Enumerator:
Definition at line 57 of file standardcalendaractionmanager.h.
Constructor & Destructor Documentation
Akonadi::StandardCalendarActionManager::StandardCalendarActionManager | ( | KActionCollection * | actionCollection, |
QWidget * | parent = 0 |
||
) | [explicit] |
Creates a new standard calendar action manager.
- Parameters:
-
actionCollection The action collection to operate on. parent The parent widget.
Definition at line 388 of file standardcalendaractionmanager.cpp.
StandardCalendarActionManager::~StandardCalendarActionManager | ( | ) |
Destroys the standard contact action manager.
Definition at line 394 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 500 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).
Definition at line 508 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 | ( | 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.
Definition at line 483 of file standardcalendaractionmanager.cpp.
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.
Definition at line 424 of file standardcalendaractionmanager.cpp.
void StandardCalendarActionManager::createAllActions | ( | ) |
Convenience method to create all standard actions.
- See also:
- createAction()
Definition at line 488 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, iftrue
no action is taken.
Definition at line 518 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, iftrue
no action is taken.
Definition at line 526 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 531 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 536 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 513 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.
Definition at line 399 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 541 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 546 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.
Definition at line 413 of file standardcalendaractionmanager.cpp.
The documentation for this class was generated from the following files: