Key Class Reference

The Key class is used for the keys on the on screen keyboard. More...

#include "framework/keyboard/internal/Key.h"

Public Member Functions
	Key ()
	Key (QString text, QString shiftText)
QString	text (void)
void	setText (QString text)
QString	shiftText (void)
void	setShiftText (QString text)
KeyboardUtils::KeyType	type (void)
void	setType (KeyboardUtils::KeyType type)
QString	displayText (void)
void	setDisplayText (QString text)
QString	displayShiftText (void)
void	setDisplayShiftText (QString text)
bool	dead (void)
bool	isDead (void)
void	setDead (bool dead)
bool	shiftDead (void)
bool	isShiftDead (void)
void	setShiftDead (bool dead)

Properties
QString	text
QString	shiftText
KeyboardUtils::KeyType	type
QString	displayText
QString	displayShiftText
bool	dead
bool	shiftDead

Private Attributes
QString	m_text
QString	m_shiftText
KeyboardUtils::KeyType	m_type = KeyboardUtils::KeyType_Any
QString	m_displayText
QString	m_displayShiftText
bool	m_dead = false
bool	m_shiftDead = false

Detailed Description

The Key class is used for the keys on the on screen keyboard.

Constructor & Destructor Documentation

Key() [1/2]

Key::Key ( )

explicit

Constructs Key.

Key() [2/2]

Key::Key	(	QString	text,
		QString	shiftText
	)

Constructs Key (with properties).

Member Function Documentation

isDead()

bool Key::isDead

(

void

)

True if this is a dead key.

Deprecated:

Use dead() instead.

isShiftDead()

bool Key::isShiftDead

(

void

)

True if this is a dead key when pressed with shift.

Deprecated:

Use shiftDead() instead.

Property Documentation

dead

bool Key::dead

readwrite

True if this is a dead key.

displayShiftText

QString Key::displayShiftText

readwrite

The text (for combination with the shift key) visible on the keyboard.

displayText

QString Key::displayText

readwrite

The text visible on the keyboard.

shiftDead

bool Key::shiftDead

readwrite

True if this is a dead key when pressed with shift.

shiftText

QString Key::shiftText

readwrite

The text for this key when pressed with shift.

text

QString Key::text

readwrite

The text for this key.

type

KeyboardUtils::KeyType Key::type

readwrite

The type of the key.

---

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

• src/framework/keyboard/internal/Key.h
• src/framework/keyboard/internal/Key.cpp