Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017 #ifndef MIMENGINEWORDSINTERFACE_H
00018 #define MIMENGINEWORDSINTERFACE_H
00019
00020 #include "mimenginetypes.h"
00021 #include <QString>
00022 #include <QtPlugin>
00023
00024 class QPoint;
00025 class QStringList;
00026
00035 class MImEngineWordsInterface
00036 {
00037 public:
00041 MImEngineWordsInterface();
00042
00046 virtual ~MImEngineWordsInterface();
00047
00052 virtual bool init() = 0;
00053
00060 virtual bool addDictionaryWord(const QString &word,
00061 MImEngine::DictionaryType) = 0;
00062
00069 virtual bool removeDictionaryWord(const QString &word,
00070 MImEngine::DictionaryType) = 0;
00071
00077 virtual bool disableDictionary(MImEngine::DictionaryType) = 0;
00078
00084 virtual bool enableDictionary(MImEngine::DictionaryType) = 0;
00085
00091 virtual bool removeDictionary(MImEngine::DictionaryType) = 0;
00092
00097 virtual void appendString(const QString &s) = 0;
00098
00103 virtual void appendCharacter(const QChar &c) = 0;
00104
00111 virtual void tapKeyboard(const QPoint &position, bool shift, QChar symbol) = 0;
00112
00121 virtual void reselectString(const QString &s) = 0;
00122
00132 virtual void setContext(const QString &s, int cursor) = 0;
00133
00137 virtual void disablePrediction() = 0;
00138
00144 virtual void enablePrediction() = 0;
00145
00151 virtual bool predictionEnabled() = 0;
00152
00156 virtual void disableCompletion() = 0;
00157
00161 virtual void enableCompletion() = 0;
00162
00167 virtual bool completionEnabled() = 0;
00168
00173 virtual void disableCorrection() = 0;
00174
00179 virtual void enableCorrection() = 0;
00180
00186 virtual bool correctionEnabled() = 0;
00187
00192 virtual void clearEngineBuffer() = 0;
00193
00198 virtual void saveAndClearEngineBuffer() { }
00199
00215 virtual QStringList candidates(unsigned int uStartIndex = 0, unsigned int uNum = 0) = 0;
00216
00221 virtual int totalCandidates() = 0;
00222
00233 virtual int matchedLength() = 0;
00234
00243 virtual QStringList matchedSyllables() = 0;
00244
00251 virtual int suggestedCandidateIndex() = 0;
00252
00256 virtual bool setSuggestedCandidateIndex(int index) { Q_UNUSED(index); return false; }
00257
00266 virtual void setExactWordPositionInList(MImEngine::ExactInListType setting) = 0;
00267
00274 virtual MImEngine::DictionaryType candidateSource(int index) = 0;
00275
00281 virtual QString language() = 0;
00282
00283
00290 virtual bool setLanguage(const QString &lang,
00291 MImEngine::LanguagePriority) = 0;
00292
00296 bool setKeyboardLayout(const QString &) { return false; }
00297
00301 QString keyboardLayout() { return QString(); }
00302
00308 virtual bool setKeyboardLayoutKeys(const QList<MImEngine::KeyboardLayoutKey> &keys) = 0;
00309
00315 virtual QList<MImEngine::KeyboardLayoutKey> keyboardLayoutKeys() = 0;
00316
00321 virtual bool exportAsNokiaDictionary(const QString &fileName) = 0;
00322
00327 virtual bool importNokiaUserDictionary(const QString &fileName) = 0;
00328
00334 virtual QString driver() = 0;
00335
00342 virtual void setMaximumErrors(int maxErrors) = 0;
00343
00350 virtual int maximumErrors() = 0;
00351
00358 virtual void setMaximumCandidates(int maxCandidates) = 0;
00359
00365 virtual int maximumCandidates() = 0;
00366
00375 virtual bool setScript(const QString &s) = 0;
00376
00381 virtual QString script() = 0;
00382
00396 virtual QString transliterate(const QString &targetScript, unsigned int index) = 0;
00397
00403 virtual QString error() = 0;
00404
00411 virtual void insertCharacters(const QString &text, int index = -1) = 0;
00412
00420 virtual void removeCharacters(int count = 1, int index = -1) = 0;
00421
00433 virtual void commitWord(int index = -1, bool ignoreNewWord = true) = 0;
00434 };
00435
00436 Q_DECLARE_INTERFACE(MImEngineWordsInterface,
00437 "com.nokia.Meego.MImEngineWordsInterface/0.1")
00438
00439
00440 #endif // MIMENGINEWORDSINTERFACE_H
00441