@girs/atk-1.0 2.45.1-3.0.0 → 2.48.2-3.0.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
@@ -1,7 +1,11 @@
1
1
 
2
2
  # Atk-1.0
3
3
 
4
- GJS TypeScript type definitions for Atk-1.0, generated from library version 2.45.1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0.
4
+ ![version](https://img.shields.io/npm/v/@girs/atk-1.0)
5
+ ![downloads/week](https://img.shields.io/npm/dw/@girs/atk-1.0)
6
+
7
+
8
+ GJS TypeScript type definitions for Atk-1.0, generated from library version 2.48.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.3.
5
9
 
6
10
  ATK provides the set of accessibility interfaces that are implemented by other toolkits and applications. Using the ATK interfaces, accessibility tools have full access to view and control running applications.
7
11
 
package/atk-1.0.d.cts CHANGED
@@ -805,6 +805,11 @@ export enum Role {
805
805
  * actual change is. (Since: 2.36)
806
806
  */
807
807
  SUGGESTION,
808
+ /**
809
+ * A specialized push button to open a menu.
810
+ * (Since: 2.46)
811
+ */
812
+ PUSH_BUTTON_MENU,
808
813
  /**
809
814
  * not a valid role, used for finding end of the enumeration
810
815
  */
@@ -1638,7 +1643,7 @@ export function value_type_get_name(value_type: ValueType): string | null
1638
1643
  * supported are events of type "focus:". Most clients of ATK will prefer to
1639
1644
  * attach signal handlers for the various ATK signals instead.
1640
1645
  *
1641
- * see atk_add_focus_tracker.
1646
+ * see [id`atk_add_focus_tracker]`
1642
1647
  * @callback
1643
1648
  * @param obj An #AtkObject instance for whom the callback will be called when the specified event (e.g. 'focus:') takes place.
1644
1649
  */
@@ -1650,7 +1655,7 @@ export interface EventListener {
1650
1655
  * called in order to initialize the per-object event registration system
1651
1656
  * used by #AtkEventListener, if any preparation is required.
1652
1657
  *
1653
- * see atk_focus_tracker_init.
1658
+ * see [id`atk_focus_tracker_init]`
1654
1659
  * @callback
1655
1660
  */
1656
1661
  export interface EventListenerInit {
@@ -1683,7 +1688,7 @@ export interface Function {
1683
1688
  * interception of key events via the return code as described below.
1684
1689
  * @callback
1685
1690
  * @param event an AtkKeyEventStruct containing information about the key event for which notification is being given.
1686
- * @returns TRUE (nonzero) if the event emission should be stopped and the event discarded without being passed to the normal GUI recipient; FALSE (zero) if the event dispatch to the client application should proceed as normal. see atk_add_key_event_listener.
1691
+ * @returns TRUE (nonzero) if the event emission should be stopped and the event discarded without being passed to the normal GUI recipient; FALSE (zero) if the event dispatch to the client application should proceed as normal. see [id@atk_add_key_event_listener]
1687
1692
  */
1688
1693
  export interface KeySnoopFunc {
1689
1694
  (event: KeyEventStruct): number
@@ -1888,6 +1893,9 @@ export interface Action {
1888
1893
  }
1889
1894
 
1890
1895
  /**
1896
+ * The ATK interface provided by UI components
1897
+ * which the user can activate/interact with.
1898
+ *
1891
1899
  * #AtkAction should be implemented by instances of #AtkObject classes
1892
1900
  * with which the user can interact directly, i.e. buttons,
1893
1901
  * checkboxes, scrollbars, e.g. components which are not "passive"
@@ -2222,6 +2230,10 @@ export interface Component {
2222
2230
  }
2223
2231
 
2224
2232
  /**
2233
+ * The ATK interface provided by UI components
2234
+ * which occupy a physical area on the screen.
2235
+ * which the user can activate/interact with.
2236
+ *
2225
2237
  * #AtkComponent should be implemented by most if not all UI elements
2226
2238
  * with an actual on-screen presence, i.e. components which can be
2227
2239
  * said to have a screen-coordinate bounding box. Virtually all
@@ -2427,6 +2439,9 @@ export interface Document {
2427
2439
  }
2428
2440
 
2429
2441
  /**
2442
+ * The ATK interface which represents the toplevel
2443
+ * container for document content.
2444
+ *
2430
2445
  * The AtkDocument interface should be supported by any object whose
2431
2446
  * content is a representation or view of a document. The AtkDocument
2432
2447
  * interface should appear on the toplevel container for the document
@@ -2578,6 +2593,8 @@ export interface EditableText {
2578
2593
  }
2579
2594
 
2580
2595
  /**
2596
+ * The ATK interface implemented by components containing user-editable text content.
2597
+ *
2581
2598
  * #AtkEditableText should be implemented by UI components which
2582
2599
  * contain text which the user can edit, via the #AtkObject
2583
2600
  * corresponding to that component (see #AtkObject).
@@ -2586,7 +2603,7 @@ export interface EditableText {
2586
2603
  * which implements #AtkEditableText is by definition an #AtkText
2587
2604
  * implementor as well.
2588
2605
  *
2589
- * See also: #AtkText
2606
+ * See [iface`AtkText]`
2590
2607
  * @interface
2591
2608
  */
2592
2609
  export class EditableText extends GObject.Object {
@@ -2639,34 +2656,11 @@ export interface HyperlinkImpl {
2639
2656
  }
2640
2657
 
2641
2658
  /**
2642
- * AtkHyperlinkImpl allows AtkObjects to refer to their associated
2643
- * AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs
2644
- * from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas
2645
- * AtkHyperlink is a object type. The AtkHyperlinkImpl interface
2646
- * allows a client to query an AtkObject for the availability of an
2647
- * associated AtkHyperlink instance, and obtain that instance. It is
2648
- * thus particularly useful in cases where embedded content or inline
2649
- * content within a text object is present, since the embedding text
2650
- * object implements AtkHypertext and the inline/embedded objects are
2651
- * exposed as children which implement AtkHyperlinkImpl, in addition
2652
- * to their being obtainable via AtkHypertext:getLink followed by
2653
- * AtkHyperlink:getObject.
2654
- *
2655
- * The AtkHyperlinkImpl interface should be supported by objects
2656
- * exposed within the hierarchy as children of an AtkHypertext
2657
- * container which correspond to "links" or embedded content within
2658
- * the text. HTML anchors are not, for instance, normally exposed
2659
- * this way, but embedded images and components which appear inline in
2660
- * the content of a text object are. The AtkHyperlinkIface interface
2661
- * allows a means of determining which children are hyperlinks in this
2662
- * sense of the word, and for obtaining their corresponding
2663
- * AtkHyperlink object, from which the embedding range, URI, etc. can
2664
- * be obtained.
2665
- *
2666
- * To some extent this interface exists because, for historical
2667
- * reasons, AtkHyperlink was defined as an object type, not an
2668
- * interface. Thus, in order to interact with AtkObjects via
2669
- * AtkHyperlink semantics, a new interface was required.
2659
+ * A queryable interface which allows AtkHyperlink instances
2660
+ * associated with an AtkObject to be obtained. AtkHyperlinkImpl
2661
+ * corresponds to AT-SPI's Hyperlink interface, and differs from
2662
+ * AtkHyperlink in that AtkHyperlink is an object type, rather than an
2663
+ * interface, and thus cannot be directly queried. FTW
2670
2664
  * @interface
2671
2665
  */
2672
2666
  export class HyperlinkImpl extends GObject.Object {
@@ -2766,6 +2760,8 @@ export interface Hypertext {
2766
2760
  }
2767
2761
 
2768
2762
  /**
2763
+ * The ATK interface which provides standard mechanism for manipulating hyperlinks.
2764
+ *
2769
2765
  * An interface used for objects which implement linking between
2770
2766
  * multiple resource or content locations, or multiple 'markers'
2771
2767
  * within a single document. A Hypertext instance is associated with
@@ -2888,6 +2884,9 @@ export interface Image {
2888
2884
  }
2889
2885
 
2890
2886
  /**
2887
+ * The ATK Interface implemented by components
2888
+ * which expose image or pixmap content on-screen.
2889
+ *
2891
2890
  * #AtkImage should be implemented by #AtkObject subtypes on behalf of
2892
2891
  * components which display image/pixmap information onscreen, and
2893
2892
  * which provide information (other than just widget borders, etc.)
@@ -3114,6 +3113,8 @@ export interface Selection {
3114
3113
  }
3115
3114
 
3116
3115
  /**
3116
+ * The ATK interface implemented by container objects whose #AtkObject children can be selected.
3117
+ *
3117
3118
  * #AtkSelection should be implemented by UI components with children
3118
3119
  * which are exposed by #atk_object_ref_child and
3119
3120
  * #atk_object_get_n_children, if the use of the parent UI component
@@ -3231,6 +3232,8 @@ export interface StreamableContent {
3231
3232
  }
3232
3233
 
3233
3234
  /**
3235
+ * The ATK interface which provides access to streamable content.
3236
+ *
3234
3237
  * An interface whereby an object allows its backing content to be
3235
3238
  * streamed to clients. Typical implementors would be images or
3236
3239
  * icons, HTML content, or multimedia display/rendering widgets.
@@ -3764,6 +3767,8 @@ export interface Table {
3764
3767
  }
3765
3768
 
3766
3769
  /**
3770
+ * The ATK interface implemented for UI components which contain tabular or row/column information.
3771
+ *
3767
3772
  * #AtkTable should be implemented by components which present
3768
3773
  * elements ordered via rows and columns. It may also be used to
3769
3774
  * present tree-structured information if the nodes of the trees can
@@ -3960,11 +3965,13 @@ export interface TableCell extends Object {
3960
3965
  }
3961
3966
 
3962
3967
  /**
3968
+ * The ATK interface implemented for a cell inside a two-dimentional #AtkTable
3969
+ *
3963
3970
  * Being #AtkTable a component which present elements ordered via rows
3964
3971
  * and columns, an #AtkTableCell is the interface which each of those
3965
3972
  * elements, so "cells" should implement.
3966
3973
  *
3967
- * See also #AtkTable.
3974
+ * See [iface`AtkTable]`
3968
3975
  * @interface
3969
3976
  */
3970
3977
  export class TableCell extends GObject.Object {
@@ -4568,6 +4575,8 @@ export interface Text {
4568
4575
  }
4569
4576
 
4570
4577
  /**
4578
+ * The ATK interface implemented by components with text content.
4579
+ *
4571
4580
  * #AtkText should be implemented by #AtkObjects on behalf of widgets
4572
4581
  * that have text content which is either attributed or otherwise
4573
4582
  * non-trivial. #AtkObjects whose text content is simple,
@@ -4795,6 +4804,8 @@ export interface Value {
4795
4804
  }
4796
4805
 
4797
4806
  /**
4807
+ * The ATK interface implemented by valuators and components which display or select a value from a bounded range of values.
4808
+ *
4798
4809
  * #AtkValue should be implemented for components which either display
4799
4810
  * a value from a bounded range, or which allow the user to specify a
4800
4811
  * value from a bounded range, or both. For instance, most sliders and
@@ -5108,9 +5119,13 @@ export interface Window extends Object {
5108
5119
  }
5109
5120
 
5110
5121
  /**
5122
+ * The ATK Interface provided by UI components that represent a top-level window.
5123
+ *
5111
5124
  * #AtkWindow should be implemented by the UI elements that represent
5112
5125
  * a top-level window, such as the main window of an application or
5113
5126
  * dialog.
5127
+ *
5128
+ * See [class`AtkObject]`
5114
5129
  * @interface
5115
5130
  */
5116
5131
  export class Window extends GObject.Object {
@@ -5200,6 +5215,8 @@ export interface GObjectAccessible {
5200
5215
  }
5201
5216
 
5202
5217
  /**
5218
+ * This object class is derived from AtkObject and can be used as a basis implementing accessible objects.
5219
+ *
5203
5220
  * This object class is derived from AtkObject. It can be used as a
5204
5221
  * basis for implementing accessible objects for GObjects which are
5205
5222
  * not derived from GtkWidget. One example of its use is in providing
@@ -5404,6 +5421,8 @@ export interface Hyperlink extends Action {
5404
5421
  }
5405
5422
 
5406
5423
  /**
5424
+ * An ATK object which encapsulates a link or set of links in a hypertext document.
5425
+ *
5407
5426
  * An ATK object which encapsulates a link or set of links (for
5408
5427
  * instance in the case of client-side image maps) in a hypertext
5409
5428
  * document. It may implement the AtkAction interface. AtkHyperlink
@@ -5495,6 +5514,8 @@ export interface Misc {
5495
5514
  }
5496
5515
 
5497
5516
  /**
5517
+ * A set of ATK utility functions for thread locking
5518
+ *
5498
5519
  * A set of utility functions for thread locking. This interface and
5499
5520
  * all his related methods are deprecated since 2.12.
5500
5521
  * @class
@@ -5752,6 +5773,8 @@ export interface NoOpObject extends Action, Component, Document, EditableText, H
5752
5773
  }
5753
5774
 
5754
5775
  /**
5776
+ * An AtkObject which purports to implement all ATK interfaces.
5777
+ *
5755
5778
  * An AtkNoOpObject is an AtkObject which purports to implement all
5756
5779
  * ATK interfaces. It is the type of AtkObject which is created if an
5757
5780
  * accessible object is requested for an object type for which no
@@ -5811,6 +5834,8 @@ export interface NoOpObjectFactory {
5811
5834
  }
5812
5835
 
5813
5836
  /**
5837
+ * The AtkObjectFactory which creates an AtkNoOpObject.
5838
+ *
5814
5839
  * The AtkObjectFactory which creates an AtkNoOpObject. An instance of
5815
5840
  * this is created by an AtkRegistry if no factory type has not been
5816
5841
  * specified to create an accessible object of a particular type.
@@ -5854,6 +5879,13 @@ export module Object {
5854
5879
  ($obj: Object, arg1: Object): void
5855
5880
  }
5856
5881
 
5882
+ /**
5883
+ * Signal callback interface for `announcement`
5884
+ */
5885
+ export interface AnnouncementSignalCallback {
5886
+ ($obj: Object, arg1: string | null): void
5887
+ }
5888
+
5857
5889
  /**
5858
5890
  * Signal callback interface for `children-changed`
5859
5891
  */
@@ -6289,6 +6321,9 @@ export interface Object {
6289
6321
  connect(sigName: "active-descendant-changed", callback: Object.ActiveDescendantChangedSignalCallback): number
6290
6322
  connect_after(sigName: "active-descendant-changed", callback: Object.ActiveDescendantChangedSignalCallback): number
6291
6323
  emit(sigName: "active-descendant-changed", arg1: Object, ...args: any[]): void
6324
+ connect(sigName: "announcement", callback: Object.AnnouncementSignalCallback): number
6325
+ connect_after(sigName: "announcement", callback: Object.AnnouncementSignalCallback): number
6326
+ emit(sigName: "announcement", arg1: string | null, ...args: any[]): void
6292
6327
  connect(sigName: "children-changed", callback: Object.ChildrenChangedSignalCallback): number
6293
6328
  connect_after(sigName: "children-changed", callback: Object.ChildrenChangedSignalCallback): number
6294
6329
  emit(sigName: "children-changed", arg1: number, arg2: Object, ...args: any[]): void
@@ -6356,6 +6391,8 @@ export interface Object {
6356
6391
  }
6357
6392
 
6358
6393
  /**
6394
+ * The base object class for the Accessibility Toolkit API.
6395
+ *
6359
6396
  * This class is the primary class for accessibility support via the
6360
6397
  * Accessibility ToolKit (ATK). Objects which are instances of
6361
6398
  * #AtkObject (or instances of AtkObject-derived types) are queried
@@ -6374,7 +6411,7 @@ export interface Object {
6374
6411
  * implementation is insufficient, via instances of a new #AtkObject
6375
6412
  * subclass.
6376
6413
  *
6377
- * See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also
6414
+ * See [class`AtkObjectFactory]`, [class`AtkRegistry]`. (GTK+ users see also
6378
6415
  * #GtkAccessible).
6379
6416
  * @interface
6380
6417
  */
@@ -6450,6 +6487,9 @@ export interface ObjectFactory {
6450
6487
  }
6451
6488
 
6452
6489
  /**
6490
+ * The base object class for a factory used to
6491
+ * create accessible objects for objects of a specific GType.
6492
+ *
6453
6493
  * This class is the base object class for a factory used to create an
6454
6494
  * accessible object for a specific GType. The function
6455
6495
  * atk_registry_set_factory_type() is normally called to store in the
@@ -6568,7 +6608,9 @@ export interface Plug extends Component {
6568
6608
  }
6569
6609
 
6570
6610
  /**
6571
- * See #AtkSocket
6611
+ * Toplevel for embedding into other processes
6612
+ *
6613
+ * See [class`AtkSocket]`
6572
6614
  * @class
6573
6615
  */
6574
6616
  export class Plug extends Object {
@@ -6648,6 +6690,10 @@ export interface Registry {
6648
6690
  }
6649
6691
 
6650
6692
  /**
6693
+ * An object used to store the GType of the
6694
+ * factories used to create an accessible object for an object of a
6695
+ * particular GType.
6696
+ *
6651
6697
  * The AtkRegistry is normally used to create appropriate ATK "peers"
6652
6698
  * for user interface components. Application developers usually need
6653
6699
  * only interact with the AtkRegistry by associating appropriate ATK
@@ -6732,6 +6778,9 @@ export interface Relation {
6732
6778
  }
6733
6779
 
6734
6780
  /**
6781
+ * An object used to describe a relation between a
6782
+ * object and one or more other objects.
6783
+ *
6735
6784
  * An AtkRelation describes a relation between an object and one or
6736
6785
  * more other objects. The actual relations that an object has with
6737
6786
  * other objects are defined as an AtkRelationSet, which is a set of
@@ -6855,6 +6904,9 @@ export interface RelationSet {
6855
6904
  }
6856
6905
 
6857
6906
  /**
6907
+ * A set of AtkRelations, normally the set of
6908
+ * AtkRelations which an AtkObject has.
6909
+ *
6858
6910
  * The AtkRelationSet held by an object establishes its relationships
6859
6911
  * with objects beyond the normal "parent/child" hierarchical
6860
6912
  * relationships that all user interface objects have.
@@ -6996,6 +7048,8 @@ export interface Socket extends Component {
6996
7048
  }
6997
7049
 
6998
7050
  /**
7051
+ * Container for AtkPlug objects from other processes
7052
+ *
6999
7053
  * Together with #AtkPlug, #AtkSocket provides the ability to embed
7000
7054
  * accessibles from one process into another in a fashion that is
7001
7055
  * transparent to assistive technologies. #AtkSocket works as the
@@ -7018,6 +7072,8 @@ export interface Socket extends Component {
7018
7072
  * atk_object_get_n_accessible_children() and
7019
7073
  * atk_object_ref_accessible_child(). All the logic related to those
7020
7074
  * functions will be implemented by the IPC layer.
7075
+ *
7076
+ * See [class`AtkPlug]`
7021
7077
  * @class
7022
7078
  */
7023
7079
  export class Socket extends Object {
@@ -7148,6 +7204,8 @@ export interface StateSet {
7148
7204
  }
7149
7205
 
7150
7206
  /**
7207
+ * An AtkStateSet contains the states of an object.
7208
+ *
7151
7209
  * An AtkStateSet is a read-only representation of the full set of #AtkStates
7152
7210
  * that apply to an object at a given time. This set is not meant to be
7153
7211
  * modified, but rather created when #atk_object_ref_state_set() is called.
@@ -7202,6 +7260,8 @@ export interface Util {
7202
7260
  }
7203
7261
 
7204
7262
  /**
7263
+ * A set of ATK utility functions for event and toolkit support.
7264
+ *
7205
7265
  * A set of ATK utility functions which are used to support event
7206
7266
  * registration of various types, and obtaining the 'root' accessible
7207
7267
  * of a process and information about the current ATK implementation
@@ -7732,6 +7792,8 @@ export interface Range {
7732
7792
  }
7733
7793
 
7734
7794
  /**
7795
+ * A given range or subrange, to be used with #AtkValue
7796
+ *
7735
7797
  * #AtkRange are used on #AtkValue, in order to represent the full
7736
7798
  * range of a given component (for example an slider or a range
7737
7799
  * control), or to define each individual subrange this full range is
package/atk-1.0.d.ts CHANGED
@@ -807,6 +807,11 @@ enum Role {
807
807
  * actual change is. (Since: 2.36)
808
808
  */
809
809
  SUGGESTION,
810
+ /**
811
+ * A specialized push button to open a menu.
812
+ * (Since: 2.46)
813
+ */
814
+ PUSH_BUTTON_MENU,
810
815
  /**
811
816
  * not a valid role, used for finding end of the enumeration
812
817
  */
@@ -1640,7 +1645,7 @@ function value_type_get_name(value_type: ValueType): string | null
1640
1645
  * supported are events of type "focus:". Most clients of ATK will prefer to
1641
1646
  * attach signal handlers for the various ATK signals instead.
1642
1647
  *
1643
- * see atk_add_focus_tracker.
1648
+ * see [id`atk_add_focus_tracker]`
1644
1649
  * @callback
1645
1650
  * @param obj An #AtkObject instance for whom the callback will be called when the specified event (e.g. 'focus:') takes place.
1646
1651
  */
@@ -1652,7 +1657,7 @@ interface EventListener {
1652
1657
  * called in order to initialize the per-object event registration system
1653
1658
  * used by #AtkEventListener, if any preparation is required.
1654
1659
  *
1655
- * see atk_focus_tracker_init.
1660
+ * see [id`atk_focus_tracker_init]`
1656
1661
  * @callback
1657
1662
  */
1658
1663
  interface EventListenerInit {
@@ -1685,7 +1690,7 @@ interface Function {
1685
1690
  * interception of key events via the return code as described below.
1686
1691
  * @callback
1687
1692
  * @param event an AtkKeyEventStruct containing information about the key event for which notification is being given.
1688
- * @returns TRUE (nonzero) if the event emission should be stopped and the event discarded without being passed to the normal GUI recipient; FALSE (zero) if the event dispatch to the client application should proceed as normal. see atk_add_key_event_listener.
1693
+ * @returns TRUE (nonzero) if the event emission should be stopped and the event discarded without being passed to the normal GUI recipient; FALSE (zero) if the event dispatch to the client application should proceed as normal. see [id@atk_add_key_event_listener]
1689
1694
  */
1690
1695
  interface KeySnoopFunc {
1691
1696
  (event: KeyEventStruct): number
@@ -1890,6 +1895,9 @@ interface Action {
1890
1895
  }
1891
1896
 
1892
1897
  /**
1898
+ * The ATK interface provided by UI components
1899
+ * which the user can activate/interact with.
1900
+ *
1893
1901
  * #AtkAction should be implemented by instances of #AtkObject classes
1894
1902
  * with which the user can interact directly, i.e. buttons,
1895
1903
  * checkboxes, scrollbars, e.g. components which are not "passive"
@@ -2224,6 +2232,10 @@ interface Component {
2224
2232
  }
2225
2233
 
2226
2234
  /**
2235
+ * The ATK interface provided by UI components
2236
+ * which occupy a physical area on the screen.
2237
+ * which the user can activate/interact with.
2238
+ *
2227
2239
  * #AtkComponent should be implemented by most if not all UI elements
2228
2240
  * with an actual on-screen presence, i.e. components which can be
2229
2241
  * said to have a screen-coordinate bounding box. Virtually all
@@ -2429,6 +2441,9 @@ interface Document {
2429
2441
  }
2430
2442
 
2431
2443
  /**
2444
+ * The ATK interface which represents the toplevel
2445
+ * container for document content.
2446
+ *
2432
2447
  * The AtkDocument interface should be supported by any object whose
2433
2448
  * content is a representation or view of a document. The AtkDocument
2434
2449
  * interface should appear on the toplevel container for the document
@@ -2580,6 +2595,8 @@ interface EditableText {
2580
2595
  }
2581
2596
 
2582
2597
  /**
2598
+ * The ATK interface implemented by components containing user-editable text content.
2599
+ *
2583
2600
  * #AtkEditableText should be implemented by UI components which
2584
2601
  * contain text which the user can edit, via the #AtkObject
2585
2602
  * corresponding to that component (see #AtkObject).
@@ -2588,7 +2605,7 @@ interface EditableText {
2588
2605
  * which implements #AtkEditableText is by definition an #AtkText
2589
2606
  * implementor as well.
2590
2607
  *
2591
- * See also: #AtkText
2608
+ * See [iface`AtkText]`
2592
2609
  * @interface
2593
2610
  */
2594
2611
  class EditableText extends GObject.Object {
@@ -2641,34 +2658,11 @@ interface HyperlinkImpl {
2641
2658
  }
2642
2659
 
2643
2660
  /**
2644
- * AtkHyperlinkImpl allows AtkObjects to refer to their associated
2645
- * AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs
2646
- * from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas
2647
- * AtkHyperlink is a object type. The AtkHyperlinkImpl interface
2648
- * allows a client to query an AtkObject for the availability of an
2649
- * associated AtkHyperlink instance, and obtain that instance. It is
2650
- * thus particularly useful in cases where embedded content or inline
2651
- * content within a text object is present, since the embedding text
2652
- * object implements AtkHypertext and the inline/embedded objects are
2653
- * exposed as children which implement AtkHyperlinkImpl, in addition
2654
- * to their being obtainable via AtkHypertext:getLink followed by
2655
- * AtkHyperlink:getObject.
2656
- *
2657
- * The AtkHyperlinkImpl interface should be supported by objects
2658
- * exposed within the hierarchy as children of an AtkHypertext
2659
- * container which correspond to "links" or embedded content within
2660
- * the text. HTML anchors are not, for instance, normally exposed
2661
- * this way, but embedded images and components which appear inline in
2662
- * the content of a text object are. The AtkHyperlinkIface interface
2663
- * allows a means of determining which children are hyperlinks in this
2664
- * sense of the word, and for obtaining their corresponding
2665
- * AtkHyperlink object, from which the embedding range, URI, etc. can
2666
- * be obtained.
2667
- *
2668
- * To some extent this interface exists because, for historical
2669
- * reasons, AtkHyperlink was defined as an object type, not an
2670
- * interface. Thus, in order to interact with AtkObjects via
2671
- * AtkHyperlink semantics, a new interface was required.
2661
+ * A queryable interface which allows AtkHyperlink instances
2662
+ * associated with an AtkObject to be obtained. AtkHyperlinkImpl
2663
+ * corresponds to AT-SPI's Hyperlink interface, and differs from
2664
+ * AtkHyperlink in that AtkHyperlink is an object type, rather than an
2665
+ * interface, and thus cannot be directly queried. FTW
2672
2666
  * @interface
2673
2667
  */
2674
2668
  class HyperlinkImpl extends GObject.Object {
@@ -2768,6 +2762,8 @@ interface Hypertext {
2768
2762
  }
2769
2763
 
2770
2764
  /**
2765
+ * The ATK interface which provides standard mechanism for manipulating hyperlinks.
2766
+ *
2771
2767
  * An interface used for objects which implement linking between
2772
2768
  * multiple resource or content locations, or multiple 'markers'
2773
2769
  * within a single document. A Hypertext instance is associated with
@@ -2890,6 +2886,9 @@ interface Image {
2890
2886
  }
2891
2887
 
2892
2888
  /**
2889
+ * The ATK Interface implemented by components
2890
+ * which expose image or pixmap content on-screen.
2891
+ *
2893
2892
  * #AtkImage should be implemented by #AtkObject subtypes on behalf of
2894
2893
  * components which display image/pixmap information onscreen, and
2895
2894
  * which provide information (other than just widget borders, etc.)
@@ -3116,6 +3115,8 @@ interface Selection {
3116
3115
  }
3117
3116
 
3118
3117
  /**
3118
+ * The ATK interface implemented by container objects whose #AtkObject children can be selected.
3119
+ *
3119
3120
  * #AtkSelection should be implemented by UI components with children
3120
3121
  * which are exposed by #atk_object_ref_child and
3121
3122
  * #atk_object_get_n_children, if the use of the parent UI component
@@ -3233,6 +3234,8 @@ interface StreamableContent {
3233
3234
  }
3234
3235
 
3235
3236
  /**
3237
+ * The ATK interface which provides access to streamable content.
3238
+ *
3236
3239
  * An interface whereby an object allows its backing content to be
3237
3240
  * streamed to clients. Typical implementors would be images or
3238
3241
  * icons, HTML content, or multimedia display/rendering widgets.
@@ -3766,6 +3769,8 @@ interface Table {
3766
3769
  }
3767
3770
 
3768
3771
  /**
3772
+ * The ATK interface implemented for UI components which contain tabular or row/column information.
3773
+ *
3769
3774
  * #AtkTable should be implemented by components which present
3770
3775
  * elements ordered via rows and columns. It may also be used to
3771
3776
  * present tree-structured information if the nodes of the trees can
@@ -3962,11 +3967,13 @@ interface TableCell extends Object {
3962
3967
  }
3963
3968
 
3964
3969
  /**
3970
+ * The ATK interface implemented for a cell inside a two-dimentional #AtkTable
3971
+ *
3965
3972
  * Being #AtkTable a component which present elements ordered via rows
3966
3973
  * and columns, an #AtkTableCell is the interface which each of those
3967
3974
  * elements, so "cells" should implement.
3968
3975
  *
3969
- * See also #AtkTable.
3976
+ * See [iface`AtkTable]`
3970
3977
  * @interface
3971
3978
  */
3972
3979
  class TableCell extends GObject.Object {
@@ -4570,6 +4577,8 @@ interface Text {
4570
4577
  }
4571
4578
 
4572
4579
  /**
4580
+ * The ATK interface implemented by components with text content.
4581
+ *
4573
4582
  * #AtkText should be implemented by #AtkObjects on behalf of widgets
4574
4583
  * that have text content which is either attributed or otherwise
4575
4584
  * non-trivial. #AtkObjects whose text content is simple,
@@ -4797,6 +4806,8 @@ interface Value {
4797
4806
  }
4798
4807
 
4799
4808
  /**
4809
+ * The ATK interface implemented by valuators and components which display or select a value from a bounded range of values.
4810
+ *
4800
4811
  * #AtkValue should be implemented for components which either display
4801
4812
  * a value from a bounded range, or which allow the user to specify a
4802
4813
  * value from a bounded range, or both. For instance, most sliders and
@@ -5110,9 +5121,13 @@ interface Window extends Object {
5110
5121
  }
5111
5122
 
5112
5123
  /**
5124
+ * The ATK Interface provided by UI components that represent a top-level window.
5125
+ *
5113
5126
  * #AtkWindow should be implemented by the UI elements that represent
5114
5127
  * a top-level window, such as the main window of an application or
5115
5128
  * dialog.
5129
+ *
5130
+ * See [class`AtkObject]`
5116
5131
  * @interface
5117
5132
  */
5118
5133
  class Window extends GObject.Object {
@@ -5202,6 +5217,8 @@ interface GObjectAccessible {
5202
5217
  }
5203
5218
 
5204
5219
  /**
5220
+ * This object class is derived from AtkObject and can be used as a basis implementing accessible objects.
5221
+ *
5205
5222
  * This object class is derived from AtkObject. It can be used as a
5206
5223
  * basis for implementing accessible objects for GObjects which are
5207
5224
  * not derived from GtkWidget. One example of its use is in providing
@@ -5406,6 +5423,8 @@ interface Hyperlink extends Action {
5406
5423
  }
5407
5424
 
5408
5425
  /**
5426
+ * An ATK object which encapsulates a link or set of links in a hypertext document.
5427
+ *
5409
5428
  * An ATK object which encapsulates a link or set of links (for
5410
5429
  * instance in the case of client-side image maps) in a hypertext
5411
5430
  * document. It may implement the AtkAction interface. AtkHyperlink
@@ -5497,6 +5516,8 @@ interface Misc {
5497
5516
  }
5498
5517
 
5499
5518
  /**
5519
+ * A set of ATK utility functions for thread locking
5520
+ *
5500
5521
  * A set of utility functions for thread locking. This interface and
5501
5522
  * all his related methods are deprecated since 2.12.
5502
5523
  * @class
@@ -5754,6 +5775,8 @@ interface NoOpObject extends Action, Component, Document, EditableText, Hypertex
5754
5775
  }
5755
5776
 
5756
5777
  /**
5778
+ * An AtkObject which purports to implement all ATK interfaces.
5779
+ *
5757
5780
  * An AtkNoOpObject is an AtkObject which purports to implement all
5758
5781
  * ATK interfaces. It is the type of AtkObject which is created if an
5759
5782
  * accessible object is requested for an object type for which no
@@ -5813,6 +5836,8 @@ interface NoOpObjectFactory {
5813
5836
  }
5814
5837
 
5815
5838
  /**
5839
+ * The AtkObjectFactory which creates an AtkNoOpObject.
5840
+ *
5816
5841
  * The AtkObjectFactory which creates an AtkNoOpObject. An instance of
5817
5842
  * this is created by an AtkRegistry if no factory type has not been
5818
5843
  * specified to create an accessible object of a particular type.
@@ -5856,6 +5881,13 @@ module Object {
5856
5881
  ($obj: Object, arg1: Object): void
5857
5882
  }
5858
5883
 
5884
+ /**
5885
+ * Signal callback interface for `announcement`
5886
+ */
5887
+ interface AnnouncementSignalCallback {
5888
+ ($obj: Object, arg1: string | null): void
5889
+ }
5890
+
5859
5891
  /**
5860
5892
  * Signal callback interface for `children-changed`
5861
5893
  */
@@ -6291,6 +6323,9 @@ interface Object {
6291
6323
  connect(sigName: "active-descendant-changed", callback: Object.ActiveDescendantChangedSignalCallback): number
6292
6324
  connect_after(sigName: "active-descendant-changed", callback: Object.ActiveDescendantChangedSignalCallback): number
6293
6325
  emit(sigName: "active-descendant-changed", arg1: Object, ...args: any[]): void
6326
+ connect(sigName: "announcement", callback: Object.AnnouncementSignalCallback): number
6327
+ connect_after(sigName: "announcement", callback: Object.AnnouncementSignalCallback): number
6328
+ emit(sigName: "announcement", arg1: string | null, ...args: any[]): void
6294
6329
  connect(sigName: "children-changed", callback: Object.ChildrenChangedSignalCallback): number
6295
6330
  connect_after(sigName: "children-changed", callback: Object.ChildrenChangedSignalCallback): number
6296
6331
  emit(sigName: "children-changed", arg1: number, arg2: Object, ...args: any[]): void
@@ -6358,6 +6393,8 @@ interface Object {
6358
6393
  }
6359
6394
 
6360
6395
  /**
6396
+ * The base object class for the Accessibility Toolkit API.
6397
+ *
6361
6398
  * This class is the primary class for accessibility support via the
6362
6399
  * Accessibility ToolKit (ATK). Objects which are instances of
6363
6400
  * #AtkObject (or instances of AtkObject-derived types) are queried
@@ -6376,7 +6413,7 @@ interface Object {
6376
6413
  * implementation is insufficient, via instances of a new #AtkObject
6377
6414
  * subclass.
6378
6415
  *
6379
- * See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also
6416
+ * See [class`AtkObjectFactory]`, [class`AtkRegistry]`. (GTK+ users see also
6380
6417
  * #GtkAccessible).
6381
6418
  * @interface
6382
6419
  */
@@ -6452,6 +6489,9 @@ interface ObjectFactory {
6452
6489
  }
6453
6490
 
6454
6491
  /**
6492
+ * The base object class for a factory used to
6493
+ * create accessible objects for objects of a specific GType.
6494
+ *
6455
6495
  * This class is the base object class for a factory used to create an
6456
6496
  * accessible object for a specific GType. The function
6457
6497
  * atk_registry_set_factory_type() is normally called to store in the
@@ -6570,7 +6610,9 @@ interface Plug extends Component {
6570
6610
  }
6571
6611
 
6572
6612
  /**
6573
- * See #AtkSocket
6613
+ * Toplevel for embedding into other processes
6614
+ *
6615
+ * See [class`AtkSocket]`
6574
6616
  * @class
6575
6617
  */
6576
6618
  class Plug extends Object {
@@ -6650,6 +6692,10 @@ interface Registry {
6650
6692
  }
6651
6693
 
6652
6694
  /**
6695
+ * An object used to store the GType of the
6696
+ * factories used to create an accessible object for an object of a
6697
+ * particular GType.
6698
+ *
6653
6699
  * The AtkRegistry is normally used to create appropriate ATK "peers"
6654
6700
  * for user interface components. Application developers usually need
6655
6701
  * only interact with the AtkRegistry by associating appropriate ATK
@@ -6734,6 +6780,9 @@ interface Relation {
6734
6780
  }
6735
6781
 
6736
6782
  /**
6783
+ * An object used to describe a relation between a
6784
+ * object and one or more other objects.
6785
+ *
6737
6786
  * An AtkRelation describes a relation between an object and one or
6738
6787
  * more other objects. The actual relations that an object has with
6739
6788
  * other objects are defined as an AtkRelationSet, which is a set of
@@ -6857,6 +6906,9 @@ interface RelationSet {
6857
6906
  }
6858
6907
 
6859
6908
  /**
6909
+ * A set of AtkRelations, normally the set of
6910
+ * AtkRelations which an AtkObject has.
6911
+ *
6860
6912
  * The AtkRelationSet held by an object establishes its relationships
6861
6913
  * with objects beyond the normal "parent/child" hierarchical
6862
6914
  * relationships that all user interface objects have.
@@ -6998,6 +7050,8 @@ interface Socket extends Component {
6998
7050
  }
6999
7051
 
7000
7052
  /**
7053
+ * Container for AtkPlug objects from other processes
7054
+ *
7001
7055
  * Together with #AtkPlug, #AtkSocket provides the ability to embed
7002
7056
  * accessibles from one process into another in a fashion that is
7003
7057
  * transparent to assistive technologies. #AtkSocket works as the
@@ -7020,6 +7074,8 @@ interface Socket extends Component {
7020
7074
  * atk_object_get_n_accessible_children() and
7021
7075
  * atk_object_ref_accessible_child(). All the logic related to those
7022
7076
  * functions will be implemented by the IPC layer.
7077
+ *
7078
+ * See [class`AtkPlug]`
7023
7079
  * @class
7024
7080
  */
7025
7081
  class Socket extends Object {
@@ -7150,6 +7206,8 @@ interface StateSet {
7150
7206
  }
7151
7207
 
7152
7208
  /**
7209
+ * An AtkStateSet contains the states of an object.
7210
+ *
7153
7211
  * An AtkStateSet is a read-only representation of the full set of #AtkStates
7154
7212
  * that apply to an object at a given time. This set is not meant to be
7155
7213
  * modified, but rather created when #atk_object_ref_state_set() is called.
@@ -7204,6 +7262,8 @@ interface Util {
7204
7262
  }
7205
7263
 
7206
7264
  /**
7265
+ * A set of ATK utility functions for event and toolkit support.
7266
+ *
7207
7267
  * A set of ATK utility functions which are used to support event
7208
7268
  * registration of various types, and obtaining the 'root' accessible
7209
7269
  * of a process and information about the current ATK implementation
@@ -7734,6 +7794,8 @@ interface Range {
7734
7794
  }
7735
7795
 
7736
7796
  /**
7797
+ * A given range or subrange, to be used with #AtkValue
7798
+ *
7737
7799
  * #AtkRange are used on #AtkValue, in order to represent the full
7738
7800
  * range of a given component (for example an slider or a range
7739
7801
  * control), or to define each individual subrange this full range is
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@girs/atk-1.0",
3
- "version": "2.45.1-3.0.0",
4
- "description": "GJS TypeScript type definitions for Atk-1.0, generated from library version 2.45.1",
3
+ "version": "2.48.2-3.0.3",
4
+ "description": "GJS TypeScript type definitions for Atk-1.0, generated from library version 2.48.2",
5
5
  "type": "module",
6
6
  "module": "atk-1.0.js",
7
7
  "main": "atk-1.0.js",
@@ -31,12 +31,12 @@
31
31
  "test:cjs": "tsc --noEmit atk-1.0.d.cts"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^3.0.0",
35
- "@girs/gobject-2.0": "^2.76.1-3.0.0",
36
- "@girs/glib-2.0": "^2.76.1-3.0.0"
34
+ "@girs/gjs": "^3.0.3",
35
+ "@girs/glib-2.0": "^2.76.1-3.0.3",
36
+ "@girs/gobject-2.0": "^2.76.1-3.0.3"
37
37
  },
38
38
  "devDependencies": {
39
- "typescript": "^5.0.4"
39
+ "typescript": "*"
40
40
  },
41
41
  "keywords": [
42
42
  "Gir",