KAbstractFileItemActionPlugin Class Reference

#include <kabstractfileitemactionplugin.h>

Inheritance diagram for KAbstractFileItemActionPlugin:

Public Member Functions
	KAbstractFileItemActionPlugin (QObject *parent)
virtual	~KAbstractFileItemActionPlugin ()
virtual QList< QAction * >	actions (const KFileItemListProperties &fileItemInfos, QWidget *parentWidget)=0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Base class for KFileItemAction plugins.

Please try to use servicemenus first, if you simply need to add actions to the popup menu for one or more mimetypes.

However if you need some dynamic logic, like "only show this item if two files are selected", or "show a submenu with a variable number of actions", then you have to implement a KAbstractFileItemActionPlugin subclass.

As always plugins need to be exported via the K_EXPORT_PLUGIN macro like so:

K_PLUGIN_FACTORY(MyActionPluginFactory, registerPlugin<MyActionPlugin>();)
K_EXPORT_PLUGIN(MyActionPluginFactory("myactionplugin"))

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

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

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

As with all KDE plugins one needs to install the plugin as a module. In cmake terms this looks roughly as follows:

kde4_add_plugin(myactionplugin myactionplugin.cpp)
target_link_libraries(myactionplugin ${KDE4_KIO_LIBS})
install(TARGETS myactionplugin DESTINATION ${PLUGIN_INSTALL_DIR})
install(FILES myactionplugin.desktop DESTINATION ${SERVICES_INSTALL_DIR})

Author

Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org

Since

4.6.1

Definition at line 81 of file kabstractfileitemactionplugin.h.

Constructor & Destructor Documentation

KAbstractFileItemActionPlugin::KAbstractFileItemActionPlugin

(

QObject *

parent

)

Definition at line 23 of file kabstractfileitemactionplugin.cpp.

KAbstractFileItemActionPlugin::~KAbstractFileItemActionPlugin ( )

virtual

Definition at line 28 of file kabstractfileitemactionplugin.cpp.

Member Function Documentation

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

pure virtual

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

Parameters

fileItemInfos	The information about the selected file items. (Which file items, their common mimetype, etc.)
parentWidget	A parent widget for error messages or the like.

Returns

List of actions, that should added to e. g. the popup menu. It is recommended to use the KAbstractFileItemActionPlugin as parent of the actions.

---

The documentation for this class was generated from the following files:

• kabstractfileitemactionplugin.h
• kabstractfileitemactionplugin.cpp