#include <kdatatool.h>

Inheritance diagram for KDataToolAction:

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

Signals inherited from KAction
void	authorized (KAuth::Action *action)

void	globalShortcutChanged (const QKeySequence &)

void	triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)

Public Member Functions
	KDataToolAction (const QString &text, const KDataToolInfo &info, const QString &command, QObject *parent)

	~KDataToolAction ()

Public Member Functions inherited from KAction
	KAction (QObject *parent)

	KAction (const QString &text, QObject *parent)

	KAction (const KIcon &icon, const QString &text, QObject *parent)

virtual	~KAction ()

KAuth::Action *	authAction () const

bool	event (QEvent *)

void	forgetGlobalShortcut ()

const KShortcut &	globalShortcut (ShortcutTypes type=ActiveShortcut) const

bool	globalShortcutAllowed () const

bool	isGlobalShortcutEnabled () const

bool	isShortcutConfigurable () const

KRockerGesture	rockerGesture (ShortcutTypes type=ActiveShortcut) const

void	setAuthAction (KAuth::Action *action)

void	setAuthAction (const QString &actionName)

void	setGlobalShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut\|DefaultShortcut), GlobalShortcutLoading loading=Autoloading)

void	setGlobalShortcutAllowed (bool allowed, GlobalShortcutLoading loading=Autoloading)

void	setHelpText (const QString &text)

void	setRockerGesture (const KRockerGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut\|DefaultShortcut))

void	setShapeGesture (const KShapeGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut\|DefaultShortcut))

void	setShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut\|DefaultShortcut))

void	setShortcut (const QKeySequence &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut\|DefaultShortcut))

void	setShortcutConfigurable (bool configurable)

void	setShortcuts (const QList< QKeySequence > &shortcuts, ShortcutTypes type=ShortcutTypes(ActiveShortcut\|DefaultShortcut))

KShapeGesture	shapeGesture (ShortcutTypes type=ActiveShortcut) const

KShortcut	shortcut (ShortcutTypes types=ActiveShortcut) const

Public Member Functions inherited from QAction
	QAction (QObject *parent)

	QAction (const QString &text, QObject *parent)

	QAction (QObject parent, const char name)

	QAction (const QString &text, const QKeySequence &shortcut, QObject parent, const char name)

	QAction (const QIcon &icon, const QString &text, QObject *parent)

	QAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, QObject parent, const char name)

	~QAction ()

QKeySequence	accel () const

QActionGroup *	actionGroup () const

void	activate (ActionEvent event)

void	activated (int i)

bool	addTo (QWidget *w)

QList< QGraphicsWidget * >	associatedGraphicsWidgets () const

QList< QWidget * >	associatedWidgets () const

bool	autoRepeat () const

void	changed ()

QVariant	data () const

QFont	font () const

void	hover ()

void	hovered ()

QIcon	icon () const

QIcon	iconSet () const

QString	iconText () const

bool	isCheckable () const

bool	isChecked () const

bool	isEnabled () const

bool	isIconVisibleInMenu () const

bool	isOn () const

bool	isSeparator () const

bool	isToggleAction () const

bool	isVisible () const

QMenu *	menu () const

MenuRole	menuRole () const

QString	menuText () const

QWidget *	parentWidget () const

Priority	priority () const

bool	removeFrom (QWidget *w)

void	setAccel (const QKeySequence &shortcut)

void	setActionGroup (QActionGroup *group)

void	setAutoRepeat (bool)

void	setCheckable (bool)

void	setChecked (bool)

void	setData (const QVariant &userData)

void	setDisabled (bool b)

void	setEnabled (bool)

void	setFont (const QFont &font)

void	setIcon (const QIcon &icon)

void	setIconSet (const QIcon &i)

void	setIconText (const QString &text)

void	setIconVisibleInMenu (bool visible)

void	setMenu (QMenu *menu)

void	setMenuRole (MenuRole menuRole)

void	setMenuText (const QString &text)

void	setOn (bool b)

void	setPriority (Priority priority)

void	setSeparator (bool b)

void	setShortcut (const QKeySequence &shortcut)

void	setShortcutContext (Qt::ShortcutContext context)

void	setShortcuts (QKeySequence::StandardKey key)

void	setShortcuts (const QList< QKeySequence > &shortcuts)

void	setSoftKeyRole (SoftKeyRole softKeyRole)

void	setStatusTip (const QString &statusTip)

void	setText (const QString &text)

void	setToggleAction (bool b)

void	setToolTip (const QString &tip)

void	setVisible (bool)

void	setWhatsThis (const QString &what)

QKeySequence	shortcut () const

Qt::ShortcutContext	shortcutContext () const

QList< QKeySequence >	shortcuts () const

bool	showStatusText (QWidget *widget)

SoftKeyRole	softKeyRole () const

QString	statusTip () const

QString	text () const

void	toggle ()

void	toggled (bool checked)

QString	toolTip () const

void	trigger ()

void	triggered (bool checked)

QString	whatsThis () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QWidgetAction
	QWidgetAction (QObject *parent)

virtual	~QWidgetAction ()

QWidget *	defaultWidget () const

void	releaseWidget (QWidget *widget)

QWidget *	requestWidget (QWidget *parent)

void	setDefaultWidget (QWidget *widget)

Static Public Member Functions
static QList< QAction * >	dataToolActionList (const QList< KDataToolInfo > &tools, const QObject receiver, const char slot, KActionCollection *parent)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions
virtual void	slotActivated ()

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QWidgetAction
QList< QWidget * >	createdWidgets () const

virtual QWidget *	createWidget (QWidget *parent)

virtual void	deleteWidget (QWidget *widget)

virtual bool	eventFilter (QObject obj, QEvent event)

Additional Inherited Members
Public Types inherited from KAction
enum	GlobalShortcutLoading

enum	ShortcutType

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from KAction
KShortcut	globalShortcut

bool	globalShortcutAllowed

bool	globalShortcutEnabled

KShortcut	shortcut

bool	shortcutConfigurable

Properties inherited from QAction
	autoRepeat

	checkable

	checked

	enabled

	font

	icon

	iconText

	iconVisibleInMenu

	menuRole

	priority

	shortcut

	shortcutContext

	softKeyRole

	statusTip

	text

	toolTip

	visible

	whatsThis

Properties inherited from QObject
	objectName

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 201 of file kdatatool.h.

Constructor & Destructor Documentation

KDataToolAction::KDataToolAction	(	const QString &	text,
		const KDataToolInfo &	info,
		const QString &	command,
		QObject *	parent
	)

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	The name of the action

Definition at line 254 of file kdatatool.cpp.

KDataToolAction::~KDataToolAction ( )

Destructor.

Definition at line 264 of file kdatatool.cpp.

Member Function Documentation

QList< QAction * > KDataToolAction::dataToolActionList	(	const QList< KDataToolInfo > &	tools,
		const QObject *	receiver,
		const char *	slot,
		KActionCollection *	parent
	)

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
parent	the parent action collection for the actions to be created

Returns: the KActions

Definition at line 274 of file kdatatool.cpp.

void KDataToolAction::slotActivated ( )

protectedvirtual

Definition at line 269 of file kdatatool.cpp.

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

The documentation for this class was generated from the following files:

KIO

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KIO

kdelibs API Reference

Search