Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

accessibleParent: Atspi.Accessible
attributes: HashTable<string | number | symbol, string | number | boolean>
cachedProperties: number
children: object[]
description: string
gTypeInstance: TypeInstance
interfaces: number
name: string
parent: Atspi.Object
path: string
role: Atspi.Role
states: Atspi.StateSet
name: string

Methods

  • addColumnSelection(column: number): boolean
  • Selects the specified column, adding it to the current column selection. Not all tables support column selection.

    Parameters

    • column: number

      the zero-indexed column number of the column being selected.

    Returns boolean

  • addRowSelection(row: number): boolean
  • Selects the specified row, adding it to the current row selection. Not all tables support row selection.

    Parameters

    • row: number

      the zero-indexed row number of the row being selected.

    Returns boolean

  • addSelection(startOffset: number, endOffset: number): boolean
  • Selects some text (adds a text selection) in an #AtspiText object.

    Parameters

    • startOffset: number

      the starting offset of the desired new selection.

    • endOffset: number

      the offset of the first character after the new selection.

    Returns boolean

  • 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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • clearCache(): void
  • Clears the cached information for the given accessible and all of its descendants.

    Returns void

  • clearSelection(): boolean
  • Clears the current selection, removing all selected children from the specified #AtspiSelection implementor's selection list.

    Returns boolean

  • Queries whether a given #AtspiComponent contains a particular point.

    Parameters

    • x: number

      a #gint specifying the x coordinate in question.

    • y: number

      a #gint specifying the y coordinate in question.

    • ctype: Atspi.CoordType

      the desired coordinate system of the point (x, y) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).

    Returns boolean

  • copyText(startPos: number, endPos: number): boolean
  • Copies text from an #AtspiEditableText object into the system clipboard.

    see: #atspi_editable_text_paste_text

    Parameters

    • startPos: number

      a #gint indicating the starting character offset of the text to copy.

    • endPos: number

      a #gint indicating the offset of the first character past the end of the text section to be copied.

    Returns boolean

  • cutText(startPos: number, endPos: number): boolean
  • Deletes text from an #AtspiEditableText object, copying the excised portion into the system clipboard.

    see: #atspi_editable_text_paste_text

    Parameters

    • startPos: number

      a #gint indicating the starting character offset of the text to cut.

    • endPos: number

      a #gint indicating the offset of the first character past the end of the text section to be cut.

    Returns boolean

  • deleteText(startPos: number, endPos: number): boolean
  • Deletes text from an #AtspiEditableText object, without copying the excised portion into the system clipboard.

    see: #atspi_editable_text_cut_text

    Parameters

    • startPos: number

      a #gint indicating the starting character offset of the text to delete.

    • endPos: number

      a #gint indicating the offset of the first character past the end of the text section to be deleted.

    Returns boolean

  • deselectChild(childIndex: number): boolean
  • Deselects a specific child of an #AtspiSelection. Note that child_index is the index of the child in the parent container.

    See #atspi_selection_deselect_selected_child

    Parameters

    • childIndex: number

      a #gint indicating which of the children of the #AtspiAccessible is to be de-selected.

    Returns boolean

  • deselectSelectedChild(selectedChildIndex: number): boolean
  • Removes a child from the selected children list of an #AtspiSelection. 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.

    Parameters

    • selectedChildIndex: number

      a #gint indicating which of the selected children of the #Accessible is to be selected.

    Returns boolean

  • doAction(i: number): boolean
  • Invoke the action indicated by #index.

    Parameters

    • i: number

      an integer specifying which action to invoke.

    Returns boolean

  • emit(sigName: "mode-changed", why: string, ...args: any[]): void
  • emit(sigName: "region-changed", arg2: number, ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "mode-changed"
    • why: string
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "region-changed"
    • arg2: number
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • forceFloating(): void
  • This function is intended for #GObject 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().

    Returns void

  • freezeNotify(): void
  • 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::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.

    Returns void

  • 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.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns Atspi.Accessible

  • Gets the accessible child at a given coordinate within an #AtspiComponent.

    Parameters

    • x: number

      a #gint specifying the x coordinate of the point in question.

    • y: number

      a #gint specifying the y coordinate of the point in question.

    • ctype: Atspi.CoordType

      the coordinate system of the point (x, y) (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).

    Returns Atspi.Accessible

  • getAccessibleId(): string
  • 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.

    Returns string

  • getActionDescription(i: number): string
  • Get the description of 'i-th' action invocable on an object implementing #AtspiAction.

    Parameters

    • i: number

      an integer indicating which action to query.

    Returns string

  • getActionName(i: number): string
  • Get the name of the 'i-th' action invocable on an object implementing #AtspiAction.

    Parameters

    • i: number

      an integer indicating which action to query.

    Returns string

  • getAlpha(): number
  • getAtspiVersion(): string
  • Gets the AT-SPI IPC specification version supported by the application pointed to by the #AtspiAccessible object. Only works on application root objects.

    Returns string

  • getAttributeRun(offset: number, includeDefaults: boolean): [HashTable<string | number | symbol, string | number | boolean>, number, number]
  • Gets a set of attributes applied to a range of text from an #AtspiText object, optionally including its 'default' attributes.

    Parameters

    • offset: number

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

    • includeDefaults: boolean

      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 [HashTable<string | number | symbol, string | number | boolean>, number, number]

  • getAttributes(): HashTable<string | number | symbol, string | number | boolean>
  • 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 HashTable<string | number | symbol, string | number | boolean>

  • getAttributesAsArray(): string[]
  • Gets a #GArray 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 string[]

  • Gets the ranges of text from an #AtspiText object which lie within the bounds defined by (x, y) and (x+``width, y+``height).

    Parameters

    • x: number

      the 'starting' x coordinate of the bounding box.

    • y: number

      the 'starting' y coordinate of the bounding box.

    • width: number

      the x extent of the bounding box.

    • height: number

      the y extent of the bounding box.

    • type: Atspi.CoordType

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

    • clipTypeX: Atspi.TextClipType

      an #AtspiTextClipType indicating how to treat characters that intersect the bounding box's x extents.

    • clipTypeY: Atspi.TextClipType

      an #AtspiTextClipType indicating how to treat characters that intersect the bounding box's y extents.

    Returns Atspi.TextRange[]

  • getCaretOffset(): number
  • getCharacterAtOffset(offset: number): number
  • Gets the character at a given offset for an #AtspiText object.

    Parameters

    • offset: number

      a #gint indicating the text offset where the desired character is located.

    Returns number

  • getCharacterCount(): number
  • 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.

    Parameters

    • offset: number

      a #gint indicating the offset of the text character for whom boundary information is requested.

    • type: Atspi.CoordType

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

    Returns Atspi.Rect

  • Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index.

    Parameters

    • childIndex: number

      a #long indicating which child is specified.

    Returns Atspi.Accessible

  • getChildCount(): number
  • Gets the number of children contained by an #AtspiAccessible object.

    Returns number

  • getColumnAtIndex(index: number): number
  • 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

    Parameters

    • index: number

      the specified child index, zero-indexed.

    Returns number

  • getColumnDescription(column: number): string
  • Gets a text description of a particular table column. This differs from #atspi_table_get_column_header, which returns an #Accessible.

    Parameters

    • column: number

      the specified table column, zero-indexed.

    Returns string

  • getColumnExtentAt(row: number, column: number): number
  • 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.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns number

  • Gets the header associated with a table column, if available. This differs from #atspi_table_get_column_description, which returns a string.

    Parameters

    • column: number

      the specified table column, zero-indexed.

    Returns Atspi.Accessible

  • getColumnIndex(): number
  • getColumnSpan(): number
  • 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.

    Returns number

  • getCurrentPageNumber(): number
  • getCurrentValue(): number
  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDefaultAttributes(): HashTable<string | number | symbol, string | number | boolean>
  • Gets the default attributes applied to an #AtspiText 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 HashTable<string | number | symbol, string | number | boolean>

  • getDescription(): string
  • Gets the description of an #AtspiAccessible object.

    Returns string

  • getDocumentAttributeValue(attribute: string): string
  • getDocumentAttributes(): HashTable<string | number | symbol, string | number | boolean>
  • 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 HashTable<string | number | symbol, string | number | boolean>

  • Gets the bounding box of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • ctype: Atspi.CoordType

      the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).

    Returns Atspi.Rect

  • getId(): number
  • Gets the application id for a #AtspiAccessible object. Only works on application root objects.

    Returns number

  • getImageDescription(): string
  • Gets the bounding box of the image displayed in a specified #AtspiImage implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • ctype: Atspi.CoordType

      the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).

    Returns Atspi.Rect

  • getImageLocale(): string
  • Gets the minimum x and y coordinates of the image displayed in a specified #AtspiImage implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • ctype: Atspi.CoordType

      the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).

    Returns Atspi.Point

  • Gets the size of the image displayed in a specified #AtspiImage object. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.

    Returns Atspi.Point

  • getIndexAt(row: number, column: number): number
  • 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

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns number

  • getIndexInParent(): number
  • Gets the index of an #AtspiAccessible object within its parent's #AtspiAccessible children list.

    Returns number

  • getInterfaces(): string[]
  • A set of pointers to all interfaces supported by an #AtspiAccessible.

    Returns string[]

  • getKeyBinding(i: number): string
  • Get the keybindings for the i-th action invocable on an object implementing #AtspiAction, 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.

    Parameters

    • i: number

      an integer indicating which action to query.

    Returns string

  • getLinkIndex(characterOffset: number): number
  • Gets the index of the #AtspiHyperlink object at a specified character offset.

    Parameters

    • characterOffset: number

      a #gint specifying the character offset to query.

    Returns number

  • getLocale(): string
  • getLocalizedName(i: number): string
  • Get the name of the 'i-th' action invocable on an object implementing #AtspiAction.

    Parameters

    • i: number

      an integer indicating which action to query.

    Returns string

  • getLocalizedRoleName(): 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 ().

    Returns string

  • Gets all #AtspiAccessible objects from the collection matching a given rule.

    Parameters

    • rule: MatchRule

      An #AtspiMatchRule describing the match criteria.

    • sortby: CollectionSortOrder

      An #AtspiCollectionSortOrder specifying the way the results are to be sorted.

    • count: number

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

    • traverse: boolean

      Not supported.

    Returns Atspi.Accessible[]

  • Gets all #AtspiAccessible objects from the collection, before current_object, matching a given rule.

    Parameters

    • currentObject: Atspi.Accessible

      Upon reaching this object, searching should stop.

    • rule: MatchRule

      An #AtspiMatchRule describing the match criteria.

    • sortby: CollectionSortOrder

      An #AtspiCollectionSortOrder specifying the way the results are to be sorted.

    • tree: CollectionTreeTraversalType

      An #AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed.

    • count: number

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

    • traverse: boolean

      Not supported.

    Returns Atspi.Accessible[]

  • Gets all #AtspiAccessible objects from the collection, after current_object, matching a given rule.

    Parameters

    • currentObject: Atspi.Accessible

      The object at which to start searching.

    • rule: MatchRule

      An #AtspiMatchRule describing the match criteria.

    • sortby: CollectionSortOrder

      An #AtspiCollectionSortOrder specifying the way the results are to be sorted.

    • tree: CollectionTreeTraversalType

      An #AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed.

    • limitScope: boolean

      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: number

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

    • traverse: boolean

      Not supported.

    Returns Atspi.Accessible[]

  • getMaximumValue(): number
  • getMdiZOrder(): number
  • Queries the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top)

    Returns number

  • getMinimumIncrement(): number
  • getMinimumValue(): number
  • getNActions(): number
  • getNColumns(): number
  • Gets the number of columns in an #AtspiTable, exclusive of any columns that are programmatically hidden, but inclusive of columns that may be outside of the current scrolling window or viewport.

    Returns number

  • getNLinks(): number
  • getNRows(): number
  • Gets the number of rows in an #AtspiTable, exclusive of any rows that are programmatically hidden, but inclusive of rows that may be outside of the current scrolling window or viewport.

    Returns number

  • getNSelectedChildren(): number
  • getNSelectedColumns(): number
  • getNSelectedRows(): number
  • getNSelections(): number
  • getName(): string
  • getObjectLocale(): string
  • Gets the character offset into the text at a given point.

    Parameters

    • x: number

      the x coordinate of the point to be queried.

    • y: number

      the y coordinate of the point to be queried.

    • type: Atspi.CoordType

      an #AtspiCoordType indicating the coordinate system in which the values should be returned.

    Returns number

  • getPageCount(): number
  • getPosition(...args: any[]): any
  • Gets the minimum x and y coordinates of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • Rest ...args: any[]

    Returns any

  • getProcessId(): number
  • 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.

    Returns number

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • Gets the bounding box for text within a range in an #AtspiText object. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • startOffset: number

      a #gint indicating the offset of the first text character for whom boundary information is requested.

    • endOffset: number

      a #gint indicating the offset of the text character after the last character for whom boundary information is requested.

    • type: Atspi.CoordType

      an #AtspiCoordType indicating the coordinate system to use for the returned values.

    Returns Atspi.Rect

  • Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's relationships with other #AtspiAccessible objects.

    Returns Atspi.Relation[]

  • Gets the UI role played by an #AtspiAccessible object. This role's name can be obtained via atspi_accessible_get_role_name ().

    Returns Atspi.Role

  • getRoleName(): string
  • 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 ().

    Returns string

  • getRowAtIndex(index: number): number
  • 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

    Parameters

    • index: number

      the specified child index, zero-indexed.

    Returns number

  • getRowColumnExtentsAtIndex(index: number): [boolean, number, number, number, number, boolean]
  • 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 #AtspiTable child at index '6' extends across columns 5 and 6 of row 2 of an #AtspiTable 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.

    Parameters

    • index: number

      the index of the #AtspiTable child whose row/column extents are requested.

    Returns [boolean, number, number, number, number, boolean]

  • getRowColumnSpan(): [number, number, number, number]
  • 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.

    Returns [number, number, number, number]

  • getRowDescription(row: number): string
  • Gets a text description of a particular table row. This differs from #atspi_table_get_row_header, which returns an #AtspiAccessible.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    Returns string

  • getRowExtentAt(row: number, column: number): number
  • 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.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns number

  • Gets the header associated with a table row, if available. This differs from #atspi_table_get_row_description, which returns a string.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    Returns Atspi.Accessible

  • getRowSpan(): number
  • 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.

    Returns number

  • Gets the i-th selected #AtspiAccessible child of an #AtspiSelection. 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.

    Parameters

    • selectedChildIndex: number

      a #gint indicating which of the selected children is specified.

    Returns Atspi.Accessible

  • getSelectedColumns(): number[]
  • getSelectedRows(): number[]
  • Gets the bounds of the selection_num-th active text selection for an #AtspiText object.

    Parameters

    • selectionNum: number

      a #gint indicating which selection to query.

    Returns Atspi.Range

  • Gets the size of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.

    Returns Atspi.Point

  • Gets a portion of the text exposed through an #AtspiText 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.

    Parameters

    Returns Atspi.TextRange

  • getText(startOffset: number, endOffset: number): string
  • Gets a range of text from an #AtspiText 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.

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    Returns string

  • Gets delimited text from an #AtspiText object which follows a given text offset.

    Parameters

    • offset: number

      a #gint indicating the offset from which the delimiter search is based.

    • type: TextBoundaryType

      an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.

    Returns Atspi.TextRange

  • Gets delimited text from an #AtspiText object which includes a given text offset.

    Parameters

    • offset: number

      a #gint indicating the offset from which the delimiter search is based.

    • type: TextBoundaryType

      an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.

    Returns Atspi.TextRange

  • getTextAttributeValue(offset: number, attributeName: string): string
  • Gets the value of a named attribute at a given offset.

    Parameters

    • offset: number

      The character offset at which to query the attribute.

    • attributeName: string

      The attribute to query.

    Returns string

  • getTextAttributes(offset: number): [HashTable<string | number | symbol, string | number | boolean>, number, number]
  • Gets the attributes applied to a range of text from an #AtspiText object. The text attributes correspond to CSS attributes where possible. DEPRECATED

    Parameters

    • offset: number

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

    Returns [HashTable<string | number | symbol, string | number | boolean>, number, number]

  • Gets delimited text from an #AtspiText object which precedes a given text offset.

    Parameters

    • offset: number

      a #gint indicating the offset from which the delimiter search is based.

    • type: TextBoundaryType

      an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.

    Returns Atspi.TextRange

  • getToolkitName(): string
  • Gets the toolkit name for an #AtspiAccessible object. Only works on application root objects.

    Returns string

  • getToolkitVersion(): string
  • Gets the toolkit version for an #AtspiAccessible object. Only works on application root objects.

    Returns string

  • getv(names: string[], values: any[]): void
  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • grabFocus(): boolean
  • insertText(position: number, text: string, length: number): boolean
  • Inserts text into an #AtspiEditableText 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.

    Parameters

    • position: number

      a #gint indicating the character offset at which to insert the new text.

    • text: string

      a string representing the text to insert, in UTF-8 encoding.

    • length: number

      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.

    Returns boolean

  • isChildSelected(childIndex: number): boolean
  • Determines whether a particular child of an #AtspiSelection implementor is currently selected. Note that child_index is the index into the standard #AtspiAccessible container's list of children.

    Parameters

    • childIndex: number

      an index into the #AtspiSelection's list of children.

    Returns boolean

  • isColumnSelected(column: number): boolean
  • Determines whether specified table column is selected. Not all tables support column selection.

    Parameters

    • column: number

      the zero-indexed column number of the column being queried.

    Returns boolean

  • isFloating(): boolean
  • isRowSelected(row: number): boolean
  • Determines whether a table row is selected. Not all tables support row selection.

    Parameters

    • row: number

      the zero-indexed row number of the row being queried.

    Returns boolean

  • isSelected(row: number, column: number): boolean
  • Determines whether the cell at a specific row and column is selected.

    Parameters

    • row: number

      the zero-indexed row of the cell being queried.

    • column: number

      the zero-indexed column of the cell being queried.

    Returns boolean

  • notify(propertyName: string): void
  • 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.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • pasteText(position: number): boolean
  • Inserts text from the system clipboard into an #AtspiEditableText 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.

    Parameters

    • position: number

      a #gint indicating the character offset at which to insert the new text.

    Returns boolean

  • 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.

    Returns GObject.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().

    Returns GObject.Object

  • removeColumnSelection(column: number): boolean
  • De-selects the specified column, removing it from the current column selection. Not all tables support column selection.

    Parameters

    • column: number

      the zero-indexed column number of the column being de-selected.

    Returns boolean

  • removeRowSelection(row: number): boolean
  • De-selects the specified row, removing it from the current row selection. Not all tables support row selection.

    Parameters

    • row: number

      the zero-indexed number of the row being de-selected.

    Returns boolean

  • removeSelection(selectionNum: number): boolean
  • De-selects a text selection.

    Parameters

    • selectionNum: number

      a #gint indicating which text selection to remove.

    Returns boolean

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • scrollSubstringTo(startOffset: number, endOffset: number, type: Atspi.ScrollType): boolean
  • Scrolls whatever container of the #AtspiText text range so it becomes visible on the screen.

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    • type: Atspi.ScrollType

      a #AtspiScrollType indicating where the object should be placed on the screen.

    Returns boolean

  • scrollSubstringToPoint(startOffset: number, endOffset: number, coords: Atspi.CoordType, x: number, y: number): boolean
  • Scrolls whatever container of the #AtspiText text range so it becomes visible on the screen at a given position.

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    • coords: Atspi.CoordType

      a #AtspiCoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object.

    • x: number

      the x coordinate of the point to reach

    • y: number

      the y coordinate of the point to reach

    Returns boolean

  • Scrolls whatever container of the #AtspiComponent object so it becomes visible on the screen.

    Parameters

    • type: Atspi.ScrollType

      a #AtspiScrollType indicating where the object should be placed on the screen.

    Returns boolean

  • Scrolls whatever container of the #AtspiComponent object so it becomes visible on the screen at a given position.

    Parameters

    • coords: Atspi.CoordType

      a #AtspiCoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object.

    • x: number

      the x coordinate of the point to reach

    • y: number

      the y coordinate of the point to reach

    Returns boolean

  • selectAll(): boolean
  • Attempts to select all of the children of an #AtspiSelection implementor. Not all #AtspiSelection implementors support this operation.

    Returns boolean

  • selectChild(childIndex: number): boolean
  • Adds a child to the selected children list of an #AtspiSelection. For #AtspiSelection implementors that only allow single selections, this may replace the (single) current selection.

    Parameters

    • childIndex: number

      a #gint indicating which child of the #Accessible is to be selected.

    Returns boolean

  • 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.

    Parameters

    • mask: Atspi.Cache

      An #AtspiCache specifying a bit mask of the types of data to cache.

    Returns void

  • setCaretOffset(newOffset: number): boolean
  • Moves the text caret to a given position.

    Parameters

    • newOffset: number

      the offset to which the text caret is to be moved.

    Returns boolean

  • setCurrentValue(newValue: number): boolean
  • Sets the current value of an #AtspiValue.

    Parameters

    • newValue: number

      a #gdouble value which is the desired new value of the object.

    Returns boolean

  • setData(key: string, data?: object): void
  • 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setExtents(x: number, y: number, width: number, height: number, ctype: Atspi.CoordType): boolean
  • Moves and resizes the specified component.

    Parameters

    • x: number

      the new vertical position to which the component should be moved.

    • y: number

      the new horizontal position to which the component should be moved.

    • width: number

      the width to which the component should be resized.

    • height: number

      the height to which the component should be resized.

    • ctype: Atspi.CoordType

      the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).

    Returns boolean

  • Moves the component to the specified position.

    Parameters

    • x: number

      the new vertical position to which the component should be moved.

    • y: number

      the new horizontal position to which the component should be moved.

    • ctype: Atspi.CoordType

      the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).

    Returns boolean

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setSelection(selectionNum: number, startOffset: number, endOffset: number): boolean
  • Changes the bounds of an existing #AtspiText text selection.

    Parameters

    • selectionNum: number

      a zero-offset index indicating which text selection to modify.

    • startOffset: number

      a #gint indicating the new starting offset for the selection.

    • endOffset: number

      a #gint indicating the desired new offset of the first character after the selection.

    Returns boolean

  • setSize(width: number, height: number): boolean
  • Resizes the specified component to the given coordinates.

    Parameters

    • width: number

      the width to which the component should be resized.

    • height: number

      the height to which the component should be resized.

    Returns boolean

  • setTextContents(newContents: string): boolean
  • Replace the entire text contents of an #AtspiEditableText object.

    Parameters

    • newContents: string

      a character string, encoded in UTF-8, which is to become the new text contents of the #AtspiEditableText object.

    Returns boolean

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • 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::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.

    Returns void

  • unref(): void
  • 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 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 instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • 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.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method