.TH "KKeyDialog" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KKeyDialog \- The KKeyDialog class is used for configuring dictionaries of key/action associations for \fBKActionCollection\fP, \fBKAccel\fP, and \fBKGlobalAccel\fP. 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
.RI "\fIConstructs a KKeyDialog called \fCname\fP as a child of \fCparent\fP. \fP"
.ti -1c
.RI "virtual \fB~KKeyDialog\fP ()"
.br
.RI "\fIDestructor. \fP"
.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 "bool \fBconfigure\fP (bool bSaveSettings=true)"
.br
.ti -1c
.RI "void \fBcommitChanges\fP ()"
.br
.RI "\fICommit key setting changes so that changed settings actually become active. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "int \fBconfigure\fP (\fBKActionCollection\fP *coll, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.RI "\fIPops up a modal dialog for configuring key settings. \fP"
.ti -1c
.RI "int \fBconfigure\fP (\fBKAccel\fP *keys, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.RI "\fIThis is an overloaded member function, provided for convenience. \fP"
.ti -1c
.RI "int \fBconfigure\fP (\fBKGlobalAccel\fP *keys, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.RI "\fIThis is an overloaded member function, provided for convenience. \fP"
.ti -1c
.RI "int \fBconfigure\fP (\fBKActionCollection\fP *coll, bool bAllowLetterShortcuts, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.RI "\fIThis is an overloaded member function, provided for convenience. \fP"
.ti -1c
.RI "int \fBconfigure\fP (\fBKAccel\fP *keys, bool bAllowLetterShortcuts, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.RI "\fIThis is an overloaded member function, provided for convenience. \fP"
.ti -1c
.RI "int \fBconfigure\fP (\fBKGlobalAccel\fP *keys, bool bAllowLetterShortcuts, \fBQWidget\fP *parent=0, bool bSaveSettings=true)"
.br
.RI "\fIThis is an overloaded member function, provided for convenience. \fP"
.ti -1c
.RI "int \fBconfigureKeys\fP (\fBKAccel\fP *keys, bool save_settings=true, \fBQWidget\fP *parent=0)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Obsolete. \fP"
.ti -1c
.RI "int \fBconfigureKeys\fP (\fBKGlobalAccel\fP *keys, bool save_settings=true, \fBQWidget\fP *parent=0)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Obsolete. \fP"
.ti -1c
.RI "int \fBconfigureKeys\fP (\fBKActionCollection\fP *coll, const  \fBQString\fP &, bool save_settings=true, \fBQWidget\fP *parent=0)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Obsolete. \fP"
.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 
The KKeyDialog class is used for configuring dictionaries of key/action associations for \fBKActionCollection\fP, \fBKAccel\fP, and \fBKGlobalAccel\fP. Dialog for configuration of \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

 \fBKKeyDialog::configure\fP( actionCollection() );
 
.PP
.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 217 of file kkeydialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KKeyDialog::KKeyDialog (bool bAllowLetterShortcuts = true, \fBQWidget\fP * parent = 0, const char * name = 0)"
.PP
Constructs a KKeyDialog called \fCname\fP as a child of \fCparent\fP. Set \fCbAllowLetterShortcuts\fP to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.Definition at line 878 of file kkeydialog.cpp.
.PP
References KGlobal::config(), KDialogBase::defaultClicked(), KDialogBase::enableButton(), KStdAccel::name(), and KDialogBase::setMainWidget().
.SS "KKeyDialog::~\fBKKeyDialog\fP ()\fC [virtual]\fP"
.PP
Destructor. Deletes all resources used by a KKeyDialog object.Definition at line 891 of file kkeydialog.cpp.
.PP
References KGlobal::config().
.SH "Member Function Documentation"
.PP 
.SS "bool KKeyDialog::insert (\fBKActionCollection\fP *)"
.PP
Insert an action collection, i.e. 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
Definition at line 897 of file kkeydialog.cpp.
.PP
References KKeyChooser::insert().
.SS "bool KKeyDialog::insert (\fBKActionCollection\fP *, const \fBQString\fP & title)"
.PP
Insert an action collection, i.e. 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 \fBKAboutData::progName\fP() of the collection's instance is used) 
.RE
.PP
\fBReturns:\fP
.RS 4
true :) 
.RE
.PP
\fBSince:\fP
.RS 4
3.1
.RE
.PP
Definition at line 902 of file kkeydialog.cpp.
.PP
References KKeyChooser::insert().
.SS "void KKeyDialog::commitChanges ()"
.PP
Commit key setting changes so that changed settings actually become active. This method is implicitly called from \fBconfigure\fP if \fCbSaveSettings\fP is true.Definition at line 919 of file kkeydialog.cpp.
.PP
References KKeyChooser::commitChanges().
.SS "int KKeyDialog::configure (\fBKActionCollection\fP * coll, \fBQWidget\fP * parent = 0, bool bSaveSettings = true)\fC [static]\fP"
.PP
Pops up a modal dialog for configuring key settings. The new shortcut settings will be active if the user presses OK. If \fCbSaveSettings\fP is 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
Definition at line 924 of file kkeydialog.cpp.
.PP
Referenced by configure(), and configureKeys().
.SS "int KKeyDialog::configure (\fBKAccel\fP * keys, \fBQWidget\fP * parent = 0, bool bSaveSettings = true)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. It behaves essentially like the above function, except that settings are saved to a *.rc file using \fBKConfig\fP.Definition at line 929 of file kkeydialog.cpp.
.PP
References configure().
.SS "int KKeyDialog::configure (\fBKGlobalAccel\fP * keys, \fBQWidget\fP * parent = 0, bool bSaveSettings = true)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.Definition at line 934 of file kkeydialog.cpp.
.PP
References configure().
.SS "int KKeyDialog::configure (\fBKActionCollection\fP * coll, bool bAllowLetterShortcuts, \fBQWidget\fP * parent = 0, bool bSaveSettings = true)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. It behaves essentially like the above function. 
.PP
\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 959 of file kkeydialog.cpp.
.PP
References configure(), KKeyChooser::insert(), and m_pKeyChooser.
.SS "int KKeyDialog::configure (\fBKAccel\fP * keys, bool bAllowLetterShortcuts, \fBQWidget\fP * parent = 0, bool bSaveSettings = true)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. It behaves essentially like the above function. Definition at line 939 of file kkeydialog.cpp.
.PP
References configure(), KKeyChooser::insert(), m_pKeyChooser, and KAccel::updateConnections().
.SS "int KKeyDialog::configure (\fBKGlobalAccel\fP * keys, bool bAllowLetterShortcuts, \fBQWidget\fP * parent = 0, bool bSaveSettings = true)\fC [static]\fP"
.PP
This is an overloaded member function, provided for convenience. It behaves essentially like the above function. Definition at line 949 of file kkeydialog.cpp.
.PP
References configure(), KKeyChooser::insert(), m_pKeyChooser, and KGlobalAccel::updateConnections().
.SS "int KKeyDialog::configureKeys (\fBKAccel\fP * keys, bool save_settings = true, \fBQWidget\fP * parent = 0)\fC [inline, static]\fP"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Obsolete. Please use \fBKKeyDialog::configure\fP insteadDefinition at line 314 of file kkeydialog.h.
.PP
References configure().
.SS "int KKeyDialog::configureKeys (\fBKGlobalAccel\fP * keys, bool save_settings = true, \fBQWidget\fP * parent = 0)\fC [inline, static]\fP"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Obsolete. Please use \fBKKeyDialog::configure\fP insteadDefinition at line 320 of file kkeydialog.h.
.PP
References configure().
.SS "int KKeyDialog::configureKeys (\fBKActionCollection\fP * coll, const \fBQString\fP &, bool save_settings = true, \fBQWidget\fP * parent = 0)\fC [inline, static]\fP"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Obsolete. Please use \fBKKeyDialog::configure\fP insteadDefinition at line 326 of file kkeydialog.h.
.PP
References configure().

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