Class (GI Class)

Gtk-3.0GtkTreeViewAccessible

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Properties - Inherited from Gtk.ContainerAccessible

Accessors - Inherited from Gtk.ContainerAccessible

Methods

_init activate add_column_selection add_row_selection add_selection bind_property bind_property_full block_signal_handler clear_selection connect connect_after disconnect edit emit expand_collapse force_floating freeze_notify get_caption get_cell_area get_cell_extents get_cell_position get_child_index get_column_at_index get_column_description get_column_extent_at get_column_header get_column_header_cells get_data get_index_at get_n_columns get_n_rows get_property get_qdata get_renderer_state get_row_at_index get_row_description get_row_extent_at get_row_header get_row_header_cells get_selected_columns get_selected_rows get_selection_count get_summary getv grab_focus is_child_selected is_column_selected is_floating is_row_selected is_selected notify notify_by_pspec ref ref_at ref_selection ref_sink remove_column_selection remove_row_selection remove_selection run_dispose select_all_selection set set_caption set_column_description set_column_header set_data set_property set_row_description set_row_header set_summary steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref update_relationset vfunc_activate vfunc_add_column_selection vfunc_add_row_selection vfunc_add_selection vfunc_clear_selection vfunc_column_deleted vfunc_column_inserted vfunc_column_reordered vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_edit vfunc_expand_collapse vfunc_finalize vfunc_get_caption vfunc_get_cell_area vfunc_get_cell_extents vfunc_get_cell_position vfunc_get_child_index 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_index_at vfunc_get_n_columns vfunc_get_n_rows vfunc_get_property vfunc_get_renderer_state vfunc_get_row_at_index vfunc_get_row_description vfunc_get_row_extent_at vfunc_get_row_header vfunc_get_row_header_cells vfunc_get_selected_columns vfunc_get_selected_rows vfunc_get_selection_count vfunc_get_summary vfunc_grab_focus vfunc_is_child_selected vfunc_is_column_selected vfunc_is_row_selected vfunc_is_selected vfunc_model_changed vfunc_notify vfunc_ref_at vfunc_ref_selection vfunc_remove_column_selection vfunc_remove_row_selection vfunc_remove_selection vfunc_row_deleted vfunc_row_inserted vfunc_row_reordered vfunc_select_all_selection vfunc_selection_changed vfunc_set_caption vfunc_set_column_description vfunc_set_column_header vfunc_set_property vfunc_set_row_description vfunc_set_row_header vfunc_set_summary vfunc_update_relationset watch_closure

Methods - Inherited from Gtk.ContainerAccessible

add_relationship connect_widget_destroyed contains get_accessible_id get_alpha get_attributes get_description get_extents get_help_text get_index_in_parent get_layer get_mdi_zorder get_n_accessible_children get_name get_object_locale get_parent get_position get_role get_size get_widget initialize notify_state_change peek_parent ref_accessible_at_point ref_accessible_child ref_relation_set ref_state_set remove_focus_handler remove_property_change_handler remove_relationship scroll_to scroll_to_point set_accessible_id set_description set_extents set_help_text set_name set_parent set_position set_role set_size set_widget vfunc_active_descendant_changed vfunc_bounds_changed vfunc_children_changed vfunc_connect_widget_destroyed vfunc_contains vfunc_focus_event vfunc_get_alpha vfunc_get_attributes vfunc_get_description vfunc_get_extents vfunc_get_index_in_parent vfunc_get_layer vfunc_get_mdi_zorder vfunc_get_n_children vfunc_get_name vfunc_get_object_locale vfunc_get_parent vfunc_get_position vfunc_get_role vfunc_get_size vfunc_initialize vfunc_property_change vfunc_ref_accessible_at_point vfunc_ref_relation_set vfunc_ref_state_set vfunc_remove_focus_handler vfunc_remove_property_change_handler vfunc_scroll_to vfunc_scroll_to_point vfunc_set_description vfunc_set_extents vfunc_set_name vfunc_set_parent vfunc_set_position vfunc_set_role vfunc_set_size vfunc_state_change vfunc_visible_data_changed vfunc_widget_set vfunc_widget_unset _classInit compat_control find_property install_properties install_property interface_find_property interface_install_property interface_list_properties list_properties newv override_property

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 Gtk.ContainerAccessible

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

Accessors - Inherited from Gtk.ContainerAccessible

  • 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

    Parameters

    • val: string

    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

    Parameters

    • val: string

    Returns void

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    • val: string

    Returns void

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    • val: number

    Returns void

  • 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

    Parameters

    • val: string

    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

    Parameters

    • val: string

    Returns void

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    • val: string

    Returns void

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    • val: number

    Returns void

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.

  • 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

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

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

  • 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

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

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

  • 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

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

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

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

  • 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

  • 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

  • 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

  • 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

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

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

  • 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

  • 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

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

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

  • 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

  • Get a list of properties applied to this object as a whole, as an Atk.AttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" Atk.AttributeSet properties.

    Returns SList

    an Atk.AttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to atk_attribute_set_free().

  • 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 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

    Returns number

    an integer which is the index of the accessible in its parent

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

  • 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

  • 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

  • Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.

    Parameters

    • i: number

      a gint representing the position of the child, starting from 0

    Returns Atk.Object

    an Atk.Object representing the specified accessible child of the accessible.

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

  • 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 accessible description of the accessible. You can't set the description 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

    • description: string

      a character string to be set as the accessible description

    Returns void

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

  • 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

  • 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

  • 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

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

  • 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

  • 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

  • Sets the accessible description of the accessible. You can't set the description 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

    • description: string

      a character string to be set as the accessible description

    Returns void

  • 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

  • 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

Interfaces

ConstructorProps
SignalSignatures