Optionalproperties: Partial<Atspi.Accessible.ConstructorProps>Internal$signalsStatic$gtypeSelects the specified column, adding it to the current column selection. Not all tables support column selection.
the zero-indexed column number of the column being selected.
TRUE if the specified column was successfully selected, FALSE if not.
Selects the specified row, adding it to the current row selection. Not all tables support row selection.
the zero-indexed row number of the row being selected.
TRUE if the specified row was successfully selected, FALSE if not.
Selects some text (adds a text selection) in an Atspi.Text object.
the starting offset of the desired new selection.
the offset of the first character after the new selection.
TRUE if successful, FALSE otherwise.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Clears the cached information for the given accessible and all of its descendants.
Clears the current selection, removing all selected children from the specified Atspi.Selection implementor's selection list.
TRUE if successful, FALSE otherwise.
SignalconnectSignalconnect_Queries whether a given Atspi.Component contains a particular point.
TRUE if the specified component contains the point (x, y), FALSE otherwise.
Copies text from an Atspi.EditableText object into the system clipboard.
see: atspi_editable_text_paste_text
a gint indicating the starting character offset of the text to copy.
a gint indicating the offset of the first character past the end of the text section to be copied.
TRUE if the operation was successful, otherwise FALSE.
Deletes text from an Atspi.EditableText object, copying the excised portion into the system clipboard.
see: atspi_editable_text_paste_text
a gint indicating the starting character offset of the text to cut.
a gint indicating the offset of the first character past the end of the text section to be cut.
TRUE if operation was successful, FALSE otherwise.
Deletes text from an Atspi.EditableText object, without copying the excised portion into the system clipboard.
see: atspi_editable_text_cut_text
a gint indicating the starting character offset of the text to delete.
a gint indicating the offset of the first character past the end of the text section to be deleted.
TRUE if the operation was successful, otherwise FALSE.
Deselects a specific child of an Atspi.Selection.
Note that child_index is the index of the child
in the parent container.
See atspi_selection_deselect_selected_child
a gint indicating which of the children of the Atspi.Accessible is to be de-selected.
TRUE if the child was successfully deselected, FALSE otherwise.
Removes a child from the selected children list of an Atspi.Selection.
Note that child_index is the index in the selected-children list,
not the index in the parent container. selectedChildIndex in this
method, and child_index in atspi_selection_select_child
are asymmetric.
a gint indicating which of the selected children of the Atspi.Accessible is to be selected.
TRUE if the child was successfully deselected, FALSE otherwise.
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
Invoke the action indicated by #index.
an integer specifying which action to invoke.
TRUE if the action is successfully invoked, otherwise FALSE.
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the table cell at the specified row and column indices.
To get the accessible object at a particular (x, y) screen
coordinate, use atspi_component_get_accessible_at_point.
the specified table row, zero-indexed.
the specified table column, zero-indexed.
an Atspi.Accessible object representing the specified table cell.
Gets the accessible child at a given coordinate within an Atspi.Component.
a pointer to an Atspi.Accessible child of the specified component which contains the point (x, y), or NULL if no child contains the point.
Gets the accessible id of the accessible. This is not meant to be presented to the user, but to be an id which is stable over application development. Typically, this is the gtkbuilder id.
a character string representing the accessible id of the Atspi.Accessible object or NULL on exception.
Get the description of 'i-th' action invocable on an
object implementing Atspi.Action.
an integer indicating which action to query.
a UTF-8 string describing the 'i-th' invocable action.
Gets the Atspi.Action interface for an Atspi.Accessible.
a pointer to an Atspi.Action interface instance, or NULL if obj does not implement Atspi.Action.
Gets the Atspi.Action interface for an Atspi.Accessible.
a pointer to an Atspi.Action interface instance, or NULL if obj does not implement Atspi.Action.
Get the name of the 'i-th' action invocable on an
object implementing Atspi.Action.
an integer indicating which action to query.
the non-localized name of the action, as a UTF-8 string.
The active descendant of the given object. Not yet implemented.
Gets the opacity/alpha value of a component, if alpha blending is in use.
the opacity value of a component, as a gdouble between 0.0 and 1.0.
Gets the containing Atspi.Application for an object.
the containing Atspi.Application instance for this object.
Gets the AT-SPI IPC specification version supported by the application pointed to by the Atspi.Accessible object. Only works on application root objects.
a UTF-8 string indicating the AT-SPI version for the Atspi.Accessible object or NULL on exception.
Gets a set of attributes applied to a range of text from an Atspi.Text object, optionally including its 'default' attributes.
a gint indicating the offset from which the attribute search is based.
a #bool that, when set as FALSE, indicates the call should only return those attributes which are explicitly set on the current attribute run, omitting any attributes which are inherited from the default values.
a GLib.HashTable with attributes defined at the indicated offset, optionally including the 'default' ones.
Gets a GLib.Array representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes_as_array instead.
The name-value-pair attributes assigned to this object.
Gets the ranges of text from an Atspi.Text object which lie within the
bounds defined by (x, y) and (x+width, y+height).
the 'starting' x coordinate of the bounding box.
the 'starting' y coordinate of the bounding box.
the x extent of the bounding box.
the y extent of the bounding box.
an AccessibleCoordType indicating the coordinate system to use for the returned values.
an Atspi.TextClipType indicating how to treat characters that intersect the bounding box's x extents.
an Atspi.TextClipType indicating how to treat characters that intersect the bounding box's y extents.
a null-terminated list of pointers to Atspi.TextRange structs detailing the bounded text.
Gets an accessible representation of the caption for an Atspi.Table.
an Atspi.Accessible object that serves as the table's caption.
Gets the current offset of the text caret in an Atspi.Text object.
a gint indicating the current position of the text caret.
Gets the character at a given offset for an Atspi.Text object.
a gint indicating the text offset where the desired character is located.
a guint representing the UCS-4 unicode code point of the given character, or 0xFFFFFFFF if the character in question cannot be represented in the UCS-4 encoding.
Gets the character count of an AccessibleText object.
a gint indicating the total number of characters in the AccessibleText object.
Gets a bounding box containing the glyph representing the character at a particular text offset. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING.
An Atspi.Rect specifying the position and size of the character.
Gets the Atspi.Accessible child of an Atspi.Accessible object at a given index.
a #long indicating which child is specified.
a pointer to the Atspi.Accessible child object at index child_index or NULL on exception.
Gets the number of children contained by an Atspi.Accessible object.
a #long indicating the number of Atspi.Accessible children contained by an Atspi.Accessible object or -1 on exception.
Gets the Atspi.Collection interface for an Atspi.Accessible.
a pointer to an Atspi.Collection interface instance, or NULL if obj does not implement Atspi.Collection.
Gets the Atspi.Collection interface for an Atspi.Accessible.
a pointer to an Atspi.Collection interface instance, or NULL if obj does not implement Atspi.Collection.
Gets the table column index occupied by the child at a particular 1-D child index.
see atspi_table_get_index_at, atspi_table_get_row_at_index
the specified child index, zero-indexed.
a gint indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) index.
Gets a text description of a particular table column. This differs from
atspi_table_get_column_header, which returns an Atspi.Accessible.
the specified table column, zero-indexed.
a UTF-8 string describing the specified table column, if available.
Gets the number of columns spanned by the table cell at the specific row and column (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.
the specified table row, zero-indexed.
the specified table column, zero-indexed.
a gint indicating the number of columns spanned by the specified cell.
Gets the header associated with a table column, if available.
This differs from atspi_table_get_column_description, which
returns a string.
the specified table column, zero-indexed.
an Atspi.Accessible representation of the specified table column, if available.
Returns the column headers as an array of cell accessibles.
a GPtrArray of AtspiAccessibles representing the column header cells.
Returns the number of columns occupied by this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING.
a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method.
Gets the Atspi.Component interface for an Atspi.Accessible.
a pointer to an Atspi.Component interface instance, or NULL if obj does not implement Atspi.Component.
Gets the Atspi.Component interface for an Atspi.Accessible.
a pointer to an Atspi.Component interface instance, or NULL if obj does not implement Atspi.Component.
Gets the current page number of an AccessibleDocument object.
a gint indicating the current page number in the AccessibleDocument object.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets the default attributes applied to an Atspi.Text
object. The text attributes correspond to CSS attributes
where possible. The combination of this attribute set and
the attributes reported by atspi_text_get_attributes
describes the entire set of text attributes over a range.
a GLib.HashTable containing the default attributes applied to a text object, (exclusive of explicitly-set attributes), encoded as UTF-8.
Gets the description of an Atspi.Accessible object.
a UTF-8 string describing the Atspi.Accessible object or NULL on exception.
Gets the value of a single attribute, if specified for the document as a whole.
a string indicating the name of a specific attribute.
a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.
Gets all constant attributes for the document as a whole. For attributes
that change within the document content, see atspi_text_get_attribute_run instead.
a GLib.HashTable containing the constant attributes of the document, as name-value pairs.
Gets the Atspi.Document interface for an Atspi.Accessible.
a pointer to an Atspi.Document interface instance, or NULL if obj does not implement Atspi.Document.
Gets the Atspi.Document interface for an Atspi.Accessible.
a pointer to an Atspi.Document interface instance, or NULL if obj does not implement Atspi.Document.
Gets the Atspi.EditableText interface for an Atspi.Accessible.
a pointer to an Atspi.EditableText interface instance, or NULL if obj does not implement Atspi.EditableText.
Gets the Atspi.EditableText interface for an Atspi.Accessible.
a pointer to an Atspi.EditableText interface instance, or NULL if obj does not implement Atspi.EditableText.
Gets the bounding box of the specified Atspi.Component. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.
An Atspi.Rect giving the accessible's extents.
Gets the Atspi.Hyperlink interface for an Atspi.Accessible.
the Atspi.Hyperlink object associated with the given Atspi.Accessible, or NULL if not supported.
Gets the Atspi.Hypertext interface for an Atspi.Accessible.
a pointer to an Atspi.Hypertext interface instance, or NULL if obj does not implement Atspi.Hypertext.
Gets the Atspi.Hypertext interface for an Atspi.Accessible.
a pointer to an Atspi.Hypertext interface instance, or NULL if obj does not implement Atspi.Hypertext.
Gets the application id for a Atspi.Accessible object. Only works on application root objects.
a positive gint indicating the id for the Atspi.Accessible object or -1 on exception.
Gets the description of the image displayed in an Atspi.Image object.
a UTF-8 string describing the image.
Gets the bounding box of the image displayed in a specified Atspi.Image implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.
a pointer to an Atspi.Rect corresponding to the image's bounding box. The minimum x and y coordinates, width, and height are specified.
Gets the Atspi.Image interface for an Atspi.Accessible.
a pointer to an Atspi.Image interface instance, or NULL if obj does not implement Atspi.Image.
Gets the Atspi.Image interface for an Atspi.Accessible.
a pointer to an Atspi.Image interface instance, or NULL if obj does not implement Atspi.Image.
Gets the locale associated with an image and its textual representation.
A POSIX LC_MESSAGES-style locale value for image description and text.
Gets the minimum x and y coordinates of the image displayed in a specified Atspi.Image implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.
a pointer to an Atspi.Point where x and y correspond to the minimum coordinates of the displayed image.
Gets the size of the image displayed in a specified Atspi.Image object. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.
a pointer to an Atspi.Point where x corresponds to the image's width and y corresponds to the image's height.
Gets the 1-D child index corresponding to the specified 2-D row and
column indices. To get the accessible object at a particular (x, y) screen
coordinate, use atspi_component_get_accessible_at_point.
see atspi_table_get_row_at_index, atspi_table_get_column_at_index
the specified table row, zero-indexed.
the specified table column, zero-indexed.
a gint which serves as the index of a specified cell in the table, in a form usable by atspi_get_child_at_index.
Gets the index of an Atspi.Accessible object within its parent's Atspi.Accessible children list.
a glong indicating the index of the Atspi.Accessible object in its parent, or -1 if obj has no containing parent or on exception.
A set of pointers to all interfaces supported by an Atspi.Accessible.
A GLib.Array of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (i.e. "Component", "Text" etc.).
Get the keybindings for the i-th action invocable on an
object implementing Atspi.Action, if any are defined.
The keybindings string format is as follows:
there are multiple parts to a keybinding string (typically 3).
They are delimited with ";". The first is the action's
keybinding which is usable if the object implementing the action
is currently posted to the screen, e.g. if a menu is posted
then these keybindings for the corresponding menu-items are
available. The second keybinding substring is the full key sequence
necessary to post the action's widget and activate it, e.g. for
a menu item such as "File->Open" it would both post the menu and
activate the item. Thus the second keybinding string is available
during the lifetime of the containing toplevel window as a whole,
whereas the first keybinding string only works while the object
implementing AtkAction is posted. The third (and optional)
keybinding string is the "keyboard shortcut" which invokes the
action without posting any menus.
Meta-keys are indicated by the conventional strings
"<Control>", "<Alt>", "<Shift>", "<Mod2>",
etc. (we use the same string as gtk_accelerator_name() in
gtk+-2.X.
an integer indicating which action to query.
a UTF-8 string which can be parsed to determine the i-th invocable action's keybindings.
Queries which layer the component is painted into, to help determine its visibility in terms of stacking order.
the Atspi.ComponentLayer into which this component is painted.
Gets the Atspi.Hyperlink object at a specified index.
a (zero-index) gint indicating which hyperlink to query.
the Atspi.Hyperlink object specified by link_index.
Gets the index of the Atspi.Hyperlink object at a specified character offset.
a gint specifying the character offset to query.
the linkIndex of the Atspi.Hyperlink active at character offset character_offset, or -1 if there is no hyperlink at the specified character offset.
Gets the locale associated with the document's content, e.g. the locale for LOCALE_TYPE_MESSAGES.
a string compliant with the POSIX standard for locale description.
Get the name of the 'i-th' action invocable on an
object implementing Atspi.Action.
an integer indicating which action to query.
the name of the action, as a UTF-8 string.
Gets a UTF-8 string corresponding to the name of the role played by an object, translated to the current locale. This method will return useful values for roles that fall outside the enumeration used in atspi_accessible_getRole ().
a localized, UTF-8 string specifying the type of UI role played by an Atspi.Accessible object.
Gets all Atspi.Accessible objects from the collection matching a given
rule.
An Atspi.MatchRule describing the match criteria.
An Atspi.CollectionSortOrder specifying the way the results are to be sorted.
The maximum number of results to return, or 0 for no limit.
Not supported.
All Atspi.Accessible objects matching the given match rule.
Gets all Atspi.Accessible objects from the collection, before
current_object, matching a given rule.
Upon reaching this object, searching should stop.
An Atspi.MatchRule describing the match criteria.
An Atspi.CollectionSortOrder specifying the way the results are to be sorted.
An Atspi.CollectionTreeTraversalType specifying restrictions on the objects to be traversed.
The maximum number of results to return, or 0 for no limit.
Not supported.
All Atspi.Accessible objects matching the given match rule that preceed current_object.
Gets all Atspi.Accessible objects from the collection, after
current_object, matching a given rule.
The object at which to start searching.
An Atspi.MatchRule describing the match criteria.
An Atspi.CollectionSortOrder specifying the way the results are to be sorted.
An Atspi.CollectionTreeTraversalType specifying restrictions on the objects to be traversed.
If TRUE, only descendants of current_object's parent will be returned. Otherwise (if FALSE), any accessible may be returned if it would preceed current_object in a flattened hierarchy.
The maximum number of results to return, or 0 for no limit.
Not supported.
All Atspi.Accessible objects matching the given match rule after current_object.
Gets the maximum allowed value for an Atspi.Value.
the maximum allowed value for this object.
Queries the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top)
a gshort indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer.
Gets the minimum increment by which an Atspi.Value can be adjusted.
the minimum increment by which the value may be changed, or zero if the minimum increment cannot be determined.
Gets the minimum allowed value for an Atspi.Value.
the minimum allowed value for this object.
Get the number of actions invokable on an Atspi.Action implementor.
an integer indicating the number of invocable actions.
Gets the number of columns in an Atspi.Table, exclusive of any columns that are programmatically hidden, but inclusive of columns that may be outside of the current scrolling window or viewport.
a gint indicating the number of columns in the table.
Gets the total number of Atspi.Hyperlink objects that an Atspi.Hypertext implementor has.
a gint indicating the number of Atspi.Hyperlink objects of the Atspi.Hypertext implementor, or -1 if the number cannot be determined (for example, if the Atspi.Hypertext object is so large that it is not all currently in the memory cache).
Gets the number of rows in an Atspi.Table, exclusive of any rows that are programmatically hidden, but inclusive of rows that may be outside of the current scrolling window or viewport.
a gint indicating the number of rows in the table.
Gets the number of children of an Atspi.Selection implementor which are currently selected.
a gint indicating the number of Atspi.Accessible children of the Atspi.Selection implementor which are currently selected.
Queries a table to find out how many columns are currently selected. Not all tables support column selection.
a gint indicating the number of columns currently selected.
Query a table to find out how many rows are currently selected. Not all tables support row selection.
a gint indicating the number of rows currently selected.
Gets the number of active non-contiguous selections for an Atspi.Text object.
a gint indicating the current number of non-contiguous text selections active within an Atspi.Text object.
Gets the name of an Atspi.Accessible object.
a UTF-8 string indicating the name of the Atspi.Accessible object or NULL on exception.
Gets the character offset into the text at a given point.
the x coordinate of the point to be queried.
the y coordinate of the point to be queried.
an Atspi.CoordType indicating the coordinate system in which the values should be returned.
the offset (as a gint) at the point (x, y) in the specified coordinate system.
Gets the page count of an AccessibleDocument object.
a gint indicating the page count of an AccessibleDocument object.
Gets an Atspi.Accessible object's parent container.
a pointer to the Atspi.Accessible object which contains the given Atspi.Accessible instance, or NULL if the obj has no parent container.
Gets the minimum x and y coordinates of the specified Atspi.Component. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.
An Atspi.Point giving the obj's position.
Returns the process id associated with the given accessible. Mainly added for debugging; it is a shortcut to explicitly querying the accessible's app->bus_name and then calling GetConnectionUnixProcessID.
The process ID or undetermined value if error is set.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets the bounding box for text within a range in an Atspi.Text object. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING.
a gint indicating the offset of the first text character for whom boundary information is requested.
a gint indicating the offset of the text character after the last character for whom boundary information is requested.
an Atspi.CoordType indicating the coordinate system to use for the returned values.
An Atspi.Rect giving the position and size of the specified range of text.
Gets the set of Atspi.Relation objects which describes this Atspi.Accessible object's relationships with other Atspi.Accessible objects.
a GLib.Array of Atspi.Relation pointers or NULL on exception.
Gets the UI role played by an Atspi.Accessible object. This role's name can be obtained via atspi_accessible_get_role_name ().
the Atspi.Role of an Atspi.Accessible object.
Gets a UTF-8 string corresponding to the name of the role played by an object. This method will return useful values for roles that fall outside the enumeration used in atspi_accessible_get_role ().
a UTF-8 string specifying the type of UI role played by an Atspi.Accessible object.
Gets the table row index occupied by the child at a particular 1-D child index.
see atspi_table_get_index_at, atspi_table_get_column_at_index
the specified child index, zero-indexed.
a gint indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) index.
Given a child index, determines the row and column indices and
extents, and whether the cell is currently selected. If
the child at index is not a cell (for instance, if it is
a summary, caption, etc.), FALSE is returned.
The returned values are meaningful only if the Table has both
STATE_VISIBLE and STATE_SHOWING.
Example: If the Atspi.Table child at index '6' extends across columns 5 and 6 of row 2 of an Atspi.Table instance, and is currently selected, then
retval = atspi_table_get_row_column_extents_at_index (table, 6, row, col, row_extents, col_extents, is_selected);
will return TRUE, and after the call
row, col, row_extents, col_extents,
and is_selected will contain 2, 5, 1, 2, and
TRUE, respectively.
the index of the Atspi.Table child whose row/column extents are requested.
TRUE if the index is associated with a valid table cell, FALSE if the index does not correspond to a cell. If FALSE is returned, the values of the out parameters are undefined.
Gets the row and column indexes and extents of this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING.
Gets a text description of a particular table row. This differs from
atspi_table_get_row_header, which returns an Atspi.Accessible.
the specified table row, zero-indexed.
a UTF-8 string describing the specified table row, if available.
Gets the number of rows spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.
the specified table row, zero-indexed.
the specified table column, zero-indexed.
a gint indicating the number of rows spanned by the specified cell.
Gets the header associated with a table row, if available. This differs from
atspi_table_get_row_description, which returns a string.
the specified table row, zero-indexed.
an Atspi.Accessible representation of the specified table row, if available.
Returns the row headers as an array of cell accessibles.
a GPtrArray of AtspiAccessibles representing the row header cells.
Returns the number of rows occupied by this cell accessible. The returned values are meaningful only if the table cell has both STATE_VISIBLE and STATE_SHOWING.
a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method.
Gets the i-th selected Atspi.Accessible child of an Atspi.Selection.
Note that selected_child_index refers to the index in the list
of 'selected'
children and generally differs from that used in
atspi_accessible_get_child_at_index or returned by
atspi_accessible_get_index_in_parent.
selected_child_index must lie between 0
and atspi_selection_get_n_selected_children - 1, inclusive.
a gint indicating which of the selected children is specified.
a pointer to a selected Atspi.Accessible child object, specified by selected_child_index.
Queries a table for a list of indices of columns which are currently selected.
an array of gint values, specifying which columns are currently selected.
Queries a table for a list of indices of rows which are currently selected.
an array of gint values, specifying which rows are currently selected.
Gets the bounds of the selection_num-th active text selection for an
Atspi.Text object.
a gint indicating which selection to query.
Gets the Atspi.Selection interface for an Atspi.Accessible.
a pointer to an Atspi.Selection interface instance, or NULL if obj does not implement Atspi.Selection.
Gets the Atspi.Selection interface for an Atspi.Accessible.
a pointer to an Atspi.Selection interface instance, or NULL if obj does not implement Atspi.Selection.
Gets the size of the specified Atspi.Component. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.
An Atspi.Point giving the obj's size.
Gets the states currently held by an object.
a pointer to an Atspi.StateSet representing an object's current state set.
Gets a portion of the text exposed through an Atspi.Text according to a given offset
and a specific granularity, along with the start and end offsets defining the
boundaries of such a portion of text.
If granularity is ATSPI_TEXT_GRANULARITY_CHAR the character at the
offset is returned.
If granularity is ATSPI_TEXT_GRANULARITY_WORD the returned string
is from the word start at or before the offset to the word start after
the offset.
The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word.
If granularity is ATSPI_TEXT_GRANULARITY_SENTENCE the returned string
is from the sentence start at or before the offset to the sentence
start after the offset.
The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence.
If granularity is ATSPI_TEXT_GRANULARITY_LINE the returned string
is from the line start at or before the offset to the line
start after the offset.
If granularity is ATSPI_TEXT_GRANULARITY_PARAGRAPH the returned string
is from the start of the paragraph at or before the offset to the start
of the following paragraph after the offset.
position
a newly allocated string containing the text at the offset bounded by the specified granularity. Use g_free() to free the returned string. Returns null if the offset is invalid or no implementation is available.
Gets an accessible object which summarizes the contents of an Atspi.Table.
an Atspi.Accessible object that serves as the table's summary (often a reduced Atspi.Table).
Returns a reference to the accessible of the containing table.
the AtspiAccessible for the containing table.
Gets the Atspi.TableCell interface for an Atspi.Accessible.
a pointer to an Atspi.TableCell interface instance, or NULL if obj does not implement Atspi.Table.
Gets the Atspi.Table interface for an Atspi.Accessible.
a pointer to an Atspi.Table interface instance, or NULL if obj does not implement Atspi.Table.
Gets the Atspi.Table interface for an Atspi.Accessible.
a pointer to an Atspi.Table interface instance, or NULL if obj does not implement Atspi.Table.
Gets a range of text from an Atspi.Text object. The number of bytes in the returned string may exceed either end_offset or start_offset, since UTF-8 is a variable-width encoding.
a gint indicating the start of the desired text range.
a gint indicating the first character past the desired range.
a text string containing characters from start_offset to end_offset-1, inclusive, encoded as UTF-8.
Gets delimited text from an Atspi.Text object which follows a given text offset.
a gint indicating the offset from which the delimiter search is based.
an Atspi.TextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.
an Atspi.TextRange containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are after or inclusive of the current offset, or an empty string if no such text exists.
Gets delimited text from an Atspi.Text object which includes a given text offset.
a gint indicating the offset from which the delimiter search is based.
an Atspi.TextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.
an Atspi.TextRange containing a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists.
Gets the value of a named attribute at a given offset.
The character offset at which to query the attribute.
The attribute to query.
the value of a given attribute at the given offset, or null if not present.
Gets the attributes applied to a range of text from an Atspi.Text object. The text attributes correspond to CSS attributes where possible. DEPRECATED
a gint indicating the offset from which the attribute search is based.
a GLib.HashTable describing the attributes at the given character offset.
Gets delimited text from an Atspi.Text object which precedes a given text offset.
a gint indicating the offset from which the delimiter search is based.
an Atspi.TextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.
an Atspi.TextRange containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are before the current offset, or an empty string if no such text exists.
Gets the Atspi.Table interface for an Atspi.Accessible.
a pointer to an Atspi.Text interface instance, or NULL if obj does not implement Atspi.Text.
Gets the Atspi.Table interface for an Atspi.Accessible.
a pointer to an Atspi.Text interface instance, or NULL if obj does not implement Atspi.Text.
Gets the toolkit name for an Atspi.Accessible object. Only works on application root objects.
a UTF-8 string indicating the toolkit name for the Atspi.Accessible object or NULL on exception.
Gets the toolkit version for an Atspi.Accessible object. Only works on application root objects.
a UTF-8 string indicating the toolkit version for the Atspi.Accessible object or NULL on exception.
Gets the Atspi.Table interface for an Atspi.Accessible.
a pointer to an Atspi.Value interface instance, or NULL if obj does not implement Atspi.Value.
Gets the Atspi.Table interface for an Atspi.Accessible.
a pointer to an Atspi.Value interface instance, or NULL if obj does not implement Atspi.Value.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Attempts to set the keyboard input focus to the specified Atspi.Component.
TRUE if successful, FALSE otherwise.
Inserts text into an Atspi.EditableText object.
As with all character offsets, the specified position may not be the
same as the resulting byte offset, since the text is in a
variable-width encoding.
a gint indicating the character offset at which to insert the new text.
a string representing the text to insert, in UTF-8 encoding.
the number of characters of text to insert, in bytes. If the byte count of text is less than or equal to length, the entire contents of text will be inserted.
TRUE if the operation was successful, otherwise FALSE.
Determines whether a particular child of an Atspi.Selection implementor
is currently selected. Note that child_index is the index into the
standard Atspi.Accessible container's list of children.
an index into the Atspi.Selection's list of children.
TRUE if the specified child is currently selected, FALSE otherwise.
Determines whether specified table column is selected. Not all tables support column selection.
the zero-indexed column number of the column being queried.
TRUE if the specified column is currently selected, FALSE if not.
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Determines whether a table row is selected. Not all tables support row selection.
the zero-indexed row number of the row being queried.
TRUE if the specified row is currently selected, FALSE if not.
Determines whether the cell at a specific row and column is selected.
the zero-indexed row of the cell being queried.
the zero-indexed column of the cell being queried.
TRUE if the specified cell is currently selected, FALSE if not.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Inserts text from the system clipboard into an Atspi.EditableText object.
As with all character offsets, the specified position may not be the
same as the resulting byte offset, since the text is in a
variable-width encoding.
a gint indicating the character offset at which to insert the new text.
TRUE if the operation was successful, otherwise FALSE.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
De-selects the specified column, removing it from the current column selection. Not all tables support column selection.
the zero-indexed column number of the column being de-selected.
TRUE if the specified column was successfully de-selected, FALSE if not.
De-selects the specified row, removing it from the current row selection. Not all tables support row selection.
the zero-indexed number of the row being de-selected.
TRUE if the specified row was successfully de-selected, FALSE if not.
De-selects a text selection.
a gint indicating which text selection to remove.
TRUE if successful, FALSE otherwise.
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Scrolls whatever container of the Atspi.Text text range so it becomes visible on the screen.
a gint indicating the start of the desired text range.
a gint indicating the first character past the desired range.
a Atspi.ScrollType indicating where the object should be placed on the screen.
TRUE if successful, FALSE otherwise.
Scrolls whatever container of the Atspi.Text text range so it becomes visible on the screen at a given position.
a gint indicating the start of the desired text range.
a gint indicating the first character past the desired range.
a Atspi.CoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object.
the x coordinate of the point to reach
the y coordinate of the point to reach
TRUE if successful, FALSE otherwise.
Scrolls whatever container of the Atspi.Component object so it becomes visible on the screen.
a Atspi.ScrollType indicating where the object should be placed on the screen.
TRUE if successful, FALSE otherwise.
Scrolls whatever container of the Atspi.Component object so it becomes visible on the screen at a given position.
a Atspi.CoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object.
the x coordinate of the point to reach
the y coordinate of the point to reach
TRUE if successful, FALSE otherwise.
Attempts to select all of the children of an Atspi.Selection implementor. Not all Atspi.Selection implementors support this operation.
TRUE if successful, FALSE otherwise.
Adds a child to the selected children list of an Atspi.Selection. For Atspi.Selection implementors that only allow single selections, this may replace the (single) current selection.
a gint indicating which child of the Atspi.Accessible is to be selected.
TRUE if the child was successfully selected, FALSE otherwise.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the type of data to cache for accessibles. If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED, then the desktop's cache flag will be used. If the desktop's cache flag is also undefined, then all possible data will be cached. This function is intended to work around bugs in toolkits where the proper events are not raised / to aid in testing for such bugs.
An Atspi.Cache specifying a bit mask of the types of data to cache.
Moves the text caret to a given position.
the offset to which the text caret is to be moved.
TRUE if successful, FALSE otherwise.
Sets the current value of an Atspi.Value.
a gdouble value which is the desired new value of the object.
TRUE if the value could be assigned the specified value, FALSE otherwise.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Moves and resizes the specified component.
the new vertical position to which the component should be moved.
the new horizontal position to which the component should be moved.
the width to which the component should be resized.
the height to which the component should be resized.
the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
TRUE if successful; FALSE otherwise.
Moves the component to the specified position.
TRUE if successful; FALSE otherwise.
Sets a property on an object.
The name of the property to set
The value to set the property to
Changes the bounds of an existing Atspi.Text text selection.
a zero-offset index indicating which text selection to modify.
a gint indicating the new starting offset for the selection.
a gint indicating the desired new offset of the first character after the selection.
TRUE if successful, FALSE otherwise.
Resizes the specified component to the given coordinates.
the width to which the component should be resized.
the height to which the component should be resized.
TRUE if successful; FALSE otherwise.
Replace the entire text contents of an Atspi.EditableText object.
a character string, encoded in UTF-8, which is to become the new text contents of the Atspi.EditableText object.
TRUE if the operation was successful, otherwise FALSE.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Compile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.