---

KDataTool Class Reference

#include <kdatatool.h>

List of all members.

Public Methods
	KDataTool (QObject *parent=0, const char *name=0)
KInstance *	instance () const
virtual bool	run (const QString &command, void *data, const QString &datatype, const QString &mimetype)=0

---

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 210 of file kdatatool.h.

---

Constructor & Destructor Documentation

KDataTool::KDataTool (  QObject *    parent = 0, const char *    name = 0 )

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

---

Member Function Documentation

KInstance* KDataTool::instance (    )

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.

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.)

---

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

• kdatatool.h

---