Interface (GI Interface)

Atk-1.0AtkText

The ATK interface implemented by components with text content.

Atk.Text should be implemented by AtkObjects on behalf of widgets that have text content which is either attributed or otherwise non-trivial. AtkObjects whose text content is simple, unattributed, and very brief may expose that content via atk_object_get_name instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, the Atk.Text interface should be used to expose the text content. In the case of editable text content, Atk.EditableText (a subtype of the Atk.Text interface) should be implemented instead.

Atk.Text provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures.

interface Text {
    $signals: GObject.Object.SignalSignatures;
    _init(...args: any[]): void;
    add_selection(start_offset: number, end_offset: 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<Atk.Text, GObject.Object.SignalSignatures[K]>,
    ): number;
    connect(signal: string, callback: (...args: any[]) => any): number;
    connect_after<K extends "notify">(
        signal: K,
        callback: SignalCallback<Atk.Text, 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_bounded_ranges(
        rect: TextRectangle,
        coord_type: Atk.CoordType,
        x_clip_type: Atk.TextClipType,
        y_clip_type: Atk.TextClipType,
    ): Atk.TextRange[];
    get_caret_offset(): number;
    get_character_at_offset(offset: number): string;
    get_character_count(): number;
    get_character_extents(
        offset: number,
        coords: Atk.CoordType,
    ): [number, number, number, number];
    get_data(key: string): any;
    get_default_attributes(): SList;
    get_n_selections(): number;
    get_offset_at_point(x: number, y: number, coords: Atk.CoordType): number;
    get_property(property_name: string, value: any): any;
    get_qdata(quark: number): any;
    get_range_extents(
        start_offset: number,
        end_offset: number,
        coord_type: Atk.CoordType,
    ): TextRectangle;
    get_run_attributes(offset: number): [SList, number, number];
    get_selection(selection_num: number): [string, number, number];
    get_string_at_offset(
        offset: number,
        granularity: Atk.TextGranularity,
    ): [string, number, number];
    get_text(start_offset: number, end_offset: number): string;
    get_text_after_offset(
        offset: number,
        boundary_type: Atk.TextBoundary,
    ): [string, number, number];
    get_text_at_offset(
        offset: number,
        boundary_type: Atk.TextBoundary,
    ): [string, number, number];
    get_text_before_offset(
        offset: number,
        boundary_type: Atk.TextBoundary,
    ): [string, number, number];
    getv(names: string[], values: any[]): void;
    is_floating(): boolean;
    notify(property_name: string): void;
    notify_by_pspec(pspec: GObject.ParamSpec): void;
    ref(): GObject.Object;
    ref_sink(): GObject.Object;
    remove_selection(selection_num: number): boolean;
    run_dispose(): void;
    scroll_substring_to(
        start_offset: number,
        end_offset: number,
        type: Atk.ScrollType,
    ): boolean;
    scroll_substring_to_point(
        start_offset: number,
        end_offset: number,
        coords: Atk.CoordType,
        x: number,
        y: number,
    ): boolean;
    set(properties: { [key: string]: any }): void;
    set_caret_offset(offset: number): boolean;
    set_data(key: string, data?: any): void;
    set_property(property_name: string, value: any): void;
    set_selection(
        selection_num: number,
        start_offset: number,
        end_offset: number,
    ): boolean;
    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_add_selection(start_offset: number, end_offset: number): boolean;
    vfunc_constructed(): void;
    vfunc_dispatch_properties_changed(
        n_pspecs: number,
        pspecs: GObject.ParamSpec,
    ): void;
    vfunc_dispose(): void;
    vfunc_finalize(): void;
    vfunc_get_bounded_ranges(
        rect: TextRectangle,
        coord_type: Atk.CoordType,
        x_clip_type: Atk.TextClipType,
        y_clip_type: Atk.TextClipType,
    ): Atk.TextRange[];
    vfunc_get_caret_offset(): number;
    vfunc_get_character_at_offset(offset: number): string;
    vfunc_get_character_count(): number;
    vfunc_get_character_extents(
        offset: number,
        coords: Atk.CoordType,
    ): [number, number, number, number];
    vfunc_get_default_attributes(): SList;
    vfunc_get_n_selections(): number;
    vfunc_get_offset_at_point(
        x: number,
        y: number,
        coords: Atk.CoordType,
    ): number;
    vfunc_get_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_get_range_extents(
        start_offset: number,
        end_offset: number,
        coord_type: Atk.CoordType,
    ): TextRectangle;
    vfunc_get_run_attributes(offset: number): [SList, number, number];
    vfunc_get_selection(selection_num: number): [string, number, number];
    vfunc_get_string_at_offset(
        offset: number,
        granularity: Atk.TextGranularity,
    ): [string, number, number];
    vfunc_get_text(start_offset: number, end_offset: number): string;
    vfunc_get_text_after_offset(
        offset: number,
        boundary_type: Atk.TextBoundary,
    ): [string, number, number];
    vfunc_get_text_at_offset(
        offset: number,
        boundary_type: Atk.TextBoundary,
    ): [string, number, number];
    vfunc_get_text_before_offset(
        offset: number,
        boundary_type: Atk.TextBoundary,
    ): [string, number, number];
    vfunc_notify(pspec: GObject.ParamSpec): void;
    vfunc_remove_selection(selection_num: number): boolean;
    vfunc_scroll_substring_to(
        start_offset: number,
        end_offset: number,
        type: Atk.ScrollType,
    ): boolean;
    vfunc_scroll_substring_to_point(
        start_offset: number,
        end_offset: number,
        coords: Atk.CoordType,
        x: number,
        y: number,
    ): boolean;
    vfunc_set_caret_offset(offset: number): boolean;
    vfunc_set_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_set_selection(
        selection_num: number,
        start_offset: number,
        end_offset: number,
    ): boolean;
    vfunc_text_attributes_changed(): void;
    vfunc_text_caret_moved(location: number): void;
    vfunc_text_changed(position: number, length: number): void;
    vfunc_text_selection_changed(): void;
    watch_closure(closure: Closure): void;
}

Hierarchy (View Summary)

Implemented by

Index

Properties - Inherited from GObject

Methods

Methods - Inherited from GObject

Methods - Inherited from Atk.Text.Interface

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

  • Adds a selection bounded by the specified offsets.

    Parameters

    • start_offset: number

      the starting character offset of the selected region

    • end_offset: number

      the offset of the first character after the selected region.

    Returns boolean

    true if successful, false otherwise

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

  • Gets the character count.

    Returns number

    the number of characters or -1 in 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]

  • Creates an Atk.AttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.

    Returns SList

    an Atk.AttributeSet which contains the default text attributes for this Atk.Text. This Atk.AttributeSet should be freed by a call to atk_attribute_set_free().

  • Gets the number of selected regions.

    Returns number

    The number of selected regions, or -1 in the case of failure.

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

  • 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

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

    Parameters

    Returns [string, number, number]

    a newly allocated string containing the text after offset bounded by the specified boundary_type. 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 specified text.

    Parameters

    Returns [string, number, number]

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

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

    true if successful, 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.

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

  • 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

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

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

  • 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

Methods - Inherited from Atk.Text.Interface

  • Adds a selection bounded by the specified offsets.

    Parameters

    • start_offset: number

      the starting character offset of the selected region

    • end_offset: number

      the offset of the first character after the selected region.

    Returns boolean

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

  • 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

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

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

  • 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

  • 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

  • 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

Interfaces

ConstructorProps
Interface