TDEShortcutList Class Reference

#include <tdeshortcutlist.h>

Inheritance diagram for TDEShortcutList:

Public Types
enum	Other

Public Member Functions
	TDEShortcutList ()
virtual uint	count () const =0
virtual TQString	name (uint index) const =0
virtual TQString	label (uint index) const =0
virtual TQString	whatsThis (uint index) const =0
virtual const TDEShortcut &	shortcut (uint index) const =0
virtual const TDEShortcut &	shortcutDefault (uint index) const =0
virtual bool	isConfigurable (uint index) const =0
virtual bool	setShortcut (uint index, const TDEShortcut &shortcut)=0
virtual bool	isGlobal (uint index) const
virtual int	index (const TQString &sName) const
virtual int	index (const KKeySequence &keySeq) const
virtual const TDEInstance *	instance () const
virtual TQVariant	getOther (Other, uint index) const =0
virtual bool	setOther (Other, uint index, TQVariant)=0
virtual bool	save () const =0
virtual bool	readSettings (const TQString &sConfigGroup=TQString::null, TDEConfigBase *pConfig=0)
virtual bool	writeSettings (const TQString &sConfigGroup=TQString::null, TDEConfigBase *pConfig=0, bool bWriteAll=false, bool bGlobal=false) const

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Detailed Description

TDEShortcutList is an abstract base class for TDEAccelShortcutList and TDEStdAccel::ShortcutList.

It gives you an unified interface for accessing the accelerator lists of TDEAccel (using TDEAccelShortcutList), TDEGlobalAccel (using TDEAccelShortcutList), and TDEStdAccel (using TDEStdAccel::ShortcutList).

Base class for accessing accelerator lists

Definition at line 48 of file tdeshortcutlist.h.

Member Enumeration Documentation

Other

enum TDEShortcutList::Other

Definition at line 146 of file tdeshortcutlist.h.

Constructor & Destructor Documentation

TDEShortcutList()

TDEShortcutList::TDEShortcutList

(

)

Default constructor.

Definition at line 18 of file tdeshortcutlist.cpp.

~TDEShortcutList()

TDEShortcutList::~TDEShortcutList ( )

virtual

Definition at line 22 of file tdeshortcutlist.cpp.

Member Function Documentation

count()

virtual uint TDEShortcutList::count ( ) const

pure virtual

Returns the number of entries.

Returns

the number of entries

Implemented in TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

getOther()

TQVariant TDEShortcutList::getOther ( Other  , uint  index  ) const

pure virtual

Definition at line 61 of file tdeshortcutlist.cpp.

index() [1/2]

int TDEShortcutList::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

Definition at line 42 of file tdeshortcutlist.cpp.

index() [2/2]

int TDEShortcutList::index ( const TQString &  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

Definition at line 31 of file tdeshortcutlist.cpp.

instance()

const TDEInstance * TDEShortcutList::instance ( ) const

virtual

The TDEInstance.

Returns

the TDEInstance of the list, can be 0 if not available

Definition at line 56 of file tdeshortcutlist.cpp.

isConfigurable()

virtual bool TDEShortcutList::isConfigurable ( uint  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

isGlobal()

bool TDEShortcutList::isGlobal ( uint  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 TDEAccelShortcutList.

Definition at line 26 of file tdeshortcutlist.cpp.

label()

virtual TQString TDEShortcutList::label ( uint  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

name()

virtual TQString TDEShortcutList::name ( uint  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

readSettings()

bool TDEShortcutList::readSettings ( const TQString &  sConfigGroup = TQString::null, TDEConfigBase *  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

Definition at line 71 of file tdeshortcutlist.cpp.

save()

virtual bool TDEShortcutList::save ( ) const

pure virtual

Save the shortcut list.

Returns

true if successful, false otherwise

Implemented in TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

setOther()

bool TDEShortcutList::setOther ( Other  , uint  index, TQVariant    )

pure virtual

Definition at line 66 of file tdeshortcutlist.cpp.

setShortcut()

virtual bool TDEShortcutList::setShortcut ( uint  index, const TDEShortcut &  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

shortcut()

virtual const TDEShortcut & TDEShortcutList::shortcut ( uint  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

shortcutDefault()

virtual const TDEShortcut & TDEShortcutList::shortcutDefault ( uint  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

virtual_hook()

void TDEShortcutList::virtual_hook ( int  id, void *  data  )

protectedvirtual

used to extend the interface with virtuals without breaking binary compatibility

Reimplemented in TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

Definition at line 212 of file tdeshortcutlist.cpp.

whatsThis()

virtual TQString TDEShortcutList::whatsThis ( uint  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 TDEAccelShortcutList, and TDEStdAccel::ShortcutList.

writeSettings()

bool TDEShortcutList::writeSettings ( const TQString &  sConfigGroup = TQString::null, TDEConfigBase *  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

Definition at line 109 of file tdeshortcutlist.cpp.

---

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

• tdeshortcutlist.h
• tdeshortcutlist.cpp