Skip to content
This repository has been archived by the owner on Nov 2, 2022. It is now read-only.

Latest commit

 

History

History
575 lines (466 loc) · 18.8 KB

vendor.md

File metadata and controls

575 lines (466 loc) · 18.8 KB

Sets the watch and timeout functions of a DBusConnection to integrate the connection with the GLib main loop. Pass in [None] for the GMainContext unless you're doing something specialized.

If called twice for the same context, does nothing the second time. If called once with context A and once with context B, context B replaces context A as the context monitoring the connection.

connection

the connection

context

the GMainContext or [None] for default context

Removes a device event listener from the registry's listener queue, ceasing notification of events of the specified type.

listener

a pointer to the AtspiDeviceListener for which device events are requested.

filter

Unused parameter.

Returns

[true] if successful, otherwise [false].

Removes a keystroke event listener from the registry's listener queue, ceasing notification of events with modifiers matching modmask.

listener

a pointer to the AtspiDeviceListener for which keystroke events are requested.

key_set

a pointer to the AtspiKeyDefinition array indicating which keystroke events are requested, or [None] to indicate that all keycodes and keyvals for the specified modifier set are to be included.

modmask

the key modifier mask for which this listener is to be 'deregistered' (of type AtspiKeyMaskType).

event_types

an AtspiKeyMaskType mask indicating which types of key events were requested (ATSPI_KEY_PRESSED, etc.).

Returns

[true] if successful, otherwise [false].

Synthesizes a keyboard event (as if a hardware keyboard event occurred in the current UI context).

keyval

a gint indicating the keycode or keysym or modifier mask of the key event being synthesized.

keystring

an (optional) UTF-8 string which, if synth_type is ATSPI_KEY_STRING, indicates a 'composed' keyboard input string being synthesized; this type of keyboard event synthesis does not emulate hardware keypresses but injects the string as though a composing input method (such as XIM) were used.

synth_type

an AtspiKeySynthType flag indicating whether keyval is to be interpreted as a keysym rather than a keycode (ATSPI_KEY_SYM) or a string (ATSPI_KEY_STRING) or a modifier mask (ATSPI_KEY_LOCKMODIFIERS and ATSPI_KEY_UNLOCKMODIFIERS), or whether to synthesize ATSPI_KEY_PRESS, ATSPI_KEY_RELEASE, or both (ATSPI_KEY_PRESSRELEASE).

Returns

[true] if successful, otherwise [false].

Gets the list of virtual desktops. On return, list will point to a newly-created, NULL terminated array of virtual desktop pointers. It is the responsibility of the caller to free this array when it is no longer needed. NOTE: currently multiple virtual desktops are not implemented; this implementation always returns a Garray with a single [Accessible][crate::Accessible] desktop.

Returns

a [glib::Array][crate::glib::Array] of desktops.

Registers a listener for device events, for instance button events.

listener

a pointer to the AtspiDeviceListener which requests the events.

event_types

an AtspiDeviceEventMask mask indicating which types of key events are requested (ATSPI_KEY_PRESSED, etc.).

filter

Unused parameter.

Returns

[true] if successful, otherwise [false].

Registers a listener for keystroke events, either pre-emptively for all windows (ATSPI_KEYLISTENER_ALL_WINDOWS), non-preemptively (ATSPI_KEYLISTENER_NOSYNC), or pre-emptively at the toolkit level (ATSPI_KEYLISTENER_CANCONSUME). If ALL_WINDOWS or CANCONSUME are used, the event is consumed upon receipt if one of listener's callbacks returns [true] (other sync_type values may be available in the future).

listener

a pointer to the AtspiDeviceListener for which keystroke events are requested.

key_set

a pointer to the AtspiKeyDefinition array indicating which keystroke events are requested, or NULL to indicate that all keycodes and keyvals for the specified modifier set are to be included.

modmask

an AtspiKeyMaskType mask indicating which key event modifiers must be set in combination with keys, events will only be reported for key events for which all modifiers in modmask are set. If you wish to listen for events with multiple modifier combinations, you must call atspi_register_keystroke_listener once for each combination.

event_types

an AtspiKeyMaskType mask indicating which types of key events are requested (ATSPI_KEY_PRESSED etc.).

sync_type

an AtspiKeyListenerSyncType parameter indicating the behavior of the notification/listener transaction.

Returns

[true] if successful, otherwise [false].

Sets the main loop context that AT-SPI should assume is in use when setting an idle callback. This function should be called by application-side implementors (ie, at-spi2-atk) when it is desirable to re-enter the main loop.

cnx

The GMainContext to use.

One higher than the highest valid value of [ComponentLayer][crate::ComponentLayer].

One higher than the highest valid value of [CoordType][crate::CoordType].

One higher than the highest valid value of AtspiEventType.

One higher than the highest valid value of AtspiKeyEventType.

One higher than the highest valid value of AtspiKeySynthType.

One higher than the highest valid value of AtspiLocaleType.

One higher than the highest valid value of AtspiModifierType.

One higher than the highest valid value of AtspiRelationType.

One higher than the highest valid value of [Role][crate::Role].

One higher than the highest valid value of [ScrollType][crate::ScrollType].

One higher than the highest valid value of [CollectionSortOrder][crate::CollectionSortOrder].

One higher than the highest valid value of [StateType][crate::StateType].

One higher than the highest valid value of [TextBoundaryType][crate::TextBoundaryType].

One higher than the highest valid value of [TextClipType][crate::TextClipType].

One higher than the highest valid value of AtspiCollection_TreeTraversalType.

Implements

[AccessibleExt][trait@crate::prelude::AccessibleExt], [ActionExt][trait@crate::prelude::ActionExt], [CollectionExt][trait@crate::prelude::CollectionExt], [ComponentExt][trait@crate::prelude::ComponentExt], [DocumentExt][trait@crate::prelude::DocumentExt], [EditableTextExt][trait@crate::prelude::EditableTextExt], [HypertextExt][trait@crate::prelude::HypertextExt], [ImageExt][trait@crate::prelude::ImageExt], [SelectionExt][trait@crate::prelude::SelectionExt], [TableExt][trait@crate::prelude::TableExt], [TableCellExt][trait@crate::prelude::TableCellExt], [TextExt][trait@crate::prelude::TextExt], [ValueExt][trait@crate::prelude::ValueExt]

Gets the AttributeSet representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes instead.

Returns

The name-value-pair attributes assigned to this object.

Gets a [glib::Array][crate::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.

Returns

The name-value-pair attributes assigned to this object.

A set of pointers to all interfaces supported by an [Accessible][crate::Accessible].

Returns

A [glib::Array][crate::glib::Array] of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (i.e. "Component", "Text" etc.).

Gets the set of AtspiRelation objects which describes this [Accessible][crate::Accessible] object's relationships with other [Accessible][crate::Accessible] objects.

Returns

a [glib::Array][crate::glib::Array] of AtspiRelation pointers or NULL on exception.

Implements

[ActionExt][trait@crate::prelude::ActionExt]

Implements

[CollectionExt][trait@crate::prelude::CollectionExt]

Gets all [Accessible][crate::Accessible] objects from the self matching a given rule.

rule

An [MatchRule][crate::MatchRule] describing the match criteria.

sortby

An [CollectionSortOrder][crate::CollectionSortOrder] specifying the way the results are to be sorted.

count

The maximum number of results to return, or 0 for no limit.

traverse

Not supported.

Returns

All [Accessible][crate::Accessible] objects matching the given match rule.

Gets all [Accessible][crate::Accessible] objects from the self, before current_object, matching a given rule.

current_object

Upon reaching this object, searching should stop.

rule

An [MatchRule][crate::MatchRule] describing the match criteria.

sortby

An [CollectionSortOrder][crate::CollectionSortOrder] specifying the way the results are to be sorted.

tree

An [CollectionTreeTraversalType][crate::CollectionTreeTraversalType] specifying restrictions on the objects to be traversed.

count

The maximum number of results to return, or 0 for no limit.

traverse

Not supported.

Returns

All [Accessible][crate::Accessible] objects matching the given match rule that preceed current_object.

Gets all [Accessible][crate::Accessible] objects from the self, after current_object, matching a given rule.

current_object

The object at which to start searching.

rule

An [MatchRule][crate::MatchRule] describing the match criteria.

sortby

An [CollectionSortOrder][crate::CollectionSortOrder] specifying the way the results are to be sorted.

tree

An [CollectionTreeTraversalType][crate::CollectionTreeTraversalType] specifying restrictions on the objects to be traversed.

limit_scope

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.

count

The maximum number of results to return, or 0 for no limit.

traverse

Not supported.

Returns

All [Accessible][crate::Accessible] objects matching the given match rule after current_object.

Implements

[ComponentExt][trait@crate::prelude::ComponentExt]

Implements

[DocumentExt][trait@crate::prelude::DocumentExt]

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.

Deprecated since 2.10

Use atspi_document_get_document_attributes instead.

Returns

a GHashTable containing the constant attributes of the document, as name-value pairs.

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.

Returns

a GHashTable containing the constant attributes of the document, as name-value pairs.

Implements

[EditableTextExt][trait@crate::prelude::EditableTextExt]

Implements

[HyperlinkExt][trait@crate::prelude::HyperlinkExt]

Implements

[HypertextExt][trait@crate::prelude::HypertextExt]

Implements

[ImageExt][trait@crate::prelude::ImageExt]

Creates a new [MatchRule][crate::MatchRule] with specified states, attributes, interfaces, and roles.

states

An [StateSet][crate::StateSet] specifying the states to match or NULL if none.

statematchtype

An [CollectionMatchType][crate::CollectionMatchType] specifying how to interpret states.

attributes

A GHashTable specifying attributes to match. To specify multiple attribute values, separate each value with a :: If an attribute value contains a :, then it can be escaped by preceding it with a . A backslash can likewise be escaped by inserting a double backslash.

attributematchtype

An [CollectionMatchType][crate::CollectionMatchType] specifying how to interpret attributes.

roles

A [glib::Array][crate::glib::Array] of roles to match, or NULL if not applicable.

rolematchtype

An [CollectionMatchType][crate::CollectionMatchType] specifying how to interpret roles.

interfaces

An array of interfaces to match, or NULL if not applicable. Interface names should be specified by their DBus names (org.a11y.Atspi.Accessible, org.a11y.Atspi.Component, etc).

interfacematchtype

An [CollectionMatchType][crate::CollectionMatchType] specifying how to interpret interfaces.

invert

if [true], the match rule should be denied (inverted); if [false], it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time.

Returns

A new [MatchRule][crate::MatchRule].

Gets a copy of an [Range][crate::Range] object.

Returns

the [Range][crate::Range] copy of an [Range][crate::Range] object.

Implements

[SelectionExt][trait@crate::prelude::SelectionExt]

Implements

[StateSetExt][trait@crate::prelude::StateSetExt]

Generates an [StateSet][crate::StateSet] with the given states.

states

An array of states with which the method initializes the state set.

Returns

A new [StateSet][crate::StateSet] with the given states.

Returns the states in an [StateSet][crate::StateSet] as an array.

Returns

A [glib::Array][crate::glib::Array] of state types representing the current state.

Implements

[TableExt][trait@crate::prelude::TableExt]

Queries a table for a list of indices of columns which are currently selected.

Returns

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.

Returns

an array of gint values, specifying which rows are currently selected.

Implements

[TableCellExt][trait@crate::prelude::TableCellExt]

Implements

[TextExt][trait@crate::prelude::TextExt]

Gets a set of attributes applied to a range of text from an [Text][crate::Text] object, optionally including its 'default' attributes.

offset

a gint indicating the offset from which the attribute search is based.

include_defaults

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.

Returns

a GHashTable with attributes defined at the indicated offset, optionally including the 'default' ones.

start_offset

a gint pointer indicating the start of the desired text range.

end_offset

a gint pointer indicating the first character past the desired range.

Gets the attributes applied to a range of text from an [Text][crate::Text] object. The text attributes correspond to CSS attributes where possible. <em>DEPRECATED</em>

Deprecated since 2.10

Use atspi_text_get_text_attributes instead.

offset

a gint indicating the offset from which the attribute search is based.

Returns

a GHashTable describing the attributes at the given character offset.

start_offset

a gint pointer indicating the start of the desired text range.

end_offset

a gint pointer indicating the first character past the desired range.

Gets the ranges of text from an [Text][crate::Text] object which lie within the bounds defined by (x, y) and (x+width, y+height).

x

the 'starting' x coordinate of the bounding box.

y

the 'starting' y coordinate of the bounding box.

width

the x extent of the bounding box.

height

the y extent of the bounding box.

type_

an AccessibleCoordType indicating the coordinate system to use for the returned values.

clipTypeX

an [TextClipType][crate::TextClipType] indicating how to treat characters that intersect the bounding box's x extents.

clipTypeY

an [TextClipType][crate::TextClipType] indicating how to treat characters that intersect the bounding box's y extents.

Returns

a null-terminated list of pointers to [TextRange][crate::TextRange] structs detailing the bounded text.

Gets the default attributes applied to an [Text][crate::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.

Returns

a GHashTable containing the default attributes applied to a text object, (exclusive of explicitly-set attributes), encoded as UTF-8.

Gets the attributes applied to a range of text from an [Text][crate::Text] object. The text attributes correspond to CSS attributes where possible. <em>DEPRECATED</em>

offset

a gint indicating the offset from which the attribute search is based.

Returns

a GHashTable describing the attributes at the given character offset.

start_offset

a gint pointer indicating the start of the desired text range.

end_offset

a gint pointer indicating the first character past the desired range.

Implements

[ValueExt][trait@crate::prelude::ValueExt]