_GtkAccessibleTextInterface Struct Reference

#include <gtkaccessibletext.h>

Data Fields
GTypeInterface	g_iface
GBytes *(*	get_contents )(GtkAccessibleText *self, unsigned int start, unsigned int end)
GBytes *(*	get_contents_at )(GtkAccessibleText *self, unsigned int offset, GtkAccessibleTextGranularity granularity, unsigned int *start, unsigned int *end)
unsigned int(*	get_caret_position )(GtkAccessibleText *self)
gboolean(*	get_selection )(GtkAccessibleText *self, gsize *n_ranges, GtkAccessibleTextRange **ranges)
gboolean(*	get_attributes )(GtkAccessibleText *self, unsigned int offset, gsize *n_ranges, GtkAccessibleTextRange **ranges, char ***attribute_names, char ***attribute_values)
void(*	get_default_attributes )(GtkAccessibleText *self, char ***attribute_names, char ***attribute_values)
gboolean(*	get_extents )(GtkAccessibleText *self, unsigned int start, unsigned int end, graphene_rect_t *extents)
gboolean(*	get_offset )(GtkAccessibleText *self, const graphene_point_t *point, unsigned int *offset)

Detailed Description

GtkAccessibleTextInterface:

The interface vtable for accessible objects containing text.

Since: 4.14

Definition at line 104 of file gtkaccessibletext.h.

Field Documentation

g_iface

GTypeInterface _GtkAccessibleTextInterface::g_iface

Definition at line 107 of file gtkaccessibletext.h.

get_attributes

gboolean(* _GtkAccessibleTextInterface::get_attributes) (GtkAccessibleText *self, unsigned int offset, gsize *n_ranges, GtkAccessibleTextRange **ranges, char ***attribute_names, char ***attribute_values)

GtkAccessibleTextInterface::get_attributes: @self: the accessible object @offset: the offset, in characters @n_ranges: (out): the number of attributes @ranges: (out) (array length=n_ranges) (optional) (transfer container): the ranges of the attributes inside the accessible object @attribute_names: (out) (array zero-terminated=1) (optional) (transfer full): the names of the attributes inside the accessible object @attribute_values: (out) (array zero-terminated=1) (optional) (transfer full): the values of the attributes inside the accessible object

Retrieves the text attributes inside the accessible object.

Each attribute is composed by:

• a range
• a name
• a value

It is left to the implementation to determine the serialization format of the value to a string.

GTK provides support for various text attribute names and values, but implementations of this interface are free to add their own attributes.

If this function returns true, n_ranges will be set to a value greater than or equal to one, @ranges will be set to a newly allocated array of [struct::Gtk.AccessibleTextRange].

Returns: true if the accessible object has at least an attribute, and false otherwise

Since: 4.14

Definition at line 226 of file gtkaccessibletext.h.

get_caret_position

unsigned int(* _GtkAccessibleTextInterface::get_caret_position) (GtkAccessibleText *self)

GtkAccessibleTextInterface::get_caret_position: @self: the accessible object

Retrieves the position of the caret inside the accessible object.

Returns: the position of the caret, in characters

Since: 4.14

Definition at line 168 of file gtkaccessibletext.h.

get_contents

GBytes *(* _GtkAccessibleTextInterface::get_contents) (GtkAccessibleText *self, unsigned int start, unsigned int end)

GtkAccessibleTextInterface::get_contents: @self: the accessible object @start: the beginning of the range, in characters @end: the end of the range, in characters

Retrieve the current contents of the accessible object within the given range.

If @end is G_MAXUINT, the end of the range is the full content of the accessible object.

Returns: (transfer full): the requested slice of the contents of the accessible object, as UTF-8. Note that the slice does not have to be NUL-terminated

Since: 4.14

Definition at line 129 of file gtkaccessibletext.h.

get_contents_at

GBytes *(* _GtkAccessibleTextInterface::get_contents_at) (GtkAccessibleText *self, unsigned int offset, GtkAccessibleTextGranularity granularity, unsigned int *start, unsigned int *end)

GtkAccessibleTextInterface::get_contents_at: @self: the accessible object @offset: the offset, in characters @granularity: the granularity of the query @start: (out): the start of the range, in characters @end: (out): the end of the range, in characters

Retrieve the current contents of the accessible object starting from the given offset, and using the given granularity.

The @start and @end values contain the boundaries of the text.

Returns: (transfer full): the requested slice of the contents of the accessible object, as UTF-8. Note that the slice does not have to be NUL-terminated

Since: 4.14

Definition at line 152 of file gtkaccessibletext.h.

get_default_attributes

void(* _GtkAccessibleTextInterface::get_default_attributes) (GtkAccessibleText *self, char ***attribute_names, char ***attribute_values)

GtkAccessibleTextInterface::get_default_attributes: @self: the accessible object @attribute_names: (out) (array zero-terminated=1) (optional) (transfer full): the names of the default attributes inside the accessible object @attribute_values: (out) (array zero-terminated=1) (optional) (transfer full): the values of the default attributes inside the accessible object

Retrieves the default text attributes inside the accessible object.

Each attribute is composed by:

• a name
• a value

It is left to the implementation to determine the serialization format of the value to a string.

GTK provides support for various text attribute names and values, but implementations of this interface are free to add their own attributes.

Since: 4.14

Definition at line 256 of file gtkaccessibletext.h.

get_extents

gboolean(* _GtkAccessibleTextInterface::get_extents) (GtkAccessibleText *self, unsigned int start, unsigned int end, graphene_rect_t *extents)

GtkAccessibleTextInterface::get_extents: @self: the accessible object @start: the start offset, in characters @end: the end offset, in characters, @extents (out caller-allocates): return location for the extents

Obtains the extents of a range of text, in widget coordinates.

Returns: true if the extents were filled in, false otherwise

Since: 4.16

Definition at line 273 of file gtkaccessibletext.h.

get_offset

gboolean(* _GtkAccessibleTextInterface::get_offset) (GtkAccessibleText *self, const graphene_point_t *point, unsigned int *offset)

GtkAccessibleTextInterface::get_offset: @self: the accessible object @point: a point in widget coordinates of @self @offset: (out): return location for the text offset at @point

Gets the text offset at a given point.

Returns: true if the offset was set, false otherwise

Since: 4.16

Definition at line 290 of file gtkaccessibletext.h.

get_selection

gboolean(* _GtkAccessibleTextInterface::get_selection) (GtkAccessibleText *self, gsize *n_ranges, GtkAccessibleTextRange **ranges)

GtkAccessibleTextInterface::get_selection: @self: the accessible object @n_ranges: (out): the number of selection ranges @ranges: (optional) (out) (array length=n_ranges) (transfer container): the selection ranges

Retrieves the selection ranges in the accessible object.

If this function returns true, n_ranges will be set to a value greater than or equal to one, and @ranges will be set to a newly allocated array of [struct::Gtk.AccessibleTextRange].

Returns: true if there is at least a selection inside the accessible object, and false otherwise

Since: 4.14

Definition at line 187 of file gtkaccessibletext.h.

---

The documentation for this struct was generated from the following file:

• gtkaccessibletext.h