• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeio/tdeio
 

tdeio/tdeio

Public Member Functions | Protected Member Functions | List of all members
KDataTool Class Referenceabstract

#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 ( 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
parentthe parent of the TQObject (or 0 for parent-less KDataTools)
namethe name of the TQObject, can be 0

Definition at line 269 of file kdatatool.cpp.

Member Function Documentation

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.

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

Interface for 'running' this tool.

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

Parameters
commandis the command that was selected (see KDataToolInfo::commands())
datathe 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.
datatypedefines the type of data.
mimetypedefines 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:
  • kdatatool.h
  • kdatatool.cpp

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  •     tdecore
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  • tdeioslave
  •   http
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.8.8
This website is maintained by Timothy Pearson.