Signals |
Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
KDataToolAction Class Reference
#include <kdatatool.h>
Inherits TDEAction.
Signals | |
void | toolActivated (const KDataToolInfo &info, const TQString &command) |
Public Member Functions | |
KDataToolAction (const TQString &text, const KDataToolInfo &info, const TQString &command, TQObject *parent=0, const char *name=0) | |
Static Public Member Functions | |
static TQPtrList< TDEAction > | dataToolActionList (const TQValueList< KDataToolInfo > &tools, const TQObject *receiver, const char *slot) |
Protected Member Functions | |
virtual void | slotActivated () |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
This class helps applications implement support for KDataTool.
The steps to follow are simple:
- query for the available tools using KDataToolInfo::query
- pass the result to KDataToolAction::dataToolActionList (with a slot)
- plug the resulting actions, either using KXMLGUIClient::plugActionList, or by hand.
The slot defined for step 2 is called when the action is activated, and that's where the tool should be created and run.
Definition at line 194 of file kdatatool.h.
Constructor & Destructor Documentation
◆ KDataToolAction()
KDataToolAction::KDataToolAction | ( | const TQString & | text, |
const KDataToolInfo & | info, | ||
const TQString & | command, | ||
TQObject * | parent = 0 , |
||
const char * | name = 0 |
||
) |
Constructs a new KDataToolAction.
- Parameters
-
text The text that will be displayed. info the corresponding KDataToolInfo command the command of the action parent This action's parent. name An internal name for this action.
Definition at line 218 of file kdatatool.cpp.
Member Function Documentation
◆ dataToolActionList()
|
static |
Creates a list of actions from a list of information about data-tools.
The slot must have a signature corresponding to the toolActivated signal.
Note that it's the caller's responsibility to delete the actions when they're not needed anymore.
- Parameters
-
tools the list of data tool descriptions receiver the receiver for toolActivated() signals slot the slot that will receive the toolActivated() signals
- Returns
- the TDEActions
Definition at line 231 of file kdatatool.cpp.
◆ toolActivated
|
signal |
Emitted when a tool has been activated.
- Parameters
-
info a description of the activated tools command the command for the tool
The documentation for this class was generated from the following files: