Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class RegionOverlap

java.lang.Object

java.lang.Enum<RegionOverlap>

org.freedesktop.cairo.RegionOverlap

All Implemented Interfaces:

Serializable, Comparable<RegionOverlap>, Constable

public enum RegionOverlap
extends Enum<RegionOverlap>

Used as the return value for cairo_region_contains_rectangle().

Since:

1.10

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
IN	The contents are entirely inside the region.
OUT	The contents are entirely outside the region.
PART	The contents are partially inside and partially outside the region.

Method Summary

Modifier and Type	Method	Description
static org.gnome.glib.Type	getType()	Get the CairoRegionOverlap GType
int	getValue()	Return the value of this enum
static RegionOverlap	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
static RegionOverlap	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RegionOverlap[]	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

IN

public static final RegionOverlap IN

The contents are entirely inside the region.

Since:

1.10

OUT

public static final RegionOverlap OUT

The contents are entirely outside the region.

Since:

1.10

PART

public static final RegionOverlap PART

The contents are partially inside and partially outside the region.

Since:

1.10

Method Details

values

public static RegionOverlap[] 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 RegionOverlap 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

getValue

public int getValue()

Return the value of this enum

Returns:

the value

of

public static RegionOverlap of(int ordinal)

Returns the enum constant for the given ordinal (its position in the enum declaration).

Parameters:

ordinal - the position in the enum declaration, starting from zero

Returns:

the enum constant for the given ordinal

getType

public static org.gnome.glib.Type getType()

Get the CairoRegionOverlap GType

Returns:

the GType