Konsole::KeyboardTranslator::Entry Class Reference

#include <KeyboardTranslator.h>

Public Member Functions
	Entry ()
Command	command () const
QString	conditionToString () const
QByteArray	escapedText (bool expandWildCards=false, Qt::KeyboardModifiers modifiers=Qt::NoModifier) const
bool	isNull () const
int	keyCode () const
bool	matches (int keyCode, Qt::KeyboardModifiers modifiers, States flags) const
Qt::KeyboardModifiers	modifierMask () const
Qt::KeyboardModifiers	modifiers () const
bool	operator== (const Entry &rhs) const
QString	resultToString (bool expandWildCards=false, Qt::KeyboardModifiers modifiers=Qt::NoModifier) const
void	setCommand (Command aCommand)
void	setKeyCode (int aKeyCode)
void	setModifierMask (Qt::KeyboardModifiers modifiers)
void	setModifiers (Qt::KeyboardModifiers modifiers)
void	setState (States aState)
void	setStateMask (States aStateMask)
void	setText (const QByteArray &aText)
States	state () const
States	stateMask () const
QByteArray	text (bool expandWildCards=false, Qt::KeyboardModifiers keyboardModifiers=Qt::NoModifier) const

Detailed Description

Represents an association between a key sequence pressed by the user and the character sequence and commands associated with it for a particular KeyboardTranslator.

Definition at line 121 of file KeyboardTranslator.h.

Constructor & Destructor Documentation

KeyboardTranslator::Entry::Entry

(

)

Constructs a new entry for a keyboard translator.

Definition at line 401 of file KeyboardTranslator.cpp.

Member Function Documentation

KeyboardTranslator::Command Konsole::KeyboardTranslator::Entry::command ( ) const

inline

Returns the commands associated with this entry.

Definition at line 478 of file KeyboardTranslator.h.

QString KeyboardTranslator::Entry::conditionToString

(

)

const

Returns the key code and modifiers associated with this entry as a QKeySequence.

Returns this entry's conditions ( ie. its key code, modifier and state criteria ) as a string.

Definition at line 599 of file KeyboardTranslator.cpp.

QByteArray KeyboardTranslator::Entry::escapedText	(	bool	expandWildCards = false,
		Qt::KeyboardModifiers	modifiers = Qt::NoModifier
	)		const

Returns the character sequence associated with this entry, with any non-printable characters replaced with escape sequences.

eg. \E for Escape, \t for tab, \n for new line.

Parameters

expandWildCards	See text()
modifiers	See text()

Definition at line 451 of file KeyboardTranslator.cpp.

bool Konsole::KeyboardTranslator::Entry::isNull ( ) const

inline

Returns true if this entry is null.

This is true for newly constructed entries which have no properties set.

Definition at line 469 of file KeyboardTranslator.h.

int Konsole::KeyboardTranslator::Entry::keyCode ( ) const

inline

Returns the character code ( from the Qt::Key enum ) associated with this entry.

Definition at line 442 of file KeyboardTranslator.h.

bool KeyboardTranslator::Entry::matches	(	int	keyCode,
		Qt::KeyboardModifiers	modifiers,
		States	flags
	)		const

Returns true if this entry matches the given key sequence, specified as a combination of keyCode , modifiers and state.

Definition at line 422 of file KeyboardTranslator.cpp.

Qt::KeyboardModifiers Konsole::KeyboardTranslator::Entry::modifierMask ( ) const

inline

Returns the keyboard modifiers which are valid in this entry.

See modifiers()

Definition at line 464 of file KeyboardTranslator.h.

Qt::KeyboardModifiers Konsole::KeyboardTranslator::Entry::modifiers ( ) const

inline

Returns a bitwise-OR of the enabled keyboard modifiers associated with this entry.

If a modifier is set in modifierMask() but not in modifiers(), this means that the entry only matches when that modifier is NOT pressed.

If a modifier is not set in modifierMask() then the entry matches whether the modifier is pressed or not.

Definition at line 455 of file KeyboardTranslator.h.

bool KeyboardTranslator::Entry::operator==

(

const Entry &

rhs

)

const

Definition at line 411 of file KeyboardTranslator.cpp.

QString KeyboardTranslator::Entry::resultToString	(	bool	expandWildCards = false,
		Qt::KeyboardModifiers	modifiers = Qt::NoModifier
	)		const

Returns this entry's result ( ie.

its command or character sequence ) as a string.

Parameters

expandWildCards	See text()
modifiers	See text()

Definition at line 577 of file KeyboardTranslator.cpp.

void Konsole::KeyboardTranslator::Entry::setCommand ( Command  aCommand )

inline

Sets the command associated with this entry.

Definition at line 474 of file KeyboardTranslator.h.

void Konsole::KeyboardTranslator::Entry::setKeyCode ( int  aKeyCode )

inline

Sets the character code associated with this entry.

Definition at line 446 of file KeyboardTranslator.h.

void Konsole::KeyboardTranslator::Entry::setModifierMask ( Qt::KeyboardModifiers  modifiers )

inline

See modifierMask() and modifiers()

Definition at line 460 of file KeyboardTranslator.h.

void Konsole::KeyboardTranslator::Entry::setModifiers ( Qt::KeyboardModifiers  modifiers )

inline

See modifiers()

Definition at line 451 of file KeyboardTranslator.h.

void Konsole::KeyboardTranslator::Entry::setState ( States  aState )

inline

See state()

Definition at line 511 of file KeyboardTranslator.h.

void Konsole::KeyboardTranslator::Entry::setStateMask ( States  aStateMask )

inline

See stateMask()

Definition at line 520 of file KeyboardTranslator.h.

void Konsole::KeyboardTranslator::Entry::setText ( const QByteArray &  aText )

inline

Sets the character sequence associated with this entry.

Definition at line 483 of file KeyboardTranslator.h.

KeyboardTranslator::States Konsole::KeyboardTranslator::Entry::state ( ) const

inline

Returns a bitwise-OR of the enabled state flags associated with this entry.

If flag is set in stateMask() but not in state(), this means that the entry only matches when the terminal is NOT in that state.

If a state is not set in stateMask() then the entry matches whether the terminal is in that state or not.

Definition at line 515 of file KeyboardTranslator.h.

KeyboardTranslator::States Konsole::KeyboardTranslator::Entry::stateMask ( ) const

inline

Returns the state flags which are valid in this entry.

See state()

Definition at line 524 of file KeyboardTranslator.h.

QByteArray Konsole::KeyboardTranslator::Entry::text ( bool  expandWildCards = false, Qt::KeyboardModifiers  keyboardModifiers = Qt::NoModifier  ) const

inline

Returns the character sequence associated with this entry, optionally replacing wildcard '*' characters with numbers to indicate the keyboard modifiers being pressed.

TODO: The numbers used to replace '*' characters are taken from the Konsole/KDE 3 code. Document them.

Parameters

expandWildCards	Specifies whether wild cards (occurrences of the '*' character) in the entry should be replaced with a number to indicate the modifier keys being pressed.
keyboardModifiers	The keyboard modifiers being pressed.

Definition at line 491 of file KeyboardTranslator.h.

---

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

• KeyboardTranslator.h
• KeyboardTranslator.cpp