#include <ToolsPluginInterface.h>

Inheritance diagram for ToolsPluginInterface:

Public Member Functions
	ToolsPluginInterface (const KComponentData &instance, QObject *parent)

virtual	~ToolsPluginInterface ()

QString	displayName ()

QString	pluginId () const

KPluginInfo	pluginInfo ()

virtual void	run (Document *document=0) const =0

QStringList	supportedDataStructures ()

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

This interface must be implemented by all Visual graph editor tools.

To create a plugin, it is necessary to provide a desktop file that contains the following information:

[Desktop Entry]
Encoding=UTF-8
Type=Service
#Icon=icon
ServiceTypes=Rocs/ToolPlugin
X-KDE-Library=rocs_mytool                                   # Name of tool library
X-KDE-PluginInfo-Author=Rocs Developers
X-KDE-PluginInfo-Email=rocs-devel@kde.org
X-KDE-PluginInfo-Name=Transform Edges Rocs Tool Plugin
X-KDE-PluginInfo-Version=0.0.1
X-KDE-PluginInfo-Website=http://edu.kde.org/rocs/
X-KDE-PluginInfo-Category=Plugins
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=false
X-Rocs-SupportedDataStructures=Graph,LinkedList             # Comma separated list of supprted backends
Name=My Tool                                                # Tool name for user visible strings
Comment=This tool makes cool things, i.e. ...               # Tool description.

Further, the plugin itself is generated by the following factory method:

typedef KGenericFactory<MyTool> ToolsPluginFactory;
static const KAboutData aboutdata("rocs_mytool", 0, ki18n("MyTool") , "0.0.1");
K_EXPORT_COMPONENT_FACTORY( rocs_mytool, ToolsPluginFactory( &aboutdata )  )
MyTool::MyTool(QObject *parent, const char *name, const QStringList &args)
    : ToolsPluginInterface(ToolsPluginFactory::componentData(), parent)
{
    //...
}

Definition at line 73 of file ToolsPluginInterface.h.

Constructor & Destructor Documentation

ToolsPluginInterface::ToolsPluginInterface	(	const KComponentData &	instance,
		QObject *	parent
	)

Definition at line 35 of file ToolsPluginInterface.cpp.

ToolsPluginInterface::~ToolsPluginInterface ( )

virtual

Definition at line 43 of file ToolsPluginInterface.cpp.

Member Function Documentation

QString ToolsPluginInterface::displayName ( )

Returns the display name of this plugin.

This is a convenience method that simply calls pluginInfo->name().

Definition at line 54 of file ToolsPluginInterface.cpp.

QString ToolsPluginInterface::pluginId ( ) const

Return the plugin identifier.

Returns: the plugin's id, which is QObject::metaObject()->className()

Definition at line 48 of file ToolsPluginInterface.cpp.

KPluginInfo ToolsPluginInterface::pluginInfo ( )

Return the KPluginInfo object associated with this plugin.

Definition at line 64 of file ToolsPluginInterface.cpp.

virtual void ToolsPluginInterface::run ( Document * document = 0 ) const

pure virtual

Implement this method for each plugin.

The implementation shall execute the tool at the given document document or, if not given, at the active document as given by the DocumentManager.

Parameters

document is the graph document at that the tool shall operate

Implemented in AssignValuesToolPlugin, GenerateGraphToolPlugin, and TransformEdgesToolPlugin.

QStringList ToolsPluginInterface::supportedDataStructures ( )

Gives list of supported data structures of the tool.

Use this method to check whether the tool plugin is compatible with the given data structure backend. The list of supported backends consists of data structure backend identifiers as given by DataStructureBackendInterface::internalName().

Returns: list of supported data structure backend identifiers

Definition at line 59 of file ToolsPluginInterface.cpp.

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

rocs/VisualEditor

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

rocs/VisualEditor

kdeedu API Reference

Search