InputPurpose

InputPurpose

Description:

[ CCode ( cprefix = "IBUS_INPUT_PURPOSE_" , type_id = "ibus_input_purpose_get_type ()" ) ]
[ Version ( since = "1.5.4" ) ]
public enum InputPurpose

Describes primary purpose of the input context.

This information is particularly useful to implement intelligent behavior in engines, such as automatic input-mode switch and text prediction.

Note that the purpose is not meant to impose a totally strict rule about allowed characters, and does not replace input validation. It is fine for an on-screen keyboard to let the user override the character set restriction that is expressed by the purpose. The application is expected to validate the entry contents, even if it specified a purpose.

The difference between IBUS_INPUT_PURPOSE_DIGITS and IBUS_INPUT_PURPOSE_NUMBER is that the former accepts only digits while the latter also some punctuation (like commas or points, plus, minus) and “e” or “E” as in 3.14E+000.

This enumeration may be extended in the future; engines should interpret unknown values as 'free form'.

Namespace: IBus

Package: ibus-1.0

Content:

Enum values:

ALPHA - Allow only alphabetic characters
DATE - Input a date for the Wayland text-input protocol V1/V3.
DATETIME - Input a date and time for the Wayland text-input protocol V1/V3.
DIGITS - Allow only digits
EMAIL - Edited field expects email address
FREE_FORM - Allow any character
NAME - Edited field expects the name of a person
NUMBER - Edited field expects numbers
PASSWORD - Like IBUS_INPUT_PURPOSE_FREE_FORM, but characters are hidden
PHONE - Edited field expects phone number
PIN - Like IBUS_INPUT_PURPOSE_DIGITS, but characters are hidden
TERMINAL - Allow any character, in addition to control codes.
TIME - Input a time for the Wayland text-input protocol V1/V3.
URL - Edited field expects URL