.TH "KKeyChooser" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyChooser \- Configure dictionaries of key/action associations for \fBKAccel\fP and \fBKGlobalAccel\fP. Widget for configuration of \fBKAccel\fP and \fBKGlobalAccel\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kkeydialog.h>\fP
.PP
Inherits \fBQWidget\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBActionType\fP { \fBApplication\fP, \fBApplicationGlobal\fP, \fBStandard\fP, \fBGlobal\fP }"
.br
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBallDefault\fP ()"
.br
.RI "\fISet all keys to their default values (bindings). \fP"
.ti -1c
.RI "void \fBsetPreferFourModifierKeys\fP (bool preferFourModifierKeys)"
.br
.RI "\fISpecifies whether to use the 3 or 4 modifier key scheme. \fP"
.ti -1c
.RI "void \fBlistSync\fP ()"
.br
.RI "\fIRebuild list entries based on underlying map. \fP"
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBkeyChange\fP ()"
.br
.RI "\fIEmitted when an action's shortcut has been changed. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKKeyChooser\fP (\fBQWidget\fP *parent, ActionType type=Application, bool bAllowLetterShortcuts=true)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fBKKeyChooser\fP (\fBKActionCollection\fP *coll, \fBQWidget\fP *parent, bool bAllowLetterShortcuts=true)"
.br
.ti -1c
.RI "\fBKKeyChooser\fP (\fBKAccel\fP *actions, \fBQWidget\fP *parent, bool bAllowLetterShortcuts=true)"
.br
.ti -1c
.RI "\fBKKeyChooser\fP (\fBKGlobalAccel\fP *actions, \fBQWidget\fP *parent)"
.br
.ti -1c
.RI "\fBKKeyChooser\fP (\fBKShortcutList\fP *, \fBQWidget\fP *parent, ActionType type=Application, bool bAllowLetterShortcuts=true)"
.br
.ti -1c
.RI "bool \fBinsert\fP (\fBKActionCollection\fP *)"
.br
.RI "\fIInsert an action collection, i.e. \fP"
.ti -1c
.RI "bool \fBinsert\fP (\fBKActionCollection\fP *, const  \fBQString\fP &title)"
.br
.RI "\fIInsert an action collection, i.e. \fP"
.ti -1c
.RI "void \fBsyncToConfig\fP (const  \fBQString\fP &sConfigGroup, \fBKConfigBase\fP *pConfig, bool bClearUnset)"
.br
.ti -1c
.RI "void \fBcommitChanges\fP ()"
.br
.RI "\fIThis function writes any shortcut changes back to the original action set(s). \fP"
.ti -1c
.RI "void \fBsave\fP ()"
.br
.RI "\fIThis commits and then saves the actions to disk. \fP"
.ti -1c
.RI "\fBKKeyChooser\fP (\fBKAccel\fP *actions, \fBQWidget\fP *parent, bool bCheckAgainstStdKeys, bool bAllowLetterShortcuts, bool bAllowWinKey=false)"
.br
.ti -1c
.RI "\fBKKeyChooser\fP (\fBKGlobalAccel\fP *actions, \fBQWidget\fP *parent, bool bCheckAgainstStdKeys, bool bAllowLetterShortcuts, bool bAllowWinKey=false)"
.br
.in -1c
.SS "Protected Types"

.in +1c
.ti -1c
.RI "enum { \fBNoKey\fP =  1, \fBDefaultKey\fP, \fBCustomKey\fP }"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotNoKey\fP ()"
.br
.ti -1c
.RI "void \fBslotDefaultKey\fP ()"
.br
.ti -1c
.RI "void \fBslotCustomKey\fP ()"
.br
.ti -1c
.RI "void \fBslotListItemSelected\fP (\fBQListViewItem\fP *item)"
.br
.ti -1c
.RI "void \fBcapturedShortcut\fP (const  KShortcut &cut)"
.br
.ti -1c
.RI "void \fBslotSettingsChanged\fP (int)"
.br
.ti -1c
.RI "void \fBslotListItemDoubleClicked\fP (\fBQListViewItem\fP *ipoQListViewItem, const  \fBQPoint\fP &ipoQPoint, int c)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBinitGUI\fP (ActionType type, bool bAllowLetterShortcuts)"
.br
.ti -1c
.RI "bool \fBinsert\fP (\fBKAccel\fP *)"
.br
.ti -1c
.RI "bool \fBinsert\fP (\fBKGlobalAccel\fP *)"
.br
.ti -1c
.RI "bool \fBinsert\fP (\fBKShortcutList\fP *)"
.br
.ti -1c
.RI "void \fBbuildListView\fP (uint iList, const  \fBQString\fP &title=QString::null)"
.br
.RI "\fI\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fP"
.ti -1c
.RI "void \fBreadGlobalKeys\fP ()"
.br
.ti -1c
.RI "void \fBupdateButtons\fP ()"
.br
.ti -1c
.RI "void \fBfontChange\fP (const  \fBQFont\fP &_font)"
.br
.ti -1c
.RI "void \fBsetShortcut\fP (const  KShortcut &cut)"
.br
.ti -1c
.RI "bool \fBisKeyPresent\fP (const  KShortcut &cut, bool warnuser=true)"
.br
.ti -1c
.RI "bool \fBisKeyPresentLocally\fP (const  KShortcut &cut, KKeyChooserItem *ignoreItem, const  \fBQString\fP &warnText)"
.br
.ti -1c
.RI "void \fB_warning\fP (const  \fBKKeySequence\fP &seq, \fBQString\fP sAction, \fBQString\fP sTitle)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "ActionType \fBm_type\fP"
.br
.ti -1c
.RI "bool \fBm_bAllowLetterShortcuts\fP"
.br
.ti -1c
.RI "bool \fBm_bAllowWinKey\fP"
.br
.ti -1c
.RI "bool \fBm_bPreferFourModifierKeys\fP"
.br
.ti -1c
.RI "\fBQRadioButton\fP * \fBm_prbNone\fP"
.br
.ti -1c
.RI "\fBQRadioButton\fP * \fBm_prbDef\fP"
.br
.ti -1c
.RI "\fBQRadioButton\fP * \fBm_prbCustom\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKKeyDialog\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Configure dictionaries of key/action associations for \fBKAccel\fP and \fBKGlobalAccel\fP. Widget for configuration of \fBKAccel\fP and \fBKGlobalAccel\fP. 

The class takes care of all aspects of configuration, including handling key conflicts internally. Connect to the \fBallDefault\fP() slot if you want to set all configurable shortcuts to their default values.
.PP
\fBSee also:\fP
.RS 4
\fBKKeyDialog\fP 
.RE
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBkkeydialog.h\fP,v 1.72.2.1 2003/04/25 07:38:44 mlaurent Exp 
.RE
.PP
.RE
.PP
\fBAuthor:\fP
.RS 4
Nicolas Hadacek <hadacek@via.ecp.fr> 
.RE
.PP

.PP
Definition at line 58 of file kkeydialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KKeyChooser::KKeyChooser (\fBQWidget\fP * parent, ActionType type = Application, bool bAllowLetterShortcuts = true)"
.PP
Constructor. \fBParameters:\fP
.RS 4
\fIbAllowLetterShortcuts\fP Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts. 
.RE
.PP
Definition at line 134 of file kkeydialog.cpp.
.SS "KKeyChooser::KKeyChooser (\fBKAccel\fP * actions, \fBQWidget\fP * parent, bool bCheckAgainstStdKeys, bool bAllowLetterShortcuts, bool bAllowWinKey = false)"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP
Definition at line 168 of file kkeydialog.cpp.
.PP
References insert().
.SS "KKeyChooser::KKeyChooser (\fBKGlobalAccel\fP * actions, \fBQWidget\fP * parent, bool bCheckAgainstStdKeys, bool bAllowLetterShortcuts, bool bAllowWinKey = false)"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP
Definition at line 184 of file kkeydialog.cpp.
.PP
References insert().
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyChooser::insert (\fBKActionCollection\fP *)"
.PP
Insert an action collection, i.e. add all its actions to the ones already associated with the KKeyChooser object.Definition at line 213 of file kkeydialog.cpp.
.PP
Referenced by KKeyDialog::configure(), KKeyDialog::insert(), and KKeyChooser().
.SS "bool KKeyChooser::insert (\fBKActionCollection\fP *, const \fBQString\fP & title)"
.PP
Insert an action collection, i.e. add all its actions to the ones already associated with the KKeyChooser object. 
.PP
\fBParameters:\fP
.RS 4
\fItitle\fP subtree title of this collection of shortcut. 
.RE
.PP
\fBSince:\fP
.RS 4
3.1
.RE
.PP
Definition at line 218 of file kkeydialog.cpp.
.PP
References KInstance::aboutData(), buildListView(), KActionCollection::instance(), QString::isEmpty(), and KAboutData::programName().
.SS "void KKeyChooser::commitChanges ()"
.PP
This function writes any shortcut changes back to the original action set(s). Definition at line 253 of file kkeydialog.cpp.
.PP
References QListViewItemIterator::current().
.PP
Referenced by KKeyDialog::commitChanges(), and save().
.SS "void KKeyChooser::save ()"
.PP
This commits and then saves the actions to disk. Any \fBKActionCollection\fP objects with the xmlFile() value set will be written to an xml file. All other will be written to the application's rc file.Definition at line 265 of file kkeydialog.cpp.
.PP
References commitChanges().
.SS "void KKeyChooser::keyChange ()\fC [signal]\fP"
.PP
Emitted when an action's shortcut has been changed. Referenced by allDefault().
.SS "void KKeyChooser::allDefault ()\fC [slot]\fP"
.PP
Set all keys to their default values (bindings). Definition at line 557 of file kkeydialog.cpp.
.PP
References QListViewItemIterator::current(), and keyChange().
.SS "void KKeyChooser::setPreferFourModifierKeys (bool preferFourModifierKeys)\fC [slot]\fP"
.PP
Specifies whether to use the 3 or 4 modifier key scheme. This determines which default is used when the 'Default' button is clicked.Definition at line 587 of file kkeydialog.cpp.
.SS "void KKeyChooser::buildListView (uint iList, const \fBQString\fP & title = QString::null)\fC [protected]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 415 of file kkeydialog.cpp.
.PP
References KShortcutList::count(), QListViewItem::firstChild(), KShortcutList::isConfigurable(), QString::isEmpty(), KShortcutList::label(), KShortcutList::name(), QListViewItem::setExpandable(), QListViewItem::setOpen(), QListViewItem::setSelectable(), and QString::startsWith().
.PP
Referenced by insert().
.SS "void KKeyChooser::listSync ()\fC [slot]\fP"
.PP
Rebuild list entries based on underlying map. Use this if you changed the underlying map.Definition at line 602 of file kkeydialog.cpp.

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