KDE API Reference

KDE API Reference
KIOWidgets
KAbstractFileItemActionPlugin

KAbstractFileItemActionPlugin Class

Header:	`#include <KAbstractFileItemActionPlugin>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS KIOWidgets)` `target_link_libraries(mytarget PRIVATE Qt6::KIOWidgets)`

List of all members, including inherited members

Public Functions

virtual QList<QAction *> actions(const KFileItemListProperties &fileItemInfos, QWidget *parentWidget) = 0

Signals

void	error(const QString &errorMessage)

Detailed Description

@class KAbstractFileItemActionPlugin kabstractfileitemactionplugin.h <KAbstractFileItemActionPlugin>

@brief Base class for KFileItemAction plugins.

KFileItemAction plugins allow dynamic features to be added to the context menus for files and directories when browsing.

Most filetype-based popup menu items can be implemented using servicemenus linked to MIME types, and that should be the preferred way of doing this. However, complex scenarios such as showing submenus with a variable number of actions or only showing an item if exactly two files are selected need to be implemented as a KFileItemAction plugin.

To create such a plugin, subclass KAbstractFileItemActionPlugin and implement actions() to return the actions to want to add to the context menu. Then create a plugin in the usual KPluginFactory based way:

K_PLUGIN_CLASS_WITH_JSON(MyActionPlugin, "myactionplugin.json")
#include <thisfile.moc>

A desktop file is necessary to register the plugin with the KDE plugin system:

[Desktop Entry]
Type=Service
Name=My fancy action plugin
X-KDE-Library=myactionplugin
X-KDE-ServiceTypes=KFileItemAction/Plugin
MimeType=some/mimetype;

Note the \p KFileItemAction/Plugin service type which is used by KFileItemActions::addServicePluginActionsTo() to load all available plugins and the \p MimeType field which specifies for which types of file items the setup() method should be called.

The desktop file contents must also be compiled into the plugin as JSON data. The following CMake code builds and installs the plugin:

kcoreaddons_add_plugin(myactionplugin SOURCES myactionplugin.cpp INSTALL_NAMESPACE "kf5/kfileitemaction")
kcoreaddons_desktop_to_json(myactionplugin myactionplugin.desktop) # generate the json file

target_link_libraries(myactionplugin KF5::KIOWidgets)

@note the plugin should be installed in the "kf5/kfileitemaction" subfolder of $QT_PLUGIN_PATH. @note If the plugin has a lower priority and should show up in the "Actions" submenu, you can set the X-KDE-Show-In-Submenu property to true.

@author Sebastian Trueg <trueg@kde.org>

@since 4.6.1

Member Function Documentation

`[pure virtual]` QList<QAction > KAbstractFileItemActionPlugin::actions(const KFileItemListProperties &fileItemInfos*, QWidget **parentWidget*)

Implement the actions method in the plugin in order to create actions.

@param fileItemInfos Information about the selected file items. @param parentWidget To be used as parent for the returned QActions

@return A list of actions to be added to a contextual menu for the file items.

`[signal]` void KAbstractFileItemActionPlugin::error(const QString &errorMessage)

Emits an error which will be displayed to the user @since 5.82