Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KToggleAction Class Reference

Checkbox like action. More...

#include <kaction.h>

Inheritance diagram for KToggleAction:

KAction KRadioAction KToggleToolBarAction List of all members.

Public Slots

virtual void setChecked (bool)

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)

Protected Slots

virtual void slotActivated ()

Protected Methods

virtual void virtual_hook (int id, void *data)

Detailed Description

Checkbox like action.

Checkbox like action.

This action provides two states: checked or not.

Definition at line 611 of file kaction.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.

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.

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.

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.

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.

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.

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

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

virtual KToggleAction::~KToggleAction (    )  [virtual]
 

Destructor

Member Function Documentation

QString KToggleAction::exclusiveGroup (    ) 
 

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

bool KToggleAction::isChecked (    ) 
 

Returns the actual state of the action.

Referenced by KDirOperator::showHiddenFiles(), KDirOperator::sortReversed(), KDirOperator::toggleDirsFirst(), and KDirOperator::toggleIgnoreCase().

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

virtual void KToggleAction::setChecked (  bool    )  [virtual, slot]
 

Sets the state of the action.

Reimplemented in KToggleToolBarAction.

Referenced by KDirOperator::setShowHiddenFiles(), KDirOperator::sortByDate(), KDirOperator::sortByName(), KDirOperator::sortBySize(), KDirOperator::sortReversed(), KDirOperator::toggleDirsFirst(), and KDirOperator::toggleIgnoreCase().

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

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:26 2003 for kdelibs by doxygen1.2.18