/usr/include/KF5/KIOWidgets/kabstractfileitemactionplugin.h is in libkf5kio-dev 5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | /* This file is part of the KDE project
Copyright (C) 2010 Sebastian Trueg <trueg@kde.org>
Based on konq_popupmenuplugin.h Copyright 2008 David Faure <faure@kde.org>
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Library General Public License as published
by the Free Software Foundation; either version 2 of the License or
( at your option ) version 3 or, at the discretion of KDE e.V.
( which shall act as a proxy as in section 14 of the GPLv3 ), any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KABSTRACTFILEITEMACTION_PLUGIN_H
#define KABSTRACTFILEITEMACTION_PLUGIN_H
#include "kiowidgets_export.h"
#include <QtCore/QObject>
class QAction;
class QMenu;
class QWidget;
class KFileItemListProperties;
/**
* @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:
* \code
* K_PLUGIN_FACTORY_WITH_JSON(MyActionPluginFactory, myactionplugin.json, registerPlugin<MyActionPlugin>();)
* #include <thisfile.moc>
* \endcode
*
* A desktop file is necessary to register the plugin with the KDE plugin system:
*
* \code
* [Desktop Entry]
* Encoding=UTF-8
* Type=Service
* Name=My fancy action plugin
* X-KDE-Library=myactionplugin
* ServiceTypes=KFileItemAction/Plugin
* MimeType=some/mimetype;
* \endcode
*
* 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:
* \code
* set(myactionplugin_SRCS myactionplugin.cpp)
*
* kcoreaddons_add_plugin(myactionplugin SOURCES ${myactionplugin_SRCS} INSTALL_NAMESPACE "kf5/kfileitemaction")
* kcoreaddons_desktop_to_json(myactionplugin myactionplugin.desktop) # generate the json file
*
* target_link_libraries(myactionplugin KF5::KIOWidgets)
* \endcode
*
* @note the plugin should be installed in the "kf5/kfileitemaction" subfolder of $QT_PLUGIN_PATH.
*
* @author Sebastian Trueg <trueg@kde.org>
*
* @since 4.6.1
*/
class KIOWIDGETS_EXPORT KAbstractFileItemActionPlugin : public QObject
{
Q_OBJECT
public:
KAbstractFileItemActionPlugin(QObject *parent);
virtual ~KAbstractFileItemActionPlugin();
/**
* Implement the actions method in the plugin in order to create actions.
*
* The returned actions should have the KAbstractFileItemActionPlugin object
* as their parent.
*
* @param fileItemInfos Information about the selected file items.
* @param parentWidget A parent widget for error messages or the like.
*
* @return A list of actions to be added to a contextual menu for the file
* items.
*/
virtual QList<QAction *> actions(const KFileItemListProperties &fileItemInfos,
QWidget *parentWidget) = 0;
};
#endif
|