class KToggleAction

Checkbox like action. More...

Definition#include <kaction.h>
InheritsKAction [public ]
Inherited byKRadioAction
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Slots

Signals

Protected Methods

Protected Slots


Detailed Description

Checkbox like action.

This action provides two states: checked or not.

 KToggleAction ( const QString& text, int accel = 0, QObject* parent = 0, const char* name = 0 )

KToggleAction

Construct a toggle action with text and potential keyboard accelerator but nothing else. Use this only if you really know what you are doing.

Parameters:
textThe text that will be displayed.
accelThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

 KToggleAction ( const QString& text, int accel, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 )

KToggleAction

Parameters:
textThe text that will be displayed.
accelThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

 KToggleAction ( const QString& text, const QIconSet& pix, int accel = 0, QObject* parent = 0, const char* name = 0 )

KToggleAction

Parameters:
textThe text that will be displayed.
pixThe icons that go with this action.
accelThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

 KToggleAction ( const QString& text, const QString& pix, int accel = 0, QObject* parent = 0, const char* name = 0 )

KToggleAction

Parameters:
textThe text that will be displayed.
pixThe dynamically loaded icon that goes with this action.
accelThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

 KToggleAction ( const QString& text, const QIconSet& pix, int accel, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 )

KToggleAction

Parameters:
textThe text that will be displayed.
pixThe icons that go with this action.
accelThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

 KToggleAction ( const QString& text, const QString& pix, int accel, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 )

KToggleAction

Parameters:
textThe text that will be displayed.
pixThe dynamically loaded icon that goes with this action.
accelThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

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

KToggleAction

Parameters:
parentThis action's parent.
nameAn internal name for this action.

 ~KToggleAction ()

~KToggleAction

[virtual]

Destructor

int  plug ( QWidget*, 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:
widgetThe GUI element to display this action.
indexThe index of the item.

Reimplemented from KAction.

bool  isChecked ()

isChecked

[const]

Retrieves the actual state of the action.

QString  exclusiveGroup ()

exclusiveGroup

[const virtual]

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

See also: setExclusiveGroup

void  setExclusiveGroup ( const QString& name )

setExclusiveGroup

[virtual slot]

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  setChecked ( int id, bool checked )

setChecked

[protected virtual]

void  toggled ( bool )

toggled

[signal]


Generated by: dfaure on kde.faure.org on Thu Jan 17 22:16:05 2002, using kdoc 2.0a53.