@girs/atspi-2.0 2.0.0-3.2.6 → 2.0.0-3.2.8

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/atspi-2.0.d.cts CHANGED
@@ -288,26 +288,6 @@ 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
- }
311
291
  /**
312
292
  * Used by interfaces #AtspiText and #AtspiDocument, this
313
293
  * enumeration corresponds to the POSIX 'setlocale' enum values.
@@ -623,7 +603,7 @@ export enum Role {
623
603
  */
624
604
  DATE_EDITOR,
625
605
  /**
626
- * An inconifed internal frame within a DESKTOP_FRAME.
606
+ * An inconifed internal frame within a DESKTOP_PANE.
627
607
  */
628
608
  DESKTOP_ICON,
629
609
  /**
@@ -645,16 +625,16 @@ export enum Role {
645
625
  * and select the contents of a directory.
646
626
  */
647
627
  DIRECTORY_PANE,
648
- /**
649
- * An object used for drawing custom user interface
650
- * elements.
651
- */
652
- DRAWING_AREA,
653
628
  /**
654
629
  * A specialized dialog that displays the files in
655
630
  * the directory and lets the user select a file, browse a different
656
631
  * directory, or specify a filename.
657
632
  */
633
+ DRAWING_AREA,
634
+ /**
635
+ * An object used for drawing custom user interface
636
+ * elements.
637
+ */
658
638
  FILE_CHOOSER,
659
639
  /**
660
640
  * A object that fills up space in a user interface.
@@ -813,13 +793,14 @@ export enum Role {
813
793
  SEPARATOR,
814
794
  /**
815
795
  * An object that allows the user to select from a bounded
816
- * range. Unlike `ATSPI_ROLE_SCROLL_BAR,` `ATSPI_ROLE_SLIDER` objects need not control
817
- * 'viewport'-like objects.
796
+ * range.
818
797
  */
819
798
  SLIDER,
820
799
  /**
821
800
  * An object which allows one of a set of choices to
822
- * be selected, and which displays the current choice.
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.
823
804
  */
824
805
  SPIN_BUTTON,
825
806
  /**
@@ -942,7 +923,7 @@ export enum Role {
942
923
  /**
943
924
  * An object corresponding to the toplevel accessible
944
925
  * of an application, which may contain `ATSPI_ROLE_FRAME` objects or other
945
- * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
926
+ * accessible objects. Children of #AccessibleDesktop objects are generally
946
927
  * `ATSPI_ROLE_APPLICATION` objects.
947
928
  */
948
929
  APPLICATION,
@@ -1278,18 +1259,14 @@ export enum Role {
1278
1259
  /**
1279
1260
  * A container for content that is called out as a proposed
1280
1261
  * change from the current version of the document, such as by a reviewer of 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
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
1283
1264
  * actual change is. `Since:` 2.36
1284
1265
  */
1285
1266
  SUGGESTION,
1286
- /**
1287
- * A specialized push button to open a menu. `Since` 2.46
1288
- */
1289
- PUSH_BUTTON_MENU,
1290
1267
  /**
1291
1268
  * Not a valid role, used for finding end of
1292
- * enumeration.
1269
+ * enumeration.
1293
1270
  */
1294
1271
  LAST_DEFINED,
1295
1272
  }
@@ -1792,7 +1769,7 @@ export enum KeyListenerSyncType {
1792
1769
  NOSYNC,
1793
1770
  /**
1794
1771
  * Events are delivered synchronously, before the
1795
- * currently focused application sees them.
1772
+ * currently focussed application sees them.
1796
1773
  */
1797
1774
  SYNCHRONOUS,
1798
1775
  /**
@@ -1819,36 +1796,36 @@ export const COMPONENTLAYER_COUNT: number
1819
1796
  * One higher than the highest valid value of #AtspiCoordType.
1820
1797
  */
1821
1798
  export const COORD_TYPE_COUNT: number
1822
- export const DBUS_INTERFACE_ACCESSIBLE: string | null
1823
- export const DBUS_INTERFACE_ACTION: string | null
1824
- export const DBUS_INTERFACE_APPLICATION: string | null
1825
- export const DBUS_INTERFACE_CACHE: string | null
1826
- export const DBUS_INTERFACE_COLLECTION: string | null
1827
- export const DBUS_INTERFACE_COMPONENT: string | null
1828
- export const DBUS_INTERFACE_DEC: string | null
1829
- export const DBUS_INTERFACE_DEVICE_EVENT_LISTENER: string | null
1830
- export const DBUS_INTERFACE_DOCUMENT: string | null
1831
- export const DBUS_INTERFACE_EDITABLE_TEXT: string | null
1832
- export const DBUS_INTERFACE_EVENT_KEYBOARD: string | null
1833
- export const DBUS_INTERFACE_EVENT_MOUSE: string | null
1834
- export const DBUS_INTERFACE_EVENT_OBJECT: string | null
1835
- export const DBUS_INTERFACE_EVENT_SCREEN_READER: string | null
1836
- export const DBUS_INTERFACE_HYPERLINK: string | null
1837
- export const DBUS_INTERFACE_HYPERTEXT: string | null
1838
- export const DBUS_INTERFACE_IMAGE: string | null
1839
- export const DBUS_INTERFACE_REGISTRY: string | null
1840
- export const DBUS_INTERFACE_SELECTION: string | null
1841
- export const DBUS_INTERFACE_SOCKET: string | null
1842
- export const DBUS_INTERFACE_TABLE: string | null
1843
- export const DBUS_INTERFACE_TABLE_CELL: string | null
1844
- export const DBUS_INTERFACE_TEXT: string | null
1845
- export const DBUS_INTERFACE_VALUE: string | null
1846
- export const DBUS_NAME_REGISTRY: string | null
1847
- export const DBUS_PATH_DEC: string | null
1848
- export const DBUS_PATH_NULL: string | null
1849
- export const DBUS_PATH_REGISTRY: string | null
1850
- export const DBUS_PATH_ROOT: string | null
1851
- export const DBUS_PATH_SCREEN_READER: string | null
1799
+ export const DBUS_INTERFACE_ACCESSIBLE: string
1800
+ export const DBUS_INTERFACE_ACTION: string
1801
+ export const DBUS_INTERFACE_APPLICATION: string
1802
+ export const DBUS_INTERFACE_CACHE: string
1803
+ export const DBUS_INTERFACE_COLLECTION: string
1804
+ export const DBUS_INTERFACE_COMPONENT: string
1805
+ export const DBUS_INTERFACE_DEC: string
1806
+ export const DBUS_INTERFACE_DEVICE_EVENT_LISTENER: string
1807
+ export const DBUS_INTERFACE_DOCUMENT: string
1808
+ export const DBUS_INTERFACE_EDITABLE_TEXT: string
1809
+ export const DBUS_INTERFACE_EVENT_KEYBOARD: string
1810
+ export const DBUS_INTERFACE_EVENT_MOUSE: string
1811
+ export const DBUS_INTERFACE_EVENT_OBJECT: string
1812
+ export const DBUS_INTERFACE_EVENT_SCREEN_READER: string
1813
+ export const DBUS_INTERFACE_HYPERLINK: string
1814
+ export const DBUS_INTERFACE_HYPERTEXT: string
1815
+ export const DBUS_INTERFACE_IMAGE: string
1816
+ export const DBUS_INTERFACE_REGISTRY: string
1817
+ export const DBUS_INTERFACE_SELECTION: string
1818
+ export const DBUS_INTERFACE_SOCKET: string
1819
+ export const DBUS_INTERFACE_TABLE: string
1820
+ export const DBUS_INTERFACE_TABLE_CELL: string
1821
+ export const DBUS_INTERFACE_TEXT: string
1822
+ export const DBUS_INTERFACE_VALUE: string
1823
+ export const DBUS_NAME_REGISTRY: string
1824
+ export const DBUS_PATH_DEC: string
1825
+ export const DBUS_PATH_NULL: string
1826
+ export const DBUS_PATH_REGISTRY: string
1827
+ export const DBUS_PATH_ROOT: string
1828
+ export const DBUS_PATH_SCREEN_READER: string
1852
1829
  /**
1853
1830
  * One higher than the highest valid value of #AtspiEventType.
1854
1831
  */
@@ -1960,15 +1937,7 @@ export function generate_keyboard_event(keyval: number, keystring: string | null
1960
1937
  * @param name a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs").
1961
1938
  * @returns %TRUE if successful, otherwise %FALSE.
1962
1939
  */
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
1940
+ export function generate_mouse_event(x: number, y: number, name: string): boolean
1972
1941
  /**
1973
1942
  * Gets the virtual desktop indicated by index `i`.
1974
1943
  * NOTE: currently multiple virtual desktops are not implemented;
@@ -1997,10 +1966,6 @@ export function get_desktop_count(): number
1997
1966
  * @returns a #GArray of desktops.
1998
1967
  */
1999
1968
  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 ]
2004
1969
  /**
2005
1970
  * Connects to the accessibility registry and initializes the SPI.
2006
1971
  * @returns 0 on success, 1 if already initialized, or an integer error code.
@@ -2012,11 +1977,11 @@ export function init(): number
2012
1977
  */
2013
1978
  export function is_initialized(): boolean
2014
1979
  /**
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.
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.
2020
1985
  */
2021
1986
  export function register_device_event_listener(listener: DeviceListener, event_types: DeviceEventMask, filter: any | null): boolean
2022
1987
  /**
@@ -2035,14 +2000,9 @@ export function register_device_event_listener(listener: DeviceListener, event_t
2035
2000
  * @returns %TRUE if successful, otherwise %FALSE.
2036
2001
  */
2037
2002
  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
2044
2003
  /**
2045
2004
  * Gets a localizable string that indicates the name of an #AtspiRole.
2005
+ * <em>DEPRECATED.</em>
2046
2006
  * @param role an #AtspiRole object to query.
2047
2007
  * @returns a localizable string name for an #AtspiRole enumerated type.
2048
2008
  */
@@ -2056,13 +2016,18 @@ export function role_get_name(role: Role): string | null
2056
2016
  */
2057
2017
  export function set_main_context(cnx: GLib.MainContext): void
2058
2018
  /**
2059
- * Deprecated. This function no longer does anything and should not be used.
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.
2060
2025
  * @param accessible the #AtspiAccessible corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION.
2061
2026
  */
2062
2027
  export function set_reference_window(accessible: Accessible): void
2063
2028
  /**
2064
2029
  * Set the timeout used for method calls. If this is not set explicitly,
2065
- * a default of 800 ms is used.
2030
+ * a default of 0.8 ms is used.
2066
2031
  * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
2067
2032
  * sending a keyboard event notification. This means that, if an AT makes
2068
2033
  * a call in response to the keyboard notification and the application
@@ -2112,9 +2077,6 @@ export interface EventListenerCB {
2112
2077
  export interface EventListenerSimpleCB {
2113
2078
  (event: Event): void
2114
2079
  }
2115
- export interface GenerateMouseEventCB {
2116
- (): void
2117
- }
2118
2080
  /**
2119
2081
  * A callback that will be invoked when a key is pressed.
2120
2082
  * @callback
@@ -2126,7 +2088,7 @@ export interface GenerateMouseEventCB {
2126
2088
  * @param keystring the text corresponding to the keypress.
2127
2089
  */
2128
2090
  export interface KeyCallback {
2129
- (device: Device, pressed: boolean, keycode: number, keysym: number, modifiers: number, keystring: string | null): void
2091
+ (device: Device, pressed: boolean, keycode: number, keysym: number, modifiers: number, keystring: string): void
2130
2092
  }
2131
2093
  export module Action {
2132
2094
 
@@ -2284,15 +2246,6 @@ export interface Collection {
2284
2246
  disconnect(id: number): void
2285
2247
  }
2286
2248
 
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
- */
2296
2249
  export class Collection extends GObject.Object {
2297
2250
 
2298
2251
  // Own properties of Atspi-2.0.Atspi.Collection
@@ -2399,8 +2352,8 @@ export interface Component {
2399
2352
  scroll_to_point(coords: CoordType, x: number, y: number): boolean
2400
2353
  /**
2401
2354
  * Moves and resizes the specified component.
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.
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.
2404
2357
  * @param width the width to which the component should be resized.
2405
2358
  * @param height the height to which the component should be resized.
2406
2359
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
@@ -2409,14 +2362,14 @@ export interface Component {
2409
2362
  set_extents(x: number, y: number, width: number, height: number, ctype: CoordType): boolean
2410
2363
  /**
2411
2364
  * Moves the component to the specified position.
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.
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.
2414
2367
  * @param ctype the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
2415
2368
  * @returns #TRUE if successful; #FALSE otherwise.
2416
2369
  */
2417
2370
  set_position(x: number, y: number, ctype: CoordType): boolean
2418
2371
  /**
2419
- * Resizes the specified component to the given pixel dimensions.
2372
+ * Resizes the specified component to the given coordinates.
2420
2373
  * @param width the width to which the component should be resized.
2421
2374
  * @param height the height to which the component should be resized.
2422
2375
  * @returns #TRUE if successful; #FALSE otherwise.
@@ -2431,20 +2384,6 @@ export interface Component {
2431
2384
  disconnect(id: number): void
2432
2385
  }
2433
2386
 
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
- */
2448
2387
  export class Component extends GObject.Object {
2449
2388
 
2450
2389
  // Own properties of Atspi-2.0.Atspi.Component
@@ -2573,7 +2512,7 @@ export interface EditableText {
2573
2512
  * @param length the number of characters of text to insert, in bytes. If the byte count of text is less than or equal to length, the entire contents of text will be inserted.
2574
2513
  * @returns #TRUE if the operation was successful, otherwise #FALSE.
2575
2514
  */
2576
- insert_text(position: number, text: string | null, length: number): boolean
2515
+ insert_text(position: number, text: string, length: number): boolean
2577
2516
  /**
2578
2517
  * Inserts text from the system clipboard into an #AtspiEditableText object.
2579
2518
  * As with all character offsets, the specified `position` may not be the
@@ -2588,7 +2527,7 @@ export interface EditableText {
2588
2527
  * @param new_contents a character string, encoded in UTF-8, which is to become the new text contents of the #AtspiEditableText object.
2589
2528
  * @returns #TRUE if the operation was successful, otherwise #FALSE.
2590
2529
  */
2591
- set_text_contents(new_contents: string | null): boolean
2530
+ set_text_contents(new_contents: string): boolean
2592
2531
 
2593
2532
  // Class property signals of Atspi-2.0.Atspi.EditableText
2594
2533
 
@@ -2652,17 +2591,6 @@ export interface Hypertext {
2652
2591
  disconnect(id: number): void
2653
2592
  }
2654
2593
 
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
- */
2666
2594
  export class Hypertext extends GObject.Object {
2667
2595
 
2668
2596
  // Own properties of Atspi-2.0.Atspi.Hypertext
@@ -2836,17 +2764,6 @@ export interface Selection {
2836
2764
  disconnect(id: number): void
2837
2765
  }
2838
2766
 
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
- */
2850
2767
  export class Selection extends GObject.Object {
2851
2768
 
2852
2769
  // Own properties of Atspi-2.0.Atspi.Selection
@@ -3094,20 +3011,6 @@ export interface Table {
3094
3011
  disconnect(id: number): void
3095
3012
  }
3096
3013
 
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
- */
3111
3014
  export class Table extends GObject.Object {
3112
3015
 
3113
3016
  // Own properties of Atspi-2.0.Atspi.Table
@@ -3236,6 +3139,7 @@ export interface Text {
3236
3139
  * Gets the attributes applied to a range of text from an #AtspiText
3237
3140
  * object. The text attributes correspond to CSS attributes
3238
3141
  * where possible.
3142
+ * <em>DEPRECATED</em>
3239
3143
  * @param offset a #gint indicating the offset from which the attribute search is based.
3240
3144
  * @returns a #GHashTable describing the attributes at the given character offset.
3241
3145
  */
@@ -3436,18 +3340,6 @@ export interface Text {
3436
3340
  disconnect(id: number): void
3437
3341
  }
3438
3342
 
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
- */
3451
3343
  export class Text extends GObject.Object {
3452
3344
 
3453
3345
  // Own properties of Atspi-2.0.Atspi.Text
@@ -3515,16 +3407,6 @@ export interface Value {
3515
3407
  disconnect(id: number): void
3516
3408
  }
3517
3409
 
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
- */
3528
3410
  export class Value extends GObject.Object {
3529
3411
 
3530
3412
  // Own properties of Atspi-2.0.Atspi.Value
@@ -3587,10 +3469,6 @@ export interface Accessible extends Action, Collection, Component, Document, Edi
3587
3469
  * descendants.
3588
3470
  */
3589
3471
  clear_cache(): void
3590
- /**
3591
- * Clears the cached information only for the given accessible.
3592
- */
3593
- clear_cache_single(): void
3594
3472
  /**
3595
3473
  * Gets the accessible id of the accessible. This is not meant to be presented
3596
3474
  * to the user, but to be an id which is stable over application development.
@@ -3712,7 +3590,7 @@ export interface Accessible extends Action, Collection, Component, Document, Edi
3712
3590
  * @returns a UTF-8 string indicating the name of the #AtspiAccessible object or NULL on exception.
3713
3591
  */
3714
3592
  get_name(): string | null
3715
- get_object_locale(): string | null
3593
+ get_object_locale(): string
3716
3594
  /**
3717
3595
  * Gets an #AtspiAccessible object's parent container.
3718
3596
  * @returns a pointer to the #AtspiAccessible object which contains the given #AtspiAccessible instance, or NULL if the @obj has no parent container.
@@ -3851,14 +3729,6 @@ export interface Accessible extends Action, Collection, Component, Document, Edi
3851
3729
  disconnect(id: number): void
3852
3730
  }
3853
3731
 
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
- */
3862
3732
  export class Accessible extends Object {
3863
3733
 
3864
3734
  // Own properties of Atspi-2.0.Atspi.Accessible
@@ -3904,14 +3774,6 @@ export interface Application {
3904
3774
  disconnect(id: number): void
3905
3775
  }
3906
3776
 
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
- */
3915
3777
  export class Application extends GObject.Object {
3916
3778
 
3917
3779
  // Own properties of Atspi-2.0.Atspi.Application
@@ -3956,7 +3818,7 @@ export interface Device {
3956
3818
  */
3957
3819
  get_locked_modifiers(): number
3958
3820
  /**
3959
- * Gets the modifier for a given keycode, if one exists. Does not create a new
3821
+ * Gets the modifier for a given keycode, if one exists. Does not creatt a new
3960
3822
  * mapping. This function should be used when the intention is to query a
3961
3823
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
3962
3824
  * rather than to add key grabs.
@@ -4011,7 +3873,7 @@ export interface Device {
4011
3873
  */
4012
3874
  vfunc_get_locked_modifiers(): number
4013
3875
  /**
4014
- * Gets the modifier for a given keycode, if one exists. Does not create a new
3876
+ * Gets the modifier for a given keycode, if one exists. Does not creatt a new
4015
3877
  * mapping. This function should be used when the intention is to query a
4016
3878
  * locking modifier such as num lock via atspi_device_get_locked_modifiers,
4017
3879
  * rather than to add key grabs.
@@ -4303,7 +4165,7 @@ export interface EventListener {
4303
4165
  * @param event_type a string specifying the event type for which this listener is to be deregistered.
4304
4166
  * @returns #TRUE if successful, otherwise #FALSE.
4305
4167
  */
4306
- deregister(event_type: string | null): boolean
4168
+ deregister(event_type: string): boolean
4307
4169
  /**
4308
4170
  * Adds an in-process callback function to an existing #AtspiEventListener.
4309
4171
  *
@@ -4341,7 +4203,6 @@ export interface EventListener {
4341
4203
  * object:column-deleted
4342
4204
  * object:model-changed
4343
4205
  * object:active-descendant-changed
4344
- * object:announcement
4345
4206
  *
4346
4207
  * (screen reader events)
4347
4208
  * screen-reader:region-changed
@@ -4391,14 +4252,14 @@ export interface EventListener {
4391
4252
  * @param event_type a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. EventClasses include "object", "window", "mouse", and toolkit events (e.g. "Gtk", "AWT"). Examples: "focus:", "Gtk:GtkWidget:button_press_event".
4392
4253
  * @returns #TRUE if successful, otherwise #FALSE.
4393
4254
  */
4394
- register(event_type: string | null): boolean
4255
+ register(event_type: string): boolean
4395
4256
  /**
4396
4257
  * Adds an in-process callback function to an existing #AtspiEventListener.
4397
4258
  * @param event_type a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format and legal event types.
4398
4259
  * @param properties a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback. TODO: Document.
4399
4260
  * @returns #TRUE if successful, otherwise #FALSE.
4400
4261
  */
4401
- register_full(event_type: string | null, properties: string[] | null): boolean
4262
+ register_full(event_type: string, properties: string[] | null): boolean
4402
4263
  /**
4403
4264
  * Adds an in-process callback function to an existing #AtspiEventListener.
4404
4265
  * @param event_type a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format and legal event types.
@@ -4406,7 +4267,7 @@ export interface EventListener {
4406
4267
  * @param app the application whose events should be reported, or %null for all applications.
4407
4268
  * @returns #TRUE if successful, otherwise #FALSE.
4408
4269
  */
4409
- register_with_app(event_type: string | null, properties: string[] | null, app: Accessible | null): boolean
4270
+ register_with_app(event_type: string, properties: string[] | null, app: Accessible | null): boolean
4410
4271
 
4411
4272
  // Class property signals of Atspi-2.0.Atspi.EventListener
4412
4273
 
@@ -4416,16 +4277,6 @@ export interface EventListener {
4416
4277
  disconnect(id: number): void
4417
4278
  }
4418
4279
 
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
- */
4429
4280
  export class EventListener extends GObject.Object {
4430
4281
 
4431
4282
  // Own properties of Atspi-2.0.Atspi.EventListener
@@ -4458,16 +4309,16 @@ export class EventListener extends GObject.Object {
4458
4309
  * @param event_type a string specifying the event type for which this listener is to be deregistered.
4459
4310
  * @returns #TRUE if successful, otherwise #FALSE.
4460
4311
  */
4461
- static deregister_from_callback(callback: EventListenerCB, event_type: string | null): boolean
4312
+ static deregister_from_callback(callback: EventListenerCB, event_type: string): boolean
4462
4313
  /**
4463
4314
  * Registers an #AtspiEventListenerCB against an `event_type`.
4464
4315
  * @param callback the #AtspiEventListenerCB to be registered against an event type.
4465
4316
  * @param event_type a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format.
4466
4317
  * @returns #TRUE if successfull, otherwise #FALSE.
4467
4318
  */
4468
- static register_from_callback(callback: EventListenerCB, event_type: string | null): boolean
4469
- static register_from_callback_full(event_type: string | null, properties: string[]): boolean
4470
- static register_from_callback_with_app(event_type: string | null, properties: string[], app: Accessible | null): boolean
4319
+ static register_from_callback(callback: EventListenerCB, event_type: string): boolean
4320
+ static register_from_callback_full(event_type: string, properties: string[]): boolean
4321
+ static register_from_callback_with_app(event_type: string, properties: string[], app: Accessible | null): boolean
4471
4322
  }
4472
4323
 
4473
4324
  export module Hyperlink {
@@ -4540,19 +4391,6 @@ export interface Hyperlink {
4540
4391
  disconnect(id: number): void
4541
4392
  }
4542
4393
 
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
- */
4556
4394
  export class Hyperlink extends Object {
4557
4395
 
4558
4396
  // Own properties of Atspi-2.0.Atspi.Hyperlink
@@ -4598,11 +4436,6 @@ export interface MatchRule {
4598
4436
  disconnect(id: number): void
4599
4437
  }
4600
4438
 
4601
- /**
4602
- * An interface that allows the definition of match rules
4603
- * for accessible objects.
4604
- * @class
4605
- */
4606
4439
  export class MatchRule extends GObject.Object {
4607
4440
 
4608
4441
  // Own properties of Atspi-2.0.Atspi.MatchRule
@@ -4623,7 +4456,7 @@ export class MatchRule extends GObject.Object {
4623
4456
  * @param attributematchtype An #AtspiCollectionMatchType specifying how to interpret `attributes`.
4624
4457
  * @param roles A #GArray of roles to match, or NULL if not applicable.
4625
4458
  * @param rolematchtype An #AtspiCollectionMatchType specifying how to interpret `roles`.
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).
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).
4627
4460
  * @param interfacematchtype An #AtspiCollectionMatchType specifying how to interpret `interfaces`.
4628
4461
  * @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.
4629
4462
  * @returns A new #AtspiMatchRule.
@@ -4639,7 +4472,7 @@ export class MatchRule extends GObject.Object {
4639
4472
  * @param attributematchtype An #AtspiCollectionMatchType specifying how to interpret `attributes`.
4640
4473
  * @param roles A #GArray of roles to match, or NULL if not applicable.
4641
4474
  * @param rolematchtype An #AtspiCollectionMatchType specifying how to interpret `roles`.
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).
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).
4643
4476
  * @param interfacematchtype An #AtspiCollectionMatchType specifying how to interpret `interfaces`.
4644
4477
  * @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.
4645
4478
  * @returns A new #AtspiMatchRule.
@@ -4732,15 +4565,6 @@ export interface Relation {
4732
4565
  disconnect(id: number): void
4733
4566
  }
4734
4567
 
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
- */
4744
4568
  export class Relation extends GObject.Object {
4745
4569
 
4746
4570
  // Own properties of Atspi-2.0.Atspi.Relation
@@ -4821,7 +4645,7 @@ export interface StateSet {
4821
4645
  * @param name a string corresponding to a state name.
4822
4646
  * @param enabled if #TRUE, `name` should be enabled in the `set` in question; otherwise, it should be disabled.
4823
4647
  */
4824
- set_by_name(name: string | null, enabled: boolean): void
4648
+ set_by_name(name: string, enabled: boolean): void
4825
4649
 
4826
4650
  // Class property signals of Atspi-2.0.Atspi.StateSet
4827
4651
 
@@ -4831,11 +4655,6 @@ export interface StateSet {
4831
4655
  disconnect(id: number): void
4832
4656
  }
4833
4657
 
4834
- /**
4835
- * The atspi-stateset objects implement wrappers around a
4836
- * bitmap of accessible states.
4837
- * @class
4838
- */
4839
4658
  export class StateSet extends GObject.Object {
4840
4659
 
4841
4660
  // Own properties of Atspi-2.0.Atspi.StateSet