class KAccelAction

Public Methods

•  KAccelAction ()
•  KAccelAction ( const KAccelAction& )
•  KAccelAction ( const QString& sName, const QString& sLabel, const QString& sWhatsThis, const KShortcut& cutDef3, const KShortcut& cutDef4, const QObject* pObjSlot, const char* psMethodSlot, bool bConfigurable, bool bEnabled )
•  ~KAccelAction ()
• void  clear ()
• bool  init ( const QString& sName, const QString& sLabel, const QString& sWhatsThis, const KShortcut& cutDef3, const KShortcut& cutDef4, const QObject* pObjSlot, const char* psMethodSlot, bool bConfigurable, bool bEnabled )
• KAccelAction&  operator= ( const KAccelAction& )
• const QString&  name () const
• const QString&  label () const
• const QString&  whatsThis () const
• const KShortcut&  shortcut () const
• const KShortcut&  shortcutDefault () const
• const KShortcut&  shortcutDefault3 () const
• const KShortcut&  shortcutDefault4 () const
• const QObject*  objSlotPtr () const
• const char*  methodSlotPtr () const
• bool  isConfigurable () const
• bool  isEnabled () const
• void  setName ( const QString& name )
• void  setLabel ( const QString& label )
• void  setWhatsThis ( const QString& whatsThis )
• bool  setShortcut ( const KShortcut& rgCuts )
• void  setSlot ( const QObject* pObjSlot, const char* psMethodSlot )
• void  setConfigurable ( bool configurable )
• void  setEnabled ( bool enable )
• int  getID () const
• void  setID ( int n )
• bool  isConnected () const
• bool  setKeySequence ( uint i, const KKeySequence &keySeq )
• void  clearShortcut ()
• bool  contains ( const KKeySequence &keySeq )
• QString  toString () const
• QString  toStringInternal () const

Public Static Methods

• static bool  useFourModifierKeys ()
• static void  useFourModifierKeys ( bool use )

Protected Methods

• void  incConnections ()
• void  decConnections ()

Protected Members

• QString m_sName
• QString m_sLabel
• QString m_sWhatsThis
• KShortcut m_cut
• KShortcut m_cutDefault3
• KShortcut m_cutDefault4
• const QObject* m_pObjSlot
• const char* m_psMethodSlot
• bool m_bConfigurable
• bool m_bEnabled
• int m_nIDAccel
• uint m_nConnections

Detailed Description

A KAccelAction prepresents an action that can be executed using an accelerator key. Each KAccelAction has a name, a label, a "What's this" string and a KShortcut. The user can configure and enable/disable them using KKeyDialog.

	1) KAccelAction = "Run Command"
		Default3 = "Alt+F2"
		Default4 = "Meta+Enter;Alt+F2"
		1) KShortcut = "Meta+Enter"
			1) KKeySequence = "Meta+Enter"
				1) KKey = "Meta+Enter"
					1) Meta+Enter
					2) Meta+Keypad_Enter
		2) KShortcut = "Alt+F2"
			1) KKeySequence = "Alt+F2"
				1) Alt+F2
	2) KAccelAction = "Something"
		Default3 = ""
		Default4 = ""
		1) KShortcut = "Meta+X,Asterisk"
			1) KKeySequence = "Meta+X,Asterisk"
				1) KKey = "Meta+X"
					1) Meta+X
				2) KKey = "Asterisk"
					1) Shift+8 (English layout)
					2) Keypad_Asterisk

See also: KAccel, KGlobalAccel, KKeyChooser, KKeyDialog

Creates an empty KAccelAction.

See also: clear()

Copy constructor.

Creates a new KAccelAction.

Parameters:

sName	the name of the accelerator
sLabel	the label of the accelerator (i18n!)
sWhatsThis	the What's This text (18n!)
cutDef3	the default shortcut for 3 modifier systems
cutDef4	the default shortcut for 4 modifier systems
pObjSlot	the receiver of a signal when the key has been pressed
psMethodSlot	the slot to connect for key presses. Receives an int, as set by setID(), as only argument
bConfigurable	if true the user can configure the shortcut
bEnabled	true if the accelerator should be enabled

Clears the accelerator.

Re-initialized the KAccelAction.

Parameters:

sName	the name of the accelerator
sLabel	the label of the accelerator (i18n!)
sWhatsThis	the What's This text (18n!)
cutDef3	the default shortcut for 3 modifier systems
cutDef4	the default shortcut for 4 modifier systems
pObjSlot	the receiver of a signal when the key has been pressed
psMethodSlot	the slot to connect for key presses. Receives an int, as set by setID(), as only argument
bConfigurable	if true the user can configure the shortcut
bEnabled	true if the accelerator should be enabled

Returns: true if successful, false otherwise

Copies this KAccelAction.

[const]

Returns the name of the accelerator action.

Returns: the name of the accelerator action, can be null if not set

[const]

Returns the label of the accelerator action.

Returns: the label of the accelerator action, can be null if not set

[const]

Returns the What's This text of the accelerator action.

Returns: the What's This text of the accelerator action, can be null if not set

[const]

The shortcut that is actually used (may be used configured).

Returns: the shortcut of the KAccelAction, can be null if not set

See also: shortcutDefault()

[const]

The default shortcut for this system.

Returns: the default shortcut on this system, can be null if not set

See also: shortcut(), shortcutDefault3(), shortcutDefault4()

[const]

The default shortcut for 3 modifier systems.

Returns: the default shortcut for 3 modifier systems, can be null if not set

See also: shortcutDefault(), shortcutDefault4(), useFourModifierKeys()

[const]

The default shortcut for 4 modifier systems.

Returns: the default shortcut for 4 modifier systems, can be null if not set

See also: shortcutDefault(), shortcutDefault3(), useFourModifierKeys()

[const]

Returns the receiver of signals.

Returns: the receiver of signals (can be 0 if not set)

[const]

Returns the slot for the signal.

Returns: the slot for the signal

[const]

Checks whether the user can configure the action.

Returns: true if configurable, false otherwise

[const]

Checks whether the action is enabled.

Returns: true if enabled, false otherwise

Sets the name of the accelerator action.

Parameters:

name	the new name

Sets the user-readable label of the accelerator action.

Parameters:

label

the new label (i18n!)

Sets the What's This text for the accelerator action.

Parameters:

whatsThis

the new What's This text (i18n!)

Sets the new shortcut of the accelerator action.

Parameters:

rgCuts

the shortcut to set

Returns: true if successful, false otherwise

Sets the slot of the accelerator action.

Parameters:

pObjSlot	the receiver object of the signal
psMethodSlot	the slot for the signal

Enables or disabled configuring the action.

Parameters:

configurable

true to enable configurability, false to disable

Enables or disabled the action.

Parameters:

configurable

true to enable the action, false to disable

[const]

Retrieves the id set using setID.

Returns: the id of the accelerator action

Allows you to set an id that will be used as the action signal's argument.

Parameters:

n	the new id

See also: @ref, getID()

[const]

Checkes whether the action is connected (emits signals).

Returns: true if connected, false otherwise

Sets a key sequence of the action's shortcut.

Parameters:

i	the position of the sequence
keySeq	the new new sequence

Returns: true if successful, false otherwise

See also: KShortcut::setSeq()

Clears the action's shortcut. It will not contain any sequences after calling this method.

See also: KShortcut::clear()

Checks whether the action's shortcut contains the given key sequence.

Parameters:

keySeq

the key sequence to check

Returns: true if the shortcut contains the given sequence

See also: KShortcut::contains()

[const]

Returns the string representation of the action's shortcut.

Returns: the string representation of the action's shortcut.

See also: KShortcut::toString()

[const]

[static]

Returns true if four modifier keys will be used.

Returns: true if four modifier keys will be used.

[static]

Selects 3 or 4 modifier default shortcuts.

Parameters:

use	true to use 4 modifier shortcuts, false to use 3 modifier shortcuts

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]