# class StandardActionManager

###

Module | akonadi
Namespace | Akonadi
Class | StandardActionManager
Inherits | QObject

Manages generic Akonadi actions common for all types. This covers creating of the actions with appropriate labels, icons, shortcuts etc., updating the action state depending on the current selection as well as default implementations for the actual operations.

If the default implementation is not appropriate for your application you can still use the state tracking by disconnecting the triggered() signal and re-connecting it to your implementation. The actual KAction objects can be retrieved by calling createAction() or action() for that.

If the default look and feel (labels, icons, shortcuts) of the actions is not appropriate for your application, you can access them as noted above and customize them to your needs. Additionally, you can set a KLocalizedString which should be used as a action label with correct plural handling for actions operating on multiple objects with setActionText().

Finally, if you have special needs for the action states, connect to the actionStateUpdated() signal and adjust the state accordingly.

The following actions are provided (KAction name in parenthesis): - Creation of a new collection (@c akonadi_collection_create) - Copying of selected collections (@c akonadi_collection_copy) - Deletion of selected collections (@c akonadi_collection_delete) - Synchronization of selected collections (@c akonadi_collection_sync) - Showing the collection properties dialog for the current collection (@c akonadi_collection_properties) - Copying of selected items (@c akonadi_itemcopy) - Pasting collections, items or raw data (@c akonadi_paste) - Deleting of selected items (@c akonadi_item_delete) - Managing local subscriptions (@c akonadi_manage_local_subscriptions)

The following example shows how to use standard actions in your application: @verbatim Akonadi.StandardActionManager *actMgr = new Akonadi.StandardActionManager( actionCollection(), this ); actMgr->setCollectionSelectionModel( collectionView->collectionSelectionModel() ); actMgr->createAllActions(); @endverbatim Additionally you have to add the actions to the KXMLGUI file of your application, using the names listed above.

If you only need a subset of the actions provided, you can call createAction() instead of createAllActions() for the action types you want.

To do: collection deleting and sync do not support multi-selection yet

### enums

- Type { CreateCollection, CopyCollections, DeleteCollections, SynchronizeCollections, CollectionProperties, CopyItems, Paste, DeleteItems, ManageLocalSubscriptions, LastType }

enum details

### methods

- StandardActionManager (actionCollection, parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  actionCollection | KActionCollection |
  parent | QWidget | 0

  Create a new standard action manager.

  actionCollection - The action collection to operate on.

  parent - The parent widget.

- action (type)

  returns KAction

  Argument | Type | Default
  --- | --- | ---
  type | Akonadi.StandardActionManager.Type |

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

- actionStateUpdated ( )

  returns Nothing
  SIGNAL ("actionStateUpdated ()")

  Emitted when 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 (type)

  returns KAction

  Argument | Type | Default
  --- | --- | ---
  type | Akonadi.StandardActionManager.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.

- createAllActions ( )

  returns Nothing

  Convenience method to create all standard actions.

  See also createAction()

- setActionText (type, text)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  type | Akonadi.StandardActionManager.Type |
  text | KLocalizedString |

  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: @verbatim acctMgr->setActionText( Akonadi.StandardActionManager.CopyItems, ki18np( "Copy Mail", "Copy %1 Mails" ) ); @endverbatim

- setCollectionSelectionModel (selectionModel)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  selectionModel | QItemSelectionModel |

  Sets the collection selection model based on which the collection related actions should operate. If none is set, all collection actions will be disabled.

- setItemSelectionModel (selectionModel)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  selectionModel | QItemSelectionModel |

  Sets the item selection model based on which the item related actions should operate. If none is set, all item actions will be disabled.

### enums - detail

- Type { CreateCollection, CopyCollections, DeleteCollections, SynchronizeCollections, CollectionProperties, CopyItems, Paste, DeleteItems, ManageLocalSubscriptions, LastType }

  List of supported actions.

  | CreateCollection | - | - |
  | CopyCollections | - | - |
  | DeleteCollections | - | - |
  | SynchronizeCollections | - | - |
  | CollectionProperties | - | - |
  | CopyItems | - | - |
  | Paste | - | - |
  | DeleteItems | - | - |
  | ManageLocalSubscriptions | - | - |
  | LastType | - | - |