Changeset View
Changeset View
Standalone View
Standalone View
src/lib/efl/interfaces/efl_input_text.eo
| 1 | enum @beta Efl.Input_Text.Panel_Layout_Type | 1 | enum Efl.Input_Text.Panel_Layout_Type | ||
|---|---|---|---|---|---|
| 2 | { | 2 | { | ||
| 3 | [[Input panel (virtual keyboard) layout types. | 3 | [[Input panel (virtual keyboard) layout types. | ||
| 4 | Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. | 4 | Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. | ||
| 5 | @since 1.24 | ||||
| 5 | ]] | 6 | ]] | ||
| 6 | normal, [[Default layout.]] | 7 | normal, [[Default layout.]] | ||
| 7 | number, [[Number layout.]] | 8 | number, [[Number layout.]] | ||
| 8 | email, [[Email layout.]] | 9 | email, [[Email layout.]] | ||
| 9 | url, [[URL layout.]] | 10 | url, [[URL layout.]] | ||
| 10 | phone_number, [[Phone Number layout.]] | 11 | phone_number, [[Phone Number layout.]] | ||
| 11 | ip, [[IP layout.]] | 12 | ip, [[IP layout.]] | ||
| 12 | month, [[Month layout.]] | 13 | month, [[Month layout.]] | ||
| 13 | number_only, [[Number Only layout.]] | 14 | number_only, [[Number Only layout.]] | ||
| 14 | invalid, [[Never use this.]] | 15 | invalid, [[Never use this.]] | ||
| 15 | hex, [[Hexadecimal layout.]] | 16 | hex, [[Hexadecimal layout.]] | ||
| 16 | terminal, [[Command-line terminal layout including esc, alt, ctrl key, so on (no auto-correct, no auto-capitalization).]] | 17 | terminal, [[Command-line terminal layout including esc, alt, ctrl key, so on (no auto-correct, no auto-capitalization).]] | ||
| 17 | password, [[Like normal, but no auto-correct, no auto-capitalization etc.]] | 18 | password, [[Like normal, but no auto-correct, no auto-capitalization etc.]] | ||
| 18 | datetime, [[Date and time layout.]] | 19 | datetime, [[Date and time layout.]] | ||
| 19 | emoticon, [[Emoticon layout.]] | 20 | emoticon, [[Emoticon layout.]] | ||
| 20 | voice [[Voice layout, but if the IME does not support voice layout, then normal layout will be shown.]] | 21 | voice [[Voice layout, but if the IME does not support voice layout, then normal layout will be shown.]] | ||
| 21 | } | 22 | } | ||
| 22 | 23 | | |||
| 23 | enum @beta Efl.Input_Text.Panel_Language_Type | 24 | enum Efl.Input_Text.Panel_Language_Type | ||
| 24 | { | 25 | { | ||
| 25 | [[Input panel (virtual keyboard) language modes. | 26 | [[Input panel (virtual keyboard) language modes. | ||
| 27 | @since 1.24 | ||||
| 26 | ]] | 28 | ]] | ||
| 27 | automatic, [[Automatic]] | 29 | automatic, [[Automatic]] | ||
| 28 | alphabet [[Alphabet]] | 30 | alphabet [[Alphabet]] | ||
| 29 | } | 31 | } | ||
| 30 | 32 | | |||
| 31 | enum @beta Efl.Input_Text.Capitalize_Type | 33 | enum Efl.Input_Text.Capitalize_Type | ||
| 32 | { | 34 | { | ||
| 33 | [[Autocapitalization Types. | 35 | [[Autocapitalization Types. | ||
| 34 | Choose method of auto-capitalization. | 36 | Choose method of auto-capitalization. | ||
| 37 | @since 1.24 | ||||
| 35 | ]] | 38 | ]] | ||
| 36 | none, [[No auto-capitalization when typing.]] | 39 | none, [[No auto-capitalization when typing.]] | ||
| 37 | word, [[Autocapitalize each word typed.]] | 40 | word, [[Autocapitalize each word typed.]] | ||
| 38 | sentence, [[Autocapitalize the start of each sentence.]] | 41 | sentence, [[Autocapitalize the start of each sentence.]] | ||
| 39 | all [[Autocapitalize all letters.]] | 42 | all [[Autocapitalize all letters.]] | ||
| 40 | } | 43 | } | ||
| 41 | 44 | | |||
| 42 | enum @beta Efl.Input_Text.Panel_Return_Key_Type | 45 | enum Efl.Input_Text.Panel_Return_Key_Type | ||
| 43 | { | 46 | { | ||
| 44 | [["Return" Key types on the input panel (virtual keyboard). | 47 | [["Return" Key types on the input panel (virtual keyboard). | ||
| 48 | @since 1.24 | ||||
| 45 | ]] | 49 | ]] | ||
| 46 | default, [[Default.]] | 50 | default, [[Default.]] | ||
| 47 | done, [[Done.]] | 51 | done, [[Done.]] | ||
| 48 | go, [[Go.]] | 52 | go, [[Go.]] | ||
| 49 | join, [[Join.]] | 53 | join, [[Join.]] | ||
| 50 | login, [[Login.]] | 54 | login, [[Login.]] | ||
| 51 | next, [[Next.]] | 55 | next, [[Next.]] | ||
| 52 | search, [[Search string or magnifier icon.]] | 56 | search, [[Search string or magnifier icon.]] | ||
| 53 | send, [[Send.]] | 57 | send, [[Send.]] | ||
| 54 | signin [[Sign-in.]] | 58 | signin [[Sign-in.]] | ||
| 55 | } | 59 | } | ||
| 56 | 60 | | |||
| 57 | enum @beta Efl.Input_Text.Panel_Return_Key_State | 61 | enum Efl.Input_Text.Panel_Return_Key_State | ||
| 58 | { | 62 | { | ||
| 59 | [["Return" Key state on the input panel (virtual keyboard). | 63 | [["Return" Key state on the input panel (virtual keyboard). | ||
| 64 | @since 1.24 | ||||
| 60 | ]] | 65 | ]] | ||
| 61 | auto, [[The return key on input panel is disabled when the entry has no text, | 66 | auto, [[The return key on input panel is disabled when the entry has no text, | ||
| 62 | if entry has text, return key is enabled. | 67 | if entry has text, return key is enabled. | ||
| 63 | ]] | 68 | ]] | ||
| 64 | enabled, [[The return key on input panel is enabled.]] | 69 | enabled, [[The return key on input panel is enabled.]] | ||
| 65 | disabled, [[The return key on input panel is disabled.]] | 70 | disabled, [[The return key on input panel is disabled.]] | ||
| 66 | } | 71 | } | ||
| 67 | 72 | | |||
| 68 | enum @beta Efl.Input_Text.Content_Type | 73 | enum Efl.Input_Text.Content_Type | ||
| 69 | { | 74 | { | ||
| 70 | [[Enumeration that defines the types of Input Hints.]] | 75 | [[Enumeration that defines the types of Input Hints. | ||
| 76 | @since 1.24]] | ||||
| 71 | none = 0, [[No active hints.]] | 77 | none = 0, [[No active hints.]] | ||
| 72 | auto_complete = 1 << 0, [[Suggest word auto completion.]] | 78 | auto_complete = 1 << 0, [[Suggest word auto completion.]] | ||
| 73 | sensitive_data = 1 << 1, [[Typed text should not be stored.]] | 79 | sensitive_data = 1 << 1, [[Typed text should not be stored.]] | ||
| 74 | autofill_credit_card_expiration_date = 0x100, [[ Autofill hint for a credit card expiration date.]] | 80 | autofill_credit_card_expiration_date = 0x100, [[ Autofill hint for a credit card expiration date.]] | ||
| 75 | autofill_credit_card_expiration_day = 0x200, [[Autofill hint for a credit card expiration day.]] | 81 | autofill_credit_card_expiration_day = 0x200, [[Autofill hint for a credit card expiration day.]] | ||
| 76 | autofill_credit_card_expiration_month = 0x300, [[ Autofill hint for a credit card expiration month.]] | 82 | autofill_credit_card_expiration_month = 0x300, [[ Autofill hint for a credit card expiration month.]] | ||
| 77 | autofill_credit_card_expiration_year = 0x400, [[ Autofill hint for a credit card expiration year.]] | 83 | autofill_credit_card_expiration_year = 0x400, [[ Autofill hint for a credit card expiration year.]] | ||
| 78 | autofill_credit_card_number = 0x500, [[ Autofill hint for a credit card number.]] | 84 | autofill_credit_card_number = 0x500, [[ Autofill hint for a credit card number.]] | ||
| Show All 26 Lines | |||||
| 105 | { | 111 | { | ||
| 106 | [[Enumeration for defining the types of @Efl.Input_Text.Panel_Layout_Type for normal variation.]] | 112 | [[Enumeration for defining the types of @Efl.Input_Text.Panel_Layout_Type for normal variation.]] | ||
| 107 | normal , [[The normal password layout.]] | 113 | normal , [[The normal password layout.]] | ||
| 108 | number_only , [[The password layout to allow only number.]] | 114 | number_only , [[The password layout to allow only number.]] | ||
| 109 | } | 115 | } | ||
| 110 | 116 | | |||
| 111 | 117 | | |||
| 112 | 118 | | |||
| 113 | interface @beta Efl.Input_Text { | 119 | interface Efl.Input_Text { | ||
| 114 | [[All the functionality relating to input hints | 120 | [[All the functionality relating to input hints/ | ||
| 121 | @since 1.24 | ||||
| 115 | ]] | 122 | ]] | ||
| 116 | methods { | 123 | methods { | ||
| 117 | @property input_panel_show_on_demand { | 124 | @property input_panel_show_on_demand { | ||
| 118 | [[Set/Get the attribute to show the input panel in case of only a user's explicit Mouse Up event. | 125 | [[Set/Get the attribute to show the input panel in case of only a user's explicit Mouse Up event. | ||
| 119 | It doesn't request to show the input panel even though it has focus.]] | 126 | It doesn't request to show the input panel even though it has focus.]] | ||
| 120 | set { | 127 | set { | ||
| 121 | } | 128 | } | ||
| 122 | get { | 129 | get { | ||
| 123 | } | 130 | } | ||
| 124 | values { | 131 | values { | ||
| 125 | ondemand: bool; [[If $true, the input panel will be shown in case of only Mouse up event. | 132 | ondemand: bool; [[If $true, the input panel will be shown in case of only Mouse up event. | ||
| 126 | (Focus event will be ignored.) | 133 | (Focus event will be ignored.) | ||
| 127 | ]] | 134 | ]] | ||
| 128 | } | 135 | } | ||
| 129 | } | 136 | } | ||
| 130 | 137 | | |||
| 131 | // FIXME: I don't understand why this is needed in addition to Layout | 138 | | ||
| 132 | @property input_panel_language { | 139 | @property input_panel_language { | ||
| 133 | [[The language mode of the input panel. | 140 | [[The language mode of the input panel. | ||
| 134 | This API can be used if you want to show the alphabet keyboard mode.]] | 141 | This API can be used if you want to show the alphabet keyboard mode.]] | ||
| 135 | set { | 142 | set { | ||
| 136 | } | 143 | } | ||
| 137 | get { | 144 | get { | ||
| 138 | } | 145 | } | ||
| 139 | values { | 146 | values { | ||
| Show All 9 Lines | 151 | @property input_panel_layout_variation { | |||
| 149 | } | 156 | } | ||
| 150 | get { | 157 | get { | ||
| 151 | } | 158 | } | ||
| 152 | values { | 159 | values { | ||
| 153 | variation: int; [[Layout variation type.]] | 160 | variation: int; [[Layout variation type.]] | ||
| 154 | } | 161 | } | ||
| 155 | } | 162 | } | ||
| 156 | 163 | | |||
| 157 | // FIXME: input_capitalize/capitalization ? | | |||
| 158 | @property autocapitalization { | 164 | @property autocapitalization { | ||
| 159 | [[The autocapitalization type on the immodule.]] | 165 | [[The autocapitalization type on the immodule.]] | ||
| 160 | set { | 166 | set { | ||
| 161 | } | 167 | } | ||
| 162 | get { | 168 | get { | ||
| 163 | } | 169 | } | ||
| 164 | values { | 170 | values { | ||
| 165 | autocapital_type: Efl.Input_Text.Capitalize_Type; [[The type of autocapitalization.]] | 171 | autocapital_type: Efl.Input_Text.Capitalize_Type; [[The type of autocapitalization.]] | ||
| 166 | } | 172 | } | ||
| 167 | } | 173 | } | ||
| 168 | 174 | | |||
| 169 | // FIXME: rename | | |||
| 170 | @property predictable { | 175 | @property predictable { | ||
| 171 | [[Whether the entry should allow predictive text.]] | 176 | [[Whether the entry should allow predictive text.]] | ||
| 172 | set { | 177 | set { | ||
| 173 | } | 178 | } | ||
| 174 | get { | 179 | get { | ||
| 175 | } | 180 | } | ||
| 176 | values { | 181 | values { | ||
| 177 | prediction: bool; [[Whether the entry should allow predictive text.]] | 182 | prediction: bool; [[Whether the entry should allow predictive text.]] | ||
| 178 | } | 183 | } | ||
| 179 | } | 184 | } | ||
| 180 | // FIXME: I agree with Mike, looks bad | 185 | | ||
| 181 | @property input_content_type @beta { | 186 | @property input_content_type @beta { | ||
| 182 | [[The input hint which allows input methods to fine-tune their behavior.]] | 187 | [[The input hint which allows input methods to fine-tune their behavior.]] | ||
| 183 | set { | 188 | set { | ||
| 184 | } | 189 | } | ||
| 185 | get { | 190 | get { | ||
| 186 | } | 191 | } | ||
| 187 | values { | 192 | values { | ||
| 188 | hints: Efl.Input_Text.Content_Type; [[Input hint.]] | 193 | hints: Efl.Input_Text.Content_Type; [[Input hint.]] | ||
| 189 | } | 194 | } | ||
| 190 | } | 195 | } | ||
| 196 | | ||||
| 191 | @property input_panel_layout { | 197 | @property input_panel_layout { | ||
| 192 | [[The input panel layout of the entry.]] | 198 | [[The input panel layout of the entry.]] | ||
| 193 | set { | 199 | set { | ||
| 194 | } | 200 | } | ||
| 195 | get { | 201 | get { | ||
| 196 | } | 202 | } | ||
| 197 | values { | 203 | values { | ||
| 198 | layout: Efl.Input_Text.Panel_Layout_Type(Efl.Input_Text.Panel_Layout_Type.invalid); [[Layout type.]] | 204 | layout: Efl.Input_Text.Panel_Layout_Type(Efl.Input_Text.Panel_Layout_Type.invalid); [[Layout type.]] | ||
| 199 | } | 205 | } | ||
| 200 | } | 206 | } | ||
| 207 | | ||||
| 201 | @property input_panel_return_key_type { | 208 | @property input_panel_return_key_type { | ||
| 202 | [[The "return" key type. This type is used to set string or icon on the "return" key of the input panel. | 209 | [[The "return" key type. This type is used to set string or icon on the "return" key of the input panel. | ||
| 203 | An input panel displays the string or icon associated with this type.]] | 210 | An input panel displays the string or icon associated with this type.]] | ||
| 204 | set { | 211 | set { | ||
| 205 | } | 212 | } | ||
| 206 | get { | 213 | get { | ||
| 207 | } | 214 | } | ||
| 208 | values { | 215 | values { | ||
| 209 | return_key_type: Efl.Input_Text.Panel_Return_Key_Type; [[The type of "return" key on the input panel.]] | 216 | return_key_type: Efl.Input_Text.Panel_Return_Key_Type; [[The type of "return" key on the input panel.]] | ||
| 210 | } | 217 | } | ||
| 211 | } | 218 | } | ||
| 212 | // FIXME: shouldn't this be "autoshow" or something? | 219 | | ||
| 213 | @property input_panel_autoshow { | 220 | @property input_panel_autoshow { | ||
| 214 | [[The attribute to show the input panel automatically.]] | 221 | [[The attribute to show the input panel automatically.]] | ||
| 215 | set { | 222 | set { | ||
| 216 | } | 223 | } | ||
| 217 | get { | 224 | get { | ||
| 218 | } | 225 | } | ||
| 219 | values { | 226 | values { | ||
| 220 | enabled: bool; [[If $true, the input panel is appeared when entry is clicked or has a focus.]] | 227 | enabled: bool; [[If $true, the input panel is appeared when entry is clicked or has a focus.]] | ||
| ▲ Show 20 Lines • Show All 42 Lines • Show Last 20 Lines | |||||