#include <kkeydialog.h>

Inherits TQWidget.

Public Types
enum	ActionType { Application , ApplicationGlobal , Standard , Global }

Public Slots
void	allDefault ()

void	setPreferFourModifierKeys (bool preferFourModifierKeys)

void	listSync ()

Signals
void	keyChange ()

Public Member Functions
	KKeyChooser (TQWidget *parent, ActionType type=Application, bool bAllowLetterShortcuts=true)

	KKeyChooser (TDEActionCollection coll, TQWidget parent, bool bAllowLetterShortcuts=true)

	KKeyChooser (TDEAccel actions, TQWidget parent, bool bAllowLetterShortcuts=true)

	KKeyChooser (TDEGlobalAccel actions, TQWidget parent)

	KKeyChooser (TDEShortcutList , TQWidget parent, ActionType type=Application, bool bAllowLetterShortcuts=true)

bool	insert (TDEActionCollection *)

bool	insert (TDEActionCollection *, const TQString &title)

void	syncToConfig (const TQString &sConfigGroup, TDEConfigBase *pConfig, bool bClearUnset)

void	commitChanges ()

void	save ()

	KKeyChooser (TDEAccel actions, TQWidget parent, bool bCheckAgainstStdKeys, bool bAllowLetterShortcuts, bool bAllowWinKey=false)

	KKeyChooser (TDEGlobalAccel actions, TQWidget parent, bool bCheckAgainstStdKeys, bool bAllowLetterShortcuts, bool bAllowWinKey=false)

Static Public Member Functions
static bool	checkGlobalShortcutsConflict (const TDEShortcut &cut, bool warnUser, TQWidget *parent)

static bool	checkStandardShortcutsConflict (const TDEShortcut &cut, bool warnUser, TQWidget *parent)

Protected Types
enum	{ NoKey = 1 , DefaultKey , CustomKey }

Protected Slots
void	slotNoKey ()

void	slotDefaultKey ()

void	slotCustomKey ()

void	slotListItemSelected (TQListViewItem *item)

void	capturedShortcut (const TDEShortcut &cut)

void	slotSettingsChanged (int)

void	slotListItemDoubleClicked (TQListViewItem *ipoQListViewItem, const TQPoint &ipoQPoint, int c)

Protected Member Functions
void	initGUI (ActionType type, bool bAllowLetterShortcuts)

bool	insert (TDEAccel *)

bool	insert (TDEGlobalAccel *)

bool	insert (TDEShortcutList *)

void	buildListView (uint iList, const TQString &title=TQString::null)

void	readGlobalKeys ()

void	updateButtons ()

void	fontChange (const TQFont &_font)

void	setShortcut (const TDEShortcut &cut)

bool	isKeyPresent (const TDEShortcut &cut, bool warnuser=true)

bool	isKeyPresentLocally (const TDEShortcut &cut, KKeyChooserItem *ignoreItem, const TQString &warnText)

void	_warning (const KKeySequence &seq, TQString sAction, TQString sTitle)

virtual void	virtual_hook (int id, void *data)

Protected Attributes
ActionType	m_type

bool	m_bAllowLetterShortcuts

bool	m_bAllowWinKey

bool	m_bPreferFourModifierKeys

TQRadioButton *	m_prbNone

TQRadioButton *	m_prbDef

TQRadioButton *	m_prbCustom

Friends
class	KKeyDialog

Detailed Description

Widget for configuration of TDEAccel and TDEGlobalAccel.

Configure dictionaries of key/action associations for TDEAccel and TDEGlobalAccel.

The class takes care of all aspects of configuration, including handling key conflicts internally. Connect to the allDefault() slot if you want to set all configurable shortcuts to their default values.

See also: KKeyDialog

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

Definition at line 58 of file kkeydialog.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Definition at line 168 of file kkeydialog.h.

◆ ActionType

enum KKeyChooser::ActionType

Definition at line 62 of file kkeydialog.h.

Constructor & Destructor Documentation

◆ KKeyChooser() [1/7]

KKeyChooser::KKeyChooser	(	TQWidget *	parent,
		ActionType	type = `Application`,
		bool	bAllowLetterShortcuts = `true`
	)

Constructor.

Parameters

parent	the parent widget for this widget
type	the ActionType for this KKeyChooser
bAllowLetterShortcuts	Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 154 of file kkeydialog.cpp.

◆ KKeyChooser() [2/7]

KKeyChooser::KKeyChooser	(	TDEActionCollection *	coll,
		TQWidget *	parent,
		bool	bAllowLetterShortcuts = `true`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

parent	parent widget
coll	the TDEActionCollection to configure
bAllowLetterShortcuts	Set to false if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 160 of file kkeydialog.cpp.

◆ KKeyChooser() [3/7]

KKeyChooser::KKeyChooser	(	TDEAccel *	actions,
		TQWidget *	parent,
		bool	bAllowLetterShortcuts = `true`
	)

Definition at line 167 of file kkeydialog.cpp.

◆ KKeyChooser() [4/7]

KKeyChooser::KKeyChooser	(	TDEGlobalAccel *	actions,
		TQWidget *	parent
	)

Definition at line 174 of file kkeydialog.cpp.

◆ KKeyChooser() [5/7]

KKeyChooser::KKeyChooser	(	TDEShortcutList *	pList,
		TQWidget *	parent,
		ActionType	type = `Application`,
		bool	bAllowLetterShortcuts = `true`
	)

Definition at line 181 of file kkeydialog.cpp.

◆ ~KKeyChooser()

KKeyChooser::~KKeyChooser ( )

virtual

Definition at line 224 of file kkeydialog.cpp.

◆ KKeyChooser() [6/7]

KKeyChooser::KKeyChooser	(	TDEAccel *	actions,
		TQWidget *	parent,
		bool	bCheckAgainstStdKeys,
		bool	bAllowLetterShortcuts,
		bool	bAllowWinKey = `false`
	)

Deprecated:

Definition at line 188 of file kkeydialog.cpp.

◆ KKeyChooser() [7/7]

KKeyChooser::KKeyChooser	(	TDEGlobalAccel *	actions,
		TQWidget *	parent,
		bool	bCheckAgainstStdKeys,
		bool	bAllowLetterShortcuts,
		bool	bAllowWinKey = `false`
	)

Deprecated:

Definition at line 204 of file kkeydialog.cpp.

Member Function Documentation

◆ _warning()

void KKeyChooser::_warning	(	const KKeySequence &	seq,
		TQString	sAction,
		TQString	sTitle
	)

protected

Definition at line 938 of file kkeydialog.cpp.

◆ allDefault

void KKeyChooser::allDefault ( )

slot

Set all keys to their default values (bindings).

Definition at line 615 of file kkeydialog.cpp.

◆ buildListView()

void KKeyChooser::buildListView	(	uint	iList,
		const TQString &	title = `TQString::null`
	)

protected

Since: 3.1

Definition at line 461 of file kkeydialog.cpp.

◆ capturedShortcut

void KKeyChooser::capturedShortcut ( const TDEShortcut & cut )

protectedslot

Definition at line 652 of file kkeydialog.cpp.

◆ checkGlobalShortcutsConflict()

bool KKeyChooser::checkGlobalShortcutsConflict	(	const TDEShortcut &	cut,
		bool	warnUser,
		TQWidget *	parent
	)

static

Checks whether the given shortcut conflicts with global keyboard shortcuts.

If yes, and the warnUser argument is true, warns the user and gives them a chance to reassign the shortcut from the global shortcut.

Returns: true if there was conflict (and the user didn't reassign the shortcut)

Parameters

cut	the shortcut that will be checked for conflicts
warnUser	if true, the user will be warned about a conflict and given a chance to reassign the shortcut
parent	parent widget for the warning dialog

Since: 3.2

Definition at line 849 of file kkeydialog.cpp.

◆ checkStandardShortcutsConflict()

bool KKeyChooser::checkStandardShortcutsConflict	(	const TDEShortcut &	cut,
		bool	warnUser,
		TQWidget *	parent
	)

static

Checks whether the given shortcut conflicts with standard keyboard shortcuts.

If yes, and the warnUser argument is true, warns the user and gives them a chance to reassign the shortcut from the standard shortcut.

Returns: true if there was conflict (and the user didn't reassign the shortcut)

Parameters

cut	the shortcut that will be checked for conflicts
warnUser	if true, the user will be warned about a conflict and given a chance to reassign the shortcut
parent	parent widget for the warning dialog

Since: 3.2

Definition at line 831 of file kkeydialog.cpp.

◆ commitChanges()

void KKeyChooser::commitChanges ( )

This function writes any shortcut changes back to the original action set(s).

Definition at line 273 of file kkeydialog.cpp.

◆ fontChange()

void KKeyChooser::fontChange ( const TQFont & _font )

protected

Definition at line 602 of file kkeydialog.cpp.

◆ initGUI()

void KKeyChooser::initGUI	(	ActionType	type,
		bool	bAllowLetterShortcuts
	)

protected

Definition at line 292 of file kkeydialog.cpp.

◆ insert() [1/5]

bool KKeyChooser::insert ( TDEAccel * pAccel )

protected

Definition at line 252 of file kkeydialog.cpp.

◆ insert() [2/5]

bool KKeyChooser::insert ( TDEActionCollection * pColl )

Insert an action collection, i.e.

add all its actions to the ones already associated with the KKeyChooser object.

Definition at line 233 of file kkeydialog.cpp.

◆ insert() [3/5]

bool KKeyChooser::insert	(	TDEActionCollection *	pColl,
		const TQString &	title
	)

Insert an action collection, i.e.

add all its actions to the ones already associated with the KKeyChooser object.

Parameters

title subtree title of this collection of shortcut.

Since: 3.1

Definition at line 238 of file kkeydialog.cpp.

◆ insert() [4/5]

bool KKeyChooser::insert ( TDEGlobalAccel * pAccel )

protected

Definition at line 259 of file kkeydialog.cpp.

◆ insert() [5/5]

bool KKeyChooser::insert ( TDEShortcutList * pList )

protected

Definition at line 266 of file kkeydialog.cpp.

◆ isKeyPresent()

bool KKeyChooser::isKeyPresent	(	const TDEShortcut &	cut,
		bool	warnuser = `true`
	)

protected

Definition at line 753 of file kkeydialog.cpp.

◆ isKeyPresentLocally()

bool KKeyChooser::isKeyPresentLocally	(	const TDEShortcut &	cut,
		KKeyChooserItem *	ignoreItem,
		const TQString &	warnText
	)

protected

Definition at line 799 of file kkeydialog.cpp.

◆ keyChange

void KKeyChooser::keyChange ( )

signal

Emitted when an action's shortcut has been changed.

◆ listSync

void KKeyChooser::listSync ( )

slot

Rebuild list entries based on underlying map.

Use this if you changed the underlying map.

Definition at line 662 of file kkeydialog.cpp.

◆ readGlobalKeys()

void KKeyChooser::readGlobalKeys ( )

protected

Definition at line 580 of file kkeydialog.cpp.

◆ save()

void KKeyChooser::save ( )

This commits and then saves the actions to disk.

Any TDEActionCollection 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 285 of file kkeydialog.cpp.

◆ setPreferFourModifierKeys

void KKeyChooser::setPreferFourModifierKeys ( bool preferFourModifierKeys )

slot

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 647 of file kkeydialog.cpp.

◆ setShortcut()

void KKeyChooser::setShortcut ( const TDEShortcut & cut )

protected

Definition at line 702 of file kkeydialog.cpp.

◆ slotCustomKey

void KKeyChooser::slotCustomKey ( )

protectedslot

Definition at line 575 of file kkeydialog.cpp.

◆ slotDefaultKey

void KKeyChooser::slotDefaultKey ( )

protectedslot

Definition at line 567 of file kkeydialog.cpp.

◆ slotListItemDoubleClicked

void KKeyChooser::slotListItemDoubleClicked	(	TQListViewItem *	ipoQListViewItem,
		const TQPoint &	ipoQPoint,
		int	c
	)

protectedslot

Definition at line 635 of file kkeydialog.cpp.

◆ slotListItemSelected

void KKeyChooser::slotListItemSelected ( TQListViewItem * item )

protectedslot

Definition at line 630 of file kkeydialog.cpp.

◆ slotNoKey

void KKeyChooser::slotNoKey ( )

protectedslot

Definition at line 555 of file kkeydialog.cpp.

◆ slotSettingsChanged

void KKeyChooser::slotSettingsChanged ( int category )

protectedslot

Definition at line 596 of file kkeydialog.cpp.

◆ syncToConfig()

void KKeyChooser::syncToConfig	(	const TQString &	sConfigGroup,
		TDEConfigBase *	pConfig,
		bool	bClearUnset
	)

Definition at line 678 of file kkeydialog.cpp.

◆ updateButtons()

void KKeyChooser::updateButtons ( )

protected

Definition at line 508 of file kkeydialog.cpp.

◆ virtual_hook()

void KKeyChooser::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

Definition at line 1203 of file kkeydialog.cpp.

Friends And Related Function Documentation

◆ KKeyDialog

friend class KKeyDialog

friend

Definition at line 254 of file kkeydialog.h.

Member Data Documentation

◆ m_bAllowLetterShortcuts

bool KKeyChooser::m_bAllowLetterShortcuts

protected

Definition at line 197 of file kkeydialog.h.

◆ m_bAllowWinKey

bool KKeyChooser::m_bAllowWinKey

protected

Definition at line 198 of file kkeydialog.h.

◆ m_bPreferFourModifierKeys

bool KKeyChooser::m_bPreferFourModifierKeys

protected

Definition at line 201 of file kkeydialog.h.

◆ m_prbCustom

TQRadioButton* KKeyChooser::m_prbCustom

protected

Definition at line 205 of file kkeydialog.h.

◆ m_prbDef

TQRadioButton* KKeyChooser::m_prbDef

protected

Definition at line 204 of file kkeydialog.h.

◆ m_prbNone

TQRadioButton* KKeyChooser::m_prbNone

protected

Definition at line 203 of file kkeydialog.h.

◆ m_type

ActionType KKeyChooser::m_type

protected

Definition at line 196 of file kkeydialog.h.

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

tdeui

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ ActionType

Constructor & Destructor Documentation

◆ KKeyChooser() [1/7]

◆ KKeyChooser() [2/7]

◆ KKeyChooser() [3/7]

◆ KKeyChooser() [4/7]

◆ KKeyChooser() [5/7]

◆ ~KKeyChooser()

◆ KKeyChooser() [6/7]

◆ KKeyChooser() [7/7]

Member Function Documentation

◆ _warning()

◆ allDefault

◆ buildListView()

◆ capturedShortcut

◆ checkGlobalShortcutsConflict()

◆ checkStandardShortcutsConflict()

◆ commitChanges()

◆ fontChange()

◆ initGUI()

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

◆ isKeyPresent()

◆ isKeyPresentLocally()

◆ keyChange

◆ listSync

◆ readGlobalKeys()

◆ save()

◆ setPreferFourModifierKeys

◆ setShortcut()

◆ slotCustomKey

◆ slotDefaultKey

◆ slotListItemDoubleClicked

◆ slotListItemSelected

◆ slotNoKey

◆ slotSettingsChanged

◆ syncToConfig()

◆ updateButtons()

◆ virtual_hook()

Friends And Related Function Documentation

◆ KKeyDialog

Member Data Documentation

◆ m_bAllowLetterShortcuts

◆ m_bAllowWinKey

◆ m_bPreferFourModifierKeys

◆ m_prbCustom

◆ m_prbDef

◆ m_prbNone

◆ m_type

tdeui

tdeui