Enum Class Underline

java.lang.Object
java.lang.Enum<Underline>
org.gnome.pango.Underline
All Implemented Interfaces:
Serializable, Comparable<Underline>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum Underline extends Enum<Underline> implements Enumeration
The PangoUnderline enumeration is used to specify whether text should be underlined, and if so, the type of underlining.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DOUBLE
    a double underline should be drawn
    DOUBLE_LINE
    Like PANGOUNDERLINEDOUBLE, but drawn continuously across multiple runs.
    ERROR
    an underline indicating an error should be drawn below.
    ERROR_LINE
    Like PANGOUNDERLINEERROR, but drawn continuously across multiple runs.
    LOW
    a single underline should be drawn at a position beneath the ink extents of the text being underlined.
    NONE
    no underline should be drawn
    SINGLE
    a single underline should be drawn
    SINGLE_LINE
    Like PANGOUNDERLINESINGLE, but drawn continuously across multiple runs.

  • Method Summary

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

    • NONE

      public static final Underline NONE
      no underline should be drawn

    • SINGLE

      public static final Underline SINGLE
      a single underline should be drawn

    • DOUBLE

      public static final Underline DOUBLE
      a double underline should be drawn

    • LOW

      public static final Underline LOW
      a single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. SINGLE should be used for extended portions of text.

    • ERROR

      public static final Underline ERROR
      an underline indicating an error should be drawn below. The exact style of rendering is up to the PangoRenderer in use, but typical styles include wavy or dotted lines. This underline is typically used to indicate an error such as a possible mispelling; in some cases a contrasting color may automatically be used. This type of underlining is available since Pango 1.4.

    • SINGLE_LINE

      public static final Underline SINGLE_LINE
      Like PANGOUNDERLINESINGLE, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46.

    • DOUBLE_LINE

      public static final Underline DOUBLE_LINE
      Like PANGOUNDERLINEDOUBLE, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46.

    • ERROR_LINE

      public static final Underline ERROR_LINE
      Like PANGOUNDERLINEERROR, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46.

  • Method Details

    • values

      public static Underline[] 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 Underline 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 Underline of(int value)
      Create a new Underline 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 Underline of(MemorySegment address)
      Create a new Underline 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 Underline class.
      Returns:
      the GType