/**
- * @internal
* @defgroup Elm_Access Access
- * @ingroup Elementary
- *
- * WARNING! this API is not finalized. It is unstable. - do not use it if
- * you want no breaks in future.
- *
- * TODO: description
- *
+ * @ingroup elm_accessibility_group
*/
#include "elm_access.eo.h"
get {
[[Indicate if connection with AT-SPI2 bus has been established.
+ \@internal
\@if MOBILE \@since_tizen 3.0
\@elseif WEARABLE \@since_tizen 3.0
\@endif
}
@property root {
get {
- [[Get root object of accessible object hierarchy]]
+ [[Get root object of accessible object hierarchy
+
+ \@internal
+ ]]
values {
ret: Eo*;
}
#include "elm_atspi_bridge.eo.h"
+/**
+ * @defgroup Elm_Atspi_Bridge Atspi Bridge
+ * @ingroup elm_accessibility_group
+ */
//TIZEN_ONLY(20160527) - Add direct reading feature
+/**
+ * This callback type is used to provide reading status information.
+ * @param data The data specified as the last param when setting this callback
+ * @param say_signal The signal decribes reading status information
+ * @see elm_atspi_bridge_utils_say
+ * @ingroup Elm_Atspi_Bridge
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
typedef void (*Elm_Atspi_Say_Signal_Cb)(void *data, const char *say_signal);
/**
* @brief Reads given text by screen reader
* “ReadingSkipped”
* @param data The user data to be passed to the callback function
*
- * @ingoup Elm_Atspi_Bridge
+ * @ingroup Elm_Atspi_Bridge
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const void *data);
//
//TIZEN_ONLY(20161027) - Export elm_atspi_bridge_utils_is_screen_reader_enabled
-/** Determines if screen reader is enabled
- *
+/**
+ * @internal
+ * Determines if screen reader is enabled
* @ingroup Elm_Atspi_Bridge
*/
EAPI Eina_Bool elm_atspi_bridge_utils_is_screen_reader_enabled(void);
EAPI void elm_config_popup_scrollable_set(Eina_Bool scrollable);
/**
- * @defgroup ATSPI AT-SPI2 Accessibility
* @ingroup elm_infra_group
*
* Elementary widgets support Linux Accessibility standard. For more
*
* @since 1.10
*
- * @ingroup ATSPI
+ * @ingroup Elm_Config
*
* @see elm_config_atspi_mode_set()
*
*
* @since 1.10
*
- * @ingroup ATSPI
+ * @ingroup Elm_Config
*
* @see elm_config_atspi_mode_get()
*
methods {
@property localized_role_name @protected {
get {
- [[Gets an localized string describing accessible object role name.]]
+ [[Gets an localized string describing accessible object role name.
+
+ \@internal
+ ]]
}
values {
localized_name: const(char)*; [[Localized accessible role name]]
//
@property relation_set @protected {
get {
- [[Gets an all relations between accessible object and other accessible objects.]]
+ [[Gets an all relations between accessible object and other accessible objects.
+
+ \@internal
+ ]]
}
values {
relations: Elm_Atspi_Relation_Set; [[Accessible relation set]]
}
@property children @protected {
get {
- [[Gets object's accessible children.]]
+ [[Gets object's accessible children.
+
+ \@internal
+ ]]
}
values {
children: free(own(list<Elm_Interface_Atspi_Accessible *> *), eina_list_free);
}
@property role_name @protected {
get {
- [[Gets human-readable string indentifying widget accessibility role.]]
+ [[Gets human-readable string indentifying widget accessibility role.
+
+ \@internal
+ ]]
}
values {
role_name: const(char)*; [[Accessible role name]]
}
@property attributes @protected {
get {
- [[Gets key-value pairs identifying object extra attributes. Must be free by a user.]]
+ [[Gets key-value pairs identifying object extra attributes. Must be free by a user.
+
+ \@internal
+ ]]
}
values {
attributes: free(own(list<own(Elm_Atspi_Attribute *)> *), elm_atspi_attributes_list_free); [[List of object attributes]]
//TIZEN_ONLY(20160926): attributes, endless recursion fix
attributes_clear {
- [[Removes all attributes in accessible object.]]
+ [[Removes all attributes in accessible object.
+
+ \@internal
+ ]]
}
@property reading_info_type @protected {
//
@property index_in_parent @protected {
get {
- [[Gets index of the child in parent's children list.]]
+ [[Gets index of the child in parent's children list.
+
+ \@internal
+ ]]
}
values {
idx: int; [[Index in children list]]
}
}
gesture_do @protected {
- [[Handles gesture on given widget.]]
+ [[Handles gesture on given widget.
+
+ \@internal
+ ]]
legacy: null;
params {
@in gesture_info: Elm_Atspi_Gesture_Info;
//
@property parent @protected {
get {
- [[Gets object's accessible parent.]]
+ [[Gets object's accessible parent.
+
+ \@internal
+ ]]
}
set {
- [[Sets object's accessible parent.]]
+ [[Sets object's accessible parent.
+
+ \@internal
+ ]]
}
values {
parent: Elm_Interface_Atspi_Accessible *;
}
@property state_set @protected {
get {
- [[Gets set describing object accessible states.]]
+ [[Gets set describing object accessible states.
+
+ \@internal
+ ]]
}
values {
states: Elm_Atspi_State_Set;
}
//
event_handler_add @class @protected {
- [[Register accessibility event listener]]
+ [[Register accessibility event listener
+
+ \@internal
+ ]]
params {
@in cb: Eo_Event_Cb; [[callback]]
@in data: void*; [[data]]
return: Elm_Atspi_Event_Handler*; [[Event handler]]
}
event_handler_del @class @protected {
- [[Deregister accessibility event listener]]
+ [[Deregister accessibility event listener
+
+ \@internal
+ ]]
params {
@in handler: Elm_Atspi_Event_Handler *; [[Event handler]]
}
}
event_emit @class @protected {
+ [[Emit accessibility event which could occur atspi event
+
+ \@internal
+ ]]
params {
@in accessible: Elm_Interface_Atspi_Accessible *; [[Accessibility object.]]
@in event: const(Eo_Event_Description)*; [[Accessibility event type.]]
]]
return: bool;
params {
- @in type: Elm_Atspi_Relation_Type;
- @in relation_object: const(Elm_Interface_Atspi_Accessible)*;
+ @in type: Elm_Atspi_Relation_Type; [[Relation type between two objects]]
+ @in relation_object: const(Elm_Interface_Atspi_Accessible)*; [[Relation object of source object]]
}
}
relationship_remove {
\@endif
]]
params {
- @in type: Elm_Atspi_Relation_Type;
- @in relation_object: const(Elm_Interface_Atspi_Accessible)*;
+ @in type: Elm_Atspi_Relation_Type; [[Relation type between two objects]]
+ @in relation_object: const(Elm_Interface_Atspi_Accessible)*; [[Relation object of source object]]
}
}
relationships_clear {
- [[Removes all relationships in accessible object.]]
+ [[Removes all relationships in accessible object.
+
+ \@internal
+ ]]
}
//TIZEN_ONLY(20161122): add state_notify api
state_notify @protected {
- [[ Notifies accessibility clients about current state of the
+ [[ Notifies assistive technology clients about current state of the
accessibile object.
Function limits information broadcast to clients to types
if recursive parameter is set, function will traverse all
accessible children and call state_notify function on them.
+
+ \@internal
]]
params {
@in state_types_mask: Elm_Atspi_State_Set;
#define ELM_INTERFACE_ATSPI_ACCESSIBLE_H
/**
- * @defgroup Elm_Accessibility Accessibility
- * @ingroup elm_infra_group
+ * @defgroup Elm_Interface_Atspi_Accessible Atspi Accessible
+ * @ingroup elm_accessibility_group
* @{
*/
//TIZEN_ONLY(20190922): add name callback, description callback.
/**
- * ATSPI reading information callback
+ * This callback type is used to provide accessibility reading information.
+ * @param data The data specified as the last param when setting this callback
+ * @param obj The accessible object specified as the fisrt param when setting
+ * this callback
+ * @return The information to be used by accessibilty client
+ * @see elm_atspi_accessible_name_cb_set
+ * @see elm_atspi_accessible_description_cb_set
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
*/
typedef char *(*Elm_Atspi_Reading_Info_Cb)(void *data, Evas_Object *obj);
//
ELM_ATSPI_GESTURE_THREE_FINGERS_FLICK_UP_RETURN,
ELM_ATSPI_GESTURE_THREE_FINGERS_FLICK_DOWN_RETURN,
};
+/**
+ * Type of gesture that is emitted on assistive technology client side.
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
typedef enum _Elm_Atspi_Gesture_Type Elm_Atspi_Gesture_Type;
enum _Elm_Atspi_Gesture_State
ELM_ATSPI_GESTURE_STATE_END,
ELM_ATSPI_GESTURE_STATE_ABORT,
};
+/**
+ * State of gesture that is emitted on assistive technology client side.
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
typedef enum _Elm_Atspi_Gesture_State Elm_Atspi_Gesture_State;
struct _Elm_Atspi_Gesture_Info
Elm_Atspi_Gesture_State state;
unsigned int event_time;
};
+/**
+ * Detailed information of gesture that is emitted on assistive technology client side.
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
typedef struct _Elm_Atspi_Gesture_Info Elm_Atspi_Gesture_Info;
+/**
+ * This callback type is used to provide accessibility gesture information.
+ * @param data The data specified as the last param when setting this callback
+ * @param obj The accessible object specified as the fisrt param when setting
+ * this callback
+ * @return @c true if application consumes gesutre, @c false if application does
+ * not consume gesture, then assistive technology client consumes gesture
+ * @see elm_atspi_accessible_gesture_cb_set
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
typedef Eina_Bool (*Elm_Atspi_Gesture_Cb)(void *data, Elm_Atspi_Gesture_Info gesture_info, Evas_Object *obj);
//
/**
+ * @internal
* ATSPI event listener
*/
typedef struct _Elm_Atspi_Event_Handler Elm_Atspi_Event_Handler;
/**
+ * @internal
* ATSPI object state set.
*/
typedef uint64_t Elm_Atspi_State_Set;
/*
+ * @internal
* Sets a particilar state type for given state set.
*/
#define STATE_TYPE_SET(state_set, type) (state_set|= ((Elm_Atspi_State_Set)1 << type))
/**
+ * @internal
* Unsets a particilar state type for given state set.
*/
#define STATE_TYPE_UNSET(state_set, type) (state_set &= ~((Elm_Atspi_State_Set)1 << type))
/**
+ * @internal
* Gets value of a particilar state type for given state set.
*/
#define STATE_TYPE_GET(state_set, type) (state_set & ((Elm_Atspi_State_Set)1 << type))
/**
+ * @internal
* @brief Creates atspi state using given type.
*/
#define ATSPI_STATE(type) ((Elm_Atspi_State_Set)1 << (type))
-/**
- * @enum _Elm_Atspi_Role
- * Describes the role of an object visible to AT-SPI Clients.
- */
enum _Elm_Atspi_Role
{
ELM_ATSPI_ROLE_INVALID,
ELM_ATSPI_ROLE_LAST_DEFINED,
};
-typedef enum _Elm_Atspi_Role Elm_Atspi_Role;
-
/**
- * @enum _Elm_Atspi_State_Type
- * Describes a possible states of an object visible to AT-SPI clients.
+ * Describes the role of an object visible to assistive technology client.
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
*/
+typedef enum _Elm_Atspi_Role Elm_Atspi_Role;
+
enum _Elm_Atspi_State_Type
{
ELM_ATSPI_STATE_INVALID,
ELM_ATSPI_STATE_LAST_DEFINED,
};
-typedef enum _Elm_Atspi_State_Type Elm_Atspi_State_Type;
-
/**
- * Elm_Atspi_Relation_Type describes relation between two objects.
+ * Describes a possible states of an object visible to AT-SPI clients.
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
*/
+typedef enum _Elm_Atspi_State_Type Elm_Atspi_State_Type;
+
enum _Elm_Atspi_Relation_Type {
ELM_ATSPI_RELATION_NULL,
ELM_ATSPI_RELATION_LABEL_FOR,
ELM_ATSPI_RELATION_LAST_DEFINED,
};
+/**
+ * Elm_Atspi_Relation_Type describes relation between two objects.
+ * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
+ */
typedef enum _Elm_Atspi_Relation_Type Elm_Atspi_Relation_Type;
struct _Elm_Atspi_Event_State_Changed_Data
typedef struct _Elm_Atspi_Relation Elm_Atspi_Relation;
/**
+ * @internal
* Free Elm_Atspi_Attributes_List
*
* @if MOBILE @since_tizen 3.0
typedef Eina_List *Elm_Atspi_Relation_Set;
/**
+ * @internal
* Frees relation.
*
* @if MOBILE @since_tizen 3.0
EAPI void elm_atspi_relation_free(Elm_Atspi_Relation *relation);
/**
+ * @internal
* Clones relation.
*
* @if MOBILE @since_tizen 3.0
EAPI Elm_Atspi_Relation * elm_atspi_relation_clone(const Elm_Atspi_Relation *relation);
/**
+ * @internal
* Appends relation to relation set
*
* @if MOBILE @since_tizen 3.0
EAPI Eina_Bool elm_atspi_relation_set_relation_append(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj);
/**
+ * @internal
* Removes relation from relation set
*
* @if MOBILE @since_tizen 3.0
EAPI void elm_atspi_relation_set_relation_remove(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type, const Eo *rel_obj);
/**
+ * @internal
* Removes all relation from relation set of a given type
*
* @if MOBILE @since_tizen 3.0
EAPI void elm_atspi_relation_set_relation_type_remove(Elm_Atspi_Relation_Set *set, Elm_Atspi_Relation_Type type);
/**
+ * @internal
* Frees Elm_Atspi_Relation_Set
*
* @if MOBILE @since_tizen 3.0
EAPI void elm_atspi_relation_set_free(Elm_Atspi_Relation_Set *set);
/**
+ * @internal
* Clones Elm_Atspi_Relation_Set
*
* @if MOBILE @since_tizen 3.0
#define elm_interface_atspi_accessible_removed(obj) \
eo_do(ELM_INTERFACE_ATSPI_ACCESSIBLE_MIXIN, elm_interface_atspi_accessible_event_emit(obj, ELM_INTERFACE_ATSPI_ACCESSIBLE_EVENT_REMOVED, NULL));
-/**
- * @defgroup Elm_Interface_Atspi_Accessible Atspi Accessible
- * @ingroup Elm_Accessibility
- *
- * @{
- */
-
#include "elm_interface_atspi_accessible.eo.h"
#endif
#ifndef EFL_NOLEGACY_API_SUPPORT
#include "elm_interface_atspi_accessible.eo.legacy.h"
#endif
-/**
- * @}
- */
-
/**
* @}
*/
#endif
#ifndef EFL_NOLEGACY_API_SUPPORT
#include "elm_interface_atspi_action.eo.legacy.h"
+/**
+ * @defgroup Elm_Interface_Atspi_Component Atspi Component
+ * @ingroup elm_accessibility_group
+ * @{
+ */
#include "elm_interface_atspi_component.eo.legacy.h"
+/**
+ * @}
+ */
#include "elm_interface_atspi_editable_text.eo.legacy.h"
#include "elm_interface_atspi_image.eo.legacy.h"
#include "elm_interface_atspi_selection.eo.legacy.h"
* @ingroup Elementary
* @brief This contains infrastructure modules that facilitate the use of widgets.
*
+ * @defgroup elm_accessibility_group Accessibility
+ * @ingroup elm_infra_group
+ *
* @defgroup elm_container_group Elementary Containers
* @ingroup Elementary
* @brief Elementary is about displaying its widgets in a nice layout, for this
* @param obj The object
* @param part The object's part name to register
*
- * @ingroup General
+ * @ingroup Elm_General
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
projects / platform / upstream / elementary.git / commitdiff