• 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
KToggleAction Class Reference

#include <kactionclasses.h>

Inheritance diagram for KToggleAction:
KAction KRadioAction KToggleFullScreenAction KToggleToolBarAction

List of all members.

Public Slots

virtual void setChecked (bool)

Signals

void toggled (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

Protected Slots

virtual void slotActivated ()

Protected Member Functions

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

Properties

bool checked
TQString exclusiveGroup

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) [virtual, slot]

Sets the state of the action.

Reimplemented in KToggleFullScreenAction, and KToggleToolBarAction.

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.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |