Enum Class GravityHint

java.lang.Object

java.lang.Enum<GravityHint>

org.gnome.pango.GravityHint

All Implemented Interfaces:

Serializable, Comparable<GravityHint>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum GravityHint
extends Enum<GravityHint>
implements Enumeration

PangoGravityHint defines how horizontal scripts should behave in a vertical context.

That is, English excerpts in a vertical paragraph for example.

See also Pango.Gravity

Since:

1.16

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LINE	for scripts not in their natural direction (eg. Latin in East gravity), choose per-script gravity such that every script respects the line progression.
NATURAL	scripts will take their natural gravity based on the base gravity and the script.
STRONG	always use the base gravity set, regardless of the script.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NATURAL

public static final GravityHint NATURAL

scripts will take their natural gravity based on the base gravity and the script. This is the default.

STRONG

public static final GravityHint STRONG

always use the base gravity set, regardless of the script.

LINE

public static final GravityHint LINE

for scripts not in their natural direction (eg. Latin in East gravity), choose per-script gravity such that every script respects the line progression. This means, Latin and Arabic will take opposite gravities and both flow top-to-bottom for example.

Method Details

values

public static GravityHint[] 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 GravityHint 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 GravityHint of(int value)

Create a new GravityHint for the provided value

Parameters:

value - the enum value

Returns:

the enum 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

of

public static GravityHint of(MemorySegment address)

Create a new GravityHint for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the GravityHint class.

Returns:

the GType