Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
$gtype: GType<Atspi.Text>
name: string

Methods

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

    Parameters

    • startOffset: number

      the starting offset of the desired new selection.

    • endOffset: number

      the offset of the first character after the new selection.

    Returns boolean

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

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

    • transformFrom: TClosure<any, any>

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

    Returns Binding

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

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

    Parameters

    • offset: number

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

    • includeDefaults: boolean

      a #bool that, when set as #FALSE, indicates the call should only return those attributes which are explicitly set on the current attribute run, omitting any attributes which are inherited from the default values.

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

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

    Parameters

    • x: number

      the 'starting' x coordinate of the bounding box.

    • y: number

      the 'starting' y coordinate of the bounding box.

    • width: number

      the x extent of the bounding box.

    • height: number

      the y extent of the bounding box.

    • type: Atspi.CoordType

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

    • clipTypeX: Atspi.TextClipType

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

    • clipTypeY: Atspi.TextClipType

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

    Returns Atspi.TextRange[]

  • getCaretOffset(): number
  • Gets the current offset of the text caret in an #AtspiText object.

    Returns number

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

    Parameters

    • offset: number

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

    Returns number

  • getCharacterCount(): number
  • Gets the character count of an #AccessibleText object.

    Returns number

  • Gets a bounding box containing the glyph representing the character at a particular text offset. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING.

    Parameters

    • offset: number

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

    • type: Atspi.CoordType

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

    Returns Atspi.Rect

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

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDefaultAttributes(): HashTable<string | number | symbol, string | number | boolean>
  • Gets the default attributes applied to an #AtspiText object. The text attributes correspond to CSS attributes where possible. The combination of this attribute set and the attributes reported by #atspi_text_get_attributes describes the entire set of text attributes over a range.

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

  • getNSelections(): number
  • Gets the number of active non-contiguous selections for an #AtspiText object.

    Returns number

  • Gets the character offset into the text at a given point.

    Parameters

    • x: number

      the x coordinate of the point to be queried.

    • y: number

      the y coordinate of the point to be queried.

    • type: Atspi.CoordType

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

    Returns number

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

    The value can be:

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

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

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

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

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

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

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

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    • type: Atspi.CoordType

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

    Returns Atspi.Rect

  • Gets the bounds of the selection_num-th active text selection for an #AtspiText object.

    Parameters

    • selectionNum: number

      a #gint indicating which selection to query.

    Returns Atspi.Range

  • Gets a portion of the text exposed through an #AtspiText according to a given offset and a specific granularity, along with the start and end offsets defining the boundaries of such a portion of text.

    If granularity is ATSPI_TEXT_GRANULARITY_CHAR the character at the offset is returned.

    If granularity is ATSPI_TEXT_GRANULARITY_WORD the returned string is from the word start at or before the offset to the word start after the offset.

    The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word.

    If granularity is ATSPI_TEXT_GRANULARITY_SENTENCE the returned string is from the sentence start at or before the offset to the sentence start after the offset.

    The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence.

    If granularity is ATSPI_TEXT_GRANULARITY_LINE the returned string is from the line start at or before the offset to the line start after the offset.

    If granularity is ATSPI_TEXT_GRANULARITY_PARAGRAPH the returned string is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset.

    Parameters

    Returns Atspi.TextRange

  • getText(startOffset: number, endOffset: number): string
  • Gets a range of text from an #AtspiText object. The number of bytes in the returned string may exceed either end_offset or start_offset, since UTF-8 is a variable-width encoding.

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    Returns string

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

    Parameters

    • offset: number

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

    • type: TextBoundaryType

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

    Returns Atspi.TextRange

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

    Parameters

    • offset: number

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

    • type: TextBoundaryType

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

    Returns Atspi.TextRange

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

    Parameters

    • offset: number

      The character offset at which to query the attribute.

    • attributeName: string

      The attribute to query.

    Returns string

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

    Parameters

    • offset: number

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

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

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

    Parameters

    • offset: number

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

    • type: TextBoundaryType

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

    Returns Atspi.TextRange

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • isFloating(): boolean
  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

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

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

    Parameters

    • propertyName: string

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

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

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

    Returns void

  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

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

    Parameters

    • selectionNum: number

      a #gint indicating which text selection to remove.

    Returns boolean

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

    This function should only be called from object system implementations.

    Returns void

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

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    • type: Atspi.ScrollType

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

    Returns boolean

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

    Parameters

    • startOffset: number

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

    • endOffset: number

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

    • coords: Atspi.CoordType

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

    • x: number

      the x coordinate of the point to reach

    • y: number

      the y coordinate of the point to reach

    Returns boolean

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

    Parameters

    • newOffset: number

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

    Returns boolean

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

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

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

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

    Parameters

    • selectionNum: number

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

    • startOffset: number

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

    • endOffset: number

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

    Returns boolean

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

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

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

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

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

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

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

    Returns ParamSpec[]

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

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

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

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