@girs/atspi-2.0 2.0.0-3.2.2 → 2.0.0-3.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/atspi-2.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Atspi-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.2.
8
+ GJS TypeScript type definitions for Atspi-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.3.
9
9
 
10
10
  AT-SPI2 is a D-Bus based accessibility framework. It defines a D-Bus protocol for providing and accessing application accessibility information. The project includes a library for bridging the D-Bus protocol to the ATK API, allowing Gtk based applications to be made accessible.
11
11
 
package/atspi-2.0.d.cts CHANGED
@@ -603,7 +603,7 @@ export enum Role {
603
603
  */
604
604
  DATE_EDITOR,
605
605
  /**
606
- * An inconifed internal frame within a DESKTOP_PANE.
606
+ * An inconifed internal frame within a DESKTOP_FRAME.
607
607
  */
608
608
  DESKTOP_ICON,
609
609
  /**
@@ -626,14 +626,14 @@ export enum Role {
626
626
  */
627
627
  DIRECTORY_PANE,
628
628
  /**
629
- * A specialized dialog that displays the files in
630
- * the directory and lets the user select a file, browse a different
631
- * directory, or specify a filename.
629
+ * An object used for drawing custom user interface
630
+ * elements.
632
631
  */
633
632
  DRAWING_AREA,
634
633
  /**
635
- * An object used for drawing custom user interface
636
- * elements.
634
+ * A specialized dialog that displays the files in
635
+ * the directory and lets the user select a file, browse a different
636
+ * directory, or specify a filename.
637
637
  */
638
638
  FILE_CHOOSER,
639
639
  /**
@@ -793,14 +793,13 @@ export enum Role {
793
793
  SEPARATOR,
794
794
  /**
795
795
  * An object that allows the user to select from a bounded
796
- * range.
796
+ * range. Unlike `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
797
+ * 'viewport'-like objects.
797
798
  */
798
799
  SLIDER,
799
800
  /**
800
801
  * An object which allows one of a set of choices to
801
- * be selected, and which displays the current choice. Unlike
802
- * `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
803
- * 'viewport'-like objects.
802
+ * be selected, and which displays the current choice.
804
803
  */
805
804
  SPIN_BUTTON,
806
805
  /**
@@ -923,7 +922,7 @@ export enum Role {
923
922
  /**
924
923
  * An object corresponding to the toplevel accessible
925
924
  * of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
926
- * accessible objects. Children of #AccessibleDesktop objects are generally
925
+ * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
927
926
  * `ATSPI_ROLE_APPLICATION` objects.
928
927
  */
929
928
  APPLICATION,
@@ -1259,14 +1258,18 @@ export enum Role {
1259
1258
  /**
1260
1259
  * A container for content that is called out as a proposed
1261
1260
  * change from the current version of the document, such as by a reviewer of the
1262
- * content. This role should include either %ATSPI_ROLE_CONTENT_DELETION and/or
1263
- * %ATSPI_ROLE_CONTENT_INSERTION children, in any order, to indicate what the
1261
+ * content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or
1262
+ * %ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the
1264
1263
  * actual change is. `Since:` 2.36
1265
1264
  */
1266
1265
  SUGGESTION,
1266
+ /**
1267
+ * A specialized push button to open a menu. `Since` 2.46
1268
+ */
1269
+ PUSH_BUTTON_MENU,
1267
1270
  /**
1268
1271
  * Not a valid role, used for finding end of
1269
- * enumeration.
1272
+ * enumeration.
1270
1273
  */
1271
1274
  LAST_DEFINED,
1272
1275
  }
@@ -1769,7 +1772,7 @@ export enum KeyListenerSyncType {
1769
1772
  NOSYNC,
1770
1773
  /**
1771
1774
  * Events are delivered synchronously, before the
1772
- * currently focussed application sees them.
1775
+ * currently focused application sees them.
1773
1776
  */
1774
1777
  SYNCHRONOUS,
1775
1778
  /**
@@ -1977,11 +1980,11 @@ export function init(): number
1977
1980
  */
1978
1981
  export function is_initialized(): boolean
1979
1982
  /**
1980
- * Registers a listener for device events, for instance button events.
1981
- * @param listener a pointer to the #AtspiDeviceListener which requests the events.
1982
- * @param event_types an #AtspiDeviceEventMask mask indicating which types of key events are requested (%ATSPI_KEY_PRESSED, etc.).
1983
- * @param filter Unused parameter.
1984
- * @returns %TRUE if successful, otherwise %FALSE.
1983
+ * This function does nothing and should not be called.
1984
+ * @param listener
1985
+ * @param event_types
1986
+ * @param filter
1987
+ * @returns Always returns %FALSE.
1985
1988
  */
1986
1989
  export function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: any | null): boolean
1987
1990
  /**
@@ -2027,7 +2030,7 @@ export function set_main_context(cnx: GLib.MainContext): void
2027
2030
  export function set_reference_window(accessible: Accessible): void
2028
2031
  /**
2029
2032
  * Set the timeout used for method calls. If this is not set explicitly,
2030
- * a default of 0.8 ms is used.
2033
+ * a default of 800 ms is used.
2031
2034
  * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
2032
2035
  * sending a keyboard event notification. This means that, if an AT makes
2033
2036
  * a call in response to the keyboard notification and the application
@@ -2246,6 +2249,15 @@ export interface Collection {
2246
2249
  disconnect(id: number): void
2247
2250
  }
2248
2251
 
2252
+ /**
2253
+ * An interface designed to allow accessibles which satisfy a set of
2254
+ * criteria to be returned.
2255
+ *
2256
+ * An interface designed to allow accessibles which satisfy a set of
2257
+ * criteria to be returned. This interface can be used to avoid iteration
2258
+ * or client-side search of the object tree.
2259
+ * @interface
2260
+ */
2249
2261
  export class Collection extends GObject.Object {
2250
2262
 
2251
2263
  // Own properties of Atspi-2.0.Atspi.Collection
@@ -2352,8 +2364,8 @@ export interface Component {
2352
2364
  scroll_to_point(coords: CoordType, x: number, y: number): boolean
2353
2365
  /**
2354
2366
  * Moves and resizes the specified component.
2355
- * @param x the new vertical position to which the component should be moved.
2356
- * @param y the new horizontal position to which the component should be moved.
2367
+ * @param x the new horizontal position to which the component should be moved.
2368
+ * @param y the new vertical position to which the component should be moved.
2357
2369
  * @param width the width to which the component should be resized.
2358
2370
  * @param height the height to which the component should be resized.
2359
2371
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
@@ -2362,14 +2374,14 @@ export interface Component {
2362
2374
  set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean
2363
2375
  /**
2364
2376
  * Moves the component to the specified position.
2365
- * @param x the new vertical position to which the component should be moved.
2366
- * @param y the new horizontal position to which the component should be moved.
2377
+ * @param x the new horizontal position to which the component should be moved.
2378
+ * @param y the new vertical position to which the component should be moved.
2367
2379
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
2368
2380
  * @returns #TRUE if successful; #FALSE otherwise.
2369
2381
  */
2370
2382
  set_position(x: number, y: number, ctype: CoordType): boolean
2371
2383
  /**
2372
- * Resizes the specified component to the given coordinates.
2384
+ * Resizes the specified component to the given pixel dimensions.
2373
2385
  * @param width the width to which the component should be resized.
2374
2386
  * @param height the height to which the component should be resized.
2375
2387
  * @returns #TRUE if successful; #FALSE otherwise.
@@ -2384,6 +2396,20 @@ export interface Component {
2384
2396
  disconnect(id: number): void
2385
2397
  }
2386
2398
 
2399
+ /**
2400
+ * An interface implemented by objects which have onscreen visual
2401
+ * representations.
2402
+ *
2403
+ * The Component interface is implemented by objects which occupy on-screen
2404
+ * space, e.g. objects which have onscreen visual representations. The methods
2405
+ * in Component allow clients to identify where the objects lie in the onscreen
2406
+ * coordinate system, their relative size, stacking order, and position. It
2407
+ * also provides a mechanism whereby keyboard focus may be transferred to
2408
+ * specific user interface elements programmatically. This is a 2D API.
2409
+ * Coordinates of 3D objects are projected into the 2-dimensional screen view
2410
+ * for purposes of this interface.
2411
+ * @interface
2412
+ */
2387
2413
  export class Component extends GObject.Object {
2388
2414
 
2389
2415
  // Own properties of Atspi-2.0.Atspi.Component
@@ -2591,6 +2617,17 @@ export interface Hypertext {
2591
2617
  disconnect(id: number): void
2592
2618
  }
2593
2619
 
2620
+ /**
2621
+ * An interface used for objects which implement linking between
2622
+ * multiple resource locations.
2623
+ *
2624
+ * An interface used for objects which implement linking between
2625
+ * multiple resource or content locations, or multiple 'markers'
2626
+ * within a single document. A hypertext instance is associated
2627
+ * with one or more hyperlinks which are associated with particular
2628
+ * offsets within the hypertext's content.
2629
+ * @interface
2630
+ */
2594
2631
  export class Hypertext extends GObject.Object {
2595
2632
 
2596
2633
  // Own properties of Atspi-2.0.Atspi.Hypertext
@@ -2764,6 +2801,17 @@ export interface Selection {
2764
2801
  disconnect(id: number): void
2765
2802
  }
2766
2803
 
2804
+ /**
2805
+ * An interface which indicates that an object exposes a 'selection' model,
2806
+ * allowing the selection of one or more of its children.
2807
+ *
2808
+ * An interface which indicates that an object exposes a 'selection'
2809
+ * model, allowing the selection of one or more of its children.
2810
+ * Read-only Selection instances are possible, in which case the
2811
+ * interface is used to programmatically determine the selected-ness
2812
+ * of its children.
2813
+ * @interface
2814
+ */
2767
2815
  export class Selection extends GObject.Object {
2768
2816
 
2769
2817
  // Own properties of Atspi-2.0.Atspi.Selection
@@ -3011,6 +3059,20 @@ export interface Table {
3011
3059
  disconnect(id: number): void
3012
3060
  }
3013
3061
 
3062
+ /**
3063
+ * An interface used by containers whose data is arranged in a tabular form.
3064
+ *
3065
+ * An interface used by containers whose contained data is arranged
3066
+ * in a tabular (i.e. row-column) form. Tables may resemble
3067
+ * a two-dimensional grid, as in a spreadsheet, or may feature objects
3068
+ * which span multiple rows and/or columns, but whose bounds are
3069
+ * aligned on a row/column matrix. Objects within tables are children
3070
+ * of the table object, and they may be referenced either via a child
3071
+ * index or via a row/column pair. Table 'cells' may implement other
3072
+ * interfaces, such as Text, Action, Image, and Component, and should do
3073
+ * so as appropriate to their onscreen presentation and/or behavior.
3074
+ * @interface
3075
+ */
3014
3076
  export class Table extends GObject.Object {
3015
3077
 
3016
3078
  // Own properties of Atspi-2.0.Atspi.Table
@@ -3340,6 +3402,18 @@ export interface Text {
3340
3402
  disconnect(id: number): void
3341
3403
  }
3342
3404
 
3405
+ /**
3406
+ * An interface implemented by objects which place textual
3407
+ * information onscreen.
3408
+ *
3409
+ * The text interface should be implemented by objects which place textual
3410
+ * information onscreen as character strings or glyphs. The text interface
3411
+ * allows access to textual content including display attributes and
3412
+ * semantic hints associated with runs of text, and to bounding
3413
+ * information for glyphs and substrings. It also allows portions of text to
3414
+ * be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
3415
+ * @interface
3416
+ */
3343
3417
  export class Text extends GObject.Object {
3344
3418
 
3345
3419
  // Own properties of Atspi-2.0.Atspi.Text
@@ -3407,6 +3481,16 @@ export interface Value {
3407
3481
  disconnect(id: number): void
3408
3482
  }
3409
3483
 
3484
+ /**
3485
+ * An interface supporting a one-dimensional scalar
3486
+ * to be modified, or which reflects its value.
3487
+ *
3488
+ * An interface supporting a one-dimensional scalar
3489
+ * to be modified, or which reflects its value. If
3490
+ * STATE_EDITABLE is not present, the value is
3491
+ * treated as "read only".
3492
+ * @interface
3493
+ */
3410
3494
  export class Value extends GObject.Object {
3411
3495
 
3412
3496
  // Own properties of Atspi-2.0.Atspi.Value
@@ -3729,6 +3813,14 @@ export interface Accessible extends Action, Collection, Component, Document, Edi
3729
3813
  disconnect(id: number): void
3730
3814
  }
3731
3815
 
3816
+ /**
3817
+ * The base interface which is implemented by all accessible objects.
3818
+ *
3819
+ * All objects support interfaces for querying their contained 'children'
3820
+ * and position in the accessible-object hierarchy, whether or not they
3821
+ * actually have children.
3822
+ * @class
3823
+ */
3732
3824
  export class Accessible extends Object {
3733
3825
 
3734
3826
  // Own properties of Atspi-2.0.Atspi.Accessible
@@ -3774,6 +3866,14 @@ export interface Application {
3774
3866
  disconnect(id: number): void
3775
3867
  }
3776
3868
 
3869
+ /**
3870
+ * An interface identifying the root object associated
3871
+ * with a running application.
3872
+ *
3873
+ * An interface identifying an object which is the root of the
3874
+ * hierarchy associated with a running application.
3875
+ * @class
3876
+ */
3777
3877
  export class Application extends GObject.Object {
3778
3878
 
3779
3879
  // Own properties of Atspi-2.0.Atspi.Application
@@ -3818,7 +3918,7 @@ export interface Device {
3818
3918
  */
3819
3919
  get_locked_modifiers(): number
3820
3920
  /**
3821
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3921
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3822
3922
  * mapping. This function should be used when the intention is to query a
3823
3923
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3824
3924
  * rather than to add key grabs.
@@ -3873,7 +3973,7 @@ export interface Device {
3873
3973
  */
3874
3974
  vfunc_get_locked_modifiers(): number
3875
3975
  /**
3876
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3976
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3877
3977
  * mapping. This function should be used when the intention is to query a
3878
3978
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3879
3979
  * rather than to add key grabs.
@@ -4203,6 +4303,7 @@ export interface EventListener {
4203
4303
  * object:column-deleted
4204
4304
  * object:model-changed
4205
4305
  * object:active-descendant-changed
4306
+ * object:announcement
4206
4307
  *
4207
4308
  * (screen reader events)
4208
4309
  * screen-reader:region-changed
@@ -4277,6 +4378,16 @@ export interface EventListener {
4277
4378
  disconnect(id: number): void
4278
4379
  }
4279
4380
 
4381
+ /**
4382
+ * A generic interface implemented by objects for the receipt of event
4383
+ * notifications.
4384
+ *
4385
+ * A generic interface implemented by objects for the receipt of event
4386
+ * notifications. atspi-event-listener is the interface via which clients of
4387
+ * the atspi-registry receive notification of changes to an application's user
4388
+ * interface and content.
4389
+ * @class
4390
+ */
4280
4391
  export class EventListener extends GObject.Object {
4281
4392
 
4282
4393
  // Own properties of Atspi-2.0.Atspi.EventListener
@@ -4391,6 +4502,19 @@ export interface Hyperlink {
4391
4502
  disconnect(id: number): void
4392
4503
  }
4393
4504
 
4505
+ /**
4506
+ * Instances of atspi-hyperlink are the means by which end users
4507
+ * and clients interact with linked content.
4508
+ *
4509
+ * Instances of atspi-hyperlink are returned by
4510
+ * atspi-hypertext objects, and are the means by
4511
+ * which end users and clients interact with linked,
4512
+ * and in some cases embedded, content. These instances
4513
+ * may have multiple "anchors", where an anchor corresponds to a
4514
+ * reference to a particular resource with a corresponding resource
4515
+ * identified (URI).
4516
+ * @class
4517
+ */
4394
4518
  export class Hyperlink extends Object {
4395
4519
 
4396
4520
  // Own properties of Atspi-2.0.Atspi.Hyperlink
@@ -4436,6 +4560,11 @@ export interface MatchRule {
4436
4560
  disconnect(id: number): void
4437
4561
  }
4438
4562
 
4563
+ /**
4564
+ * An interface that allows the definition of match rules
4565
+ * for accessible objects.
4566
+ * @class
4567
+ */
4439
4568
  export class MatchRule extends GObject.Object {
4440
4569
 
4441
4570
  // Own properties of Atspi-2.0.Atspi.MatchRule
@@ -4565,6 +4694,15 @@ export interface Relation {
4565
4694
  disconnect(id: number): void
4566
4695
  }
4567
4696
 
4697
+ /**
4698
+ * An interface via which non-hierarchical relationships
4699
+ * are indicated.
4700
+ *
4701
+ * An interface via which non-hierarchical relationships
4702
+ * are indicated. An instance of this interface represents
4703
+ * a "one-to-many" correspondence.
4704
+ * @class
4705
+ */
4568
4706
  export class Relation extends GObject.Object {
4569
4707
 
4570
4708
  // Own properties of Atspi-2.0.Atspi.Relation
@@ -4655,6 +4793,11 @@ export interface StateSet {
4655
4793
  disconnect(id: number): void
4656
4794
  }
4657
4795
 
4796
+ /**
4797
+ * The atspi-stateset objects implement wrappers around a
4798
+ * bitmap of accessible states.
4799
+ * @class
4800
+ */
4658
4801
  export class StateSet extends GObject.Object {
4659
4802
 
4660
4803
  // Own properties of Atspi-2.0.Atspi.StateSet
package/atspi-2.0.d.ts CHANGED
@@ -605,7 +605,7 @@ enum Role {
605
605
  */
606
606
  DATE_EDITOR,
607
607
  /**
608
- * An inconifed internal frame within a DESKTOP_PANE.
608
+ * An inconifed internal frame within a DESKTOP_FRAME.
609
609
  */
610
610
  DESKTOP_ICON,
611
611
  /**
@@ -628,14 +628,14 @@ enum Role {
628
628
  */
629
629
  DIRECTORY_PANE,
630
630
  /**
631
- * A specialized dialog that displays the files in
632
- * the directory and lets the user select a file, browse a different
633
- * directory, or specify a filename.
631
+ * An object used for drawing custom user interface
632
+ * elements.
634
633
  */
635
634
  DRAWING_AREA,
636
635
  /**
637
- * An object used for drawing custom user interface
638
- * elements.
636
+ * A specialized dialog that displays the files in
637
+ * the directory and lets the user select a file, browse a different
638
+ * directory, or specify a filename.
639
639
  */
640
640
  FILE_CHOOSER,
641
641
  /**
@@ -795,14 +795,13 @@ enum Role {
795
795
  SEPARATOR,
796
796
  /**
797
797
  * An object that allows the user to select from a bounded
798
- * range.
798
+ * range. Unlike `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
799
+ * 'viewport'-like objects.
799
800
  */
800
801
  SLIDER,
801
802
  /**
802
803
  * An object which allows one of a set of choices to
803
- * be selected, and which displays the current choice. Unlike
804
- * `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
805
- * 'viewport'-like objects.
804
+ * be selected, and which displays the current choice.
806
805
  */
807
806
  SPIN_BUTTON,
808
807
  /**
@@ -925,7 +924,7 @@ enum Role {
925
924
  /**
926
925
  * An object corresponding to the toplevel accessible
927
926
  * of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
928
- * accessible objects. Children of #AccessibleDesktop objects are generally
927
+ * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
929
928
  * `ATSPI_ROLE_APPLICATION` objects.
930
929
  */
931
930
  APPLICATION,
@@ -1261,14 +1260,18 @@ enum Role {
1261
1260
  /**
1262
1261
  * A container for content that is called out as a proposed
1263
1262
  * change from the current version of the document, such as by a reviewer of the
1264
- * content. This role should include either %ATSPI_ROLE_CONTENT_DELETION and/or
1265
- * %ATSPI_ROLE_CONTENT_INSERTION children, in any order, to indicate what the
1263
+ * content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or
1264
+ * %ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the
1266
1265
  * actual change is. `Since:` 2.36
1267
1266
  */
1268
1267
  SUGGESTION,
1268
+ /**
1269
+ * A specialized push button to open a menu. `Since` 2.46
1270
+ */
1271
+ PUSH_BUTTON_MENU,
1269
1272
  /**
1270
1273
  * Not a valid role, used for finding end of
1271
- * enumeration.
1274
+ * enumeration.
1272
1275
  */
1273
1276
  LAST_DEFINED,
1274
1277
  }
@@ -1771,7 +1774,7 @@ enum KeyListenerSyncType {
1771
1774
  NOSYNC,
1772
1775
  /**
1773
1776
  * Events are delivered synchronously, before the
1774
- * currently focussed application sees them.
1777
+ * currently focused application sees them.
1775
1778
  */
1776
1779
  SYNCHRONOUS,
1777
1780
  /**
@@ -1979,11 +1982,11 @@ function init(): number
1979
1982
  */
1980
1983
  function is_initialized(): boolean
1981
1984
  /**
1982
- * Registers a listener for device events, for instance button events.
1983
- * @param listener a pointer to the #AtspiDeviceListener which requests the events.
1984
- * @param event_types an #AtspiDeviceEventMask mask indicating which types of key events are requested (%ATSPI_KEY_PRESSED, etc.).
1985
- * @param filter Unused parameter.
1986
- * @returns %TRUE if successful, otherwise %FALSE.
1985
+ * This function does nothing and should not be called.
1986
+ * @param listener
1987
+ * @param event_types
1988
+ * @param filter
1989
+ * @returns Always returns %FALSE.
1987
1990
  */
1988
1991
  function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: any | null): boolean
1989
1992
  /**
@@ -2029,7 +2032,7 @@ function set_main_context(cnx: GLib.MainContext): void
2029
2032
  function set_reference_window(accessible: Accessible): void
2030
2033
  /**
2031
2034
  * Set the timeout used for method calls. If this is not set explicitly,
2032
- * a default of 0.8 ms is used.
2035
+ * a default of 800 ms is used.
2033
2036
  * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
2034
2037
  * sending a keyboard event notification. This means that, if an AT makes
2035
2038
  * a call in response to the keyboard notification and the application
@@ -2248,6 +2251,15 @@ interface Collection {
2248
2251
  disconnect(id: number): void
2249
2252
  }
2250
2253
 
2254
+ /**
2255
+ * An interface designed to allow accessibles which satisfy a set of
2256
+ * criteria to be returned.
2257
+ *
2258
+ * An interface designed to allow accessibles which satisfy a set of
2259
+ * criteria to be returned. This interface can be used to avoid iteration
2260
+ * or client-side search of the object tree.
2261
+ * @interface
2262
+ */
2251
2263
  class Collection extends GObject.Object {
2252
2264
 
2253
2265
  // Own properties of Atspi-2.0.Atspi.Collection
@@ -2354,8 +2366,8 @@ interface Component {
2354
2366
  scroll_to_point(coords: CoordType, x: number, y: number): boolean
2355
2367
  /**
2356
2368
  * Moves and resizes the specified component.
2357
- * @param x the new vertical position to which the component should be moved.
2358
- * @param y the new horizontal position to which the component should be moved.
2369
+ * @param x the new horizontal position to which the component should be moved.
2370
+ * @param y the new vertical position to which the component should be moved.
2359
2371
  * @param width the width to which the component should be resized.
2360
2372
  * @param height the height to which the component should be resized.
2361
2373
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
@@ -2364,14 +2376,14 @@ interface Component {
2364
2376
  set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean
2365
2377
  /**
2366
2378
  * Moves the component to the specified position.
2367
- * @param x the new vertical position to which the component should be moved.
2368
- * @param y the new horizontal position to which the component should be moved.
2379
+ * @param x the new horizontal position to which the component should be moved.
2380
+ * @param y the new vertical position to which the component should be moved.
2369
2381
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
2370
2382
  * @returns #TRUE if successful; #FALSE otherwise.
2371
2383
  */
2372
2384
  set_position(x: number, y: number, ctype: CoordType): boolean
2373
2385
  /**
2374
- * Resizes the specified component to the given coordinates.
2386
+ * Resizes the specified component to the given pixel dimensions.
2375
2387
  * @param width the width to which the component should be resized.
2376
2388
  * @param height the height to which the component should be resized.
2377
2389
  * @returns #TRUE if successful; #FALSE otherwise.
@@ -2386,6 +2398,20 @@ interface Component {
2386
2398
  disconnect(id: number): void
2387
2399
  }
2388
2400
 
2401
+ /**
2402
+ * An interface implemented by objects which have onscreen visual
2403
+ * representations.
2404
+ *
2405
+ * The Component interface is implemented by objects which occupy on-screen
2406
+ * space, e.g. objects which have onscreen visual representations. The methods
2407
+ * in Component allow clients to identify where the objects lie in the onscreen
2408
+ * coordinate system, their relative size, stacking order, and position. It
2409
+ * also provides a mechanism whereby keyboard focus may be transferred to
2410
+ * specific user interface elements programmatically. This is a 2D API.
2411
+ * Coordinates of 3D objects are projected into the 2-dimensional screen view
2412
+ * for purposes of this interface.
2413
+ * @interface
2414
+ */
2389
2415
  class Component extends GObject.Object {
2390
2416
 
2391
2417
  // Own properties of Atspi-2.0.Atspi.Component
@@ -2593,6 +2619,17 @@ interface Hypertext {
2593
2619
  disconnect(id: number): void
2594
2620
  }
2595
2621
 
2622
+ /**
2623
+ * An interface used for objects which implement linking between
2624
+ * multiple resource locations.
2625
+ *
2626
+ * An interface used for objects which implement linking between
2627
+ * multiple resource or content locations, or multiple 'markers'
2628
+ * within a single document. A hypertext instance is associated
2629
+ * with one or more hyperlinks which are associated with particular
2630
+ * offsets within the hypertext's content.
2631
+ * @interface
2632
+ */
2596
2633
  class Hypertext extends GObject.Object {
2597
2634
 
2598
2635
  // Own properties of Atspi-2.0.Atspi.Hypertext
@@ -2766,6 +2803,17 @@ interface Selection {
2766
2803
  disconnect(id: number): void
2767
2804
  }
2768
2805
 
2806
+ /**
2807
+ * An interface which indicates that an object exposes a 'selection' model,
2808
+ * allowing the selection of one or more of its children.
2809
+ *
2810
+ * An interface which indicates that an object exposes a 'selection'
2811
+ * model, allowing the selection of one or more of its children.
2812
+ * Read-only Selection instances are possible, in which case the
2813
+ * interface is used to programmatically determine the selected-ness
2814
+ * of its children.
2815
+ * @interface
2816
+ */
2769
2817
  class Selection extends GObject.Object {
2770
2818
 
2771
2819
  // Own properties of Atspi-2.0.Atspi.Selection
@@ -3013,6 +3061,20 @@ interface Table {
3013
3061
  disconnect(id: number): void
3014
3062
  }
3015
3063
 
3064
+ /**
3065
+ * An interface used by containers whose data is arranged in a tabular form.
3066
+ *
3067
+ * An interface used by containers whose contained data is arranged
3068
+ * in a tabular (i.e. row-column) form. Tables may resemble
3069
+ * a two-dimensional grid, as in a spreadsheet, or may feature objects
3070
+ * which span multiple rows and/or columns, but whose bounds are
3071
+ * aligned on a row/column matrix. Objects within tables are children
3072
+ * of the table object, and they may be referenced either via a child
3073
+ * index or via a row/column pair. Table 'cells' may implement other
3074
+ * interfaces, such as Text, Action, Image, and Component, and should do
3075
+ * so as appropriate to their onscreen presentation and/or behavior.
3076
+ * @interface
3077
+ */
3016
3078
  class Table extends GObject.Object {
3017
3079
 
3018
3080
  // Own properties of Atspi-2.0.Atspi.Table
@@ -3342,6 +3404,18 @@ interface Text {
3342
3404
  disconnect(id: number): void
3343
3405
  }
3344
3406
 
3407
+ /**
3408
+ * An interface implemented by objects which place textual
3409
+ * information onscreen.
3410
+ *
3411
+ * The text interface should be implemented by objects which place textual
3412
+ * information onscreen as character strings or glyphs. The text interface
3413
+ * allows access to textual content including display attributes and
3414
+ * semantic hints associated with runs of text, and to bounding
3415
+ * information for glyphs and substrings. It also allows portions of text to
3416
+ * be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
3417
+ * @interface
3418
+ */
3345
3419
  class Text extends GObject.Object {
3346
3420
 
3347
3421
  // Own properties of Atspi-2.0.Atspi.Text
@@ -3409,6 +3483,16 @@ interface Value {
3409
3483
  disconnect(id: number): void
3410
3484
  }
3411
3485
 
3486
+ /**
3487
+ * An interface supporting a one-dimensional scalar
3488
+ * to be modified, or which reflects its value.
3489
+ *
3490
+ * An interface supporting a one-dimensional scalar
3491
+ * to be modified, or which reflects its value. If
3492
+ * STATE_EDITABLE is not present, the value is
3493
+ * treated as "read only".
3494
+ * @interface
3495
+ */
3412
3496
  class Value extends GObject.Object {
3413
3497
 
3414
3498
  // Own properties of Atspi-2.0.Atspi.Value
@@ -3731,6 +3815,14 @@ interface Accessible extends Action, Collection, Component, Document, EditableTe
3731
3815
  disconnect(id: number): void
3732
3816
  }
3733
3817
 
3818
+ /**
3819
+ * The base interface which is implemented by all accessible objects.
3820
+ *
3821
+ * All objects support interfaces for querying their contained 'children'
3822
+ * and position in the accessible-object hierarchy, whether or not they
3823
+ * actually have children.
3824
+ * @class
3825
+ */
3734
3826
  class Accessible extends Object {
3735
3827
 
3736
3828
  // Own properties of Atspi-2.0.Atspi.Accessible
@@ -3776,6 +3868,14 @@ interface Application {
3776
3868
  disconnect(id: number): void
3777
3869
  }
3778
3870
 
3871
+ /**
3872
+ * An interface identifying the root object associated
3873
+ * with a running application.
3874
+ *
3875
+ * An interface identifying an object which is the root of the
3876
+ * hierarchy associated with a running application.
3877
+ * @class
3878
+ */
3779
3879
  class Application extends GObject.Object {
3780
3880
 
3781
3881
  // Own properties of Atspi-2.0.Atspi.Application
@@ -3820,7 +3920,7 @@ interface Device {
3820
3920
  */
3821
3921
  get_locked_modifiers(): number
3822
3922
  /**
3823
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3923
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3824
3924
  * mapping. This function should be used when the intention is to query a
3825
3925
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3826
3926
  * rather than to add key grabs.
@@ -3875,7 +3975,7 @@ interface Device {
3875
3975
  */
3876
3976
  vfunc_get_locked_modifiers(): number
3877
3977
  /**
3878
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3978
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3879
3979
  * mapping. This function should be used when the intention is to query a
3880
3980
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3881
3981
  * rather than to add key grabs.
@@ -4205,6 +4305,7 @@ interface EventListener {
4205
4305
  * object:column-deleted
4206
4306
  * object:model-changed
4207
4307
  * object:active-descendant-changed
4308
+ * object:announcement
4208
4309
  *
4209
4310
  * (screen reader events)
4210
4311
  * screen-reader:region-changed
@@ -4279,6 +4380,16 @@ interface EventListener {
4279
4380
  disconnect(id: number): void
4280
4381
  }
4281
4382
 
4383
+ /**
4384
+ * A generic interface implemented by objects for the receipt of event
4385
+ * notifications.
4386
+ *
4387
+ * A generic interface implemented by objects for the receipt of event
4388
+ * notifications. atspi-event-listener is the interface via which clients of
4389
+ * the atspi-registry receive notification of changes to an application's user
4390
+ * interface and content.
4391
+ * @class
4392
+ */
4282
4393
  class EventListener extends GObject.Object {
4283
4394
 
4284
4395
  // Own properties of Atspi-2.0.Atspi.EventListener
@@ -4393,6 +4504,19 @@ interface Hyperlink {
4393
4504
  disconnect(id: number): void
4394
4505
  }
4395
4506
 
4507
+ /**
4508
+ * Instances of atspi-hyperlink are the means by which end users
4509
+ * and clients interact with linked content.
4510
+ *
4511
+ * Instances of atspi-hyperlink are returned by
4512
+ * atspi-hypertext objects, and are the means by
4513
+ * which end users and clients interact with linked,
4514
+ * and in some cases embedded, content. These instances
4515
+ * may have multiple "anchors", where an anchor corresponds to a
4516
+ * reference to a particular resource with a corresponding resource
4517
+ * identified (URI).
4518
+ * @class
4519
+ */
4396
4520
  class Hyperlink extends Object {
4397
4521
 
4398
4522
  // Own properties of Atspi-2.0.Atspi.Hyperlink
@@ -4438,6 +4562,11 @@ interface MatchRule {
4438
4562
  disconnect(id: number): void
4439
4563
  }
4440
4564
 
4565
+ /**
4566
+ * An interface that allows the definition of match rules
4567
+ * for accessible objects.
4568
+ * @class
4569
+ */
4441
4570
  class MatchRule extends GObject.Object {
4442
4571
 
4443
4572
  // Own properties of Atspi-2.0.Atspi.MatchRule
@@ -4567,6 +4696,15 @@ interface Relation {
4567
4696
  disconnect(id: number): void
4568
4697
  }
4569
4698
 
4699
+ /**
4700
+ * An interface via which non-hierarchical relationships
4701
+ * are indicated.
4702
+ *
4703
+ * An interface via which non-hierarchical relationships
4704
+ * are indicated. An instance of this interface represents
4705
+ * a "one-to-many" correspondence.
4706
+ * @class
4707
+ */
4570
4708
  class Relation extends GObject.Object {
4571
4709
 
4572
4710
  // Own properties of Atspi-2.0.Atspi.Relation
@@ -4657,6 +4795,11 @@ interface StateSet {
4657
4795
  disconnect(id: number): void
4658
4796
  }
4659
4797
 
4798
+ /**
4799
+ * The atspi-stateset objects implement wrappers around a
4800
+ * bitmap of accessible states.
4801
+ * @class
4802
+ */
4660
4803
  class StateSet extends GObject.Object {
4661
4804
 
4662
4805
  // Own properties of Atspi-2.0.Atspi.StateSet
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/atspi-2.0",
3
- "version": "2.0.0-3.2.2",
3
+ "version": "2.0.0-3.2.3",
4
4
  "description": "GJS TypeScript type definitions for Atspi-2.0, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "atspi-2.0.js",
@@ -25,10 +25,10 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit atspi-2.0.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/dbus-1.0": "^1.0.0-3.2.2",
29
- "@girs/gjs": "^3.2.2",
30
- "@girs/glib-2.0": "^2.77.0-3.2.2",
31
- "@girs/gobject-2.0": "^2.77.0-3.2.2"
28
+ "@girs/dbus-1.0": "^1.0.0-3.2.3",
29
+ "@girs/gjs": "^3.2.3",
30
+ "@girs/glib-2.0": "^2.76.1-3.2.3",
31
+ "@girs/gobject-2.0": "^2.76.1-3.2.3"
32
32
  },
33
33
  "devDependencies": {
34
34
  "typescript": "*"