ToolsPluginInterface Class Reference

#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 ()

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 wether 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:

• ToolsPluginInterface.h
• ToolsPluginInterface.cpp