#include <tdeshortcut.h>

Public Types
enum	{ MAX_SEQUENCES = 2 }

Public Member Functions
	TDEShortcut ()

	TDEShortcut (int keyQt)

	TDEShortcut (const TQKeySequence &keySeq)

	TDEShortcut (const KKey &key)

	TDEShortcut (const KKeySequence &keySeq)

	TDEShortcut (const TDEShortcut &shortcut)

	TDEShortcut (const char *shortcut)

	TDEShortcut (const TQString &shortcut)

void	clear ()

bool	init (int keyQt)

bool	init (const TQKeySequence &keySeq)

bool	init (const KKey &key)

bool	init (const KKeySequence &keySeq)

bool	init (const TDEShortcut &shortcut)

bool	init (const TQString &shortcut)

TDEShortcut &	operator= (const TDEShortcut &cut)

uint	count () const

const KKeySequence &	seq (uint i) const

int	keyCodeQt () const

bool	isNull () const

int	compare (const TDEShortcut &shortcut) const

bool	operator== (const TDEShortcut &cut) const

bool	operator!= (const TDEShortcut &cut) const

bool	operator< (const TDEShortcut &cut) const

bool	contains (const KKey &key) const

bool	contains (const KKeyNative &key) const

bool	contains (const KKeySequence &keySeq) const

bool	setSeq (uint i, const KKeySequence &keySeq)

bool	append (const KKeySequence &keySeq)

void	remove (const KKeySequence &keySeq)

bool	append (const KKey &spec)

bool	append (const TDEShortcut &cut)

	operator TQKeySequence () const

TQString	toString () const

TQString	toStringInternal (const TDEShortcut *pcutDefault=0) const

	operator int () const

Static Public Member Functions
static TDEShortcut &	null ()

Protected Attributes
uint	m_nSeqs

KKeySequence	m_rgseq [MAX_SEQUENCES]

Friends
class	KKeyNative

Detailed Description

The TDEShortcut class is used to represent a keyboard shortcut to an action.

A shortcut is normally a single key with modifiers, such as Ctrl+V. A TDEShortcut object may also contain an alternate key which will also activate the action it's associated to, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a TDEAction. For example, the below code binds the escape key to the close action.

TDEAction *closeAction = KStdAction::close( this, TQ_SLOT( close() ), actionCollection() );
TDEShortcut closeShortcut = closeAction->shortcut();
closeShortcut.append( KKey(Key_Escape));
closeAction->setShortcut(closeShortcut);

Note that a shortcut cannot have more than 2 key combinations associated with it, so the above code would not do anything (and append() would return false) if the closeAction already had an key and alternate key.

Definition at line 543 of file tdeshortcut.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The maximum number of key sequences that can be contained in a TDEShortcut.

Definition at line 550 of file tdeshortcut.h.

Constructor & Destructor Documentation

◆ TDEShortcut() [1/8]

TDEShortcut::TDEShortcut ( )

Creates a new null shortcut.

See also: null(); isNull(); clear()

Definition at line 403 of file tdeshortcut.cpp.

◆ TDEShortcut() [2/8]

TDEShortcut::TDEShortcut ( int keyQt )

Creates a new shortcut with the given Qt key code as the only key sequence.

Parameters

keyQt the qt keycode

See also: TQt::Key

Definition at line 404 of file tdeshortcut.cpp.

◆ TDEShortcut() [3/8]

TDEShortcut::TDEShortcut ( const TQKeySequence & keySeq )

Creates a new shortcut that contains only the given qt key sequence.

Parameters

keySeq the qt key sequence to add

Definition at line 405 of file tdeshortcut.cpp.

◆ TDEShortcut() [4/8]

TDEShortcut::TDEShortcut ( const KKey & key )

Creates a new shortcut that contains only the given key in its only sequence.

Parameters

key	the key to add

Definition at line 406 of file tdeshortcut.cpp.

◆ TDEShortcut() [5/8]

TDEShortcut::TDEShortcut ( const KKeySequence & keySeq )

Creates a new shortcut that contains only the given key sequence.

Parameters

keySeq the key sequence to add

Definition at line 407 of file tdeshortcut.cpp.

◆ TDEShortcut() [6/8]

TDEShortcut::TDEShortcut ( const TDEShortcut & shortcut )

Copies the given shortcut.

Parameters

shortcut the shortcut to add

Definition at line 408 of file tdeshortcut.cpp.

◆ TDEShortcut() [7/8]

TDEShortcut::TDEShortcut ( const char * shortcut )

Creates a new key sequence that contains the given key sequence.

The description consists of semicolon-separated keys as used in KKeySequence::KKeySequence(const TQString&).

Parameters

shortcut the description of the key

See also: KKeySequence::KKeySequence(const TQString&)

Definition at line 409 of file tdeshortcut.cpp.

◆ TDEShortcut() [8/8]

TDEShortcut::TDEShortcut ( const TQString & shortcut )

Creates a new key sequence that contains the given key sequence.

The description consists of semicolon-separated keys as used in KKeySequence::KKeySequence(const TQString&).

Parameters

shortcut the description of the key

See also: KKeySequence::KKeySequence(const TQString&)

Definition at line 410 of file tdeshortcut.cpp.

Member Function Documentation

◆ append() [1/3]

bool TDEShortcut::append ( const KKey & spec )

Appends the given key.

Parameters

spec	the key to add

Returns: true if successful, false otherwise

See also: setSeq(); MAX_SEQUENCES

Since: 3.2

Definition at line 599 of file tdeshortcut.cpp.

◆ append() [2/3]

bool TDEShortcut::append ( const KKeySequence & keySeq )

Appends the given key sequence.

This sets it as either the keysequence or the alternate keysequence. If the shortcut already has MAX_SEQUENCES sequences then this call does nothing, and returns false.

Parameters

keySeq the key sequence to add

Returns: true if successful, false otherwise

See also: setSeq()

Definition at line 587 of file tdeshortcut.cpp.

◆ append() [3/3]

bool TDEShortcut::append ( const TDEShortcut & cut )

Appends the sequences from the given shortcut.

Parameters

cut	the shortcut to append

Returns: true if successful, false otherwise

See also: MAX_SEQUENCES

Since: 3.2

Definition at line 609 of file tdeshortcut.cpp.

◆ clear()

void TDEShortcut::clear ( )

Clears the shortcut.

The shortcut is null after calling this function.

See also: isNull()

Definition at line 416 of file tdeshortcut.cpp.

◆ compare()

int TDEShortcut::compare ( const TDEShortcut & shortcut ) const

Compares this object with the given shortcut.

Returns a negative number if the given shortcut is larger, 0 if they are equal and a positive number this shortcut is larger. Shortcuts are compared by comparing the individual key sequences, starting from the beginning until an unequal key sequences has been found. If a shortcut contains more key sequences, it is considered larger.

Parameters

shortcut the shortcut to compare to

Returns: a negative number if the given TDEShortcut is larger, 0 if they are equal and a positive number this TDEShortcut is larger

See also: KKey::compare(); KKeyShortcut::compare()

Definition at line 522 of file tdeshortcut.cpp.

◆ contains() [1/3]

bool TDEShortcut::contains ( const KKey & key ) const

Checks whether this shortcut contains a sequence that starts with the given key.

Parameters

key	the key to check

Returns: true if a key sequence starts with the key

Definition at line 532 of file tdeshortcut.cpp.

◆ contains() [2/3]

bool TDEShortcut::contains ( const KKeyNative & key ) const

Checks whether this shortcut contains a sequence that starts with the given key.

Parameters

key	the key to check

Returns: true if a key sequence starts with the key

Definition at line 537 of file tdeshortcut.cpp.

◆ contains() [3/3]

bool TDEShortcut::contains ( const KKeySequence & keySeq ) const

Checks whether this shortcut contains the given sequence.

Parameters

keySeq the key sequence to check

Returns: true if the shortcut has the given key sequence

Definition at line 551 of file tdeshortcut.cpp.

◆ count()

uint TDEShortcut::count ( ) const

Returns the number of sequences that are in this shortcut.

Returns: the number of sequences MAX_SEQUENCES

Definition at line 500 of file tdeshortcut.cpp.

◆ init() [1/6]

bool TDEShortcut::init ( const KKey & key )

Initializes the shortcut with the given key as its only sequence.

Parameters

key	the key to add

Definition at line 440 of file tdeshortcut.cpp.

◆ init() [2/6]

bool TDEShortcut::init ( const KKeySequence & keySeq )

Initializes the shortcut with the given qt key sequence.

Parameters

keySeq the qt key sequence to add

Definition at line 447 of file tdeshortcut.cpp.

◆ init() [3/6]

bool TDEShortcut::init ( const TDEShortcut & shortcut )

Copies the given shortcut.

Parameters

shortcut the shortcut to add

Definition at line 454 of file tdeshortcut.cpp.

◆ init() [4/6]

bool TDEShortcut::init ( const TQKeySequence & keySeq )

Initializes the shortcut with the given qt key sequence.

Parameters

keySeq the qt key sequence to add

Definition at line 433 of file tdeshortcut.cpp.

◆ init() [5/6]

bool TDEShortcut::init ( const TQString & shortcut )

Initializes the key sequence with the given key sequence.

The description consists of semicolon-separated keys as used in KKeySequence::KKeySequence(const TQString&).

Parameters

shortcut the description of the key

See also: KKeySequence::KKeySequence(const TQString&)

Definition at line 462 of file tdeshortcut.cpp.

◆ init() [6/6]

bool TDEShortcut::init ( int keyQt )

Initializes the shortcut with the given Qt key code as the only key sequence.

Parameters

keyQt the qt keycode

See also: TQt::Key

Definition at line 421 of file tdeshortcut.cpp.

◆ isNull()

bool TDEShortcut::isNull ( ) const

Returns true if the shortcut is null (after clear() or empty constructor).

Returns: true if the shortcut is null

See also: clear(); null()

Definition at line 517 of file tdeshortcut.cpp.

◆ keyCodeQt()

int TDEShortcut::keyCodeQt ( ) const

Returns the key code of the first key sequence, or null if there is no first key sequence.

Returns: the key code of the first sequence's first key

See also: TQt::Key; KKeySequence::keyCodeQt()

Definition at line 510 of file tdeshortcut.cpp.

◆ null()

TDEShortcut & TDEShortcut::null ( )

static

Returns a null shortcut.

Returns: the null shortcut

See also: isNull(); clear()

Definition at line 667 of file tdeshortcut.cpp.

◆ operator TQKeySequence()

TDEShortcut::operator TQKeySequence ( ) const

Converts this shortcut to a key sequence.

The first key sequence will be taken.

Definition at line 627 of file tdeshortcut.cpp.

◆ operator!=()

bool TDEShortcut::operator!= ( const TDEShortcut & cut ) const

inline

Compares the sequences of both shortcuts.

See also: compare()

Definition at line 729 of file tdeshortcut.h.

◆ operator<()

bool TDEShortcut::operator< ( const TDEShortcut & cut ) const

inline

Compares the sequences of both shortcuts.

See also: compare()

Definition at line 736 of file tdeshortcut.h.

◆ operator=()

TDEShortcut& TDEShortcut::operator= ( const TDEShortcut & cut )

inline

Copies the given shortcut over this shortcut.

Definition at line 665 of file tdeshortcut.h.

◆ operator==()

bool TDEShortcut::operator== ( const TDEShortcut & cut ) const

inline

Compares the sequences of both shortcuts.

See also: compare()

Definition at line 722 of file tdeshortcut.h.

◆ remove()

void TDEShortcut::remove ( const KKeySequence & keySeq )

Removes the given key sequence from this shortcut.

Parameters

keySeq the key sequence to remove

Since: 3.3

Definition at line 572 of file tdeshortcut.cpp.

◆ seq()

const KKeySequence & TDEShortcut::seq ( uint i ) const

Returns the i'th key sequence of this shortcut.

Parameters

i	the number of the key sequence to retrieve

Returns: the i'th sequence or KKeySequence::null() if there are less than i key sequences MAX_SEQUENCES

Definition at line 505 of file tdeshortcut.cpp.

◆ setSeq()

bool TDEShortcut::setSeq	(	uint	i,
		const KKeySequence &	keySeq
	)

Sets the i 'th key sequence of the shortcut.

You can not introduce gaps in the list of sequences, so you must use an i <= count(). Also note that the maximum number of key sequences is MAX_SEQUENCES.

Parameters

i	the position of the new key sequence(0 <= i <= count(), 0 <= i < MAX_SEQUENCES)
keySeq	the key sequence to set

Returns: true if successful, false otherwise

Definition at line 560 of file tdeshortcut.cpp.

◆ toString()

TQString TDEShortcut::toString ( ) const

Returns a description of the shortcut as semicolon-separated ket sequences, as returned by KKeySequence::toString().

Returns: the string represenation of this shortcut

See also: KKey::toString(); KKeySequence::toString()

Definition at line 635 of file tdeshortcut.cpp.

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

tdecore

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TDEShortcut() [1/8]

◆ TDEShortcut() [2/8]

◆ TDEShortcut() [3/8]

◆ TDEShortcut() [4/8]

◆ TDEShortcut() [5/8]

◆ TDEShortcut() [6/8]

◆ TDEShortcut() [7/8]

◆ TDEShortcut() [8/8]

Member Function Documentation

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ clear()

◆ compare()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ count()

◆ init() [1/6]

◆ init() [2/6]

◆ init() [3/6]

◆ init() [4/6]

◆ init() [5/6]

◆ init() [6/6]

◆ isNull()

◆ keyCodeQt()

◆ null()

◆ operator TQKeySequence()

◆ operator!=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ remove()

◆ seq()

◆ setSeq()

◆ toString()

tdecore

tdecore