org.kde.koala

Class KDataToolAction

public class KDataToolAction extends KAction

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. See KDataToolActionSignals for signals emitted by KDataToolAction

    UNKNOWN: This class helps applications implement support for KDataTool.

    Constructor Summary
    protected KDataToolAction(Class dummy)
    KDataToolAction(String text, KDataToolInfo info, String command, QObject parent, String name)
    Constructs a new KDataToolAction.
    KDataToolAction(String text, KDataToolInfo info, String command, QObject parent)
    KDataToolAction(String text, KDataToolInfo info, String command)
    Method Summary
    StringclassName()
    voiddispose()
    Delete the wrapped C++ instance ahead of finalize()
    protected voidfinalize()
    Deletes the wrapped C++ instance
    booleanisDisposed()
    Has the wrapped C++ instance been deleted?
    QMetaObjectmetaObject()
    protected voidslotActivated()
    Creates a list of actions from a list of information about data-tools.

    Constructor Detail

    KDataToolAction

    protected KDataToolAction(Class dummy)

    KDataToolAction

    public KDataToolAction(String text, KDataToolInfo info, String command, QObject parent, String name)
    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.

    UNKNOWN: Constructs a new KDataToolAction.

    KDataToolAction

    public KDataToolAction(String text, KDataToolInfo info, String command, QObject parent)

    KDataToolAction

    public KDataToolAction(String text, KDataToolInfo info, String command)

    Method Detail

    className

    public String className()

    dispose

    public void dispose()
    Delete the wrapped C++ instance ahead of finalize()

    finalize

    protected void finalize()
    Deletes the wrapped C++ instance

    isDisposed

    public boolean isDisposed()
    Has the wrapped C++ instance been deleted?

    metaObject

    public QMetaObject metaObject()

    slotActivated

    protected void slotActivated()
    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

    UNKNOWN: Creates a list of actions from a list of information about data-tools.