KSelectAction Class Reference

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

#include <kactionclasses.h>

Inheritance diagram for KSelectAction:

[legend]

List of all members.

Public Slots
virtual void	clear ()
virtual void	setComboWidth (int width)
virtual void	setCurrentItem (int index)
virtual void	setEditable (bool)
virtual void	setItems (const QStringList &lst)
Signals
void	activated (const QString &text)
void	activated (int index)
Public Member Functions
virtual void	changeItem (int index, const QString &text)
virtual int	comboWidth () const
virtual int	currentItem () const
virtual QString	currentText () const
virtual bool	isEditable () const
virtual bool	isShortcutConfigurable () const
virtual QStringList	items () const
	KSelectAction (QObject *parent=0, 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 (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=KShortcut(), QObject *parent=0, 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 KShortcut &cut, const QObject *receiver, const char *slot, QObject *parent, const char *name=0)
	KSelectAction (const QString &text, const KShortcut &cut=KShortcut(), QObject *parent=0, const char *name=0)
bool	menuAccelsEnabled () const
virtual int	plug (QWidget *widget, int index=-1)
QPopupMenu *	popupMenu () const
bool	removeAmpersandsInCombo () const
void	setMaxComboViewCount (int n)
void	setMenuAccelsEnabled (bool b)
void	setRemoveAmpersandsInCombo (bool b) KDE_DEPRECATED
virtual	~KSelectAction ()
Protected Slots
virtual void	slotActivated ()
virtual void	slotActivated (const QString &text)
virtual void	slotActivated (int id)
Protected Member Functions
virtual void	changeItem (int id, int index, const QString &text)
QStringList	comboItems () const
virtual void	updateClear (int id)
virtual void	updateComboWidth (int id)
virtual void	updateCurrentItem (int id)
virtual void	updateItems (int id)
virtual void	virtual_hook (int id, void *data)
Properties
int	comboWidth
int	currentItem
QString	currentText
bool	editable
QStringList	items
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 329 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 373 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 380 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 388 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 396 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 404 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 414 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 424 of file kactionclasses.cpp.

KSelectAction::~KSelectAction

(

)

[virtual]

Destructor.

Definition at line 430 of file kactionclasses.cpp.

---

Member Function Documentation

void KSelectAction::activated

(

const QString &

text

)

[signal]

This signal is emitted when an item is selected;.

Parameters:

text

indicates the item selected.

void KSelectAction::activated

(

int

index

)

[signal]

This signal is emitted when an item is selected;.

Parameters:

index

indicated the item selected.

void KSelectAction::changeItem	(	int	id,
		int	index,
		const QString &	text
	)			[protected, virtual]

Definition at line 531 of file kactionclasses.cpp.

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

Changes the text of item.

Parameters:

	index	to
	text	.

Definition at line 513 of file kactionclasses.cpp.

void KSelectAction::clear

(

)

[virtual, slot]

Clears up all the items in this action.

Definition at line 741 of file kactionclasses.cpp.

QStringList 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 722 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 QString 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 809 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 497 of file kactionclasses.h.

virtual QStringList 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	(	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, and KFontAction.

Definition at line 636 of file kactionclasses.cpp.

QPopupMenu * KSelectAction::popupMenu

(

)

const

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

Definition at line 483 of file kactionclasses.cpp.

bool KSelectAction::removeAmpersandsInCombo

(

)

const

Since:

3.1

Definition at line 819 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 464 of file kactionclasses.cpp.

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

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 548 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 478 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 824 of file kactionclasses.cpp.

void KSelectAction::setRemoveAmpersandsInCombo

(

bool

b

)

Deprecated:

See setMenuAccelsEnabled .

Since:

3.1

Definition at line 814 of file kactionclasses.cpp.

void KSelectAction::slotActivated

(

)

[protected, virtual, slot]

Reimplemented from KAction.

Reimplemented in KRecentFilesAction, and KFontSizeAction.

Definition at line 796 of file kactionclasses.cpp.

void KSelectAction::slotActivated

(

const QString &

text

)

[protected, virtual, slot]

Reimplemented in KRecentFilesAction, and KFontSizeAction.

Definition at line 774 of file kactionclasses.cpp.

void KSelectAction::slotActivated

(

int

id

)

[protected, virtual, slot]

Reimplemented in KRecentFilesAction, and KFontSizeAction.

Definition at line 763 of file kactionclasses.cpp.

void KSelectAction::updateClear

(

int

id

)

[protected, virtual]

Definition at line 751 of file kactionclasses.cpp.

void KSelectAction::updateComboWidth

(

int

id

)

[protected, virtual]

Definition at line 601 of file kactionclasses.cpp.

void KSelectAction::updateCurrentItem

(

int

id

)

[protected, virtual]

Definition at line 581 of file kactionclasses.cpp.

void KSelectAction::updateItems

(

int

id

)

[protected, virtual]

Definition at line 614 of file kactionclasses.cpp.

void KSelectAction::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KAction.

Reimplemented in KListAction, KRecentFilesAction, KFontAction, and KFontSizeAction.

Definition at line 2362 of file kactionclasses.cpp.

---

Property Documentation

int KSelectAction::comboWidth [read, write]

Definition at line 335 of file kactionclasses.h.

int KSelectAction::currentItem [read, write]

Definition at line 332 of file kactionclasses.h.

QString KSelectAction::currentText [read]

Definition at line 336 of file kactionclasses.h.

bool KSelectAction::editable [read, write]

Definition at line 334 of file kactionclasses.h.

QStringList KSelectAction::items [read, write]

Definition at line 333 of file kactionclasses.h.

bool KSelectAction::menuAccelsEnabled [read, write]

Definition at line 337 of file kactionclasses.h.

---

The documentation for this class was generated from the following files:

• kactionclasses.h
• kactionclasses.cpp