#include <kdatatool.h>
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 245 of file kdatatool.h.
Constructor & Destructor Documentation
Constructor The data-tool is only created when a menu-item, that relates to it, is activated.
- Parameters
-
Definition at line 292 of file kdatatool.cpp.
Destructor.
Definition at line 297 of file kdatatool.cpp.
Member Function Documentation
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 307 of file kdatatool.cpp.
Interface for 'running' this tool.
This is the method that the data-tool must implement.
- Parameters
-
- Returns
- true if successful, false otherwise
. Do not use under any circumstance (including bad weather).
Definition at line 302 of file kdatatool.cpp..