Functions

  attribute_set_free (attrib_set)
  focus_tracker_notify (object)
  get_binary_age ()
  get_default_registry ()
  get_focus_object ()
  get_interface_age ()
  get_major_version ()
  get_micro_version ()
  get_minor_version ()
  get_root ()
  get_toolkit_name ()
  get_toolkit_version ()
  get_version ()
  relation_type_for_name (name)
  relation_type_get_name (type)
  relation_type_register (name)
  remove_focus_tracker (tracker_id)
  remove_global_event_listener (listener_id)
  remove_key_event_listener (listener_id)
  role_for_name (name)
  role_get_localized_name (role)
  role_get_name (role)
  role_register (name)
  state_type_for_name (name)
  state_type_get_name (type)
  state_type_register (name)
  text_attribute_for_name (name)
  text_attribute_get_name (attr)
  text_attribute_get_value (attr, index_)
  text_attribute_register (name)
  text_free_ranges (ranges)
  value_type_get_localized_name (value_type)
  value_type_get_name (value_type)

Details

Atk.attribute_set_free(attrib_set)[source]
Parameters:attrib_set ([object]) – The #AtkAttributeSet to free

Frees the memory used by an #AtkAttributeSet, including all its Atk.Attributes.

Atk.focus_tracker_notify(object)[source]
Parameters:object (Atk.Object) – an Atk.Object

Cause the focus tracker functions which have been specified to be executed for the object.

Deprecated since version 2.9.4: Focus tracking has been dropped as a feature to be implemented by ATK itself. As Atk.Object ::focus-event was deprecated in favor of a Atk.Object ::state-change signal, in order to notify a focus change on your implementation, you can use Atk.Object.notify_state_change() instead.

Atk.get_binary_age()[source]
Returns:the binary age of the ATK library
Return type:int

Returns the binary age as passed to libtool when building the ATK library the process is running against.

New in version 2.8.

Atk.get_default_registry()[source]
Returns:a default implementation of the Atk.ObjectFactory/type registry
Return type:Atk.Registry

Gets a default implementation of the Atk.ObjectFactory/type registry. Note: For most toolkit maintainers, this will be the correct registry for registering new Atk.Object factories. Following a call to this function, maintainers may call Atk.Registry.set_factory_type() to associate an Atk.ObjectFactory subclass with the GObject.GType of objects for whom accessibility information will be provided.

Atk.get_focus_object()[source]
Returns:the currently focused object for the current application
Return type:Atk.Object

Gets the currently focused object.

New in version 1.6.

Atk.get_interface_age()[source]
Returns:the interface age of the ATK library
Return type:int

Returns the interface age as passed to libtool when building the ATK library the process is running against.

New in version 2.8.

Atk.get_major_version()[source]
Returns:the major version number of the ATK library
Return type:int

Returns the major version number of the ATK library. (e.g. in ATK version 2.7.4 this is 2.)

This function is in the library, so it represents the ATK library your code is running against. In contrast, the Atk.MAJOR_VERSION macro represents the major version of the ATK headers you have included when compiling your code.

New in version 2.8.

Atk.get_micro_version()[source]
Returns:the micro version number of the ATK library
Return type:int

Returns the micro version number of the ATK library. (e.g. in ATK version 2.7.4 this is 4.)

This function is in the library, so it represents the ATK library your code is are running against. In contrast, the Atk.MICRO_VERSION macro represents the micro version of the ATK headers you have included when compiling your code.

New in version 2.8.

Atk.get_minor_version()[source]
Returns:the minor version number of the ATK library
Return type:int

Returns the minor version number of the ATK library. (e.g. in ATK version 2.7.4 this is 7.)

This function is in the library, so it represents the ATK library your code is are running against. In contrast, the Atk.MINOR_VERSION macro represents the minor version of the ATK headers you have included when compiling your code.

New in version 2.8.

Atk.get_root()[source]
Returns:the root accessible container for the current application
Return type:Atk.Object

Gets the root accessible container for the current application.

Atk.get_toolkit_name()[source]
Returns:name string for the GUI toolkit implementing ATK for this application
Return type:str

Gets name string for the GUI toolkit implementing ATK for this application.

Atk.get_toolkit_version()[source]
Returns:version string for the GUI toolkit implementing ATK for this application
Return type:str

Gets version string for the GUI toolkit implementing ATK for this application.

Atk.get_version()[source]
Returns:version string for ATK
Return type:str

Gets the current version for ATK.

New in version 1.20.

Atk.relation_type_for_name(name)[source]
Parameters:name (str) – a string which is the (non-localized) name of an ATK relation type.
Returns:the Atk.RelationType enumerated type corresponding to the specified name, or Atk.RelationType.NULL if no matching relation type is found.
Return type:Atk.RelationType

Get the Atk.RelationType type corresponding to a relation name.

Atk.relation_type_get_name(type)[source]
Parameters:type (Atk.RelationType) – The Atk.RelationType whose name is required
Returns:the string describing the Atk.RelationType
Return type:str

Gets the description string describing the Atk.RelationType type.

Atk.relation_type_register(name)[source]
Parameters:name (str) – a name string
Returns:an Atk.RelationType associated with name
Return type:Atk.RelationType

Associate name with a new Atk.RelationType

Atk.remove_focus_tracker(tracker_id)[source]
Parameters:tracker_id (int) – the id of the focus tracker to remove

Removes the specified focus tracker from the list of functions to be called when any object receives focus.

Deprecated since version 2.9.4: Focus tracking has been dropped as a feature to be implemented by ATK itself. If you need focus tracking on your implementation, subscribe to the Atk.Object ::state-change “focused” signal.

Atk.remove_global_event_listener(listener_id)[source]
Parameters:listener_id (int) – the id of the event listener to remove

listener_id is the value returned by #atk_add_global_event_listener when you registered that event listener.

Toolkit implementor note: ATK provides a default implementation for this virtual method. ATK implementors are discouraged from reimplementing this method.

Toolkit implementor note: this method is not intended to be used by ATK implementors but by ATK consumers.

Removes the specified event listener

Atk.remove_key_event_listener(listener_id)[source]
Parameters:listener_id (int) – the id of the event listener to remove

listener_id is the value returned by #atk_add_key_event_listener when you registered that event listener.

Removes the specified event listener.

Atk.role_for_name(name)[source]
Parameters:name (str) – a string which is the (non-localized) name of an ATK role.
Returns:the Atk.Role enumerated type corresponding to the specified name, or Atk.Role.INVALID if no matching role is found.
Return type:Atk.Role

Get the Atk.Role type corresponding to a rolew name.

Atk.role_get_localized_name(role)[source]
Parameters:role (Atk.Role) – The Atk.Role whose localized name is required
Returns:the localized string describing the Atk.Role
Return type:str

Gets the localized description string describing the Atk.Role role.

Atk.role_get_name(role)[source]
Parameters:role (Atk.Role) – The Atk.Role whose name is required
Returns:the string describing the Atk.Role
Return type:str

Gets the description string describing the Atk.Role role.

Atk.role_register(name)[source]
Parameters:name (str) – a character string describing the new role.
Returns:an Atk.Role for the new role if added properly. Atk.Role.INVALID in case of error.
Return type:Atk.Role

Registers the role specified by name. name must be a meaningful name. So it should not be empty, or consisting on whitespaces.

Deprecated since version 2.12: If your application/toolkit doesn’t find a suitable role for a specific object defined at Atk.Role, please submit a bug in order to add a new role to the specification.

Atk.state_type_for_name(name)[source]
Parameters:name (str) – a character string state name
Returns:an Atk.StateType corresponding to name
Return type:Atk.StateType

Gets the Atk.StateType corresponding to the description string name.

Atk.state_type_get_name(type)[source]
Parameters:type (Atk.StateType) – The Atk.StateType whose name is required
Returns:the string describing the Atk.StateType
Return type:str

Gets the description string describing the Atk.StateType type.

Atk.state_type_register(name)[source]
Parameters:name (str) – a character string describing the new state.
Returns:an #AtkState value for the new state.
Return type:Atk.StateType

Register a new object state.

Atk.text_attribute_for_name(name)[source]
Parameters:name (str) – a string which is the (non-localized) name of an ATK text attribute.
Returns:the Atk.TextAttribute enumerated type corresponding to the specified name, or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found.
Return type:Atk.TextAttribute

Get the Atk.TextAttribute type corresponding to a text attribute name.

Atk.text_attribute_get_name(attr)[source]
Parameters:attr (Atk.TextAttribute) – The Atk.TextAttribute whose name is required
Returns:a string containing the name; this string should not be freed
Return type:str

Gets the name corresponding to the Atk.TextAttribute

Atk.text_attribute_get_value(attr, index_)[source]
Parameters:
Returns:

a string containing the value; this string should not be freed; None is returned if there are no values maintained for the attr value.

Return type:

str or None

Gets the value for the index of the Atk.TextAttribute

Atk.text_attribute_register(name)[source]
Parameters:name (str) – a name string
Returns:an Atk.TextAttribute associated with name
Return type:Atk.TextAttribute

Associate name with a new Atk.TextAttribute

Atk.text_free_ranges(ranges)[source]
Parameters:ranges ([Atk.TextRange]) – A pointer to an array of Atk.TextRange which is to be freed.

Frees the memory associated with an array of Atk.TextRange. It is assumed that the array was returned by the function Atk.Text.get_bounded_ranges and is None terminated.

New in version 1.3.

Atk.value_type_get_localized_name(value_type)[source]
Parameters:value_type (Atk.ValueType) – The Atk.ValueType whose localized name is required
Returns:the localized string describing the Atk.ValueType
Return type:str

Gets the localized description string describing the Atk.ValueType value_type.

Atk.value_type_get_name(value_type)[source]
Parameters:value_type (Atk.ValueType) – The Atk.ValueType whose name is required
Returns:the string describing the Atk.ValueType
Return type:str

Gets the description string describing the Atk.ValueType value_type.