---

KShortcutList Class Reference

Base class for accessing accelerator lists. More...

#include <kshortcutlist.h>

Inheritance diagram for KShortcutList:

List of all members.

Public Methods
	KShortcutList ()
virtual unsigned int	count () const=0
virtual QString	name (unsigned int index) const=0
virtual QString	label (unsigned int index) const=0
virtual QString	whatsThis (unsigned int index) const=0
virtual const KShortcut &	shortcut (unsigned int index) const=0
virtual const KShortcut &	shortcutDefault (unsigned int index) const=0
virtual bool	isConfigurable (unsigned int index) const=0
virtual bool	setShortcut (unsigned int index, const KShortcut &shortcut)=0
virtual bool	isGlobal (unsigned int index) const
virtual int	index (const QString &sName) const
virtual int	index (const KKeySequence &keySeq) const
virtual const KInstance *	instance () const
virtual bool	save () const=0
virtual bool	readSettings (const QString &sConfigGroup=QString::null, KConfigBase *pConfig=0)
virtual bool	writeSettings (const QString &sConfigGroup=QString::null, KConfigBase *pConfig=0, bool bWriteAll=false, bool bGlobal=false) const
Protected Methods
virtual void	virtual_hook (int id, void *data)
	used to extend the interface with virtuals without breaking binary compatibility

---

Detailed Description

Base class for accessing accelerator lists.

KShortcutList is an abstract base class for KAccelShortcutList and KStdAccel::ShortcutList. It gives you an unified interface for accessing the accelerator lists of KAccel (using @KAccelShortcutList), KGlobalAccel (using @KAccelShortcutList), and KStdAccel (using KStdAccel::ShortcutList).

Definition at line 45 of file kshortcutlist.h.

---

Constructor & Destructor Documentation

KShortcutList::KShortcutList (    )

Default constructor.

---

Member Function Documentation

virtual unsigned int KShortcutList::count (    )  [pure virtual]

Returns the number of entries. Returns: the number of entries Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual int KShortcutList::index (  const KKeySequence &    keySeq )  const [virtual]

Returns the index of the shortcut with he given key sequence. Parameters: keySeq  the key sequence to search for Returns: the index of the shortcut, of -1 if not found

virtual int KShortcutList::index (  const QString &    sName )  const [virtual]

Returns the index of the shortcut with he given name. Parameters: sName  the name of the shortcut to search Returns: the index of the shortcut, of -1 if not found

virtual const KInstance* KShortcutList::instance (    )  [virtual]

The KInstance. Returns: the KInstance of the list, can be 0 if not available

virtual bool KShortcutList::isConfigurable (  unsigned int    index )  const [pure virtual]

Checks whether the shortcut with the given index is configurable. Parameters: index  the index of the shortcut (must be < count()) Returns: true if configurable, false otherwise Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual bool KShortcutList::isGlobal (  unsigned int    index )  const [virtual]

Checks whether the shortcut with the given index is saved in the global configuration. Parameters: index  the index of the shortcut (must be < count()) Returns: true if global, false otherwise Reimplemented in KAccelShortcutList.

virtual QString KShortcutList::label (  unsigned int    index )  const [pure virtual]

Returns the (i18n'd) label of the shortcut with the given index. Parameters: index  the index of the shortcut (must be < count()) Returns: the label (i18n'd) of the shortcut Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual QString KShortcutList::name (  unsigned int    index )  const [pure virtual]

Returns the name of the shortcut with the given index. Parameters: index  the index of the shortcut (must be < count()) Returns: the name of the shortcut Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual bool KShortcutList::readSettings (  const QString &    sConfigGroup = QString::null, KConfigBase *    pConfig = 0 )  [virtual]

Loads the shortcuts from the given configuration file. Parameters: sConfigGroup  the group in the configuration file pConfig  the configuration file to load from Returns: true if successful, false otherwise

virtual bool KShortcutList::save (    )  [pure virtual]

Save the shortcut list. Returns: true if successful, false otherwise Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual bool KShortcutList::setShortcut (  unsigned int    index, const KShortcut &    shortcut )  [pure virtual]

Sets the shortcut of the given entry Parameters: index  the index of the shortcut (must be < count()) shortcut  the shortcut Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual const KShortcut& KShortcutList::shortcut (  unsigned int    index )  const [pure virtual]

Returns the shortcut with the given index. Parameters: index  the index of the shortcut (must be < count()) Returns: the shortcut See also: shortcutDefault() Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual const KShortcut& KShortcutList::shortcutDefault (  unsigned int    index )  const [pure virtual]

Returns default shortcut with the given index. Parameters: index  the index of the shortcut (must be < count()) Returns: the default shortcut See also: shortcut() Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual QString KShortcutList::whatsThis (  unsigned int    index )  const [pure virtual]

Returns the (i18n'd) What's This text of the shortcut with the given index. Parameters: index  the index of the shortcut (must be < count()) Returns: the What's This text (i18n'd) of the shortcut Implemented in KAccelShortcutList, and KStdAccel::ShortcutList.

virtual bool KShortcutList::writeSettings (  const QString &    sConfigGroup = QString::null, KConfigBase *    pConfig = 0, bool    bWriteAll = false, bool    bGlobal = false )  const [virtual]

Writes the shortcuts to the given configuration file. Parameters: sConfigGroup  the group in the configuration file pConfig  the configuration file to save to bWriteAll  true to write all actions bGlobal  true to write to the global configuration file Returns: true if successful, false otherwise

---

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

• kshortcutlist.h

---