S60 3rd Edition API Reference: ptidefs.h File Reference

ptidefs.h File Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

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

Go to the source code of this file.


Data Structures

class  TPtiLangName
class  MPtiCoreInfo
class  TPtiCoreInfo
class  TPtiNumericKeyBinding
struct  TRecognitionRangeTag
 Public Since 3rd Ed FP1 type definition for HWR. More...

Defines

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

Typedefs

typedef TRecognitionRangeTag TRecognitionRange
 Public Since 3rd Ed FP1 type definition for HWR.

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
}
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,
  EPtiEngineMaxInputModes = EPtiEngineAdvCangjieVkb
}
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, 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
}
enum  TPtiEngineCapsBits {
  EWordCompletion = 0x01, EReordering = 0x02, ENextWordPrediction = 0x04, ESupportUserDictionaries = 0x08,
  ESupportSCTToneMarks = 0x10, ESupportCangjieInput = 0x20
}
enum  TPtiTextCase { EPtiCaseLower = 0, EPtiCaseUpper, EPtiCaseChrLower, EPtiCaseChrUpper }
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 }
enum  TPtiChineseVariant { EPtiChineseVariantPrc = 0, EPtiChineseVariantHk, EPtiChineseVariantTw }
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
}
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
}
 Public Since 3rd Ed FP1. More...
enum  TLatinLetterOrder { EUpperFirst, ELowerFirst }
 Public Since 3rd Ed FP1. More...

Variables

const TInt KMaxLanguageNameLength = 50
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
 

Public Since 3rd Ed FP1 type definition for HWR.

Enumeration Type Documentation

anonymous enum
 
Enumerator:
KPtiPinyinTone0 
KPtiPinyinTone1 
KPtiPinyinTone2 
KPtiPinyinTone3 
KPtiPinyinTone4 
anonymous enum
 
Enumerator:
KPtiZhuyinTone0 
KPtiZhuyinTone1 
KPtiZhuyinTone2 
KPtiZhuyinTone3 
KPtiZhuyinTone4 
enum TLatinLetterOrder
 

Public Since 3rd Ed FP1.

Enumerator:
EUpperFirst 
ELowerFirst 
enum TPtiCharConversion
 
Enumerator:
EPtiSimplifiedToComplex 
EPtiUcs2ToUtf8 
EPtiUcs2ToBig5 
EPtiUcs2ToGB 
EPtiUtf8ToUcs2 
EPtiKo2ToWc 
EPtiWcToKo2 
EPtiBig5ToUcs2 
EPtiComplexToSimplified 
enum TPtiChineseVariant
 
Enumerator:
EPtiChineseVariantPrc 
EPtiChineseVariantHk 
EPtiChineseVariantTw 
enum TPtiEngineCapsBits
 
Enumerator:
EWordCompletion 
EReordering 
ENextWordPrediction 
ESupportUserDictionaries 
ESupportSCTToneMarks 
ESupportCangjieInput 
enum TPtiEngineCommand
 
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 
enum TPtiEngineInputMode
 
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 
EPtiEngineMaxInputModes 
enum TPtiError
 
Enumerator:
KErrNoActiveLanguage 
KErrLanguageNotFound 
KErrNoSuitableCore 
KErrNotAllowed 
KErrTooLongWord 
KErrInvalidWord 
KErrTooLongReading 
KErrInvalidReading 
KErrUserDic 
enum TPtiKey
 
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 
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 
enum TPtiSpelling
 
Enumerator:
EPtiStrokes 
EPtiPinyin 
EPtiBopomofo 
EPtiZhuyin 
enum TPtiTextCase
 
Enumerator:
EPtiCaseLower 
EPtiCaseUpper 
EPtiCaseChrLower 
EPtiCaseChrUpper 
enum TRecognitionSubRanges
 

Public Since 3rd Ed FP1.

Enumerator:
EPtiRangePRCChinese 
EPtiRangeHKChinese 
EPtiRangeTWChinese 
EPtiRangeLatin 
EPtiRangeSymbol 
EPtiRangeNumber 

Variable Documentation

const TInt KErrPtiEngineBase = (-1000)
 
const TInt KMaxLanguageNameLength = 50
 
Copyright © Nokia Corporation 2001-2007
Back to top