.TH "KDataToolAction" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDataToolAction \- This class helps applications implement support for \fBKDataTool\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdatatool.h>\fP
.PP
Inherits \fBKAction\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBtoolActivated\fP (const \fBKDataToolInfo\fP &info, const \fBQString\fP &command)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDataToolAction\fP (const \fBQString\fP &\fBtext\fP, const \fBKDataToolInfo\fP &info, const \fBQString\fP &command, \fBQObject\fP *\fBparent\fP=0, const char *\fBname\fP=0)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBQPtrList\fP< \fBKAction\fP > \fBdataToolActionList\fP (const \fBQValueList\fP< \fBKDataToolInfo\fP > &tools, const \fBQObject\fP *receiver, const char *slot)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBslotActivated\fP ()"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This class helps applications implement support for \fBKDataTool\fP. 

The steps to follow are simple: 
.PD 0

.IP "\(bu" 2
query for the available tools using \fBKDataToolInfo::query\fP 
.IP "\(bu" 2
pass the result to \fBKDataToolAction::dataToolActionList\fP (with a slot) 
.IP "\(bu" 2
plug the resulting actions, either using \fBKXMLGUIClient::plugActionList\fP, or by hand.
.PP
The slot defined for step 2 is called when the action is activated, and that's where the tool should be created and run. 
.PP
Definition at line 194 of file kdatatool.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDataToolAction::KDataToolAction (const \fBQString\fP & text, const \fBKDataToolInfo\fP & info, const \fBQString\fP & command, \fBQObject\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Constructs a new KDataToolAction. 
.PP
\fBParameters:\fP
.RS 4
\fItext\fP The text that will be displayed. 
.br
\fIinfo\fP the corresponding \fBKDataToolInfo\fP 
.br
\fIcommand\fP the command of the action 
.br
\fIparent\fP This action's parent. 
.br
\fIname\fP An internal name for this action. 
.RE
.PP

.PP
Definition at line 226 of file kdatatool.cpp.
.PP
Referenced by dataToolActionList().
.SH "Member Function Documentation"
.PP 
.SS "\fBQPtrList\fP< \fBKAction\fP > KDataToolAction::dataToolActionList (const \fBQValueList\fP< \fBKDataToolInfo\fP > & tools, const \fBQObject\fP * receiver, const char * slot)\fC [static]\fP"
.PP
Creates a list of actions from a list of information about data-tools. 
.PP
The slot must have a signature corresponding to the toolActivated signal.
.PP
Note that it's the caller's responsibility to delete the actions when they're not needed anymore. 
.PP
\fBParameters:\fP
.RS 4
\fItools\fP the list of data tool descriptions 
.br
\fIreceiver\fP the receiver for \fBtoolActivated()\fP signals 
.br
\fIslot\fP the slot that will receive the \fBtoolActivated()\fP signals 
.RE
.PP
\fBReturns:\fP
.RS 4
the KActions 
.RE
.PP

.PP
Definition at line 239 of file kdatatool.cpp.
.PP
References QPtrList::append(), QObject::connect(), QValueList::end(), endl(), KDataToolAction(), kdWarning(), and toolActivated().
.SS "void KDataToolAction::toolActivated (const \fBKDataToolInfo\fP & info, const \fBQString\fP & command)\fC [signal]\fP"
.PP
Emitted when a tool has been activated. 
.PP
\fBParameters:\fP
.RS 4
\fIinfo\fP a description of the activated tools 
.br
\fIcommand\fP the command for the tool 
.RE
.PP

.PP
Referenced by dataToolActionList().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
