#include <kdatatool.h>

Inheritance diagram for KDataTool:

Public Member Functions
	KDataTool (QObject *parent=0)

	~KDataTool ()

const KComponentData &	componentData () const

virtual bool	run (const QString &command, void *data, const QString &datatype, const QString &mimetype)=0

void	setComponentData (const KComponentData &componentData)

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

A generic tool that processes data.

A data-tool is a "plugin" for an application, that acts (reads/modifies) on a portion of the data present in the document (e.g. a text document, a single word or paragraph, a KSpread cell, an image, etc.)

The application has some generic code for presenting the tools in a popupmenu

See also: KDataToolAction, and for activating a tool, passing it the data (and possibly getting modified data from it).

Definition at line 262 of file kdatatool.h.

Constructor & Destructor Documentation

KDataTool::KDataTool ( QObject * parent = 0 )

Constructor The data-tool is only created when a menu-item, that relates to it, is activated.

Parameters

parent the parent of the QObject (or 0 for parent-less KDataTools)

Definition at line 323 of file kdatatool.cpp.

KDataTool::~KDataTool ( )

Destructor.

Definition at line 328 of file kdatatool.cpp.

Member Function Documentation

const KComponentData & KDataTool::componentData ( ) const

Returns the instance of the part that created this tool.

Usually used if the tool wants to read its configuration in the app's config file.

Returns: the instance of the part that created this tool.

Definition at line 338 of file kdatatool.cpp.

virtual bool KDataTool::run	(	const QString &	command,
		void *	data,
		const QString &	datatype,
		const QString &	mimetype
	)

pure virtual

Interface for 'running' this tool.

This is the method that the data-tool must implement.

Parameters

command	is the command that was selected (see KDataToolInfo::commands())
data	the data provided by the application, on which to run the tool. The application is responsible for setting that data before running the tool, and for getting it back and updating itself with it, after the tool ran.
datatype	defines the type of `data`.
mimetype	defines the mimetype of the data (for instance datatype may be QString, but the mimetype can be text/plain, text/html etc.)

Returns: true if successful, false otherwise

void KDataTool::setComponentData ( const KComponentData & componentData )

. Do not use under any circumstance (including bad weather).

Definition at line 333 of file kdatatool.cpp.

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

KIO

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KIO

kdelibs API Reference

Search