• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdeui
 

kdeui

Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties | List of all members
KToggleAction Class Reference

#include <kactionclasses.h>

Inheritance diagram for KToggleAction:
KAction KRadioAction KToggleFullScreenAction KToggleToolBarAction

Public Slots

virtual void setChecked (bool)
- Public Slots inherited from KAction
virtual void setText (const TQString &text)
virtual bool setShortcut (const KShortcut &)
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 KAction
void activated ()
void activated (KAction::ActivationReason reason, TQt::ButtonState state)
void enabled (bool)

Public Member Functions

 KToggleAction (const TQString &text, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KToggleAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KToggleAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KToggleAction (const TQString &text, const TQString &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KToggleAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KToggleAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KToggleAction (TQObject *parent=0, const char *name=0)
virtual ~KToggleAction ()
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 KAction
 KAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const KGuiItem &item, const KShortcut &cut, const TQObject *receiver, const char *slot, KActionCollection *parent, const char *name)
 KAction (const TQString &text, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KAction (const TQString &text, const TQString &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 KAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 KAction (TQObject *parent=0, const char *name=0)
virtual ~KAction ()
virtual void plugAccel (KAccel *accel, bool configurable=true) KDE_DEPRECATED
virtual void unplug (TQWidget *w)
virtual void unplugAccel () KDE_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 kaccelCount () const
virtual bool hasIcon () const
bool hasIconSet () const
virtual TQString plainText () const
virtual TQString text () const
virtual const KShortcut & shortcut () const
virtual const KShortcut & 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 (KIcon::Group group, int size=0) const
TQIconSet iconSet () const
virtual TQString icon () const
KActionCollection * parentCollection () const
void unplugAll ()
int accel () const KDE_DEPRECATED
TQString statusText () const
void setAccel (int key) KDE_DEPRECATED
void setStatusText (const TQString &text)
int menuId (int i)

Protected Slots

virtual void slotActivated ()
- Protected Slots inherited from KAction
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 KAction
KToolBar * 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

Properties

bool checked
TQString exclusiveGroup
- Properties inherited from KAction
int containerCount
TQString plainText
TQString text
TQString shortcut
bool enabled
TQString group
TQString whatsThis
TQString toolTip
TQString icon

Additional Inherited Members

- Public Types inherited from KAction
enum  ActivationReason {
  UnknownActivation, EmulatedActivation, AccelActivation, PopupMenuActivation,
  ToolBarActivation
}
- Static Public Member Functions inherited from KAction
static int getToolButtonID ()
- Protected Attributes inherited from KAction
KActionCollection * m_parentCollection

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 TQString &  text,
const KShortcut &  cut = KShortcut(),
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
textThe text that will be displayed.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

Definition at line 74 of file kactionclasses.cpp.

KToggleAction::KToggleAction ( const TQString &  text,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0 
)
Parameters
textThe text that will be displayed.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe TQT_SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 82 of file kactionclasses.cpp.

KToggleAction::KToggleAction ( const TQString &  text,
const TQIconSet &  pix,
const KShortcut &  cut = KShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)
Parameters
textThe text that will be displayed.
pixThe icons that go with this action.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

Definition at line 90 of file kactionclasses.cpp.

KToggleAction::KToggleAction ( const TQString &  text,
const TQString &  pix,
const KShortcut &  cut = KShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)
Parameters
textThe text that will be displayed.
pixThe dynamically loaded icon that goes with this action.
cutThe corresponding keyboard accelerator (shortcut).
parentThis action's parent.
nameAn internal name for this action.

Definition at line 98 of file kactionclasses.cpp.

KToggleAction::KToggleAction ( const TQString &  text,
const TQIconSet &  pix,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0 
)
Parameters
textThe text that will be displayed.
pixThe icons that go with this action.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe TQT_SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 106 of file kactionclasses.cpp.

KToggleAction::KToggleAction ( const TQString &  text,
const TQString &  pix,
const KShortcut &  cut,
const TQObject *  receiver,
const char *  slot,
TQObject *  parent,
const char *  name = 0 
)
Parameters
textThe text that will be displayed.
pixThe dynamically loaded icon that goes with this action.
cutThe corresponding keyboard accelerator (shortcut).
receiverThe SLOT's parent.
slotThe TQT_SLOT to invoke to execute this action.
parentThis action's parent.
nameAn internal name for this action.

Definition at line 116 of file kactionclasses.cpp.

KToggleAction::KToggleAction ( TQObject *  parent = 0,
const char *  name = 0 
)
Parameters
parentThis action's parent.
nameAn internal name for this action.

Definition at line 126 of file kactionclasses.cpp.

KToggleAction::~KToggleAction ( )
virtual

Destructor.

Definition at line 132 of file kactionclasses.cpp.

Member Function Documentation

TQString 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 244 of file kactionclasses.cpp.

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

Parameters
widgetThe GUI element to display this action.
indexThe index of the item.

Reimplemented from KAction.

Reimplemented in KToggleToolBarAction.

Definition at line 138 of file kactionclasses.cpp.

void KToggleAction::setChecked ( bool  c)
virtualslot

Sets the state of the action.

Definition at line 165 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 259 of file kactionclasses.cpp.

void KToggleAction::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 kactionclasses.cpp.

TQString KToggleAction::toolTip ( ) const
virtual

Reimplemented for internal reasons.

Reimplemented from KAction.

Definition at line 265 of file kactionclasses.cpp.


The documentation for this class was generated from the following files:
  • kactionclasses.h
  • kactionclasses.cpp

kdeui

Skip menu "kdeui"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeui

Skip menu "kdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdeui by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |