org.kde.koala

Class KShortcutList

public class KShortcutList extends Object implements QtSupport

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

UNKNOWN: Base class for accessing accelerator lists.

Constructor Summary
protected	KShortcutList(Class dummy)

Method Summary
int	count() Returns the number of entries.
QVariant	getOther(int arg1, int index) \internal @short \internal
int	index(String sName) Returns the index of the shortcut with he given name.
int	index(KKeySequence keySeq) Returns the index of the shortcut with he given key sequence.
KInstanceInterface	instance() The KInstance.
boolean	isConfigurable(int index) Checks whether the shortcut with the given `index` is configurable.
boolean	isGlobal(int index) Checks whether the shortcut with the given `index` is saved in the global configuration.
String	label(int index) Returns the (i18n'd) label of the shortcut with the given `index.`
String	name(int index) Returns the name of the shortcut with the given `index.`
boolean	readSettings(String sConfigGroup, KConfigBase pConfig) Loads the shortcuts from the given configuration file.
boolean	readSettings(String sConfigGroup)
boolean	readSettings()
boolean	save() Save the shortcut list.
boolean	setOther(int arg1, int index, QVariant arg3) \internal @short \internal
boolean	setShortcut(int index, KShortcut shortcut) Sets the shortcut of the given entry
KShortcut	shortcut(int index) Returns the shortcut with the given `index.`
KShortcut	shortcutDefault(int index) Returns default shortcut with the given `index.`
String	whatsThis(int index) Returns the (i18n'd) What's This text of the shortcut with the given `index.`
boolean	writeSettings(String sConfigGroup, KConfigBase pConfig, boolean bWriteAll, boolean bGlobal) Writes the shortcuts to the given configuration file.
boolean	writeSettings(String sConfigGroup, KConfigBase pConfig, boolean bWriteAll)
boolean	writeSettings(String sConfigGroup, KConfigBase pConfig)
boolean	writeSettings(String sConfigGroup)
boolean	writeSettings()

Constructor Detail

KShortcutList

protected KShortcutList(Class dummy)

Method Detail

count

public int count()

Returns the number of entries.

Returns: the number of entries

UNKNOWN: Returns the number of entries.

getOther

public QVariant getOther(int arg1, int index)

\internal @short \internal

index

public int index(String sName)

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

UNKNOWN: Returns the index of the shortcut with he given name.

index

public int index(KKeySequence keySeq)

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

UNKNOWN: Returns the index of the shortcut with he given key sequence.

instance

public KInstanceInterface instance()

The KInstance.

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

UNKNOWN: The KInstance.

isConfigurable

public boolean isConfigurable(int index)

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

UNKNOWN: Checks whether the shortcut with the given index is configurable.

isGlobal

public boolean isGlobal(int index)

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

UNKNOWN: Checks whether the shortcut with the given index is saved in the global configuration.

label

public String label(int index)

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

UNKNOWN: Returns the (i18n'd) label of the shortcut with the given index.

name

public String name(int index)

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

UNKNOWN: Returns the name of the shortcut with the given index.

readSettings

public boolean readSettings(String sConfigGroup, KConfigBase pConfig)

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

UNKNOWN: Loads the shortcuts from the given configuration file.

readSettings

public boolean readSettings(String sConfigGroup)

readSettings

public boolean readSettings()

save

public boolean save()

Save the shortcut list.

Returns: true if successful, false otherwise

UNKNOWN: Save the shortcut list.

setOther

public boolean setOther(int arg1, int index, QVariant arg3)

\internal @short \internal

setShortcut

public boolean setShortcut(int index, KShortcut shortcut)

Sets the shortcut of the given entry

Parameters: index the index of the shortcut (must be < count()) shortcut the shortcut

UNKNOWN: Sets the shortcut of the given entry

shortcut

public KShortcut shortcut(int index)

Returns the shortcut with the given index.

Parameters: index the index of the shortcut (must be < count())

Returns: the shortcut

shortcutDefault

public KShortcut shortcutDefault(int index)

Returns default shortcut with the given index.

Parameters: index the index of the shortcut (must be < count())

Returns: the default shortcut

whatsThis

public String whatsThis(int index)

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

UNKNOWN: Returns the (i18n'd) What's This text of the shortcut with the given index.

writeSettings

public boolean writeSettings(String sConfigGroup, KConfigBase pConfig, boolean bWriteAll, boolean bGlobal)

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

UNKNOWN: Writes the shortcuts to the given configuration file.