• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Types | Public Member Functions | Protected Member Functions | List of all members
KShortcutList Class Reference

#include <kshortcutlist.h>

Inheritance diagram for KShortcutList:
KAccelShortcutList KStdAccel::ShortcutList

Public Types

enum  Other

Public Member Functions

 KShortcutList ()
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 KShortcut & shortcut (uint index) const =0
virtual const KShortcut & shortcutDefault (uint index) const =0
virtual bool isConfigurable (uint index) const =0
virtual bool setShortcut (uint index, const KShortcut &shortcut)=0
virtual bool isGlobal (uint index) const
virtual int index (const TQString &sName) const
virtual int index (const KKeySequence &keySeq) const
virtual const KInstance * 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, KConfigBase *pConfig=0)
virtual bool writeSettings (const TQString &sConfigGroup=TQString::null, KConfigBase *pConfig=0, bool bWriteAll=false, bool bGlobal=false) const

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Detailed Description

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

Base class for accessing accelerator lists

Definition at line 48 of file kshortcutlist.h.

Constructor & Destructor Documentation

KShortcutList::KShortcutList ( )

Default constructor.

Definition at line 18 of file kshortcutlist.cpp.

Member Function Documentation

virtual uint KShortcutList::count ( ) const
pure virtual

Returns the number of entries.

Returns
the number of entries

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

int KShortcutList::index ( const TQString &  sName) const
virtual

Returns the index of the shortcut with he given name.

Parameters
sNamethe name of the shortcut to search
Returns
the index of the shortcut, of -1 if not found

Definition at line 31 of file kshortcutlist.cpp.

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

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

Parameters
keySeqthe key sequence to search for
Returns
the index of the shortcut, of -1 if not found

Definition at line 42 of file kshortcutlist.cpp.

const KInstance * KShortcutList::instance ( ) const
virtual

The KInstance.

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

Definition at line 56 of file kshortcutlist.cpp.

virtual bool KShortcutList::isConfigurable ( uint  index) const
pure virtual

Checks whether the shortcut with the given index is configurable.

Parameters
indexthe index of the shortcut (must be < count())
Returns
true if configurable, false otherwise

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

bool KShortcutList::isGlobal ( uint  index) const
virtual

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

Parameters
indexthe index of the shortcut (must be < count())
Returns
true if global, false otherwise

Reimplemented in KAccelShortcutList.

Definition at line 26 of file kshortcutlist.cpp.

virtual TQString KShortcutList::label ( uint  index) const
pure virtual

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

Parameters
indexthe index of the shortcut (must be < count())
Returns
the label (i18n'd) of the shortcut

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

virtual TQString KShortcutList::name ( uint  index) const
pure virtual

Returns the name of the shortcut with the given index.

Parameters
indexthe index of the shortcut (must be < count())
Returns
the name of the shortcut

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

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

Loads the shortcuts from the given configuration file.

Parameters
sConfigGroupthe group in the configuration file
pConfigthe configuration file to load from
Returns
true if successful, false otherwise

Definition at line 71 of file kshortcutlist.cpp.

virtual bool KShortcutList::save ( ) const
pure virtual

Save the shortcut list.

Returns
true if successful, false otherwise

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

virtual bool KShortcutList::setShortcut ( uint  index,
const KShortcut &  shortcut 
)
pure virtual

Sets the shortcut of the given entry.

Parameters
indexthe index of the shortcut (must be < count())
shortcutthe shortcut

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

virtual const KShortcut& KShortcutList::shortcut ( uint  index) const
pure virtual

Returns the shortcut with the given index.

Parameters
indexthe index of the shortcut (must be < count())
Returns
the shortcut
See Also
shortcutDefault()

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

virtual const KShortcut& KShortcutList::shortcutDefault ( uint  index) const
pure virtual

Returns default shortcut with the given index.

Parameters
indexthe index of the shortcut (must be < count())
Returns
the default shortcut
See Also
shortcut()

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

void KShortcutList::virtual_hook ( int  id,
void *  data 
)
protectedvirtual

used to extend the interface with virtuals without breaking binary compatibility

Reimplemented in KStdAccel::ShortcutList, and KAccelShortcutList.

Definition at line 212 of file kshortcutlist.cpp.

virtual TQString KShortcutList::whatsThis ( uint  index) const
pure virtual

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

Parameters
indexthe index of the shortcut (must be < count())
Returns
the What's This text (i18n'd) of the shortcut

Implemented in KStdAccel::ShortcutList, and KAccelShortcutList.

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

Writes the shortcuts to the given configuration file.

Parameters
sConfigGroupthe group in the configuration file
pConfigthe configuration file to save to
bWriteAlltrue to write all actions
bGlobaltrue to write to the global configuration file
Returns
true if successful, false otherwise

Definition at line 109 of file kshortcutlist.cpp.


The documentation for this class was generated from the following files:
  • kshortcutlist.h
  • kshortcutlist.cpp

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |