#include <kdatatool.h>
Inherits TQObject.
Public Member Functions | |
KDataTool (TQObject *parent=0, const char *name=0) | |
void | setInstance (TDEInstance *instance) |
TDEInstance * | instance () const |
virtual bool | run (const TQString &command, void *data, const TQString &datatype, const TQString &mimetype)=0 |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
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 254 of file kdatatool.h.
Constructor & Destructor Documentation
◆ KDataTool()
KDataTool::KDataTool | ( | TQObject * | parent = 0 , |
const char * | name = 0 |
||
) |
Constructor The data-tool is only created when a menu-item, that relates to it, is activated.
- Parameters
-
parent the parent of the TQObject (or 0 for parent-less KDataTools) name the name of the TQObject, can be 0
Definition at line 269 of file kdatatool.cpp.
Member Function Documentation
◆ instance()
TDEInstance * KDataTool::instance | ( | ) | 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 274 of file kdatatool.cpp.
◆ run()
|
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 TQString, but the mimetype can be text/plain, text/html etc.)
- Returns
- true if successful, false otherwise
The documentation for this class was generated from the following files: