@girs/atspi-2.0 4.3.0 → 4.4.0

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/atspi-2.0)
 
 
-GJS TypeScript type definitions for Atspi-2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
+GJS TypeScript type definitions for Atspi-2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
 
 ## Install
 

package/atspi-2.0.d.ts

@@ -2706,12 +2706,14 @@ export namespace Atspi {
          * to the user, but to be an id which is stable over application development.
          * Typically, this is the gtkbuilder id.
          * @returns a character string representing the accessible id of the {@link Atspi.Accessible} object or NULL on exception.
+         * @since 2.34
          */
         get_accessible_id(): string;
 
         /**
          * Gets the {@link Atspi.Action} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Action} interface          instance, or NULL if `obj` does not implement {@link Atspi.Action}.
+         * @deprecated since 2.10: Use atspi_accessible_get_action_iface instead.
          */
         get_action(): Action;
 
@@ -2769,6 +2771,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Collection} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Collection} interface          instance, or NULL if `obj` does not implement {@link Atspi.Collection}.
+         * @deprecated since 2.10: Use atspi_accessible_get_collection_iface instead.
          */
         get_collection(): Collection;
 
@@ -2781,6 +2784,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Component} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Component} interface          instance, or NULL if `obj` does not implement {@link Atspi.Component}.
+         * @deprecated since 2.10: Use atspi_accessible_get_component_iface instead.
          */
         get_component(): Component;
 
@@ -2799,6 +2803,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Document} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Document} interface          instance, or NULL if `obj` does not implement {@link Atspi.Document}.
+         * @deprecated since 2.10: Use atspi_accessible_get_document_iface instead.
          */
         get_document(): Document;
 
@@ -2811,6 +2816,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.EditableText} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.EditableText} interface          instance, or NULL if `obj` does not implement {@link Atspi.EditableText}.
+         * @deprecated since 2.10: Use atspi_accessible_get_editable_text_iface instead.
          */
         get_editable_text(): EditableText;
 
@@ -2825,6 +2831,7 @@ export namespace Atspi {
          * present, it provides information that a screen reader can relay to the user
          * to explain how to interact with the object.
          * @returns a character string representing the help text for the {@link Atspi.Accessible} object or NULL on exception.
+         * @since 2.52
          */
         get_help_text(): string;
 
@@ -2837,6 +2844,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Hypertext} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Hypertext} interface          instance, or NULL if `obj` does not implement {@link Atspi.Hypertext}.
+         * @deprecated since 2.10: Use atspi_accessible_get_hypertext_iface instead.
          */
         get_hypertext(): Hypertext;
 
@@ -2856,6 +2864,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Image} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Image} interface instance, or          NULL if `obj` does not implement {@link Atspi.Image}.
+         * @deprecated since 2.10: Use atspi_accessible_get_image_iface instead.
          */
         get_image(): Image;
 
@@ -2934,6 +2943,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Selection} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Selection} interface          instance, or NULL if `obj` does not implement {@link Atspi.Selection}.
+         * @deprecated since 2.10: Use atspi_accessible_get_selection_iface instead.
          */
         get_selection(): Selection;
 
@@ -2958,6 +2968,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Table} interface instance, or          NULL if `obj` does not implement {@link Atspi.Table}.
+         * @deprecated since 2.10: Use atspi_accessible_get_table_iface instead.
          */
         get_table(): Table;
 
@@ -2982,6 +2993,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Text} interface instance, or          NULL if `obj` does not implement {@link Atspi.Text}.
+         * @deprecated since 2.10: Use atspi_accessible_get_text_iface instead.
          */
         get_text(): Text;
 
@@ -3014,6 +3026,7 @@ export namespace Atspi {
         /**
          * Gets the {@link Atspi.Table} interface for an {@link Atspi.Accessible}.
          * @returns a pointer to an {@link Atspi.Value} interface instance, or          NULL if `obj` does not implement {@link Atspi.Value}.
+         * @deprecated since 2.10: Use atspi_accessible_get_value_iface instead.
          */
         get_value(): Value;
 
@@ -3144,6 +3157,7 @@ export namespace Atspi {
          *      object implementing {@link Atspi.Action}.
          * @param i an integer indicating which action to query.
          * @returns a UTF-8 string describing the '`i`-th' invocable action.
+         * @deprecated since 2.10: Use atspi_action_get_action_description instead.
          */
         get_action_description(i: number): string;
 
@@ -3193,6 +3207,7 @@ export namespace Atspi {
          *      object implementing {@link Atspi.Action}.
          * @param i an integer indicating which action to query.
          * @returns the non-localized name of the action, as a UTF-8 string.
+         * @deprecated since 2.10: Use atspi_action_get_action_name instead.
          */
         get_action_name(i: number): string;
 
@@ -3372,6 +3387,7 @@ export namespace Atspi {
          * Gets the value of a single attribute, if specified for the document as a whole.
          * @param attribute a string indicating the name of a specific attribute.
          * @returns a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.
+         * @deprecated since 2.10: Use atspi_document_get_document_attribute_value instead.
          */
         get_document_attribute_value(attribute: string): string;
 
@@ -3379,6 +3395,7 @@ export namespace Atspi {
          * Gets all constant attributes for the document as a whole. For attributes
          * that change within the document content, see `atspi_text_get_attribute_run` instead.
          * @returns a {@link GLib.HashTable}          containing the constant attributes of the document, as name-value pairs.
+         * @deprecated since 2.10: Use atspi_document_get_document_attributes instead.
          */
         get_document_attributes(): { [key: string]: string };
 
@@ -3404,6 +3421,7 @@ export namespace Atspi {
         /**
          * Returns an array of AtspiTextSelections within this document.
          * @returns a GArray of AtspiTextSelection structures representing the selection.
+         * @since 2.52
          */
         get_text_selections(): TextSelection[];
 
@@ -3415,6 +3433,7 @@ export namespace Atspi {
          * FALSE will be returned.
          * @param selections a GArray of AtspiTextSelections              to be selected.
          * @returns TRUE if the selection was made successfully; FALSE otherwise.
+         * @since 2.52
          */
         set_text_selections(selections: TextSelection[]): boolean;
 
@@ -3914,6 +3933,7 @@ export namespace Atspi {
          * @param offset The character offset at which to query the attribute.
          * @param attribute_name The attribute to query.
          * @returns the value of a given attribute at the given offset, or `null` if not present.
+         * @deprecated since 2.10: Use atspi_text_get_text_attribute_value instead.
          */
         get_text_attribute_value(offset: number, attribute_name: string): string | null;
 
@@ -3923,6 +3943,7 @@ export namespace Atspi {
          * where possible.
          * @param offset a `gint` indicating the offset from which the attribute        search is based.
          * @returns a {@link GLib.HashTable} describing the attributes at the given character offset.
+         * @deprecated since 2.10: Use atspi_text_get_text_attributes instead.
          */
         get_text_attributes(offset: number): [{ [key: string]: string }, number, number];
 
@@ -4041,6 +4062,7 @@ export namespace Atspi {
          * @param offset position
          * @param granularity An {@link Atspi.TextGranularity}
          * @returns 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.
+         * @since 2.9.90
          */
         get_string_at_offset(offset: number, granularity: TextGranularity): TextRange;
 
@@ -4059,6 +4081,7 @@ export namespace Atspi {
          * @param offset a `gint` indicating the offset from which the delimiter        search is based.
          * @param type an {@link Atspi.TextBoundaryType} indicating whether the desired       text string is a word, sentence, line, or attribute run.
          * @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the          delimited text, whose delimiting boundaries bracket the          current offset, or an empty string if no such text exists.
+         * @deprecated since 2.10: Use atspi_text_get_string_at_offset.
          */
         get_text_at_offset(offset: number, type: TextBoundaryType): TextRange;
 
@@ -4311,12 +4334,14 @@ export namespace Atspi {
          * @param x a `gint` indicating the x coordinate of the mouse event, relative to     `obj`..
          * @param y a `gint` indicating the y coordinate of the mouse event, relative to     `obj`..
          * @param name a string indicating which mouse event to be synthesized        (e.g. "b1p", "b1c", "b2r", "rel", "abs").
+         * @since 2.52
          * @virtual
          */
         vfunc_generate_mouse_event(obj: Accessible, x: number, y: number, name: string): void;
 
         /**
          * Returns the capabilities currently enabled for this device.
+         * @since 2.60
          * @virtual
          */
         vfunc_get_capabilities(): DeviceCapability;
@@ -4327,6 +4352,7 @@ export namespace Atspi {
          * locking modifier such as num lock via atspi_device_get_locked_modifiers,
          * rather than to add key grabs.
          * @param keysym the XKB keysym to map.
+         * @since 2.55
          * @virtual
          */
         vfunc_get_keysym_modifier(keysym: number): number;
@@ -4366,6 +4392,7 @@ export namespace Atspi {
          * that is not currently being used. If no unused modifier can be found,
          * then it will use the first modifier by default.
          * @param keysym the XKB keysym to map.
+         * @since 2.55
          * @virtual
          */
         vfunc_map_keysym_modifier(keysym: number): number;
@@ -4393,6 +4420,7 @@ export namespace Atspi {
 
         /**
          * @param capabilities A bitmask specifying the capabilities that should be enabled. This replaces the existing set of enabled capabilities, so, if it excludes some capabilities that are currently enabled, then those capabilities may be disabled.
+         * @since 2.60
          * @virtual
          */
         vfunc_set_capabilities(capabilities: DeviceCapability): DeviceCapability;
@@ -4406,6 +4434,7 @@ export namespace Atspi {
         /**
          * Removes a mapped modifier from the given keysym.
          * @param keysym the XKB keysym to unmap.
+         * @since 2.55
          * @virtual
          */
         vfunc_unmap_keysym_modifier(keysym: number): void;
@@ -4429,6 +4458,7 @@ export namespace Atspi {
          * Add a callback that will receive a notification whenever a key is
          * pressed or released.
          * @param callback the   function to call when the given key is pressed.
+         * @deprecated since 2.60: Connect to the key-pressed and key-released signals instead of using this function.
          */
         add_key_watcher(callback: KeyCallback): void;
 
@@ -4445,16 +4475,19 @@ export namespace Atspi {
          * @param x a `gint` indicating the x coordinate of the mouse event, relative to     `obj`..
          * @param y a `gint` indicating the y coordinate of the mouse event, relative to     `obj`..
          * @param name a string indicating which mouse event to be synthesized        (e.g. "b1p", "b1c", "b2r", "rel", "abs").
+         * @since 2.52
          */
         generate_mouse_event(obj: Accessible, x: number, y: number, name: string): void;
 
         /**
          * Returns the application ID of the device.
+         * @since 2.55
          */
         get_app_id(): string;
 
         /**
          * Returns the capabilities currently enabled for this device.
+         * @since 2.60
          */
         get_capabilities(): DeviceCapability;
 
@@ -4470,6 +4503,7 @@ export namespace Atspi {
          * rather than to add key grabs.
          * @param keysym the XKB keysym to map.
          * @returns the modifier that is mapped to this keysym.
+         * @since 2.55
          */
         get_keysym_modifier(keysym: number): number;
 
@@ -4509,6 +4543,7 @@ export namespace Atspi {
          * then it will use the first modifier by default.
          * @param keysym the XKB keysym to map.
          * @returns the modifier that is now mapped to this keysym. This return value can be passed to atspi_device_add_key_grab.
+         * @since 2.55
          */
         map_keysym_modifier(keysym: number): number;
 
@@ -4544,12 +4579,14 @@ export namespace Atspi {
         /**
          * Sets the application ID of the device.
          * @param app_id the application ID.
+         * @since 2.55
          */
         set_app_id(app_id: string): void;
 
         /**
          * @param capabilities A bitmask specifying the capabilities that should be enabled. This replaces the existing set of enabled capabilities, so, if it excludes some capabilities that are currently enabled, then those capabilities may be disabled.
          * @returns The new set of capabilities that are enabled. This may differ from the value passed in if the device does not support all of the requested capabilities.
+         * @since 2.60
          */
         set_capabilities(capabilities: DeviceCapability): DeviceCapability;
 
@@ -4561,6 +4598,7 @@ export namespace Atspi {
         /**
          * Removes a mapped modifier from the given keysym.
          * @param keysym the XKB keysym to unmap.
+         * @since 2.55
          */
         unmap_keysym_modifier(keysym: number): void;
 
@@ -5778,6 +5816,7 @@ export namespace Atspi {
          *      object implementing {@link Atspi.Action}.
          * @param i an integer indicating which action to query.
          * @returns a UTF-8 string describing the '`i`-th' invocable action.
+         * @deprecated since 2.10: Use atspi_action_get_action_description instead.
          */
         get_action_description(i: number): string;
 
@@ -5827,6 +5866,7 @@ export namespace Atspi {
          *      object implementing {@link Atspi.Action}.
          * @param i an integer indicating which action to query.
          * @returns the non-localized name of the action, as a UTF-8 string.
+         * @deprecated since 2.10: Use atspi_action_get_action_name instead.
          */
         get_action_name(i: number): string;
     }
@@ -6083,6 +6123,7 @@ export namespace Atspi {
          * Gets the value of a single attribute, if specified for the document as a whole.
          * @param attribute a string indicating the name of a specific attribute.
          * @returns a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object.
+         * @deprecated since 2.10: Use atspi_document_get_document_attribute_value instead.
          */
         get_document_attribute_value(attribute: string): string;
 
@@ -6090,6 +6131,7 @@ export namespace Atspi {
          * Gets all constant attributes for the document as a whole. For attributes
          * that change within the document content, see `atspi_text_get_attribute_run` instead.
          * @returns a {@link GLib.HashTable}          containing the constant attributes of the document, as name-value pairs.
+         * @deprecated since 2.10: Use atspi_document_get_document_attributes instead.
          */
         get_document_attributes(): { [key: string]: string };
 
@@ -6115,6 +6157,7 @@ export namespace Atspi {
         /**
          * Returns an array of AtspiTextSelections within this document.
          * @returns a GArray of AtspiTextSelection structures representing the selection.
+         * @since 2.52
          */
         get_text_selections(): TextSelection[];
 
@@ -6126,6 +6169,7 @@ export namespace Atspi {
          * FALSE will be returned.
          * @param selections a GArray of AtspiTextSelections              to be selected.
          * @returns TRUE if the selection was made successfully; FALSE otherwise.
+         * @since 2.52
          */
         set_text_selections(selections: TextSelection[]): boolean;
     }
@@ -6827,6 +6871,7 @@ export namespace Atspi {
          * @param offset The character offset at which to query the attribute.
          * @param attribute_name The attribute to query.
          * @returns the value of a given attribute at the given offset, or `null` if not present.
+         * @deprecated since 2.10: Use atspi_text_get_text_attribute_value instead.
          */
         get_text_attribute_value(offset: number, attribute_name: string): string | null;
 
@@ -6836,6 +6881,7 @@ export namespace Atspi {
          * where possible.
          * @param offset a `gint` indicating the offset from which the attribute        search is based.
          * @returns a {@link GLib.HashTable} describing the attributes at the given character offset.
+         * @deprecated since 2.10: Use atspi_text_get_text_attributes instead.
          */
         get_text_attributes(offset: number): [{ [key: string]: string }, number, number];
 
@@ -6961,6 +7007,7 @@ export namespace Atspi {
          * @param offset position
          * @param granularity An {@link Atspi.TextGranularity}
          * @returns 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.
+         * @since 2.9.90
          */
         get_string_at_offset(offset: number, granularity: TextGranularity): TextRange;
 
@@ -6989,6 +7036,7 @@ export namespace Atspi {
          * @param offset a `gint` indicating the offset from which the delimiter        search is based.
          * @param type an {@link Atspi.TextBoundaryType} indicating whether the desired       text string is a word, sentence, line, or attribute run.
          * @returns an {@link Atspi.TextRange} containing a UTF-8 string representing the          delimited text, whose delimiting boundaries bracket the          current offset, or an empty string if no such text exists.
+         * @deprecated since 2.10: Use atspi_text_get_string_at_offset.
          */
         get_text_at_offset(offset: number, type: TextBoundaryType): TextRange;
 
@@ -7103,6 +7151,7 @@ export namespace Atspi {
          * Gets the human readable text alternative associated with the value.
          * `text` is a newly created string, that must be freed by the
          * caller. Can be NULL if no descriptor is available.
+         * @since 2.46
          */
         get_text(): string;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/atspi-2.0",
-    "version": "4.3.0",
+    "version": "4.4.0",
     "description": "GJS TypeScript type definitions for Atspi-2.0",
     "type": "module",
     "module": "atspi-2.0.js",
@@ -31,10 +31,10 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/dbus-1.0": "^4.3.0"    },
+      "@girs/gjs": "^4.4.0",
+      "@girs/gobject-2.0": "^4.4.0",
+      "@girs/glib-2.0": "^4.4.0",
+      "@girs/dbus-1.0": "^4.4.0"    },
     "devDependencies": {
       "typescript": "*"
     },