Parses the contents of a Keyboard Translator (.keytab) file and returns the entries found in it. More...

#include "KeyboardTranslator.h"

Collaboration diagram for KeyboardTranslatorReader:

[legend]

Classes
struct	Token

Public Member Functions
	KeyboardTranslatorReader (QIODevice *source)
	Constructs a new reader which parses the given `source`. More...

QString	description () const
	Returns the description text. More...

bool	hasNextEntry ()
	Returns true if there is another entry in the source stream. More...

KeyboardTranslator::Entry	nextEntry ()
	Returns the next entry found in the source stream. More...

bool	parseError ()
	Returns true if an error occurred whilst parsing the input or false if no error occurred. More...

Static Public Member Functions
static KeyboardTranslator::Entry	createEntry (const QString &condition, const QString &result)
	Parses a condition and result string for a translator entry and produces a keyboard translator entry. More...

Private Member Functions
bool	decodeSequence (const QString &, int &keyCode, Qt::KeyboardModifiers &modifiers, Qt::KeyboardModifiers &modifierMask, KeyboardTranslator::States &state, KeyboardTranslator::States &stateFlags)

void	readNext ()

QList< Token >	tokenize (const QString &)

Static Private Member Functions
static bool	parseAsCommand (const QString &text, KeyboardTranslator::Command &command)

static bool	parseAsKeyCode (const QString &item, int &keyCode)

static bool	parseAsModifier (const QString &item, Qt::KeyboardModifier &modifier)

static bool	parseAsStateFlag (const QString &item, KeyboardTranslator::State &state)

Private Attributes
QString	_description

bool	_hasNext

KeyboardTranslator::Entry	_nextEntry

QIODevice *	_source

Detailed Description

Parses the contents of a Keyboard Translator (.keytab) file and returns the entries found in it.

Usage example:

QFile source( "/path/to/keytab" );
source.open( QIODevice::ReadOnly );
 
KeyboardTranslator* translator = new KeyboardTranslator( "name-of-translator" );
 
KeyboardTranslatorReader reader(source);
while ( reader.hasNextEntry() )
    translator->addEntry(reader.nextEntry());
 
source.close();
 
if ( !reader.parseError() )
{
    // parsing succeeded, do something with the translator
}
else
{
    // parsing failed
}

Definition at line 424 of file KeyboardTranslator.h.

Constructor & Destructor Documentation

◆ KeyboardTranslatorReader()

KeyboardTranslatorReader::KeyboardTranslatorReader ( QIODevice * source )

Constructs a new reader which parses the given source.

Definition at line 236 of file KeyboardTranslator.cpp.

References _description, readNext(), KeyboardTranslatorReader::Token::TitleKeyword, and tokenize().

Member Function Documentation

◆ createEntry()

KeyboardTranslator::Entry KeyboardTranslatorReader::createEntry	(	const QString &	condition,
		const QString &	result
	)

static

Parses a condition and result string for a translator entry and produces a keyboard translator entry.

The condition and result strings are in the same format as in

Definition at line 467 of file KeyboardTranslator.cpp.

References hasNextEntry(), nextEntry(), and parseAsCommand().

◆ decodeSequence()

bool KeyboardTranslatorReader::decodeSequence	(	const QString &	text,
		int &	keyCode,
		Qt::KeyboardModifiers &	modifiers,
		Qt::KeyboardModifiers &	modifierMask,
		KeyboardTranslator::States &	state,
		KeyboardTranslator::States &	stateFlags
	)