Enum Class AccessibleRole

java.lang.Object
java.lang.Enum<AccessibleRole>
org.gnome.gtk.AccessibleRole
All Implemented Interfaces:
Serializable, Comparable<AccessibleRole>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum AccessibleRole extends Enum<AccessibleRole> implements Enumeration

The accessible role for a Accessible implementation.

Abstract roles are only used as part of the ontology; application developers must not use abstract roles in their code.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALERT
    An element with important, and usually time-sensitive, information
    ALERT_DIALOG
    A type of dialog that contains an alert message
    APPLICATION
    A toplevel element of a graphical user interface.
    ARTICLE
    A section of a page that consists of a composition that forms an independent part of a document, page, or site.
    BANNER
    Unused
    BLOCK_QUOTE
    A section of content that is quoted from another source.
    BUTTON
    An input element that allows for user-triggered actions when clicked or pressed
    CAPTION
    Unused
    CELL
    Unused
    CHECKBOX
    A checkable input element that has three possible values: true, false, or mixed
    COLUMN_HEADER
    A header in a columned list.
    COMBO_BOX
    An input that controls another element, such as a list or a grid, that can dynamically pop up to help the user set the value of the input
    COMMAND
    Abstract role.
    COMMENT
    A comment contains content expressing reaction to other content.
    COMPOSITE
    Abstract role.
    DIALOG
    A dialog is a window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response.
    DOCUMENT
    Content that assistive technology users may want to browse in a reading mode.
    FEED
    Unused
    FORM
    Unused
    GENERIC
    A nameless container that has no semantic meaning of its own.
    GRID
    A grid of items.
    GRID_CELL
    An item in a grid or tree grid.
    GROUP
    An element that groups multiple related widgets.
    HEADING
    Unused
    IMG
    An image.
    INPUT
    Abstract role.
    LABEL
    A visible name or caption for a user interface component.
    LANDMARK
    Abstract role.
    LEGEND
    Unused
    LINK
    A clickable link.
    LIST
    A list of items.
    LIST_BOX
    Unused.
    LIST_ITEM
    An item in a list.
    LOG
    Unused
    MAIN
    Unused
    MARQUEE
    Unused
    MATH
    Unused
    MENU
    A menu.
    MENU_BAR
    A menubar.
    MENU_ITEM
    An item in a menu.
    MENU_ITEM_CHECKBOX
    A check item in a menu.
    MENU_ITEM_RADIO
    A radio item in a menu.
    METER
    An element that represents a value within a known range.
    NAVIGATION
    Unused
    NONE
    An element that is not represented to accessibility technologies.
    NOTE
    Unused
    OPTION
    Unused
    PARAGRAPH
    A paragraph of content.
    PRESENTATION
    An element that is not represented to accessibility technologies.
    PROGRESS_BAR
    An element that displays the progress status for tasks that take a long time.
    RADIO
    A checkable input in a group of radio roles, only one of which can be checked at a time.
    RADIO_GROUP
    Unused
    RANGE
    Abstract role.
    REGION
    Unused
    ROW
    A row in a columned list.
    ROW_GROUP
    Unused
    ROW_HEADER
    Unused
    SCROLLBAR
    A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.
    SEARCH
    Unused
    SEARCH_BOX
    A type of textbox intended for specifying search criteria.
    SECTION
    Abstract role.
    SECTION_HEAD
    Abstract role.
    SELECT
    Abstract role.
    SEPARATOR
    A divider that separates and distinguishes sections of content or groups of menuitems.
    SLIDER
    A user input where the user selects a value from within a given range.
    SPIN_BUTTON
    A form of range that expects the user to select from among discrete choices.
    STATUS
    Unused
    STRUCTURE
    Abstract role.
    SWITCH
    A type of checkbox that represents on/off values, as opposed to checked/unchecked values.
    TAB
    An item in a list of tab used for switching pages.
    TAB_LIST
    A list of tabs for switching pages.
    TAB_PANEL
    A page in a notebook or stack.
    TABLE
    Unused
    TERMINAL
    A virtual terminal.
    TEXT_BOX
    A type of input that allows free-form text as its value.
    TIME
    Unused
    TIMER
    Unused
    TOGGLE_BUTTON
    A type of push button which stays pressed until depressed by a second activation.
    TOOLBAR
    Unused
    TOOLTIP
    Unused
    TREE
    Unused
    TREE_GRID
    A treeview-like, columned list.
    TREE_ITEM
    Unused
    WIDGET
    Abstract role for interactive components of a graphical user interface
    WINDOW
    Abstract role for windows.

  • Method Summary

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

    • ALERT

      public static final AccessibleRole ALERT
      An element with important, and usually time-sensitive, information

    • ALERT_DIALOG

      public static final AccessibleRole ALERT_DIALOG
      A type of dialog that contains an alert message

    • BUTTON

      public static final AccessibleRole BUTTON
      An input element that allows for user-triggered actions when clicked or pressed

    • CAPTION

      public static final AccessibleRole CAPTION
      Unused

    • CELL

      public static final AccessibleRole CELL
      Unused

    • CHECKBOX

      public static final AccessibleRole CHECKBOX
      A checkable input element that has three possible values: true, false, or mixed

    • COLUMN_HEADER

      public static final AccessibleRole COLUMN_HEADER
      A header in a columned list.

    • COMBO_BOX

      public static final AccessibleRole COMBO_BOX
      An input that controls another element, such as a list or a grid, that can dynamically pop up to help the user set the value of the input

    • COMMAND

      public static final AccessibleRole COMMAND
      Abstract role.

    • COMPOSITE

      public static final AccessibleRole COMPOSITE
      Abstract role.

    • DIALOG

      public static final AccessibleRole DIALOG
      A dialog is a window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response.

    • DOCUMENT

      public static final AccessibleRole DOCUMENT
      Content that assistive technology users may want to browse in a reading mode.

    • FEED

      public static final AccessibleRole FEED
      Unused

    • FORM

      public static final AccessibleRole FORM
      Unused

    • GENERIC

      public static final AccessibleRole GENERIC
      A nameless container that has no semantic meaning of its own. This is the role that GTK uses by default for widgets.

    • GRID

      public static final AccessibleRole GRID
      A grid of items.

    • GRID_CELL

      public static final AccessibleRole GRID_CELL
      An item in a grid or tree grid.

    • GROUP

      public static final AccessibleRole GROUP
      An element that groups multiple related widgets. GTK uses this role for various containers, like HeaderBar or Notebook.

    • HEADING

      public static final AccessibleRole HEADING
      Unused

    • IMG

      public static final AccessibleRole IMG
      An image.

    • INPUT

      public static final AccessibleRole INPUT
      Abstract role.

    • LABEL

      public static final AccessibleRole LABEL
      A visible name or caption for a user interface component.

    • LANDMARK

      public static final AccessibleRole LANDMARK
      Abstract role.

    • LEGEND

      public static final AccessibleRole LEGEND
      Unused

    • LIST

      public static final AccessibleRole LIST
      A list of items.

    • LIST_BOX

      public static final AccessibleRole LIST_BOX
      Unused.

    • LIST_ITEM

      public static final AccessibleRole LIST_ITEM
      An item in a list.

    • LOG

      public static final AccessibleRole LOG
      Unused

    • MAIN

      public static final AccessibleRole MAIN
      Unused

    • MARQUEE

      public static final AccessibleRole MARQUEE
      Unused

    • MATH

      public static final AccessibleRole MATH
      Unused

    • METER

      public static final AccessibleRole METER
      An element that represents a value within a known range.

    • NONE

      public static final AccessibleRole NONE
      An element that is not represented to accessibility technologies. This role is synonymous to GTKACCESSIBLEROLEPRESENTATION.

    • NOTE

      public static final AccessibleRole NOTE
      Unused

    • OPTION

      public static final AccessibleRole OPTION
      Unused

    • PRESENTATION

      public static final AccessibleRole PRESENTATION
      An element that is not represented to accessibility technologies. This role is synonymous to GTKACCESSIBLEROLENONE.

    • PROGRESS_BAR

      public static final AccessibleRole PROGRESS_BAR
      An element that displays the progress status for tasks that take a long time.

    • RADIO

      public static final AccessibleRole RADIO
      A checkable input in a group of radio roles, only one of which can be checked at a time.

    • RADIO_GROUP

      public static final AccessibleRole RADIO_GROUP
      Unused

    • RANGE

      public static final AccessibleRole RANGE
      Abstract role.

    • REGION

      public static final AccessibleRole REGION
      Unused

    • ROW

      public static final AccessibleRole ROW
      A row in a columned list.

    • ROW_GROUP

      public static final AccessibleRole ROW_GROUP
      Unused

    • ROW_HEADER

      public static final AccessibleRole ROW_HEADER
      Unused

    • SCROLLBAR

      public static final AccessibleRole SCROLLBAR
      A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.

    • SECTION

      public static final AccessibleRole SECTION
      Abstract role.

    • SECTION_HEAD

      public static final AccessibleRole SECTION_HEAD
      Abstract role.

    • SELECT

      public static final AccessibleRole SELECT
      Abstract role.

    • SEPARATOR

      public static final AccessibleRole SEPARATOR
      A divider that separates and distinguishes sections of content or groups of menuitems.

    • SLIDER

      public static final AccessibleRole SLIDER
      A user input where the user selects a value from within a given range.

    • SPIN_BUTTON

      public static final AccessibleRole SPIN_BUTTON
      A form of range that expects the user to select from among discrete choices.

    • STATUS

      public static final AccessibleRole STATUS
      Unused

    • STRUCTURE

      public static final AccessibleRole STRUCTURE
      Abstract role.

    • SWITCH

      public static final AccessibleRole SWITCH
      A type of checkbox that represents on/off values, as opposed to checked/unchecked values.

    • TAB

      public static final AccessibleRole TAB
      An item in a list of tab used for switching pages.

    • TABLE

      public static final AccessibleRole TABLE
      Unused

    • TAB_LIST

      public static final AccessibleRole TAB_LIST
      A list of tabs for switching pages.

    • TAB_PANEL

      public static final AccessibleRole TAB_PANEL
      A page in a notebook or stack.

    • TEXT_BOX

      public static final AccessibleRole TEXT_BOX
      A type of input that allows free-form text as its value.

    • TIME

      public static final AccessibleRole TIME
      Unused

    • TIMER

      public static final AccessibleRole TIMER
      Unused

    • TOOLBAR

      public static final AccessibleRole TOOLBAR
      Unused

    • TOOLTIP

      public static final AccessibleRole TOOLTIP
      Unused

    • TREE

      public static final AccessibleRole TREE
      Unused

    • TREE_GRID

      public static final AccessibleRole TREE_GRID
      A treeview-like, columned list.

    • TREE_ITEM

      public static final AccessibleRole TREE_ITEM
      Unused

    • WIDGET

      public static final AccessibleRole WIDGET
      Abstract role for interactive components of a graphical user interface

    • WINDOW

      public static final AccessibleRole WINDOW
      Abstract role for windows.

    • TOGGLE_BUTTON

      public static final AccessibleRole TOGGLE_BUTTON
      A type of push button which stays pressed until depressed by a second activation.
      Since:
      4.10

    • APPLICATION

      public static final AccessibleRole APPLICATION

      A toplevel element of a graphical user interface.

      This is the role that GTK uses by default for windows.

      Since:
      4.12

    • PARAGRAPH

      public static final AccessibleRole PARAGRAPH
      A paragraph of content.
      Since:
      4.14

    • BLOCK_QUOTE

      public static final AccessibleRole BLOCK_QUOTE
      A section of content that is quoted from another source.
      Since:
      4.14

    • ARTICLE

      public static final AccessibleRole ARTICLE
      A section of a page that consists of a composition that forms an independent part of a document, page, or site.
      Since:
      4.14

    • COMMENT

      public static final AccessibleRole COMMENT
      A comment contains content expressing reaction to other content.
      Since:
      4.14

    • TERMINAL

      public static final AccessibleRole TERMINAL
      A virtual terminal.
      Since:
      4.14

  • Method Details

    • values

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