accessibility.h

#include <modkit/accessibility.h>10 functions · 4 structs · 4 enums · 10 typedefs · 4 macros

Per-window accessibility snapshots and action dispatch.

Functions

mk_accessibility_action_event_initfunction

void mk_accessibility_action_event_init(mk_accessibility_action_event_t *event)

Initialize the accessibility action event.

Parameter	Type	Description
event	mk_accessibility_action_event_t *	Value for event.

mk_accessibility_node_initfunction

void mk_accessibility_node_init(mk_accessibility_node_t *node)

Initialize the accessibility node.

Parameter	Type	Description
node	mk_accessibility_node_t *	Value for node.

mk_accessibility_publish_snapshotfunction

mk_result mk_accessibility_publish_snapshot(mk_accessibility_window_t *window, const mk_accessibility_snapshot_t *snapshot)

Perform the accessibility publish snapshot operation.

Parameter	Type	Description
window	mk_accessibility_window_t *	Value for window.
snapshot	const mk_accessibility_snapshot_t *	Value for snapshot.

Returns MK_SUCCESS or an error result.

mk_accessibility_queue_actionfunction

mk_result mk_accessibility_queue_action(mk_accessibility_window_t *window, const mk_accessibility_action_event_t *event)

Backend entry point; the action is deep-copied and queued to the main loop.

Parameter	Type	Description
window	mk_accessibility_window_t *	Value for window.
event	const mk_accessibility_action_event_t *	Value for event.

Returns MK_SUCCESS or an error result.

mk_accessibility_snapshot_generationfunction

uint64_t mk_accessibility_snapshot_generation(const mk_accessibility_window_t *window)

Perform the accessibility snapshot generation operation.

Parameter	Type	Description
window	const mk_accessibility_window_t *	Value for window.

Returns The resulting value.

mk_accessibility_snapshot_initfunction

void mk_accessibility_snapshot_init(mk_accessibility_snapshot_t *snapshot)

Initialize the accessibility snapshot.

Parameter	Type	Description
snapshot	mk_accessibility_snapshot_t *	Value for snapshot.

mk_accessibility_supportedfunction

bool mk_accessibility_supported(void)

True only when a native accessibility adapter is active.

Returns True when the condition holds.

mk_accessibility_window_createfunction

mk_result mk_accessibility_window_create(const mk_accessibility_window_desc_t *desc, mk_accessibility_window_t **window)

Create accessibility window.

Parameter	Type	Description
desc	const mk_accessibility_window_desc_t *	Configuration descriptor.
window	mk_accessibility_window_t **	Value for window.

Returns MK_SUCCESS or an error result.

mk_accessibility_window_desc_initfunction

void mk_accessibility_window_desc_init(mk_accessibility_window_desc_t *desc)

Initialize the accessibility window desc.

Parameter	Type	Description
desc	mk_accessibility_window_desc_t *	Configuration descriptor.

mk_accessibility_window_destroyfunction

void mk_accessibility_window_destroy(mk_accessibility_window_t *window)

Destroy the accessibility window.

Parameter	Type	Description
window	mk_accessibility_window_t *	Value for window.

Structs

mk_accessibility_action_eventstruct

Data for accessibility action event.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
node_id	uint64_t	The node ID.
action	mk_accessibility_action_t	The action.
value	const char *	The value.
selection_start	int32_t	The selection start.
selection_end	int32_t	The selection end.
scroll_x	float	The scroll x.
scroll_y	float	The scroll y.

mk_accessibility_nodestruct

Data for accessibility node.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
id	uint64_t	The ID.
parent_id	uint64_t	The parent ID.
order	uint32_t	The order.
role	mk_accessibility_role_t	The role.
label	const char *	The label.
description	const char *	The description.
value	const char *	The value.
bounds	mk_rectf	The bounds.
states	uint32_t	The states.
actions	uint32_t	The actions.
range_min	double	The range min.
range_max	double	The range max.
range_value	double	The range value.
selection_start	int32_t	The selection start.
selection_end	int32_t	The selection end.
collection_index	uint32_t	The collection index.
collection_count	uint32_t	The collection count.
live	mk_accessibility_live_t	The live.

mk_accessibility_snapshotstruct

Data for accessibility snapshot.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
nodes	const mk_accessibility_node_t *	The nodes.
node_count	uint32_t	The node count.
focused_node_id	uint64_t	The focused node ID.

mk_accessibility_window_descstruct

Data for accessibility window desc.

Field	Type	Description
struct_size	uint32_t	The struct size.
struct_version	uint32_t	The struct version.
window_id	uint32_t	The window ID.
action_callback	mk_accessibility_action_fn	The action callback.
user_data	void *	The user data.

Enums

mk_accessibility_actionenum

Values for accessibility action.

Value	Description
MK_ACCESSIBILITY_ACTION_FOCUS	Selects focus.
MK_ACCESSIBILITY_ACTION_INVOKE	Selects invoke.
MK_ACCESSIBILITY_ACTION_SET_VALUE	Selects set value.
MK_ACCESSIBILITY_ACTION_SET_SELECTION	Selects set selection.
MK_ACCESSIBILITY_ACTION_INCREMENT	Selects increment.
MK_ACCESSIBILITY_ACTION_DECREMENT	Selects decrement.
MK_ACCESSIBILITY_ACTION_EXPAND	Selects expand.
MK_ACCESSIBILITY_ACTION_COLLAPSE	Selects collapse.
MK_ACCESSIBILITY_ACTION_SCROLL	Selects scroll.

mk_accessibility_liveenum

Values for accessibility live.

Value	Description
MK_ACCESSIBILITY_LIVE_OFF	Selects off.
MK_ACCESSIBILITY_LIVE_POLITE	Selects polite.
MK_ACCESSIBILITY_LIVE_ASSERTIVE	Selects assertive.

mk_accessibility_roleenum

Values for accessibility role.

Value	Description
MK_ACCESSIBILITY_ROLE_UNKNOWN	Selects unknown.
MK_ACCESSIBILITY_ROLE_WINDOW	Selects window.
MK_ACCESSIBILITY_ROLE_GROUP	Selects group.
MK_ACCESSIBILITY_ROLE_BUTTON	Selects button.
MK_ACCESSIBILITY_ROLE_CHECKBOX	Selects checkbox.
MK_ACCESSIBILITY_ROLE_RADIO	Selects radio.
MK_ACCESSIBILITY_ROLE_TEXT	Selects text.
MK_ACCESSIBILITY_ROLE_TEXT_FIELD	Selects text field.
MK_ACCESSIBILITY_ROLE_SLIDER	Selects slider.
MK_ACCESSIBILITY_ROLE_IMAGE	Selects image.
MK_ACCESSIBILITY_ROLE_LINK	Selects link.
MK_ACCESSIBILITY_ROLE_LIST	Selects list.
MK_ACCESSIBILITY_ROLE_LIST_ITEM	Selects list item.
MK_ACCESSIBILITY_ROLE_MENU	Selects menu.
MK_ACCESSIBILITY_ROLE_MENU_ITEM	Selects menu item.
MK_ACCESSIBILITY_ROLE_SCROLL_AREA	Selects scroll area.
MK_ACCESSIBILITY_ROLE_DIALOG	Selects dialog.
MK_ACCESSIBILITY_ROLE_SWITCH	Selects switch.
MK_ACCESSIBILITY_ROLE_PROGRESS	Selects progress.
MK_ACCESSIBILITY_ROLE_SPIN_BUTTON	Selects spin button.
MK_ACCESSIBILITY_ROLE_TAB_LIST	Selects tab list.
MK_ACCESSIBILITY_ROLE_TAB	Selects tab.
MK_ACCESSIBILITY_ROLE_TAB_PANEL	Selects tab panel.

mk_accessibility_stateenum

Values for accessibility state.

Value	Description
MK_ACCESSIBILITY_STATE_DISABLED	Selects disabled.
MK_ACCESSIBILITY_STATE_FOCUSED	Selects focused.
MK_ACCESSIBILITY_STATE_SELECTED	Selects selected.
MK_ACCESSIBILITY_STATE_CHECKED	Selects checked.
MK_ACCESSIBILITY_STATE_EXPANDED	Selects expanded.
MK_ACCESSIBILITY_STATE_HIDDEN	Selects hidden.
MK_ACCESSIBILITY_STATE_READ_ONLY	Selects read only.

Typedefs

mk_accessibility_action_event_ttypedef

typedef struct mk_accessibility_action_event mk_accessibility_action_event_t

Data for accessibility action event.

mk_accessibility_action_fntypedef

typedef void(*) mk_accessibility_action_fn(const mk_accessibility_action_event_t *event, void *user_data)

Callback used for accessibility action.

mk_accessibility_action_ttypedef

typedef enum mk_accessibility_action mk_accessibility_action_t

Values for accessibility action.

mk_accessibility_live_ttypedef

typedef enum mk_accessibility_live mk_accessibility_live_t

Values for accessibility live.

mk_accessibility_node_ttypedef

typedef struct mk_accessibility_node mk_accessibility_node_t

Data for accessibility node.

mk_accessibility_role_ttypedef

typedef enum mk_accessibility_role mk_accessibility_role_t

Values for accessibility role.

mk_accessibility_snapshot_ttypedef

typedef struct mk_accessibility_snapshot mk_accessibility_snapshot_t

Data for accessibility snapshot.

mk_accessibility_state_ttypedef

typedef enum mk_accessibility_state mk_accessibility_state_t

Values for accessibility state.

mk_accessibility_window_desc_ttypedef

typedef struct mk_accessibility_window_desc mk_accessibility_window_desc_t

Data for accessibility window desc.

mk_accessibility_window_ttypedef

typedef struct mk_accessibility_window_s mk_accessibility_window_t

Type used for accessibility window.

Macros

MK_ACCESSIBILITY_ACTION_EVENT_VERSIONdefine

MK_ACCESSIBILITY_ACTION_EVENT_VERSION

ABI or format version for accessibility action event.

MK_ACCESSIBILITY_NODE_VERSIONdefine

MK_ACCESSIBILITY_NODE_VERSION

ABI or format version for accessibility node.

MK_ACCESSIBILITY_SNAPSHOT_VERSIONdefine

MK_ACCESSIBILITY_SNAPSHOT_VERSION

ABI or format version for accessibility snapshot.

MK_ACCESSIBILITY_WINDOW_DESC_VERSIONdefine

MK_ACCESSIBILITY_WINDOW_DESC_VERSION

ABI or format version for accessibility window desc.