61 Enumerates known keyboard types. Specific bits are reserved |
61 Enumerates known keyboard types. Specific bits are reserved |
62 for keyboard classes. For example all, qwerty based |
62 for keyboard classes. For example all, qwerty based |
63 keyboards have bit HbQwertyKeyboardMask set and all touch keypads have |
63 keyboards have bit HbQwertyKeyboardMask set and all touch keypads have |
64 bit HbTouchInputMask set. |
64 bit HbTouchInputMask set. |
65 */ |
65 */ |
66 enum HbKeyboardTypeFlag |
66 enum HbKeyboardTypeFlag { |
67 { |
67 HbKeyboardNone = 0x00000000, |
68 HbKeyboardNone = 0x00000000, |
68 |
69 |
69 HbKeyboard12Key = 0x00000001, /**< Deprecated, use HbKeyboardHardwarePortrait instead. */ |
70 HbKeyboard12Key = 0x00000001, /**< Conventional phone keypad */ |
70 HbKeyboardHardwarePortrait = HbKeyboard12Key, /**< Hardware keyboard for portrait orientation. */ |
71 |
71 HbKeyboardQwerty = 0x00000001 | HbQwertyKeyboardMask, /**< Deprecated, use HbKeyboardHardwareLandcape instead */ |
72 HbKeyboardQwerty = 0x00000001 | HbQwertyKeyboardMask, /**< Qwerty keyboard */ |
72 HbKeyboardHardwareLandcape = HbKeyboardQwerty, /**< Hardware keyboard for landscape mode. */ |
73 |
73 HbKeyboardVirtual12Key = 0x00000001 | HbTouchInputMask, /**< Deprecated, use HbKeyboardTouchPortrait instead. */ |
74 HbKeyboardVirtual12Key = 0x00000001 | HbTouchInputMask, /**< Touchscreen version of conventional phone keypad */ |
74 HbKeyboardTouchPortrait = HbKeyboardVirtual12Key, /**< Touch keyboard for portrait mode. */ |
75 HbKeyboardVirtualQwerty = 0x00000002 | HbTouchInputMask| HbQwertyKeyboardMask, /**< Touchscreen version of qwerty keyboard */ |
75 HbKeyboardVirtualQwerty = 0x00000002 | HbTouchInputMask | HbQwertyKeyboardMask, /**< Touchscreen version of qwerty keyboard */ |
76 HbKeyboardSctPortrait = 0x00000003 | HbTouchInputMask, /**< Special character selection keypad for portrait view */ |
76 HbKeyboardTouchLandscape = HbKeyboardVirtualQwerty, /**< Touch keyboard for landscape mode. */ |
77 HbKeyboardSctLandscape = 0x00000004 | HbTouchInputMask| HbQwertyKeyboardMask, /**< Special character selection keypad for landscape view */ |
77 HbKeyboardSctPortrait = 0x00000003 | HbTouchInputMask, /**< Special character selection keypad for portrait view */ |
78 HbKeyboardHwr = 0x00000005 | HbTouchInputMask| HbHwrKeyboardMask, /**< Hand writing recognition keypad */ |
78 HbKeyboardSctLandscape = 0x00000004 | HbTouchInputMask | HbQwertyKeyboardMask, /**< Special character selection keypad for landscape view */ |
79 HbKeyboardThaiStarSctPortrait = 0x00000006 | HbTouchInputMask, /**< Special character selection keypad for star key in Thai portrait view */ |
79 HbKeyboardHwr = 0x00000005 | HbTouchInputMask | HbHwrKeyboardMask, /**< Hand writing recognition keypad */ |
80 HbKeyboardThaiHashSctPortrait = 0x00000007 | HbTouchInputMask /**< Special character selection keypad for hash key in Thai portrait view */ |
80 HbKeyboardVirtual12KeyLabels = 0x00000006 | HbTouchInputMask /**< Key labels for virtual 12 key keyboard */ |
81 }; |
81 }; |
82 |
82 |
83 Q_DECLARE_FLAGS(HbKeyboardType, HbKeyboardTypeFlag) |
83 Q_DECLARE_FLAGS(HbKeyboardType, HbKeyboardTypeFlag) |
84 |
84 |
85 /*! |
85 /*! |
86 \enum HbInputModeType |
86 \enum HbInputModeType |
87 |
87 |
88 Enumerates known input modes. Specific bits are reserved |
88 Enumerates known input modes. Specific bits are reserved |
89 for classifying different input mode types. For example, all Chinese modes |
89 for classifying different input mode types. For example, all Chinese modes |
90 have bit HbChineseModeMask set and all Japanese modes have |
90 have bit HbChineseModeMask set and all Japanese modes have |
91 bit HbJapaneseModeMask set. HbInputModeCustom is a special case. |
91 bit HbJapaneseModeMask set. HbInputModeCustom is a special case. |
92 That input mode never appears in standard input mode set, but it must |
92 That input mode never appears in standard input mode set, but it must |
93 be activated separately from UI. |
93 be activated separately from UI. |
94 */ |
94 */ |
95 enum HbInputModeTypeFlag |
95 enum HbInputModeTypeFlag { |
96 { |
|
97 HbInputModeNone = 0x00000000, |
96 HbInputModeNone = 0x00000000, |
98 |
97 |
99 // Default mode |
98 // Default mode |
100 HbInputModeDefault = 0x00000001, /**< Default input mode. This may mean diffierent things for different languages. */ |
99 HbInputModeDefault = 0x00000001, /**< Default input mode. This may mean diffierent things for different languages. */ |
101 |
100 |
102 // Numeric input mode |
101 // Numeric input mode |
103 HbInputModeNumeric = 0x00000001 | HbNumericModeMask, /**< Numeric input mode */ |
102 HbInputModeNumeric = 0x00000001 | HbNumericModeMask, /**< Numeric input mode */ |
104 |
103 |
105 // Special modes for all languages |
104 // Special modes for all languages |
106 HbInputModeSpeechToText = 0x00000500, /**< Speech-to-text input mode */ |
105 HbInputModeSpeechToText = 0x00000500, /**< Speech-to-text input mode */ |
107 |
106 |
108 // Chinese modes |
107 // Chinese modes |
109 HbInputModePinyin = 0x00000001 | HbChineseModeMask, /**< Chinese PinYin input */ |
108 HbInputModePinyin = 0x00000001 | HbChineseModeMask, /**< Chinese PinYin input */ |
110 HbInputModeStroke = 0x00000002 | HbChineseModeMask, /**< Chinese Stroke input */ |
109 HbInputModeStroke = 0x00000002 | HbChineseModeMask, /**< Chinese Stroke input */ |
111 HbInputModeZhuyin = 0x00000003 | HbChineseModeMask, /**< Chinese ZhuYin input */ |
110 HbInputModeZhuyin = 0x00000003 | HbChineseModeMask, /**< Chinese ZhuYin input */ |
193 may declare a set of constraints that control its behaviour. Constraint |
188 may declare a set of constraints that control its behaviour. Constraint |
194 bits are set through editor interface class. |
189 bits are set through editor interface class. |
195 |
190 |
196 \sa HbEditorInterface |
191 \sa HbEditorInterface |
197 */ |
192 */ |
198 enum HbEditorConstraint |
193 enum HbEditorConstraint { |
199 { |
|
200 HbEditorConstraintNone = 0, |
194 HbEditorConstraintNone = 0, |
201 HbEditorConstraintAutoCompletingField = 0x01, /**< This is auto-completing editor. It remebers what has been typed previously to same editor class. */ |
195 HbEditorConstraintAutoCompletingField = 0x01, /**< This is auto-completing editor. It remembers what has been typed previously to same editor class. */ |
202 HbEditorConstraintIgnoreFocus = 0x02, /**< Editor rejects input framework focus. */ |
196 HbEditorConstraintIgnoreFocus = 0x02, /**< Editor rejects input framework focus. */ |
203 HbEditorConstraintFixedInputMode = 0x04, /**< Editor doesn't allow initial input mode to be changed. */ |
197 HbEditorConstraintFixedInputMode = 0x04, /**< Editor doesn't allow initial input mode to be changed. */ |
204 HbEditorConstraintLatinAlphabetOnly = 0x08 /**< Editor allows only languages and input modes that produce latin alphabets. */ |
198 HbEditorConstraintLatinAlphabetOnly = 0x08 /**< Editor allows only languages and input modes that produce latin alphabets. */ |
205 }; |
199 }; |
206 Q_DECLARE_FLAGS(HbEditorConstraints, HbEditorConstraint) |
200 Q_DECLARE_FLAGS(HbEditorConstraints, HbEditorConstraint) |
|
201 Q_DECLARE_OPERATORS_FOR_FLAGS(HbEditorConstraints) |
207 |
202 |
208 /*! |
203 /*! |
209 \enum HbInputDigitType |
204 \enum HbInputDigitType |
210 |
205 |
211 Enumerates known digit type settings. |
206 Enumerates known digit type settings. |
212 */ |
207 */ |
213 enum HbInputDigitType |
208 enum HbInputDigitType { |
214 { |
|
215 HbDigitTypeNone = 0, |
209 HbDigitTypeNone = 0, |
216 HbDigitTypeLatin, /**< Latin digits in use */ |
210 HbDigitTypeLatin, /**< Latin digits in use */ |
217 HbDigitTypeArabicIndic, /**< Arabic indic digits in use */ |
211 HbDigitTypeArabicIndic, /**< Arabic indic digits in use */ |
218 HbDigitTypeEasternArabic, /**< Eastern arabic digits in use */ |
212 HbDigitTypeEasternArabic, /**< Eastern arabic digits in use */ |
219 HbDigitTypeDevanagari /**< Devanagari digits in use */ |
213 HbDigitTypeDevanagari /**< Devanagari digits in use */ |
220 }; |
214 }; |
221 |
215 |
222 /*! |
216 /*! |
223 Enumerates operation modes for touch keypad. |
217 Enumerates operation modes for touch keypad. |
224 */ |
218 */ |
225 enum HbKeypadMode{ |
219 enum HbKeypadMode { |
226 EModeAbc, /**< Display aplhanumeric keypad */ |
220 EModeAbc, /**< Display aplhanumeric keypad */ |
227 EModeNumeric /**< Display number mode keypad */ |
221 EModeNumeric /**< Display number mode keypad */ |
228 }; |
222 }; |
229 |
223 |
230 /*! |
224 /*! |
231 Enumerates known editor classes. If this value is set through |
225 Enumerates known editor classes. If this value is set through |
232 HbEditorInterface, it will have an effect on some input functionality. |
226 HbEditorInterface, it will have an effect on some input functionality. |
233 */ |
227 */ |
234 enum HbInputEditorClass { |
228 enum HbInputEditorClass { |
235 HbInputEditorClassUnknown = 0, |
229 HbInputEditorClassUnknown = 0, |
236 HbInputEditorClassEmail, |
230 HbInputEditorClassEmail, |
237 HbInputEditorClassUrl, |
231 HbInputEditorClassUrl, |
238 HbInputEditorClassUsername, |
232 HbInputEditorClassUsername, |
239 HbInputEditorClassPassword, |
233 HbInputEditorClassPassword, |
240 HbInputEditorClassPhoneNumber, |
234 HbInputEditorClassPhoneNumber, |
241 HbInputEditorClassStreetAddress, |
235 HbInputEditorClassStreetAddress, |
242 HbInputEditorClassZipCode, |
236 HbInputEditorClassZipCode, |
243 HbInputEditorClassSIPAddress, |
237 HbInputEditorClassSIPAddress, |
244 HbInputEditorClassFirstName, |
238 HbInputEditorClassFirstName, |
245 HbInputEditorClassLastName, |
239 HbInputEditorClassLastName, |
246 HbInputEditorClassFullName, |
240 HbInputEditorClassFullName, |
247 HbInputEditorClassFaxNumber, |
241 HbInputEditorClassFaxNumber, |
248 HbInputEditorClassTitle, |
242 HbInputEditorClassTitle, |
249 HbInputEditorClassProfession, |
243 HbInputEditorClassProfession, |
250 HbInputEditorClassCity, |
244 HbInputEditorClassCity, |
251 HbInputEditorClassDestination, |
245 HbInputEditorClassDestination, |
252 HbInputEditorClassNetworkDomain, |
246 HbInputEditorClassNetworkDomain, |
253 HbInputEditorClassNetworkName, |
247 HbInputEditorClassNetworkName, |
254 |
248 |
255 HbInputEditorClassLastItem // Keep this last, but never use. |
249 HbInputEditorClassLastItem // Keep this last, but never use. |
256 }; |
250 }; |
257 |
251 |
258 /*! |
252 /*! |
259 Enumerates primary candidate modes. |
253 Enumerates primary candidate modes. |
260 */ |
254 */ |
261 enum HbPrimaryCandidateMode{ |
255 enum HbPrimaryCandidateMode { |
262 HbPrimaryCandidateModeBestPrediction, /**< Display best prediction as the primary candidate */ |
256 HbPrimaryCandidateModeBestPrediction, /**< Display best prediction as the primary candidate */ |
263 HbPrimaryCandidateModeExactTyping /**< Display exact typing as the primary candidate */ |
257 HbPrimaryCandidateModeExactTyping /**< Display exact typing as the primary candidate */ |
264 }; |
258 }; |
265 |
259 |
266 /*! |
260 /*! |
267 Enumerates typing correction levels. |
261 Enumerates typing correction levels. |
268 */ |
262 */ |
269 enum HbTypingCorrectionLevel{ |
263 enum HbTypingCorrectionLevel { |
270 HbTypingCorrectionLevelLow, |
264 HbTypingCorrectionLevelLow, |
271 HbTypingCorrectionLevelMedium, |
265 HbTypingCorrectionLevelMedium, |
272 HbTypingCorrectionLevelHigh |
266 HbTypingCorrectionLevelHigh |
273 }; |
267 }; |
274 |
268 |