Namespace
Atk – 1.0
The Accessibility toolkit
Dependencies
GObject—2.0 | The base type system library |
Browse documentation |
Related libraries
AT-SPI | The Assistive Technology Service Provider Interface |
Browse documentation |
Classes
GObjectAccessible |
This object class is derived from AtkObject. It can be used as a basis for implementing accessible objects for GObjects which are not derived from GtkWidget. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library. since: 1.0 |
Hyperlink |
An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host AtkHypertext object. since: 1.0 |
Misc |
A set of utility functions for thread locking. This interface and all his related methods are deprecated since 2.12. since: 1.0 |
NoOpObject |
An AtkNoOpObject is an AtkObject which purports to implement all ATK interfaces. It is the type of AtkObject which is created if an accessible object is requested for an object type for which no factory type is specified. since: 1.0 |
NoOpObjectFactory |
The AtkObjectFactory which creates an AtkNoOpObject. An instance of this is created by an AtkRegistry if no factory type has not been specified to create an accessible object of a particular type. since: 1.0 |
Object |
This class is the primary class for accessibility support via the
Accessibility ToolKit (ATK). Objects which are instances of
since: 1.0 |
ObjectFactory |
This class is the base object class for a factory used to create an
accessible object for a specific GType. The function
since: 1.0 |
Plug |
See since: 1.0 |
Registry |
The AtkRegistry is normally used to create appropriate ATK “peers” for user interface components. Application developers usually need only interact with the AtkRegistry by associating appropriate ATK implementation classes with GObject classes via the atk_registry_set_factory_type call, passing the appropriate GType for application custom widget classes. since: 1.0 |
Relation |
An AtkRelation describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as an AtkRelationSet, which is a set of AtkRelations. since: 1.0 |
RelationSet |
The AtkRelationSet held by an object establishes its relationships with objects beyond the normal “parent/child” hierarchical relationships that all user interface objects have. AtkRelationSets establish whether objects are labelled or controlled by other components, share group membership with other components (for instance within a radio-button group), or share content which “flows” between them, among other types of possible relationships. since: 1.0 |
Socket |
Together with since: 1.0 |
StateSet |
An AtkStateSet is a read-only representation of the full set of since: 1.0 |
Util |
A set of ATK utility functions which are used to support event registration of various types, and obtaining the ‘root’ accessible of a process and information about the current ATK implementation and toolkit version. since: 1.0 |
Interfaces
Action |
since: 1.0 |
Component |
since: 1.0 |
Document |
The AtkDocument interface should be supported by any object whose content is a representation or view of a document. The AtkDocument interface should appear on the toplevel container for the document content; however AtkDocument instances may be nested (i.e. an AtkDocument may be a descendant of another AtkDocument) in those cases where one document contains “embedded content” which can reasonably be considered a document in its own right. since: 1.0 |
EditableText |
since: 1.0 |
HyperlinkImpl |
AtkHyperlinkImpl allows AtkObjects to refer to their associated AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas AtkHyperlink is a object type. The AtkHyperlinkImpl interface allows a client to query an AtkObject for the availability of an associated AtkHyperlink instance, and obtain that instance. It is thus particularly useful in cases where embedded content or inline content within a text object is present, since the embedding text object implements AtkHypertext and the inline/embedded objects are exposed as children which implement AtkHyperlinkImpl, in addition to their being obtainable via AtkHypertext:getLink followed by AtkHyperlink:getObject. since: 1.0 |
Hypertext |
An interface used for objects which implement linking between multiple resource or content locations, or multiple ‘markers’ within a single document. A Hypertext instance is associated with one or more Hyperlinks, which are associated with particular offsets within the Hypertext’s included content. While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets. since: 1.0 |
Image |
since: 1.0 |
ImplementorIface |
The AtkImplementor interface is implemented by objects for which AtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor); since: 1.0 |
Selection |
atk_object_get_n_children, if the use of the parent UI componentordinarily involves selection of one or more of the objects
corresponding to those since: 1.0 |
StreamableContent |
An interface whereby an object allows its backing content to be streamed to clients. Typical implementors would be images or icons, HTML content, or multimedia display/rendering widgets. since: 1.0 |
Table |
since: 1.0 |
TableCell |
Being since: 1.0 |
Text |
atk_object_get_name instead; however if the text is editable,multi-line, typically longer than three or four words, attributed,
selectable, or if the object already uses the ‘name’ ATK property
for other information, the since: 1.0 |
Value |
since: 1.0 |
Window |
since: 1.0 |
Structs
Attribute |
AtkAttribute is a string name/value pair representing a generic
attribute. This can be used to expose additional information from
an accessible object as a whole (see atk_object_get_attributes())
or an document (see atk_document_get_attributes()). In the case of
text attributes (see atk_text_get_default_attributes()),
since: 1.0 |
Implementor |
since: 1.0 |
KeyEventStruct |
Encapsulates information about a key event. since: 1.0 |
PropertyValues |
valid value. This is a field defined with the purpose of contain the previous value of the property, but is not used anymore. since: 1.0 |
Range |
since: 1.0 |
Rectangle |
A data structure for holding a rectangle. Those coordinates are relative to the component top-level parent. since: 1.0 |
TextRange |
A structure used to describe a text range. since: 1.0 |
TextRectangle |
A structure used to store a rectangle used by AtkText. since: 1.0 |
Aliases
AttributeSet |
This is a singly-linked list (a since: 1.0 |
State |
since: 1.0 |
Enumerations
CoordType |
Specifies how xy coordinates are to be interpreted. Used by functions such
as since: 1.0 |
KeyEventType |
Specifies the type of a keyboard evemt. since: 1.0 |
Layer |
Describes the layer of a component. since: 1.0 |
RelationType |
Describes the type of the relation. since: 1.0 |
Role |
Describes the role of an object. since: 1.0 |
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. since: 1.0 |
TextAttribute |
Describes the text attributes supported. since: 1.0 |
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. Use AtkTextGranularity with #atk_text_get_string_at_offset instead. since: 1.0 |
TextClipType |
Describes the type of clipping required. since: 1.0 |
TextGranularity |
Text granularity types used for specifying the granularity of the region of text we are interested in. since: 1.0 |
ValueType |
Default types for a given value. Those are defined in order to easily get localized strings to describe a given value or a given subrange, using atk_value_type_get_localized_name(). since: 1.0 |
Bitfields
HyperlinkStateFlags |
Describes the type of link. since: 1.0 |
Callbacks
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 are supported are events of type “focus:”. Most clients of ATK will prefer to attach signal handlers for the various ATK signals instead. since: 1.0 |
EventListenerInit |
An since: 1.0 |
FocusHandler |
The type of callback function used for
deprecated: 2.9.4 since: 1.0 |
Function |
An AtkFunction is a function definition used for padding which has been added to class and interface structures to allow for expansion in the future. since: 1.0 |
KeySnoopFunc |
An since: 1.0 |
PropertyChangeHandler |
An AtkPropertyChangeHandler is a function which is executed when an AtkObject’s property changes value. It is specified in a call to atk_object_connect_property_change_handler(). deprecated: Unknown since: 1.0 |
Functions
add_focus_tracker |
Adds the specified function to the list of functions to be called when an object receives focus. deprecated: 2.9.4 since: 1.0 |
add_global_event_listener |
Adds the specified function to the list of functions to be called when an ATK event of type event_type occurs. since: 1.0 |
add_key_event_listener |
Adds the specified function to the list of functions to be called
when a key event occurs. The since: 1.0 |
focus_tracker_init |
Specifies the function to be called for focus tracker initialization. This function should be called by an implementation of the ATK interface if any specific work needs to be done to enable focus tracking. deprecated: 2.9.4 since: 1.0 |
focus_tracker_notify |
Cause the focus tracker functions which have been specified to be executed for the object. deprecated: 2.9.4 since: 1.0 |
get_binary_age |
Returns the binary age as passed to libtool when building the ATK library the process is running against. since: 2.8 |
get_default_registry |
Gets a default implementation of the since: 1.0 |
get_focus_object |
Gets the currently focused object. since: 1.6 |
get_interface_age |
Returns the interface age as passed to libtool when building the ATK library the process is running against. since: 2.8 |
get_major_version |
Returns the major version number of the ATK library. (e.g. in ATK version 2.7.4 this is 2.) since: 2.8 |
get_micro_version |
Returns the micro version number of the ATK library. (e.g. in ATK version 2.7.4 this is 4.) since: 2.8 |
get_minor_version |
Returns the minor version number of the ATK library. (e.g. in ATK version 2.7.4 this is 7.) since: 2.8 |
get_root |
Gets the root accessible container for the current application. since: 1.0 |
get_toolkit_name |
Gets name string for the GUI toolkit implementing ATK for this application. since: 1.0 |
get_toolkit_version |
Gets version string for the GUI toolkit implementing ATK for this application. since: 1.0 |
get_version |
Gets the current version for ATK. since: 1.20 |
remove_focus_tracker |
Removes the specified focus tracker from the list of functions to be called when any object receives focus. deprecated: 2.9.4 since: 1.0 |
remove_global_event_listener |
since: 1.0 |
remove_key_event_listener |
since: 1.0 |
Function Macros
CHECK_VERSION |
Returns since: 2.7.4 |
DEFINE_ABSTRACT_TYPE |
A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE(), but defines an abstract type. since: 1.22 |
DEFINE_ABSTRACT_TYPE_WITH_CODE |
A convenience macro for ATK type implementations. Similar to ATK_DEFINE_TYPE_WITH_CODE(), but defines an abstract type. since: 1.22 |
DEFINE_TYPE |
A convenience macro for type ATK implementations, which declares a class
initialization function, an instance initialization function (see since: 1.22 |
DEFINE_TYPE_EXTENDED |
The most general convenience macro for ATK type implementations, on which ATK_DEFINE_TYPE(), etc are based. since: 1.22 |
DEFINE_TYPE_WITH_CODE |
A convenience macro for ATK 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 |
since: 1.0 |
GOBJECT_ACCESSIBLE |
since: 1.0 |
GOBJECT_ACCESSIBLE_CLASS |
since: 1.0 |
NO_OP_OBJECT |
since: 1.0 |
NO_OP_OBJECT_CLASS |
since: 1.0 |
NO_OP_OBJECT_FACTORY |
since: 1.0 |
NO_OP_OBJECT_FACTORY_CLASS |
since: 1.0 |
UNAVAILABLE |
since: 1.0 |
Constants
BINARY_AGE |
Like atk_get_binary_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. since: 1.0 |
INTERFACE_AGE |
Like atk_get_interface_age(), but from the headers used at application compile time, rather than from the library linked against at application run time. since: 1.0 |
MAJOR_VERSION |
Like atk_get_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. since: 1.0 |
MICRO_VERSION |
Like atk_get_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. since: 1.0 |
MINOR_VERSION |
Like atk_get_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time. since: 1.0 |
VERSION_MIN_REQUIRED |
A macro that should be defined by the user prior to including
the atk/atk.h header.
The definition should be one of the predefined ATK version
macros: since: 1.0 |