Konsole::KeyboardTranslatorManager

Search for usage in LXR

Konsole::KeyboardTranslatorManager Class Reference

#include <KeyboardTranslator.h>

Public Member Functions

 KeyboardTranslatorManager ()
 
 KeyboardTranslatorManager (const KeyboardTranslatorManager &)=delete
 
void addTranslator (KeyboardTranslator *translator)
 
QList< QStringallTranslators ()
 
const KeyboardTranslatordefaultTranslator ()
 
bool deleteTranslator (const QString &name)
 
const KeyboardTranslatorfindTranslator (const QString &name)
 
KeyboardTranslatorManageroperator= (const KeyboardTranslatorManager &)=delete
 

Static Public Member Functions

static KeyboardTranslatorManagerinstance ()
 

Detailed Description

Manages the keyboard translations available for use by terminal sessions, see KeyboardTranslator.

Definition at line 431 of file KeyboardTranslator.h.

Constructor & Destructor Documentation

◆ KeyboardTranslatorManager()

KeyboardTranslatorManager::KeyboardTranslatorManager ( )

Constructs a new KeyboardTranslatorManager and loads the list of available keyboard translations.

The keyboard translations themselves are not loaded until they are first requested via a call to findTranslator()

Definition at line 56 of file KeyboardTranslator.cpp.

◆ ~KeyboardTranslatorManager()

KeyboardTranslatorManager::~KeyboardTranslatorManager ( )

Definition at line 61 of file KeyboardTranslator.cpp.

Member Function Documentation

◆ addTranslator()

void KeyboardTranslatorManager::addTranslator ( KeyboardTranslator * translator)

Adds a new translator.

If a translator with the same name already exists, it will be replaced by the new translator.

TODO: More documentation.

Definition at line 851 of file KeyboardTranslator.cpp.

◆ allTranslators()

QList< QString > KeyboardTranslatorManager::allTranslators ( )

Returns a list of the names of available keyboard translators.

The first time this is called, a search for available translators is started.

Definition at line 553 of file KeyboardTranslator.cpp.

◆ defaultTranslator()

const KeyboardTranslator * KeyboardTranslatorManager::defaultTranslator ( )

Returns the default translator for Konsole.

Definition at line 161 of file KeyboardTranslator.cpp.

◆ deleteTranslator()

bool KeyboardTranslatorManager::deleteTranslator ( const QString & name)

Deletes a translator.

Returns true on successful deletion or false otherwise.

TODO: More documentation

Definition at line 858 of file KeyboardTranslator.cpp.

◆ findTranslator()

const KeyboardTranslator * KeyboardTranslatorManager::findTranslator ( const QString & name)

Returns the keyboard translator with the given name or 0 if no translator with that name exists.

The first time that a translator with a particular name is requested, the on-disk .keyboard file is loaded and parsed.

Definition at line 99 of file KeyboardTranslator.cpp.

◆ instance()

KeyboardTranslatorManager * KeyboardTranslatorManager::instance ( )
static

Returns the global KeyboardTranslatorManager instance.

Definition at line 873 of file KeyboardTranslator.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:04:23 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.