src/hbcore/inputfw/hbinputdef.h
changeset 6 c3690ec91ef8
parent 5 627c4a0fd0e7
child 7 923ff622b8b9
--- a/src/hbcore/inputfw/hbinputdef.h	Fri Jun 11 13:58:22 2010 +0300
+++ b/src/hbcore/inputfw/hbinputdef.h	Wed Jun 23 18:33:25 2010 +0300
@@ -63,21 +63,21 @@
 keyboards have bit HbQwertyKeyboardMask set and all touch keypads have
 bit HbTouchInputMask set.
 */
-enum HbKeyboardTypeFlag
-{
-    HbKeyboardNone          				= 0x00000000,
+enum HbKeyboardTypeFlag {
+    HbKeyboardNone                          = 0x00000000,
 
-    HbKeyboard12Key         				= 0x00000001,       /**< Deprecated, use HbKeyboardHardwarePortrait instead. */
+    HbKeyboard12Key                         = 0x00000001,       /**< Deprecated, use HbKeyboardHardwarePortrait instead. */
     HbKeyboardHardwarePortrait                          = HbKeyboard12Key,  /**< Hardware keyboard for portrait orientation. */
-    HbKeyboardQwerty        				= 0x00000001 | HbQwertyKeyboardMask,  /**< Deprecated, use HbKeyboardHardwareLandcape instead */
+    HbKeyboardQwerty                        = 0x00000001 | HbQwertyKeyboardMask,  /**< Deprecated, use HbKeyboardHardwareLandcape instead */
     HbKeyboardHardwareLandcape                          = HbKeyboardQwerty, /**< Hardware keyboard for landscape mode. */
-    HbKeyboardVirtual12Key  				= 0x00000001 | HbTouchInputMask,    /**< Deprecated, use HbKeyboardTouchPortrait instead. */
+    HbKeyboardVirtual12Key                  = 0x00000001 | HbTouchInputMask,    /**< Deprecated, use HbKeyboardTouchPortrait instead. */
     HbKeyboardTouchPortrait                             = HbKeyboardVirtual12Key,           /**< Touch keyboard for portrait mode. */
-    HbKeyboardVirtualQwerty 				= 0x00000002 | HbTouchInputMask| HbQwertyKeyboardMask, /**< Touchscreen version of qwerty keyboard */
+    HbKeyboardVirtualQwerty                 = 0x00000002 | HbTouchInputMask | HbQwertyKeyboardMask, /**< Touchscreen version of qwerty keyboard */
     HbKeyboardTouchLandscape                            = HbKeyboardVirtualQwerty, /**< Touch keyboard for landscape mode. */
-    HbKeyboardSctPortrait   				= 0x00000003 | HbTouchInputMask,                       /**< Special character selection keypad for portrait view */
-    HbKeyboardSctLandscape  				= 0x00000004 | HbTouchInputMask| HbQwertyKeyboardMask, /**< Special character selection keypad for landscape view */
-    HbKeyboardHwr           				= 0x00000005 | HbTouchInputMask| HbHwrKeyboardMask    /**< Hand writing recognition keypad */
+    HbKeyboardSctPortrait                   = 0x00000003 | HbTouchInputMask,                       /**< Special character selection keypad for portrait view */
+    HbKeyboardSctLandscape                  = 0x00000004 | HbTouchInputMask | HbQwertyKeyboardMask, /**< Special character selection keypad for landscape view */
+    HbKeyboardHwr                           = 0x00000005 | HbTouchInputMask | HbHwrKeyboardMask,   /**< Hand writing recognition keypad */
+    HbKeyboardVirtual12KeyLabels            = 0x00000006 | HbTouchInputMask                        /**< Key labels for virtual 12 key keyboard */
 };
 
 Q_DECLARE_FLAGS(HbKeyboardType, HbKeyboardTypeFlag)
@@ -87,13 +87,12 @@
 
 Enumerates known input modes. Specific bits are reserved
 for classifying different input mode types. For example, all Chinese modes
-have bit HbChineseModeMask set and all Japanese modes have 
+have bit HbChineseModeMask set and all Japanese modes have
 bit HbJapaneseModeMask set. HbInputModeCustom is a special case.
 That input mode never appears in standard input mode set, but it must
-be activated separately from UI. 
+be activated separately from UI.
 */
-enum HbInputModeTypeFlag
-{
+enum HbInputModeTypeFlag {
     HbInputModeNone                    = 0x00000000,
 
     // Default mode
@@ -103,7 +102,7 @@
     HbInputModeNumeric                 = 0x00000001 | HbNumericModeMask,  /**< Numeric input mode */
 
     // Special modes for all languages
-    HbInputModeSpeechToText            = 0x00000500,                      /**< Speech-to-text input mode */ 
+    HbInputModeSpeechToText            = 0x00000500,                      /**< Speech-to-text input mode */
 
     // Chinese modes
     HbInputModePinyin                  = 0x00000001 | HbChineseModeMask,  /**< Chinese PinYin input */
@@ -124,7 +123,7 @@
     HbInputModeHwrLatinFull            = 0x00000002 | HbHwrModeMask,                       /**< Latin based hand writing recognition, full screen */
     HbInputModeHwrChinese              = 0x00000003 | HbHwrModeMask | HbChineseModeMask,   /**< Chinese hand writing recognition */
     HbInputModeHwrChineseFull          = 0x00000004 | HbHwrModeMask | HbChineseModeMask,   /**< Chinese hand writing recognition, full screen */
-          
+
     // Custom made mode that does not belong to any pre-existing category
     HbInputModeCustom                  = HbChineseModeMask - 1             /**< Custom input mode */
 };
@@ -137,8 +136,7 @@
 shift, fn and chr keys. If a modifier bit is set, then the corresponding key
 is pressed.
 */
-enum HbModifier
-{
+enum HbModifier {
     HbModifierNone         = 0x00000000,
     HbModifierShiftPressed = 0x00000001,     /**< Shift-key is pressed */
     HbModifierChrPressed   = 0x00000002,     /**< Chr-key is pressed */
@@ -151,8 +149,7 @@
 
 Enumerates keyboard setting flags.
 */
-enum HbKeyboardSettingFlag
-{
+enum HbKeyboardSettingFlag {
     HbKeyboardSettingNone         = 0x00000000,
     HbKeyboardSetting12key        = 0x00000001,
     HbKeyboardSettingQwerty       = 0x00000010
@@ -166,8 +163,7 @@
 where the framework automatically tries to conclude when upper case
 state is needed.
 */
-enum HbTextCase
-{
+enum HbTextCase {
     HbTextCaseNone,
     HbTextCaseLower,             /**< Lower text case. */
     HbTextCaseUpper,             /**< Upper text case. */
@@ -179,8 +175,7 @@
 
 Enumerates possible states for Fn key.
 */
-enum HbFnState
-{
+enum HbFnState {
     HbFnOff,    /**< Fn key inactive. */
     HbFnNext,   /**< Fn key active for the next keypress. */
     HbFnOn      /**< Fn key locked as active. */
@@ -195,10 +190,9 @@
 
 \sa HbEditorInterface
 */
-enum HbEditorConstraint
-{
+enum HbEditorConstraint {
     HbEditorConstraintNone                 = 0,
-    HbEditorConstraintAutoCompletingField  = 0x01,   /**< This is auto-completing editor. It remebers what has been typed previously to same editor class. */
+    HbEditorConstraintAutoCompletingField  = 0x01,   /**< This is auto-completing editor. It remembers what has been typed previously to same editor class. */
     HbEditorConstraintIgnoreFocus          = 0x02,   /**< Editor rejects input framework focus. */
     HbEditorConstraintFixedInputMode       = 0x04,   /**< Editor doesn't allow initial input mode to be changed. */
     HbEditorConstraintLatinAlphabetOnly    = 0x08    /**< Editor allows only languages and input modes that produce latin alphabets. */
@@ -210,8 +204,7 @@
 
 Enumerates known digit type settings.
 */
-enum HbInputDigitType
-{
+enum HbInputDigitType {
     HbDigitTypeNone = 0,
     HbDigitTypeLatin,          /**< Latin digits in use */
     HbDigitTypeArabicIndic,    /**< Arabic indic digits in use */
@@ -220,11 +213,11 @@
 };
 
 /*!
-Enumerates operation modes for touch keypad. 
+Enumerates operation modes for touch keypad.
 */
-enum HbKeypadMode{
+enum HbKeypadMode {
     EModeAbc,        /**< Display aplhanumeric keypad */
-    EModeNumeric     /**< Display number mode keypad */ 
+    EModeNumeric     /**< Display number mode keypad */
 };
 
 /*!
@@ -232,33 +225,33 @@
 HbEditorInterface, it will have an effect on some input functionality.
 */
 enum HbInputEditorClass {
-     HbInputEditorClassUnknown = 0,
-     HbInputEditorClassEmail,
-     HbInputEditorClassUrl,
-     HbInputEditorClassUsername,
-     HbInputEditorClassPassword,
-     HbInputEditorClassPhoneNumber,
-     HbInputEditorClassStreetAddress,
-     HbInputEditorClassZipCode,
-     HbInputEditorClassSIPAddress,
-     HbInputEditorClassFirstName,
-     HbInputEditorClassLastName,
-     HbInputEditorClassFullName,
-     HbInputEditorClassFaxNumber,
-     HbInputEditorClassTitle,
-     HbInputEditorClassProfession,
-     HbInputEditorClassCity,
-     HbInputEditorClassDestination,
-     HbInputEditorClassNetworkDomain,
-     HbInputEditorClassNetworkName,     
+    HbInputEditorClassUnknown = 0,
+    HbInputEditorClassEmail,
+    HbInputEditorClassUrl,
+    HbInputEditorClassUsername,
+    HbInputEditorClassPassword,
+    HbInputEditorClassPhoneNumber,
+    HbInputEditorClassStreetAddress,
+    HbInputEditorClassZipCode,
+    HbInputEditorClassSIPAddress,
+    HbInputEditorClassFirstName,
+    HbInputEditorClassLastName,
+    HbInputEditorClassFullName,
+    HbInputEditorClassFaxNumber,
+    HbInputEditorClassTitle,
+    HbInputEditorClassProfession,
+    HbInputEditorClassCity,
+    HbInputEditorClassDestination,
+    HbInputEditorClassNetworkDomain,
+    HbInputEditorClassNetworkName,
 
-     HbInputEditorClassLastItem          // Keep this last, but never use.
+    HbInputEditorClassLastItem          // Keep this last, but never use.
 };
 
 /*!
 Enumerates primary candidate modes.
 */
-enum HbPrimaryCandidateMode{
+enum HbPrimaryCandidateMode {
     HbPrimaryCandidateModeBestPrediction,        /**< Display best prediction as the primary candidate */
     HbPrimaryCandidateModeExactTyping            /**< Display exact typing as the primary candidate */
 };
@@ -266,7 +259,7 @@
 /*!
 Enumerates typing correction levels.
 */
-enum HbTypingCorrectionLevel{
+enum HbTypingCorrectionLevel {
     HbTypingCorrectionLevelLow,
     HbTypingCorrectionLevelMedium,
     HbTypingCorrectionLevelHigh