The Accessibility toolkit
| Version | 2.52 |
| Authors | GTK Development Team |
| License | LGPL-2.1-or-later |
| Website | https://www.gtk.org |
| Source | https://gitlab.gnome.org/GNOME/at-spi2-core/ |
| C headers | atk/atk.h |
| pkg-config files | atk |
| GObject—2.0 | The base type system library |
| Browse documentation |
| AT-SPI | The Assistive Technology Service Provider Interface |
| Browse documentation |
| GObjectAccessible | This object class is derived from AtkObject and can be used as a basis implementing accessible objects. |
| Hyperlink | AnATK object which encapsulates a link or set of links in a hypertext document. |
| Misc | A set ofATK utility functions for thread locking. |
| NoOpObject | An AtkObject which purports to implement allATK interfaces. |
| NoOpObjectFactory | The AtkObjectFactory which creates an AtkNoOpObject. |
| Object | The base object class for the Accessibility ToolkitAPI. |
| ObjectFactory | The base object class for a factory used to create accessible objects for objects of a specific GType. |
| Plug | Toplevel for embedding into other processes. |
| Registry | An object used to store the GType of thefactories used to create an accessible object for an object of aparticular GType. |
| Relation | An object used to describe a relation between a object and one or more other objects. |
| RelationSet | A set of AtkRelations, normally the set of AtkRelations which an AtkObject has. |
| Socket | Container for AtkPlug objects from other processes. |
| StateSet | An AtkStateSet contains the states of an object. |
| Util | A set ofATK utility functions for event and toolkit support. |
| Action | TheATK interface provided byUI componentswhich the user can activate/interact with. |
| Component | TheATK interface provided byUI componentswhich occupy a physical area on the screen.which the user can activate/interact with. |
| Document | TheATK interface which represents the toplevel container for document content. |
| EditableText | TheATK interface implemented by components containing user-editable text content. |
| HyperlinkImpl | A queryable interface which allows AtkHyperlink instancesassociated with an AtkObject to be obtained. AtkHyperlinkImplcorresponds toAT-SPI’s Hyperlink interface, and differs fromAtkHyperlink in that AtkHyperlink is an object type, rather than aninterface, and thus cannot be directly queried.FTW. |
| Hypertext | TheATK interface which provides standard mechanism for manipulating hyperlinks. |
| Image | TheATK Interface implemented by components which expose image or pixmap content on-screen. |
| ImplementorIface | The AtkImplementor interface is implemented by objects for whichAtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor);. |
| Selection | TheATK interface implemented by container objects whose |
| StreamableContent | TheATK interface which provides access to streamable content. |
| Table | TheATK interface implemented forUI components which contain tabular or row/column information. |
| TableCell | TheATK interface implemented for a cell inside a two-dimentional |
| Text | TheATK interface implemented by components with text content. |
| Value | TheATK interface implemented by valuators and components which display or select a value from a bounded range of values. |
| Window | TheATK Interface provided byUI components that represent a top-level window. |
| Attribute | AtkAttribute is a string name/value pair representing a genericattribute. This can be used to expose additional information froman accessible object as a whole (see atk_object_get_attributes())or an document (see atk_document_get_attributes()). In the case oftext attributes (see atk_text_get_default_attributes()), |
| Implementor | |
| KeyEventStruct | Encapsulates information about a key event. |
| PropertyValues | valid value. This is a field defined with the purpose of containthe previous value of the property, but is not used anymore. |
| Range | A given range or subrange, to be used with |
| Rectangle | A data structure for holding a rectangle. Those coordinates arerelative to the component top-level parent. |
| TextRange | A structure used to describe a text range. |
| TextRectangle | A structure used to store a rectangle used by AtkText. |
| TextSelection | This structure represents a single text selection within a document. Thisselection is defined by two points in the content, where each one is definedby an AtkObject supporting the AtkText interface and a character offsetrelative to it. since: 2.52 |
| AttributeSet | This is a singly-linked list (a |
| State | An AtkState describes a single state of an object. |
| CoordType | Specifies how xy coordinates are to be interpreted. Used by functions suchas |
| KeyEventType | Specifies the type of a keyboard evemt. |
| Layer | Describes the layer of a component. |
| Live | Enumeration used to indicate a type of live region and how assertive itshould be in terms of speaking notifications. Currently, this is only usedfor “notification” events, but it may be used for additional purposesin the future. since: 2.50 |
| RelationType | Describes the type of the relation. |
| Role | Describes the role of an object. |
| ScrollType | Specifies where an object should be placed on the screen when using scroll_to. since: 2.30 |
| StateType | The possible types of states of an object. |
| TextAttribute | Describes the text attributes supported. |
| TextBoundary | Text boundary types used for specifying boundaries for regions of text.This enumeration is deprecated since 2.9.4 and should not be used. UseAtkTextGranularity with #atk_text_get_string_at_offset instead. |
| TextClipType | Describes the type of clipping required. |
| TextGranularity | Text granularity types used for specifying the granularity of the region oftext we are interested in. |
| ValueType | Default types for a given value. Those are defined in order toeasily get localized strings to describe a given value or a givensubrange, using atk_value_type_get_localized_name(). |
| HyperlinkStateFlags | Describes the type of link. |
| EventListener | A function which is called when an object emits a matching event,as used in #atk_add_focus_tracker.Currently the only events for which object-specific handlers aresupported are events of type “focus:”. Most clients ofATK will prefer toattach signal handlers for the variousATK signals instead. |
| EventListenerInit | An |
| FocusHandler | The type of callback function used for deprecated: 2.9.4 |
| Function | An AtkFunction is a function definition used for padding which hasbeen added to class and interface structures to allow for expansionin the future. |
| KeySnoopFunc | An |
| PropertyChangeHandler | An AtkPropertyChangeHandler is a function which is executed when anAtkObject’s property changes value. It is specified in a call to atk_object_connect_property_change_handler(). deprecated: Unknown |
| add_focus_tracker | Adds the specified function to the list of functions to be calledwhen an object receives focus. deprecated: 2.9.4 |
| add_global_event_listener | Adds the specified function to the list of functions to be calledwhen anATK event of type event_type occurs. |
| add_key_event_listener | Adds the specified function to the list of functions to be called when a key event occurs. The |
| focus_tracker_init | Specifies the function to be called for focus tracker initialization.This function should be called by an implementation of theATK interface if any specific work needs to be done to enablefocus tracking. deprecated: 2.9.4 |
| focus_tracker_notify | Cause the focus tracker functions which have been specified to beexecuted for the object. deprecated: 2.9.4 |
| get_binary_age | Returns the binary age as passed to libtool when building theATKlibrary the process is running against. since: 2.8 |
| get_default_registry | Gets a default implementation of the |
| get_focus_object | Gets the currently focused object. since: 1.6 |
| get_interface_age | Returns the interface age as passed to libtool when building theATK library the process is running against. since: 2.8 |
| get_major_version | Returns the major version number of theATK library. (e.g. inATKversion 2.7.4 this is 2.). since: 2.8 |
| get_micro_version | Returns the micro version number of theATK library. (e.g. inATKversion 2.7.4 this is 4.). since: 2.8 |
| get_minor_version | Returns the minor version number of theATK library. (e.g. inATKversion 2.7.4 this is 7.). since: 2.8 |
| get_root | Gets the root accessible container for the current application. |
| get_toolkit_name | Gets name string for theGUI toolkit implementingATK for this application. |
| get_toolkit_version | Gets version string for theGUI toolkit implementingATK for this application. |
| get_version | Gets the current version forATK. since: 1.20 |
| remove_focus_tracker | Removes the specified focus tracker from the list of functionsto be called when any object receives focus. deprecated: 2.9.4 |
| remove_global_event_listener |
|
| remove_key_event_listener |
|
| CHECK_VERSION | Returns since: 2.7.4 |
| DEFINE_ABSTRACT_TYPE | A convenience macro forATK type implementations.Similar to ATK_DEFINE_TYPE(), but defines an abstract type. since: 1.22 |
| DEFINE_ABSTRACT_TYPE_WITH_CODE | A convenience macro forATK type implementations.Similar to ATK_DEFINE_TYPE_WITH_CODE(), but defines an abstract type. since: 1.22 |
| DEFINE_TYPE | A convenience macro for typeATK implementations, which declares a classinitialization function, an instance initialization function (see since: 1.22 |
| DEFINE_TYPE_EXTENDED | The most general convenience macro forATK type implementations, on whichATK_DEFINE_TYPE(), etc are based. since: 1.22 |
| DEFINE_TYPE_WITH_CODE | A convenience macro forATK type implementations.Similar to ATK_DEFINE_TYPE(), but allows you to insert custom code into the_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). since: 1.22 |
| DEPRECATED_FOR | |
| GOBJECT_ACCESSIBLE | |
| GOBJECT_ACCESSIBLE_CLASS | |
| NO_OP_OBJECT | |
| NO_OP_OBJECT_CLASS | |
| NO_OP_OBJECT_FACTORY | |
| NO_OP_OBJECT_FACTORY_CLASS | |
| UNAVAILABLE |
| BINARY_AGE | Like atk_get_binary_age(), but from the headers used atapplication compile time, rather than from the library linkedagainst at application run time. |
| INTERFACE_AGE | Like atk_get_interface_age(), but from the headers used atapplication compile time, rather than from the library linkedagainst at application run time. |
| MAJOR_VERSION | Like atk_get_major_version(), but from the headers used atapplication compile time, rather than from the library linkedagainst at application run time. |
| MICRO_VERSION | Like atk_get_micro_version(), but from the headers used atapplication compile time, rather than from the library linkedagainst at application run time. |
| MINOR_VERSION | Like atk_get_minor_version(), but from the headers used atapplication compile time, rather than from the library linkedagainst at application run time. |
| VERSION_MIN_REQUIRED | A macro that should be defined by the user prior to includingthe atk/atk.h header.The definition should be one of the predefinedATK versionmacros: |