.TH "KKeyDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyDialog \- Dialog for configuration of \fBKActionCollection\fP, \fBKAccel\fP, and \fBKGlobalAccel\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kkeydialog.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKKeyDialog\fP (bool bAllowLetterShortcuts=true, \fBQWidget\fP *parent=0, const char *name=0)"
.br
.ti -1c
.RI "virtual \fB~KKeyDialog\fP ()"
.br
.ti -1c
.RI "bool \fBinsert\fP (\fBKActionCollection\fP *)"
.br
.ti -1c
.RI "bool \fBinsert\fP (\fBKActionCollection\fP *, const \fBQString\fP &title)"
.br
.ti -1c
.RI "bool \fBconfigure\fP (bool bSaveSettings=true)"
.br
.ti -1c
.RI "void \fBcommitChanges\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static int \fBconfigure\fP (\fBKActionCollection\fP *coll, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.ti -1c
.RI "static int \fBconfigure\fP (\fBKAccel\fP *keys, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.ti -1c
.RI "static int \fBconfigure\fP (\fBKGlobalAccel\fP *keys, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.ti -1c
.RI "static int \fBconfigure\fP (\fBKActionCollection\fP *coll, bool bAllowLetterShortcuts, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.ti -1c
.RI "static int \fBconfigure\fP (\fBKAccel\fP *keys, bool bAllowLetterShortcuts, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.ti -1c
.RI "static int \fBconfigure\fP (\fBKGlobalAccel\fP *keys, bool bAllowLetterShortcuts, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.ti -1c
.RI "static KDE_DEPRECATED int \fBconfigureKeys\fP (\fBKAccel\fP *keys, bool save_settings=true, \fBQWidget\fP *parent=0)"
.br
.ti -1c
.RI "static KDE_DEPRECATED int \fBconfigureKeys\fP (\fBKGlobalAccel\fP *keys, bool save_settings=true, \fBQWidget\fP *parent=0)"
.br
.ti -1c
.RI "static KDE_DEPRECATED int \fBconfigureKeys\fP (\fBKActionCollection\fP *coll, const \fBQString\fP &, bool save_settings=true, \fBQWidget\fP *parent=0)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Dialog for configuration of \fBKActionCollection\fP, \fBKAccel\fP, and \fBKGlobalAccel\fP. 

The KKeyDialog class is used for configuring dictionaries of key/action associations for \fBKActionCollection\fP, \fBKAccel\fP, and \fBKGlobalAccel\fP. It uses the \fBKKeyChooser\fP widget and offers buttons to set all keys to defaults and invoke on-line help.
.PP
Three static methods are supplied which provide the most convienient interface to the dialog. The most common and most encouraged use is with \fBKActionCollection\fP.
.PP
.PP
.nf
 KKeyDialog::configure( actionCollection() );
.fi
.PP
.PP
\fBAuthor:\fP
.RS 4
Nicolas Hadacek <hadacek@via.ecp.fr> 
.RE
.PP

.PP
Definition at line 274 of file kkeydialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KKeyDialog::KKeyDialog (bool bAllowLetterShortcuts = \fCtrue\fP, \fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Constructs a KKeyDialog called \fCname\fP as a child of \fCparent\fP. 
.PP
Set \fCbAllowLetterShortcuts\fP to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.
.PP
Definition at line 1101 of file kkeydialog.cpp.
.PP
References KDialogBase::defaultClicked(), KDialogBase::enableButton(), KConfigBase::readSizeEntry(), and KDialogBase::setMainWidget().
.SS "KKeyDialog::~\fBKKeyDialog\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Deletes all resources used by a KKeyDialog object.
.PP
Definition at line 1114 of file kkeydialog.cpp.
.PP
References KConfigBase::writeEntry().
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyDialog::insert (\fBKActionCollection\fP *)"
.PP
Insert an action collection, i.e. 
.PP
add all its actions to the ones displayed by the dialog. This method can be useful in applications following the document/view design, with actions in both the document and the view. Simply call insert with the action collections of each one in turn. 
.PP
\fBReturns:\fP
.RS 4
true :)
.RE
.PP

.PP
Definition at line 1120 of file kkeydialog.cpp.
.PP
References KKeyChooser::insert().
.PP
Referenced by KXMLGUIFactory::configureShortcuts().
.SS "bool KKeyDialog::insert (\fBKActionCollection\fP *, const \fBQString\fP & title)"
.PP
Insert an action collection, i.e. 
.PP
add all its actions to the ones displayed by the dialog. This method can be useful in applications following the document/view design, with actions in both the document and the view. Simply call insert with the action collections of each one in turn.
.PP
\fBParameters:\fP
.RS 4
\fItitle\fP the title associated with the collection (if null, the KAboutData::progName() of the collection's instance is used) 
.RE
.PP
\fBReturns:\fP
.RS 4
true :) 
.RE
.PP
\fBSince:\fP
.RS 4
3.1
.RE
.PP

.PP
Definition at line 1125 of file kkeydialog.cpp.
.PP
References KKeyChooser::insert().
.SS "void KKeyDialog::commitChanges ()"
.PP
Commit key setting changes so that changed settings actually become active. 
.PP
This method is implicitly called from \fBconfigure\fP if \fCbSaveSettings\fP is true.
.PP
Definition at line 1142 of file kkeydialog.cpp.
.PP
References KKeyChooser::commitChanges().
.SS "int KKeyDialog::configure (\fBKActionCollection\fP * coll, \fBQWidget\fP * parent = \fC0\fP, bool bSaveSettings = \fCtrue\fP)\fC [static]\fP"
.PP
Pops up a modal dialog for configuring key settings. 
.PP
The new shortcut settings will be active if the user presses OK. If \fCbSaveSettings\fP if true, the settings will also be saved back to the *uirc file which they were intially read from. 
.PP
\fBReturns:\fP
.RS 4
Accept if the dialog was closed with OK, Reject otherwise.
.RE
.PP

.PP
Definition at line 1147 of file kkeydialog.cpp.
.PP
Referenced by configure().
.SS "int KKeyDialog::configure (\fBKAccel\fP * keys, \fBQWidget\fP * parent = \fC0\fP, bool bSaveSettings = \fCtrue\fP)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. 
.PP
It behaves essentially like the above function, except that settings are saved to a *.rc file using \fBKConfig\fP.
.PP
Definition at line 1152 of file kkeydialog.cpp.
.PP
References configure().
.SS "int KKeyDialog::configure (\fBKGlobalAccel\fP * keys, \fBQWidget\fP * parent = \fC0\fP, bool bSaveSettings = \fCtrue\fP)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. 
.PP
It behaves essentially like the above function.
.PP
Definition at line 1157 of file kkeydialog.cpp.
.PP
References configure().
.SS "int KKeyDialog::configure (\fBKActionCollection\fP * coll, bool bAllowLetterShortcuts, \fBQWidget\fP * parent = \fC0\fP, bool bSaveSettings = \fCtrue\fP)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. 
.PP
It behaves essentially like the above function.
.PP
\fBParameters:\fP
.RS 4
\fIcoll\fP the \fBKActionCollection\fP to configure 
.br
\fIbAllowLetterShortcuts\fP Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts. 
.br
\fIparent\fP the parent widget to attach to 
.br
\fIbSaveSettings\fP if true, the settings will also be saved back to the *uirc file which they were intially read from.
.RE
.PP

.PP
Definition at line 1182 of file kkeydialog.cpp.
.PP
References configure(), endl(), KKeyChooser::insert(), kdDebug(), and m_pKeyChooser.
.SS "int KKeyDialog::configure (\fBKAccel\fP * keys, bool bAllowLetterShortcuts, \fBQWidget\fP * parent = \fC0\fP, bool bSaveSettings = \fCtrue\fP)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. 
.PP
It behaves essentially like the above function. 
.PP
Definition at line 1162 of file kkeydialog.cpp.
.PP
References configure(), KKeyChooser::insert(), and m_pKeyChooser.
.SS "int KKeyDialog::configure (\fBKGlobalAccel\fP * keys, bool bAllowLetterShortcuts, \fBQWidget\fP * parent = \fC0\fP, bool bSaveSettings = \fCtrue\fP)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. 
.PP
It behaves essentially like the above function. 
.PP
Definition at line 1172 of file kkeydialog.cpp.
.PP
References configure(), KKeyChooser::insert(), and m_pKeyChooser.
.SS "static KDE_DEPRECATED int KKeyDialog::configureKeys (\fBKAccel\fP * keys, bool save_settings = \fCtrue\fP, \fBQWidget\fP * parent = \fC0\fP)\fC [inline, static]\fP"
.PP
\fBDeprecated\fP
.RS 4
Obsolete. Please use \fBKKeyDialog::configure\fP instead 
.RE
.PP

.PP
Definition at line 376 of file kkeydialog.h.
.SS "static KDE_DEPRECATED int KKeyDialog::configureKeys (\fBKGlobalAccel\fP * keys, bool save_settings = \fCtrue\fP, \fBQWidget\fP * parent = \fC0\fP)\fC [inline, static]\fP"
.PP
\fBDeprecated\fP
.RS 4
Obsolete. Please use \fBKKeyDialog::configure\fP instead 
.RE
.PP

.PP
Definition at line 382 of file kkeydialog.h.
.SS "static KDE_DEPRECATED int KKeyDialog::configureKeys (\fBKActionCollection\fP * coll, const \fBQString\fP &, bool save_settings = \fCtrue\fP, \fBQWidget\fP * parent = \fC0\fP)\fC [inline, static]\fP"
.PP
\fBDeprecated\fP
.RS 4
Obsolete. Please use \fBKKeyDialog::configure\fP instead 
.RE
.PP

.PP
Definition at line 388 of file kkeydialog.h.

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