KShortcutsDialog Class Reference

#include <kshortcutsdialog.h>

Inheritance diagram for KShortcutsDialog:

Signals
void	saved ()
Signals inherited from KDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()

Public Member Functions
	KShortcutsDialog (KShortcutsEditor::ActionTypes types=KShortcutsEditor::AllActions, KShortcutsEditor::LetterShortcuts allowLetterShortcuts=KShortcutsEditor::LetterShortcutsAllowed, QWidget *parent=0)
virtual	~KShortcutsDialog ()
QList< KActionCollection * >	actionCollections () const
void	addCollection (KActionCollection *, const QString &title=QString())
bool	configure (bool saveSettings=true)
virtual QSize	sizeHint () const
Public Member Functions inherited from KDialog
	KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
	~KDialog ()
KPushButton *	button (ButtonCode id) const
KIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
QWidget *	mainWidget ()
virtual QSize	minimumSizeHint () const
void	restoreDialogSize (const KConfigGroup &config)
void	saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const KIcon &icon)
void	setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)

Static Public Member Functions
static int	configure (KActionCollection *collection, KShortcutsEditor::LetterShortcuts allowLetterShortcuts=KShortcutsEditor::LetterShortcutsAllowed, QWidget *parent=0, bool bSaveSettings=true)
Static Public Member Functions inherited from KDialog
static bool	avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void	centerOnScreen (QWidget *widget, int screen=-1)
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int	spacingHint ()

Additional Inherited Members
Public Types inherited from KDialog
enum	ButtonCode {   None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004,   Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040,   No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400,   User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }
Public Slots inherited from KDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)
Protected Slots inherited from KDialog
virtual void	slotButtonClicked (int button)
void	updateGeometry ()
Protected Member Functions inherited from KDialog
	KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void	closeEvent (QCloseEvent *e)
virtual void	hideEvent (QHideEvent *)
virtual void	keyPressEvent (QKeyEvent *)
Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Detailed Description

Dialog for configuration of KActionCollection and KGlobalAccel.

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

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

KShortcutsDialog::configure( actionCollection() );

Since

4.3 By default this dialog is modal. If you don't want that, setModal(false) and then the non-static configure() will show the dialog. If you want to do anything extra when the dialog is done, connect to okClicked() and/or cancelClicked(). However, if your extra stuff depends on the changed settings already being saved, connect to saved() instead to be safe; if you connect to okClicked() your function might be called before the save happens.

example:

KShortcutsDialog dlg;
dlg.addCollection(myActions);
dlg.setModal(false);
connect(&dlg, SIGNAL(saved()), this, SLOT(doExtraStuff()));
dlg.configure();

KDE Shortcuts Dialog

Author

Nicolas Hadacek hadac.nosp@m.ek@v.nosp@m.ia.ec.nosp@m.p.fr

Hamish Rodda rodda.nosp@m.@kde.nosp@m..org (KDE 4 porting)

Michael Jansen kde@m.nosp@m.icha.nosp@m.el-ja.nosp@m.nsen.nosp@m..biz

Definition at line 69 of file kshortcutsdialog.h.

Constructor & Destructor Documentation

KShortcutsDialog::KShortcutsDialog ( KShortcutsEditor::ActionTypes  types = KShortcutsEditor::AllActions, KShortcutsEditor::LetterShortcuts  allowLetterShortcuts = KShortcutsEditor::LetterShortcutsAllowed, QWidget *  parent = 0  )

explicit

Constructs a KShortcutsDialog as a child of parent.

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

Definition at line 119 of file kshortcutsdialog.cpp.

KShortcutsDialog::~KShortcutsDialog ( )

virtual

Destructor.

Deletes all resources used by a KShortcutsDialog object.

Definition at line 145 of file kshortcutsdialog.cpp.

Member Function Documentation

QList< KActionCollection * > KShortcutsDialog::actionCollections

(

)

const

Returns

the list of action collections that are available for configuration in the dialog.

Definition at line 160 of file kshortcutsdialog.cpp.

void KShortcutsDialog::addCollection	(	KActionCollection *	collection,
		const QString &	title = QString()
	)

Add all actions of the collection to the ones displayed and configured by the dialog.

Parameters

title

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

Definition at line 153 of file kshortcutsdialog.cpp.

bool KShortcutsDialog::configure

(

bool

saveSettings = true

)

Run the dialog and call writeSettings() on the action collections that were added if bSaveSettings is true.

Definition at line 166 of file kshortcutsdialog.cpp.

int KShortcutsDialog::configure ( KActionCollection *  collection, KShortcutsEditor::LetterShortcuts  allowLetterShortcuts = KShortcutsEditor::LetterShortcutsAllowed, QWidget *  parent = 0, bool  bSaveSettings = true  )

static

Pops up a modal dialog for configuring key settings.

The new shortcut settings will become active if the user presses OK.

Parameters

collection	the KActionCollection to configure
allowLetterShortcuts	set to KShortcutsEditor::LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.
parent	the parent widget to attach to
bSaveSettings	if true, the settings will also be saved back by calling writeSettings() on the action collections that were added.

Returns

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

Definition at line 186 of file kshortcutsdialog.cpp.

void KShortcutsDialog::saved ( )

signal

emitted after ok is clicked and settings are saved

QSize KShortcutsDialog::sizeHint ( ) const

virtual

See also

QWidget::sizeHint()

Reimplemented from KDialog.

Definition at line 181 of file kshortcutsdialog.cpp.

---

The documentation for this class was generated from the following files:

• kshortcutsdialog.h
• kshortcutsdialog.cpp