kio Library API Documentation

KDataToolAction Class Reference

This class helps applications implement support for KDataTool. More...

#include <kdatatool.h>

Inheritance diagram for KDataToolAction:

Inheritance graph
[legend]
Collaboration diagram for KDataToolAction:

Collaboration graph
[legend]
List of all members.

Signals

void toolActivated (const KDataToolInfo &info, const QString &command)

Public Member Functions

 KDataToolAction (const QString &text, const KDataToolInfo &info, const QString &command, QObject *parent=0, const char *name=0)

Static Public Member Functions

QPtrList< KActiondataToolActionList (const QValueList< KDataToolInfo > &tools, const QObject *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:

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 const QString text,
const KDataToolInfo info,
const QString command,
QObject 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 226 of file kdatatool.cpp.

References KDataToolAction().

Referenced by KDataToolAction().


Member Function Documentation

QPtrList< KAction > KDataToolAction::dataToolActionList const QValueList< KDataToolInfo > &  tools,
const QObject receiver,
const char *  slot
[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 KActions

Definition at line 239 of file kdatatool.cpp.

References dataToolActionList(), endl(), kdWarning(), and toolActivated().

Referenced by dataToolActionList().

void KDataToolAction::toolActivated const KDataToolInfo info,
const QString command
[signal]
 

Emitted when a tool has been activated.

Parameters:
info a description of the activated tools
command the command for the tool

Referenced by dataToolActionList().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 14 00:21:35 2005 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003