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

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.4.
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
@@ -288,6 +288,26 @@ export enum KeySynthType {
288
288
  */
289
289
  UNLOCKMODIFIERS,
290
290
  }
291
+ /**
292
+ * Enumeration used to indicate a type of live region and how assertive it
293
+ * should be in terms of speaking notifications. Currently, this is only used
294
+ * for "announcement" events, but it may be used for additional purposes
295
+ * in the future.
296
+ */
297
+ export enum Live {
298
+ /**
299
+ * No live region.
300
+ */
301
+ NONE,
302
+ /**
303
+ * This live region should be considered polite.
304
+ */
305
+ POLITE,
306
+ /**
307
+ * This live region should be considered assertive.
308
+ */
309
+ ASSERTIVE,
310
+ }
291
311
  /**
292
312
  * Used by interfaces #AtspiText and #AtspiDocument, this
293
313
  * enumeration corresponds to the POSIX 'setlocale' enum values.
@@ -603,7 +623,7 @@ export enum Role {
603
623
  */
604
624
  DATE_EDITOR,
605
625
  /**
606
- * An inconifed internal frame within a DESKTOP_PANE.
626
+ * An inconifed internal frame within a DESKTOP_FRAME.
607
627
  */
608
628
  DESKTOP_ICON,
609
629
  /**
@@ -626,14 +646,14 @@ export enum Role {
626
646
  */
627
647
  DIRECTORY_PANE,
628
648
  /**
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.
649
+ * An object used for drawing custom user interface
650
+ * elements.
632
651
  */
633
652
  DRAWING_AREA,
634
653
  /**
635
- * An object used for drawing custom user interface
636
- * elements.
654
+ * A specialized dialog that displays the files in
655
+ * the directory and lets the user select a file, browse a different
656
+ * directory, or specify a filename.
637
657
  */
638
658
  FILE_CHOOSER,
639
659
  /**
@@ -793,14 +813,13 @@ export enum Role {
793
813
  SEPARATOR,
794
814
  /**
795
815
  * An object that allows the user to select from a bounded
796
- * range.
816
+ * range. Unlike `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
817
+ * 'viewport'-like objects.
797
818
  */
798
819
  SLIDER,
799
820
  /**
800
821
  * 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.
822
+ * be selected, and which displays the current choice.
804
823
  */
805
824
  SPIN_BUTTON,
806
825
  /**
@@ -923,7 +942,7 @@ export enum Role {
923
942
  /**
924
943
  * An object corresponding to the toplevel accessible
925
944
  * of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
926
- * accessible objects. Children of #AccessibleDesktop objects are generally
945
+ * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
927
946
  * `ATSPI_ROLE_APPLICATION` objects.
928
947
  */
929
948
  APPLICATION,
@@ -1259,14 +1278,18 @@ export enum Role {
1259
1278
  /**
1260
1279
  * A container for content that is called out as a proposed
1261
1280
  * 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
1281
+ * content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or
1282
+ * %ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the
1264
1283
  * actual change is. `Since:` 2.36
1265
1284
  */
1266
1285
  SUGGESTION,
1286
+ /**
1287
+ * A specialized push button to open a menu. `Since` 2.46
1288
+ */
1289
+ PUSH_BUTTON_MENU,
1267
1290
  /**
1268
1291
  * Not a valid role, used for finding end of
1269
- * enumeration.
1292
+ * enumeration.
1270
1293
  */
1271
1294
  LAST_DEFINED,
1272
1295
  }
@@ -1769,7 +1792,7 @@ export enum KeyListenerSyncType {
1769
1792
  NOSYNC,
1770
1793
  /**
1771
1794
  * Events are delivered synchronously, before the
1772
- * currently focussed application sees them.
1795
+ * currently focused application sees them.
1773
1796
  */
1774
1797
  SYNCHRONOUS,
1775
1798
  /**
@@ -1938,6 +1961,14 @@ export function generate_keyboard_event(keyval: number, keystring: string | null
1938
1961
  * @returns %TRUE if successful, otherwise %FALSE.
1939
1962
  */
1940
1963
  export function generate_mouse_event(x: number, y: number, name: string | null): boolean
1964
+ /**
1965
+ * Like atspi_generate_mouse_event, but asynchronous.
1966
+ * @param x a #glong indicating the screen x coordinate of the mouse event.
1967
+ * @param y a #glong indicating the screen y coordinate of the mouse event.
1968
+ * @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
1969
+ * @param callback a callback to be called when a reply is received. May be NULL.
1970
+ */
1971
+ export function generate_mouse_event_async(x: number, y: number, name: string | null, callback: GenerateMouseEventCB | null): void
1941
1972
  /**
1942
1973
  * Gets the virtual desktop indicated by index `i`.
1943
1974
  * NOTE: currently multiple virtual desktops are not implemented;
@@ -1966,6 +1997,10 @@ export function get_desktop_count(): number
1966
1997
  * @returns a #GArray of desktops.
1967
1998
  */
1968
1999
  export function get_desktop_list(): Accessible[]
2000
+ /**
2001
+ * Returns the version of the AT-SPI library being used at runtime.
2002
+ */
2003
+ export function get_version(): [ /* major */ number, /* minor */ number, /* micro */ number ]
1969
2004
  /**
1970
2005
  * Connects to the accessibility registry and initializes the SPI.
1971
2006
  * @returns 0 on success, 1 if already initialized, or an integer error code.
@@ -1977,11 +2012,11 @@ export function init(): number
1977
2012
  */
1978
2013
  export function is_initialized(): boolean
1979
2014
  /**
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.
2015
+ * This function does nothing and should not be called.
2016
+ * @param listener
2017
+ * @param event_types
2018
+ * @param filter
2019
+ * @returns Always returns %FALSE.
1985
2020
  */
1986
2021
  export function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: any | null): boolean
1987
2022
  /**
@@ -2000,9 +2035,14 @@ export function register_device_event_listener(listener: DeviceListener, event_t
2000
2035
  * @returns %TRUE if successful, otherwise %FALSE.
2001
2036
  */
2002
2037
  export function register_keystroke_listener(listener: DeviceListener, key_set: KeyDefinition[] | null, modmask: KeyMaskType, event_types: KeyEventMask, sync_type: KeyListenerSyncType): boolean
2038
+ /**
2039
+ * Gets the localized description string describing the #AtspiRole `role`.
2040
+ * @param role an #AtspiRole object to query.
2041
+ * @returns the localized string describing the AtspiRole
2042
+ */
2043
+ export function role_get_localized_name(role: Role): string | null
2003
2044
  /**
2004
2045
  * Gets a localizable string that indicates the name of an #AtspiRole.
2005
- * <em>DEPRECATED.</em>
2006
2046
  * @param role an #AtspiRole object to query.
2007
2047
  * @returns a localizable string name for an #AtspiRole enumerated type.
2008
2048
  */
@@ -2016,18 +2056,13 @@ export function role_get_name(role: Role): string | null
2016
2056
  */
2017
2057
  export function set_main_context(cnx: GLib.MainContext): void
2018
2058
  /**
2019
- * Sets the reference window that will be used when atspi_generate_mouse_event
2020
- * is called. Coordinates will be assumed to be relative to this window. This
2021
- * is needed because, due to Wayland's security model, it is not currently
2022
- * possible to retrieve global coordinates.
2023
- * If NULL is passed, then AT-SPI will use the window that has focus at the
2024
- * time that atspi_generate_mouse_event is called.
2059
+ * Deprecated. This function no longer does anything and should not be used.
2025
2060
  * @param accessible the #AtspiAccessible corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION.
2026
2061
  */
2027
2062
  export function set_reference_window(accessible: Accessible): void
2028
2063
  /**
2029
2064
  * Set the timeout used for method calls. If this is not set explicitly,
2030
- * a default of 0.8 ms is used.
2065
+ * a default of 800 ms is used.
2031
2066
  * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
2032
2067
  * sending a keyboard event notification. This means that, if an AT makes
2033
2068
  * a call in response to the keyboard notification and the application
@@ -2077,6 +2112,9 @@ export interface EventListenerCB {
2077
2112
  export interface EventListenerSimpleCB {
2078
2113
  (event: Event): void
2079
2114
  }
2115
+ export interface GenerateMouseEventCB {
2116
+ (): void
2117
+ }
2080
2118
  /**
2081
2119
  * A callback that will be invoked when a key is pressed.
2082
2120
  * @callback
@@ -2246,6 +2284,15 @@ export interface Collection {
2246
2284
  disconnect(id: number): void
2247
2285
  }
2248
2286
 
2287
+ /**
2288
+ * An interface designed to allow accessibles which satisfy a set of
2289
+ * criteria to be returned.
2290
+ *
2291
+ * An interface designed to allow accessibles which satisfy a set of
2292
+ * criteria to be returned. This interface can be used to avoid iteration
2293
+ * or client-side search of the object tree.
2294
+ * @interface
2295
+ */
2249
2296
  export class Collection extends GObject.Object {
2250
2297
 
2251
2298
  // Own properties of Atspi-2.0.Atspi.Collection
@@ -2352,8 +2399,8 @@ export interface Component {
2352
2399
  scroll_to_point(coords: CoordType, x: number, y: number): boolean
2353
2400
  /**
2354
2401
  * 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.
2402
+ * @param x the new horizontal position to which the component should be moved.
2403
+ * @param y the new vertical position to which the component should be moved.
2357
2404
  * @param width the width to which the component should be resized.
2358
2405
  * @param height the height to which the component should be resized.
2359
2406
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
@@ -2362,14 +2409,14 @@ export interface Component {
2362
2409
  set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean
2363
2410
  /**
2364
2411
  * 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.
2412
+ * @param x the new horizontal position to which the component should be moved.
2413
+ * @param y the new vertical position to which the component should be moved.
2367
2414
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
2368
2415
  * @returns #TRUE if successful; #FALSE otherwise.
2369
2416
  */
2370
2417
  set_position(x: number, y: number, ctype: CoordType): boolean
2371
2418
  /**
2372
- * Resizes the specified component to the given coordinates.
2419
+ * Resizes the specified component to the given pixel dimensions.
2373
2420
  * @param width the width to which the component should be resized.
2374
2421
  * @param height the height to which the component should be resized.
2375
2422
  * @returns #TRUE if successful; #FALSE otherwise.
@@ -2384,6 +2431,20 @@ export interface Component {
2384
2431
  disconnect(id: number): void
2385
2432
  }
2386
2433
 
2434
+ /**
2435
+ * An interface implemented by objects which have onscreen visual
2436
+ * representations.
2437
+ *
2438
+ * The Component interface is implemented by objects which occupy on-screen
2439
+ * space, e.g. objects which have onscreen visual representations. The methods
2440
+ * in Component allow clients to identify where the objects lie in the onscreen
2441
+ * coordinate system, their relative size, stacking order, and position. It
2442
+ * also provides a mechanism whereby keyboard focus may be transferred to
2443
+ * specific user interface elements programmatically. This is a 2D API.
2444
+ * Coordinates of 3D objects are projected into the 2-dimensional screen view
2445
+ * for purposes of this interface.
2446
+ * @interface
2447
+ */
2387
2448
  export class Component extends GObject.Object {
2388
2449
 
2389
2450
  // Own properties of Atspi-2.0.Atspi.Component
@@ -2591,6 +2652,17 @@ export interface Hypertext {
2591
2652
  disconnect(id: number): void
2592
2653
  }
2593
2654
 
2655
+ /**
2656
+ * An interface used for objects which implement linking between
2657
+ * multiple resource locations.
2658
+ *
2659
+ * An interface used for objects which implement linking between
2660
+ * multiple resource or content locations, or multiple 'markers'
2661
+ * within a single document. A hypertext instance is associated
2662
+ * with one or more hyperlinks which are associated with particular
2663
+ * offsets within the hypertext's content.
2664
+ * @interface
2665
+ */
2594
2666
  export class Hypertext extends GObject.Object {
2595
2667
 
2596
2668
  // Own properties of Atspi-2.0.Atspi.Hypertext
@@ -2764,6 +2836,17 @@ export interface Selection {
2764
2836
  disconnect(id: number): void
2765
2837
  }
2766
2838
 
2839
+ /**
2840
+ * An interface which indicates that an object exposes a 'selection' model,
2841
+ * allowing the selection of one or more of its children.
2842
+ *
2843
+ * An interface which indicates that an object exposes a 'selection'
2844
+ * model, allowing the selection of one or more of its children.
2845
+ * Read-only Selection instances are possible, in which case the
2846
+ * interface is used to programmatically determine the selected-ness
2847
+ * of its children.
2848
+ * @interface
2849
+ */
2767
2850
  export class Selection extends GObject.Object {
2768
2851
 
2769
2852
  // Own properties of Atspi-2.0.Atspi.Selection
@@ -3011,6 +3094,20 @@ export interface Table {
3011
3094
  disconnect(id: number): void
3012
3095
  }
3013
3096
 
3097
+ /**
3098
+ * An interface used by containers whose data is arranged in a tabular form.
3099
+ *
3100
+ * An interface used by containers whose contained data is arranged
3101
+ * in a tabular (i.e. row-column) form. Tables may resemble
3102
+ * a two-dimensional grid, as in a spreadsheet, or may feature objects
3103
+ * which span multiple rows and/or columns, but whose bounds are
3104
+ * aligned on a row/column matrix. Objects within tables are children
3105
+ * of the table object, and they may be referenced either via a child
3106
+ * index or via a row/column pair. Table 'cells' may implement other
3107
+ * interfaces, such as Text, Action, Image, and Component, and should do
3108
+ * so as appropriate to their onscreen presentation and/or behavior.
3109
+ * @interface
3110
+ */
3014
3111
  export class Table extends GObject.Object {
3015
3112
 
3016
3113
  // Own properties of Atspi-2.0.Atspi.Table
@@ -3139,7 +3236,6 @@ export interface Text {
3139
3236
  * Gets the attributes applied to a range of text from an #AtspiText
3140
3237
  * object. The text attributes correspond to CSS attributes
3141
3238
  * where possible.
3142
- * <em>DEPRECATED</em>
3143
3239
  * @param offset a #gint indicating the offset from which the attribute search is based.
3144
3240
  * @returns a #GHashTable describing the attributes at the given character offset.
3145
3241
  */
@@ -3340,6 +3436,18 @@ export interface Text {
3340
3436
  disconnect(id: number): void
3341
3437
  }
3342
3438
 
3439
+ /**
3440
+ * An interface implemented by objects which place textual
3441
+ * information onscreen.
3442
+ *
3443
+ * The text interface should be implemented by objects which place textual
3444
+ * information onscreen as character strings or glyphs. The text interface
3445
+ * allows access to textual content including display attributes and
3446
+ * semantic hints associated with runs of text, and to bounding
3447
+ * information for glyphs and substrings. It also allows portions of text to
3448
+ * be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
3449
+ * @interface
3450
+ */
3343
3451
  export class Text extends GObject.Object {
3344
3452
 
3345
3453
  // Own properties of Atspi-2.0.Atspi.Text
@@ -3407,6 +3515,16 @@ export interface Value {
3407
3515
  disconnect(id: number): void
3408
3516
  }
3409
3517
 
3518
+ /**
3519
+ * An interface supporting a one-dimensional scalar
3520
+ * to be modified, or which reflects its value.
3521
+ *
3522
+ * An interface supporting a one-dimensional scalar
3523
+ * to be modified, or which reflects its value. If
3524
+ * STATE_EDITABLE is not present, the value is
3525
+ * treated as "read only".
3526
+ * @interface
3527
+ */
3410
3528
  export class Value extends GObject.Object {
3411
3529
 
3412
3530
  // Own properties of Atspi-2.0.Atspi.Value
@@ -3469,6 +3587,10 @@ export interface Accessible extends Action, Collection, Component, Document, Edi
3469
3587
  * descendants.
3470
3588
  */
3471
3589
  clear_cache(): void
3590
+ /**
3591
+ * Clears the cached information only for the given accessible.
3592
+ */
3593
+ clear_cache_single(): void
3472
3594
  /**
3473
3595
  * Gets the accessible id of the accessible. This is not meant to be presented
3474
3596
  * to the user, but to be an id which is stable over application development.
@@ -3729,6 +3851,14 @@ export interface Accessible extends Action, Collection, Component, Document, Edi
3729
3851
  disconnect(id: number): void
3730
3852
  }
3731
3853
 
3854
+ /**
3855
+ * The base interface which is implemented by all accessible objects.
3856
+ *
3857
+ * All objects support interfaces for querying their contained 'children'
3858
+ * and position in the accessible-object hierarchy, whether or not they
3859
+ * actually have children.
3860
+ * @class
3861
+ */
3732
3862
  export class Accessible extends Object {
3733
3863
 
3734
3864
  // Own properties of Atspi-2.0.Atspi.Accessible
@@ -3774,6 +3904,14 @@ export interface Application {
3774
3904
  disconnect(id: number): void
3775
3905
  }
3776
3906
 
3907
+ /**
3908
+ * An interface identifying the root object associated
3909
+ * with a running application.
3910
+ *
3911
+ * An interface identifying an object which is the root of the
3912
+ * hierarchy associated with a running application.
3913
+ * @class
3914
+ */
3777
3915
  export class Application extends GObject.Object {
3778
3916
 
3779
3917
  // Own properties of Atspi-2.0.Atspi.Application
@@ -3818,7 +3956,7 @@ export interface Device {
3818
3956
  */
3819
3957
  get_locked_modifiers(): number
3820
3958
  /**
3821
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3959
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3822
3960
  * mapping. This function should be used when the intention is to query a
3823
3961
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3824
3962
  * rather than to add key grabs.
@@ -3873,7 +4011,7 @@ export interface Device {
3873
4011
  */
3874
4012
  vfunc_get_locked_modifiers(): number
3875
4013
  /**
3876
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
4014
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3877
4015
  * mapping. This function should be used when the intention is to query a
3878
4016
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3879
4017
  * rather than to add key grabs.
@@ -4203,6 +4341,7 @@ export interface EventListener {
4203
4341
  * object:column-deleted
4204
4342
  * object:model-changed
4205
4343
  * object:active-descendant-changed
4344
+ * object:announcement
4206
4345
  *
4207
4346
  * (screen reader events)
4208
4347
  * screen-reader:region-changed
@@ -4277,6 +4416,16 @@ export interface EventListener {
4277
4416
  disconnect(id: number): void
4278
4417
  }
4279
4418
 
4419
+ /**
4420
+ * A generic interface implemented by objects for the receipt of event
4421
+ * notifications.
4422
+ *
4423
+ * A generic interface implemented by objects for the receipt of event
4424
+ * notifications. atspi-event-listener is the interface via which clients of
4425
+ * the atspi-registry receive notification of changes to an application's user
4426
+ * interface and content.
4427
+ * @class
4428
+ */
4280
4429
  export class EventListener extends GObject.Object {
4281
4430
 
4282
4431
  // Own properties of Atspi-2.0.Atspi.EventListener
@@ -4391,6 +4540,19 @@ export interface Hyperlink {
4391
4540
  disconnect(id: number): void
4392
4541
  }
4393
4542
 
4543
+ /**
4544
+ * Instances of atspi-hyperlink are the means by which end users
4545
+ * and clients interact with linked content.
4546
+ *
4547
+ * Instances of atspi-hyperlink are returned by
4548
+ * atspi-hypertext objects, and are the means by
4549
+ * which end users and clients interact with linked,
4550
+ * and in some cases embedded, content. These instances
4551
+ * may have multiple "anchors", where an anchor corresponds to a
4552
+ * reference to a particular resource with a corresponding resource
4553
+ * identified (URI).
4554
+ * @class
4555
+ */
4394
4556
  export class Hyperlink extends Object {
4395
4557
 
4396
4558
  // Own properties of Atspi-2.0.Atspi.Hyperlink
@@ -4436,6 +4598,11 @@ export interface MatchRule {
4436
4598
  disconnect(id: number): void
4437
4599
  }
4438
4600
 
4601
+ /**
4602
+ * An interface that allows the definition of match rules
4603
+ * for accessible objects.
4604
+ * @class
4605
+ */
4439
4606
  export class MatchRule extends GObject.Object {
4440
4607
 
4441
4608
  // Own properties of Atspi-2.0.Atspi.MatchRule
@@ -4456,7 +4623,7 @@ export class MatchRule extends GObject.Object {
4456
4623
  * @param attributematchtype An #AtspiCollectionMatchType specifying how to interpret `attributes`.
4457
4624
  * @param roles A #GArray of roles to match, or NULL if not applicable.
4458
4625
  * @param rolematchtype An #AtspiCollectionMatchType specifying how to interpret `roles`.
4459
- * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by their DBus names (org.a11y.Atspi.Accessible, org.a11y.Atspi.Component, etc).
4626
+ * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by the final component of their DBus names (Accessible, Component, etc).
4460
4627
  * @param interfacematchtype An #AtspiCollectionMatchType specifying how to interpret `interfaces`.
4461
4628
  * @param invert if #TRUE, the match rule should be denied (inverted); if #FALSE, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time.
4462
4629
  * @returns A new #AtspiMatchRule.
@@ -4472,7 +4639,7 @@ export class MatchRule extends GObject.Object {
4472
4639
  * @param attributematchtype An #AtspiCollectionMatchType specifying how to interpret `attributes`.
4473
4640
  * @param roles A #GArray of roles to match, or NULL if not applicable.
4474
4641
  * @param rolematchtype An #AtspiCollectionMatchType specifying how to interpret `roles`.
4475
- * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by their DBus names (org.a11y.Atspi.Accessible, org.a11y.Atspi.Component, etc).
4642
+ * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by the final component of their DBus names (Accessible, Component, etc).
4476
4643
  * @param interfacematchtype An #AtspiCollectionMatchType specifying how to interpret `interfaces`.
4477
4644
  * @param invert if #TRUE, the match rule should be denied (inverted); if #FALSE, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time.
4478
4645
  * @returns A new #AtspiMatchRule.
@@ -4565,6 +4732,15 @@ export interface Relation {
4565
4732
  disconnect(id: number): void
4566
4733
  }
4567
4734
 
4735
+ /**
4736
+ * An interface via which non-hierarchical relationships
4737
+ * are indicated.
4738
+ *
4739
+ * An interface via which non-hierarchical relationships
4740
+ * are indicated. An instance of this interface represents
4741
+ * a "one-to-many" correspondence.
4742
+ * @class
4743
+ */
4568
4744
  export class Relation extends GObject.Object {
4569
4745
 
4570
4746
  // Own properties of Atspi-2.0.Atspi.Relation
@@ -4655,6 +4831,11 @@ export interface StateSet {
4655
4831
  disconnect(id: number): void
4656
4832
  }
4657
4833
 
4834
+ /**
4835
+ * The atspi-stateset objects implement wrappers around a
4836
+ * bitmap of accessible states.
4837
+ * @class
4838
+ */
4658
4839
  export class StateSet extends GObject.Object {
4659
4840
 
4660
4841
  // Own properties of Atspi-2.0.Atspi.StateSet
package/atspi-2.0.d.ts CHANGED
@@ -290,6 +290,26 @@ enum KeySynthType {
290
290
  */
291
291
  UNLOCKMODIFIERS,
292
292
  }
293
+ /**
294
+ * Enumeration used to indicate a type of live region and how assertive it
295
+ * should be in terms of speaking notifications. Currently, this is only used
296
+ * for "announcement" events, but it may be used for additional purposes
297
+ * in the future.
298
+ */
299
+ enum Live {
300
+ /**
301
+ * No live region.
302
+ */
303
+ NONE,
304
+ /**
305
+ * This live region should be considered polite.
306
+ */
307
+ POLITE,
308
+ /**
309
+ * This live region should be considered assertive.
310
+ */
311
+ ASSERTIVE,
312
+ }
293
313
  /**
294
314
  * Used by interfaces #AtspiText and #AtspiDocument, this
295
315
  * enumeration corresponds to the POSIX 'setlocale' enum values.
@@ -605,7 +625,7 @@ enum Role {
605
625
  */
606
626
  DATE_EDITOR,
607
627
  /**
608
- * An inconifed internal frame within a DESKTOP_PANE.
628
+ * An inconifed internal frame within a DESKTOP_FRAME.
609
629
  */
610
630
  DESKTOP_ICON,
611
631
  /**
@@ -628,14 +648,14 @@ enum Role {
628
648
  */
629
649
  DIRECTORY_PANE,
630
650
  /**
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.
651
+ * An object used for drawing custom user interface
652
+ * elements.
634
653
  */
635
654
  DRAWING_AREA,
636
655
  /**
637
- * An object used for drawing custom user interface
638
- * elements.
656
+ * A specialized dialog that displays the files in
657
+ * the directory and lets the user select a file, browse a different
658
+ * directory, or specify a filename.
639
659
  */
640
660
  FILE_CHOOSER,
641
661
  /**
@@ -795,14 +815,13 @@ enum Role {
795
815
  SEPARATOR,
796
816
  /**
797
817
  * An object that allows the user to select from a bounded
798
- * range.
818
+ * range. Unlike `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
819
+ * 'viewport'-like objects.
799
820
  */
800
821
  SLIDER,
801
822
  /**
802
823
  * 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.
824
+ * be selected, and which displays the current choice.
806
825
  */
807
826
  SPIN_BUTTON,
808
827
  /**
@@ -925,7 +944,7 @@ enum Role {
925
944
  /**
926
945
  * An object corresponding to the toplevel accessible
927
946
  * of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
928
- * accessible objects. Children of #AccessibleDesktop objects are generally
947
+ * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
929
948
  * `ATSPI_ROLE_APPLICATION` objects.
930
949
  */
931
950
  APPLICATION,
@@ -1261,14 +1280,18 @@ enum Role {
1261
1280
  /**
1262
1281
  * A container for content that is called out as a proposed
1263
1282
  * 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
1283
+ * content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or
1284
+ * %ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the
1266
1285
  * actual change is. `Since:` 2.36
1267
1286
  */
1268
1287
  SUGGESTION,
1288
+ /**
1289
+ * A specialized push button to open a menu. `Since` 2.46
1290
+ */
1291
+ PUSH_BUTTON_MENU,
1269
1292
  /**
1270
1293
  * Not a valid role, used for finding end of
1271
- * enumeration.
1294
+ * enumeration.
1272
1295
  */
1273
1296
  LAST_DEFINED,
1274
1297
  }
@@ -1771,7 +1794,7 @@ enum KeyListenerSyncType {
1771
1794
  NOSYNC,
1772
1795
  /**
1773
1796
  * Events are delivered synchronously, before the
1774
- * currently focussed application sees them.
1797
+ * currently focused application sees them.
1775
1798
  */
1776
1799
  SYNCHRONOUS,
1777
1800
  /**
@@ -1940,6 +1963,14 @@ function generate_keyboard_event(keyval: number, keystring: string | null, synth
1940
1963
  * @returns %TRUE if successful, otherwise %FALSE.
1941
1964
  */
1942
1965
  function generate_mouse_event(x: number, y: number, name: string | null): boolean
1966
+ /**
1967
+ * Like atspi_generate_mouse_event, but asynchronous.
1968
+ * @param x a #glong indicating the screen x coordinate of the mouse event.
1969
+ * @param y a #glong indicating the screen y coordinate of the mouse event.
1970
+ * @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
1971
+ * @param callback a callback to be called when a reply is received. May be NULL.
1972
+ */
1973
+ function generate_mouse_event_async(x: number, y: number, name: string | null, callback: GenerateMouseEventCB | null): void
1943
1974
  /**
1944
1975
  * Gets the virtual desktop indicated by index `i`.
1945
1976
  * NOTE: currently multiple virtual desktops are not implemented;
@@ -1968,6 +1999,10 @@ function get_desktop_count(): number
1968
1999
  * @returns a #GArray of desktops.
1969
2000
  */
1970
2001
  function get_desktop_list(): Accessible[]
2002
+ /**
2003
+ * Returns the version of the AT-SPI library being used at runtime.
2004
+ */
2005
+ function get_version(): [ /* major */ number, /* minor */ number, /* micro */ number ]
1971
2006
  /**
1972
2007
  * Connects to the accessibility registry and initializes the SPI.
1973
2008
  * @returns 0 on success, 1 if already initialized, or an integer error code.
@@ -1979,11 +2014,11 @@ function init(): number
1979
2014
  */
1980
2015
  function is_initialized(): boolean
1981
2016
  /**
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.
2017
+ * This function does nothing and should not be called.
2018
+ * @param listener
2019
+ * @param event_types
2020
+ * @param filter
2021
+ * @returns Always returns %FALSE.
1987
2022
  */
1988
2023
  function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: any | null): boolean
1989
2024
  /**
@@ -2002,9 +2037,14 @@ function register_device_event_listener(listener: DeviceListener, event_types: D
2002
2037
  * @returns %TRUE if successful, otherwise %FALSE.
2003
2038
  */
2004
2039
  function register_keystroke_listener(listener: DeviceListener, key_set: KeyDefinition[] | null, modmask: KeyMaskType, event_types: KeyEventMask, sync_type: KeyListenerSyncType): boolean
2040
+ /**
2041
+ * Gets the localized description string describing the #AtspiRole `role`.
2042
+ * @param role an #AtspiRole object to query.
2043
+ * @returns the localized string describing the AtspiRole
2044
+ */
2045
+ function role_get_localized_name(role: Role): string | null
2005
2046
  /**
2006
2047
  * Gets a localizable string that indicates the name of an #AtspiRole.
2007
- * <em>DEPRECATED.</em>
2008
2048
  * @param role an #AtspiRole object to query.
2009
2049
  * @returns a localizable string name for an #AtspiRole enumerated type.
2010
2050
  */
@@ -2018,18 +2058,13 @@ function role_get_name(role: Role): string | null
2018
2058
  */
2019
2059
  function set_main_context(cnx: GLib.MainContext): void
2020
2060
  /**
2021
- * Sets the reference window that will be used when atspi_generate_mouse_event
2022
- * is called. Coordinates will be assumed to be relative to this window. This
2023
- * is needed because, due to Wayland's security model, it is not currently
2024
- * possible to retrieve global coordinates.
2025
- * If NULL is passed, then AT-SPI will use the window that has focus at the
2026
- * time that atspi_generate_mouse_event is called.
2061
+ * Deprecated. This function no longer does anything and should not be used.
2027
2062
  * @param accessible the #AtspiAccessible corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION.
2028
2063
  */
2029
2064
  function set_reference_window(accessible: Accessible): void
2030
2065
  /**
2031
2066
  * Set the timeout used for method calls. If this is not set explicitly,
2032
- * a default of 0.8 ms is used.
2067
+ * a default of 800 ms is used.
2033
2068
  * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
2034
2069
  * sending a keyboard event notification. This means that, if an AT makes
2035
2070
  * a call in response to the keyboard notification and the application
@@ -2079,6 +2114,9 @@ interface EventListenerCB {
2079
2114
  interface EventListenerSimpleCB {
2080
2115
  (event: Event): void
2081
2116
  }
2117
+ interface GenerateMouseEventCB {
2118
+ (): void
2119
+ }
2082
2120
  /**
2083
2121
  * A callback that will be invoked when a key is pressed.
2084
2122
  * @callback
@@ -2248,6 +2286,15 @@ interface Collection {
2248
2286
  disconnect(id: number): void
2249
2287
  }
2250
2288
 
2289
+ /**
2290
+ * An interface designed to allow accessibles which satisfy a set of
2291
+ * criteria to be returned.
2292
+ *
2293
+ * An interface designed to allow accessibles which satisfy a set of
2294
+ * criteria to be returned. This interface can be used to avoid iteration
2295
+ * or client-side search of the object tree.
2296
+ * @interface
2297
+ */
2251
2298
  class Collection extends GObject.Object {
2252
2299
 
2253
2300
  // Own properties of Atspi-2.0.Atspi.Collection
@@ -2354,8 +2401,8 @@ interface Component {
2354
2401
  scroll_to_point(coords: CoordType, x: number, y: number): boolean
2355
2402
  /**
2356
2403
  * 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.
2404
+ * @param x the new horizontal position to which the component should be moved.
2405
+ * @param y the new vertical position to which the component should be moved.
2359
2406
  * @param width the width to which the component should be resized.
2360
2407
  * @param height the height to which the component should be resized.
2361
2408
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
@@ -2364,14 +2411,14 @@ interface Component {
2364
2411
  set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean
2365
2412
  /**
2366
2413
  * 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.
2414
+ * @param x the new horizontal position to which the component should be moved.
2415
+ * @param y the new vertical position to which the component should be moved.
2369
2416
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
2370
2417
  * @returns #TRUE if successful; #FALSE otherwise.
2371
2418
  */
2372
2419
  set_position(x: number, y: number, ctype: CoordType): boolean
2373
2420
  /**
2374
- * Resizes the specified component to the given coordinates.
2421
+ * Resizes the specified component to the given pixel dimensions.
2375
2422
  * @param width the width to which the component should be resized.
2376
2423
  * @param height the height to which the component should be resized.
2377
2424
  * @returns #TRUE if successful; #FALSE otherwise.
@@ -2386,6 +2433,20 @@ interface Component {
2386
2433
  disconnect(id: number): void
2387
2434
  }
2388
2435
 
2436
+ /**
2437
+ * An interface implemented by objects which have onscreen visual
2438
+ * representations.
2439
+ *
2440
+ * The Component interface is implemented by objects which occupy on-screen
2441
+ * space, e.g. objects which have onscreen visual representations. The methods
2442
+ * in Component allow clients to identify where the objects lie in the onscreen
2443
+ * coordinate system, their relative size, stacking order, and position. It
2444
+ * also provides a mechanism whereby keyboard focus may be transferred to
2445
+ * specific user interface elements programmatically. This is a 2D API.
2446
+ * Coordinates of 3D objects are projected into the 2-dimensional screen view
2447
+ * for purposes of this interface.
2448
+ * @interface
2449
+ */
2389
2450
  class Component extends GObject.Object {
2390
2451
 
2391
2452
  // Own properties of Atspi-2.0.Atspi.Component
@@ -2593,6 +2654,17 @@ interface Hypertext {
2593
2654
  disconnect(id: number): void
2594
2655
  }
2595
2656
 
2657
+ /**
2658
+ * An interface used for objects which implement linking between
2659
+ * multiple resource locations.
2660
+ *
2661
+ * An interface used for objects which implement linking between
2662
+ * multiple resource or content locations, or multiple 'markers'
2663
+ * within a single document. A hypertext instance is associated
2664
+ * with one or more hyperlinks which are associated with particular
2665
+ * offsets within the hypertext's content.
2666
+ * @interface
2667
+ */
2596
2668
  class Hypertext extends GObject.Object {
2597
2669
 
2598
2670
  // Own properties of Atspi-2.0.Atspi.Hypertext
@@ -2766,6 +2838,17 @@ interface Selection {
2766
2838
  disconnect(id: number): void
2767
2839
  }
2768
2840
 
2841
+ /**
2842
+ * An interface which indicates that an object exposes a 'selection' model,
2843
+ * allowing the selection of one or more of its children.
2844
+ *
2845
+ * An interface which indicates that an object exposes a 'selection'
2846
+ * model, allowing the selection of one or more of its children.
2847
+ * Read-only Selection instances are possible, in which case the
2848
+ * interface is used to programmatically determine the selected-ness
2849
+ * of its children.
2850
+ * @interface
2851
+ */
2769
2852
  class Selection extends GObject.Object {
2770
2853
 
2771
2854
  // Own properties of Atspi-2.0.Atspi.Selection
@@ -3013,6 +3096,20 @@ interface Table {
3013
3096
  disconnect(id: number): void
3014
3097
  }
3015
3098
 
3099
+ /**
3100
+ * An interface used by containers whose data is arranged in a tabular form.
3101
+ *
3102
+ * An interface used by containers whose contained data is arranged
3103
+ * in a tabular (i.e. row-column) form. Tables may resemble
3104
+ * a two-dimensional grid, as in a spreadsheet, or may feature objects
3105
+ * which span multiple rows and/or columns, but whose bounds are
3106
+ * aligned on a row/column matrix. Objects within tables are children
3107
+ * of the table object, and they may be referenced either via a child
3108
+ * index or via a row/column pair. Table 'cells' may implement other
3109
+ * interfaces, such as Text, Action, Image, and Component, and should do
3110
+ * so as appropriate to their onscreen presentation and/or behavior.
3111
+ * @interface
3112
+ */
3016
3113
  class Table extends GObject.Object {
3017
3114
 
3018
3115
  // Own properties of Atspi-2.0.Atspi.Table
@@ -3141,7 +3238,6 @@ interface Text {
3141
3238
  * Gets the attributes applied to a range of text from an #AtspiText
3142
3239
  * object. The text attributes correspond to CSS attributes
3143
3240
  * where possible.
3144
- * <em>DEPRECATED</em>
3145
3241
  * @param offset a #gint indicating the offset from which the attribute search is based.
3146
3242
  * @returns a #GHashTable describing the attributes at the given character offset.
3147
3243
  */
@@ -3342,6 +3438,18 @@ interface Text {
3342
3438
  disconnect(id: number): void
3343
3439
  }
3344
3440
 
3441
+ /**
3442
+ * An interface implemented by objects which place textual
3443
+ * information onscreen.
3444
+ *
3445
+ * The text interface should be implemented by objects which place textual
3446
+ * information onscreen as character strings or glyphs. The text interface
3447
+ * allows access to textual content including display attributes and
3448
+ * semantic hints associated with runs of text, and to bounding
3449
+ * information for glyphs and substrings. It also allows portions of text to
3450
+ * be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
3451
+ * @interface
3452
+ */
3345
3453
  class Text extends GObject.Object {
3346
3454
 
3347
3455
  // Own properties of Atspi-2.0.Atspi.Text
@@ -3409,6 +3517,16 @@ interface Value {
3409
3517
  disconnect(id: number): void
3410
3518
  }
3411
3519
 
3520
+ /**
3521
+ * An interface supporting a one-dimensional scalar
3522
+ * to be modified, or which reflects its value.
3523
+ *
3524
+ * An interface supporting a one-dimensional scalar
3525
+ * to be modified, or which reflects its value. If
3526
+ * STATE_EDITABLE is not present, the value is
3527
+ * treated as "read only".
3528
+ * @interface
3529
+ */
3412
3530
  class Value extends GObject.Object {
3413
3531
 
3414
3532
  // Own properties of Atspi-2.0.Atspi.Value
@@ -3471,6 +3589,10 @@ interface Accessible extends Action, Collection, Component, Document, EditableTe
3471
3589
  * descendants.
3472
3590
  */
3473
3591
  clear_cache(): void
3592
+ /**
3593
+ * Clears the cached information only for the given accessible.
3594
+ */
3595
+ clear_cache_single(): void
3474
3596
  /**
3475
3597
  * Gets the accessible id of the accessible. This is not meant to be presented
3476
3598
  * to the user, but to be an id which is stable over application development.
@@ -3731,6 +3853,14 @@ interface Accessible extends Action, Collection, Component, Document, EditableTe
3731
3853
  disconnect(id: number): void
3732
3854
  }
3733
3855
 
3856
+ /**
3857
+ * The base interface which is implemented by all accessible objects.
3858
+ *
3859
+ * All objects support interfaces for querying their contained 'children'
3860
+ * and position in the accessible-object hierarchy, whether or not they
3861
+ * actually have children.
3862
+ * @class
3863
+ */
3734
3864
  class Accessible extends Object {
3735
3865
 
3736
3866
  // Own properties of Atspi-2.0.Atspi.Accessible
@@ -3776,6 +3906,14 @@ interface Application {
3776
3906
  disconnect(id: number): void
3777
3907
  }
3778
3908
 
3909
+ /**
3910
+ * An interface identifying the root object associated
3911
+ * with a running application.
3912
+ *
3913
+ * An interface identifying an object which is the root of the
3914
+ * hierarchy associated with a running application.
3915
+ * @class
3916
+ */
3779
3917
  class Application extends GObject.Object {
3780
3918
 
3781
3919
  // Own properties of Atspi-2.0.Atspi.Application
@@ -3820,7 +3958,7 @@ interface Device {
3820
3958
  */
3821
3959
  get_locked_modifiers(): number
3822
3960
  /**
3823
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3961
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3824
3962
  * mapping. This function should be used when the intention is to query a
3825
3963
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3826
3964
  * rather than to add key grabs.
@@ -3875,7 +4013,7 @@ interface Device {
3875
4013
  */
3876
4014
  vfunc_get_locked_modifiers(): number
3877
4015
  /**
3878
- * Gets the modifier for a given keycode, if one exists. Does not creatt a new
4016
+ * Gets the modifier for a given keycode, if one exists. Does not create a new
3879
4017
  * mapping. This function should be used when the intention is to query a
3880
4018
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3881
4019
  * rather than to add key grabs.
@@ -4205,6 +4343,7 @@ interface EventListener {
4205
4343
  * object:column-deleted
4206
4344
  * object:model-changed
4207
4345
  * object:active-descendant-changed
4346
+ * object:announcement
4208
4347
  *
4209
4348
  * (screen reader events)
4210
4349
  * screen-reader:region-changed
@@ -4279,6 +4418,16 @@ interface EventListener {
4279
4418
  disconnect(id: number): void
4280
4419
  }
4281
4420
 
4421
+ /**
4422
+ * A generic interface implemented by objects for the receipt of event
4423
+ * notifications.
4424
+ *
4425
+ * A generic interface implemented by objects for the receipt of event
4426
+ * notifications. atspi-event-listener is the interface via which clients of
4427
+ * the atspi-registry receive notification of changes to an application's user
4428
+ * interface and content.
4429
+ * @class
4430
+ */
4282
4431
  class EventListener extends GObject.Object {
4283
4432
 
4284
4433
  // Own properties of Atspi-2.0.Atspi.EventListener
@@ -4393,6 +4542,19 @@ interface Hyperlink {
4393
4542
  disconnect(id: number): void
4394
4543
  }
4395
4544
 
4545
+ /**
4546
+ * Instances of atspi-hyperlink are the means by which end users
4547
+ * and clients interact with linked content.
4548
+ *
4549
+ * Instances of atspi-hyperlink are returned by
4550
+ * atspi-hypertext objects, and are the means by
4551
+ * which end users and clients interact with linked,
4552
+ * and in some cases embedded, content. These instances
4553
+ * may have multiple "anchors", where an anchor corresponds to a
4554
+ * reference to a particular resource with a corresponding resource
4555
+ * identified (URI).
4556
+ * @class
4557
+ */
4396
4558
  class Hyperlink extends Object {
4397
4559
 
4398
4560
  // Own properties of Atspi-2.0.Atspi.Hyperlink
@@ -4438,6 +4600,11 @@ interface MatchRule {
4438
4600
  disconnect(id: number): void
4439
4601
  }
4440
4602
 
4603
+ /**
4604
+ * An interface that allows the definition of match rules
4605
+ * for accessible objects.
4606
+ * @class
4607
+ */
4441
4608
  class MatchRule extends GObject.Object {
4442
4609
 
4443
4610
  // Own properties of Atspi-2.0.Atspi.MatchRule
@@ -4458,7 +4625,7 @@ class MatchRule extends GObject.Object {
4458
4625
  * @param attributematchtype An #AtspiCollectionMatchType specifying how to interpret `attributes`.
4459
4626
  * @param roles A #GArray of roles to match, or NULL if not applicable.
4460
4627
  * @param rolematchtype An #AtspiCollectionMatchType specifying how to interpret `roles`.
4461
- * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by their DBus names (org.a11y.Atspi.Accessible, org.a11y.Atspi.Component, etc).
4628
+ * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by the final component of their DBus names (Accessible, Component, etc).
4462
4629
  * @param interfacematchtype An #AtspiCollectionMatchType specifying how to interpret `interfaces`.
4463
4630
  * @param invert if #TRUE, the match rule should be denied (inverted); if #FALSE, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time.
4464
4631
  * @returns A new #AtspiMatchRule.
@@ -4474,7 +4641,7 @@ class MatchRule extends GObject.Object {
4474
4641
  * @param attributematchtype An #AtspiCollectionMatchType specifying how to interpret `attributes`.
4475
4642
  * @param roles A #GArray of roles to match, or NULL if not applicable.
4476
4643
  * @param rolematchtype An #AtspiCollectionMatchType specifying how to interpret `roles`.
4477
- * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by their DBus names (org.a11y.Atspi.Accessible, org.a11y.Atspi.Component, etc).
4644
+ * @param interfaces An array of interfaces to match, or NULL if not applicable. Interface names should be specified by the final component of their DBus names (Accessible, Component, etc).
4478
4645
  * @param interfacematchtype An #AtspiCollectionMatchType specifying how to interpret `interfaces`.
4479
4646
  * @param invert if #TRUE, the match rule should be denied (inverted); if #FALSE, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, focusable and clickable at the same time.
4480
4647
  * @returns A new #AtspiMatchRule.
@@ -4567,6 +4734,15 @@ interface Relation {
4567
4734
  disconnect(id: number): void
4568
4735
  }
4569
4736
 
4737
+ /**
4738
+ * An interface via which non-hierarchical relationships
4739
+ * are indicated.
4740
+ *
4741
+ * An interface via which non-hierarchical relationships
4742
+ * are indicated. An instance of this interface represents
4743
+ * a "one-to-many" correspondence.
4744
+ * @class
4745
+ */
4570
4746
  class Relation extends GObject.Object {
4571
4747
 
4572
4748
  // Own properties of Atspi-2.0.Atspi.Relation
@@ -4657,6 +4833,11 @@ interface StateSet {
4657
4833
  disconnect(id: number): void
4658
4834
  }
4659
4835
 
4836
+ /**
4837
+ * The atspi-stateset objects implement wrappers around a
4838
+ * bitmap of accessible states.
4839
+ * @class
4840
+ */
4660
4841
  class StateSet extends GObject.Object {
4661
4842
 
4662
4843
  // 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.4",
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.4",
29
+ "@girs/gjs": "^3.2.4",
30
+ "@girs/glib-2.0": "^2.78.0-3.2.4",
31
+ "@girs/gobject-2.0": "^2.78.0-3.2.4"
32
32
  },
33
33
  "devDependencies": {
34
34
  "typescript": "*"