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, char name)
	Sets an accessible name of the object. This string should be short, human-readable name identyfing gui element.
char *	elm_atspi_accessible_name_get (const Elm_Interface_Atspi_Accessible *obj)
	Gets an accessible name of the object.
void	elm_atspi_accessible_role_set (Elm_Interface_Atspi_Accessible *obj, Elm_Atspi_Role role)
	Sets role of the object in accessibility domain. Role describes a class of gui elements that provides same functionality. Role list is predefined.
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_description_set (Elm_Interface_Atspi_Accessible obj, const char description)
	Sets contextual information about object. Description contrary to "name" property contain more verbose information about object. Property may contain description of functionality which given element provides in application.
const char *	elm_atspi_accessible_description_get (const Elm_Interface_Atspi_Accessible *obj)
	Gets contextual information about object.
void	elm_atspi_attributes_list_free (Eina_List *list)
void	elm_atspi_relation_free (Elm_Atspi_Relation *rel)
Elm_Atspi_Relation *	elm_atspi_relation_clone (const Elm_Atspi_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_relation_set_free (Elm_Atspi_Relation_Set *set)
Elm_Atspi_Relation_Set	elm_atspi_relation_set_clone (const Elm_Atspi_Relation_Set *set)
Typedefs
typedef uint64_t	Elm_Atspi_State_Set
Defines
#define	STATE_TYPE_UNSET(state_set, type) (state_set &= ~((Elm_Atspi_State_Set)1 << type))
#define	STATE_TYPE_GET(state_set, type) (state_set & ((Elm_Atspi_State_Set)1 << type))

Define Documentation

#define STATE_TYPE_GET	(	state_set,
		type
	)	(state_set & ((Elm_Atspi_State_Set)1 << type))

Gets value of a particilar state type for given state set.

#define STATE_TYPE_UNSET	(	state_set,
		type
	)	(state_set &= ~((Elm_Atspi_State_Set)1 << type))

Unsets a particilar state type for given state set.

Typedef Documentation

typedef uint64_t Elm_Atspi_State_Set

ATSPI object state set.

Enumeration Type Documentation

enum _Elm_Atspi_Relation_Type

Elm_Atspi_Relation_Type describes relation between two objects.

enum _Elm_Atspi_Role

Describes the role of an object visible to AT-SPI Clients.

enum _Elm_Atspi_State_Type

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

Function Documentation

const char* elm_atspi_accessible_description_get ( const Elm_Interface_Atspi_Accessible * obj )

Gets contextual information about object.

Since :: 2.4

Returns:: Statically allocated string with contextual information

Parameters:

[in] obj The elm interface atspi accessible

void elm_atspi_accessible_description_set	(	Elm_Interface_Atspi_Accessible *	obj,
		const char *	description
	)

Sets contextual information about object. Description contrary to "name" property contain more verbose information about object. Property may contain description of functionality which given element provides in application.

Example of good accessible description for icon-only button closing the application might be: "Close the application".

Since :: 2.4

Parameters:

[in]	obj	The elm interface atspi accessible *
[in]	description	No description supplied.

char* elm_atspi_accessible_name_get ( const Elm_Interface_Atspi_Accessible * obj )

Gets an accessible name of the object.

Since :: 2.4

Returns:: Newly allocated string with object accessible name Should be free by a user

Parameters:

[in] obj The elm interface atspi accessible

void elm_atspi_accessible_name_set	(	Elm_Interface_Atspi_Accessible *	obj,
		char *	name
	)

Sets an accessible name of the object. This string should be short, human-readable name identyfing gui element.

Since :: 2.4

Example of good accessible name for icon-only button closing the application might be: "exit" or "quit".

Remarks:: Function parameter will not be modified or referenced afterwards.

Parameters:

[in]	obj	The elm interface atspi accessible *
[in]	name	accessible name

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.

Remarks:: 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.

Returns:: EINA_TRUE is relationship was successfully appended, EINA_FALSE otherwise

Since :: 2.4

Parameters:

[in]	obj	The elm interface atspi accessible *
[in]	type	No description supplied.
[in]	relation_object	No description supplied.

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.

Since :: 2.4

Parameters:

[in]	obj	The elm interface atspi accessible *
[in]	type	No description supplied.
[in]	relation_object	No description supplied.

Elm_Atspi_Role elm_atspi_accessible_role_get ( const Elm_Interface_Atspi_Accessible * obj )

Gets the role of the object in accessibility domain.

Since :: 2.4

Returns:: Acccessible role of the object in accessibility domain

Parameters:

[in] obj The elm interface atspi accessible

void elm_atspi_accessible_role_set	(	Elm_Interface_Atspi_Accessible *	obj,
		Elm_Atspi_Role	role
	)

Sets role of the object in accessibility domain. Role describes a class of gui elements that provides same functionality. Role list is predefined.

Since :: 2.4

Parameters:

[in]	obj	The elm interface atspi accessible *
[in]	role	No description supplied.

const char* elm_atspi_accessible_translation_domain_get ( const Elm_Interface_Atspi_Accessible * obj )

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

Since :: 2.4

Returns:: Translation domain of "name" and "description"

Parameters:

[in] obj The elm interface atspi accessible

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 "descriptions" properties.

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

Remarks:: It is up to application developer to ensure that translation files are properly binded to translation domain with bindtextdomain function when accessibility is enabled.

Since :: 2.4

Parameters:

[in]	obj	The elm interface atspi accessible *
[in]	domain	No description supplied.

void elm_atspi_attributes_list_free ( Eina_List * list )

Free Elm_Atspi_Attributes_List

Elm_Atspi_Relation* elm_atspi_relation_clone ( const Elm_Atspi_Relation * relation )

Clones relation

void elm_atspi_relation_free ( Elm_Atspi_Relation * rel )

Free Elm_Atspi_Relation

Elm_Atspi_Relation_Set elm_atspi_relation_set_clone ( const Elm_Atspi_Relation_Set * set )

Makes a deep copy of Elm_Atspi_State_Set

void elm_atspi_relation_set_free ( Elm_Atspi_Relation_Set * set )

Frees Elm_Atspi_State_Set

Eina_Bool elm_atspi_relation_set_relation_append	(	Elm_Atspi_Relation_Set *	set,
		Elm_Atspi_Relation_Type	type,
		const Eo *	rel_obj
	)

Appends relation to relation set

void elm_atspi_relation_set_relation_remove	(	Elm_Atspi_Relation_Set *	set,
		Elm_Atspi_Relation_Type	type,
		const Eo *	rel_obj
	)

Removes relation from relation set

void elm_atspi_relation_set_relation_type_remove	(	Elm_Atspi_Relation_Set *	set,
		Elm_Atspi_Relation_Type	type
	)

Removes all relation from relation set of a given type

Functions

Typedefs

Defines

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation