Package org.gnome.gdk
Enum Class ModifierType
- All Implemented Interfaces:
Enumeration,Serializable,Comparable<ModifierType>,Constable
@Generated("io.github.jwharm.JavaGI")
public enum ModifierType
extends Enum<ModifierType>
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.
Note that GDK may add internal values to events which include values outside
of this enumeration. Your code should preserve and ignore them. You can use
GDK_MODIFIER_MASK to remove all private values.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionthe fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key).the first mouse button.the second mouse button.the third mouse button.the fourth mouse button.the fifth mouse button.the Control key.the Hyper modifier.a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock).the Meta modifier.No modifier.the Shift key.the Super modifier. -
Method Summary
Modifier and TypeMethodDescriptionstatic TypegetType()Get the GType of the ModifierType classintgetValue()Get the numeric value of this enumstatic ModifierTypeof(int value) Create a new ModifierType for the provided valuestatic ModifierTypeReturns the enum constant of this class with the specified name.static ModifierType[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NO_MODIFIER_MASK
No modifier. -
SHIFT_MASK
the Shift key. -
LOCK_MASK
a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock). -
CONTROL_MASK
the Control key. -
ALT_MASK
the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key). -
BUTTON1_MASK
the first mouse button. -
BUTTON2_MASK
the second mouse button. -
BUTTON3_MASK
the third mouse button. -
BUTTON4_MASK
the fourth mouse button. -
BUTTON5_MASK
the fifth mouse button. -
SUPER_MASK
the Super modifier. -
HYPER_MASK
the Hyper modifier. -
META_MASK
the Meta modifier. Maps to Command on macOS.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
of
Create a new ModifierType 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:
getValuein interfaceEnumeration- Returns:
- the enum value
-
getType
-