KAction Class Reference
Class to encapsulate user-driven action or event. More...
#include <kaction.h>
Inheritance diagram for KAction:

Public Types | |
enum | ActivationReason { UnknownActivation, EmulatedActivation, AccelActivation, PopupMenuActivation, ToolBarActivation } |
Public Slots | |
virtual void | setText (const QString &text) |
virtual bool | setShortcut (const KShortcut &) |
virtual void | setGroup (const QString &) |
virtual void | setWhatsThis (const QString &text) |
virtual void | setToolTip (const QString &) |
virtual void | setIconSet (const QIconSet &iconSet) |
virtual void | setIcon (const QString &icon) |
virtual void | setEnabled (bool enable) |
virtual void | setShortcutConfigurable (bool) |
virtual void | activate () |
Signals | |
void | activated () |
void | activated (KAction::ActivationReason reason, Qt::ButtonState state) |
void | enabled (bool) |
Public Member Functions | |
KAction (const QString &text, const KShortcut &cut, const QObject *receiver, const char *slot, KActionCollection *parent, const char *name) | |
KAction (const QString &text, const QIconSet &pix, const KShortcut &cut, const QObject *receiver, const char *slot, KActionCollection *parent, const char *name) | |
KAction (const QString &text, const QString &pix, const KShortcut &cut, const QObject *receiver, const char *slot, KActionCollection *parent, const char *name) | |
KAction (const KGuiItem &item, const KShortcut &cut, const QObject *receiver, const char *slot, KActionCollection *parent, const char *name) | |
KAction (const QString &text, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0) | |
KAction (const QString &text, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0) | |
KAction (const QString &text, const QIconSet &pix, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0) | |
KAction (const QString &text, const QString &pix, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0) | |
KAction (const QString &text, const QIconSet &pix, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0) | |
KAction (const QString &text, const QString &pix, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0) | |
KAction (QObject *parent=0, const char *name=0) | |
virtual | ~KAction () |
virtual int | plug (QWidget *widget, int index=-1) |
virtual void | plugAccel (KAccel *accel, bool configurable=true) KDE_DEPRECATED |
virtual void | unplug (QWidget *w) |
virtual void | unplugAccel () KDE_DEPRECATED |
virtual bool | isPlugged () const |
bool | isPlugged (const QWidget *container) const |
virtual bool | isPlugged (const QWidget *container, int id) const |
virtual bool | isPlugged (const QWidget *container, const QWidget *_representative) const |
QWidget * | container (int index) const |
int | itemId (int index) const |
QWidget * | representative (int index) const |
int | containerCount () const |
uint | kaccelCount () const |
virtual bool | hasIcon () const |
bool | hasIconSet () const |
virtual QString | plainText () const |
virtual QString | text () const |
virtual const KShortcut & | shortcut () const |
virtual const KShortcut & | shortcutDefault () const |
QString | shortcutText () const |
void | setShortcutText (const QString &) |
virtual bool | isEnabled () const |
virtual bool | isShortcutConfigurable () const |
virtual QString | group () const |
virtual QString | whatsThis () const |
virtual QString | toolTip () const |
virtual QIconSet | iconSet (KIcon::Group group, int size=0) const |
QIconSet | iconSet () const |
virtual QString | icon () const |
KActionCollection * | parentCollection () const |
void | unplugAll () |
int | accel () const KDE_DEPRECATED |
QString | statusText () const |
void | setAccel (int key) KDE_DEPRECATED |
void | setStatusText (const QString &text) |
int | menuId (int i) |
Static Public Member Functions | |
static int | getToolButtonID () |
Protected Slots | |
virtual void | slotDestroyed () |
virtual void | slotKeycodeChanged () |
virtual void | slotActivated () |
void | slotPopupActivated () |
void | slotButtonClicked (int, Qt::ButtonState state) |
Protected Member Functions | |
KToolBar * | toolBar (int index) const |
QPopupMenu * | popupMenu (int index) const |
void | removeContainer (int index) |
int | findContainer (const QWidget *widget) const |
int | findContainer (int id) const |
void | plugMainWindowAccel (QWidget *w) |
void | addContainer (QWidget *parent, int id) |
void | addContainer (QWidget *parent, QWidget *representative) |
virtual void | updateShortcut (int i) |
virtual void | updateShortcut (QPopupMenu *menu, int id) |
virtual void | updateGroup (int id) |
virtual void | updateText (int i) |
virtual void | updateEnabled (int i) |
virtual void | updateIconSet (int i) |
virtual void | updateIcon (int i) |
virtual void | updateToolTip (int id) |
virtual void | updateWhatsThis (int i) |
QString | whatsThisWithIcon () const |
const KGuiItem & | guiItem () const |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KActionCollection * | m_parentCollection |
Properties | |
int | containerCount |
QString | plainText |
QString | text |
QString | shortcut |
bool | enabled |
QString | group |
QString | whatsThis |
QString | toolTip |
QString | icon |
Friends | |
class | KActionCollection |
Detailed Description
Class to encapsulate user-driven action or event.The KAction class (and derived and super classes) provides a way to easily encapsulate a "real" user-selected action or event in your program.
For instance, a user may want to paste
the contents of the clipboard or scroll
down
a document or quit
the application. These are all actions
-- events that the user causes to happen. The KAction class allows the developer to deal with these actions in an easy and intuitive manner.
Specifically, the KAction class encapsulated the various attributes to an event/action. For instance, an action might have an icon that goes along with it (a clipboard for a "paste" action or scissors for a "cut" action). The action might have some text to describe the action. It will certainly have a method or function that actually executes
the action! All these attributes are contained within the KAction object.
The advantage of dealing with Actions is that you can manipulate the Action without regard to the GUI representation of it. For instance, in the "normal" way of dealing with actions like "cut", you would manually insert a item for Cut into a menu and a button into a toolbar. If you want to disable the cut action for a moment (maybe nothing is selected), you would have to hunt down the pointer to the menu item and the toolbar button and disable both individually. Setting the menu item and toolbar item up uses very similar code - but has to be done twice!
With the Action concept, you simply "plug" the Action into whatever GUI element you want. The KAction class will then take care of correctly defining the menu item (with icons, accelerators, text, etc) or toolbar button.. or whatever. From then on, if you manipulate the Action at all, the effect will propogate through all GUI representations of it. Back to the "cut" example: if you want to disable the Cut Action, you would simply do 'cutAction->setEnabled(false)' and the menuitem and button would instantly be disabled!
This is the biggest advantage to the Action concept -- there is a one-to-one relationship between the "real" action and all
GUI representations of it.
KAction emits the activated() signal if the user activated the corresponding GUI element ( menu item, toolbar button, etc. )
If you are in the situation of wanting to map the activated() signal of multiple action objects to one slot, with a special argument bound to each action, then you might consider using QSignalMapper . A tiny example:
QSignalMapper *desktopNumberMapper = new QSignalMapper( this ); connect( desktopNumberMapper, SIGNAL( mapped( int ) ), this, SLOT( moveWindowToDesktop( int ) ) ); for ( uint i = 0; i < numberOfDesktops; ++i ) { KAction *desktopAction = new KAction( i18n( "Move Window to Desktop %i" ).arg( i ), ... ); connect( desktopAction, SIGNAL( activated() ), desktopNumberMapper, SLOT( map() ) ); desktopNumberMapper->setMapping( desktopAction, i ); }
General Usage:
The steps to using actions are roughly as follows
- Decide which attributes you want to associate with a given action (icons, text, keyboard shortcut, etc)
- Create the action using KAction (or derived or super class).
- "Plug" the Action into whatever GUI element you want. Typically, this will be a menu or toolbar.
Here is an example of enabling a "New [document]" action
KAction *newAct = new KAction(i18n("&New"), "filenew", KStdAccel::shortcut(KStdAccel::New), this, SLOT(fileNew()), actionCollection(), "new");
QPopupMenu *file = new QPopupMenu; newAct->plug(file);
newAct->plug(toolBar());
That's it!
If you want to disable that action sometime later, you can do so with
newAct->setEnabled(false)
Do not delete a KAction object without unplugging it from all its containers. The simplest way to do that is to use the unplugAll() as in the following example:
newAct->unplugAll(); delete newAct;
Note: if you are using a "standard" action like "new", "paste", "quit", or any other action described in the KDE UI Standards, please use the methods in the KStdAction class rather than defining your own.
Usage Within the XML Framework:
If you are using KAction within the context of the XML menu and toolbar building framework, then there are a few tiny changes. The first is that you must insert your new action into an action collection. The action collection (a KActionCollection) is, logically enough, a central collection of all of the actions defined in your application. The XML UI framework code in KXMLGUI classes needs access to this collection in order to build up the GUI (it's how the builder code knows which actions are valid and which aren't).
Also, if you use the XML builder framework, then you do not ever have to plug your actions into containers manually. The framework does that for you.
- See also:
- KStdAction
Definition at line 202 of file kaction.h.
Member Enumeration Documentation
|
|
Constructor & Destructor Documentation
|
Constructs an action with text, potential keyboard shortcut, and a SLOT to call when this action is invoked by the user.
If you do not want or have a keyboard shortcut, set the This is the most common KAction used when you do not have a corresponding icon (note that it won't appear in the current version of the "Edit ToolBar" dialog, because an action needs an icon to be plugged in a toolbar...).
Definition at line 113 of file kaction.cpp. |
|
Constructs an action with text, icon, potential keyboard shortcut, and a SLOT to call when this action is invoked by the user.
If you do not want or have a keyboard shortcut, set the
This is the other common KAction used. Use it when you
Definition at line 130 of file kaction.cpp. |
|
Constructs an action with text, icon, potential keyboard shortcut, and a SLOT to call when this action is invoked by the user. The icon is loaded on demand later based on where it is plugged in.
If you do not want or have a keyboard shortcut, set the
This is the other common KAction used. Use it when you
Definition at line 121 of file kaction.cpp. |
|
The same as the above constructor, but with a KGuiItem providing the text and icon.
Definition at line 139 of file kaction.cpp. References setToolTip(), and setWhatsThis(). |
|
Definition at line 152 of file kaction.cpp. |
|
Definition at line 159 of file kaction.cpp. |
|
Definition at line 167 of file kaction.cpp. References setIconSet(). |
|
Definition at line 176 of file kaction.cpp. |
|
Definition at line 185 of file kaction.cpp. References setIconSet(). |
|
Definition at line 195 of file kaction.cpp. |
|
Definition at line 205 of file kaction.cpp. |
|
Standard destructor.
Definition at line 212 of file kaction.cpp. References endl(), kdDebug(), KActionCollection::take(), and unplugAccel(). |
Member Function Documentation
|
"Plug" or insert this action into a given widget. This will typically be a menu or a toolbar. From this point on, you will never need to directly manipulate the item in the menu or toolbar. You do all enabling/disabling/manipulation directly with your KAction object.
Reimplemented in KToggleAction, KSelectAction, KRecentFilesAction, KActionMenu, KToolBarPopupAction, KToggleToolBarAction, KWidgetAction, and KPasteTextAction. Definition at line 618 of file kaction.cpp. References KActionCollection::connectHighlight(), KActionCollection::count(), endl(), KToolBar::getButton(), getToolButtonID(), iconSet(), KToolBar::insertButton(), KGlobal::instance(), KActionCollection::instance(), kdDebug(), kdWarning(), slotButtonClicked(), and slotPopupActivated(). Referenced by KPasteTextAction::plug(), KToolBarPopupAction::plug(), and KToggleAction::plug(). |
|
Definition at line 763 of file kaction.cpp. References endl(), isEnabled(), kdBacktrace(), kdDebug(), kdWarning(), and unplugAccel(). |
|
"Unplug" or remove this action from a given widget. This will typically be a menu or a toolbar. This is rarely used in "normal" application. Typically, it would be used if your application has several views or modes, each with a completely different menu structure. If you simply want to disable an action for a given period, use setEnabled() instead.
Reimplemented in KWidgetAction. Definition at line 735 of file kaction.cpp. References KActionCollection::disconnectHighlight(), and KToolBar::removeItemDelayed(). Referenced by KWidgetAction::unplug(). |
|
Definition at line 791 of file kaction.cpp. Referenced by plugAccel(), and ~KAction(). |
|
returns whether the action is plugged into any container widget or not.
Definition at line 263 of file kaction.cpp. Referenced by KDCOPActionProxy::processAction(), and KWidgetAction::unplug(). |
|
returns whether the action is plugged into the given container
Definition at line 268 of file kaction.cpp. |
|
returns whether the action is plugged into the given container with the given, container specific, id (often menu or toolbar id ) .
Definition at line 273 of file kaction.cpp. |
|
returns whether the action is plugged into the given container with the given, container specific, representative container widget item.
Definition at line 279 of file kaction.cpp. |
|
Definition at line 1067 of file kaction.cpp. |
|
Get the text associated with this action.
Referenced by KActionMenu::plug(), and KSelectAction::plug(). |
|
Get the keyboard shortcut associated with this action.
|
|
Get the default shortcut for this action.
Definition at line 545 of file kaction.cpp. |
|
Returns true if this action is enabled.
Definition at line 586 of file kaction.cpp. Referenced by KCommandHistory::addCommand(), KPasteTextAction::plug(), KToolBarPopupAction::plug(), KActionMenu::plug(), KRecentFilesAction::plug(), KSelectAction::plug(), plugAccel(), and KCommandHistory::redo(). |
|
Returns true if this action's shortcut is configurable.
Definition at line 591 of file kaction.cpp. |
|
Get the What's this text for the action.
Referenced by KPasteTextAction::plug(), KWidgetAction::plug(), KToolBarPopupAction::plug(), KActionMenu::plug(), KRecentFilesAction::plug(), and KSelectAction::plug(). |
|
Get the tooltip text for the action.
Reimplemented in KToggleAction. Referenced by KSelectAction::plug(), and KToggleAction::toolTip(). |
|
Get the QIconSet from which the icons used to display this action will be chosen.
Definition at line 985 of file kaction.cpp. Referenced by KToolBarPopupAction::plug(), KActionMenu::plug(), KSelectAction::plug(), and plug(). |
|
How it works. KActionCollection is an organizing container for KActions. KActionCollection keeps track of the information necessary to handle configuration and shortcuts. Focus Widget pointer: This is the widget which is the focus for action shortcuts. It is set either by passing a QWidget* to the KActionCollection constructor or by calling setWidget() if the widget wasn't known when the object was initially constructed (as in KXMLGUIClient and KParts::PartBase) Shortcuts: An action's shortcut will not not be connected unless a focus widget has been specified in KActionCollection. XML Filename: This is used to save user-modified settings back to the *ui.rc file. It is set by KXMLGUIFactory. Definition at line 66 of file kaction.cpp. Referenced by KPasteTextAction::plug(), KWidgetAction::plug(), KToolBarPopupAction::plug(), KActionMenu::plug(), KRecentFilesAction::plug(), KSelectAction::plug(), and plug(). |
|
Sets the text associated with this action. The text is used for menu and toolbar labels etc. Reimplemented in KToolBarLabelAction. Definition at line 863 of file kaction.cpp. Referenced by KCommandHistory::addCommand(), KCommandHistory::clear(), KCommandHistory::redo(), KToggleFullScreenAction::setChecked(), KToolBarLabelAction::setText(), and KCommandHistory::undo(). |
|
Sets the keyboard shortcut associated with this action.
Definition at line 404 of file kaction.cpp. Referenced by setAccel(). |
|
Sets the What's this text for the action. This text will be displayed when a widget that has been created by plugging this action into a container is clicked on in What's this mode. The What's this text can include QML markup as well as raw text. Definition at line 995 of file kaction.cpp. Referenced by KAction(), KStdAction::showMenubar(), and KStdAction::showStatusbar(). |
|
Sets the tooltip text for the action. This will be used as a tooltip for a toolbar button, as a statusbar help-text for a menu item, and it also appears in the toolbar editor, to describe the action. For the tooltip to show up on the statusbar you will need to connect a couple of the actionclass signals to the toolbar. The easiest way of doing this is in your main window class, when you create a statusbar. See the KActionCollection class for more details.
Definition at line 596 of file kaction.cpp. Referenced by KAction(). |
|
Sets the QIconSet from which the icons used to display this action will be chosen.
Definition at line 953 of file kaction.cpp. Referenced by KAction(). |
|
Enables or disables this action. All uses of this action (eg. in menus or toolbars) will be updated to reflect the state of the action. Definition at line 816 of file kaction.cpp. Referenced by KCommandHistory::addCommand(), KCommandHistory::clear(), KWidgetAction::KWidgetAction(), KToggleToolBarAction::plug(), KCommandHistory::redo(), KSelectAction::setItems(), KCommandHistory::undo(), and KCommandHistory::updateActions(). |
|
Indicate whether the user may configure the action's shortcut.
Definition at line 858 of file kaction.cpp. |
|
Emulate user's interaction programmatically, by activating the action. The implementation simply emits activated(). Definition at line 1088 of file kaction.cpp. References activated(). Referenced by KDCOPActionProxy::processAction(). |
|
Definition at line 1109 of file kaction.cpp. References activated(), endl(), kdDebug(), kdWarning(), KApplication::keyboardMouseState(), and KPopupMenu::state(). Referenced by plug(). |
|
Definition at line 1140 of file kaction.cpp. References activated(), endl(), and kdDebug(). Referenced by KToolBarPopupAction::plug(), and plug(). |
|
Return the underlying KGuiItem
Definition at line 1267 of file kaction.cpp. |
|
Emitted when this action is activated.
Referenced by activate(), KListAction::KListAction(), KPasteTextAction::KPasteTextAction(), KSelectAction::plug(), slotButtonClicked(), and slotPopupActivated(). |
|
This signal allows to know the reason why an action was activated: whether it was due to a toolbar button, popupmenu, keyboard accel, or programmatically. In the first two cases, it also allows to know which mouse button was used (Left or Middle), and whether keyboard modifiers were pressed (e.g. CTRL). Note that this signal is emitted before the normal activated() signal. Yes, BOTH signals are always emitted, so that connecting to activated() still works. Applications which care about reason and state can either ignore the activated() signal for a given action and react to this one instead, or store the reason and state until the activated() signal is emitted.
|
|
Definition at line 561 of file kaction.cpp. |
|
Definition at line 497 of file kaction.cpp. References setShortcut(). |
|
|
|
|
The documentation for this class was generated from the following files: