AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Update GtkAccessibleRole docs

Browse Source 
Sync up the docs with changed enum values, and document
all the roles that are used in GTK at the moment. All
others are left as "Unused".
This commit is contained in:
Matthias Clasen 2020-07-26 21:18:50 -04:00
parent 29abefbe61
commit 9a27614b41
1 changed files with 82 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

148
gtk/gtkenums.h
View File

@ -1156,80 +1156,96 @@ typedef enum {
* time-sensitive, information * time-sensitive, information
* @GTK_ACCESSIBLE_ROLE_ALERT_DIALOG: A type of dialog that contains an * @GTK_ACCESSIBLE_ROLE_ALERT_DIALOG: A type of dialog that contains an
* alert message * alert message
* @GTK_ACCESSIBLE_ROLE_APPLICATION: FIXME * @GTK_ACCESSIBLE_ROLE_BANNER: Unused
* @GTK_ACCESSIBLE_ROLE_ARTICLE: FIXME
* @GTK_ACCESSIBLE_ROLE_BANNER: FIXME
* @GTK_ACCESSIBLE_ROLE_BUTTON: An input element that allows for * @GTK_ACCESSIBLE_ROLE_BUTTON: An input element that allows for
* user-triggered actions when clicked or pressed * user-triggered actions when clicked or pressed
* @GTK_ACCESSIBLE_ROLE_CAPTION: Unused
* @GTK_ACCESSIBLE_ROLE_CELL: Unused
* @GTK_ACCESSIBLE_ROLE_CHECKBOX: A checkable input element that has * @GTK_ACCESSIBLE_ROLE_CHECKBOX: A checkable input element that has
* three possible values: `true`, `false`, or `mixed` * three possible values: `true`, `false`, or `mixed`
* @GTK_ACCESSIBLE_ROLE_COLUMN_HEADER: FIXME * @GTK_ACCESSIBLE_ROLE_COLUMN_HEADER: Unused
* @GTK_ACCESSIBLE_ROLE_COMBOBOX: An input that controls another element, * @GTK_ACCESSIBLE_ROLE_COMBO_BOX: An input that controls another element,
* such as a list or a grid, that can dynamically pop up to help the user * such as a list or a grid, that can dynamically pop up to help the user
* set the value of the input * set the value of the input
* @GTK_ACCESSIBLE_ROLE_COMMAND: An abstract widget that performs an * @GTK_ACCESSIBLE_ROLE_COMMAND: An abstract widget that performs an
* action, but does not receive input * action, but does not receive input
* @GTK_ACCESSIBLE_ROLE_COMPLEMENTARY: FIXME * @GTK_ACCESSIBLE_ROLE_COMPOSITE: Unused
* @GTK_ACCESSIBLE_ROLE_COMPOSITE: FIXME * @GTK_ACCESSIBLE_ROLE_DIALOG: A dialog is a window that is designed to interrupt
* @GTK_ACCESSIBLE_ROLE_CONTENT_INFO: FIXME * the current processing of an application in order to prompt the user to enter
* @GTK_ACCESSIBLE_ROLE_DEFINITION: FIXME * information or require a response.
* @GTK_ACCESSIBLE_ROLE_DIALOG: FIXME * @GTK_ACCESSIBLE_ROLE_DOCUMENT: Unused
* @GTK_ACCESSIBLE_ROLE_DIRECTORY: FIXME * @GTK_ACCESSIBLE_ROLE_FEED: Unused
* @GTK_ACCESSIBLE_ROLE_DOCUMENT: FIXME * @GTK_ACCESSIBLE_ROLE_FORM: Unused
* @GTK_ACCESSIBLE_ROLE_FORM: FIXME * @GTK_ACCESSIBLE_ROLE_GENERIC: Unused
* @GTK_ACCESSIBLE_ROLE_GRID: FIXME * @GTK_ACCESSIBLE_ROLE_GRID: Unused
* @GTK_ACCESSIBLE_ROLE_GRID_CELL: FIXME * @GTK_ACCESSIBLE_ROLE_GRID_CELL: Unused
* @GTK_ACCESSIBLE_ROLE_GROUP: FIXME * @GTK_ACCESSIBLE_ROLE_GROUP: Unused
* @GTK_ACCESSIBLE_ROLE_HEADING: FIXME * @GTK_ACCESSIBLE_ROLE_HEADING: Unused
* @GTK_ACCESSIBLE_ROLE_IMG: FIXME * @GTK_ACCESSIBLE_ROLE_IMG: Unused
* @GTK_ACCESSIBLE_ROLE_INPUT: FIXME * @GTK_ACCESSIBLE_ROLE_INPUT: Unused
* @GTK_ACCESSIBLE_ROLE_LANDMARK: FIXME * @GTK_ACCESSIBLE_ROLE_LABEL: Unused
* @GTK_ACCESSIBLE_ROLE_LINK: FIXME * @GTK_ACCESSIBLE_ROLE_LANDMARK: Unused
* @GTK_ACCESSIBLE_ROLE_LIST_BOX: FIXME * @GTK_ACCESSIBLE_ROLE_LEGEND: Unused
* @GTK_ACCESSIBLE_ROLE_LIST_ITEM: FIXME * @GTK_ACCESSIBLE_ROLE_LINK: Unused
* @GTK_ACCESSIBLE_ROLE_LOG: FIXME * @GTK_ACCESSIBLE_ROLE_LIST_BOX: Unused
* @GTK_ACCESSIBLE_ROLE_MAIN: FIXME * @GTK_ACCESSIBLE_ROLE_LIST_ITEM: Unused
* @GTK_ACCESSIBLE_ROLE_MARQUEE: FIXME * @GTK_ACCESSIBLE_ROLE_LOG: Unused
* @GTK_ACCESSIBLE_ROLE_MATH: FIXME * @GTK_ACCESSIBLE_ROLE_MAIN: Unused
* @GTK_ACCESSIBLE_ROLE_MENU: FIXME * @GTK_ACCESSIBLE_ROLE_MARQUEE: Unused
* @GTK_ACCESSIBLE_ROLE_MENU_BAR: FIXME * @GTK_ACCESSIBLE_ROLE_METER: Unused
* @GTK_ACCESSIBLE_ROLE_MENU_ITEM: FIXME * @GTK_ACCESSIBLE_ROLE_MATH: Unused
* @GTK_ACCESSIBLE_ROLE_MENU_ITEM_CHECKBOX: FIXME * @GTK_ACCESSIBLE_ROLE_MENU: Unused
* @GTK_ACCESSIBLE_ROLE_MENU_ITEM_RADIO: FIXME * @GTK_ACCESSIBLE_ROLE_MENU_BAR: Unused
* @GTK_ACCESSIBLE_ROLE_NAVIGATION: FIXME * @GTK_ACCESSIBLE_ROLE_MENU_ITEM: Unused
* @GTK_ACCESSIBLE_ROLE_NOTE: FIXME * @GTK_ACCESSIBLE_ROLE_MENU_ITEM_CHECKBOX: Unused
* @GTK_ACCESSIBLE_ROLE_OPTION: FIXME * @GTK_ACCESSIBLE_ROLE_MENU_ITEM_RADIO: Unused
* @GTK_ACCESSIBLE_ROLE_PRESENTATION: FIXME * @GTK_ACCESSIBLE_ROLE_NAVIGATION: Unused
* @GTK_ACCESSIBLE_ROLE_PROGRESS_BAR: FIXME * @GTK_ACCESSIBLE_ROLE_NOTE: Unused
* @GTK_ACCESSIBLE_ROLE_RADIO: FIXME * @GTK_ACCESSIBLE_ROLE_OPTION: Unused
* @GTK_ACCESSIBLE_ROLE_RADIO_GROUP: FIXME * @GTK_ACCESSIBLE_ROLE_PRESENTATION: Unused
* @GTK_ACCESSIBLE_ROLE_RANGE: FIXME * @GTK_ACCESSIBLE_ROLE_PROGRESS_BAR: An element that displays the progress
* @GTK_ACCESSIBLE_ROLE_REGION: FIXME * status for tasks that take a long time.
* @GTK_ACCESSIBLE_ROLE_ROW: FIXME * @GTK_ACCESSIBLE_ROLE_RADIO: A checkable input in a group of radio roles,
* @GTK_ACCESSIBLE_ROLE_ROW_GROUP: FIXME * only one of which can be checked at a time.
* @GTK_ACCESSIBLE_ROLE_ROW_HEADER: FIXME * @GTK_ACCESSIBLE_ROLE_RADIO_GROUP: Unused
* @GTK_ACCESSIBLE_ROLE_SCROLLBAR: FIXME * @GTK_ACCESSIBLE_ROLE_RANGE: Unused
* @GTK_ACCESSIBLE_ROLE_SEARCH: FIXME * @GTK_ACCESSIBLE_ROLE_REGION: Unused
* @GTK_ACCESSIBLE_ROLE_SECTION: FIXME * @GTK_ACCESSIBLE_ROLE_ROW: Unused
* @GTK_ACCESSIBLE_ROLE_SECTION_HEAD: FIXME * @GTK_ACCESSIBLE_ROLE_ROW_GROUP: Unused
* @GTK_ACCESSIBLE_ROLE_SELECT: FIXME * @GTK_ACCESSIBLE_ROLE_ROW_HEADER: Unused
* @GTK_ACCESSIBLE_ROLE_SEPARATOR: FIXME * @GTK_ACCESSIBLE_ROLE_SCROLLBAR: A graphical object that controls the scrolling
* @GTK_ACCESSIBLE_ROLE_SLIDER: FIXME * of content within a viewing area, regardless of whether the content is fully
* @GTK_ACCESSIBLE_ROLE_SPIN_BUTTON: FIXME * displayed within the viewing area.
* @GTK_ACCESSIBLE_ROLE_STATUS: FIXME * @GTK_ACCESSIBLE_ROLE_SEARCH: Unused
* @GTK_ACCESSIBLE_ROLE_STRUCTURE: FIXME * @GTK_ACCESSIBLE_ROLE_SEARCH_BOX: Unused
* @GTK_ACCESSIBLE_ROLE_TAB: FIXME * @GTK_ACCESSIBLE_ROLE_SECTION: Unused
* @GTK_ACCESSIBLE_ROLE_TAB_LIST: FIXME * @GTK_ACCESSIBLE_ROLE_SECTION_HEAD: Unused
* @GTK_ACCESSIBLE_ROLE_TAB_PANEL: FIXME * @GTK_ACCESSIBLE_ROLE_SELECT: Unused
* @GTK_ACCESSIBLE_ROLE_TEXT_BOX: FIXME * @GTK_ACCESSIBLE_ROLE_SEPARATOR: A divider that separates and distinguishes
* @GTK_ACCESSIBLE_ROLE_TIMER: FIXME * sections of content or groups of menuitems.
* @GTK_ACCESSIBLE_ROLE_TOOLBAR: FIXME * @GTK_ACCESSIBLE_ROLE_SLIDER: A user input where the user selects a value
* @GTK_ACCESSIBLE_ROLE_TOOLTIP: FIXME * from within a given range.
* @GTK_ACCESSIBLE_ROLE_TREE: FIXME * @GTK_ACCESSIBLE_ROLE_SPIN_BUTTON: A form of range that expects the user to
* @GTK_ACCESSIBLE_ROLE_TREE_GRID: FIXME * select from among discrete choices.
* @GTK_ACCESSIBLE_ROLE_TREE_ITEM: FIXME * @GTK_ACCESSIBLE_ROLE_STATUS: Unused
* @GTK_ACCESSIBLE_ROLE_WIDGET: FIXME * @GTK_ACCESSIBLE_ROLE_STRUCTURE: Unused
* @GTK_ACCESSIBLE_ROLE_WINDOW: FIXME * @GTK_ACCESSIBLE_ROLE_SWITCH: A type of checkbox that represents on/off values,
* as opposed to checked/unchecked values.
* @GTK_ACCESSIBLE_ROLE_TAB: Unused
* @GTK_ACCESSIBLE_ROLE_TABLE: Unused
* @GTK_ACCESSIBLE_ROLE_TAB_LIST: Unused
* @GTK_ACCESSIBLE_ROLE_TAB_PANEL: Unused
* @GTK_ACCESSIBLE_ROLE_TEXT_BOX: Unused
* @GTK_ACCESSIBLE_ROLE_TIME: Unused
* @GTK_ACCESSIBLE_ROLE_TIMER: Unused
* @GTK_ACCESSIBLE_ROLE_TOOLBAR: Unused
* @GTK_ACCESSIBLE_ROLE_TOOLTIP: Unused
* @GTK_ACCESSIBLE_ROLE_TREE: Unused
* @GTK_ACCESSIBLE_ROLE_TREE_GRID: Unused
* @GTK_ACCESSIBLE_ROLE_TREE_ITEM: Unused
* @GTK_ACCESSIBLE_ROLE_WIDGET: An interactive component of a graphical user
* interface. This is the role that GTK uses by default for widgets.
* @GTK_ACCESSIBLE_ROLE_WINDOW: Unused
* *
* The accessible role for a #GtkAccessible implementation. * The accessible role for a #GtkAccessible implementation.
* *