KToggleAction Class Reference

Checkbox like action. More...

#include <kactionclasses.h>

Inheritance diagram for KToggleAction:

[legend]

List of all members.

Public Slots
virtual void	setChecked (bool)
Signals
void	toggled (bool)
Public Member Functions
QString	exclusiveGroup () const
bool	isChecked () const
	KToggleAction (QObject *parent=0, const char *name=0)
	KToggleAction (const QString &text, const QString &pix, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0)
	KToggleAction (const QString &text, const QIconSet &pix, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0)
	KToggleAction (const QString &text, const QString &pix, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0)
	KToggleAction (const QString &text, const QIconSet &pix, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0)
	KToggleAction (const QString &text, const KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0)
	KToggleAction (const QString &text, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0)
virtual int	plug (QWidget *widget, int index=-1)
void	setCheckedState (const KGuiItem &checkedItem)
virtual void	setExclusiveGroup (const QString &name)
virtual QString	toolTip () const
virtual	~KToggleAction ()
Protected Slots
virtual void	slotActivated ()
Protected Member Functions
virtual void	updateChecked (int id)
virtual void	virtual_hook (int id, void *data)
Properties
bool	checked
QString	exclusiveGroup

---

Detailed Description

Checkbox like action.

Checkbox like action.

This action provides two states: checked or not.

Definition at line 68 of file kactionclasses.h.

---

Constructor & Destructor Documentation

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

Constructs a toggle action with text and potential keyboard accelerator but nothing else.

Use this only if you really know what you are doing.

Parameters:

	text	The text that will be displayed.
	cut	The corresponding keyboard accelerator (shortcut).
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 71 of file kactionclasses.cpp.

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

Parameters:

	text	The text that will be displayed.
	cut	The corresponding keyboard accelerator (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 79 of file kactionclasses.cpp.

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

Parameters:

	text	The text that will be displayed.
	pix	The icons that go with this action.
	cut	The corresponding keyboard accelerator (shortcut).
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 87 of file kactionclasses.cpp.

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

Parameters:

	text	The text that will be displayed.
	pix	The dynamically loaded icon that goes with this action.
	cut	The corresponding keyboard accelerator (shortcut).
	parent	This action's parent.
	name	An internal name for this action.

Definition at line 95 of file kactionclasses.cpp.

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

Parameters:

	text	The text that will be displayed.
	pix	The icons that go with this action.
	cut	The corresponding keyboard accelerator (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 103 of file kactionclasses.cpp.

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

Parameters:

	text	The text that will be displayed.
	pix	The dynamically loaded icon that goes with this action.
	cut	The corresponding keyboard accelerator (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 kactionclasses.cpp.

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

Parameters:

	parent	This action's parent.
	name	An internal name for this action.

Definition at line 123 of file kactionclasses.cpp.

KToggleAction::~KToggleAction

(

)

[virtual]

Destructor.

Definition at line 129 of file kactionclasses.cpp.

---

Member Function Documentation

QString KToggleAction::exclusiveGroup

(

)

const

Returns:

which "exclusive group" this action is part of.

See also:

setExclusiveGroup

bool KToggleAction::isChecked

(

)

const

Returns the actual state of the action.

Definition at line 241 of file kactionclasses.cpp.

int KToggleAction::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 KToggleAction object.

Parameters:

	widget	The GUI element to display this action.
	index	The index of the item.

Reimplemented from KAction.

Reimplemented in KToggleToolBarAction.

Definition at line 135 of file kactionclasses.cpp.

void KToggleAction::setChecked

(

bool

c

)

[virtual, slot]

Sets the state of the action.

Reimplemented in KToggleToolBarAction, and KToggleFullScreenAction.

Definition at line 162 of file kactionclasses.cpp.

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.

This feature replaces the checkmark that usually appears in front of the text, in menus. It is useful when the text is mainly a verb: e.g. "Show <foo>" should turn into "Hide <foo>" when activated.

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

Since:

3.3

Definition at line 256 of file kactionclasses.cpp.

void KToggleAction::setExclusiveGroup

(

const QString &

name

)

[virtual]

Defines which "exclusive group" this action is part of.

In a given exclusive group, only one toggle action can be checked at a any moment. Checking an action unchecks the other actions of the group.

Definition at line 246 of file kactionclasses.cpp.

void KToggleAction::slotActivated

(

)

[protected, virtual, slot]

Reimplemented from KAction.

Reimplemented in KRadioAction.

Definition at line 234 of file kactionclasses.cpp.

void KToggleAction::toggled

(

bool

)

[signal]

QString KToggleAction::toolTip

(

)

const [virtual]

Reimplemented for internal reasons.

Reimplemented from KAction.

Definition at line 262 of file kactionclasses.cpp.

void KToggleAction::updateChecked

(

int

id

)

[protected, virtual]

Definition at line 193 of file kactionclasses.cpp.

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

Reimplemented from KAction.

Reimplemented in KRadioAction, KToggleToolBarAction, and KToggleFullScreenAction.

Definition at line 2356 of file kactionclasses.cpp.

---

Property Documentation

bool KToggleAction::checked [read, write]

Definition at line 71 of file kactionclasses.h.

QString KToggleAction::exclusiveGroup [read, write]

Definition at line 72 of file kactionclasses.h.

---

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

• kactionclasses.h
• kactionclasses.cpp