Enum Class SnapshotRegion

java.lang.Object

java.lang.Enum<SnapshotRegion>

org.webkitgtk.SnapshotRegion

All Implemented Interfaces:

Serializable, Comparable<SnapshotRegion>, Constable, Enumeration

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

Enum values used to specify the region from which to get a WebKitWebView snapshot

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL_DOCUMENT	A snapshot of the entire document.
VISIBLE	Specifies a snapshot only for the area that is visible in the webview

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the SnapshotRegion class.
int	getValue()	Get the numeric value of this enum
static SnapshotRegion	of(int value)	Create a new SnapshotRegion for the provided value
static SnapshotRegion	of(MemorySegment address)	Create a new SnapshotRegion for the value in the provided memory address.
static SnapshotRegion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SnapshotRegion[]	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

VISIBLE

public static final SnapshotRegion VISIBLE

Specifies a snapshot only for the area that is visible in the webview

FULL_DOCUMENT

public static final SnapshotRegion FULL_DOCUMENT

A snapshot of the entire document.

Method Details

values

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

Create a new SnapshotRegion 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 SnapshotRegion of(MemorySegment address)

Create a new SnapshotRegion 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 SnapshotRegion class.

Returns:

the GType