tdeui
TDEToggleAction Class Reference
Checkbox like action. More...
#include <tdeactionclasses.h>

Public Slots | |
virtual void | setChecked (bool) |
Signals | |
void | toggled (bool) |
Public Member Functions | |
TDEToggleAction (const TQString &text, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0) | |
TDEToggleAction (const TQString &text, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0) | |
TDEToggleAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0) | |
TDEToggleAction (const TQString &text, const TQString &pix, const TDEShortcut &cut=TDEShortcut(), TQObject *parent=0, const char *name=0) | |
TDEToggleAction (const TQString &text, const TQIconSet &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0) | |
TDEToggleAction (const TQString &text, const TQString &pix, const TDEShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0) | |
TDEToggleAction (TQObject *parent=0, const char *name=0) | |
virtual | ~TDEToggleAction () |
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) |
Detailed Description
Checkbox like action.
Checkbox like action.
This action provides two states: checked or not.
Definition at line 68 of file tdeactionclasses.h.
Constructor & Destructor Documentation
TDEToggleAction::TDEToggleAction | ( | const TQString & | text, | |
const TDEShortcut & | cut = TDEShortcut() , |
|||
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:
-
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.
Definition at line 74 of file tdeactionclasses.cpp.
TDEToggleAction::TDEToggleAction | ( | const TQString & | text, | |
const TDEShortcut & | cut, | |||
const TQObject * | receiver, | |||
const char * | slot, | |||
TQObject * | 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 TQT_SLOT to invoke to execute this action. parent This action's parent. name An internal name for this action.
Definition at line 82 of file tdeactionclasses.cpp.
TDEToggleAction::TDEToggleAction | ( | const TQString & | text, | |
const TQIconSet & | pix, | |||
const TDEShortcut & | cut = TDEShortcut() , |
|||
TQObject * | 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.
Definition at line 90 of file tdeactionclasses.cpp.
TDEToggleAction::TDEToggleAction | ( | const TQString & | text, | |
const TQString & | pix, | |||
const TDEShortcut & | cut = TDEShortcut() , |
|||
TQObject * | 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.
Definition at line 98 of file tdeactionclasses.cpp.
TDEToggleAction::TDEToggleAction | ( | const TQString & | text, | |
const TQIconSet & | pix, | |||
const TDEShortcut & | cut, | |||
const TQObject * | receiver, | |||
const char * | slot, | |||
TQObject * | 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 TQT_SLOT to invoke to execute this action. parent This action's parent. name An internal name for this action.
Definition at line 106 of file tdeactionclasses.cpp.
TDEToggleAction::TDEToggleAction | ( | const TQString & | text, | |
const TQString & | pix, | |||
const TDEShortcut & | cut, | |||
const TQObject * | receiver, | |||
const char * | slot, | |||
TQObject * | 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 TQT_SLOT to invoke to execute this action. parent This action's parent. name An internal name for this action.
Definition at line 116 of file tdeactionclasses.cpp.
TDEToggleAction::TDEToggleAction | ( | TQObject * | parent = 0 , |
|
const char * | name = 0 | |||
) |
- Parameters:
-
parent This action's parent. name An internal name for this action.
Definition at line 126 of file tdeactionclasses.cpp.
TDEToggleAction::~TDEToggleAction | ( | ) | [virtual] |
Destructor.
Definition at line 132 of file tdeactionclasses.cpp.
Member Function Documentation
TQString TDEToggleAction::exclusiveGroup | ( | ) | const |
- Returns:
- which "exclusive group" this action is part of.
- See also:
- setExclusiveGroup
Definition at line 254 of file tdeactionclasses.cpp.
bool TDEToggleAction::isChecked | ( | ) | const |
Returns the actual state of the action.
Definition at line 244 of file tdeactionclasses.cpp.
int TDEToggleAction::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 TDEToggleAction object.
- Parameters:
-
widget The GUI element to display this action. index The index of the item.
Reimplemented from TDEAction.
Reimplemented in TDEToggleToolBarAction.
Definition at line 138 of file tdeactionclasses.cpp.
void TDEToggleAction::setChecked | ( | bool | c | ) | [virtual, slot] |
Sets the state of the action.
Reimplemented in TDEToggleToolBarAction, and TDEToggleFullScreenAction.
Definition at line 165 of file tdeactionclasses.cpp.
void TDEToggleAction::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 tdeactionclasses.cpp.
void TDEToggleAction::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 tdeactionclasses.cpp.
TQString TDEToggleAction::toolTip | ( | ) | const [virtual] |
Reimplemented for internal reasons.
Reimplemented from TDEAction.
Definition at line 265 of file tdeactionclasses.cpp.
The documentation for this class was generated from the following files: