mirror of
https://github.com/KDE/konsole.git
synced 2026-06-12 16:05:45 -04:00
110 lines
3.3 KiB
C++
110 lines
3.3 KiB
C++
/*
|
|
This source file is part of Konsole, a terminal emulator.
|
|
|
|
Copyright 2007-2008 by Robert Knight <robertknight@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef KEYBOARDTRANSLATOR_MANAGER_H
|
|
#define KEYBOARDTRANSLATOR_MANAGER_H
|
|
|
|
// Qt
|
|
#include <QtCore/QHash>
|
|
#include <QtCore/QStringList>
|
|
|
|
// Konsole
|
|
#include "konsole_export.h"
|
|
#include "KeyboardTranslator.h"
|
|
|
|
class QIODevice;
|
|
|
|
namespace Konsole
|
|
{
|
|
/**
|
|
* Manages the keyboard translations available for use by terminal sessions,
|
|
* see KeyboardTranslator.
|
|
*/
|
|
class KeyboardTranslatorManager
|
|
{
|
|
public:
|
|
/**
|
|
* 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()
|
|
*/
|
|
KeyboardTranslatorManager();
|
|
~KeyboardTranslatorManager();
|
|
|
|
/**
|
|
* Adds a new translator. If a translator with the same name
|
|
* already exists, it will be replaced by the new translator.
|
|
*
|
|
* TODO: More documentation.
|
|
*/
|
|
void addTranslator(KeyboardTranslator* translator);
|
|
|
|
/**
|
|
* Deletes a translator. Returns true on successful deletion or false otherwise.
|
|
*
|
|
* TODO: More documentation
|
|
*/
|
|
bool deleteTranslator(const QString& name);
|
|
|
|
/** Returns the default translator for Konsole. */
|
|
const KeyboardTranslator* defaultTranslator();
|
|
|
|
/**
|
|
* 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 .keytab file is loaded and parsed.
|
|
*/
|
|
const KeyboardTranslator* findTranslator(const QString& name);
|
|
/**
|
|
* Returns a list of the names of available keyboard translators.
|
|
*
|
|
* The first time this is called, a search for available
|
|
* translators is started.
|
|
*/
|
|
QStringList allTranslators();
|
|
|
|
/** Returns the global KeyboardTranslatorManager instance. */
|
|
static KeyboardTranslatorManager* instance();
|
|
|
|
private:
|
|
void findTranslators(); // locate all available translators
|
|
|
|
// loads the translator with the given name
|
|
KeyboardTranslator* loadTranslator(const QString& name);
|
|
KeyboardTranslator* loadTranslator(QIODevice* device, const QString& name);
|
|
|
|
bool saveTranslator(const KeyboardTranslator* translator);
|
|
QString findTranslatorPath(const QString& name);
|
|
|
|
bool _haveLoadedAll;
|
|
|
|
const KeyboardTranslator* _fallbackTranslator;
|
|
QHash<QString, KeyboardTranslator*> _translators;
|
|
};
|
|
}
|
|
|
|
#endif // KEYBOARDTRANSLATOR_MANAGER_H
|
|
|