From: Mike Gorse <mgorse@boston.site>
Date: Mon, 23 Jun 2008 21:52:13 +0000 (-0400)
Subject: Add simple nActions property, getDescription, getName, getKeyBinding
X-Git-Tag: AT_SPI2_ATK_2_12_0~670
X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git;a=commitdiff_plain;h=c2973a17703ce93347e496e4c99f651d5c8c3751

Add simple nActions property, getDescription, getName, getKeyBinding
---

diff --git a/atk-adaptor/action.c b/atk-adaptor/action.c
index 9a09c2d..ef801be 100644
--- a/atk-adaptor/action.c
+++ b/atk-adaptor/action.c
@@ -42,6 +42,84 @@ get_action_from_path (const char *path, void *user_data)
   return ATK_ACTION (obj);
 }
 
+static dbus_bool_t
+impl_get_nActions (const char *path, DBusMessageIter *iter, void *user_data)
+{
+  AtkAction *action = get_action_from_path (path, user_data);
+  if (!action)
+    return FALSE;
+  return droute_return_v_int32 (iter, atk_action_get_n_actions (action));
+}
+
+static DBusMessage *
+impl_get_description (DBusConnection *bus, DBusMessage *message, void *user_data)
+{
+  DBusMessage *reply;
+  dbus_int32_t index;
+  const char *desc;
+  AtkAction *action = get_action (message);
+
+  if (!action) return spi_dbus_general_error (message);
+  if (!dbus_message_get_args (message, NULL, DBUS_TYPE_INT32, &index, DBUS_TYPE_INVALID))
+  {
+    return spi_dbus_general_error (message);
+  }
+  desc = atk_action_get_description(action, index);
+  if (!desc) desc = "";
+  reply = dbus_message_new_method_return (message);
+  if (reply)
+  {
+    dbus_message_append_args (reply, DBUS_TYPE_STRING, &desc, DBUS_TYPE_INVALID);
+  }
+  return reply;
+}
+
+static DBusMessage *
+impl_get_name (DBusConnection *bus, DBusMessage *message, void *user_data)
+{
+  DBusMessage *reply;
+  dbus_int32_t index;
+  const char *name;
+  AtkAction *action = get_action (message);
+
+  if (!action) return spi_dbus_general_error (message);
+  if (!dbus_message_get_args (message, NULL, DBUS_TYPE_INT32, &index, DBUS_TYPE_INVALID))
+  {
+    return spi_dbus_general_error (message);
+  }
+  name = atk_action_get_name(action, index);
+  if (!name) name = "";
+  reply = dbus_message_new_method_return (message);
+  if (reply)
+  {
+    dbus_message_append_args (reply, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
+  }
+  return reply;
+}
+
+static DBusMessage *
+impl_get_keybinding (DBusConnection *bus, DBusMessage *message, void *user_data)
+{
+  DBusMessage *reply;
+  dbus_int32_t index;
+  const char *kb;
+  AtkAction *action = get_action (message);
+
+  if (!action) return spi_dbus_general_error (message);
+  if (!dbus_message_get_args (message, NULL, DBUS_TYPE_INT32, &index, DBUS_TYPE_INVALID))
+  {
+    return spi_dbus_general_error (message);
+  }
+  kb = atk_action_get_keybinding(action, index);
+  if (!kb) kb = "";
+  reply = dbus_message_new_method_return (message);
+  if (reply)
+  {
+    dbus_message_append_args (reply, DBUS_TYPE_STRING, &kb, DBUS_TYPE_INVALID);
+  }
+  return reply;
+}
+
 static DBusMessage *impl_getActions(DBusConnection *bus, DBusMessage *message, void *user_data)
 {
   AtkAction *action = get_action(message);
@@ -108,16 +186,25 @@ static DBusMessage *impl_doAction(DBusConnection *bus, DBusMessage *message, voi
 
 DRouteMethod methods[] =
 {
+  { impl_get_description, "getDescription" },
+  { impl_get_name, "getName" },
+  { impl_get_keybinding, "getKeyBinding" },
   {impl_getActions, "getActions"},
   {impl_doAction, "doAction"},
   {NULL, NULL }
 };
 
+static DRouteProperty properties[] =
+{
+  { impl_get_nActions, NULL, "nActions" },
+  { NULL, NULL }
+};
+
 void
 spi_initialize_action (DRouteData * data)
 {
   droute_add_interface (data, SPI_DBUS_INTERFACE_ACTION,
-			methods, NULL,
+			methods, properties,
 			(DRouteGetDatumFunction) get_action_from_path,
 			NULL);
 };
diff --git a/xml/org.freedesktop.atspi.Action.xml b/xml/org.freedesktop.atspi.Action.xml
index 569943a..4d9d1a9 100644
--- a/xml/org.freedesktop.atspi.Action.xml
+++ b/xml/org.freedesktop.atspi.Action.xml
@@ -47,6 +47,46 @@
     </tp:member>
   </tp:struct>
 
+  <tp:property name="nActions" type="i" access="read">
+    <tp:docstring>the number of actions this object supports</tp:docstring>
+  </tp:property>
+
+  <method name="getDescription">
+    <tp:docstring>
+      <p>Get the description for the specified action.  The description of an action may provide information about the result of action invocation, unlike the action name.</p>
+    </tp:docstring>
+    <arg type="i" name="index" direction="in">
+      <tp:docstring>the index of the action</tp:docstring>
+    </arg>
+    <arg type="s" direction="out">
+      <tp:docstring>A string containing the description of the specified action</tp:docstring>
+    </arg>
+  </method>
+
+  <method name="getName">
+    <tp:docstring>
+      <p>Get the name of the specified action.  Action names generally describe the user action, i.e. &quot;click&quot; or &quot;press&quot;, rather than the result of invoking the action.</p>
+    </tp:docstring>
+    <arg type="i" name="index" direction="in">
+      <tp:docstring>the index of the action</tp:docstring>
+    </arg>
+    <arg type="s" direction="out">
+      <tp:docstring>A string containing the name of the specified action</tp:docstring>
+    </arg>
+  </method>
+
+  <method name="getKeyBinding">
+    <tp:docstring>
+      <p>Get the key binding associated with a specific action.</p>
+    </tp:docstring>
+    <arg type="i" name="index" direction="in">
+      <tp:docstring>the index of the action</tp:docstring>
+    </arg>
+    <arg type="s" direction="out">
+      <tp:docstring>A string containing the key binding for the specified action, or an empty string (&quot;&quot;) if none exists.</tp:docstring>
+    </arg>
+  </method>
+
   <method name="getActions">
     <tp:docstring>
       Retrieves the actions associated with the object.