kdeui Library API Documentation

KSelectAction Class Reference

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

#include <kaction.h>

Inheritance diagram for KSelectAction:

KAction QObject KListAction KRecentFilesAction List of all members.

Public Slots

virtual void setCurrentItem (int index)
 Sets the currently checked item.

virtual void setItems (const QStringList &lst)
 Sets the items to be displayed in this action You need to call this.

virtual void clear ()
 Clears up all the items in this action.

virtual void setEditable (bool)
 When this action is plugged into a toolbar, it creates a combobox.

virtual void setComboWidth (int width)
 When this action is plugged into a toolbar, it creates a combobox.


Public Methods

 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.

 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 ()
 Destructor.

virtual int plug (QWidget *widget, int index=-1)
 "Plug" or insert this action into a given widget.

virtual bool isEditable () const
 When this action is plugged into a toolbar, it creates a combobox.

virtual QStringList items () const
virtual int comboWidth () const
 When this action is plugged into a toolbar, it creates a combobox.

void setRemoveAmpersandsInCombo (bool b)
 Deprecated.

bool removeAmpersandsInCombo () const
 
Since:
3.1


void 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.

bool menuAccelsEnabled () const
 
Since:
3.1



Protected Slots

virtual void slotActivated ()

Protected Methods

QStringList comboItems () 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.

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.

Definition at line 1472 of file kaction.cpp.

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.

Definition at line 1479 of file kaction.cpp.

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.

Definition at line 1487 of file kaction.cpp.

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.

Definition at line 1495 of file kaction.cpp.

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.

Definition at line 1503 of file kaction.cpp.

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.

Definition at line 1513 of file kaction.cpp.

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

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

Definition at line 1523 of file kaction.cpp.

KSelectAction::~KSelectAction   [virtual]
 

Destructor.

Definition at line 1529 of file kaction.cpp.


Member Function Documentation

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.

Definition at line 1732 of file kaction.cpp.

References comboItems(), QObject::connect(), QObject::destroyed(), KToolBar::getCombo(), KAction::iconSet(), KToolBar::insertCombo(), QPopupMenu::insertItem(), isEditable(), QString::isEmpty(), KAction::isEnabled(), QObject::name(), QComboBox::setInsertionPolicy(), QPopupMenu::setItemEnabled(), QPopupMenu::setWhatsThis(), KAction::text(), KAction::toolTip(), and KAction::whatsThis().

bool KSelectAction::isEditable   [virtual]
 

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

Returns:
true if the combo editable.

Definition at line 1883 of file kaction.cpp.

Referenced by plug().

QStringList KSelectAction::items   [virtual]
 

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

Definition at line 1660 of file kaction.cpp.

Referenced by KRecentFilesAction::addURL(), KRecentFilesAction::removeURL(), KRecentFilesAction::saveEntries(), and KRecentFilesAction::setMaxItems().

int KSelectAction::comboWidth   [virtual]
 

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

This returns the maximum width set by setComboWidth

Definition at line 1693 of file kaction.cpp.

void KSelectAction::setRemoveAmpersandsInCombo bool    b
 

Deprecated.

See setMenuAccelsEnabled .

Since:
3.1

Definition at line 1888 of file kaction.cpp.

References setMenuAccelsEnabled().

bool KSelectAction::removeAmpersandsInCombo  
 

Since:
3.1

Definition at line 1893 of file kaction.cpp.

References menuAccelsEnabled().

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

Definition at line 1898 of file kaction.cpp.

Referenced by setRemoveAmpersandsInCombo().

bool KSelectAction::menuAccelsEnabled  
 

Since:
3.1

Definition at line 1903 of file kaction.cpp.

Referenced by removeAmpersandsInCombo().

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.

Definition at line 1536 of file kaction.cpp.

Referenced by KListAction::setCurrentItem().

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

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

Definition at line 1633 of file kaction.cpp.

References KAction::setEnabled().

Referenced by KRecentFilesAction::addURL(), KRecentFilesAction::loadEntries(), KRecentFilesAction::removeURL(), and KRecentFilesAction::setMaxItems().

void KSelectAction::clear   [virtual, slot]
 

Clears up all the items in this action.

Definition at line 1815 of file kaction.cpp.

Referenced by KRecentFilesAction::clearURLList().

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.

Definition at line 1878 of file kaction.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 1563 of file kaction.cpp.

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

Definition at line 1796 of file kaction.cpp.

References QString::find(), and QString::remove().

Referenced by plug().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:07 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001