PtiDefs.h File Reference

Link against: ptiengine.lib


#include <e32keys.h>
#include "
PtiDefs.inl"

Go to the source code of this file.


Data Structures

class  TPtiAutoSubstBinding
 A convinience class for auto substitution related EPtiCommands. More...
class  TPtiLangName
 A structure for binding language name and language code. More...
class  MPtiCoreInfo
 An interface class for accessing core info attributes. More...
class  TPtiCoreInfo
class  TPtiNumericKeyBinding
struct  TRecognitionRangeTag

Defines

#define ELangNumeric   0x5000
 This is language code for 'numeric' language.
#define KPtiEngineChineseSeparator   0x0027

Typedefs

typedef TRecognitionRangeTag TRecognitionRange

Enumerations

enum  TPtiError {
  KErrNoActiveLanguage = KErrPtiEngineBase-1, KErrLanguageNotFound = KErrPtiEngineBase-2, KErrNoSuitableCore = KErrPtiEngineBase-3, KErrNotAllowed = KErrPtiEngineBase-4,
  KErrTooLongWord = KErrPtiEngineBase-5, KErrInvalidWord = KErrPtiEngineBase-6, KErrTooLongReading = KErrPtiEngineBase-7, KErrInvalidReading = KErrPtiEngineBase-8,
  KErrUserDic = KErrPtiEngineBase-9, KErrInternalCoreError = KErrPtiEngineBase-10, KErrLengthMismatch = KErrPtiEngineBase-11
}
enum  TPtiEngineInputMode {
  EPtiEngineInputModeNone = 0, EPtiEngineMultitapping, EPtiEnginePredictive, EPtiEngineWordCompletion,
  EPtiEngineNumeric, EPtiEngineQwerty, EPtiEnginePinyin, EPtiEngineStroke,
  EPtiEngineZhuyin, EPtiEngineHiraganaKanji, EPtiEngineHiraganaKanjiPredictive, EPtiEngineKatakana,
  EPtiEngineFullWidthKatakana, EPtiEngineFullWidthNumeric, EPtiEngineFullWidthAlphabet, EPtiEngineHiragana,
  EPtiEnginePinyinByPhrase, EPtiEngineZhuyinByPhrase, EPtiEngineZhuyinQwerty, EPtiEngineZhuyinPhraseQwerty,
  EPtiEnginePinyinQwerty, EPtiEnginePinyinPhraseQwerty, EPtiEngineStrokeQwerty, EPtiEngineNormalCangjieQwerty,
  EPtiEngineEasyCangjieQwerty, EPtiEngineAdvCangjieQwerty, EPtiEngineHiraganaKanjiQwerty, EPtiEngineHiraganaKanjiPredictiveQwerty,
  EPtiEngineKatakanaQwerty, EPtiEngineFullWidthKatakanaQwerty, EPtiEngineFullWidthNumericQwerty, EPtiEngineFullWidthAlphabetQwerty,
  EPtiEngineHiraganaQwerty, EPtiEnginePinyinVkb, EPtiEngineStrokeVkb, EPtiEngineZhuyinVkb,
  EPtiEngineStrokeByPhrase, EPtiEngineStrokePhraseQwerty, EPtiEngineHiraganaKanjiVkb, EPtiEngineHiraganaKanjiPredictiveVkb,
  EPtiEngineHiraganaKanjiHwr, EPtiEngineHiraganaKanjiPredictiveHwr, EPtiEngineKatakanaVkb, EPtiEngineFullWidthKatakanaVkb,
  EPtiEngineHiraganaVkb, EPtiEngineNormalCangjieVkb, EPtiEngineEasyCangjieVkb, EPtiEngineAdvCangjieVkb,
  EPtiEngineInputModeIndicPhoneticMultitap, EPtiEngineInputModeIndicPhoneticQwerty, EPtiEngineHiraganaKanjiVkbRomaji, EPtiEngineHiraganaKanjiPredictiveVkbRomaji,
  EPtiEngineQwertyPredictive, EPtiEngineHalfQwerty, EPtiEngineHalfQwertyPredictive, EPtiEngineInputModeQwertyPredictive,
  EPtiEngineInputModeZhuyinMiniQwertyFind, EPtiEnginePinyinPhraseHalfQwerty, EPtiEngineStrokePhraseHalfQwerty, EPtiEngineZhuyinPhraseHalfQwerty,
  EPtiEngineMaxInputModes = EPtiEngineZhuyinPhraseHalfQwerty
}
 Enumerations for all the possible input modes supported by PtiEngine. More...
enum  TPtiErrorCorrectionLevel { EPtiErrorCorrectionLevelOff = 0, EPtiErrorCorrectionLevelLow = 1, EPtiErrorCorrectionLevelHigh = 2 }
enum  TPtiKey {
  EPtiKeyNone = 0, EPtiKey1 = '1', EPtiKey2 = '2', EPtiKey3 = '3',
  EPtiKey4 = '4', EPtiKey5 = '5', EPtiKey6 = '6', EPtiKey7 = '7',
  EPtiKey8 = '8', EPtiKey9 = '9', EPtiKeyStar = '*', EPtiKey0 = '0',
  EPtiKeyHash = '#', EPtiKeyPunct = EPtiKey1, EPtiKeyABC = EPtiKey2, EPtiKeyDEF = EPtiKey3,
  EPtiKeyGHI = EPtiKey4, EPtiKeyJKL = EPtiKey5, EPtiKeyMNO = EPtiKey6, EPtiKeyPQRS = EPtiKey7,
  EPtiKeyTUV = EPtiKey8, EPtiKeyWXYZ = EPtiKey9, EPtiKeyQwerty1 = 0x31, EPtiKeyQwerty2 = 0x32,
  EPtiKeyQwerty3 = 0x33, EPtiKeyQwerty4 = 0x34, EPtiKeyQwerty5 = 0x35, EPtiKeyQwerty6 = 0x36,
  EPtiKeyQwerty7 = 0x37, EPtiKeyQwerty8 = 0x38, EPtiKeyQwerty9 = 0x39, EPtiKeyQwerty0 = 0x30,
  EPtiKeyQwertyPlus = 0x2b, EPtiKeyQwertyMinus = EStdKeyMinus, EPtiKeyQwertyComma = EStdKeyComma, EPtiKeyQwertySemicolon = EStdKeySemiColon,
  EPtiKeyQwertyFullstop = EStdKeyFullStop, EPtiKeyQwertyHash = EStdKeyHash, EPtiKeyQwertySlash = EStdKeyForwardSlash, EPtiKeyQwertyApostrophe = EStdKeySingleQuote,
  EPtiKeyQwertySpace = EStdKeySpace, EPtiKeyQwertyAtCharacter = EStdKeySquareBracketRight, EPtiKeyQwertyLeftShift = EStdKeyLeftShift, EPtiKeyQwertyA = 0x41,
  EPtiKeyQwertyB = 0x42, EPtiKeyQwertyC = 0x43, EPtiKeyQwertyD = 0x44, EPtiKeyQwertyE = 0x45,
  EPtiKeyQwertyF = 0x46, EPtiKeyQwertyG = 0x47, EPtiKeyQwertyH = 0x48, EPtiKeyQwertyI = 0x49,
  EPtiKeyQwertyJ = 0x4a, EPtiKeyQwertyK = 0x4b, EPtiKeyQwertyL = 0x4c, EPtiKeyQwertyM = 0x4d,
  EPtiKeyQwertyN = 0x4e, EPtiKeyQwertyO = 0x4f, EPtiKeyQwertyP = 0x50, EPtiKeyQwertyQ = 0x51,
  EPtiKeyQwertyR = 0x52, EPtiKeyQwertyS = 0x53, EPtiKeyQwertyT = 0x54, EPtiKeyQwertyU = 0x55,
  EPtiKeyQwertyV = 0x56, EPtiKeyQwertyW = 0x57, EPtiKeyQwertyX = 0x58, EPtiKeyQwertyY = 0x59,
  EPtiKeyQwertyZ = 0x5a, EPtiKeyQwertyChr = EStdKeyLeftFunc
}
 Key enumerations for conventional (ITU-T) and qwerty keyboards. More...
enum  TPtiEngineCapsBits {
  EWordCompletion = 0x01, EReordering = 0x02, ENextWordPrediction = 0x04, ESupportUserDictionaries = 0x08,
  ESupportSCTToneMarks = 0x10, ESupportCangjieInput = 0x20, EPreferedSpelling = 0x40, ESupportDualLanguage = 0x80,
  ESupportAutoSubstitution = 0x100
}
 Enumerations for PtiCore capabilities. More...
enum  TPtiTextCase {
  EPtiCaseLower = 0, EPtiCaseUpper, EPtiCaseChrLower, EPtiCaseChrUpper,
  EPtiCaseFnLower, EPtiCaseFnUpper
}
 Text case defintions. More...
enum  TPtiCharConversion {
  EPtiSimplifiedToComplex = 0x01, EPtiUcs2ToUtf8 = 0x02, EPtiUcs2ToBig5 = 0x04, EPtiUcs2ToGB = 0x08,
  EPtiUtf8ToUcs2 = 0x10, EPtiKo2ToWc = 0x20, EPtiWcToKo2 = 0x30, EPtiBig5ToUcs2 = 0x40,
  EPtiComplexToSimplified = 0x80
}
enum  TPtiSpelling {
  EPtiStrokes = 0x01, EPtiPinyin = 0x02, EPtiBopomofo = 0x04, EPtiZhuyin = 0x08,
  EPtiCangJie = 0x10, EPtiEasyCangjie = 0x20, EPtiAdvCangjie = 0x40
}
 Enumerates supported spelling types for CPtiEngine::GetSpelling method. More...
enum  TPtiChineseVariant { EPtiChineseVariantPrc = 0, EPtiChineseVariantHk, EPtiChineseVariantTw }
 Enumerates different Chinese variants. More...
enum  TPtiEngineCommand {
  EPtiCommandNone, EPtiCommandUserActionLeft, EPtiCommandUserActionRight, EPtiCommandUserActionConvert,
  EPtiCommandUserActionPrevious, EPtiCommandUserActionLengthen, EPtiCommandUserActionShorten, EPtiCommandUserActionCancel,
  EPtiCommandUserActionComplete, EPtiCommandUserActionAllComplete, EPtiCommandUserActionGetCurrentIndexOfCandidates, EPtiCommandUserActionCompleteCandidate,
  EPtiCommandUserActionCompleteFull0, EPtiCommandUserActionCompleteFull1, EPtiCommandUserActionCompleteFull2, EPtiCommandUserActionCompleteFull3,
  EPtiCommandUserActionCompleteFull4, EPtiCommandUserActionCompleteFull5, EPtiCommandUserActionCompleteFull6, EPtiCommandUserActionCompleteFull7,
  EPtiCommandUserActionCompleteFull8, EPtiCommandUserActionCompleteFull9, EPtiCommandUserActionCompleteHalf0, EPtiCommandUserActionCompleteHalf1,
  EPtiCommandUserActionCompleteHalf2, EPtiCommandUserActionCompleteHalf3, EPtiCommandUserActionCompleteHalf4, EPtiCommandUserActionCompleteHalf5,
  EPtiCommandUserActionCompleteHalf6, EPtiCommandUserActionCompleteHalf7, EPtiCommandUserActionCompleteHalf8, EPtiCommandUserActionCompleteHalf9,
  EPtiCommandEnableToneMarks, EPtiCommandDisableToneMarks, EPtiCommandResetToneMark, EPtiCommandIncrementToneMark,
  EPtiCommandIncrementToneMarkOverrideInvalid, EPtiCommandReloadLearningInfo, EPtiCommandUserDictionaryDelaySaving, EPtiCommandUserDictionarySaveNow,
  EPtiCommandUserActionSetCurrentIndexOfCandidates, EPtiCommandUseLatinDefaultKeyMap, EPtiCommandUseLatinCaseUpperOnlyKeyMap, EPtiCommandUseLatinCaseLowerOnlyKeyMap,
  EPtiCommandResetLearningInfo, EPtiCommandPollQwertyDeadKeyRootFlag, EPtiCommandGetAndClearDeadKeyRootChar, EPtiCommandDeadKeyWaiting,
  EPtiCommandQueryAndClearGetAllFlag, EPtiCommandGetAndClearVowelSequence, EPtiCommandSetMultitapTimer, EPtiCommandVowelSeqFlag,
  EPtiCommandClearVowelSeq, EPtiCommandSetJapaneseQwertyFlags, EPtiCommandGetAndClearLastVietnameseChar, EPtiCommandSetVietnameseLastChar,
  EPtiCommandQueryReplacePrevious, EPtiCommandSetLastKeyForVietnamese, EPtiCommandResetVietnameseVowelSeqAndToneMark, EPtiCommandGetVietnameseLastKey,
  EPtiCommandDoubleWideEntry, EPtiCommandSetClearFunction, EPtiCommandUserActionRetroActiveCandidateHalf, EPtiCommandUserActionRetroActiveCandidateFull,
  EPtiCommandUserActionRetroActiveClear, EPtiCommandUserActionRetroActiveCommit, EPtiCommandAppendCharacter, EPtiCommandBackSpaceByForce,
  EPtiCommandGetPhoneticText, EPtiCommandClearPhoneticBuffer, EPtiCommandBreakSyllable, EPtiCommandAllowPictographCandidate,
  EPtiCommandLoopback, EPtiCommandSetAutoSubstitution, EPtiCommandAddAutoSubstEntry, EPtiCommandDeleteAutoSubstEntry,
  EPtiCommandNumberOfAutoSubstEntries, EPtiCommandGetAutoSubstEntry, EPtiCommandFindAutoSubstEntry, EPtiCommandUncommitWord,
  EPtiCommandEnableAutoCompletion, EPtiCommandDisableAutoCompletion, EPtiCommandSetCorrectionLevel, EPtiCommandGetAutoCompletionTailLength,
  EPtiCommandLockCurrentCandidate, EPtiCommandSetProactiveCorrection, EPtiCommandIsExactKnownWord, EPtiCommandSetAutoCompletion,
  EPtiCommandSetNumberCandidateStatus, EPtiCommandSetAutoCompletionMaxLength, EPtiCommandMarkAutoCapitalized, EPtiCommandUserActionGetIndexOfSecondaryCandidate,
  EPtiCommandAddPhrase, EPtiCommandSetSecondaryInputLanguage, EPtiCommandSetFlagToUpdateCandidates, EPtiCommandSetCursorCrossedMaxLength,
  EPtiCommandResetCursorCrossedMaxLength, EPtiCommandUserActionSetIndexOfActiveCandidate
}
 Command definitions for CPtiEngine::HandleCommandL api methods. More...
enum  {
  KPtiPinyinTone0 = 0x02C9, KPtiPinyinTone1 = 0x02CA, KPtiPinyinTone2 = 0x02C7, KPtiPinyinTone3 = 0x02CB,
  KPtiPinyinTone4 = 0x02D9
}
enum  {
  KPtiZhuyinTone0 = 0x0020, KPtiZhuyinTone1 = 0x02CA, KPtiZhuyinTone2 = 0x02C7, KPtiZhuyinTone3 = 0x02CB,
  KPtiZhuyinTone4 = 0x02D9
}
enum  TRecognitionSubRanges {
  EPtiRangePRCChinese, EPtiRangeHKChinese, EPtiRangeTWChinese, EPtiRangeLatin,
  EPtiRangeSymbol, EPtiRangeNumber, EPtiRangeNative, EPtiRangeHiraganaKanji,
  EPtiRangeKatakana, EPtiRangeFullWidthKatakana, EPtiRangeFullWidthEnglish, EPtiRangeFullWidthNumeric,
  EPtiRangeHiraganaOnly, EPtiRangeNativeNumber, EPtiRangeNone
}
enum  TLatinLetterOrder { EUpperFirst, ELowerFirst }
enum  TPtiKeyboardType {
  EPtiKeyboardNone, EPtiKeyboard12Key, EPtiKeyboardQwerty4x12, EPtiKeyboardQwerty4x10,
  EPtiKeyboardQwerty3x11, EPtiKeyboardHalfQwerty, EPtiKeyboardCustomQwerty, EPtiKeyboardMaxLayout
}

Variables

const TInt KMaxLanguageNameLength = 50
const TInt KMaxAutoSubstStringLength = 32
const TInt KErrPtiEngineBase = (-1000)

Define Documentation

#define ELangNumeric   0x5000
 

This is language code for 'numeric' language.

It is langugae object which is always available and has only numeric input mode.

#define KPtiEngineChineseSeparator   0x0027
 

Typedef Documentation

typedef struct TRecognitionRangeTag TRecognitionRange
 

Enumeration Type Documentation

anonymous enum
 
Enumerator:
KPtiPinyinTone0 
KPtiPinyinTone1 
KPtiPinyinTone2 
KPtiPinyinTone3 
KPtiPinyinTone4 
anonymous enum
 
Enumerator:
KPtiZhuyinTone0 
KPtiZhuyinTone1 
KPtiZhuyinTone2 
KPtiZhuyinTone3 
KPtiZhuyinTone4 
enum TLatinLetterOrder
 
Enumerator:
EUpperFirst 
ELowerFirst 
enum TPtiCharConversion
 
Enumerator:
EPtiSimplifiedToComplex 
EPtiUcs2ToUtf8 
EPtiUcs2ToBig5 
EPtiUcs2ToGB 
EPtiUtf8ToUcs2 
EPtiKo2ToWc 
EPtiWcToKo2 
EPtiBig5ToUcs2 
EPtiComplexToSimplified 
enum TPtiChineseVariant
 

Enumerates different Chinese variants.

Enumerator:
EPtiChineseVariantPrc 
EPtiChineseVariantHk 
EPtiChineseVariantTw 
enum TPtiEngineCapsBits
 

Enumerations for PtiCore capabilities.

These can be queries through MPtiCoreInfo::CapsBits(). Here are descriptions:

EWordCompletion The core object supports word completion -feature.

EReordering The core object supports user dictionary reordering. This feature means that most commonly used words are moved up in prediction candidate list.

ENextWordPrediction The core supports next word prediction feature. When this feature is enabled, prediction engine tries to guess next word based on previous word(s).

ESupportUserDictionaries The core supports supports user dictionaries.

ESupportSCTToneMarks

ESupportCangjieInput The core object supports Chinese CangJie input.

ESupportDualLanguage The core object supports dual language preditcion.

ESupportAutoSubstitution The core object supports auto-substitution feature. This feature automatically expands predefined string to longer string. ie. "l8r" -> "later"

Enumerator:
EWordCompletion 
EReordering 
ENextWordPrediction 
ESupportUserDictionaries 
ESupportSCTToneMarks 
ESupportCangjieInput 
EPreferedSpelling 
ESupportDualLanguage 
ESupportAutoSubstitution 
enum TPtiEngineCommand
 

Command definitions for CPtiEngine::HandleCommandL api methods.

Many of these are for internal communication between PtiEngine framework and a specific core object and there for not documented.

Enumerator:
EPtiCommandNone 
EPtiCommandUserActionLeft 
EPtiCommandUserActionRight 
EPtiCommandUserActionConvert 
EPtiCommandUserActionPrevious 
EPtiCommandUserActionLengthen 
EPtiCommandUserActionShorten 
EPtiCommandUserActionCancel 
EPtiCommandUserActionComplete 
EPtiCommandUserActionAllComplete 
EPtiCommandUserActionGetCurrentIndexOfCandidates 
EPtiCommandUserActionCompleteCandidate 
EPtiCommandUserActionCompleteFull0 
EPtiCommandUserActionCompleteFull1 
EPtiCommandUserActionCompleteFull2 
EPtiCommandUserActionCompleteFull3 
EPtiCommandUserActionCompleteFull4 
EPtiCommandUserActionCompleteFull5 
EPtiCommandUserActionCompleteFull6 
EPtiCommandUserActionCompleteFull7 
EPtiCommandUserActionCompleteFull8 
EPtiCommandUserActionCompleteFull9 
EPtiCommandUserActionCompleteHalf0 
EPtiCommandUserActionCompleteHalf1 
EPtiCommandUserActionCompleteHalf2 
EPtiCommandUserActionCompleteHalf3 
EPtiCommandUserActionCompleteHalf4 
EPtiCommandUserActionCompleteHalf5 
EPtiCommandUserActionCompleteHalf6 
EPtiCommandUserActionCompleteHalf7 
EPtiCommandUserActionCompleteHalf8 
EPtiCommandUserActionCompleteHalf9 
EPtiCommandEnableToneMarks 
EPtiCommandDisableToneMarks 
EPtiCommandResetToneMark 
EPtiCommandIncrementToneMark 
EPtiCommandIncrementToneMarkOverrideInvalid 
EPtiCommandReloadLearningInfo 
EPtiCommandUserDictionaryDelaySaving 
EPtiCommandUserDictionarySaveNow 
EPtiCommandUserActionSetCurrentIndexOfCandidates 
EPtiCommandUseLatinDefaultKeyMap 
EPtiCommandUseLatinCaseUpperOnlyKeyMap 
EPtiCommandUseLatinCaseLowerOnlyKeyMap 
EPtiCommandResetLearningInfo 
EPtiCommandPollQwertyDeadKeyRootFlag 
EPtiCommandGetAndClearDeadKeyRootChar 
EPtiCommandDeadKeyWaiting 
EPtiCommandQueryAndClearGetAllFlag 
EPtiCommandGetAndClearVowelSequence 
EPtiCommandSetMultitapTimer 
EPtiCommandVowelSeqFlag 
EPtiCommandClearVowelSeq 
EPtiCommandSetJapaneseQwertyFlags 
EPtiCommandGetAndClearLastVietnameseChar 
EPtiCommandSetVietnameseLastChar 
EPtiCommandQueryReplacePrevious 
EPtiCommandSetLastKeyForVietnamese 
EPtiCommandResetVietnameseVowelSeqAndToneMark 
EPtiCommandGetVietnameseLastKey 
EPtiCommandDoubleWideEntry 
EPtiCommandSetClearFunction 
EPtiCommandUserActionRetroActiveCandidateHalf 
EPtiCommandUserActionRetroActiveCandidateFull 
EPtiCommandUserActionRetroActiveClear 
EPtiCommandUserActionRetroActiveCommit 
EPtiCommandAppendCharacter 
EPtiCommandBackSpaceByForce 
EPtiCommandGetPhoneticText 
EPtiCommandClearPhoneticBuffer 
EPtiCommandBreakSyllable 
EPtiCommandAllowPictographCandidate 
EPtiCommandLoopback 
EPtiCommandSetAutoSubstitution 
EPtiCommandAddAutoSubstEntry 
EPtiCommandDeleteAutoSubstEntry 
EPtiCommandNumberOfAutoSubstEntries 
EPtiCommandGetAutoSubstEntry 
EPtiCommandFindAutoSubstEntry 
EPtiCommandUncommitWord 
EPtiCommandEnableAutoCompletion 
EPtiCommandDisableAutoCompletion 
EPtiCommandSetCorrectionLevel 
EPtiCommandGetAutoCompletionTailLength 
EPtiCommandLockCurrentCandidate 
EPtiCommandSetProactiveCorrection 
EPtiCommandIsExactKnownWord 
EPtiCommandSetAutoCompletion 
EPtiCommandSetNumberCandidateStatus 
EPtiCommandSetAutoCompletionMaxLength 
EPtiCommandMarkAutoCapitalized 
EPtiCommandUserActionGetIndexOfSecondaryCandidate 
EPtiCommandAddPhrase 
EPtiCommandSetSecondaryInputLanguage 
EPtiCommandSetFlagToUpdateCandidates 
EPtiCommandSetCursorCrossedMaxLength 
EPtiCommandResetCursorCrossedMaxLength 
EPtiCommandUserActionSetIndexOfActiveCandidate 
enum TPtiEngineInputMode
 

Enumerations for all the possible input modes supported by PtiEngine.

The modes actually available in the device depend on core object, resource and keyboard configuration. Here are short descriptions:

EPtiEngineMultitapping Traditional text input method for latin-like languages, where a list of characters is associated to each keypad keys and user cycles through associated characters by consecutive key presses.

EPtiEnginePredictive Predictive text input mode, where user presses only one key press per character and the prediction engine provides a list of candidate words associated top that key sequence.

EPtiEngineWordCompletion This is same as EPtiEnginePredictive, except that prediction engine will include also complete words containing more characters than the number of key presses in current key sequence.

EPtiEngineNumeric This is numeric input mode. All the languages suppor it, since it uses static keymappings built directly into PtiEngine. It works in same way as EPtiEngineMultitapping, except that keymapping data contains only number mode characters.

EPtiEngineQwerty Standard qwerty-keyboard input mode for latin-like languages.

EPtiEnginePinyin Chinese PinYin input mode for ITU-T keypad.

EPtiEngineStroke Chinese Strokes input mode for ITU-T keypad.

EPtiEngineStroke Chinese ZhuYin input mode for ITU-T keypad.

EPtiEngineHirakanaKanji Japanese Hiragana/Kanji input mode.

EPtiEngineHirakanaKanjiPredictive Predictive Japanese Hiragana/Kanji input mode.

EPtiEngineKatakana Japanese Katakana input mode.

EPtiEngineFullWitdthKatakana Japanese full width Katakana input mode.

EPtiEngineFullWitdthKatakana Japanese full width numeric input mode.

EPtiEngineFullWitdthAlphabet Japanese full width alphabet input mode.

EPtiEngineHiragana Japanese Hiragana input mode.

EPtiEnginePinyinByPhrase Chinese Pinyin phrase input. This is same as EPtiEnginePinyin, execpt that input string may contain pinyin words for several chinese characters.

EPtiEngineZhuyinByPhrase Chinese Zinyin phrase input. This is same as EPtiEngineZhuyin, execpt that input string may contain zhuyin sequences for several chinese characters.

EPtiEngineZhuyinQwerty Chinese Zhuyin input for qwerty keyboard.

EPtiEngineZhuyinPhraseQwerty Chinese Zinyin phrase input for qwerty keyboard. This is same as EPtiEngineZhuyinQwerty, execpt that input string may contain zhuyin sequences for several chinese characters.

EPtiEnginePinyinQwerty Chinese Pinyin input for qwerty keyboard.

PtiEnginePinyinPhraseQwerty Same as EPtiEnginePinyinByPhrase but for qwerty keyboard

EPtiEngineStrokeQwerty Same as EPtiEngineStroke but for qwerty keyboard

EPtiEngineNormalCangjieQwerty Normal Chinese CangJie input for qwerty keyboard (CangJie is available only for qwerty).

EPtiEngineEasyCangjieQwerty Easy Chinese CangJie input for qwerty keyboard (CangJie is available only for qwerty).

EPtiEngineAdvCangjieQwerty Advanced Chinese CangJie input for qwerty keyboard (CangJie is available only for qwerty).

EPtiEngineHiraganaKanjiQwerty Japanese Hiragana/Kanji input for qwerty keyboard.

EPtiEngineHiraganaKanjiPredictiveQwerty Japanese predictive Hiragana/Kanji input for qwerty keyboard

EPtiEngineKatakanaQwerty Japanese Half-width Katakana input for qwerty keyboard.

EPtiEngineFullWidthKatakanaQwerty Japanese Full-width Katakana input for qwerty keyboard.

EPtiEngineFullWidthNumericQwerty Japanese Full-width Alphabet input for qwerty keyboard.

EPtiEngineFullWidthAlphabetQwerty Japanese Full-width Alphabet input for qwerty keyboard.

EPtiEngineHiraganaQwerty Japanese Hiragana input for qwerty keyboard.

EPtiEngineStrokeByPhrase, // Stroke phrase input. Chinese Stroke input for ITU-T keypad. Phrasal version.

EPtiEngineStrokePhraseQwerty Chinese Stroke input for qwerty keyboard. Phrasal version.

EPtiEngineQwertyPredictive, // "Sloppy type" input for qwerty keyboard. Intelligent qwerty input. Used for word completion and spell correction features for qwerty keyboard.

EPtiEngineHalfQwerty Basic multitaping style text input for half-qwerty keyboard. The functionality of half-qwerty keyboard is same as conventional itu-t phone keypad, except that each key is associated with two basic characters (instead of three or four as in itu-t keypad). Character mapping is also organized to follow qwerty layout (instead of alphabetical order as in itu-t keypad).

EPtiEngineHalfQwertyPredictive, Predictive text input for half-qwerty keyboard. The functionality of half-qwerty keyboard is same as conventional itu-t phone keypad, except that each key is associated with two basic characters(instead of three or four as in itu-t keypad). . Character mapping is also organized to follow qwerty layout (instead of alphabetical order as in itu-t keypad). This input mode is essentially same as EPtiEngineWordCompletion but uses half-qwerty keyboard.

EPtiEngineInputModeIndicPhoneticMultitap Hindi phonetic input for itu-t keypad.

EPtiEngineInputModeIndicPhoneticQwerty Hindi phonetic input for qwerty keyboard.

EPtiEngineInputModeZhuyinMiniQwertyFind zhuyin multitap input method for mini qwerty find

Enumerator:
EPtiEngineInputModeNone 
EPtiEngineMultitapping 
EPtiEnginePredictive 
EPtiEngineWordCompletion 
EPtiEngineNumeric 
EPtiEngineQwerty 
EPtiEnginePinyin 
EPtiEngineStroke 
EPtiEngineZhuyin 
EPtiEngineHiraganaKanji 
EPtiEngineHiraganaKanjiPredictive 
EPtiEngineKatakana 
EPtiEngineFullWidthKatakana 
EPtiEngineFullWidthNumeric 
EPtiEngineFullWidthAlphabet 
EPtiEngineHiragana 
EPtiEnginePinyinByPhrase 
EPtiEngineZhuyinByPhrase 
EPtiEngineZhuyinQwerty 
EPtiEngineZhuyinPhraseQwerty 
EPtiEnginePinyinQwerty 
EPtiEnginePinyinPhraseQwerty 
EPtiEngineStrokeQwerty 
EPtiEngineNormalCangjieQwerty 
EPtiEngineEasyCangjieQwerty 
EPtiEngineAdvCangjieQwerty 
EPtiEngineHiraganaKanjiQwerty 
EPtiEngineHiraganaKanjiPredictiveQwerty 
EPtiEngineKatakanaQwerty 
EPtiEngineFullWidthKatakanaQwerty 
EPtiEngineFullWidthNumericQwerty 
EPtiEngineFullWidthAlphabetQwerty 
EPtiEngineHiraganaQwerty 
EPtiEnginePinyinVkb 
EPtiEngineStrokeVkb 
EPtiEngineZhuyinVkb 
EPtiEngineStrokeByPhrase 
EPtiEngineStrokePhraseQwerty 
EPtiEngineHiraganaKanjiVkb 
EPtiEngineHiraganaKanjiPredictiveVkb 
EPtiEngineHiraganaKanjiHwr 
EPtiEngineHiraganaKanjiPredictiveHwr 
EPtiEngineKatakanaVkb 
EPtiEngineFullWidthKatakanaVkb 
EPtiEngineHiraganaVkb 
EPtiEngineNormalCangjieVkb 
EPtiEngineEasyCangjieVkb 
EPtiEngineAdvCangjieVkb 
EPtiEngineInputModeIndicPhoneticMultitap 
EPtiEngineInputModeIndicPhoneticQwerty 
EPtiEngineHiraganaKanjiVkbRomaji 
EPtiEngineHiraganaKanjiPredictiveVkbRomaji 
EPtiEngineQwertyPredictive 
EPtiEngineHalfQwerty 
EPtiEngineHalfQwertyPredictive 
EPtiEngineInputModeQwertyPredictive 
EPtiEngineInputModeZhuyinMiniQwertyFind 
EPtiEnginePinyinPhraseHalfQwerty 
EPtiEngineStrokePhraseHalfQwerty 
EPtiEngineZhuyinPhraseHalfQwerty 
EPtiEngineMaxInputModes 
enum TPtiError
 
Enumerator:
KErrNoActiveLanguage 
KErrLanguageNotFound 
KErrNoSuitableCore 
KErrNotAllowed 
KErrTooLongWord 
KErrInvalidWord 
KErrTooLongReading 
KErrInvalidReading 
KErrUserDic 
KErrInternalCoreError 
KErrLengthMismatch 
enum TPtiErrorCorrectionLevel
 
Enumerator:
EPtiErrorCorrectionLevelOff 
EPtiErrorCorrectionLevelLow 
EPtiErrorCorrectionLevelHigh 
enum TPtiKey
 

Key enumerations for conventional (ITU-T) and qwerty keyboards.

Constant names for qwerty keypad keys are named after scan code values of a device using English language keymappings. The actual character that will be inserted into editor buffer depends on keymappings of currently selected input language and may be something else than what enum name suggests. For example non-shifted EPtiKeyQwertyHash produces '#'-character if input language is English, but will produce '+'-character if input language is Danish, Norwegian, Swedish or Finnish. The key coordinates on standard 4x12 qwerty keypad are given in comments.

Enumerator:
EPtiKeyNone 
EPtiKey1 
EPtiKey2 
EPtiKey3 
EPtiKey4 
EPtiKey5 
EPtiKey6 
EPtiKey7 
EPtiKey8 
EPtiKey9 
EPtiKeyStar 
EPtiKey0 
EPtiKeyHash 
EPtiKeyPunct 
EPtiKeyABC 
EPtiKeyDEF 
EPtiKeyGHI 
EPtiKeyJKL 
EPtiKeyMNO 
EPtiKeyPQRS 
EPtiKeyTUV 
EPtiKeyWXYZ 
EPtiKeyQwerty1 
EPtiKeyQwerty2 
EPtiKeyQwerty3 
EPtiKeyQwerty4 
EPtiKeyQwerty5 
EPtiKeyQwerty6 
EPtiKeyQwerty7 
EPtiKeyQwerty8 
EPtiKeyQwerty9 
EPtiKeyQwerty0 
EPtiKeyQwertyPlus 
EPtiKeyQwertyMinus 
EPtiKeyQwertyComma 
EPtiKeyQwertySemicolon 
EPtiKeyQwertyFullstop 
EPtiKeyQwertyHash 
EPtiKeyQwertySlash 
EPtiKeyQwertyApostrophe 
EPtiKeyQwertySpace 
EPtiKeyQwertyAtCharacter 
EPtiKeyQwertyLeftShift 
EPtiKeyQwertyA 
EPtiKeyQwertyB 
EPtiKeyQwertyC 
EPtiKeyQwertyD 
EPtiKeyQwertyE 
EPtiKeyQwertyF 
EPtiKeyQwertyG 
EPtiKeyQwertyH 
EPtiKeyQwertyI 
EPtiKeyQwertyJ 
EPtiKeyQwertyK 
EPtiKeyQwertyL 
EPtiKeyQwertyM 
EPtiKeyQwertyN 
EPtiKeyQwertyO 
EPtiKeyQwertyP 
EPtiKeyQwertyQ 
EPtiKeyQwertyR 
EPtiKeyQwertyS 
EPtiKeyQwertyT 
EPtiKeyQwertyU 
EPtiKeyQwertyV 
EPtiKeyQwertyW 
EPtiKeyQwertyX 
EPtiKeyQwertyY 
EPtiKeyQwertyZ 
EPtiKeyQwertyChr 
enum TPtiKeyboardType
 
Enumerator:
EPtiKeyboardNone 
EPtiKeyboard12Key  Conventional 12 phone keypad.
EPtiKeyboardQwerty4x12  4x12 Qwerty keyboard.
EPtiKeyboardQwerty4x10  4x10 Qwerty keyboard.
EPtiKeyboardQwerty3x11  3x11 Qwerty keyboard.
EPtiKeyboardHalfQwerty  Half qwerty.
EPtiKeyboardCustomQwerty  Custom qwerty keyboard.

Bound to [KEYBOARD BLOCK QWERTY CUSTOM] in keymapping definition files.

EPtiKeyboardMaxLayout 
enum TPtiSpelling
 

Enumerates supported spelling types for CPtiEngine::GetSpelling method.

Enumerator:
EPtiStrokes 
EPtiPinyin 
EPtiBopomofo 
EPtiZhuyin 
EPtiCangJie 
EPtiEasyCangjie 
EPtiAdvCangjie 
enum TPtiTextCase
 

Text case defintions.

Enumerator:
EPtiCaseLower 
EPtiCaseUpper 
EPtiCaseChrLower 
EPtiCaseChrUpper 
EPtiCaseFnLower 
EPtiCaseFnUpper 
enum TRecognitionSubRanges
 
Enumerator:
EPtiRangePRCChinese 
EPtiRangeHKChinese 
EPtiRangeTWChinese 
EPtiRangeLatin 
EPtiRangeSymbol 
EPtiRangeNumber 
EPtiRangeNative 
EPtiRangeHiraganaKanji 
EPtiRangeKatakana 
EPtiRangeFullWidthKatakana 
EPtiRangeFullWidthEnglish 
EPtiRangeFullWidthNumeric 
EPtiRangeHiraganaOnly 
EPtiRangeNativeNumber 
EPtiRangeNone 

Variable Documentation

const TInt KErrPtiEngineBase = (-1000)
 
const TInt KMaxAutoSubstStringLength = 32
 
const TInt KMaxLanguageNameLength = 50
 

Copyright © Nokia Corporation 2001-2007
Back to top