kdeui Library API Documentation

KSelectAction Class Reference

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

#include <kactionclasses.h>

Inheritance diagram for KSelectAction:

KAction QObject 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)

Signals

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

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
QPopupMenupopupMenu () const
void setRemoveAmpersandsInCombo (bool b) KDE_DEPRECATED
bool removeAmpersandsInCombo () const
void setMenuAccelsEnabled (bool b)
bool menuAccelsEnabled () const

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 310 of file kactionclasses.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 366 of file kactionclasses.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 373 of file kactionclasses.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 381 of file kactionclasses.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 389 of file kactionclasses.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 397 of file kactionclasses.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 407 of file kactionclasses.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 417 of file kactionclasses.cpp.

KSelectAction::~KSelectAction   [virtual]
 

Destructor.

Definition at line 423 of file kactionclasses.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.

Reimplemented in KRecentFilesAction.

Definition at line 623 of file kactionclasses.cpp.

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

Referenced by KRecentFilesAction::plug().

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 795 of file kactionclasses.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 551 of file kactionclasses.cpp.

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

void KSelectAction::changeItem int    index,
const QString   text
[virtual]
 

Changes the text of item.

Parameters:
index  to
text  .

Definition at line 500 of file kactionclasses.cpp.

QString KSelectAction::currentText   [virtual]
 

Returns the text of the currently selected item.

Reimplemented in KListAction.

Definition at line 556 of file kactionclasses.cpp.

References currentItem().

int KSelectAction::currentItem   [virtual]
 

Returns the index of the current item.

See also:
setCurrentItem

Reimplemented in KListAction.

Definition at line 564 of file kactionclasses.cpp.

Referenced by currentText().

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 584 of file kactionclasses.cpp.

QPopupMenu * KSelectAction::popupMenu  
 

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

Definition at line 470 of file kactionclasses.cpp.

Referenced by plug().

void KSelectAction::setRemoveAmpersandsInCombo bool    b
 

Deprecated:
See setMenuAccelsEnabled .
Since:
3.1

Definition at line 800 of file kactionclasses.cpp.

References setMenuAccelsEnabled().

bool KSelectAction::removeAmpersandsInCombo  
 

Since:
3.1

Definition at line 805 of file kactionclasses.cpp.

References menuAccelsEnabled().

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 810 of file kactionclasses.cpp.

Referenced by setRemoveAmpersandsInCombo().

bool KSelectAction::menuAccelsEnabled  
 

Since:
3.1

Definition at line 815 of file kactionclasses.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 430 of file kactionclasses.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 535 of file kactionclasses.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 727 of file kactionclasses.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 790 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 457 of file kactionclasses.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 708 of file kactionclasses.cpp.

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

Referenced by plug().

void KSelectAction::activated int    index [signal]
 

This signal is emitted when an item is selected;.

Parameters:
index  indicated the item selected.

Referenced by KListAction::KListAction(), and plug().

void KSelectAction::activated const QString   text [signal]
 

This signal is emitted when an item is selected;.

Parameters:
text  indicates the item selected.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:34:27 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003