TDEToggleAction Class Reference

#include <tdeactionclasses.h>

Inheritance diagram for TDEToggleAction:

Public Slots
virtual void	setChecked (bool)
Public Slots inherited from TDEAction
virtual void	setText (const TQString &text)
virtual bool	setShortcut (const TDEShortcut &)
virtual void	setGroup (const TQString &)
virtual void	setWhatsThis (const TQString &text)
virtual void	setToolTip (const TQString &)
virtual void	setIconSet (const TQIconSet &iconSet)
virtual void	setIcon (const TQString &icon)
virtual void	setEnabled (bool enable)
void	setDisabled (bool disable)
virtual void	setShortcutConfigurable (bool)
virtual void	activate ()

Signals
void	toggled (bool)
Signals inherited from TDEAction
void	activated ()
void	activated (TDEAction::ActivationReason reason, TQt::ButtonState state)
void	enabled (bool)

Public Member Functions
	TDEToggleAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEToggleAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEToggleAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEToggleAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEToggleAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEToggleAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEToggleAction (TQObject *parent=0, const char *name=0)
virtual	~TDEToggleAction ()
virtual int	plug (TQWidget *widget, int index=-1)
bool	isChecked () const
TQString	exclusiveGroup () const
virtual void	setExclusiveGroup (const TQString &name)
void	setCheckedState (const KGuiItem &checkedItem)
virtual TQString	toolTip () const
Public Member Functions inherited from TDEAction
	TDEAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const KGuiItem &item, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TDEActionCollection *parent, const char *name)
	TDEAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0)
	TDEAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
	TDEAction (TQObject *parent=0, const char *name=0)
virtual	~TDEAction ()
virtual void	plugAccel (TDEAccel *accel, bool configurable=true) TDE_DEPRECATED
virtual void	unplug (TQWidget *w)
virtual void	unplugAccel () TDE_DEPRECATED
virtual bool	isPlugged () const
bool	isPlugged (const TQWidget *container) const
virtual bool	isPlugged (const TQWidget *container, int id) const
virtual bool	isPlugged (const TQWidget *container, const TQWidget *_representative) const
TQWidget *	container (int index) const
int	itemId (int index) const
TQWidget *	representative (int index) const
int	containerCount () const
uint	tdeaccelCount () const
virtual bool	hasIcon () const
bool	hasIconSet () const
virtual TQString	plainText () const
virtual TQString	text () const
virtual const TDEShortcut &	shortcut () const
virtual const TDEShortcut &	shortcutDefault () const
TQString	shortcutText () const
void	setShortcutText (const TQString &)
virtual bool	isEnabled () const
virtual bool	isShortcutConfigurable () const
virtual TQString	group () const
virtual TQString	whatsThis () const
virtual TQIconSet	iconSet (TDEIcon::Group group, int size=0) const
TQIconSet	iconSet () const
virtual TQString	icon () const
TDEActionCollection *	parentCollection () const
void	unplugAll ()
int	accel () const TDE_DEPRECATED
TQString	statusText () const
void	setAccel (int key) TDE_DEPRECATED
void	setStatusText (const TQString &text)
int	menuId (int i)

Protected Slots
virtual void	slotActivated ()
Protected Slots inherited from TDEAction
virtual void	slotDestroyed ()
virtual void	slotKeycodeChanged ()
virtual void	slotActivated ()
void	slotPopupActivated ()
void	slotButtonClicked (int, TQt::ButtonState state)

Protected Member Functions
virtual void	updateChecked (int id)
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from TDEAction
TDEToolBar *	toolBar (int index) const
TQPopupMenu *	popupMenu (int index) const
void	removeContainer (int index)
int	findContainer (const TQWidget *widget) const
int	findContainer (int id) const
void	plugMainWindowAccel (TQWidget *w)
void	addContainer (TQWidget *parent, int id)
void	addContainer (TQWidget *parent, TQWidget *representative)
virtual void	updateShortcut (int i)
virtual void	updateShortcut (TQPopupMenu *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)
TQString	whatsThisWithIcon () const
const KGuiItem &	guiItem () const

Additional Inherited Members
Public Types inherited from TDEAction
enum	ActivationReason {   UnknownActivation , EmulatedActivation , AccelActivation , PopupMenuActivation ,   ToolBarActivation }
Static Public Member Functions inherited from TDEAction
static int	getToolButtonID ()
Protected Attributes inherited from TDEAction
TDEActionCollection *	m_parentCollection

Detailed Description

Checkbox like action.

Checkbox like action.

This action provides two states: checked or not.

Definition at line 68 of file tdeactionclasses.h.

Constructor & Destructor Documentation

TDEToggleAction() [1/7]

TDEToggleAction::TDEToggleAction	(	const TQString &	text,
		const TDEShortcut &	cut = TDEShortcut(),
		TQObject *	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 74 of file tdeactionclasses.cpp.

TDEToggleAction() [2/7]

TDEToggleAction::TDEToggleAction	(	const TQString &	text,
		const TDEShortcut &	cut,
		const TQObject *	receiver,
		const char *	slot,
		TQObject *	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 82 of file tdeactionclasses.cpp.

TDEToggleAction() [3/7]

TDEToggleAction::TDEToggleAction	(	const TQString &	text,
		const TQIconSet &	pix,
		const TDEShortcut &	cut = TDEShortcut(),
		TQObject *	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 90 of file tdeactionclasses.cpp.

TDEToggleAction() [4/7]

TDEToggleAction::TDEToggleAction	(	const TQString &	text,
		const TQString &	pix,
		const TDEShortcut &	cut = TDEShortcut(),
		TQObject *	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 98 of file tdeactionclasses.cpp.

TDEToggleAction() [5/7]

TDEToggleAction::TDEToggleAction	(	const TQString &	text,
		const TQIconSet &	pix,
		const TDEShortcut &	cut,
		const TQObject *	receiver,
		const char *	slot,
		TQObject *	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 106 of file tdeactionclasses.cpp.

TDEToggleAction() [6/7]

TDEToggleAction::TDEToggleAction	(	const TQString &	text,
		const TQString &	pix,
		const TDEShortcut &	cut,
		const TQObject *	receiver,
		const char *	slot,
		TQObject *	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 116 of file tdeactionclasses.cpp.

TDEToggleAction() [7/7]

TDEToggleAction::TDEToggleAction	(	TQObject *	parent = 0,
		const char *	name = 0
	)

Parameters

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

Definition at line 126 of file tdeactionclasses.cpp.

~TDEToggleAction()

TDEToggleAction::~TDEToggleAction ( )

virtual

Destructor.

Definition at line 132 of file tdeactionclasses.cpp.

Member Function Documentation

exclusiveGroup()

TQString TDEToggleAction::exclusiveGroup

(

)

const

Returns

which "exclusive group" this action is part of.

See also

setExclusiveGroup

Definition at line 254 of file tdeactionclasses.cpp.

isChecked()

bool TDEToggleAction::isChecked

(

)

const

Returns the actual state of the action.

Definition at line 244 of file tdeactionclasses.cpp.

plug()

int TDEToggleAction::plug ( TQWidget *  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 TDEToggleAction object.

Parameters

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

Reimplemented from TDEAction.

Reimplemented in TDEToggleToolBarAction.

Definition at line 138 of file tdeactionclasses.cpp.

setChecked

void TDEToggleAction::setChecked ( bool  c )

virtualslot

Sets the state of the action.

Definition at line 165 of file tdeactionclasses.cpp.

setCheckedState()

void TDEToggleAction::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 259 of file tdeactionclasses.cpp.

setExclusiveGroup()

void TDEToggleAction::setExclusiveGroup ( const TQString &  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 249 of file tdeactionclasses.cpp.

toolTip()

TQString TDEToggleAction::toolTip ( ) const

virtual

Reimplemented for internal reasons.

Reimplemented from TDEAction.

Definition at line 265 of file tdeactionclasses.cpp.

---

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

• tdeactionclasses.h
• tdeactionclasses.cpp