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

#include <kactionclasses.h>

Inheritance diagram for KSelectAction:
KAction KListAction KRecentFilesAction

Public Slots

virtual void setCurrentItem (int index)
 
virtual void setItems (const TQStringList &lst)
 
virtual void clear ()
 
virtual void setEditable (bool)
 
virtual void setComboWidth (int width)
 
- 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 activated (int index)
 
void activated (const TQString &text)
 
- Signals inherited from KAction
void activated ()
 
void activated (KAction::ActivationReason reason, TQt::ButtonState state)
 
void enabled (bool)
 

Public Member Functions

 KSelectAction (const TQString &text, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 
 KSelectAction (const TQString &text, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 
 KSelectAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 
 KSelectAction (const TQString &text, const TQString &pix, const KShortcut &cut=KShortcut(), TQObject *parent=0, const char *name=0)
 
 KSelectAction (const TQString &text, const TQIconSet &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 
 KSelectAction (const TQString &text, const TQString &pix, const KShortcut &cut, const TQObject *receiver, const char *slot, TQObject *parent, const char *name=0)
 
 KSelectAction (TQObject *parent=0, const char *name=0)
 
virtual ~KSelectAction ()
 
virtual int plug (TQWidget *widget, int index=-1)
 
virtual bool isEditable () const
 
virtual TQStringList items () const
 
virtual void changeItem (int index, const TQString &text)
 
virtual TQString currentText () const
 
virtual int currentItem () const
 
virtual int comboWidth () const
 
void setMaxComboViewCount (int n)
 
TQPopupMenu * popupMenu () const
 
void setRemoveAmpersandsInCombo (bool b) KDE_DEPRECATED
 
bool removeAmpersandsInCombo () const
 
void setMenuAccelsEnabled (bool b)
 
bool menuAccelsEnabled () const
 
virtual bool isShortcutConfigurable () 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 TQString group () const
 
virtual TQString whatsThis () const
 
virtual TQString toolTip () 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 (int id)
 
virtual void slotActivated (const TQString &text)
 
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 changeItem (int id, int index, const TQString &text)
 
TQStringList comboItems () const
 
virtual void updateCurrentItem (int id)
 
virtual void updateComboWidth (int id)
 
virtual void updateItems (int id)
 
virtual void updateClear (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

int currentItem
 
TQStringList items
 
bool editable
 
int comboWidth
 
TQString currentText
 
bool menuAccelsEnabled
 
- 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

Action for selecting one of several items.

Action for selecting one of several items.

This action shows up a submenu with a list of items. One of them can be checked. If the user clicks on an item this item will automatically be checked, the formerly checked item becomes unchecked. There can be only one item checked at a time.

Definition at line 331 of file kactionclasses.h.

Constructor & Destructor Documentation

◆ KSelectAction() [1/7]

KSelectAction::KSelectAction ( const TQString &  text,
const KShortcut &  cut = KShortcut(),
TQObject *  parent = 0,
const char *  name = 0 
)

Constructs a select 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 376 of file kactionclasses.cpp.

◆ KSelectAction() [2/7]

KSelectAction::KSelectAction ( 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 383 of file kactionclasses.cpp.

◆ KSelectAction() [3/7]

KSelectAction::KSelectAction ( 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 391 of file kactionclasses.cpp.

◆ KSelectAction() [4/7]

KSelectAction::KSelectAction ( 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 399 of file kactionclasses.cpp.

◆ KSelectAction() [5/7]

KSelectAction::KSelectAction ( 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 407 of file kactionclasses.cpp.

◆ KSelectAction() [6/7]

KSelectAction::KSelectAction ( 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 417 of file kactionclasses.cpp.

◆ KSelectAction() [7/7]

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

Definition at line 427 of file kactionclasses.cpp.

◆ ~KSelectAction()

KSelectAction::~KSelectAction ( )
virtual

Destructor.

Definition at line 433 of file kactionclasses.cpp.

Member Function Documentation

◆ activated [1/2]

void KSelectAction::activated ( int  index)
signal

This signal is emitted when an item is selected;.

Parameters
indexindicated the item selected.

◆ activated [2/2]

void KSelectAction::activated ( const TQString &  text)
signal

This signal is emitted when an item is selected;.

Parameters
textindicates the item selected.

◆ changeItem()

void KSelectAction::changeItem ( int  index,
const TQString &  text 
)
virtual

Changes the text of item.

Parameters
indexto
text.

Definition at line 516 of file kactionclasses.cpp.

◆ clear

void KSelectAction::clear ( )
virtualslot

Clears up all the items in this action.

Definition at line 744 of file kactionclasses.cpp.

◆ comboItems()

TQStringList KSelectAction::comboItems ( ) const
protected

Depending on the menuAccelsEnabled property this method will return the actions items in a way for inclusion in a combobox with the ampersand character removed from all items or not.

Since
3.1

Definition at line 725 of file kactionclasses.cpp.

◆ comboWidth()

virtual int KSelectAction::comboWidth ( ) const
virtual

When this action is plugged into a toolbar, it creates a combobox.

This returns the maximum width set by setComboWidth

◆ currentItem()

virtual int KSelectAction::currentItem ( ) const
virtual

Returns the index of the current item.

See also
setCurrentItem

Reimplemented in KListAction.

◆ currentText()

virtual TQString KSelectAction::currentText ( ) const
virtual

Returns the text of the currently selected item.

Reimplemented in KListAction.

◆ isEditable()

bool KSelectAction::isEditable ( ) const
virtual

When this action is plugged into a toolbar, it creates a combobox.

Returns
true if the combo editable.

Definition at line 812 of file kactionclasses.cpp.

◆ isShortcutConfigurable()

virtual bool KSelectAction::isShortcutConfigurable ( ) const
inlinevirtual

Returns true if this action's shortcut is configurable.

Reimplemented from KAction.

Definition at line 500 of file kactionclasses.h.

◆ items()

virtual TQStringList KSelectAction::items ( ) const
virtual
Returns
the items that can be selected with this action. Use setItems to set them.

Reimplemented in KRecentFilesAction.

◆ menuAccelsEnabled()

bool KSelectAction::menuAccelsEnabled ( ) const
Since
3.1

◆ plug()

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

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

Reimplemented from KAction.

Reimplemented in KRecentFilesAction.

Definition at line 639 of file kactionclasses.cpp.

◆ popupMenu()

TQPopupMenu * KSelectAction::popupMenu ( ) const

Returns a pointer to the popup menu used by this action.

Definition at line 486 of file kactionclasses.cpp.

◆ removeAmpersandsInCombo()

bool KSelectAction::removeAmpersandsInCombo ( ) const
Since
3.1

Definition at line 822 of file kactionclasses.cpp.

◆ setComboWidth

void KSelectAction::setComboWidth ( int  width)
virtualslot

When this action is plugged into a toolbar, it creates a combobox.

This gives a maximum size to the combobox. The minimum size is automatically given by the contents (the items).

Definition at line 467 of file kactionclasses.cpp.

◆ setCurrentItem

void KSelectAction::setCurrentItem ( int  index)
virtualslot

Sets the currently checked item.

Parameters
indexIndex of the item (remember the first item is zero).

Definition at line 440 of file kactionclasses.cpp.

◆ setEditable

void KSelectAction::setEditable ( bool  edit)
virtualslot

When this action is plugged into a toolbar, it creates a combobox.

This makes the combo editable or read-only.

Definition at line 807 of file kactionclasses.cpp.

◆ setItems

void KSelectAction::setItems ( const TQStringList &  lst)
virtualslot

Sets the items to be displayed in this action You need to call this.

Definition at line 551 of file kactionclasses.cpp.

◆ setMaxComboViewCount()

void KSelectAction::setMaxComboViewCount ( int  n)

Sets the maximum items that are visible at once if the action is a combobox, that is the number of items in the combobox's viewport Only works before the action is plugged.

Since
3.5

Definition at line 481 of file kactionclasses.cpp.

◆ setMenuAccelsEnabled()

void KSelectAction::setMenuAccelsEnabled ( bool  b)

Sets whether any occurrence of the ampersand character ( & ) in items should be interpreted as keyboard accelerator for items displayed in a menu or not.

Since
3.1

Definition at line 827 of file kactionclasses.cpp.

◆ setRemoveAmpersandsInCombo()

void KSelectAction::setRemoveAmpersandsInCombo ( bool  b)
Deprecated:
See setMenuAccelsEnabled .
Since
3.1

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