inputmethods_plat/aknfep_settings_api/inc/AknFepInternalCRKeys.h
changeset 0 eb1f2e154e89
child 5 a47de9135b21
equal deleted inserted replaced
-1:000000000000 0:eb1f2e154e89
       
     1 /*
       
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0""
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:               Internal Central Repository keys.
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 
       
    26 
       
    27 
       
    28 
       
    29 
       
    30 
       
    31 
       
    32 #ifndef AKNFEP_INTERNAL_CR_KEYS_H
       
    33 #define AKNFEP_INTERNAL_CR_KEYS_H
       
    34 
       
    35 const TUid KCRUidAknFep = { 0x101F876D };
       
    36 
       
    37 /**
       
    38  * If this feature is enabled, new line can be entered by pressing scroll down.
       
    39  * Value is either integer 1 (enabled) or 0 (disabled).
       
    40  * Default value: 1 in Japanese variant. 0 in other variants.
       
    41  */
       
    42 const TUint32 KAknFepEnterWithScrollDown   = 0x00000001;
       
    43 
       
    44 /**
       
    45  * If this feature is enabled, Latin predictive input candidates are selected
       
    46  * using scroll keys. If the feature is disabled, they are selected using
       
    47  * softkeys. It is recommended to enable this feature in Japanese variant,
       
    48  * because in Japanese input, predictive candidates are always selected using
       
    49  * scroll keys.
       
    50  * Value is either integer 1 (enabled) or 0 (disabled).
       
    51  * Default value: 1 in Japanese variant. 0 in other variants.
       
    52  */
       
    53 const TUint32 KAknFepScrollLatinPredictive = 0x00000002;
       
    54 
       
    55 /**
       
    56  * If this feature is enabled, space can be entered by pressing scroll right.
       
    57  * Value is either integer 1 (enabled) or 0 (disabled).
       
    58  * Default value: 1 in Japanese and Thai variant. 0 in other variants.
       
    59  */
       
    60 const TUint32 KAknFepSpaceWithScrollRight  = 0x00000003;
       
    61 
       
    62 /**
       
    63  * Chinese Input Mode, integer value.
       
    64  *
       
    65  * Used values:
       
    66  *
       
    67  * 0x10  (Pinyin)
       
    68  * 0x20  (Zhuyin)
       
    69  * 0x40  (Stroke)
       
    70  * 0x80  (Latin Upper Case)
       
    71  * 0x100 (Latin Lower Case)
       
    72  *
       
    73  * Default value: 0
       
    74  */
       
    75 const TUint32 KAknFepChineseInputMode      = 0x00000004;
       
    76 
       
    77 /**
       
    78  * Input Text Language, integer value.
       
    79  *
       
    80  * Possible values:
       
    81  * 0 (automatic)
       
    82  * valid Symbian OS language code
       
    83  *
       
    84  * Default value: 0
       
    85  */
       
    86 const TUint32 KAknFepInputTxtLang          = 0x00000005;
       
    87 
       
    88 /**
       
    89  * This key is required for the Japanese predictive text input feature.
       
    90  * General settings uses it to store the user selection for Japanese
       
    91  * predictive text input.
       
    92  *
       
    93  * Default value: 0
       
    94  */
       
    95 const TUint32 KAknFepJapanesePredTxtFlag   = 0x00000006;
       
    96 
       
    97 /**
       
    98  * Predictive Text Input On/Off for ITU-T keypad.
       
    99  *
       
   100  * Possible values:
       
   101  * 0: off (default value)
       
   102  * 1: on
       
   103  */
       
   104 const TUint32 KAknFepPredTxtFlag           = 0x00000007;
       
   105 
       
   106 /**
       
   107  * Multitap timer value.
       
   108  * Replaces the constant KMultiTapTimeoutMS in Japanese variant.
       
   109  *
       
   110  * Default value: 1000000 in Japanese variant. 0 in other variants.
       
   111  */
       
   112 const TUint32 KAknFepMultiTapTimer         = 0x00000008;
       
   113 
       
   114 /**
       
   115  * Chinese CangJie input method for S60 and QWERTY.
       
   116  *
       
   117  * Possible values:
       
   118  * 0 (ECangJieNormal)
       
   119  * 1 (ECangJieEasy)
       
   120  * 2 (ECangJieAdvanced)
       
   121  */
       
   122 const TUint32 KAknFepCangJieMode           = 0x00000009;
       
   123 
       
   124 /**
       
   125  * Test mode key used in emulator.
       
   126  */
       
   127 const TUint32 KAknFepTestModeKey           = 0x0000000A;
       
   128 
       
   129 /**
       
   130  * This key is required for the Japanese special character flag. General 
       
   131  * settings uses it to store the user selection for Japanese special 
       
   132  * character settings.
       
   133  * - Comma: Japanese comma = 0x01
       
   134  *      Western comma != 0x01
       
   135  * - Period: Japanese period = 0x02
       
   136  *      Western period != 0x02
       
   137  * - Width of Space: Full width = 0x04
       
   138  *      Half width != 0x04
       
   139  * - Width of punctuation marks and symbols:
       
   140  *      Full width = 0x08
       
   141  *      Half width != 0x08
       
   142  */
       
   143 const TUint32 KAknFepJapaneseSpecialCharFlag = 0x0000000B;
       
   144 
       
   145 /**
       
   146  * Indicates whether the hash key is used in selections in lists and editors. 
       
   147  * Needed because making Edit key optional in the device. 
       
   148  * Possible values are: 1 (hash key selection in use) or 0 (hash key 
       
   149  * selection not in use).
       
   150  *
       
   151  * Default value: 0
       
   152  */
       
   153 const TUint32 KAknFepHashKeySelection      = 0x0000000C;
       
   154 
       
   155 /**
       
   156  * Indicates whether "edit text" submenu should be added to application 
       
   157  * options-menu by FEP.
       
   158  */
       
   159 const TUint32 KAknFepEditTextSubmenu       = 0x0000000D;
       
   160 
       
   161 /*
       
   162  * The bottom right point of the hwr window in the orientation mode
       
   163  * EGraphicsOrientationNormal.
       
   164  */
       
   165 const TUint32 KAknFepHwrWindowPosition0 = 0x0000000E;
       
   166 
       
   167 /**
       
   168  * The bottom right point of the hwr window in the orientation mode
       
   169  * EGraphicsOrientationRotated90.
       
   170  */	
       
   171 const TUint32 KAknFepHwrWindowPosition1 = 0x0000000F;
       
   172 	
       
   173 
       
   174 /**
       
   175  * The bottom right point of the hwr window in the orientation mode
       
   176  * EGraphicsOrientationRotated180.
       
   177  */
       
   178 const TUint32 KAknFepHwrWindowPosition2 = 0x00000010;
       
   179 	
       
   180 /**
       
   181  * The bottom right point of the hwr window in the orientation mode 
       
   182  * EGraphicsOrientationRotated270.
       
   183  */
       
   184 const TUint32 KAknFepHwrWindowPosition3 = 0x00000011;
       
   185 	
       
   186 /**
       
   187  * The last used alpha recognition range.
       
   188  */
       
   189 const TUint32 KAknFepLastUsedRange = 0x00000012;
       
   190 	
       
   191 /**
       
   192  *  Information whether HWR or VKB input method was used last.
       
   193  */
       
   194 const TUint32 KAknFepLastUsedInput = 0x00000013;
       
   195 
       
   196 /**
       
   197  *  Tells which UI language was active when FEP was last initialized.
       
   198  */
       
   199 const TUint32 KAknFepLastUsedUILanguage = 0x00000014;
       
   200 
       
   201 /**
       
   202  * This key is required for the clear direction.
       
   203  * Clear direction value Left side (Backspace function) /
       
   204  * Right side (Delete function).
       
   205  * Possible values are: (defined in AknFepGlobalEnums.h)
       
   206  * EClearDirectionLeft(0)  remove a character on the left side
       
   207  * EClearDirectionRight(1) remove a character on the right side
       
   208  */
       
   209 const TUint32 KAknFepClearDirection = 0x00000015;
       
   210 
       
   211 /**
       
   212  * Predictive Text Auto Word Completion On/Off.
       
   213  *
       
   214  * A bit vector indicating which input types have auto completion on.
       
   215  *
       
   216  * Possible values:
       
   217  * 0: off
       
   218  * 1: on (default value)
       
   219  *
       
   220  * (bitmask values in EKeyboardStyle)
       
   221  *
       
   222  * 0x01 = ITU-T (12-key) predictive input
       
   223  * 0x02 = Qwerty predictive input
       
   224  */
       
   225 const TUint32 KAknFepAutoCompleteFlag = 0x00000016;
       
   226 
       
   227 /**
       
   228  * Predictive Text Typing Correction Level.
       
   229  *
       
   230  * Possible values:
       
   231  * 0: off 
       
   232  * 1: medium (default value)
       
   233  * 2: high
       
   234  */
       
   235 const TUint32 KAknFepTypingCorrectionLevel = 0x00000017;
       
   236 
       
   237 /**
       
   238  * Predictive Text Number Candidate Shown/Not shown.
       
   239  *
       
   240  * Possible values:
       
   241  * 0: Not Shown 
       
   242  * 1: Shown (default value)
       
   243  */
       
   244 const TUint32 KAknFepNumberCandidateFlag = 0x00000018;
       
   245 
       
   246 /**
       
   247  * Predictive Text Primay Candidate Exact/Suggested.
       
   248  *
       
   249  * Possible values:
       
   250  * 0: Suggested (default value)
       
   251  * 1: Exact 
       
   252  */
       
   253 const TUint32 KAknFepPrimaryCandidateFlag = 0x00000019;
       
   254 
       
   255 /** 
       
   256  * Available physical keyboards. 
       
   257  * A bit vector indicating which physical keyboards are connected to the device.
       
   258  * Possible values (combination of these):
       
   259  * 0x01 = 12-key ITU-T,
       
   260  * 0x02 = 4x12 qwerty,
       
   261  * 0x04 = 4x10 qwerty,
       
   262  * 0x08 = 3x11 qwerty,
       
   263  * 0x10 = half qwerty,
       
   264  * 0x20 = custom qwerty
       
   265  */
       
   266 const TUint32 KAknFepPhysicalKeyboards = 0x0000001A;
       
   267 
       
   268 /**
       
   269  * Predictive Text Input On/Off.
       
   270  *
       
   271  * A bit vector indicating which input types have prediction on.
       
   272  *
       
   273  * Possible values:
       
   274  * 0: off
       
   275  * 1: on (default value)
       
   276  *
       
   277  * (bitmask values in EKeyboardStyle)
       
   278  *
       
   279  * 0x01 = ITU-T (12-key) predictive input (should match KAknFepPredTxtFlag)
       
   280  * 0x02 = Qwerty predictive input
       
   281  */
       
   282 const TUint32 KAknFepPredTxtFlagExtension = 0x0000001B;
       
   283 
       
   284 /**
       
   285  * Secondary Input Text Language, integer value.
       
   286  *
       
   287  * Possible values:
       
   288  * 0 (none)
       
   289  * valid Symbian OS language code
       
   290  *
       
   291  * Default value: 0
       
   292  */
       
   293 const TUint32 KAknFepInputTxtLangSecondary = 0x0000001C;
       
   294 
       
   295 /**
       
   296  * Indicate fullscreen qwerty(big one) key preview popup On/Off.
       
   297  *
       
   298  * Possible values:
       
   299  * 0: off
       
   300  * 1: on (default value)
       
   301  */
       
   302 const TUint32 KAknFepShowFsqPreview = 0x0000001D;
       
   303 
       
   304 /**
       
   305  * Indicate vkb (small one) preview popup On/Off.
       
   306  *
       
   307  * Possible values:
       
   308  * 0: off 
       
   309  * 1: on(default value)
       
   310  */
       
   311 const TUint32 KAknFepShowVkbPreview  = 0x0000001E;
       
   312 
       
   313 /**
       
   314  * the value stores the preferred virtual 
       
   315  * qwerty mode in landscape, there are two modes, 
       
   316  * FSQ the bigger one or VKB the smaller one. 
       
   317  * The mode values are from touch input types,  
       
   318  * EPluginInputModeHwr = 1, 
       
   319  * EPluginInputModeVkb = 2,
       
   320  * EPluginInputModeFSQ = 4,
       
   321  * EPluginInputModeItut = 8,
       
   322  * EPluginInputModeFSc = 16.
       
   323  * And only EPluginInputModeVkb and EPluginInputModeFSQ 
       
   324  * are valid here, and the default value is FSQ 4.
       
   325  */
       
   326 const TUint32 KAknFepLastUseVkbMode = 0x0000001F;
       
   327 
       
   328 /**
       
   329  * Long press number entry feature on (hybrid) QWERTY keyboard. When activated, long press of 
       
   330  * keyboard button can be used to enter the character normally mapped behind Fn modifier on that key. 
       
   331  * This setting has no effect if the keyboard does not have Fn key. Possible values: 0 (off), 1 (on)
       
   332  */
       
   333 const TUint32 KAknFepLongPressNumberEntryOnQwerty = 0x00000021;
       
   334 /**
       
   335  * Copy-pasting with shift + softkeys on QWERTY. When activated, text can be copied by holding 
       
   336  * shift depressed and pressing left softkey and pasted by holding shift depressed and pressing 
       
   337  * right softkey. Similar funtionality is anyway available on ITU-T keypads with the edit key; 
       
   338  * this setting affects only QWERTY keyboards. Possible values: 0 (off), 1 (on)
       
   339  */
       
   340 const TUint32 KAknFepShiftCopyPasteOnQwerty = 0x00000022;
       
   341 
       
   342 #endif
       
   343 
       
   344 // End of file