PimCommon::GenericPluginInterface Class
class PimCommon::GenericPluginInterfaceThe GenericPluginInterface class provides an Akonadi-aware generic plugin interface Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <PimCommonAkonadi/GenericPluginInterface> |
| CMake: | find_package(KPim6PimCommonAkonadi REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::PimCommonAkonadi) |
Public Functions
| GenericPluginInterface(QObject *parent = nullptr) | |
| virtual | ~GenericPluginInterface() override |
| QList<PimCommon::ActionType> | actionTypes() const |
| void | addActionType(PimCommon::ActionType type) |
| virtual GenericPluginInterface::RequireTypes | requiresFeatures() const |
| void | setActionTypes(const QList<PimCommon::ActionType> &type) |
| virtual void | setCollections(const Akonadi::Collection::List &cols) |
| virtual void | setCurrentCollection(const Akonadi::Collection &col) |
| virtual void | setCurrentItems(const Akonadi::Item::List &items) |
| virtual void | setItems(const Akonadi::Item::List &items) |
| virtual void | updateActions(int numberOfSelectedItems, int numberOfSelectedCollections) |
Detailed Description
Member Function Documentation
[explicit] GenericPluginInterface::GenericPluginInterface(QObject *parent = nullptr)
Constructs a GenericPluginInterface. @param parent The parent QObject
[override virtual noexcept] GenericPluginInterface::~GenericPluginInterface()
Destructs the GenericPluginInterface.
QList<PimCommon::ActionType> GenericPluginInterface::actionTypes() const
Returns the list of action types. @return The action types
See also setActionTypes().
void GenericPluginInterface::addActionType(PimCommon::ActionType type)
Adds an action type to this plugin. @param type The action type to add
[virtual] GenericPluginInterface::RequireTypes GenericPluginInterface::requiresFeatures() const
Returns the required features for this plugin. @return The required features as RequireTypes
void GenericPluginInterface::setActionTypes(const QList<PimCommon::ActionType> &type)
Sets the action types for this plugin. @param type The list of action types
See also actionTypes().
[virtual] void GenericPluginInterface::setCollections(const Akonadi::Collection::List &cols)
Sets the collections for this plugin. @param cols The list of Akonadi collections
[virtual] void GenericPluginInterface::setCurrentCollection(const Akonadi::Collection &col)
Sets the current collection for this plugin. @param col The current Akonadi collection
[virtual] void GenericPluginInterface::setCurrentItems(const Akonadi::Item::List &items)
Sets the current items for this plugin. @param items The list of current Akonadi items
[virtual] void GenericPluginInterface::setItems(const Akonadi::Item::List &items)
Sets the items for this plugin. @param items The list of Akonadi items
[virtual] void GenericPluginInterface::updateActions(int numberOfSelectedItems, int numberOfSelectedCollections)
Updates actions based on selection state. @param numberOfSelectedItems The number of selected items @param numberOfSelectedCollections The number of selected collections