InputPurpose

class InputPurpose

Describes primary purpose of the input widget.

This information is useful for on-screen keyboards and similar input methods to decide which keys should be presented to the user.

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 DIGITS and 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; input methods should interpret unknown values as “free form”.

Fields

class InputPurpose

ALPHA

Allow only alphabetic characters

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 FREE_FORM, but characters are hidden

PHONE

Edited field expects phone number

PIN

Like DIGITS, but characters are hidden

TERMINAL

Allow any character, in addition to control codes

URL

Edited field expects URL