Class (GI Class)

Atk-1.0AtkNoOpObject

An AtkObject which purports to implement all ATK interfaces.

An AtkNoOpObject is an AtkObject which purports to implement all ATK interfaces. It is the type of AtkObject which is created if an accessible object is requested for an object type for which no factory type is specified.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Properties - Inherited from Atk.Object

Accessors - Inherited from Atk.Object

Methods

_init add_column_selection add_relationship add_row_selection add_selection bind_property bind_property_full block_signal_handler clear_selection connect connect_after contains copy_text cut_text delete_text disconnect do_action emit force_floating freeze_notify get_accessible_id get_alpha get_attribute_value get_attributes get_bounded_ranges get_caption get_caret_offset get_character_at_offset get_character_count get_character_extents get_column_at_index get_column_description get_column_extent_at get_column_header get_column_header_cells get_column_span get_current_page_number get_current_value get_data get_default_attributes get_description get_document get_document_type get_extents get_help_text get_image_description get_image_locale get_image_position get_image_size get_increment get_index_at get_index_in_parent get_keybinding get_layer get_link get_link_index get_locale get_localized_name get_maximum_value get_mdi_zorder get_minimum_increment get_minimum_value get_n_accessible_children get_n_actions get_n_columns get_n_links get_n_rows get_n_selections get_name get_object_locale get_offset_at_point get_page_count get_parent get_position get_property get_qdata get_range get_range_extents get_role get_row_at_index get_row_column_span get_row_description get_row_extent_at get_row_header get_row_header_cells get_row_span get_run_attributes get_selected_columns get_selected_rows get_selection get_selection_count get_size get_string_at_offset get_sub_ranges get_summary get_table get_text get_text_after_offset get_text_at_offset get_text_before_offset get_text_selections get_value_and_text getv grab_focus initialize insert_text is_child_selected is_column_selected is_floating is_row_selected is_selected notify notify_by_pspec notify_state_change paste_text peek_parent ref ref_accessible_at_point ref_accessible_child ref_at ref_relation_set ref_selection ref_sink ref_state_set remove_column_selection remove_focus_handler remove_property_change_handler remove_relationship remove_row_selection remove_selection run_dispose scroll_substring_to scroll_substring_to_point scroll_to scroll_to_point select_all_selection set set_accessible_id set_attribute_value set_caption set_caret_offset set_column_description set_column_header set_current_value set_data set_description set_extents set_help_text set_image_description set_name set_parent set_position set_property set_role set_row_description set_row_header set_run_attributes set_selection set_size set_summary set_text_contents set_text_selections set_value steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_active_descendant_changed vfunc_add_column_selection vfunc_add_row_selection vfunc_add_selection vfunc_bounds_changed vfunc_children_changed vfunc_clear_selection vfunc_column_deleted vfunc_column_inserted vfunc_column_reordered vfunc_constructed vfunc_contains vfunc_copy_text vfunc_cut_text vfunc_delete_text vfunc_dispatch_properties_changed vfunc_dispose vfunc_do_action vfunc_finalize vfunc_focus_event vfunc_get_alpha vfunc_get_attributes vfunc_get_bounded_ranges vfunc_get_caption vfunc_get_caret_offset vfunc_get_character_at_offset vfunc_get_character_count vfunc_get_character_extents vfunc_get_column_at_index vfunc_get_column_description vfunc_get_column_extent_at vfunc_get_column_header vfunc_get_column_header_cells vfunc_get_column_span vfunc_get_current_page_number vfunc_get_current_value vfunc_get_default_attributes vfunc_get_description vfunc_get_document vfunc_get_document_attribute_value vfunc_get_document_attributes vfunc_get_document_locale vfunc_get_document_type vfunc_get_extents vfunc_get_image_description vfunc_get_image_locale vfunc_get_image_position vfunc_get_image_size vfunc_get_increment vfunc_get_index_at vfunc_get_index_in_parent vfunc_get_keybinding vfunc_get_layer vfunc_get_link vfunc_get_link_index vfunc_get_localized_name vfunc_get_maximum_value vfunc_get_mdi_zorder vfunc_get_minimum_increment vfunc_get_minimum_value vfunc_get_n_actions vfunc_get_n_children vfunc_get_n_columns vfunc_get_n_links vfunc_get_n_rows vfunc_get_n_selections vfunc_get_name vfunc_get_object_locale vfunc_get_offset_at_point vfunc_get_page_count vfunc_get_parent vfunc_get_position vfunc_get_property vfunc_get_range vfunc_get_range_extents vfunc_get_role vfunc_get_row_at_index vfunc_get_row_column_span vfunc_get_row_description vfunc_get_row_extent_at vfunc_get_row_header vfunc_get_row_header_cells vfunc_get_row_span vfunc_get_run_attributes vfunc_get_selected_columns vfunc_get_selected_rows vfunc_get_selection vfunc_get_selection_count vfunc_get_size vfunc_get_string_at_offset vfunc_get_sub_ranges vfunc_get_summary vfunc_get_table vfunc_get_text vfunc_get_text_after_offset vfunc_get_text_at_offset vfunc_get_text_before_offset vfunc_get_text_selections vfunc_get_value_and_text vfunc_grab_focus vfunc_initialize vfunc_insert_text vfunc_is_child_selected vfunc_is_column_selected vfunc_is_row_selected vfunc_is_selected vfunc_link_selected vfunc_model_changed vfunc_notify vfunc_paste_text vfunc_property_change vfunc_ref_accessible_at_point vfunc_ref_at vfunc_ref_relation_set vfunc_ref_selection vfunc_ref_state_set vfunc_remove_column_selection vfunc_remove_focus_handler vfunc_remove_property_change_handler vfunc_remove_row_selection vfunc_remove_selection vfunc_row_deleted vfunc_row_inserted vfunc_row_reordered vfunc_scroll_substring_to vfunc_scroll_substring_to_point vfunc_scroll_to vfunc_scroll_to_point vfunc_select_all_selection vfunc_selection_changed vfunc_set_caption vfunc_set_caret_offset vfunc_set_column_description vfunc_set_column_header vfunc_set_current_value vfunc_set_description vfunc_set_document_attribute vfunc_set_extents vfunc_set_image_description vfunc_set_name vfunc_set_parent vfunc_set_position vfunc_set_property vfunc_set_role vfunc_set_row_description vfunc_set_row_header vfunc_set_run_attributes vfunc_set_selection vfunc_set_size vfunc_set_summary vfunc_set_text_contents vfunc_set_text_selections vfunc_set_value vfunc_state_change vfunc_text_attributes_changed vfunc_text_caret_moved vfunc_text_changed vfunc_text_selection_changed vfunc_visible_data_changed watch_closure new

Methods - Inherited from Atk.Object

Constructors

Properties

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.

Properties - Inherited from Atk.Object

description: string
layer: Atk.Layer
name: string
relation_set: Atk.RelationSet
role: Atk.Role

Accessors - Inherited from Atk.Object

  • get accessible_component_layer(): number

    Returns number

  • get accessible_component_mdi_zorder(): number

    Returns number

  • get accessible_description(): string

    Returns string

  • set accessible_description(val: string): void

    Parameters

    • val: string

    Returns void

  • get accessible_help_text(): string

    Returns string

  • set accessible_help_text(val: string): void

    Parameters

    • val: string

    Returns void

  • Returns number

  • get accessible_id(): string

    Returns string

  • set accessible_id(val: string): void

    Parameters

    • val: string

    Returns void

  • get accessible_name(): string

    Returns string

  • set accessible_name(val: string): void

    Parameters

    • val: string

    Returns void

  • get accessible_table_caption(): string

    Table caption.

    Returns string

    Since 1.3. Use table-caption-object instead.

  • set accessible_table_caption(val: string): void

    Table caption.

    Parameters

    • Deprecatedval: string

    Returns void

    Since 1.3. Use table-caption-object instead.

  • get accessible_table_caption_object(): Atk.Object

    Returns Atk.Object

  • set accessible_table_caption_object(val: Atk.Object): void

    Parameters

    Returns void

  • get accessible_table_column_description(): string

    Accessible table column description.

    Returns string

    Since 2.12. Use atk_table_get_column_description() and atk_table_set_column_description() instead.

  • set accessible_table_column_description(val: string): void

    Accessible table column description.

    Parameters

    • Deprecatedval: string

    Returns void

    Since 2.12. Use atk_table_get_column_description() and atk_table_set_column_description() instead.

  • get accessible_table_column_header(): Atk.Object

    Accessible table column header.

    Returns Atk.Object

    Since 2.12. Use atk_table_get_column_header() and atk_table_set_column_header() instead.

  • set accessible_table_column_header(val: Atk.Object): void

    Accessible table column header.

    Parameters

    Returns void

    Since 2.12. Use atk_table_get_column_header() and atk_table_set_column_header() instead.

  • get accessible_table_row_description(): string

    Accessible table row description.

    Returns string

    Since 2.12. Use atk_table_get_row_description() and atk_table_set_row_description() instead.

  • set accessible_table_row_description(val: string): void

    Accessible table row description.

    Parameters

    • Deprecatedval: string

    Returns void

    Since 2.12. Use atk_table_get_row_description() and atk_table_set_row_description() instead.

  • get accessible_table_row_header(): Atk.Object

    Accessible table row header.

    Returns Atk.Object

    Since 2.12. Use atk_table_get_row_header() and atk_table_set_row_header() instead.

  • set accessible_table_row_header(val: Atk.Object): void

    Accessible table row header.

    Parameters

    Returns void

    Since 2.12. Use atk_table_get_row_header() and atk_table_set_row_header() instead.

  • get accessible_value(): number

    Numeric value of this object, in case being and AtkValue.

    Returns number

    Since 2.12. Use atk_value_get_value_and_text() to get the value, and value-changed signal to be notified on their value changes.

  • set accessible_value(val: number): void

    Numeric value of this object, in case being and AtkValue.

    Parameters

    • Deprecatedval: number

    Returns void

    Since 2.12. Use atk_value_get_value_and_text() to get the value, and value-changed signal to be notified on their value changes.

  • get accessibleComponentLayer(): number

    Returns number

  • get accessibleComponentMdiZorder(): number

    Returns number

  • get accessibleDescription(): string

    Returns string

  • set accessibleDescription(val: string): void

    Parameters

    • val: string

    Returns void

  • get accessibleHelpText(): string

    Returns string

  • set accessibleHelpText(val: string): void

    Parameters

    • val: string

    Returns void

  • Returns number

  • get accessibleId(): string

    Returns string

  • set accessibleId(val: string): void

    Parameters

    • val: string

    Returns void

  • get accessibleName(): string

    Returns string

  • set accessibleName(val: string): void

    Parameters

    • val: string

    Returns void

  • get accessibleTableCaption(): string

    Table caption.

    Returns string

    Since 1.3. Use table-caption-object instead.

  • set accessibleTableCaption(val: string): void

    Table caption.

    Parameters

    • Deprecatedval: string

    Returns void

    Since 1.3. Use table-caption-object instead.

  • get accessibleTableCaptionObject(): Atk.Object

    Returns Atk.Object

  • set accessibleTableCaptionObject(val: Atk.Object): void

    Parameters

    Returns void

  • get accessibleTableColumnDescription(): string

    Accessible table column description.

    Returns string

    Since 2.12. Use atk_table_get_column_description() and atk_table_set_column_description() instead.

  • set accessibleTableColumnDescription(val: string): void

    Accessible table column description.

    Parameters

    • Deprecatedval: string

    Returns void

    Since 2.12. Use atk_table_get_column_description() and atk_table_set_column_description() instead.

  • get accessibleTableColumnHeader(): Atk.Object

    Accessible table column header.

    Returns Atk.Object

    Since 2.12. Use atk_table_get_column_header() and atk_table_set_column_header() instead.

  • set accessibleTableColumnHeader(val: Atk.Object): void

    Accessible table column header.

    Parameters

    Returns void

    Since 2.12. Use atk_table_get_column_header() and atk_table_set_column_header() instead.

  • get accessibleTableRowDescription(): string

    Accessible table row description.

    Returns string

    Since 2.12. Use atk_table_get_row_description() and atk_table_set_row_description() instead.

  • set accessibleTableRowDescription(val: string): void

    Accessible table row description.

    Parameters

    • Deprecatedval: string

    Returns void

    Since 2.12. Use atk_table_get_row_description() and atk_table_set_row_description() instead.

  • get accessibleTableRowHeader(): Atk.Object

    Accessible table row header.

    Returns Atk.Object

    Since 2.12. Use atk_table_get_row_header() and atk_table_set_row_header() instead.

  • set accessibleTableRowHeader(val: Atk.Object): void

    Accessible table row header.

    Parameters

    Returns void

    Since 2.12. Use atk_table_get_row_header() and atk_table_set_row_header() instead.

  • get accessibleValue(): number

    Numeric value of this object, in case being and AtkValue.

    Returns number

    Since 2.12. Use atk_value_get_value_and_text() to get the value, and value-changed signal to be notified on their value changes.

  • set accessibleValue(val: number): void

    Numeric value of this object, in case being and AtkValue.

    Parameters

    • Deprecatedval: number

    Returns void

    Since 2.12. Use atk_value_get_value_and_text() to get the value, and value-changed signal to be notified on their value changes.

Methods

  • Adds the specified column to the selection.

    Parameters

    • column: number

      a gint representing a column in table

    Returns boolean

    a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface.

  • Adds the specified row to the selection.

    Parameters

    • row: number

      a gint representing a row in table

    Returns boolean

    a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface.

  • Adds the specified accessible child of the object to the object's selection.

    Parameters

    • i: number

      a gint specifying the child index.

    Returns boolean

    TRUE if success, 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.

    Parameters

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

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

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

  • 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

    • ...args: never[]

      the property on source to bind

    Returns any

    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.

  • Checks whether the specified point is within the extent of the component.

    Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns boolean

    true or false indicating whether the specified point is within the extent of the component or not

  • Copy text from start_pos up to, but not including end_pos to the clipboard.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

  • Copy text from start_pos up to, but not including end_pos to the clipboard and then delete from the widget.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

  • Delete text start_pos up to, but not including end_pos.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

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

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • Perform the specified action on the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns boolean

    true if success, false otherwise

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

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

    Returns void

  • Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

    Returns number

    An alpha value from 0 to 1.0, inclusive.

  • Retrieves the value of the given attribute_name inside document.

    Parameters

    • attribute_name: string

      a character string representing the name of the attribute whose value is being queried.

    Returns string

    a string value associated with the named attribute for this document, or null if a value for attribute_name has not been specified for this document.

  • Gets the offset of the position of the caret (cursor).

    Returns number

    the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure.

  • Gets the specified text.

    Parameters

    • offset: number

      a character offset within text

    Returns string

    the character at offset or 0 in the case of failure.

  • If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.

    Get the bounding box containing the glyph representing the character at a particular text offset.

    Parameters

    • offset: number

      The offset of the text character for which bounding information is required.

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or widget window

    Returns [number, number, number, number]

  • Gets a gint representing the column at the specified index_.

    Parameters

    • index_: number

      a gint representing an index in table

    Returns number

    a gint representing the column at the specified index, or -1 if the table does not implement this method.

  • Gets the description text of the specified column in the table

    Parameters

    • column: number

      a gint representing a column in table

    Returns string

    a gchar* representing the column description, or null if value does not implement this interface.

  • Gets the number of columns occupied by the accessible object at the specified row and column in the table.

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns number

    a gint representing the column extent at specified position, or 0 if value does not implement this interface.

  • Gets the column header of a specified column in an accessible table.

    Parameters

    • column: number

      a gint representing a column in the table

    Returns Atk.Object

    a AtkObject* representing the specified column header, or null if value does not implement this interface.

  • Returns the number of columns occupied by this cell accessible.

    Returns number

    a gint representing the number of columns occupied by this cell, or 0 if the cell does not implement this method.

  • Retrieves the current page number inside document.

    Returns number

    the current page number inside document, or -1 if not implemented, not know by the implementor, or irrelevant.

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Returns a description of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

    a description string, or null if action does not implement this interface.

  • Parameters

    • ...args: never[]

    Returns any

  • Gets a %gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer.

    Returns any

    a %gpointer that points to an instance of the DOM.

  • Gets the rectangle which gives the extent of the component.

    If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number, number, number]

  • Retrieves the locale identifier associated to the Atk.Image.

    Returns string

    a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or null if the image does not specify a locale.

  • Gets the position of the image in the form of a point specifying the images top-left corner.

    If the position can not be obtained (e.g. missing support), x and y are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number]

  • Get the width and height in pixels for the specified image. The values of width and height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen).

    If the size can not be obtained (e.g. missing support), x and y are set to -1.

    Returns [number, number]

  • Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

    Returns number

    the minimum increment by which the value of this object may be changed. zero if undefined.

  • Gets a gint representing the index at the specified row and column.

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns number

    a gint representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

  • Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut".

    • The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for a button.
    • The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a traditional "New..." menu item.
    • The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a traditional "New..." menu item.

    Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

    the keybinding which can be used to activate this action, or null if there is no keybinding for this action.

  • Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

    Parameters

    • char_index: number

      a character index

    Returns number

    an index into the array of hyperlinks in hypertext, or -1 if there is no hyperlink associated with this character.

  • Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and atk_image_get_image_locale.

    Returns string

    a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale.

  • Returns the localized name of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

    a name string, or null if action does not implement this interface.

  • Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.

    Returns number

    a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container.

  • Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

    Returns unknown

  • Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object.

    Returns number

    a the number of actions, or 0 if action does not implement this interface.

  • Gets the number of columns in the table.

    Returns number

    a gint representing the number of columns, or 0 if value does not implement this interface.

  • Gets the number of rows in the table.

    Returns number

    a gint representing the number of rows, or 0 if value does not implement this interface.

  • Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. "click", "press", "release", "drag", "drop", "popup", etc. The "popup" action should be used to pop up a context menu for the object, if one exists.

    For technical reasons, some toolkits cannot guarantee that the reported action is actually 'bound' to a nontrivial user event; i.e. the result of some actions via atk_action_do_action() may be NIL.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

    a name string, or null if action does not implement this interface.

  • Parameters

    • ...args: never[]

    Returns any

  • Gets the offset of the character located at coordinates x and y. x and y are interpreted as being relative to the screen or this widget's window depending on coords.

    Parameters

    • x: number

      screen x-position of character

    • y: number

      screen y-position of character

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or widget window

    Returns number

    the offset to the character which is located at the specified x and y coordinates of -1 in case of failure.

  • Retrieves the total number of pages inside document.

    Returns number

    total page count of document, or -1 if not implemented, not know by the implementor or irrelevant.

  • Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method.

    If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().

    Returns Atk.Object

    an Atk.Object representing the accessible parent of the accessible

  • Gets the position of component in the form of a point specifying component's top-left corner.

    If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number]

  • Parameters

    • ...args: never[]

    Returns any

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value 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 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.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      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

    Returns any

  • Get the bounding box for text within the specified range.

    If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1.

    Parameters

    • start_offset: number

      The offset of the first text character for which boundary information is required.

    • end_offset: number

      The offset of the text character after the last character for which boundary information is required.

    • coord_type: Atk.CoordType

      Specify whether coordinates are relative to the screen or widget window.

    Returns TextRectangle

  • Gets a gint representing the row at the specified index_.

    Parameters

    • index_: number

      a gint representing an index in table

    Returns number

    a gint representing the row at the specified index, or -1 if the table does not implement this method.

  • Gets the row and column indexes and span of this cell accessible.

    Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object.

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

    TRUE if successful; FALSE otherwise.

  • Gets the description text of the specified row in the table

    Parameters

    • row: number

      a gint representing a row in table

    Returns string

    a gchar* representing the row description, or null if value does not implement this interface.

  • Gets the number of rows occupied by the accessible object at a specified row and column in the table.

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns number

    a gint representing the row extent at specified position, or 0 if value does not implement this interface.

  • Gets the row header of a specified row in an accessible table.

    Parameters

    • row: number

      a gint representing a row in the table

    Returns Atk.Object

    a AtkObject* representing the specified row header, or null if value does not implement this interface.

  • Returns the number of rows occupied by this cell accessible.

    Returns number

    a gint representing the number of rows occupied by this cell, or 0 if the cell does not implement this method.

  • Creates an Atk.AttributeSet which consists of the attributes explicitly set at the position offset in the text. start_offset and end_offset are set to the start and end of the range around offset where the attributes are invariant. Note that end_offset is the offset of the first character after the range. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.

    Parameters

    • offset: number

      the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location.

    Returns [SList, number, number]

    an Atk.AttributeSet which contains the attributes explicitly set at offset. This Atk.AttributeSet should be freed by a call to atk_attribute_set_free().

  • Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

    Parameters

    • selected: number

      a gint** that is to contain the selected columns numbers

    Returns number

    a gint representing the number of selected columns, or %0 if value does not implement this interface.

  • Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

    Parameters

    • selected: number

      a gint** that is to contain the selected row numbers

    Returns number

    a gint representing the number of selected rows, or zero if value does not implement this interface.

  • Gets the text from the specified selection.

    Parameters

    • selection_num: number

      The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.

    Returns [string, number, number]

    a newly allocated string containing the selected text. Use g_free() to free the returned string.

  • Gets the number of accessible children currently selected. Note: callers should not rely on null or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

    Returns number

    a gint representing the number of items selected, or 0 if selection does not implement this interface.

  • Gets the size of the component in terms of width and height.

    If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.

    Returns [number, number]

  • Gets a portion of the text exposed through an Atk.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 ATK_TEXT_GRANULARITY_CHAR the character at the offset is returned.

    If granularity is ATK_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 ATK_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 ATK_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 ATK_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 [string, number, number]

    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 the specified text.

    Parameters

    • start_offset: number

      a starting character offset within text

    • end_offset: number

      an ending character offset within text, or -1 for the end of the string.

    Returns string

    a newly allocated string containing the text from start_offset up to, but not including end_offset. Use g_free() to free the returned string.

  • Gets the specified text.

    If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned.

    If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START 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 the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START 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 the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset.

    Parameters

    Returns [string, number, number]

    a newly allocated string containing the text at offset bounded by the specified boundary_type. Use g_free() to free the returned string.

  • Gets the current value and the human readable text alternative of obj. text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available.

    Returns [number, string]

  • 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

  • This function is called when implementing subclasses of Atk.Object. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of Atk.Object

    Parameters

    • Optionaldata: any

      a gpointer which identifies the object for which the AtkObject was created.

    Returns void

  • Insert text at a given position.

    Parameters

    • string: string

      the text to insert

    • length: number

      the length of text to insert, in bytes

    • position: number

      The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.

    Returns void

  • Determines if the current child of this object is selected Note: callers should not rely on null or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

    Parameters

    • i: number

      a gint specifying the child index.

    Returns boolean

    a gboolean representing the specified child is selected, or 0 if selection does not implement this interface.

  • Gets a boolean value indicating whether the specified column is selected

    Parameters

    • column: number

      a gint representing a column in table

    Returns boolean

    a gboolean representing if the column is selected, or 0 if value does not implement this interface.

  • Gets a boolean value indicating whether the specified row is selected

    Parameters

    • row: number

      a gint representing a row in table

    Returns boolean

    a gboolean representing if the row is selected, or 0 if value does not implement this interface.

  • Gets a boolean value indicating whether the accessible object at the specified row and column is selected

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns boolean

    a gboolean representing if the cell is selected, or 0 if value does not implement this interface.

  • 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

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

      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]);
    

    Parameters

    Returns void

  • Emits a state-change signal for the specified state.

    Note that as a general rule when the state of an existing object changes, emitting a notification is expected.

    Parameters

    • state: number

      an Atk.State whose state is changed

    • value: boolean

      a gboolean which indicates whether the state is being set on or off

    Returns void

  • Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns null.

    This method is intended as an utility for ATK implementors, and not to be exposed to accessible tools. See atk_object_get_parent() for further reference.

    Returns Atk.Object

    an Atk.Object representing the accessible parent of the accessible if assigned

  • 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

    the same object

  • Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns Atk.Object

    a reference to the accessible child, if one exists

  • Get a reference to the table cell at row, column. This cell should implement the interface Atk.TableCell

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns Atk.Object

    an Atk.Object representing the referred to accessible

  • Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on null or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

    Parameters

    • i: number

      a gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

    Returns Atk.Object

    an Atk.Object representing the selected accessible, or null if selection does not implement this interface.

  • 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

    object

  • Adds the specified column to the selection.

    Parameters

    • column: number

      a gint representing a column in table

    Returns boolean

    a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.

  • Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).

    Parameters

    • handler_id: number

      the handler id of the focus handler to be removed from component

    Returns void

  • Removes the specified row from the selection.

    Parameters

    • row: number

      a gint representing a row in table

    Returns boolean

    a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.

  • Removes the specified child of the object from the object's selection.

    Parameters

    • i: number

      a gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

    Returns boolean

    TRUE if success, FALSE otherwise.

  • Makes a substring of text visible on the screen by scrolling all necessary parents.

    Parameters

    • start_offset: number

      start offset in the text

    • end_offset: number

      end offset in the text, or -1 for the end of the text.

    • type: Atk.ScrollType

      specify where the object should be made visible.

    Returns boolean

    whether scrolling was successful.

  • Move the top-left of a substring of text to a given position of the screen by scrolling all necessary parents.

    Parameters

    • start_offset: number

      start offset in the text

    • end_offset: number

      end offset in the text, or -1 for the end of the text.

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or to the parent object.

    • x: number

      x-position where to scroll to

    • y: number

      y-position where to scroll to

    Returns boolean

    whether scrolling was successful.

  • Makes component visible on the screen by scrolling all necessary parents.

    Contrary to atk_component_set_position, this does not actually move component in its parent, this only makes the parents scroll so that the object shows up on the screen, given its current position within the parents.

    Parameters

    • type: Atk.ScrollType

      specify where the object should be made visible.

    Returns boolean

    whether scrolling was successful.

  • Move the top-left of component to a given position of the screen by scrolling all necessary parents.

    Parameters

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or to the parent object.

    • x: number

      x-position where to scroll to

    • y: number

      y-position where to scroll to

    Returns boolean

    whether scrolling was successful.

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Sets 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. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.

    Parameters

    • id: string

      a character string to be set as the accessible id

    Returns void

  • Sets the value for the given attribute_name inside document.

    Parameters

    • attribute_name: string

      a character string representing the name of the attribute whose value is being set.

    • attribute_value: string

      a string value to be associated with attribute_name.

    Returns boolean

    true if attribute_value is successfully associated with attribute_name for this document, and false if if the document does not allow the attribute to be modified

  • Sets the caret (cursor) position to the specified offset.

    In the case of rich-text content, this method should either grab focus or move the sequential focus navigation starting point (if the application supports this concept) as if the user had clicked on the new caret position. Typically, this means that the target of this operation is the node containing the new caret position or one of its ancestors. In other words, after this method is called, if the user advances focus, it should move to the first focusable node following the new caret position.

    Calling this method should also scroll the application viewport in a way that matches the behavior of the application's typical caret motion or tab navigation as closely as possible. This also means that if the application's caret motion or focus navigation does not trigger a scroll operation, this method should not trigger one either. If the application does not have a caret motion or focus navigation operation, this method should try to scroll the new caret position into view while minimizing unnecessary scroll motion.

    Parameters

    • offset: number

      the character offset of the new caret position

    Returns boolean

    true if successful, false otherwise.

  • Sets the description text for the specified column of the table.

    Parameters

    • column: number

      a gint representing a column in table

    • description: string

      a gchar representing the description text to set for the specified column of the table

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

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a description of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    • desc: string

      the description to be assigned to this action

    Returns boolean

    a gboolean representing if the description was successfully set;

  • Parameters

    • ...args: never[]

    Returns any

  • Sets the extents of component.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • width: number

      width to set for component

    • height: number

      height to set for component

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns boolean

    true or false whether the extents were set or not

  • Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object. You can't set the help text to NULL. This is reserved for the initial value. If you want to set the name to an empty value, you can use "".

    Parameters

    • help_text: string

      a character string to be set as the accessible's help text

    Returns void

  • Sets the textual description for this image.

    Parameters

    • description: string

      a string description to set for image

    Returns boolean

    boolean TRUE, or FALSE if operation could not be completed.

  • Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

    Parameters

    • name: string

      a character string to be set as the accessible name

    Returns void

  • Sets the position of component.

    Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves component in its parent.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the component's top level window

    Returns boolean

    true or false whether or not the position was set or not

  • Sets the description text for the specified row of table.

    Parameters

    • row: number

      a gint representing a row in table

    • description: string

      a gchar representing the description text to set for the specified row of table

    Returns void

  • Sets the attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets.

    Parameters

    • attrib_set: SList
    • start_offset: number

      start of range in which to set attributes

    • end_offset: number

      end of range in which to set attributes

    Returns boolean

    true if attributes successfully set for the specified range, otherwise false

  • Changes the start and end offset of the specified selection.

    Parameters

    • selection_num: number

      The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.

    • start_offset: number

      the new starting character offset of the selection

    • end_offset: number

      the new end position of (e.g. offset immediately past) the selection

    Returns boolean

    true if successful, false otherwise

  • Set the size of the component in terms of width and height.

    Parameters

    • width: number

      width to set for component

    • height: number

      height to set for component

    Returns boolean

    true or false whether the size was set or not

  • Makes 1 or more selections within this document denoted by the given array of AtkTextSelections. Any existing physical selection (inside or outside this document) is replaced by the new selections. All objects within the given selection ranges must be descendants of this document. Otherwise FALSE will be returned.

    Parameters

    • selections: TextSelection[]

      a GArray of AtkTextSelections to be selected.

    Returns boolean

    TRUE if the selection was made successfully; FALSE otherwise.

  • Sets the value of this object.

    This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an Atk.Value.SignalSignatures.value_changed | Atk.Value::value-changed signal emission.

    Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not.

    Parameters

    • new_value: number

      a double which is the desired new accessible value.

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

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

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    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.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

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

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

    Returns void

  • Adds the specified accessible child of the object to the object's selection.

    Parameters

    • i: number

      a gint specifying the child index.

    Returns boolean

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

    Returns void

  • Checks whether the specified point is within the extent of the component.

    Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns boolean

  • Copy text from start_pos up to, but not including end_pos to the clipboard.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

  • Copy text from start_pos up to, but not including end_pos to the clipboard and then delete from the widget.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

  • Delete text start_pos up to, but not including end_pos.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

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

    Returns void

  • Perform the specified action on the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns boolean

  • The signal handler which is executed when there is a focus event for an object. This virtual function is deprecated since 2.9.4 and it should not be overriden. Use the Atk.Object.SignalSignatures.state_change | Atk.Object::state-change "focused" signal instead.

    Parameters

    • focus_in: boolean

    Returns void

  • If the extent can not be obtained (e.g. missing support), all of x, y, width, height are set to -1.

    Get the bounding box containing the glyph representing the character at a particular text offset.

    Parameters

    • offset: number

      The offset of the text character for which bounding information is required.

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or widget window

    Returns [number, number, number, number]

  • Gets the number of columns occupied by the accessible object at the specified row and column in the table.

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns number

  • Gets a %gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer.

    Returns any

  • Retrieves the value of the given attribute_name inside document.

    Parameters

    • attribute_name: string

      a character string representing the name of the attribute whose value is being queried.

    Returns string

  • Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and atk_image_get_image_locale.

    Returns string

  • Gets the rectangle which gives the extent of the component.

    If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number, number, number]

  • Gets the position of the image in the form of a point specifying the images top-left corner.

    If the position can not be obtained (e.g. missing support), x and y are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number]

  • Get the width and height in pixels for the specified image. The values of width and height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen).

    If the size can not be obtained (e.g. missing support), x and y are set to -1.

    Returns [number, number]

  • Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

    Returns number

  • Gets a gint representing the index at the specified row and column.

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns number

  • Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut".

    • The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for a button.
    • The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a traditional "New..." menu item.
    • The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a traditional "New..." menu item.

    Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

    Parameters

    • char_index: number

      a character index

    Returns number

  • Returns the localized name of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Gets the minimum increment by which the value of this object may be changed. If zero, the minimum increment is undefined, which may mean that it is limited only by the floating point precision of the platform.

    Returns unknown

  • Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object.

    Returns number

  • Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. "click", "press", "release", "drag", "drop", "popup", etc. The "popup" action should be used to pop up a context menu for the object, if one exists.

    For technical reasons, some toolkits cannot guarantee that the reported action is actually 'bound' to a nontrivial user event; i.e. the result of some actions via atk_action_do_action() may be NIL.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Parameters

    • ...args: never[]

    Returns any

  • Gets the offset of the character located at coordinates x and y. x and y are interpreted as being relative to the screen or this widget's window depending on coords.

    Parameters

    • x: number

      screen x-position of character

    • y: number

      screen y-position of character

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or widget window

    Returns number

  • Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk_object_set_parent(), and will return it with this method.

    If you are only interested on the parent assigned with atk_object_set_parent(), use atk_object_peek_parent().

    Returns Atk.Object

  • Gets the position of component in the form of a point specifying component's top-left corner.

    If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number]

  • Parameters

    • ...args: never[]

    Returns any

  • Get the bounding box for text within the specified range.

    If the extents can not be obtained (e.g. or missing support), the rectangle fields are set to -1.

    Parameters

    • start_offset: number

      The offset of the first text character for which boundary information is required.

    • end_offset: number

      The offset of the text character after the last character for which boundary information is required.

    • coord_type: Atk.CoordType

      Specify whether coordinates are relative to the screen or widget window.

    Returns TextRectangle

  • Gets a gint representing the row at the specified index_.

    Parameters

    • index_: number

      a gint representing an index in table

    Returns number

  • Gets the row and column indexes and span of this cell accessible.

    Note: If the object does not implement this function, then, by default, atk will implement this function by calling get_row_span and get_column_span on the object.

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

  • Gets the number of rows occupied by the accessible object at a specified row and column in the table.

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns number

  • Creates an Atk.AttributeSet which consists of the attributes explicitly set at the position offset in the text. start_offset and end_offset are set to the start and end of the range around offset where the attributes are invariant. Note that end_offset is the offset of the first character after the range. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.

    Parameters

    • offset: number

      the character offset at which to get the attributes, -1 means the offset of the character to be inserted at the caret location.

    Returns [SList, number, number]

  • Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

    Parameters

    • selected: number

      a gint** that is to contain the selected columns numbers

    Returns number

  • Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

    Parameters

    • selected: number

      a gint** that is to contain the selected row numbers

    Returns number

  • Gets the text from the specified selection.

    Parameters

    • selection_num: number

      The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.

    Returns [string, number, number]

  • Gets the number of accessible children currently selected. Note: callers should not rely on null or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

    Returns number

  • Gets the size of the component in terms of width and height.

    If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.

    Returns [number, number]

  • Gets a portion of the text exposed through an Atk.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 ATK_TEXT_GRANULARITY_CHAR the character at the offset is returned.

    If granularity is ATK_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 ATK_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 ATK_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 ATK_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 [string, number, number]

  • Gets the specified text.

    Parameters

    • start_offset: number

      a starting character offset within text

    • end_offset: number

      an ending character offset within text, or -1 for the end of the string.

    Returns string

  • Gets the specified text.

    If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned.

    If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START 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 the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START 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 the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset.

    Parameters

    Returns [string, number, number]

  • Gets the current value and the human readable text alternative of obj. text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available.

    Returns [number, string]

  • This function is called when implementing subclasses of Atk.Object. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of Atk.Object

    Parameters

    • Optionaldata: any

      a gpointer which identifies the object for which the AtkObject was created.

    Returns void

  • Insert text at a given position.

    Parameters

    • string: string

      the text to insert

    • length: number

      the length of text to insert, in bytes

    • position: number

      The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.

    Returns void

  • Determines if the current child of this object is selected Note: callers should not rely on null or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

    Parameters

    • i: number

      a gint specifying the child index.

    Returns boolean

  • Gets a boolean value indicating whether the specified column is selected

    Parameters

    • column: number

      a gint representing a column in table

    Returns boolean

  • Gets a boolean value indicating whether the specified row is selected

    Parameters

    • row: number

      a gint representing a row in table

    Returns boolean

  • Gets a boolean value indicating whether the accessible object at the specified row and column is selected

    Parameters

    • row: number

      a gint representing a row in table

    • column: number

      a gint representing a column in table

    Returns boolean

  • 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

    Returns void

  • Gets a reference to the accessible object representing the specified selected child of the object. Note: callers should not rely on null or on a zero value for indication of whether AtkSelectionIface is implemented, they should use type checking/interface checking macros or the atk_get_accessible_value() convenience method.

    Parameters

    • i: number

      a gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

    Returns Atk.Object

  • Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).

    Parameters

    • handler_id: number

      the handler id of the focus handler to be removed from component

    Returns void

  • Removes the specified child of the object from the object's selection.

    Parameters

    • i: number

      a gint specifying the index in the selection set. (e.g. the ith selection as opposed to the ith child).

    Returns boolean

  • Makes a substring of text visible on the screen by scrolling all necessary parents.

    Parameters

    • start_offset: number

      start offset in the text

    • end_offset: number

      end offset in the text, or -1 for the end of the text.

    • type: Atk.ScrollType

      specify where the object should be made visible.

    Returns boolean

  • Move the top-left of a substring of text to a given position of the screen by scrolling all necessary parents.

    Parameters

    • start_offset: number

      start offset in the text

    • end_offset: number

      end offset in the text, or -1 for the end of the text.

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or to the parent object.

    • x: number

      x-position where to scroll to

    • y: number

      y-position where to scroll to

    Returns boolean

  • Makes component visible on the screen by scrolling all necessary parents.

    Contrary to atk_component_set_position, this does not actually move component in its parent, this only makes the parents scroll so that the object shows up on the screen, given its current position within the parents.

    Parameters

    • type: Atk.ScrollType

      specify where the object should be made visible.

    Returns boolean

  • Move the top-left of component to a given position of the screen by scrolling all necessary parents.

    Parameters

    • coords: Atk.CoordType

      specify whether coordinates are relative to the screen or to the parent object.

    • x: number

      x-position where to scroll to

    • y: number

      y-position where to scroll to

    Returns boolean

  • Sets the caret (cursor) position to the specified offset.

    In the case of rich-text content, this method should either grab focus or move the sequential focus navigation starting point (if the application supports this concept) as if the user had clicked on the new caret position. Typically, this means that the target of this operation is the node containing the new caret position or one of its ancestors. In other words, after this method is called, if the user advances focus, it should move to the first focusable node following the new caret position.

    Calling this method should also scroll the application viewport in a way that matches the behavior of the application's typical caret motion or tab navigation as closely as possible. This also means that if the application's caret motion or focus navigation does not trigger a scroll operation, this method should not trigger one either. If the application does not have a caret motion or focus navigation operation, this method should try to scroll the new caret position into view while minimizing unnecessary scroll motion.

    Parameters

    • offset: number

      the character offset of the new caret position

    Returns boolean

  • Sets the description text for the specified column of the table.

    Parameters

    • column: number

      a gint representing a column in table

    • description: string

      a gchar representing the description text to set for the specified column of the table

    Returns void

  • Sets a description of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    • desc: string

      the description to be assigned to this action

    Returns boolean

  • Parameters

    • ...args: never[]

    Returns any

  • Sets the value for the given attribute_name inside document.

    Parameters

    • attribute_name: string

      a character string representing the name of the attribute whose value is being set.

    • attribute_value: string

      a string value to be associated with attribute_name.

    Returns boolean

  • Sets the extents of component.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • width: number

      width to set for component

    • height: number

      height to set for component

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns boolean

  • Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

    Parameters

    • name: string

      a character string to be set as the accessible name

    Returns void

  • Sets the position of component.

    Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves component in its parent.

    Parameters

    • x: number

      x coordinate

    • y: number

      y coordinate

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the component's top level window

    Returns boolean

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

    Parameters

    Returns void

  • Sets the description text for the specified row of table.

    Parameters

    • row: number

      a gint representing a row in table

    • description: string

      a gchar representing the description text to set for the specified row of table

    Returns void

  • Sets the attributes for a specified range. See the ATK_ATTRIBUTE macros (such as #ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets.

    Parameters

    • attrib_set: SList
    • start_offset: number

      start of range in which to set attributes

    • end_offset: number

      end of range in which to set attributes

    Returns boolean

  • Changes the start and end offset of the specified selection.

    Parameters

    • selection_num: number

      The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.

    • start_offset: number

      the new starting character offset of the selection

    • end_offset: number

      the new end position of (e.g. offset immediately past) the selection

    Returns boolean

  • Set the size of the component in terms of width and height.

    Parameters

    • width: number

      width to set for component

    • height: number

      height to set for component

    Returns boolean

  • Makes 1 or more selections within this document denoted by the given array of AtkTextSelections. Any existing physical selection (inside or outside this document) is replaced by the new selections. All objects within the given selection ranges must be descendants of this document. Otherwise FALSE will be returned.

    Parameters

    • selections: TextSelection[]

      a GArray of AtkTextSelections to be selected.

    Returns boolean

  • Sets the value of this object.

    This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an Atk.Value.SignalSignatures.value_changed | Atk.Value::value-changed signal emission.

    Note for implementors: the deprecated atk_value_set_current_value() method returned TRUE or FALSE depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned TRUE in any case. For that reason it is not required anymore to return if the value was properly assigned or not.

    Parameters

    • new_value: number

      a double which is the desired new accessible value.

    Returns void

  • the signal handler which is executed when there is a text change. This virtual function is deprecated sice 2.9.4 and it should not be overriden.

    Parameters

    • position: number
    • length: number

    Returns 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

    Returns void

Methods - Inherited from Atk.Object

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

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures