Package org.freedesktop.gstreamer.video

Enum Class NavigationModifierType

java.lang.Object

java.lang.Enum<NavigationModifierType>

org.freedesktop.gstreamer.video.NavigationModifierType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<NavigationModifierType>, Constable

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

Flags to indicate the state of modifier keys and mouse buttons in events.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

Since:

1.22

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
BUTTON1_MASK	the first mouse button (usually the left button).
BUTTON2_MASK	the second mouse button (usually the right button).
BUTTON3_MASK	the third mouse button (usually the mouse wheel button or middle button).
BUTTON4_MASK	the fourth mouse button (typically the "Back" button).
BUTTON5_MASK	the fifth mouse button (typically the "forward" button).
CONTROL_MASK	the Control key.
HYPER_MASK	the Hyper modifier
LOCK_MASK
MASK	A mask covering all entries in GdkModifierType.
META_MASK	the Meta modifier
MOD1_MASK	the third modifier key
MOD2_MASK	the fourth modifier key
MOD3_MASK	the fifth modifier key
MOD4_MASK	the sixth modifier key
MOD5_MASK	the seventh modifier key
NONE
SHIFT_MASK	the Shift key.
SUPER_MASK	the Super modifier

Method Summary

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

SHIFT_MASK

public static final NavigationModifierType SHIFT_MASK

the Shift key.

LOCK_MASK

public static final NavigationModifierType LOCK_MASK

CONTROL_MASK

public static final NavigationModifierType CONTROL_MASK

the Control key.

MOD1_MASK

public static final NavigationModifierType MOD1_MASK

the third modifier key

MOD2_MASK

public static final NavigationModifierType MOD2_MASK

the fourth modifier key

MOD3_MASK

public static final NavigationModifierType MOD3_MASK

the fifth modifier key

MOD4_MASK

public static final NavigationModifierType MOD4_MASK

the sixth modifier key

MOD5_MASK

public static final NavigationModifierType MOD5_MASK

the seventh modifier key

BUTTON1_MASK

public static final NavigationModifierType BUTTON1_MASK

the first mouse button (usually the left button).

BUTTON2_MASK

public static final NavigationModifierType BUTTON2_MASK

the second mouse button (usually the right button).

BUTTON3_MASK

public static final NavigationModifierType BUTTON3_MASK

the third mouse button (usually the mouse wheel button or middle button).

BUTTON4_MASK

public static final NavigationModifierType BUTTON4_MASK

the fourth mouse button (typically the "Back" button).

BUTTON5_MASK

public static final NavigationModifierType BUTTON5_MASK

the fifth mouse button (typically the "forward" button).

SUPER_MASK

public static final NavigationModifierType SUPER_MASK

the Super modifier

HYPER_MASK

public static final NavigationModifierType HYPER_MASK

the Hyper modifier

META_MASK

public static final NavigationModifierType META_MASK

the Meta modifier

MASK

public static final NavigationModifierType MASK

A mask covering all entries in GdkModifierType.

Method Details

values

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

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

Returns:

the GType