Interface (GI Interface)

Atspi-2.0AtspiTable

An interface used by containers whose data is arranged in a tabular form.

An interface used by containers whose contained data is arranged in a tabular (i.e. row-column) form. Tables may resemble a two-dimensional grid, as in a spreadsheet, or may feature objects which span multiple rows and/or columns, but whose bounds are aligned on a row/column matrix. Objects within tables are children of the table object, and they may be referenced either via a child index or via a row/column pair. Table 'cells' may implement other interfaces, such as Text, Action, Image, and Component, and should do so as appropriate to their onscreen presentation and/or behavior.

interface Table {
    $signals: GObject.Object.SignalSignatures;
    _init(...args: any[]): void;
    add_column_selection(column: number): boolean;
    add_row_selection(row: number): boolean;
    bind_property(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
    ): GObject.Binding;
    bind_property_full(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
        transform_to?: BindingTransformFunc,
        transform_from?: BindingTransformFunc,
        notify?: DestroyNotify,
    ): GObject.Binding;
    bind_property_full(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
        transform_to: Closure<any, any>,
        transform_from: Closure<any, any>,
    ): GObject.Binding;
    block_signal_handler(id: number): void;
    connect<K extends "notify">(
        signal: K,
        callback: SignalCallback<Atspi.Table, GObject.Object.SignalSignatures[K]>,
    ): number;
    connect(signal: string, callback: (...args: any[]) => any): number;
    connect_after<K extends "notify">(
        signal: K,
        callback: SignalCallback<Atspi.Table, GObject.Object.SignalSignatures[K]>,
    ): number;
    connect_after(signal: string, callback: (...args: any[]) => any): number;
    disconnect(id: number): void;
    emit<K extends "notify">(
        signal: K,
        ...args: GjsParameters<GObject.Object.SignalSignatures[K]> extends [
            any,
            ...Q[],
        ]
            ? Q
            : never,
    ): void;
    emit(signal: string, ...args: any[]): void;
    force_floating(): void;
    freeze_notify(): void;
    get_accessible_at(row: number, column: number): Atspi.Accessible;
    get_caption(): Atspi.Accessible;
    get_column_at_index(index: number): number;
    get_column_description(column: number): string;
    get_column_extent_at(row: number, column: number): number;
    get_column_header(column: number): Atspi.Accessible;
    get_data(key: string): any;
    get_index_at(row: number, column: number): number;
    get_n_columns(): number;
    get_n_rows(): number;
    get_n_selected_columns(): number;
    get_n_selected_rows(): number;
    get_property(property_name: string, value: any): any;
    get_qdata(quark: number): any;
    get_row_at_index(index: number): number;
    get_row_column_extents_at_index(
        index: number,
    ): [boolean, number, number, number, number, boolean];
    get_row_description(row: number): string;
    get_row_extent_at(row: number, column: number): number;
    get_row_header(row: number): Atspi.Accessible;
    get_selected_columns(): number[];
    get_selected_rows(): number[];
    get_summary(): Atspi.Accessible;
    getv(names: string[], values: any[]): void;
    is_column_selected(column: number): boolean;
    is_floating(): boolean;
    is_row_selected(row: number): boolean;
    is_selected(row: number, column: number): boolean;
    notify(property_name: string): void;
    notify_by_pspec(pspec: GObject.ParamSpec): void;
    ref(): GObject.Object;
    ref_sink(): GObject.Object;
    remove_column_selection(column: number): boolean;
    remove_row_selection(row: number): boolean;
    run_dispose(): void;
    set(properties: { [key: string]: any }): void;
    set_data(key: string, data?: any): void;
    set_property(property_name: string, value: any): void;
    steal_data(key: string): any;
    steal_qdata(quark: number): any;
    stop_emission_by_name(detailedName: string): void;
    thaw_notify(): void;
    unblock_signal_handler(id: number): void;
    unref(): void;
    vfunc_constructed(): void;
    vfunc_dispatch_properties_changed(
        n_pspecs: number,
        pspecs: GObject.ParamSpec,
    ): void;
    vfunc_dispose(): void;
    vfunc_finalize(): void;
    vfunc_get_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_notify(pspec: GObject.ParamSpec): void;
    vfunc_set_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    watch_closure(closure: Closure): void;
}

Hierarchy (View Summary)

Implemented by

Index

Properties - Inherited from GObject

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.

Methods

  • Selects the specified column, adding it to the current column selection. Not all tables support column selection.

    Parameters

    • column: number

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

    Returns boolean

    TRUE if the specified column was successfully selected, FALSE if not.

  • Selects the specified row, adding it to the current row selection. Not all tables support row selection.

    Parameters

    • row: number

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

    Returns boolean

    TRUE if the specified row was successfully selected, FALSE if not.

  • Gets the table cell at the specified row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use atspi_component_get_accessible_at_point.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns Atspi.Accessible

    an Atspi.Accessible object representing the specified table cell.

  • Gets the table column index occupied by the child at a particular 1-D child index.

    see atspi_table_get_index_at, atspi_table_get_row_at_index

    Parameters

    • index: number

      the specified child index, zero-indexed.

    Returns number

    a gint indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) index.

  • Gets a text description of a particular table column. This differs from atspi_table_get_column_header, which returns an Atspi.Accessible.

    Parameters

    • column: number

      the specified table column, zero-indexed.

    Returns string

    a UTF-8 string describing the specified table column, if available.

  • Gets the number of columns spanned by the table cell at the specific row and column (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns number

    a gint indicating the number of columns spanned by the specified cell.

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

    Parameters

    • column: number

      the specified table column, zero-indexed.

    Returns Atspi.Accessible

    an Atspi.Accessible representation of the specified table column, if available.

  • Gets the 1-D child index corresponding to the specified 2-D row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use atspi_component_get_accessible_at_point.

    see atspi_table_get_row_at_index, atspi_table_get_column_at_index

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns number

    a gint which serves as the index of a specified cell in the table, in a form usable by atspi_get_child_at_index.

  • Gets the number of columns in an Atspi.Table, exclusive of any columns that are programmatically hidden, but inclusive of columns that may be outside of the current scrolling window or viewport.

    Returns number

    a gint indicating the number of columns in the table.

  • Gets the number of rows in an Atspi.Table, exclusive of any rows that are programmatically hidden, but inclusive of rows that may be outside of the current scrolling window or viewport.

    Returns number

    a gint indicating the number of rows in the table.

  • Queries a table to find out how many columns are currently selected. Not all tables support column selection.

    Returns number

    a gint indicating the number of columns currently selected.

  • Query a table to find out how many rows are currently selected. Not all tables support row selection.

    Returns number

    a gint indicating the number of rows currently selected.

  • Gets the table row index occupied by the child at a particular 1-D child index.

    see atspi_table_get_index_at, atspi_table_get_column_at_index

    Parameters

    • index: number

      the specified child index, zero-indexed.

    Returns number

    a gint indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) index.

  • Given a child index, determines the row and column indices and extents, and whether the cell is currently selected. If the child at index is not a cell (for instance, if it is a summary, caption, etc.), FALSE is returned. The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.

    Example: If the Atspi.Table child at index '6' extends across columns 5 and 6 of row 2 of an Atspi.Table instance, and is currently selected, then

    retval = atspi_table_get_row_column_extents_at_index (table, 6, row, col, row_extents, col_extents, is_selected);

    will return TRUE, and after the call row, col, row_extents, col_extents, and is_selected will contain 2, 5, 1, 2, and TRUE, respectively.

    Parameters

    • index: number

      the index of the Atspi.Table child whose row/column extents are requested.

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

    TRUE if the index is associated with a valid table cell, FALSE if the index does not correspond to a cell. If FALSE is returned, the values of the out parameters are undefined.

  • Gets a text description of a particular table row. This differs from atspi_table_get_row_header, which returns an Atspi.Accessible.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    Returns string

    a UTF-8 string describing the specified table row, if available.

  • Gets the number of rows spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • row: number

      the specified table row, zero-indexed.

    • column: number

      the specified table column, zero-indexed.

    Returns number

    a gint indicating the number of rows spanned by the specified cell.

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

    Parameters

    • row: number

      the specified table row, zero-indexed.

    Returns Atspi.Accessible

    an Atspi.Accessible representation of the specified table row, if available.

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

    Returns number[]

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

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

    Returns number[]

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

  • Determines whether specified table column is selected. Not all tables support column selection.

    Parameters

    • column: number

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

    Returns boolean

    TRUE if the specified column is currently selected, FALSE if not.

  • Determines whether a table row is selected. Not all tables support row selection.

    Parameters

    • row: number

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

    Returns boolean

    TRUE if the specified row is currently selected, FALSE if not.

  • Determines whether the cell at a specific row and column is selected.

    Parameters

    • row: number

      the zero-indexed row of the cell being queried.

    • column: number

      the zero-indexed column of the cell being queried.

    Returns boolean

    TRUE if the specified cell is currently selected, FALSE if not.

  • De-selects the specified column, removing it from the current column selection. Not all tables support column selection.

    Parameters

    • column: number

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

    Returns boolean

    TRUE if the specified column was successfully de-selected, FALSE if not.

  • De-selects the specified row, removing it from the current row selection. Not all tables support row selection.

    Parameters

    • row: number

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

    Returns boolean

    TRUE if the specified row was successfully de-selected, FALSE if not.

Methods - Inherited from GObject

  • 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

    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.

  • 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

  • This function is intended for GObject.Object implementations to re-enforce a floating 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

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

  • 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

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • 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

  • 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

  • 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

  • Increase the reference count of object, and possibly remove the floating 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

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • 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

  • 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 property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    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

  • 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

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • 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

  • 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

Interfaces

ConstructorProps