Enum Class AccessibleProperty

java.lang.Object
java.lang.Enum<AccessibleProperty>
org.gnome.gtk.AccessibleProperty
All Implemented Interfaces:
Serializable, Comparable<AccessibleProperty>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum AccessibleProperty extends Enum<AccessibleProperty> implements Enumeration
The possible accessible properties of a Accessible.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTOCOMPLETE
    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for a combobox, searchbox, or textbox and specifies how predictions would be presented if they were made.
    DESCRIPTION
    Defines a string value that describes or annotates the current element.
    HAS_POPUP
    Indicates the availability of interactive popup element, such as menu or popover, that can be triggered by an element.
    HELP_TEXT
    Defines a string value that provides a description of non-standard keyboard interactions of the current element.
    KEY_SHORTCUTS
    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
    LABEL
    Defines a string value that labels the current element.
    LEVEL
    Defines the hierarchical level of an element within a structure.
    MODAL
    Indicates whether an element is modal when displayed.
    MULTI_LINE
    Indicates whether a text box accepts multiple lines of input or only a single line.
    MULTI_SELECTABLE
    Indicates that the user may select more than one item from the current selectable descendants.
    ORIENTATION
    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
    PLACEHOLDER
    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
    READ_ONLY
    Indicates that the element is not editable, but is otherwise operable.
    REQUIRED
    Indicates that user input is required on the element before a form may be submitted.
    ROLE_DESCRIPTION
    Defines a human-readable, author-localized description for the role of an element.
    SORT
    Indicates if items in a table or grid are sorted in ascending or descending order.
    VALUE_MAX
    Defines the maximum allowed value for a range widget.
    VALUE_MIN
    Defines the minimum allowed value for a range widget.
    VALUE_NOW
    Defines the current value for a range widget.
    VALUE_TEXT
    Defines the human readable text alternative of Gtk.AccessibleProperty.VALUE_NOW for a range widget.

  • Method Summary

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

    • AUTOCOMPLETE

      public static final AccessibleProperty AUTOCOMPLETE
      Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for a combobox, searchbox, or textbox and specifies how predictions would be presented if they were made. Value type: AccessibleAutocomplete

    • DESCRIPTION

      public static final AccessibleProperty DESCRIPTION
      Defines a string value that describes or annotates the current element. Value type: string

    • HAS_POPUP

      public static final AccessibleProperty HAS_POPUP
      Indicates the availability of interactive popup element, such as menu or popover, that can be triggered by an element. Contrary to “aria-haspopup”, it doesn't indicate the type of the element, as such it cannot be used to indicate the availability of more complex elements such as dialog. Value type: boolean

    • KEY_SHORTCUTS

      public static final AccessibleProperty KEY_SHORTCUTS
      Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Value type: string. The format of the value is a space-separated list of shortcuts, with each shortcut consisting of one or more modifiers (Control, Alt or Shift), followed by a non-modifier key, all separated by +. The WAI-ARIA reference specifies how to build keyboard shortcuts strings, with specific values for each key which are the same regardless of the language, so these strings can't be built from localized key names. You can convert an accelerator into the matching key shortcuts label with Gtk.acceleratorGetAccessibleLabel(int, Set). Examples: F2, Alt+F, Control+Shift+N

    • LABEL

      public static final AccessibleProperty LABEL
      Defines a string value that labels the current element. Value type: string

    • LEVEL

      public static final AccessibleProperty LEVEL
      Defines the hierarchical level of an element within a structure. Value type: integer

    • MULTI_LINE

      public static final AccessibleProperty MULTI_LINE
      Indicates whether a text box accepts multiple lines of input or only a single line. Value type: boolean

    • MULTI_SELECTABLE

      public static final AccessibleProperty MULTI_SELECTABLE
      Indicates that the user may select more than one item from the current selectable descendants. Value type: boolean

    • ORIENTATION

      public static final AccessibleProperty ORIENTATION
      Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. Value type: Orientation

    • PLACEHOLDER

      public static final AccessibleProperty PLACEHOLDER
      Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. Value type: string

    • READ_ONLY

      public static final AccessibleProperty READ_ONLY
      Indicates that the element is not editable, but is otherwise operable. Value type: boolean

    • REQUIRED

      public static final AccessibleProperty REQUIRED
      Indicates that user input is required on the element before a form may be submitted. Value type: boolean

    • ROLE_DESCRIPTION

      public static final AccessibleProperty ROLE_DESCRIPTION
      Defines a human-readable, author-localized description for the role of an element. Value type: string

    • SORT

      public static final AccessibleProperty SORT
      Indicates if items in a table or grid are sorted in ascending or descending order. Value type: AccessibleSort

    • VALUE_MAX

      public static final AccessibleProperty VALUE_MAX
      Defines the maximum allowed value for a range widget. Value type: double

    • VALUE_MIN

      public static final AccessibleProperty VALUE_MIN
      Defines the minimum allowed value for a range widget. Value type: double

    • VALUE_NOW

      public static final AccessibleProperty VALUE_NOW
      Defines the current value for a range widget. Value type: double

    • VALUE_TEXT

      public static final AccessibleProperty VALUE_TEXT
      Defines the human readable text alternative of Gtk.AccessibleProperty.VALUE_NOW for a range widget. Value type: string

    • HELP_TEXT

      public static final AccessibleProperty HELP_TEXT
      Defines a string value that provides a description of non-standard keyboard interactions of the current element. Value type: string
      Since:
      4.16

  • Method Details

    • values

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

    • initValue

      public void initValue(Value value)

      Initializes value with the appropriate type for the property.

      This function is mostly meant for language bindings, in conjunction with gtk_accessible_update_property_value().

      Parameters:
      value - an uninitialized GValue