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	activate ()
void	setDisabled (bool disable)
virtual void	setEnabled (bool enable)
virtual void	setGroup (const QString &)
virtual void	setIcon (const QString &icon)
virtual void	setIconSet (const QIconSet &iconSet)
virtual bool	setShortcut (const KShortcut &)
virtual void	setShortcutConfigurable (bool)
virtual void	setText (const QString &text)
virtual void	setToolTip (const QString &)
virtual void	setWhatsThis (const QString &text)
Signals
void	activated (KAction::ActivationReason reason, Qt::ButtonState state)
void	activated ()
void	enabled (bool)
Public Member Functions
int	accel () const KDE_DEPRECATED
QWidget *	container (int index) const
int	containerCount () const
virtual QString	group () const
virtual bool	hasIcon () const
bool	hasIconSet () const
virtual QString	icon () const
QIconSet	iconSet () const
virtual QIconSet	iconSet (KIcon::Group group, int size=0) const
virtual bool	isEnabled () const
virtual bool	isPlugged (const QWidget container, const QWidget _representative) const
virtual bool	isPlugged (const QWidget *container, int id) const
bool	isPlugged (const QWidget *container) const
virtual bool	isPlugged () const
virtual bool	isShortcutConfigurable () const
int	itemId (int index) const
uint	kaccelCount () const
	KAction (QObject parent=0, 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 (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=KShortcut(), QObject parent=0, 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 KShortcut &cut, const QObject receiver, const char slot, QObject parent, const char name=0)
	KAction (const QString &text, const KShortcut &cut=KShortcut(), QObject parent=0, const char name=0)
	KAction (const KGuiItem &item, 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 QString &text, const QIconSet &pix, const KShortcut &cut, const QObject receiver, const char slot, KActionCollection parent, const char name)
	KAction (const QString &text, const KShortcut &cut, const QObject receiver, const char slot, KActionCollection parent, const char name)
int	menuId (int i)
KActionCollection *	parentCollection () const
virtual QString	plainText () const
virtual int	plug (QWidget *widget, int index=-1)
virtual void	plugAccel (KAccel *accel, bool configurable=true) KDE_DEPRECATED
QWidget *	representative (int index) const
void	setAccel (int key) KDE_DEPRECATED
void	setShortcutText (const QString &)
void	setStatusText (const QString &text)
virtual const KShortcut &	shortcut () const
virtual const KShortcut &	shortcutDefault () const
QString	shortcutText () const
QString	statusText () const
virtual QString	text () const
virtual QString	toolTip () const
virtual void	unplug (QWidget *w)
virtual void	unplugAccel () KDE_DEPRECATED
void	unplugAll ()
virtual QString	whatsThis () const
virtual	~KAction ()
Static Public Member Functions
static int	getToolButtonID ()
Protected Slots
virtual void	slotActivated ()
void	slotButtonClicked (int, Qt::ButtonState state)
virtual void	slotDestroyed ()
virtual void	slotKeycodeChanged ()
void	slotPopupActivated ()
Protected Member Functions
void	addContainer (QWidget parent, QWidget representative)
void	addContainer (QWidget *parent, int id)
int	findContainer (int id) const
int	findContainer (const QWidget *widget) const
const KGuiItem &	guiItem () const
void	plugMainWindowAccel (QWidget *w)
QPopupMenu *	popupMenu (int index) const
void	removeContainer (int index)
KToolBar *	toolBar (int index) const
virtual void	updateEnabled (int i)
virtual void	updateGroup (int id)
virtual void	updateIcon (int i)
virtual void	updateIconSet (int i)
virtual void	updateShortcut (QPopupMenu *menu, int id)
virtual void	updateShortcut (int i)
virtual void	updateText (int i)
virtual void	updateToolTip (int id)
virtual void	updateWhatsThis (int i)
virtual void	virtual_hook (int id, void *data)
QString	whatsThisWithIcon () const
Protected Attributes
KActionCollection *	m_parentCollection
Properties
int	containerCount
bool	enabled
QString	group
QString	icon
QString	plainText
QString	shortcut
QString	text
QString	toolTip
QString	whatsThis

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.

Detailed Example:

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");

This line creates our action. It says that wherever this action is displayed, it will use "&New" as the text, the standard icon, and the standard shortcut. It further says that whenever this action is invoked, it will use the fileNew() slot to execute it.

 QPopupMenu *file = new QPopupMenu;
 newAct->plug(file);

That just inserted the action into the File menu. The point is, it's not important in which menu it is: all manipulation of the item is done through the newAct object.

 newAct->plug(toolBar());

And this inserted the Action into the main toolbar as a button.

That's it!

If you want to disable that action sometime later, you can do so with

 newAct->setEnabled(false)

and both the menuitem in File and the toolbar button will instantly be disabled.

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;

Normally you will not need to do this as KActionCollection manages everything for you.

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

enum KAction::ActivationReason

Since:: 3.4

Enumerator:

UnknownActivation
EmulatedActivation
AccelActivation
PopupMenuActivation
ToolBarActivation

Definition at line 494 of file kaction.h.

Constructor & Destructor Documentation

KAction::KAction	(	const QString &	text,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		KActionCollection *	parent,
		const char *	name
	)

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 cut param to 0.

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...).

Parameters:

	text	The text that will be displayed.
	cut	The corresponding keyboard shortcut.
	receiver	The SLOT's parent.
	slot	The SLOT to invoke to execute this action.
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 113 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const QIconSet &	pix,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		KActionCollection *	parent,
		const char *	name
	)

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 cut param to 0.

This is the other common KAction used. Use it when you do have a corresponding icon.

Parameters:

	text	The text that will be displayed.
	pix	The icon to display.
	cut	The corresponding keyboard shortcut.
	receiver	The SLOT's parent.
	slot	The SLOT to invoke to execute this action.
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 130 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const QString &	pix,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		KActionCollection *	parent,
		const char *	name
	)

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 cut param to 0.

This is the other common KAction used. Use it when you do have a corresponding icon.

Parameters:

	text	The text that will be displayed.
	pix	The icon to display.
	cut	The corresponding keyboard shortcut (shortcut).
	receiver	The SLOT's parent.
	slot	The SLOT to invoke to execute this action.
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 121 of file kaction.cpp.

KAction::KAction	(	const KGuiItem &	item,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		KActionCollection *	parent,
		const char *	name
	)

The same as the above constructor, but with a KGuiItem providing the text and icon.

Parameters:

	item	The KGuiItem with the label and (optional) icon.
	cut	The corresponding keyboard shortcut (shortcut).
	receiver	The SLOT's parent.
	slot	The SLOT to invoke to execute this action.
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 139 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const KShortcut &	cut = `KShortcut()`,
		QObject *	parent = `0`,
		const char *	name = `0`
	)

Deprecated:

Definition at line 152 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		QObject *	parent,
		const char *	name = `0`
	)

Deprecated:

Definition at line 159 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const QIconSet &	pix,
		const KShortcut &	cut = `KShortcut()`,
		QObject *	parent = `0`,
		const char *	name = `0`
	)

Deprecated:

Definition at line 167 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const QString &	pix,
		const KShortcut &	cut = `KShortcut()`,
		QObject *	parent = `0`,
		const char *	name = `0`
	)

Deprecated:

Definition at line 176 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const QIconSet &	pix,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		QObject *	parent,
		const char *	name = `0`
	)

Deprecated:

Definition at line 185 of file kaction.cpp.

KAction::KAction	(	const QString &	text,
		const QString &	pix,
		const KShortcut &	cut,
		const QObject *	receiver,
		const char *	slot,
		QObject *	parent,
		const char *	name = `0`
	)

Deprecated:

Definition at line 195 of file kaction.cpp.

KAction::KAction	(	QObject *	parent = `0`,
		const char *	name = `0`
	)

Deprecated:

Definition at line 205 of file kaction.cpp.

KAction::~KAction ( ) [virtual]

Standard destructor.

Definition at line 212 of file kaction.cpp.

Member Function Documentation

int KAction::accel ( ) const

Deprecated:: . Use shortcut(). Get the keyboard accelerator associated with this action.

Definition at line 561 of file kaction.cpp.

void KAction::activate ( ) [virtual, slot]

Emulate user's interaction programmatically, by activating the action.

The implementation simply emits activated().

Definition at line 1088 of file kaction.cpp.

void KAction::activated	(	KAction::ActivationReason	reason,
		Qt::ButtonState	state
	)			`[signal]`

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.

Since:: 3.4

void KAction::activated ( ) [signal]

Emitted when this action is activated.

void KAction::addContainer	(	QWidget *	parent,
		QWidget *	representative
	)			`[protected]`

Definition at line 1080 of file kaction.cpp.

void KAction::addContainer	(	QWidget *	parent,
		int	id
	)			`[protected]`

Definition at line 1072 of file kaction.cpp.

QWidget * KAction::container ( int index ) const

Definition at line 1036 of file kaction.cpp.

int KAction::containerCount ( ) const

void KAction::enabled ( bool ) [signal]

int KAction::findContainer ( int id ) const [protected]

Definition at line 1206 of file kaction.cpp.

int KAction::findContainer ( const QWidget * widget ) const [protected]

Definition at line 1186 of file kaction.cpp.

int KAction::getToolButtonID ( ) [static]

How it works.

For internal use only.

Generate a toolbar button id. Made public for reimplementations.

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.

virtual QString KAction::group ( ) const [virtual]

const KGuiItem & KAction::guiItem ( ) const [protected]

Return the underlying KGuiItem.

Since:: 3.3

Definition at line 1267 of file kaction.cpp.

bool KAction::hasIcon ( ) const [virtual]

Definition at line 990 of file kaction.cpp.

bool KAction::hasIconSet ( ) const [inline]

Definition at line 421 of file kaction.h.

virtual QString KAction::icon ( ) const [virtual]

QIconSet KAction::iconSet ( ) const [inline]

Remove in KDE4.

Definition at line 476 of file kaction.h.

QIconSet KAction::iconSet	(	KIcon::Group	group,
		int	size = `0`
	)			const `[virtual]`

Get the QIconSet from which the icons used to display this action will be chosen.

In KDE4 set group default to KIcon::Small while removing the other iconSet() function.

Definition at line 985 of file kaction.cpp.

bool KAction::isEnabled ( ) const [virtual]

Returns true if this action is enabled.

Definition at line 586 of file kaction.cpp.

bool KAction::isPlugged	(	const QWidget *	container,
		const QWidget *	_representative
	)			const `[virtual]`

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.

bool KAction::isPlugged	(	const QWidget *	container,
		int	id
	)			const `[virtual]`

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.

bool KAction::isPlugged ( const QWidget * container ) const

returns whether the action is plugged into the given container

Definition at line 268 of file kaction.cpp.

bool KAction::isPlugged ( ) const [virtual]

returns whether the action is plugged into any container widget or not.

Since:: 3.1

Definition at line 263 of file kaction.cpp.

bool KAction::isShortcutConfigurable ( ) const [virtual]

Returns true if this action's shortcut is configurable.

Reimplemented in KSelectAction.

Definition at line 591 of file kaction.cpp.

int KAction::itemId ( int index ) const

Definition at line 1057 of file kaction.cpp.

uint KAction::kaccelCount ( ) const

Since:: 3.1

Definition at line 1067 of file kaction.cpp.

int KAction::menuId ( int i ) [inline]

Deprecated:: . for backwards compatibility. Use itemId()

Definition at line 663 of file kaction.h.

KActionCollection * KAction::parentCollection ( ) const

Definition at line 1256 of file kaction.cpp.

virtual QString KAction::plainText ( ) const [virtual]

int KAction::plug	(	QWidget *	widget,
		int	index = `-1`
	)			`[virtual]`

"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.

Parameters:

	widget	The GUI element to display this action
	index	The position into which the action is plugged. If this is negative, the action is inserted at the end.

Reimplemented in KToggleAction, KSelectAction, KRecentFilesAction, KFontAction, KActionMenu, KToolBarPopupAction, KToggleToolBarAction, KWidgetAction, KActionSeparator, and KPasteTextAction.

Definition at line 618 of file kaction.cpp.

void KAction::plugAccel	(	KAccel *	accel,
		bool	configurable = `true`
	)			`[virtual]`

Deprecated:: . Shouldn't be used. No substitute available.

"Plug" or insert this action into a given KAccel.

Parameters:

	accel	The KAccel collection which holds this accel
	configurable	If the shortcut is configurable via the KAccel configuration dialog (this is somehow deprecated since there is now a KAction key configuration dialog).

Definition at line 763 of file kaction.cpp.

void KAction::plugMainWindowAccel ( QWidget * w ) [protected]

Definition at line 801 of file kaction.cpp.

QPopupMenu * KAction::popupMenu ( int index ) const [protected]

Definition at line 1047 of file kaction.cpp.

void KAction::removeContainer ( int index ) [protected]

Definition at line 1226 of file kaction.cpp.

QWidget * KAction::representative ( int index ) const

Definition at line 1052 of file kaction.cpp.

void KAction::setAccel ( int key )

Deprecated:: . Use setShortcut(). Sets the keyboard accelerator associated with this action.

Definition at line 497 of file kaction.cpp.

void KAction::setDisabled ( bool disable ) [inline, slot]

Calls setEnabled( !disable ).

Since:: 3.5

Definition at line 553 of file kaction.h.

void KAction::setEnabled ( bool enable ) [virtual, slot]

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.

void KAction::setGroup ( const QString & grp ) [virtual, slot]

Definition at line 567 of file kaction.cpp.

void KAction::setIcon ( const QString & icon ) [virtual, slot]

Definition at line 922 of file kaction.cpp.

void KAction::setIconSet ( const QIconSet & iconSet ) [virtual, slot]

Sets the QIconSet from which the icons used to display this action will be chosen.

Definition at line 953 of file kaction.cpp.

bool KAction::setShortcut ( const KShortcut & cut ) [virtual, slot]

Sets the keyboard shortcut associated with this action.

Definition at line 404 of file kaction.cpp.

void KAction::setShortcutConfigurable ( bool b ) [virtual, slot]

Indicate whether the user may configure the action's shortcut.

Definition at line 858 of file kaction.cpp.

void KAction::setShortcutText ( const QString & s )

Definition at line 555 of file kaction.cpp.

void KAction::setStatusText ( const QString & text ) [inline]

Deprecated:: . Use setToolTip instead (they do the same thing now).

Definition at line 657 of file kaction.h.

void KAction::setText ( const QString & text ) [virtual, slot]

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.

void KAction::setToolTip ( const QString & tt ) [virtual, slot]

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.

See also:: KActionCollection

Definition at line 596 of file kaction.cpp.

void KAction::setWhatsThis ( const QString & text ) [virtual, slot]

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.

virtual const KShortcut& KAction::shortcut ( ) const [virtual]

Get the keyboard shortcut associated with this action.

const KShortcut & KAction::shortcutDefault ( ) const [virtual]

Get the default shortcut for this action.

Definition at line 545 of file kaction.cpp.

QString KAction::shortcutText ( ) const

Definition at line 550 of file kaction.cpp.

void KAction::slotActivated ( ) [protected, virtual, slot]

Reimplemented in KToggleAction, KRadioAction, KSelectAction, KRecentFilesAction, KFontSizeAction, and KPasteTextAction.

Definition at line 1094 of file kaction.cpp.

void KAction::slotButtonClicked	(	int	,
		Qt::ButtonState	state
	)			`[protected, slot]`

Since:: 3.4

Definition at line 1140 of file kaction.cpp.

void KAction::slotDestroyed ( ) [protected, virtual, slot]

Definition at line 1151 of file kaction.cpp.

void KAction::slotKeycodeChanged ( ) [protected, virtual, slot]

Definition at line 1248 of file kaction.cpp.

void KAction::slotPopupActivated ( ) [protected, slot]

Since:: 3.4

Definition at line 1109 of file kaction.cpp.

QString KAction::statusText ( ) const [inline]

Definition at line 645 of file kaction.h.

virtual QString KAction::text ( ) const [virtual]

Get the text associated with this action.

KToolBar * KAction::toolBar ( int index ) const [protected]

Definition at line 1042 of file kaction.cpp.

virtual QString KAction::toolTip ( ) const [virtual]

Get the tooltip text for the action.

Reimplemented in KToggleAction.

void KAction::unplug ( QWidget * w ) [virtual]

"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.

Parameters:

w

Remove the action from this GUI element.

Reimplemented in KWidgetAction.

Definition at line 735 of file kaction.cpp.

void KAction::unplugAccel ( ) [virtual]

Deprecated:: . Complement method to plugAccel(). Disconnect this action from the KAccel.

Definition at line 791 of file kaction.cpp.

void KAction::unplugAll ( )

Definition at line 1261 of file kaction.cpp.

void KAction::updateEnabled ( int i ) [protected, virtual]

Definition at line 846 of file kaction.cpp.

void KAction::updateGroup ( int id ) [protected, virtual]

Definition at line 576 of file kaction.cpp.

void KAction::updateIcon ( int i ) [protected, virtual]

Definition at line 932 of file kaction.cpp.

void KAction::updateIconSet ( int i ) [protected, virtual]

Definition at line 963 of file kaction.cpp.

void KAction::updateShortcut	(	QPopupMenu *	menu,
		int	id
	)			`[protected, virtual]`

Definition at line 516 of file kaction.cpp.

void KAction::updateShortcut ( int i ) [protected, virtual]

Definition at line 503 of file kaction.cpp.

void KAction::updateText ( int i ) [protected, virtual]

Definition at line 892 of file kaction.cpp.

void KAction::updateToolTip ( int id ) [protected, virtual]

Definition at line 605 of file kaction.cpp.

void KAction::updateWhatsThis ( int i ) [protected, virtual]

Definition at line 1004 of file kaction.cpp.

void KAction::virtual_hook	(	int	id,
		void *	data
	)			`[protected, virtual]`

Reimplemented in KToggleAction, KRadioAction, KSelectAction, KListAction, KRecentFilesAction, KFontAction, KFontSizeAction, KActionMenu, KToolBarPopupAction, KToggleToolBarAction, KToggleFullScreenAction, KWidgetAction, KActionSeparator, KPasteTextAction, and KToolBarLabelAction.

Definition at line 1272 of file kaction.cpp.

virtual QString KAction::whatsThis ( ) const [virtual]

Get the What's this text for the action.

QString KAction::whatsThisWithIcon ( ) const [protected]

Definition at line 1028 of file kaction.cpp.

Member Data Documentation

KActionCollection* KAction::m_parentCollection [protected]

Definition at line 596 of file kaction.h.

Property Documentation

int KAction::containerCount [read]

Definition at line 206 of file kaction.h.

bool KAction::enabled [read, write]

Definition at line 210 of file kaction.h.

QString KAction::group [read, write]

Definition at line 211 of file kaction.h.

QString KAction::icon [read, write]

Definition at line 214 of file kaction.h.

QString KAction::plainText [read]

Definition at line 207 of file kaction.h.

const KShortcut & KAction::shortcut [read, write]

Definition at line 209 of file kaction.h.

QString KAction::text [read, write]

Definition at line 208 of file kaction.h.

QString KAction::toolTip [read, write]

Definition at line 213 of file kaction.h.

QString KAction::whatsThis [read, write]

Definition at line 212 of file kaction.h.

The documentation for this class was generated from the following files:

kdeui

KAction Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

kdeui

API Reference