A convertor which maps between key sequences pressed by the user and the character strings which should be sent to the terminal and commands which should be invoked when those character sequences are pressed. More...

#include "KeyboardTranslator.h"

Collaboration diagram for KeyboardTranslator:

[legend]

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

Public Types
enum	Command { NoCommand = 0, SendCommand = 1, ScrollPageUpCommand = 2, ScrollPageDownCommand = 4, ScrollLineUpCommand = 8, ScrollLineDownCommand = 16, ScrollLockCommand = 32, EraseCommand = 64 }
	This enum describes commands which are associated with particular key sequences. More...
enum	State { NoState = 0, NewLineState = 1, AnsiState = 2, CursorKeysState = 4, AlternateScreenState = 8, AnyModifierState = 16 }
	The meaning of a particular key sequence may depend upon the state which the terminal emulation is in. More...

Public Member Functions
	KeyboardTranslator (const QString &name)
	Constructs a new keyboard translator with the given `name`.
void	addEntry (const Entry &entry)
	Adds an entry to this keyboard translator's table.
QString	description () const
	Returns the descriptive name of this keyboard translator.
QList< Entry >	entries () const
	Returns a list of all entries in the translator.
Entry	findEntry (int keyCode, Qt::KeyboardModifiers modifiers, States state=NoState) const
	Looks for an entry in this keyboard translator which matches the given key code, keyboard modifiers and state flags.
QString	name () const
	Returns the name of this keyboard translator.
void	removeEntry (const Entry &entry)
	Removes an entry from the table.
void	replaceEntry (const Entry &existing, const Entry &replacement)
	Replaces an entry in the translator.
void	setDescription (const QString &description)
	Sets the descriptive name of this keyboard translator.
void	setName (const QString &name)
	Sets the name of this keyboard translator.

Private Attributes
QString	_description
QHash< int, Entry >	_entries
QString	_name

Detailed Description

A convertor which maps between key sequences pressed by the user and the character strings which should be sent to the terminal and commands which should be invoked when those character sequences are pressed.

Konsole supports multiple keyboard translators, allowing the user to specify the character sequences which are sent to the terminal when particular key sequences are pressed.

A key sequence is defined as a key code, associated keyboard modifiers (Shift,Ctrl,Alt,Meta etc.) and state flags which indicate the state which the terminal must be in for the key sequence to apply.

Definition at line 126 of file KeyboardTranslator.h.

Member Enumeration Documentation

enum KeyboardTranslator::Command

This enum describes commands which are associated with particular key sequences.

Enumerator:

NoCommand	Indicates that no command is associated with this command sequence.
SendCommand	TODO Document me.
ScrollPageUpCommand	Scroll the terminal display up one page.
ScrollPageDownCommand	Scroll the terminal display down one page.
ScrollLineUpCommand	Scroll the terminal display up one line.
ScrollLineDownCommand	Scroll the terminal display down one line.
ScrollLockCommand	Toggles scroll lock mode.
EraseCommand	Echos the operating system specific erase character.

Definition at line 167 of file KeyboardTranslator.h.

enum KeyboardTranslator::State

The meaning of a particular key sequence may depend upon the state which the terminal emulation is in.

Therefore findEntry() may return a different Entry depending upon the state flags supplied.

This enum describes the states which may be associated with with a particular entry in the keyboard translation entry.

Enumerator:

NoState	Indicates that no special state is active.
NewLineState	TODO More documentation.
AnsiState	Indicates that the terminal is in 'Ansi' mode. TODO: More documentation
CursorKeysState	TODO More documentation.
AlternateScreenState	Indicates that the alternate screen ( typically used by interactive programs such as screen or vim ) is active.
AnyModifierState	Indicates that any of the modifier keys is active.