class KKeyDialog

# class KKeyDialog | Dialog for configuration of KActionCollection, KAccel, and KGlobalAccel. More...
Definition | `#include <kkeydialog.h>`
Inherits | KDialogBase [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KKeyDialog ( bool bAllowLetterShortcuts = true, QWidget* parent = 0, const char* name = 0 )
- virtual ~KKeyDialog ()
- bool insert ( KActionCollection* )
- bool insert (KActionCollection *, const QString &title)
- bool configure ( bool bSaveSettings = true )
- void commitChanges ()

#### Public Static Methods

- static int configure ( KActionCollection* coll, QWidget* parent = 0, bool bSaveSettings = true )
- static int configure ( KAccel* keys, QWidget* parent = 0, bool bSaveSettings = true )
- static int configure ( KGlobalAccel* keys, QWidget* parent = 0, bool bSaveSettings = true )
- static int configure ( KActionCollection* coll, bool bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true )
- static int configure ( KAccel* keys, bool bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true )
- static int configure ( KGlobalAccel* keys, bool bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true )
- static int configureKeys ( KAccel* keys, bool save_settings = true, QWidget* parent = 0 )
- static int configureKeys ( KGlobalAccel* keys, bool save_settings = true, QWidget* parent = 0 )
- static int configureKeys ( KActionCollection* coll, const QString& , bool save_settings = true, QWidget* parent = 0 )

#### Protected Methods

- virtual void virtual_hook ( int id, void* data )

## Detailed Description

The KKeyDialog class is used for configuring dictionaries of key/action associations for KActionCollection, KAccel, and KGlobalAccel. It uses the KKeyChooser widget and offers buttons to set all keys to defaults and invoke on-line help.

Three static methods are supplied which provide the most convienient interface to the dialog. The most common and most encouraged use is with KActionCollection.

     KKeyDialog::configure( actionCollection() );

KKeyDialog ( bool bAllowLetterShortcuts = true, QWidget* parent = 0, const char* name = 0 ) | ### KKeyDialog

Constructs a KKeyDialog called `name` as a child of `parent`. Set `bAllowLetterShortcuts` to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

~KKeyDialog () | ### ~KKeyDialog

[virtual]

Destructor. Deletes all resources used by a KKeyDialog object.

bool insert ( KActionCollection* ) | ### insert

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.

Returns: true :)

bool insert (KActionCollection *, const QString &title) | ### insert

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.

Parameters:

title | the title associated with the collection (if null, the KAboutData::progName() of the collection's instance is used)

Returns: true :)

bool configure ( bool bSaveSettings = true ) | ### configure

void commitChanges () | ### commitChanges

Commit key setting changes so that changed settings actually become active. This method is implicitly called from #configure if `bSaveSettings` is true.

int configure ( KActionCollection* coll, QWidget* parent = 0, bool bSaveSettings = true ) | ### configure

[static]

Pops up a modal dialog for configuring key settings. The new shortcut settings will be active if the user presses OK. If `bSaveSettings` is true, the settings will also be saved back to the *uirc file which they were intially read from.

Returns: Accept if the dialog was closed with OK, Reject otherwise.

int configure ( KAccel* keys, QWidget* parent = 0, bool bSaveSettings = true ) | ### configure

[static]

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

int configure ( KGlobalAccel* keys, QWidget* parent = 0, bool bSaveSettings = true ) | ### configure

[static]

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

int configure ( KActionCollection* coll, bool bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true ) | ### configure

[static]

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Parameters:

bAllowLetterShortcuts | Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

int configure ( KAccel* keys, bool bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true ) | ### configure

[static]

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

int configure ( KGlobalAccel* keys, bool bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true ) | ### configure

[static]

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

int configureKeys ( KAccel* keys, bool save_settings = true, QWidget* parent = 0 ) | ### configureKeys

[static]

Please use KKeyDialog::configure instead

int configureKeys ( KGlobalAccel* keys, bool save_settings = true, QWidget* parent = 0 ) | ### configureKeys

[static]

Please use KKeyDialog::configure instead

int configureKeys ( KActionCollection* coll, const QString& , bool save_settings = true, QWidget* parent = 0 ) | ### configureKeys

[static]

Please use KKeyDialog::configure instead

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from KDialogBase.

- Version: $Id: kkeydialog.h,v 1.72.2.1 2003/04/25 07:38:44 mlaurent Exp $
- Author: Nicolas Hadacek
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.