forked from AuroraMiddleware/gtk
docs: Add "Accessibility" section to various widgets
There are a few widgets that gained an accessible role, which means adding an "Accessibility" section in their description.
This commit is contained in:
parent
9ac4a7d99f
commit
08d59d3f68
@ -51,6 +51,10 @@
|
|||||||
* # CSS nodes
|
* # CSS nodes
|
||||||
*
|
*
|
||||||
* GtkBox uses a single CSS node with name box.
|
* GtkBox uses a single CSS node with name box.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkBox uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "config.h"
|
#include "config.h"
|
||||||
|
@ -50,6 +50,10 @@
|
|||||||
*
|
*
|
||||||
* In vertical orientation, the nodes of the children are arranged from top to
|
* In vertical orientation, the nodes of the children are arranged from top to
|
||||||
* bottom.
|
* bottom.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkCenterBox uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "config.h"
|
#include "config.h"
|
||||||
|
@ -1136,7 +1136,8 @@ typedef enum {
|
|||||||
* @GTK_ACCESSIBLE_ROLE_GENERIC: Unused
|
* @GTK_ACCESSIBLE_ROLE_GENERIC: Unused
|
||||||
* @GTK_ACCESSIBLE_ROLE_GRID: A grid of items.
|
* @GTK_ACCESSIBLE_ROLE_GRID: A grid of items.
|
||||||
* @GTK_ACCESSIBLE_ROLE_GRID_CELL: An item in a grid or tree grid.
|
* @GTK_ACCESSIBLE_ROLE_GRID_CELL: An item in a grid or tree grid.
|
||||||
* @GTK_ACCESSIBLE_ROLE_GROUP: Unused
|
* @GTK_ACCESSIBLE_ROLE_GROUP: An element that groups multiple widgets. GTK uses
|
||||||
|
* this role for various containers, like #GtkBox, #GtkViewport, and #GtkHeaderBar.
|
||||||
* @GTK_ACCESSIBLE_ROLE_HEADING: Unused
|
* @GTK_ACCESSIBLE_ROLE_HEADING: Unused
|
||||||
* @GTK_ACCESSIBLE_ROLE_IMG: An image.
|
* @GTK_ACCESSIBLE_ROLE_IMG: An image.
|
||||||
* @GTK_ACCESSIBLE_ROLE_INPUT: Abstract role.
|
* @GTK_ACCESSIBLE_ROLE_INPUT: Abstract role.
|
||||||
|
@ -50,7 +50,11 @@
|
|||||||
*
|
*
|
||||||
* # CSS nodes
|
* # CSS nodes
|
||||||
*
|
*
|
||||||
* GtkGrid uses a single CSS node with name grid.
|
* GtkGrid uses a single CSS node with name `grid`.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkGrid uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
typedef struct
|
typedef struct
|
||||||
|
@ -96,13 +96,17 @@
|
|||||||
* ╰── windowcontrols.end
|
* ╰── windowcontrols.end
|
||||||
* ]|
|
* ]|
|
||||||
*
|
*
|
||||||
* A #GtkHeaderBar's CSS node is called headerbar. It contains a windowhandle
|
* A #GtkHeaderBar's CSS node is called `headerbar`. It contains a `windowhandle`
|
||||||
* subnode, which contains a box subnode, which contains two box subnodes at
|
* subnode, which contains a `box` subnode, which contains two `box` subnodes at
|
||||||
* the start and end of the headerbar, as well as a center node that represents
|
* the start and end of the header bar, as well as a center node that represents
|
||||||
* the title.
|
* the title.
|
||||||
*
|
*
|
||||||
* Each of the boxes contains a windowcontrols subnode, see #GtkWindowControls
|
* Each of the boxes contains a `windowcontrols` subnode, see #GtkWindowControls
|
||||||
* for details, as well as other children.
|
* for details, as well as other children.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkHeaderBar uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define MIN_TITLE_CHARS 5
|
#define MIN_TITLE_CHARS 5
|
||||||
|
@ -126,30 +126,33 @@
|
|||||||
* ╰── <child>
|
* ╰── <child>
|
||||||
* ]|
|
* ]|
|
||||||
*
|
*
|
||||||
* GtkNotebook has a main CSS node with name notebook, a subnode
|
* GtkNotebook has a main CSS node with name `notebook`, a subnode
|
||||||
* with name header and below that a subnode with name tabs which
|
* with name `header` and below that a subnode with name `tabs` which
|
||||||
* contains one subnode per tab with name tab.
|
* contains one subnode per tab with name `tab`.
|
||||||
*
|
*
|
||||||
* If action widgets are present, their CSS nodes are placed next
|
* If action widgets are present, their CSS nodes are placed next
|
||||||
* to the tabs node. If the notebook is scrollable, CSS nodes with
|
* to the `tabs` node. If the notebook is scrollable, CSS nodes with
|
||||||
* name arrow are placed as first and last child of the tabs node.
|
* name `arrow` are placed as first and last child of the `tabs` node.
|
||||||
*
|
*
|
||||||
* The main node gets the .frame style class when the notebook
|
* The main node gets the `.frame` style class when the notebook
|
||||||
* has a border (see gtk_notebook_set_show_border()).
|
* has a border (see gtk_notebook_set_show_border()).
|
||||||
*
|
*
|
||||||
* The header node gets one of the style class .top, .bottom,
|
* The header node gets one of the style class `.top`, `.bottom`,
|
||||||
* .left or .right, depending on where the tabs are placed. For
|
* `.left` or `.right`, depending on where the tabs are placed. For
|
||||||
* reorderable pages, the tab node gets the .reorderable-page class.
|
* reorderable pages, the tab node gets the `.reorderable-page` class.
|
||||||
*
|
*
|
||||||
* A tab node gets the .dnd style class while it is moved with drag-and-drop.
|
* A `tab` node gets the `.dnd` style class while it is moved with drag-and-drop.
|
||||||
*
|
*
|
||||||
* The nodes are always arranged from left-to-right, regardless of text direction.
|
* The nodes are always arranged from left-to-right, regardless of text direction.
|
||||||
*
|
*
|
||||||
* # Accessibility
|
* # Accessibility
|
||||||
*
|
*
|
||||||
* GtkNotebook uses the #GTK_ACCESSIBLE_ROLE_TAB_LIST and
|
* GtkNotebook uses the following roles:
|
||||||
* #GTK_ACCESSIBLE_ROLE_TAB roles for its list of tabs and the
|
*
|
||||||
* #GTK_ACCESSIBLE_ROLE_TAB_PANEL for the pages.
|
* - %GTK_ACCESSIBLE_ROLE_GROUP for the notebook widget
|
||||||
|
* - %GTK_ACCESSIBLE_ROLE_TAB_LIST for the list of tabs
|
||||||
|
* - %GTK_ACCESSIBLE_ROLE_TAB role for each tab
|
||||||
|
* - %GTK_ACCESSIBLE_ROLE_TAB_PANEL for each page
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
@ -142,6 +142,10 @@
|
|||||||
*
|
*
|
||||||
* If both scrollbars are visible, the area where they meet is drawn
|
* If both scrollbars are visible, the area where they meet is drawn
|
||||||
* with a subnode named junction.
|
* with a subnode named junction.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkScrolledWindow uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
@ -53,7 +53,11 @@
|
|||||||
*
|
*
|
||||||
* # CSS nodes
|
* # CSS nodes
|
||||||
*
|
*
|
||||||
* GtkViewport has a single CSS node with name viewport.
|
* GtkViewport has a single CSS node with name `viewport`.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkViewport uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
typedef struct _GtkViewportPrivate GtkViewportPrivate;
|
typedef struct _GtkViewportPrivate GtkViewportPrivate;
|
||||||
|
@ -142,7 +142,7 @@
|
|||||||
*
|
*
|
||||||
* # Accessibility
|
* # Accessibility
|
||||||
*
|
*
|
||||||
* GtkWindow uses the #GTK_ACCESSIBLE_ROLE_WINDOW role.
|
* GtkWindow uses the %GTK_ACCESSIBLE_ROLE_WINDOW role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define MENU_BAR_ACCEL GDK_KEY_F10
|
#define MENU_BAR_ACCEL GDK_KEY_F10
|
||||||
|
@ -79,6 +79,10 @@
|
|||||||
* and #GtkWindowControls:decoration-layout value.
|
* and #GtkWindowControls:decoration-layout value.
|
||||||
*
|
*
|
||||||
* When #GtkWindowControls:empty is %TRUE, it gets the .empty style class.
|
* When #GtkWindowControls:empty is %TRUE, it gets the .empty style class.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkWindowHandle uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GtkWindowControls {
|
struct _GtkWindowControls {
|
||||||
|
@ -48,7 +48,11 @@
|
|||||||
*
|
*
|
||||||
* # CSS nodes
|
* # CSS nodes
|
||||||
*
|
*
|
||||||
* #GtkWindowHandle has a single CSS node with the name windowhandle.
|
* #GtkWindowHandle has a single CSS node with the name `windowhandle`.
|
||||||
|
*
|
||||||
|
* # Accessibility
|
||||||
|
*
|
||||||
|
* GtkWindowHandle uses the %GTK_ACCESSIBLE_ROLE_GROUP role.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GtkWindowHandle {
|
struct _GtkWindowHandle {
|
||||||
|
Loading…
Reference in New Issue
Block a user