KToggleAction Class Reference

#include <ktoggleaction.h>

Inheritance diagram for KToggleAction:

Public Member Functions
	KToggleAction (QObject *parent)
	KToggleAction (const QString &text, QObject *parent)
	KToggleAction (const KIcon &icon, const QString &text, QObject *parent)
virtual	~KToggleAction ()
void	setCheckedState (const KGuiItem &checkedItem)
Public Member Functions inherited from KAction
	KAction (QObject *parent)
	KAction (const QString &text, QObject *parent)
	KAction (const KIcon &icon, const QString &text, 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 (KAuth::Action *action)
void	setAuthAction (const QString &actionName)
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

Protected Slots
virtual void	slotToggled (bool checked)

Additional Inherited Members
Public Types inherited from KAction
enum	GlobalShortcutLoading { Autoloading = 0x0, NoAutoloading = 0x4 }
enum	ShortcutType { ActiveShortcut = 0x1, DefaultShortcut = 0x2 }
Signals inherited from KAction
void	authorized (KAuth::Action *action)
void	globalShortcutChanged (const QKeySequence &)
void	triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
Properties inherited from KAction
KShortcut	globalShortcut
bool	globalShortcutAllowed
bool	globalShortcutEnabled
KShortcut	shortcut
bool	shortcutConfigurable

Detailed Description

Checkbox like action.

This action provides two states: checked or not.

Definition at line 40 of file ktoggleaction.h.

Constructor & Destructor Documentation

KToggleAction::KToggleAction ( QObject *  parent )

explicit

Constructs an action with the specified parent.

Parameters

parent

The action's parent object.

Definition at line 60 of file ktoggleaction.cpp.

KToggleAction::KToggleAction	(	const QString &	text,
		QObject *	parent
	)

Constructs an action with text; a shortcut may be specified by the ampersand character (e.g.

"&Option" creates a shortcut with key O )

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.
parent	The action's parent object.

Definition at line 67 of file ktoggleaction.cpp.

KToggleAction::KToggleAction	(	const KIcon &	icon,
		const QString &	text,
		QObject *	parent
	)

Constructs an action with text and an icon; a shortcut may be specified by the ampersand character (e.g.

"&Option" creates a shortcut with key O )

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

Parameters

icon	The icon to display.
text	The text that will be displayed.
parent	The action's parent object.

Definition at line 74 of file ktoggleaction.cpp.

KToggleAction::~KToggleAction ( )

virtual

Destructor.

Definition at line 81 of file ktoggleaction.cpp.

Member Function Documentation

void KToggleAction::setCheckedState

(

const KGuiItem &

checkedItem

)

Defines the text (and icon, tooltip, whatsthis) that should be displayed instead of the normal text, when the action is checked.

Note that this does not replace the check box in front of the menu. So you should not use it to replace the text "Show <foo>" with "Hide <foo>", for example.

If hasIcon(), the icon is kept for the 'checked state', unless checkedItem defines an icon explicitly. Same thing for tooltip and whatsthis.

Definition at line 87 of file ktoggleaction.cpp.

void KToggleAction::slotToggled ( bool  checked )

protectedvirtualslot

Definition at line 93 of file ktoggleaction.cpp.

---

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

• ktoggleaction.h
• ktoggleaction.cpp