.TH "KShortcutList" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KShortcutList \- KShortcutList is an abstract base class for \fBKAccelShortcutList\fP and \fBKStdAccel::ShortcutList\fP. Base class for accessing accelerator lists.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kshortcutlist.h>\fP
.PP
Inherited by \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBOther\fP "
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKShortcutList\fP ()"
.br
.RI "\fIDefault constructor. \fP"
.ti -1c
.RI "virtual unsigned int \fBcount\fP () const =0"
.br
.RI "\fIReturns the number of entries. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBname\fP (unsigned int index) const =0"
.br
.RI "\fIReturns the name of the shortcut with the given \fCindex\fP. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBlabel\fP (unsigned int index) const =0"
.br
.RI "\fIReturns the (i18n'd) label of the shortcut with the given \fCindex\fP. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBwhatsThis\fP (unsigned int index) const =0"
.br
.RI "\fIReturns the (i18n'd) What's This text of the shortcut with the given \fCindex\fP. \fP"
.ti -1c
.RI "virtual const  KShortcut & \fBshortcut\fP (unsigned int index) const =0"
.br
.RI "\fIReturns the shortcut with the given \fCindex\fP. \fP"
.ti -1c
.RI "virtual const  KShortcut & \fBshortcutDefault\fP (unsigned int index) const =0"
.br
.RI "\fIReturns default shortcut with the given \fCindex\fP. \fP"
.ti -1c
.RI "virtual bool \fBisConfigurable\fP (unsigned int index) const =0"
.br
.RI "\fIChecks whether the shortcut with the given \fCindex\fP is configurable. \fP"
.ti -1c
.RI "virtual bool \fBsetShortcut\fP (unsigned int index, const  KShortcut &shortcut)=0"
.br
.RI "\fISets the shortcut of the given entry. \fP"
.ti -1c
.RI "virtual bool \fBisGlobal\fP (unsigned int index) const "
.br
.RI "\fIChecks whether the shortcut with the given \fCindex\fP is saved in the global configuration. \fP"
.ti -1c
.RI "virtual int \fBindex\fP (const  \fBQString\fP &sName) const "
.br
.RI "\fIReturns the index of the shortcut with he given name. \fP"
.ti -1c
.RI "virtual int \fBindex\fP (const  \fBKKeySequence\fP &keySeq) const "
.br
.RI "\fIReturns the index of the shortcut with he given key sequence. \fP"
.ti -1c
.RI "virtual const  \fBKInstance\fP * \fBinstance\fP () const "
.br
.RI "\fIThe \fBKInstance\fP. \fP"
.ti -1c
.RI "virtual \fBQVariant\fP \fBgetOther\fP (Other, unsigned int index) const =0"
.br
.ti -1c
.RI "virtual bool \fBsetOther\fP (Other, unsigned int index, \fBQVariant\fP)=0"
.br
.ti -1c
.RI "virtual bool \fBsave\fP () const =0"
.br
.RI "\fISave the shortcut list. \fP"
.ti -1c
.RI "virtual bool \fBreadSettings\fP (const  \fBQString\fP &sConfigGroup=QString::null, \fBKConfigBase\fP *pConfig=0)"
.br
.RI "\fILoads the shortcuts from the given configuration file. \fP"
.ti -1c
.RI "virtual bool \fBwriteSettings\fP (const  \fBQString\fP &sConfigGroup=QString::null, \fBKConfigBase\fP *pConfig=0, bool bWriteAll=false, bool bGlobal=false) const "
.br
.RI "\fIWrites the shortcuts to the given configuration file. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.RI "\fIused to extend the interface with virtuals without breaking binary compatibility \fP"
.in -1c
.SH "Detailed Description"
.PP 
KShortcutList is an abstract base class for \fBKAccelShortcutList\fP and \fBKStdAccel::ShortcutList\fP. Base class for accessing accelerator lists. 

It gives you an unified interface for accessing the accelerator lists of \fBKAccel\fP (using ), \fBKGlobalAccel\fP (using ), and \fBKStdAccel\fP (using \fBKStdAccel::ShortcutList\fP).
.PP
Definition at line 45 of file kshortcutlist.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KShortcutList::KShortcutList ()"
.PP
Default constructor. Definition at line 18 of file kshortcutlist.cpp.
.SH "Member Function Documentation"
.PP 
.SS "virtual unsigned int KShortcutList::count () const\fC [pure virtual]\fP"
.PP
Returns the number of entries. \fBReturns:\fP
.RS 4
the number of entries
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Referenced by index(), readSettings(), and writeSettings().
.SS "virtual \fBQString\fP KShortcutList::name (unsigned int index) const\fC [pure virtual]\fP"
.PP
Returns the name of the shortcut with the given \fCindex\fP. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
the name of the shortcut
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Referenced by readSettings(), and writeSettings().
.SS "virtual \fBQString\fP KShortcutList::label (unsigned int index) const\fC [pure virtual]\fP"
.PP
Returns the (i18n'd) label of the shortcut with the given \fCindex\fP. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
the label (i18n'd) of the shortcut
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.SS "virtual \fBQString\fP KShortcutList::whatsThis (unsigned int index) const\fC [pure virtual]\fP"
.PP
Returns the (i18n'd) What's This text of the shortcut with the given \fCindex\fP. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
the What's This text (i18n'd) of the shortcut
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.SS "virtual const KShortcut& KShortcutList::shortcut (unsigned int index) const\fC [pure virtual]\fP"
.PP
Returns the shortcut with the given \fCindex\fP. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
the shortcut 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBshortcutDefault()\fP
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Referenced by index(), and writeSettings().
.SS "virtual const KShortcut& KShortcutList::shortcutDefault (unsigned int index) const\fC [pure virtual]\fP"
.PP
Returns default shortcut with the given \fCindex\fP. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
the default shortcut 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBshortcut()\fP
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Referenced by readSettings(), and writeSettings().
.SS "virtual bool KShortcutList::isConfigurable (unsigned int index) const\fC [pure virtual]\fP"
.PP
Checks whether the shortcut with the given \fCindex\fP is configurable. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
true if configurable, false otherwise
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Referenced by readSettings(), and writeSettings().
.SS "virtual bool KShortcutList::setShortcut (unsigned int index, const KShortcut & shortcut)\fC [pure virtual]\fP"
.PP
Sets the shortcut of the given entry. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.br
\fIshortcut\fP the shortcut
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Referenced by readSettings().
.SS "virtual bool KShortcutList::isGlobal (unsigned int index) const\fC [virtual]\fP"
.PP
Checks whether the shortcut with the given \fCindex\fP is saved in the global configuration. \fBParameters:\fP
.RS 4
\fIindex\fP the index of the shortcut (must be < \fBcount\fP()) 
.RE
.PP
\fBReturns:\fP
.RS 4
true if global, false otherwise
.RE
.PP
Reimplemented in \fBKAccelShortcutList\fP.
.SS "int KShortcutList::index (const \fBQString\fP & sName) const\fC [virtual]\fP"
.PP
Returns the index of the shortcut with he given name. \fBParameters:\fP
.RS 4
\fIsName\fP the name of the shortcut to search 
.RE
.PP
\fBReturns:\fP
.RS 4
the index of the shortcut, of -1 if not found
.RE
.PP
Definition at line 32 of file kshortcutlist.cpp.
.SS "int KShortcutList::index (const \fBKKeySequence\fP & keySeq) const\fC [virtual]\fP"
.PP
Returns the index of the shortcut with he given key sequence. \fBParameters:\fP
.RS 4
\fIkeySeq\fP the key sequence to search for 
.RE
.PP
\fBReturns:\fP
.RS 4
the index of the shortcut, of -1 if not found
.RE
.PP
Definition at line 37 of file kshortcutlist.cpp.
.PP
References count(), KKeySequence::isNull(), and shortcut().
.SS "const  \fBKInstance\fP * KShortcutList::instance () const\fC [virtual]\fP"
.PP
The \fBKInstance\fP. \fBReturns:\fP
.RS 4
the \fBKInstance\fP of the list, can be 0 if not available
.RE
.PP
Definition at line 51 of file kshortcutlist.cpp.
.SS "virtual bool KShortcutList::save () const\fC [pure virtual]\fP"
.PP
Save the shortcut list. \fBReturns:\fP
.RS 4
true if successful, false otherwise
.RE
.PP
Implemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.SS "bool KShortcutList::readSettings (const \fBQString\fP & sConfigGroup = QString::null, \fBKConfigBase\fP * pConfig = 0)\fC [virtual]\fP"
.PP
Loads the shortcuts from the given configuration file. \fBParameters:\fP
.RS 4
\fIsConfigGroup\fP the group in the configuration file 
.br
\fIpConfig\fP the configuration file to load from 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise
.RE
.PP
Definition at line 66 of file kshortcutlist.cpp.
.PP
References KGlobal::config(), count(), KConfigBase::hasGroup(), isConfigurable(), QString::isEmpty(), name(), KConfigBase::readEntry(), setShortcut(), and shortcutDefault().
.SS "bool KShortcutList::writeSettings (const \fBQString\fP & sConfigGroup = QString::null, \fBKConfigBase\fP * pConfig = 0, bool bWriteAll = false, bool bGlobal = false) const\fC [virtual]\fP"
.PP
Writes the shortcuts to the given configuration file. \fBParameters:\fP
.RS 4
\fIsConfigGroup\fP the group in the configuration file 
.br
\fIpConfig\fP the configuration file to save to 
.br
\fIbWriteAll\fP true to write all actions 
.br
\fIbGlobal\fP true to write to the global configuration file 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise
.RE
.PP
Definition at line 104 of file kshortcutlist.cpp.
.PP
References KGlobal::config(), count(), KConfigBase::deleteEntry(), KConfigBase::deleteGroup(), KConfigBase::hasGroup(), isConfigurable(), QString::isEmpty(), name(), KConfigBase::readEntry(), shortcut(), shortcutDefault(), KConfigBase::sync(), and KConfigBase::writeEntry().
.PP
Referenced by KStdAccel::ShortcutList::save(), and KAccelShortcutList::save().
.SS "void KShortcutList::virtual_hook (int id, void * data)\fC [protected, virtual]\fP"
.PP
used to extend the interface with virtuals without breaking binary compatibility Reimplemented in \fBKAccelShortcutList\fP, and \fBKStdAccel::ShortcutList\fP.
.PP
Definition at line 196 of file kshortcutlist.cpp.
.PP
Referenced by KStdAccel::ShortcutList::virtual_hook(), and KAccelShortcutList::virtual_hook().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
