class KToggleAction

# class KToggleAction | Checkbox like action. More...
Definition | `#include <kaction.h>`
Inherits | KAction [public ]
Inherited by | KRadioAction, KToggleToolBarAction
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KToggleAction ( const QString& text, 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 QIconSet& pix, const KShortcut& cut = KShortcut(), QObject* parent = 0, 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, const QObject* receiver, const char* slot, QObject* parent, 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 ( QObject* parent = 0, const char* name = 0 )
- virtual ~KToggleAction ()
- virtual int plug ( QWidget* widget, int index = -1 )
- bool isChecked () const
- QString exclusiveGroup () const
- virtual void setExclusiveGroup ( const QString& name )

#### Public Slots

- virtual void setChecked ( bool )

#### Signals

- void toggled ( bool )

#### Protected Methods

- virtual void updateChecked ( int id )
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- virtual void slotActivated ()

## Detailed Description

Checkbox like action.

This action provides two states: checked or not.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

Parameters:

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

~KToggleAction () | ### ~KToggleAction

[virtual]

Destructor

int plug ( QWidget* widget, int index = -1 ) | ### plug

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

bool isChecked () | ### isChecked

[const]

Returns the actual state of the action.

QString exclusiveGroup () | ### exclusiveGroup

[const]

Returns: which "exclusive group" this action is part of.

See also: setExclusiveGroup

void setExclusiveGroup ( const QString& name ) | ### setExclusiveGroup

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

void setChecked ( bool ) | ### setChecked

[virtual slot]

Sets the state of the action.

void slotActivated () | ### slotActivated

[protected slots virtual slot]

Reimplemented from KAction.

void updateChecked ( int id ) | ### updateChecked

[protected virtual]

void toggled ( bool ) | ### toggled

[signal]

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from KAction.

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.