Tizen Native API  5.5
Atspi Accessible

Functions

Eina_Bool elm_atspi_accessible_relationship_append (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Relation_Type type, const Elm_Interface_Atspi_Accessible *relation_object)
 Defines the relationship between two accessible objects.
void elm_atspi_accessible_relationship_remove (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Relation_Type type, const Elm_Interface_Atspi_Accessible *relation_object)
 Removes the relationship between two accessible objects.
const char * elm_atspi_accessible_translation_domain_get (const Elm_Interface_Atspi_Accessible *obj)
 Gets the translation domain of "name" and "description" properties.
void elm_atspi_accessible_translation_domain_set (Elm_Interface_Atspi_Accessible *obj, const char *domain)
 Sets the translation domain of "name" and "description" properties.
void elm_atspi_accessible_name_set (Elm_Interface_Atspi_Accessible *obj, const char *name)
 Gets an localized string describing accessible object role name.
const char * elm_atspi_accessible_name_get (const Elm_Interface_Atspi_Accessible *obj)
 Gets an accessible name of the object.
void elm_atspi_accessible_name_cb_set (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Reading_Info_Cb name_cb, const void *data)
 Sets name information callback about widget.
void elm_atspi_accessible_role_set (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Role role)
 Gets an all relations between accessible object and other accessible objects.
Elm_Atspi_Role elm_atspi_accessible_role_get (const Elm_Interface_Atspi_Accessible *obj)
 Gets the role of the object in accessibility domain.
void elm_atspi_accessible_reading_info_type_set (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Reading_Info_Type_Mask reading_info)
 Gets object's accessible children.
Elm_Atspi_Reading_Info_Type_Mask elm_atspi_accessible_reading_info_type_get (const Elm_Interface_Atspi_Accessible *obj)
 Gets reading information types of an accessible object.
void elm_atspi_accessible_description_set (Elm_Interface_Atspi_Accessible *obj, const char *description)
 Gets index of the child in parent's children list.
const char * elm_atspi_accessible_description_get (const Elm_Interface_Atspi_Accessible *obj)
 Gets contextual information about object.
void elm_atspi_accessible_description_cb_set (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Reading_Info_Cb description_cb, const void *data)
 Sets contextual information callback about widget.
void elm_atspi_accessible_gesture_cb_set (Elm_Interface_Atspi_Accessible *obj, Efl_Access_Gesture_Cb gesture_cb, const void *data)
 Sets gesture callback to give widget.
void elm_atspi_accessible_can_highlight_set (Elm_Interface_Atspi_Accessible *obj, Eina_Bool can_highlight)
 Sets object's accessible parent.
Eina_Bool elm_atspi_accessible_can_highlight_get (const Elm_Interface_Atspi_Accessible *obj)
 Gets highlightable of given widget.
void elm_atspi_accessible_attribute_append (Elm_Interface_Atspi_Accessible *obj, const char *key, const char *value)
 Add key-value pair identifying widget extra attribute.
void elm_atspi_accessible_relationships_clear (Elm_Interface_Atspi_Accessible *obj)
 Removes all attributes in accessible object.
void elm_atspi_relation_set_free (Elm_Atspi_Relation_Set *set)
 Notifies assistive technology clients about current state of the accessible object.
Elm_Atspi_Relation_Set elm_atspi_relation_set_clone (const Elm_Atspi_Relation_Set *set)
void elm_atspi_relation_free (Efl_Access_Relation *relation)
Efl_Access_Relation * elm_atspi_relation_clone (const Efl_Access_Relation *relation)
Eina_Bool elm_atspi_relation_set_relation_append (Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj)
void elm_atspi_relation_set_relation_remove (Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj)
void elm_atspi_relation_set_relation_type_remove (Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type)
void elm_atspi_attributes_list_free (Eina_List *list)
Eina_Bool elm_atspi_component_highlight_grab (Efl_Access_Component *obj)
 Highlights accessible widget. returns true if highlight grab has successed, false otherwise.
Eina_Bool elm_atspi_component_highlight_clear (Efl_Access_Component *obj)
 Clears highlight of accessible widget. returns true if clear has successed, false otherwise.

Typedefs

typedef enum _Elm_Atspi_Role Elm_Atspi_Role
typedef enum _Elm_Atspi_State_Type Elm_Atspi_State_Type
typedef enum
_Elm_Atspi_Relation_Type 
Elm_Atspi_Relation_Type
typedef Efl_Access_Gesture Elm_Atspi_Gesture_Type
typedef Efl_Access_Gesture_State Elm_Atspi_Gesture_State
typedef unsigned int Elm_Atspi_Reading_Info_Type_Mask
typedef char *(* Elm_Atspi_Reading_Info_Cb )(void *data, Eo *obj)
typedef uint64_t Elm_Atspi_State_Set

Defines

#define Elm_Atspi_Gesture_Info   Efl_Access_Gesture_Info
#define Elm_Atspi_Gesture_Cb   Efl_Access_Gesture_Cb

Define Documentation

#define Elm_Atspi_Gesture_Cb   Efl_Access_Gesture_Cb

This callback type is used to provide accessibility gesture information.

Parameters:
dataThe data specified as the last param when setting this callback
objThe accessible object specified as the fisrt param when setting this callback
Returns:
true if application consumes gesutre, false if application does not consume gesture, then assistive technology client consumes gesture
See also:
elm_atspi_accessible_gesture_cb_set
Since :
3.0
#define Elm_Atspi_Gesture_Info   Efl_Access_Gesture_Info

Detailed information of gesture that is emitted on assistive technology client side.

Since :
3.0

Typedef Documentation

typedef Efl_Access_Gesture_State Elm_Atspi_Gesture_State

State of gesture that is emitted on assistive technology client side.

Since :
3.0
typedef Efl_Access_Gesture Elm_Atspi_Gesture_Type

Type of gesture that is emitted on assistive technology client side.

Warning:
do not use ELM_ATSPI_GESTURE_TWO_FINGERS_FLICK_*, and ELM_ATSPI_GESTURE_TWO_FINGERS_HOVER. These gestures are not emitted on assistive technology client side. The window manager emits mouse event directly. So if you need to check these gestures, you have to handle mouse events. If you want to make highlighted object to get mouse events directly, then please use elm_atspi_accessible_attribute_append as below.

elm_atspi_accessible_attribute_append(obj, "gesture_required", "scroll");

Since :
3.0
typedef char*(* Elm_Atspi_Reading_Info_Cb)(void *data, Eo *obj)

This callback type is used to provide accessibility reading information.

Parameters:
dataThe data specified as the last param when setting this callback
objThe accessible object specified as the fisrt param when setting this callback
Returns:
The information to be used by accessibilty client
See also:
elm_atspi_accessible_name_cb_set
elm_atspi_accessible_description_cb_set
Since :
3.0
typedef unsigned int Elm_Atspi_Reading_Info_Type_Mask

A Elm_Accessible_Reading_Info_Type mask indicating which types of reading information are requested.

See also:
elm_atspi_accessible_reading_info_type_set
Since :
3.0
typedef enum _Elm_Atspi_Relation_Type Elm_Atspi_Relation_Type

Elm_Atspi_Relation_Type describes relation between two objects.

Since :
3.0
typedef enum _Elm_Atspi_Role Elm_Atspi_Role

Describes the role of an object visible to assistive technology client.

Since :
3.0
typedef uint64_t Elm_Atspi_State_Set

AT-SPI object state set.

typedef enum _Elm_Atspi_State_Type Elm_Atspi_State_Type

Describes a possible states of an object visible to AT-SPI clients.

Since :
3.0

Enumeration Type Documentation

The accessible Reading information type that can be read.

Since :
3.0
Enumerator:
ELM_ACCESSIBLE_READING_INFO_TYPE_ROLE 

Name should be read

ELM_ACCESSIBLE_READING_INFO_TYPE_DESCRIPTION 

Role should be read

ELM_ACCESSIBLE_READING_INFO_TYPE_STATE 

description should be read.


Function Documentation

void elm_atspi_accessible_attribute_append ( Elm_Interface_Atspi_Accessible *  obj,
const char *  key,
const char *  value 
)

Add key-value pair identifying widget extra attribute.

Since :
3.0
Parameters:
[in]objThe object.
[in]keyThe string key to give extra information
[in]valueThe string value to give extra information
Eina_Bool elm_atspi_accessible_can_highlight_get ( const Elm_Interface_Atspi_Accessible *  obj)

Gets highlightable of given widget.

Since :
3.0
Parameters:
[in]objThe object.
Returns:
If true, the object is highlightable
void elm_atspi_accessible_can_highlight_set ( Elm_Interface_Atspi_Accessible *  obj,
Eina_Bool  can_highlight 
)

Sets object's accessible parent.

Gets object's accessible parent. Gets set describing object accessible states. Sets highlightable to given widget.

Since :
3.0
Parameters:
[in]objThe object.
[in]can_highlightIf true, the object is highlightable
void elm_atspi_accessible_description_cb_set ( Elm_Interface_Atspi_Accessible *  obj,
Elm_Atspi_Reading_Info_Cb  description_cb,
const void *  data 
)

Sets contextual information callback about widget.

Since :
3.0
Parameters:
[in]objThe object.
[in]description_cbThe function called to provide the accessible description
[in]dataThe data passed to description_cb
const char* elm_atspi_accessible_description_get ( const Elm_Interface_Atspi_Accessible *  obj)

Gets contextual information about object.

Since :
3.0
Parameters:
[in]objThe object.
Returns:
Accessible contextual information
void elm_atspi_accessible_description_set ( Elm_Interface_Atspi_Accessible *  obj,
const char *  description 
)

Gets index of the child in parent's children list.

Sets widget contextual information.

Since :
3.0
Parameters:
[in]objThe object.
[in]descriptionAccessible contextual information
void elm_atspi_accessible_gesture_cb_set ( Elm_Interface_Atspi_Accessible *  obj,
Efl_Access_Gesture_Cb  gesture_cb,
const void *  data 
)

Sets gesture callback to give widget.

Warning:
Please do not abuse this API. The purpose of this API is to support special application such as screen-reader guidance. Before using this API, please check if there is another way.
Since :
3.0
Parameters:
[in]objThe object.
[in]gesutre_cbThe function called to get gesture information
[in]dataThe data passed to description_cb
void elm_atspi_accessible_name_cb_set ( Elm_Interface_Atspi_Accessible *  obj,
Elm_Atspi_Reading_Info_Cb  name_cb,
const void *  data 
)

Sets name information callback about widget.

Since :
3.0
Parameters:
[in]objThe object.
[in]name_cbThe function called to provide the accessible name
[in]dataThe data passed to name_cb
const char* elm_atspi_accessible_name_get ( const Elm_Interface_Atspi_Accessible *  obj)

Gets an accessible name of the object.

Since :
3.0
Parameters:
[in]objThe object.
Returns:
Accessible name
void elm_atspi_accessible_name_set ( Elm_Interface_Atspi_Accessible *  obj,
const char *  name 
)

Gets an localized string describing accessible object role name.

Sets an accessible name of the object.

Since :
3.0
Parameters:
[in]objThe object.
[in]nameAccessible name
Elm_Atspi_Reading_Info_Type_Mask elm_atspi_accessible_reading_info_type_get ( const Elm_Interface_Atspi_Accessible *  obj)

Gets reading information types of an accessible object.

Since :
3.0
Parameters:
[in]objThe object.
Returns:
Reading information types
void elm_atspi_accessible_reading_info_type_set ( Elm_Interface_Atspi_Accessible *  obj,
Elm_Atspi_Reading_Info_Type_Mask  reading_info 
)

Gets object's accessible children.

Gets human-readable string indentifying widget accessibility role. Gets key-value pairs identifying object extra attributes. Must be free by a user. Gets reading information of an accessible object.

Since :
3.0
Parameters:
[in]objThe object.
[in]reading_infoReading information types
Eina_Bool elm_atspi_accessible_relationship_append ( Elm_Interface_Atspi_Accessible *  obj,
Elm_Atspi_Relation_Type  type,
const Elm_Interface_Atspi_Accessible *  relation_object 
)

Defines the relationship between two accessible objects.

Adds unique relation between source object and relation_object of a given type.

Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.

Relationship_append API is asymmetric, which means that appending, for example, relation ELM_ATSPI_RELATION_FLOWS_TO from object A to B, do NOT append relation ELM_ATSPI_RELATION_FLOWS_FROM from object B to object A.

return: EINA_TRUE is relationship was successfully appended, EINA_FALSE otherwise

Since :
3.0
Parameters:
[in]objThe object.
[in]typeRelation type between two objects
[in]relation_objectRelation object of source object
void elm_atspi_accessible_relationship_remove ( Elm_Interface_Atspi_Accessible *  obj,
Elm_Atspi_Relation_Type  type,
const Elm_Interface_Atspi_Accessible *  relation_object 
)

Removes the relationship between two accessible objects.

If relation_object is NULL function removes all relations of given type.

Since :
3.0
Parameters:
[in]objThe object.
[in]typeRelation type between two objects
[in]relation_objectRelation object of source object
void elm_atspi_accessible_relationships_clear ( Elm_Interface_Atspi_Accessible *  obj)

Removes all attributes in accessible object.

Register accessibility event listener Deregister accessibility event listener Emit accessibility event which could occur atspi event Removes all relationships in accessible object.

Since :
4.0
Parameters:
[in]objThe object.
Elm_Atspi_Role elm_atspi_accessible_role_get ( const Elm_Interface_Atspi_Accessible *  obj)

Gets the role of the object in accessibility domain.

Since :
3.0
Parameters:
[in]objThe object.
Returns:
Accessible role
void elm_atspi_accessible_role_set ( Elm_Interface_Atspi_Accessible *  obj,
Elm_Atspi_Role  role 
)

Gets an all relations between accessible object and other accessible objects.

Sets the role of the object in accessibility domain.

Since :
3.0
Parameters:
[in]objThe object.
[in]roleAccessible role
const char* elm_atspi_accessible_translation_domain_get ( const Elm_Interface_Atspi_Accessible *  obj)

Gets the translation domain of "name" and "description" properties.

Since :
3.0
Parameters:
[in]objThe object.
Returns:
translation domain
void elm_atspi_accessible_translation_domain_set ( Elm_Interface_Atspi_Accessible *  obj,
const char *  domain 
)

Sets the translation domain of "name" and "description" properties.

Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties.

When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter.

It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled.

Since :
3.0
Parameters:
[in]objThe object.
[in]domaintranslation domain

Free Elm_Atspi_Attributes_List

Since :
3.0
Eina_Bool elm_atspi_component_highlight_clear ( Efl_Access_Component *  obj)

Clears highlight of accessible widget. returns true if clear has successed, false otherwise.

Since :
3.0
Parameters:
[in]objThe object.

()

Eina_Bool elm_atspi_component_highlight_grab ( Efl_Access_Component *  obj)

Highlights accessible widget. returns true if highlight grab has successed, false otherwise.

Since :
3.0
Parameters:
[in]objThe object.

()

Efl_Access_Relation* elm_atspi_relation_clone ( const Efl_Access_Relation *  relation)

Clones relation.

Since :
3.0
void elm_atspi_relation_free ( Efl_Access_Relation *  relation)

Frees relation.

Since :
3.0

Clones Elm_Atspi_Relation_Set

Since :
3.0

Notifies assistive technology clients about current state of the accessible object.

Function limits information broadcast to clients to types specified by state_types_mask parameter.

if recursive parameter is set, function will traverse all accessible children and call state_notify function on them. Frees Elm_Atspi_Relation_Set

Since :
3.0

Appends relation to relation set

Since :
3.0

Removes relation from relation set

Since :
3.0

Removes all relation from relation set of a given type

Since :
3.0