Enumeration (GI Enum)

Gtk-4.0 ▶ Gtk ▶ 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 Gtk.InputPurpose.DIGITS and Gtk.InputPurpose.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”.

Index
ALPHA DIGITS EMAIL FREE_FORM NAME NUMBER PASSWORD PHONE PIN TERMINAL URL
ALPHA: 1

Allow only alphabetic characters

DIGITS: 2

Allow only digits

EMAIL: 6

Edited field expects email address

FREE_FORM: 0

Allow any character

NAME: 7

Edited field expects the name of a person

NUMBER: 3

Edited field expects numbers

PASSWORD: 8

Like Gtk.InputPurpose.FREE_FORM, but characters are hidden

PHONE: 4

Edited field expects phone number

PIN: 9

Like Gtk.InputPurpose.DIGITS, but characters are hidden

TERMINAL: 10

Allow any character, in addition to control codes

URL: 5

Edited field expects URL

Variables

$gtype