atspi: Expose API for both Mobile and Wearable 22/125522/2
authorShinwoo Kim <cinoo.kim@samsung.com>
Mon, 17 Apr 2017 02:35:13 +0000 (11:35 +0900)
committerShinwoo Kim <cinoo.kim@samsung.com>
Tue, 18 Apr 2017 02:07:42 +0000 (11:07 +0900)
The exposed API could be used both profile Mobile and Wearable.

Change-Id: I6e61daf3c67a37239681ba6c36ccecad0ee54a6e

src/lib/elm_access.h
src/lib/elm_atspi_bridge.h
src/lib/elm_interface_atspi_accessible.eo
src/lib/elm_interface_atspi_component.eo
src/lib/elm_object.h

index ba97449..57226fa 100644 (file)
@@ -114,13 +114,14 @@ typedef void (*Elm_Access_Activate_Cb)(void *data, Evas_Object *part_obj, Elm_Ob
  * @brief Register evas object as an accessible object.
  * @since 1.8
  *
- * @param obj The 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.
+ * accessible object
  *
  * @ingroup Access
  *
- * @if WEARABLE @since_tizen 3.0
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
 EAPI Evas_Object *elm_access_object_register(Evas_Object *obj, Evas_Object *parent);
@@ -129,11 +130,12 @@ EAPI Evas_Object *elm_access_object_register(Evas_Object *obj, Evas_Object *pare
  * @brief Unregister accessible object.
  * @since 1.8
  *
- * @param obj The Evas object to unregister accessible object.
+ * @param obj The Evas object to unregister accessible object
  *
  * @ingroup Access
  *
- * @if WEARABLE @since_tizen 3.0
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
 EAPI void elm_access_object_unregister(Evas_Object *obj);
@@ -142,12 +144,13 @@ 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.
+ * @param obj The evas object
  * @return Accessible object of the evas object or NULL for any error
  *
  * @ingroup Access
  *
- * @if WEARABLE @since_tizen 3.0
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
 EAPI Evas_Object *elm_access_object_get(const Evas_Object *obj);
index 2ac1c83..f42d028 100644 (file)
@@ -18,7 +18,8 @@ typedef void (*Elm_Atspi_Say_Signal_Cb)(void *data, const char *say_signal);
  *
  * @ingoup Elm_Atspi_Bridge
  *
- * @if WEARABLE @since_tizen 3.0
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
 EAPI void elm_atspi_bridge_utils_say(const char* text,
index 2fc9906..7dd6f58 100644 (file)
@@ -52,13 +52,14 @@ mixin Elm_Interface_Atspi_Accessible ()
          set {
             [[Sets name information callback about widget.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          values {
-            name_cb: Elm_Atspi_Reading_Info_Cb; [[The function called to provide the accessible name.]]
-            data: const(void)*; [[The data passed to \@c name_cb.]]
+            name_cb: Elm_Atspi_Reading_Info_Cb; [[The function called to provide the accessible name]]
+            data: const(void)*; [[The data passed to \@c name_cb]]
          }
       }
       //
@@ -119,12 +120,13 @@ mixin Elm_Interface_Atspi_Accessible ()
       attribute_append {
          [[Add key-value pair identifying widget extra attribute
 
-           \@if WEARABLE \@since_tizen 3.0
+           \@if MOBILE \@since_tizen 3.0
+           \@elseif WEARABLE \@since_tizen 3.0
            \@endif
          ]]
          params {
-            @in key: const(char)*; [[The string key to give extra information.]]
-            @in value: const(char)*; [[The string value to give extra information.]]
+            @in key: const(char)*; [[The string key to give extra information]]
+            @in value: const(char)*; [[The string value to give extra information]]
          }
       }
 
@@ -137,14 +139,16 @@ mixin Elm_Interface_Atspi_Accessible ()
          get {
             [[Gets reading information types of an accessible object.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          set {
             [[Gets reading information of an accessible object.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
@@ -187,13 +191,14 @@ mixin Elm_Interface_Atspi_Accessible ()
          set {
             [[Sets contextual information callback about widget.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          values {
-            description_cb: Elm_Atspi_Reading_Info_Cb; [[The function called to provide the accessible description.]]
-            data: const(void)*; [[The data passed to \@c description_cb.]]
+            description_cb: Elm_Atspi_Reading_Info_Cb; [[The function called to provide the accessible description]]
+            data: const(void)*; [[The data passed to \@c description_cb]]
          }
       }
       //
@@ -202,13 +207,14 @@ mixin Elm_Interface_Atspi_Accessible ()
          set {
             [[Sets gesture callback to give widget.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          values {
-            gesutre_cb: Elm_Atspi_Gesture_Cb;
-            data: const(void)*;
+            gesutre_cb: Elm_Atspi_Gesture_Cb; [[The function called to get gesture information]]
+            data: const(void)*; [[The data passed to \@c description_cb]]
          }
       }
       gesture_do @protected {
@@ -244,19 +250,21 @@ mixin Elm_Interface_Atspi_Accessible ()
          get {
             [[Gets highlightable of given widget.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          set {
             [[Sets highlightable to given widget.
 
-              \@if WEARABLE \@since_tizen 3.0
+              \@if MOBILE \@since_tizen 3.0
+              \@elseif WEARABLE \@since_tizen 3.0
               \@endif
             ]]
          }
          values {
-            can_highlight: bool; [[If \@c true, the object is highlightable.]]
+            can_highlight: bool; [[If \@c true, the object is highlightable]]
          }
       }
       //
index ae7ea76..ddcd7d9 100644 (file)
@@ -105,7 +105,8 @@ mixin Elm_Interface_Atspi_Component ()
          [[ Highlights accessible widget.
          returns true if highlight grab has successed, false otherwise.
 
-           \@if WEARABLE \@since_tizen 3.0
+           \@if MOBILE \@since_tizen 3.0
+           \@elseif WEARABLE \@since_tizen 3.0
            \@endif
          ]]
          //TIZEN_ONLY(20160721): atspi: provide highlight legacy API
@@ -117,7 +118,8 @@ mixin Elm_Interface_Atspi_Component ()
          [[ Clears highlight of accessible widget.
          returns true if clear has successed, false otherwise.
 
-           \@if WEARABLE \@since_tizen 3.0
+           \@if MOBILE \@since_tizen 3.0
+           \@elseif WEARABLE \@since_tizen 3.0
            \@endif
          ]]
          //TIZEN_ONLY(20160721): atspi: provide highlight legacy API
index 03816cf..4a38628 100644 (file)
@@ -623,7 +623,8 @@ EAPI Eina_Bool   elm_object_orientation_mode_disabled_get(const Evas_Object *obj
  *
  * @ingroup General
  *
- * @if WEARABLE @since_tizen 3.0
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
 EAPI Evas_Object *elm_object_part_access_register(Evas_Object *obj, const char *part);
@@ -638,7 +639,8 @@ EAPI Evas_Object *elm_object_part_access_register(Evas_Object *obj, const char *
  *
  * @ingroup General
  *
- * @if WEARABLE @since_tizen 3.0
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
 EAPI Evas_Object *elm_object_part_access_object_get(const Evas_Object *obj, const char *part);