Akonadi.StandardActionManager

KDE 4.9 PyKDE API Reference

- KDE's Python API

# StandardActionManager Class Reference

`from PyKDE4.akonadi import *`

Inherits: QObject
Namespace: Akonadi

## Detailed Description

Manages generic actions for collection and item views.

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:

     Akonadi.StandardActionManager *actMgr = new Akonadi.StandardActionManager( actionCollection(), this );
     actMgr->setCollectionSelectionModel( collectionView->collectionSelectionModel() );
     actMgr->createAllActions();

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.

If you want to use your own implementation of the actual action operation and not the default implementation, you can call interceptAction() on the action type you want to handle yourself and connect the slot with your own implementation to the triggered() signal of the action:

     using namespace Akonadi;

     StandardActionManager *manager = new StandardActionManager( actionCollection(), this );
     manager->setCollectionSelectionModel( collectionView->collectionSelectionModel() );
     manager->createAllActions();

     // disable default implementation
     manager->interceptAction( StandardActionManager.CopyCollections );

     // connect your own implementation
     connect( manager->action( StandardActionManager.CopyCollections ), SIGNAL( triggered( bool ) ),
              this, SLOT( myCopyImplementation() ) );
     ...

     void MyClass.myCopyImplementation()
     {
       const Collection.List collections = manager->selectedCollections();
       foreach ( const Collection &collection, collections ) {
         // copy the collection manually...
       }
     }

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

Author:
  Volker Krause <vkrause@kde.org>

## Enumerations
TextContext | { DialogTitle, DialogText, MessageBoxTitle, MessageBoxText, MessageBoxAlternativeText, ErrorMessageTitle, ErrorMessageText }
Type | { CreateCollection, CopyCollections, DeleteCollections, SynchronizeCollections, CollectionProperties, CopyItems, Paste, DeleteItems, ManageLocalSubscriptions, AddToFavoriteCollections, RemoveFromFavoriteCollections, RenameFavoriteCollection, CopyCollectionToMenu, CopyItemToMenu, MoveItemToMenu, MoveCollectionToMenu, CutItems, CutCollections, CreateResource, DeleteResources, ResourceProperties, SynchronizeResources, ToggleWorkOffline, CopyCollectionToDialog, MoveCollectionToDialog, CopyItemToDialog, MoveItemToDialog, SynchronizeCollectionsRecursive, MoveCollectionsToTrash, MoveItemsToTrash, RestoreCollectionsFromTrash, RestoreItemsFromTrash, MoveToTrashRestoreCollection, MoveToTrashRestoreCollectionAlternative, MoveToTrashRestoreItem, MoveToTrashRestoreItemAlternative, SynchronizeFavoriteCollections, LastType }
## Signals
| actionStateUpdated ()
## Methods
| __init__ (self, KActionCollection actionCollection, QWidget parent=0)
KAction | action (self, Akonadi.StandardActionManager.Type type)
KAction | createAction (self, Akonadi.StandardActionManager.Type type)
| createActionFolderMenu (self, QMenu menu, Akonadi.StandardActionManager.Type type)
| createAllActions (self)
| interceptAction (self, Akonadi.StandardActionManager.Type type, bool intercept=1)
[Akonadi.Collection] | selectedCollections (self)
[Akonadi.Item] | selectedItems (self)
| setActionText (self, Akonadi.StandardActionManager.Type type, KLocalizedString text)
| setCapabilityFilter (self, QStringList capabilities)
| setCollectionPropertiesPageNames (self, QStringList names)
| setCollectionSelectionModel (self, QItemSelectionModel selectionModel)
| setContextText (self, Akonadi.StandardActionManager.Type type, Akonadi.StandardActionManager.TextContext context, QString text)
| setContextText (self, Akonadi.StandardActionManager.Type type, Akonadi.StandardActionManager.TextContext context, KLocalizedString text)
| setFavoriteCollectionsModel (self, Akonadi.FavoriteCollectionsModel favoritesModel)
| setFavoriteSelectionModel (self, QItemSelectionModel selectionModel)
| setItemSelectionModel (self, QItemSelectionModel selectionModel)
| setMimeTypeFilter (self, QStringList mimeTypes)

## Signal Documentation

actionStateUpdated | ( |  | ) |

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.

Signal syntax:
  `QObject.connect(source, SIGNAL("actionStateUpdated()"), target_slot)`

## Method Documentation

__init__ | ( | self, |
|  | KActionCollection | actionCollection,
|  | QWidget | parent=0
| ) |  |  |

Creates a new standard action manager.

Parameters:

  | actionCollection | The action collection to operate on.
  | parent | The parent widget.

KAction action | ( | self, |
|  | Akonadi.StandardActionManager.Type | type
| ) |  |  |

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

KAction createAction | ( | self, |
|  | Akonadi.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.

createActionFolderMenu | ( | self, |
|  | QMenu | menu,
|  | Akonadi.StandardActionManager.Type | type
| ) |  |  |

Create a popup menu.

Since:
  4.8

createAllActions | ( |  | self ) |

Convenience method to create all standard actions.

See also:
  createAction()

interceptAction | ( | self, |
|  | Akonadi.StandardActionManager.Type | type,
|  | bool | intercept=1
| ) |  |  |

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, if true no action is taken.

Since:
  4.6

[Akonadi.Collection] selectedCollections | ( |  | self ) |

Returns the list of collections that are currently selected. The list is empty if no collection is currently selected.

Since:
  4.6

[Akonadi.Item] selectedItems | ( |  | self ) |

Returns the list of items that are currently selected. The list is empty if no item is currently selected.

Since:
  4.6

setActionText | ( | self, |
|  | Akonadi.StandardActionManager.Type | type,
|  | 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 Mail", "Copy %1 Mails" ) );

setCapabilityFilter | ( | self, |
|  | QStringList | capabilities
| ) |  |  |

Sets the capability filter that will be used when creating new resources.

Since:
  4.6

setCollectionPropertiesPageNames | ( | self, |
|  | QStringList | names
| ) |  |  |

Sets the page names of the config pages that will be used by the built-in collection properties dialog.

Since:
  4.6

setCollectionSelectionModel | ( | self, |
|  | 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.

setContextText | ( | self, |
|  | Akonadi.StandardActionManager.Type | type,
|  | Akonadi.StandardActionManager.TextContext | context,
|  | QString | text
| ) |  |  |

Sets the text of the action type for the given context.

Since:
  4.6

setContextText | ( | self, |
|  | Akonadi.StandardActionManager.Type | type,
|  | Akonadi.StandardActionManager.TextContext | context,
|  | KLocalizedString | text
| ) |  |  |

Sets the text of the action type for the given context.

Since:
  4.6

setFavoriteCollectionsModel | ( | self, |
|  | Akonadi.FavoriteCollectionsModel | favoritesModel
| ) |  |  |

Sets the favorite collections model based on which the collection relatedactions should operate. If none is set, the "Add to Favorite Folders" action will be disabled.

Since:
  4.4

setFavoriteSelectionModel | ( | self, |
|  | QItemSelectionModel | selectionModel
| ) |  |  |

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

Since:
  4.4

setItemSelectionModel | ( | self, |
|  | 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.

setMimeTypeFilter | ( | self, |
|  | QStringList | mimeTypes
| ) |  |  |

Sets the mime type filter that will be used when creating new resources.

Since:
  4.6

## Enumeration Documentation

TextContext

Describes the text context that can be customized.

Enumerator:

  DialogTitle |
  DialogText |
  MessageBoxTitle |
  MessageBoxText |
  MessageBoxAlternativeText |
  ErrorMessageTitle |
  ErrorMessageText |

Type

Describes the supported actions.

Enumerator:

  CreateCollection |
  CopyCollections |
  DeleteCollections |
  SynchronizeCollections |
  CollectionProperties |
  CopyItems |
  Paste |
  DeleteItems |
  ManageLocalSubscriptions |
  AddToFavoriteCollections |
  RemoveFromFavoriteCollections |
  RenameFavoriteCollection |
  CopyCollectionToMenu |
  CopyItemToMenu |
  MoveItemToMenu |
  MoveCollectionToMenu |
  CutItems |
  CutCollections |
  CreateResource |
  DeleteResources |
  ResourceProperties |
  SynchronizeResources |
  ToggleWorkOffline |
  CopyCollectionToDialog |
  MoveCollectionToDialog |
  CopyItemToDialog |
  MoveItemToDialog |
  SynchronizeCollectionsRecursive |
  MoveCollectionsToTrash |
  MoveItemsToTrash |
  RestoreCollectionsFromTrash |
  RestoreItemsFromTrash |
  MoveToTrashRestoreCollection |
  MoveToTrashRestoreCollectionAlternative |
  MoveToTrashRestoreItem |
  MoveToTrashRestoreItemAlternative |
  SynchronizeFavoriteCollections |
  LastType |