MPtiKeyMapData Class Reference
Interface class for PtiEngine keymapping data. Keymapping data is built into ecom dlls and accessesed through this interface. PtiEngine clients do not normally need to use this class directly.
Public Member Functions
|
TPtrC
|
DataForKey
(
TPtiKeyboardType
,
TPtiKey
,
TPtiTextCase
)
|
TPtrC
|
DataForKey
(
TPtiKeyboardType
,
TInt
)
|
const
TUint16
*
|
DeadKeyDataArray
(
TPtiKeyboardType
,
TInt
&)
|
TPtrC
|
DeadKeyDataForKey
(
TPtiKeyboardType
,
TPtiKey
,
TPtiTextCase
)
|
void
|
GetNumericModeKeysL
(
TPtiKeyboardType
,
RArray
<
TPtiNumericKeyBinding
> &)
|
TBool
|
HasDeadKeys
(
TPtiKeyboardType
)
|
TBool
|
HasFnKeyBindings
(
TPtiKeyboardType
)
|
TBool
|
HasKeyData
(
TPtiKeyboardType
)
|
TBool
|
HasVowelSequences
(
TPtiKeyboardType
)
|
TBool
|
IsDeadKey
(
TPtiKeyboardType
,
TPtiKey
,
TPtiTextCase
)
|
TBool
|
IsNumberModeKey
(
TPtiKeyboardType
,
TPtiNumericKeyBinding
&)
|
const
TPtiKeyBinding
*
|
KeyBindingTable
(
TPtiKeyboardType
,
TInt
&)
|
const
TUint16
*
|
KeyData
(
TPtiKeyboardType
,
TInt
&)
|
TInt
|
LanguageCode
()
|
TInt
|
NumberOfKeys
(
TPtiKeyboardType
)
|
const
TPtiNumericKeyBinding
*
|
NumericModeKeysTable
(
TPtiKeyboardType
,
TInt
&)
|
void
|
Reserved_1
()
|
void
|
Reserved_2
()
|
void
|
Reserved_3
()
|
void
|
Reserved_4
()
|
TBool
|
SuitableForLatinOnlyMode
()
|
const
TVowelSequence
*
|
VowelSequenceTable
(
TPtiKeyboardType
,
TInt
&)
|
Member Functions Documentation
DataForKey(TPtiKeyboardType, TPtiKey, TPtiTextCase)
TPtrC
|
DataForKey
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TPtiKey
|
aKey,
|
|
TPtiTextCase
|
aCase
|
|
)
|
const [pure virtual]
|
Returns keymap data for given keyboard type, key and text case.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TPtiKey
aKey
|
A key to be requested.
|
TPtiTextCase
aCase
|
A text case for aKey
|
DataForKey(TPtiKeyboardType, TInt)
TPtrC
|
DataForKey
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TInt
|
aIndex
|
|
)
|
const [pure virtual]
|
Returns keymap data for given keyboard type, key and text case. This version takes an internal keymap binding table index as a parameter. PtiEngine framework doesn't call this method directly. Normally the real implementation for this method is generated by keymap data builder into keymap plugin file, so each language data plugin has own implementation of this method.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TInt
aIndex
|
A internal index into keymap buildings table.
|
DeadKeyDataArray(TPtiKeyboardType, TInt &)
const
TUint16
*
|
DeadKeyDataArray
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TInt
&
|
aNumRowsInArray
|
|
)
|
const [pure virtual]
|
Returns pointer to dead key data table.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TInt
& aNumRowsInArray
|
This integer is filled with number of rows in array.
|
DeadKeyDataForKey(TPtiKeyboardType, TPtiKey, TPtiTextCase)
TPtrC
|
DeadKeyDataForKey
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TPtiKey
|
aKey,
|
|
TPtiTextCase
|
aCase
|
|
)
|
const [pure virtual]
|
Returns dead key data for given key / case combination.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TPtiKey
aKey
|
A key to be queried.
|
TPtiTextCase
aCase
|
A text case for aKey.
|
GetNumericModeKeysL(TPtiKeyboardType, RArray< TPtiNumericKeyBinding > &)
This methods fills an array of key bindings with those keys that produce numeric mode characters for given keyboard type. This is needed because not all languages naturally contain required numeric mode characters. Text input framework needs to know which keys to use in that case. For example, user always needs to be able to produce characters 'p' and 'w' for phone number editor, but many languages (Arabic, Hebrew, etc) don't have those characters in their qwerty key mapping data. This method makes it possible to define in key mapping data file which keys will be used if a number mode character is missing from normal qwerty mappings.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
RArray
<
TPtiNumericKeyBinding
> & aResult
|
resulting key array will be stored here. Existing entries are cleared.
|
HasDeadKeys(TPtiKeyboardType)
TBool
|
HasDeadKeys
|
(
|
TPtiKeyboardType
|
aKeyboardType
|
)
|
const [pure virtual]
|
Returns a boolean value indicating whether key mapping data contains dead keys.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
HasFnKeyBindings(TPtiKeyboardType)
TBool
|
HasFnKeyBindings
|
(
|
TPtiKeyboardType
|
aKeyboardType
|
)
|
const [pure virtual]
|
Returns boolean value indicating whether given keyboard data contains fn-key mappings.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
HasKeyData(TPtiKeyboardType)
TBool
|
HasKeyData
|
(
|
TPtiKeyboardType
|
aKeyboardType
|
)
|
const [pure virtual]
|
Returns a boolean value indicating whether language dll contains keymapping data for given keyboard type.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
HasVowelSequences(TPtiKeyboardType)
TBool
|
HasVowelSequences
|
(
|
TPtiKeyboardType
|
aKeyboardType
|
)
|
const [pure virtual]
|
Returns boolean value indicating whether keymapping data contains vowel sequences (such as those needed for Vietnamese qwerty input).
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
IsDeadKey(TPtiKeyboardType, TPtiKey, TPtiTextCase)
TBool
|
IsDeadKey
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TPtiKey
|
aKey,
|
|
TPtiTextCase
|
aCase
|
|
)
|
const [pure virtual]
|
Returns a boolean value indicating whether given key / case combination is so called 'dead key'.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TPtiKey
aKey
|
A key to be queried.
|
TPtiTextCase
aCase
|
A text case for aKey
|
IsNumberModeKey(TPtiKeyboardType, TPtiNumericKeyBinding &)
This methods takes the given
TPtiNumericKeyBinding
struct and fills its iChar field if iKey and iShifted parameters of that struct match to any of the qwerty number mode keys for this language.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TPtiNumericKeyBinding
& aWhichKey
|
A structure containing search parameters and result field.
|
KeyBindingTable(TPtiKeyboardType, TInt &)
const
TPtiKeyBinding
*
|
KeyBindingTable
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TInt
&
|
aNumItems
|
|
)
|
const [pure virtual]
|
This method provides direct access to keybinding table. Normally this isn't needed outside of keymapping classes. Use only if none of the convinienece methods above is applicable
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TInt
& aNumItems
|
This integer will be filled with number of items in reurned table.
|
KeyData(TPtiKeyboardType, TInt &)
const
TUint16
*
|
KeyData
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TInt
&
|
aDataSize
|
|
)
|
const [pure virtual]
|
This methods provides direct access to keymap data table. In most cases this method is not needed outside keymap data classes. Use only if none of the convinience methods above is applicable.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TInt
& aDataSize
|
This integer filled with number of TUint16 values in data table.
|
LanguageCode()
TInt
|
LanguageCode
|
(
|
)
|
const [pure virtual]
|
Returns language code for keymap data.
NumberOfKeys(TPtiKeyboardType)
TInt
|
NumberOfKeys
|
(
|
TPtiKeyboardType
|
aKeyboardType
|
)
|
const [pure virtual]
|
Returns maximum number of physical keys used for given keyboard type.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type.
|
NumericModeKeysTable(TPtiKeyboardType, TInt &)
const
TPtiNumericKeyBinding
*
|
NumericModeKeysTable
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TInt
&
|
aNumEntries
|
|
)
|
const [pure virtual]
|
Returns pointer to numeric mode key table for given keyboard type. Number of items in array is stored to given integer variable.
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TInt
& aNumEntries
|
The number of items in return array will be stored to this integer value.
|
Reserved_1()
void
|
Reserved_1
|
(
|
)
|
[pure virtual]
|
Reserved_2()
void
|
Reserved_2
|
(
|
)
|
[pure virtual]
|
Reserved_3()
void
|
Reserved_3
|
(
|
)
|
[pure virtual]
|
Reserved_4()
void
|
Reserved_4
|
(
|
)
|
[pure virtual]
|
SuitableForLatinOnlyMode()
TBool
|
SuitableForLatinOnlyMode
|
(
|
)
|
const [pure virtual]
|
This method returns a boolean value indicating whether this language can be used in "Latin Only" editors. If this method returns EFalse, then input framework will substitute it locally with English for "Latin Only" editors. Default implementation returns ETrue, so most languages don't need to define this in their key mapping data file.
VowelSequenceTable(TPtiKeyboardType, TInt &)
const
TVowelSequence
*
|
VowelSequenceTable
|
(
|
TPtiKeyboardType
|
aKeyboardType,
|
|
TInt
&
|
aNumEntries
|
|
)
|
const [pure virtual]
|
Returns pointer to vowel sequence table (needed for Vietnamese qwerty input).
Parameters
TPtiKeyboardType
aKeyboardType
|
Keyboard type
|
TInt
& aNumEntries
|
This integer will be filled with number of entries in table.
|
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.