class KSelectAction

# class KSelectAction | Action for selecting one of several items. More...
Definition | `#include <kaction.h>`
Inherits | KAction [public ]
Inherited by | KFontAction, KFontSizeAction, KListAction, KRecentFilesAction
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KSelectAction ( const QString& text, const KShortcut& cut = KShortcut(), QObject* parent = 0, const char* name = 0 )
- KSelectAction ( const QString& text, const KShortcut& cut, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 )
- KSelectAction ( const QString& text, const QIconSet& pix, const KShortcut& cut = KShortcut(), QObject* parent = 0, const char* name = 0 )
- KSelectAction ( const QString& text, const QString& pix, const KShortcut& cut = KShortcut(), QObject* parent = 0, const char* name = 0 )
- KSelectAction ( const QString& text, const QIconSet& pix, const KShortcut& cut, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 )
- KSelectAction ( const QString& text, const QString& pix, const KShortcut& cut, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 )
- KSelectAction ( QObject* parent = 0, const char* name = 0 )
- virtual ~KSelectAction ()
- virtual int plug ( QWidget* widget, int index = -1 )
- virtual bool isEditable () const
- virtual QStringList items () const
- virtual void changeItem ( int index, const QString& text )
- virtual QString currentText () const
- virtual int currentItem () const
- virtual int comboWidth () const
- QPopupMenu* popupMenu () const
- void setRemoveAmpersandsInCombo ( bool b )
- bool removeAmpersandsInCombo () const
- void setMenuAccelsEnabled ( bool b )
- bool menuAccelsEnabled () const

#### Public Slots

- virtual void setCurrentItem ( int index )
- virtual void setItems ( const QStringList &lst )
- virtual void clear ()
- virtual void setEditable ( bool )
- virtual void setComboWidth ( int width )

#### Signals

- void activated ( int index )
- void activated ( const QString& text )

#### Protected Methods

- virtual void changeItem ( int id, int index, const QString& text )
- QStringList 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 Slots

- virtual void slotActivated ( int id )
- virtual void slotActivated ( const QString &text )
- virtual void slotActivated ()

## Detailed Description

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.

KSelectAction ( const QString& text, const KShortcut& cut = KShortcut(), QObject* parent = 0, const char* name = 0 ) | ### KSelectAction

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:

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.

KSelectAction ( const QString& text, const KShortcut& cut, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 ) | ### KSelectAction

Parameters:

text | The text that will be displayed.
cut | The corresponding keyboard accelerator (shortcut).
receiver | The SLOT's parent.
slot | The SLOT to invoke to execute this action.
parent | This action's parent.
name | An internal name for this action.

KSelectAction ( const QString& text, const QIconSet& pix, const KShortcut& cut = KShortcut(), QObject* parent = 0, const char* name = 0 ) | ### KSelectAction

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.

KSelectAction ( const QString& text, const QString& pix, const KShortcut& cut = KShortcut(), QObject* parent = 0, const char* name = 0 ) | ### KSelectAction

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.

KSelectAction ( const QString& text, const QIconSet& pix, const KShortcut& cut, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 ) | ### KSelectAction

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 SLOT to invoke to execute this action.
parent | This action's parent.
name | An internal name for this action.

KSelectAction ( const QString& text, const QString& pix, const KShortcut& cut, const QObject* receiver, const char* slot, QObject* parent, const char* name = 0 ) | ### KSelectAction

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 SLOT to invoke to execute this action.
parent | This action's parent.
name | An internal name for this action.

KSelectAction ( QObject* parent = 0, const char* name = 0 ) | ### KSelectAction

Parameters:

parent | This action's parent.
name | An internal name for this action.

~KSelectAction () | ### ~KSelectAction

[virtual]

Destructor

int plug ( QWidget* widget, int index = -1 ) | ### plug

[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:

widget | The GUI element to display this action.
index | The index of the item.

Reimplemented from KAction.

bool isEditable () | ### isEditable

[const virtual]

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

Returns: true if the combo editable.

QStringList items () | ### items

[const virtual]

Returns: the items that can be selected with this action. Use setItems to set them.

void changeItem ( int index, const QString& text ) | ### changeItem

[virtual]

QString currentText () | ### currentText

[const virtual]

int currentItem () | ### currentItem

[const virtual]

int comboWidth () | ### comboWidth

[const virtual]

When this action is plugged into a toolbar, it creates a combobox. This returns the maximum width set by setComboWidth

QPopupMenu* popupMenu () | ### popupMenu

[const]

Reimplemented from KAction.

void setRemoveAmpersandsInCombo ( bool b ) | ### setRemoveAmpersandsInCombo

Deprecated. See setMenuAccelsEnabled .

bool removeAmpersandsInCombo () | ### removeAmpersandsInCombo

[const]

void setMenuAccelsEnabled ( bool b ) | ### setMenuAccelsEnabled

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

bool menuAccelsEnabled () | ### menuAccelsEnabled

[const]

void setCurrentItem ( int index ) | ### setCurrentItem

[virtual slot]

Sets the currently checked item.

Parameters:

index | Index of the item (remember the first item is zero).

void setItems ( const QStringList &lst ) | ### setItems

[virtual slot]

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

void clear () | ### clear

[virtual slot]

Clears up all the items in this action

void setEditable ( bool ) | ### setEditable

[virtual slot]

When this action is plugged into a toolbar, it creates a combobox. This makes the combo editable or read-only.

void setComboWidth ( int width ) | ### setComboWidth

[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).

void changeItem ( int id, int index, const QString& text ) | ### changeItem

[protected virtual]

QStringList comboItems () | ### comboItems

[protected const]

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.

void slotActivated ( int id ) | ### slotActivated

[protected slots virtual slot]

Reimplemented from KAction.

void slotActivated ( const QString &text ) | ### slotActivated

[protected slots virtual slot]

Reimplemented from KAction.

void slotActivated () | ### slotActivated

[protected slots virtual slot]

Reimplemented from KAction.

void activated ( int index ) | ### activated

[signal]

Reimplemented from KAction.

void activated ( const QString& text ) | ### activated

[signal]

Reimplemented from KAction.

void updateCurrentItem ( int id ) | ### updateCurrentItem

[protected virtual]

void updateComboWidth ( int id ) | ### updateComboWidth

[protected virtual]

void updateItems ( int id ) | ### updateItems

[protected virtual]

void updateClear ( int id ) | ### updateClear

[protected virtual]

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from KAction.

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.