• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::KeyboardTranslatorReader

Konsole::KeyboardTranslatorReader Class Reference

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

#include <KeyboardTranslator.h>

List of all members.


Public Member Functions

QString description () const
bool hasNextEntry ()
 KeyboardTranslatorReader (QIODevice *source)
KeyboardTranslator::Entry nextEntry ()
bool parseError ()

Static Public Member Functions

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

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 351 of file KeyboardTranslator.h.


Constructor & Destructor Documentation

KeyboardTranslatorReader::KeyboardTranslatorReader ( QIODevice *  source  ) 

Constructs a new reader which parses the given source.

Definition at line 216 of file KeyboardTranslator.cpp.


Member Function Documentation

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 449 of file KeyboardTranslator.cpp.

QString KeyboardTranslatorReader::description (  )  const

Returns the description text.

TODO: More documentation

Definition at line 441 of file KeyboardTranslator.cpp.

bool KeyboardTranslatorReader::hasNextEntry (  ) 

Returns true if there is another entry in the source stream.

Definition at line 445 of file KeyboardTranslator.cpp.

KeyboardTranslator::Entry KeyboardTranslatorReader::nextEntry (  ) 

Returns the next entry found in the source stream.

Definition at line 477 of file KeyboardTranslator.cpp.

bool KeyboardTranslatorReader::parseError (  ) 

Returns true if an error occurred whilst parsing the input or false if no error occurred.

Definition at line 484 of file KeyboardTranslator.cpp.


The documentation for this class was generated from the following files:
  • KeyboardTranslator.h
  • KeyboardTranslator.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal