KActionCollection Class Reference
A managed set of KAction objects. More...
#include <kactioncollection.h>
Inheritance diagram for KActionCollection:


Public Slots | |
void | clear () |
Signals | |
void | inserted (KAction *) |
void | removed (KAction *) |
void | actionHighlighted (KAction *action) |
void | actionHighlighted (KAction *action, bool highlight) |
void | actionStatusText (const QString &text) |
void | clearStatusText () |
Public Member Functions | |
KActionCollection (QWidget *parent, const char *name=0, KInstance *instance=0) | |
KActionCollection (QWidget *watch, QObject *parent, const char *name=0, KInstance *instance=0) | |
KActionCollection (const KActionCollection ©) | |
virtual void | setWidget (QWidget *widget) |
void | setAutoConnectShortcuts (bool) |
bool | isAutoConnectShortcuts () |
bool | addDocCollection (KActionCollection *pDoc) |
virtual KAccel * | accel () KDE_DEPRECATED |
virtual const KAccel * | accel () const KDE_DEPRECATED |
KAccel * | kaccel () |
const KAccel * | kaccel () const |
KAccel * | builderKAccel () const |
virtual uint | count () const |
bool | isEmpty () const |
virtual KAction * | action (int index) const |
virtual KAction * | action (const char *name, const char *classname=0) const |
virtual QStringList | groups () const |
virtual KActionPtrList | actions (const QString &group) const |
virtual KActionPtrList | actions () const |
bool | readShortcutSettings (const QString &sConfigGroup=QString::null, KConfigBase *pConfig=0) |
bool | writeShortcutSettings (const QString &sConfigGroup=QString::null, KConfigBase *pConfig=0) const |
void | setInstance (KInstance *instance) |
KInstance * | instance () const |
void | setXMLFile (const QString &) |
const QString & | xmlFile () const |
void | setHighlightingEnabled (bool enable) |
bool | highlightingEnabled () const |
void | connectHighlight (QWidget *container, KAction *action) |
void | disconnectHighlight (QWidget *container, KAction *action) |
const KXMLGUIClient * | parentGUIClient () const |
KActionCollection (QObject *parent, const char *name=0, KInstance *instance=0) | |
void | insert (KAction *action) |
void | remove (KAction *action) |
KAction * | take (KAction *action) |
KActionCollection | operator+ (const KActionCollection &) const |
KActionCollection & | operator= (const KActionCollection &) |
KActionCollection & | operator+= (const KActionCollection &) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
A managed set of KAction objects.Definition at line 64 of file kactioncollection.h.
Constructor & Destructor Documentation
|
Use this constructor if you want the collection's actions to restrict their accelerator keys to
If you don't require shortcuts, you can pass a null to the References endl(), kdDebug(), and setWidget(). |
Member Function Documentation
|
This sets the widget to which the keyboard shortcuts should be attached. You only need to call this if a null pointer was passed in the constructor. Definition at line 150 of file kactioncollection.cpp. References endl(), and kdWarning(). Referenced by KActionCollection(). |
|
This indicates whether new actions which are created in this collection should have their keyboard shortcuts automatically connected on construction. Set to 'false' if you will be loading XML-based settings. This is automatically done by KParts. The default is 'true'.
|
|
This indicates whether new actions which are created in this collection have their keyboard shortcuts automatically connected on construction.
|
|
Doc/View model. This lets you add the action collection of a document to a view's action collection. Definition at line 175 of file kactioncollection.cpp. |
|
References kaccel(). |
|
References kaccel(). |
|
Returns the KAccel object of the most recently set widget. Definition at line 280 of file kactioncollection.cpp. Referenced by accel(). |
|
Returns the KAccel object of the most recently set widget. Const version for convenience. Definition at line 289 of file kactioncollection.cpp. |
|
Returns the number of actions in the collection. Definition at line 416 of file kactioncollection.cpp. |
|
Return the KAction* at position "index" in the action collection.
Referenced by KXMLGUIClient::action(), and KXMLGUIClient::stateChanged(). |
|
Find an action (optionally, of a given subclass of KAction) in the action collection.
|
|
Returns a list of all the groups of all the KActions in this action collection.
|
|
Returns the list of actions in a particular managed by this action collection.
|
|
Returns the list of actions managed by this action collection. Definition at line 447 of file kactioncollection.cpp. |
|
Used for reading shortcut configuration from a non-XML rc file. Definition at line 406 of file kactioncollection.cpp. |
|
Used for writing shortcut configuration to a non-XML rc file. Definition at line 411 of file kactioncollection.cpp. |
|
The instance with which this class is associated. Definition at line 466 of file kactioncollection.cpp. Referenced by KKeyChooser::insert(), KPasteTextAction::plug(), KToolBarPopupAction::plug(), KActionMenu::plug(), KRecentFilesAction::plug(), and KAction::plug(). |
|
Definition at line 471 of file kactioncollection.cpp. Referenced by KXMLGUIClient::setXMLFile(). |
|
Definition at line 476 of file kactioncollection.cpp. |
|
Enable highlighting notification for specific KActions.
|
|
Return whether highlighting notifications are enabled.
|
|
Call this function if you want to receive a signal whenever a KAction is highlighted in a menu or a toolbar.
Referenced by KActionMenu::plug(), and KAction::plug(). |
|
Disconnect highlight notifications for a particular pair of contianer and action.
Referenced by KAction::unplug(). |
|
The parent KXMLGUIClient, return 0L if not available. Definition at line 625 of file kactioncollection.cpp. |
|
Emitted when "action" is highlighted.
|
|
Emitted when "action" is highlighed or loses highlighting.
|
|
Add an action to the collection. Generally you don't have to call this. The action inserts itself automatically into its parent collection. This can be useful however for a short-lived collection (e.g. for a popupmenu, where the signals from the collection are needed too). (don't forget that in the simple case, a list of actions should be a simple KActionPtrList). If you manually insert actions into a 2nd collection, don't forget to take them out again before destroying the collection.
|
|
Removes an action from the collection and deletes it. Since the KAction destructor removes the action from the collection, you generally don't have to call this.
|
|
Removes an action from the collection. Since the KAction destructor removes the action from the collection, you generally don't have to call this.
Referenced by KAction::~KAction(). |
|
Clears the entire actionCollection, deleting all actions.
|
The documentation for this class was generated from the following files: