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

#include <kactionclasses.h>

Inheritance diagram for KSelectAction:
KAction KListAction KRecentFilesAction

List of all members.

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)

Signals

void activated (int index)
void activated (const TQString &text)

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

Protected Slots

virtual void slotActivated (int id)
virtual void slotActivated (const TQString &text)
virtual void slotActivated ()

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)

Properties

int currentItem
TQStringList items
bool editable
int comboWidth
TQString currentText
bool menuAccelsEnabled

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::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::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::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::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::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::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::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 ( ) [virtual]

Destructor.

Definition at line 433 of file kactionclasses.cpp.


Member Function Documentation

void KSelectAction::activated ( int  index) [signal]

This signal is emitted when an item is selected;.

Parameters:
indexindicated the item selected.
void KSelectAction::activated ( const TQString &  text) [signal]

This signal is emitted when an item is selected;.

Parameters:
textindicates the item selected.
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.

void KSelectAction::clear ( ) [virtual, slot]

Clears up all the items in this action.

Definition at line 744 of file kactionclasses.cpp.

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.

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

virtual int KSelectAction::currentItem ( ) const [virtual]

Returns the index of the current item.

See also:
setCurrentItem

Reimplemented in KListAction.

virtual TQString KSelectAction::currentText ( ) const [virtual]

Returns the text of the currently selected item.

Reimplemented in KListAction.

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.

virtual bool KSelectAction::isShortcutConfigurable ( ) const [inline, virtual]

Returns true if this action's shortcut is configurable.

Reimplemented from KAction.

Definition at line 500 of file kactionclasses.h.

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

Reimplemented in KRecentFilesAction.

bool KSelectAction::menuAccelsEnabled ( ) const
Since:
3.1
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.

TQPopupMenu * KSelectAction::popupMenu ( ) const

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

Definition at line 486 of file kactionclasses.cpp.

bool KSelectAction::removeAmpersandsInCombo ( ) const
Since:
3.1

Definition at line 822 of file kactionclasses.cpp.

void KSelectAction::setComboWidth ( int  width) [virtual, slot]

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.

void KSelectAction::setCurrentItem ( int  index) [virtual, slot]

Sets the currently checked item.

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

Reimplemented in KListAction.

Definition at line 440 of file kactionclasses.cpp.

void KSelectAction::setEditable ( bool  edit) [virtual, slot]

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.

void KSelectAction::setItems ( const TQStringList &  lst) [virtual, slot]

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

Definition at line 551 of file kactionclasses.cpp.

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.

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.

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