Include config.h in private header
[platform/upstream/at-spi2-core.git] / atspi / atspi-action.c
index 3530b10..17b6302 100644 (file)
@@ -52,10 +52,29 @@ atspi_action_get_n_actions (AtspiAction *obj, GError **error)
  *      object implementing #AtspiAction.
  *
  * Returns: a UTF-8 string describing the '@i-th' invocable action.
+ *
+ * Deprecated: 2.10: Use atspi_action_get_action_description instead.
+ * Rename to: atspi_action_get_action_description
  **/
 gchar *
 atspi_action_get_description (AtspiAction *obj, int i, GError **error)
 {
+  return atspi_action_get_action_description (obj, i, error);
+}
+
+/**
+ * atspi_action_get_action_description:
+ * @obj: a pointer to the #AtspiAction implementor to query.
+ * @i: an integer indicating which action to query.
+ *
+ * Get the description of '@i-th' action invocable on an
+ *      object implementing #AtspiAction.
+ *
+ * Returns: a UTF-8 string describing the '@i-th' invocable action.
+ **/
+gchar *
+atspi_action_get_action_description (AtspiAction *obj, int i, GError **error)
+{
   dbus_int32_t d_i = i;
   char *retval = NULL;
 
@@ -89,7 +108,7 @@ atspi_action_get_description (AtspiAction *obj, int i, GError **error)
  *        keybinding string is the "keyboard shortcut" which invokes the 
  *        action without posting any menus. 
  *        Meta-keys are indicated by the conventional strings
- *        "<Control>", "<Alt>", "<Shift>", "<Mod2>",
+ *        "&lt;Control&gt;", "&lt;Alt&gt;", "&lt;Shift&gt;", "&lt;Mod2&gt;",
  *        etc. (we use the same string as gtk_accelerator_name() in 
  *        gtk+-2.X.
  *
@@ -117,11 +136,30 @@ atspi_action_get_key_binding (AtspiAction *obj, gint i, GError **error)
  * Get the name of the '@i-th' action invocable on an
  *      object implementing #AtspiAction.
  *
- * Returns: the 'event type' name of the action, as a UTF-8 string.
+ * Returns: the non-localized name of the action, as a UTF-8 string.
+ *
+ * Deprecated: 2.10: Use atspi_action_get_action_name instead.
+ * Rename to: atspi_action_get_action_name
  **/
 gchar *
 atspi_action_get_name (AtspiAction *obj, gint i, GError **error)
 {
+  return atspi_action_get_action_name (obj, i, error);
+}
+
+/**
+ * atspi_action_get_action_name:
+ * @obj: a pointer to the #AtspiAction implementor to query.
+ * @i: an integer indicating which action to query.
+ *
+ * Get the name of the '@i-th' action invocable on an
+ *      object implementing #AtspiAction.
+ *
+ * Returns: the non-localized name of the action, as a UTF-8 string.
+ **/
+gchar *
+atspi_action_get_action_name (AtspiAction *obj, gint i, GError **error)
+{
   dbus_int32_t d_i = i;
   char *retval = NULL;
 
@@ -133,6 +171,30 @@ atspi_action_get_name (AtspiAction *obj, gint i, GError **error)
 }
 
 /**
+ * atspi_action_get_localized_name:
+ * @obj: a pointer to the #AtspiAction implementor to query.
+ * @i: an integer indicating which action to query.
+ *
+ * Get the name of the '@i-th' action invocable on an
+ *      object implementing #AtspiAction.
+ *
+ * Returns: the name of the action, as a UTF-8 string.
+ **/
+gchar *
+atspi_action_get_localized_name (AtspiAction *obj, gint i, GError **error)
+{
+  dbus_int32_t d_i = i;
+  char *retval = NULL;
+
+  g_return_val_if_fail (obj != NULL, NULL);
+
+  _atspi_dbus_call (obj, atspi_interface_action, "GetLocalizedName", error,
+                    "i=>s", d_i, &retval);
+
+  return retval;
+}
+
+/**
  * atspi_action_do_action:
  * @obj: a pointer to the #AtspiAction to query.
  * @i: an integer specifying which action to invoke.