*
*/
-#define ELM_ACCESS_TYPE 0 /* when reading out widget or item
- * this is read first */
-#define ELM_ACCESS_INFO 1 /* next read is info - this is
- * normally label */
-#define ELM_ACCESS_STATE 2 /* if there is a state (eg checkbox)
- * then read state out */
-#define ELM_ACCESS_CONTEXT_INFO 3 /* to give contextual information */
-
-typedef char *(*Elm_Access_Content_Cb)(void *data, Evas_Object *obj);
+enum _Elm_Access_Info_Type
+{
+ ELM_ACCESS_INFO_FIRST = -1,
+ ELM_ACCESS_INFO, /* next read is info - this is
+ * normally label */
+ ELM_ACCESS_TYPE, /* when reading out widget or item
+ * this is read first */
+ ELM_ACCESS_STATE, /* if there is a state (eg checkbox)
+ * then read state out */
+ ELM_ACCESS_CONTEXT_INFO, /* to give contextual information */
+ ELM_ACCESS_INFO_LAST
+};
+
+/**
+ * @typedef Elm_Access_Info_Type
+ */
+typedef enum _Elm_Access_Info_Type Elm_Access_Info_Type;
+
+typedef char *(*Elm_Access_Info_Cb)(void *data, Evas_Object *obj);
typedef void (*Elm_Access_Activate_Cb)(void *data, Evas_Object *part_obj, Elm_Object_Item *item);
/**
+ * @typedef Elm_Access_Action_Cb
+ * User callback to make access object do specific action
+ * @param data user data
+ * @param action_info information to classify the action
+ * Returns EINA_TRUE on success, EINA FALSE otherwise
+ *
+ */
+typedef Eina_Bool (*Elm_Access_Action_Cb)(void *data, Evas_Object *obj, void *action_info);
+
+/**
+ * @enum _Elm_Access_Action_Type
+ * Enum of supported access action types.
+ */
+enum _Elm_Access_Action_Type
+{
+ ELM_ACCESS_ACTION_FIRST = -1,
+
+ ELM_ACCESS_ACTION_HIGHLIGHT, /* highlight an object */
+ ELM_ACCESS_ACTION_UNHIGHLIGHT, /* unhighlight an object */
+ ELM_ACCESS_ACTION_HIGHLIGHT_NEXT, /* set highlight to next object */
+ ELM_ACCESS_ACTION_HIGHLIGHT_PREV, /* set highlight to previous object */
+ ELM_ACCESS_ACTION_ACTIVATE, /* activate a highlight object */
+ ELM_ACCESS_ACTION_VALUE_CHANGE, /* change value of highlight object */
+ ELM_ACCESS_ACTION_SCROLL, /* scroll if one of highlight object parents
+ * is scrollable */
+ ELM_ACCESS_ACTION_BACK, /* go back to a previous view
+ ex: pop naviframe item */
+ ELM_ACCESS_ACTION_READ, /* highlight an object */
+
+ ELM_ACCESS_ACTION_LAST
+};
+
+/**
+ * @typedef Elm_Access_Action_Type
+ */
+typedef enum _Elm_Access_Action_Type Elm_Access_Action_Type;
+
+struct _Elm_Access_Action_Info
+{
+ Evas_Coord x;
+ Evas_Coord y;
+ unsigned int mouse_type; /* 0: mouse down
+ 1: mouse move
+ 2: mouse up */
+
+ Elm_Access_Action_Type action_type;
+ Eina_Bool highlight_cycle : 1;
+};
+
+typedef struct _Elm_Access_Action_Info Elm_Access_Action_Info;
+
+/**
* @brief Register evas object as an accessible object.
* @since 1.8
*
- * @param parent Accessibility parent object. this should be one of widget.
- * @param target Evas object to register as an accessible object.
+ * @param obj The evas object to register as an accessible object.
+ * @param parent The elementary object which is used for creating
+ * accessible object.
*
* @ingroup Access
*/
-EAPI void elm_access_object_register(Evas_Object *parent, Evas_Object *target);
+EAPI Evas_Object *elm_access_object_register(Evas_Object *obj, Evas_Object *parent);
/**
* @brief Unregister accessible object.
* @since 1.8
*
- * @param obj Accessible object.
+ * @param obj The Evas object to unregister accessible object.
*
* @ingroup Access
*/
-EAPI void elm_access_object_unregister(Evas_Object *target);
+EAPI void elm_access_object_unregister(Evas_Object *obj);
+
+/**
+ * @brief Get an accessible object of the evas object.
+ * @since 1.8
+ *
+ * @param obj The evas object.
+ * @return Accessible object of the evas object or NULL for any error
+ *
+ * @ingroup Access
+ */
+EAPI Evas_Object *elm_access_object_get(const Evas_Object *obj);
/**
* @brief Set text to give information for specific type.
* @param type The type of content that will be read
* @param text The text information that will be read
*
- * @see elm_access_content_cb_set
+ * @see elm_access_info_cb_set
* @ingroup Access
*/
-EAPI void elm_access_text_set(Evas_Object *obj, int type, const char *text);
+EAPI void elm_access_info_set(Evas_Object *obj, int type, const char *text);
/**
* @brief Set text to give information for specific type.
* @param obj Accessible object.
* @param type The type of content that will be read
*
- * @see elm_access_content_cb_set
+ * @see elm_access_info_cb_set
* @ingroup Access
*/
-EAPI char * elm_access_text_get(Evas_Object *obj, int type);
+EAPI char *elm_access_info_get(const Evas_Object *obj, int type);
/**
* @brief Set content callback to give information for specific type.
* In the case of button widget, the content of ELM_ACCESS_TYPE would be
* "button". The label of button such as "ok", "cancel" is for ELM_ACCESS_INFO.
* If the button is disabled, content of ELM_ACCESS_STATE would be "disabled".
- * And if there is contextual information, ELM_ACCESS_CONTEXT_INFO is used.
+ * And if there is contextual information, use ELM_ACCESS_CONTEXT_INFO.
*
* @ingroup Access
*/
-EAPI void elm_access_content_cb_set(Evas_Object *obj, int type, Elm_Access_Content_Cb func, const void *data);
+EAPI void elm_access_info_cb_set(Evas_Object *obj, int type, Elm_Access_Info_Cb func, const void *data);
/**
* @brief Set activate callback to activate highlight object.
*/
EAPI void elm_access_activate_cb_set(Evas_Object *obj, Elm_Access_Activate_Cb func, void *data);
+/**
+ * @brief Read out text information directly.
+ * @since 1.8
+ *
+ * @param text The text information that will be read
+ *
+ * This function will not free the @p text internally.
+ *
+ * @ingroup Access
+ */
+EAPI void elm_access_say(const char *text);
+
+/**
+ * @brief Give the highlight to the object directly.
+ * @since 1.8
+ *
+ * @param obj The object that will have the highlight and its information be read.
+ *
+ * The object should be an elementary object or an access object.
+ *
+ * @see elm_access_object_get
+ * @ingroup Access
+ */
+EAPI void elm_access_highlight_set(Evas_Object* obj);
+
+EAPI Eina_Bool elm_access_action(Evas_Object *obj, const Elm_Access_Action_Type type, void *action_info);
+
+EAPI void elm_access_action_cb_set(Evas_Object *obj, const Elm_Access_Action_Type type, const Elm_Access_Action_Cb cb, const void *data);
//TODO: remvoe below - use elm_access_text_set(); or elm_access_cb_set();
EINA_DEPRECATED EAPI void elm_access_external_info_set(Evas_Object *obj, const char *text);
-EINA_DEPRECATED EAPI char * elm_access_external_info_get(const Evas_Object *obj);
+EINA_DEPRECATED EAPI char *elm_access_external_info_get(const Evas_Object *obj);
projects / framework / uifw / elementary.git / blobdiff