KIO
#include <kdatatool.h>

Signals | |
void | toolActivated (const KDataToolInfo &info, const QString &command) |
![]() | |
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 () | |
![]() | |
KAction (const KIcon &icon, const QString &text, QObject *parent) | |
KAction (const QString &text, QObject *parent) | |
KAction (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 (const QString &actionName) |
void | setAuthAction (KAuth::Action *action) |
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 |
Static Public Member Functions | |
static QList< QAction * > | dataToolActionList (const QList< KDataToolInfo > &tools, const QObject *receiver, const char *slot, KActionCollection *parent) |
Protected Member Functions | |
virtual void | slotActivated () |
Additional Inherited Members | |
![]() | |
enum | GlobalShortcutLoading |
enum | ShortcutType |
![]() | |
ActiveShortcut | |
Autoloading | |
DefaultShortcut | |
NoAutoloading | |
![]() | |
KShortcut | globalShortcut |
bool | globalShortcutAllowed |
bool | globalShortcutEnabled |
KShortcut | shortcut |
bool | shortcutConfigurable |
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::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::~KDataToolAction | ( | ) |
Destructor.
Definition at line 264 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 parent the parent action collection for the actions to be created
- Returns
- the KActions
Definition at line 274 of file kdatatool.cpp.
◆ slotActivated()
|
protectedvirtual |
Definition at line 269 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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.