Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KSelectAction Class Reference

Action for selecting one of several items. More...

#include <kaction.h>

Inheritance diagram for KSelectAction:

KAction KListAction KRecentFilesAction List of all members.

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)

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 int comboWidth () const
void setRemoveAmpersandsInCombo (bool b)
bool removeAmpersandsInCombo () const
 
Since:
3.1


void setMenuAccelsEnabled (bool b)
bool menuAccelsEnabled () const
 
Since:
3.1



Protected Slots

virtual void slotActivated ()

Protected Methods

QStringList comboItems () const
virtual void virtual_hook (int id, void *data)

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 854 of file kaction.h.

Constructor & Destructor Documentation

KSelectAction::KSelectAction (  const QString &    text,
const KShortcut &    cut = KShortcut(),
QObject *    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:
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::KSelectAction (  const QString &    text,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    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 SLOT to invoke to execute this action.
parent  This action's parent.
name  An internal name for this action.

KSelectAction::KSelectAction (  const QString &    text,
const QIconSet &    pix,
const KShortcut &    cut = KShortcut(),
QObject *    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.

KSelectAction::KSelectAction (  const QString &    text,
const QString &    pix,
const KShortcut &    cut = KShortcut(),
QObject *    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.

KSelectAction::KSelectAction (  const QString &    text,
const QIconSet &    pix,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    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 SLOT to invoke to execute this action.
parent  This action's parent.
name  An internal name for this action.

KSelectAction::KSelectAction (  const QString &    text,
const QString &    pix,
const KShortcut &    cut,
const QObject *    receiver,
const char *    slot,
QObject *    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 SLOT to invoke to execute this action.
parent  This action's parent.
name  An internal name for this action.

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

Parameters:
parent  This action's parent.
name  An internal name for this action.

virtual KSelectAction::~KSelectAction (    )  [virtual]
 

Destructor

Member Function Documentation

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

Clears up all the items in this action

QStringList KSelectAction::comboItems (    )  [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

virtual int KSelectAction::comboWidth (    )  [virtual]
 

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

virtual bool KSelectAction::isEditable (    )  [virtual]
 

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

Returns:
true if the combo editable.

virtual QStringList KSelectAction::items (    )  [virtual]
 

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

virtual int KSelectAction::plug (  QWidget *    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:
widget  The GUI element to display this action.
index  The index of the item.

Reimplemented from KAction.

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

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

Sets the currently checked item.

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

Reimplemented in KListAction.

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

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

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

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

void KSelectAction::setMenuAccelsEnabled (  bool    b ) 
 

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

Since:
3.1

void KSelectAction::setRemoveAmpersandsInCombo (  bool    b ) 
 

Deprecated. See setMenuAccelsEnabled .

Since:
3.1

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:22 2003 for kdelibs by doxygen1.2.18