Package org.gnome.gtk

Enum Class InputHints

java.lang.Object

java.lang.Enum<InputHints>

org.gnome.gtk.InputHints

All Implemented Interfaces:

Enumeration, Serializable, Comparable<InputHints>, Constable

@Generated("io.github.jwharm.JavaGI")
public enum InputHints
extends Enum<InputHints>
implements Enumeration

Describes hints that might be taken into account by input methods or applications.

Note that input methods may already tailor their behaviour according to the InputPurpose of the entry.

Some common sense is expected when using these flags - mixing LOWERCASE with any of the uppercase hints makes no sense.

This enumeration may be extended in the future; input methods should ignore unknown values.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMOJI	Suggest offering Emoji support
INHIBIT_OSK	Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).
LOWERCASE	Suggest to convert all text to lowercase
NO_EMOJI	Suggest not offering Emoji support
NO_SPELLCHECK	Suggest not checking for typos
NONE	No special behaviour suggested
PRIVATE	Request that the input method should not update personalized data (like typing history)
SPELLCHECK	Suggest checking for typos
UPPERCASE_CHARS	Suggest to capitalize all text
UPPERCASE_SENTENCES	Suggest to capitalize the first word of each sentence
UPPERCASE_WORDS	Suggest to capitalize the first character of each word
VERTICAL_WRITING	The text is vertical
WORD_COMPLETION	Suggest word completion

Method Summary

Modifier and Type	Method	Description
static Type	getType()	Get the GType of the InputHints class
int	getValue()	Get the numeric value of this enum
static InputHints	of(int value)	Create a new InputHints for the provided value
static InputHints	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InputHints[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final InputHints NONE

No special behaviour suggested

SPELLCHECK

public static final InputHints SPELLCHECK

Suggest checking for typos

NO_SPELLCHECK

public static final InputHints NO_SPELLCHECK

Suggest not checking for typos

WORD_COMPLETION

public static final InputHints WORD_COMPLETION

Suggest word completion

LOWERCASE

public static final InputHints LOWERCASE

Suggest to convert all text to lowercase

UPPERCASE_CHARS

public static final InputHints UPPERCASE_CHARS

Suggest to capitalize all text

UPPERCASE_WORDS

public static final InputHints UPPERCASE_WORDS

Suggest to capitalize the first character of each word

UPPERCASE_SENTENCES

public static final InputHints UPPERCASE_SENTENCES

Suggest to capitalize the first word of each sentence

INHIBIT_OSK

public static final InputHints INHIBIT_OSK

Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).

VERTICAL_WRITING

public static final InputHints VERTICAL_WRITING

The text is vertical

EMOJI

public static final InputHints EMOJI

Suggest offering Emoji support

NO_EMOJI

public static final InputHints NO_EMOJI

Suggest not offering Emoji support

PRIVATE

public static final InputHints PRIVATE

Request that the input method should not update personalized data (like typing history)

Method Details

values

public static InputHints[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static InputHints valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static InputHints of(int value)

Create a new InputHints for the provided value

Parameters:

value - the bitfield value

Returns:

the bitfield for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

getType

public static Type getType()

Get the GType of the InputHints class

Returns:

the GType