Changed IDL for State, Component, and Image to reduce use of out params.

[platform/core/uifw/at-spi2-atk.git] / cspi / spi_action.c

diff --git a/cspi/spi_action.c b/cspi/spi_action.c
index 39546f9..fffb068 100644 (file)
--- a/cspi/spi_action.c
+++ b/cspi/spi_action.c
@@ -1,81 +1,141 @@
+#include <cspi/spi-private.h>
+
+/**
+ * AccessibleAction_ref:
+ * @obj: a pointer to the #AccessibleAction on which to operate.
+ *
+ * Increment the reference count for an #AccessibleAction.
+ *
+ * Returns: 0 (no return code implemented yet).
+ *
+ **/
 int
-AccessibleAction_ref (
-                      AccessibleAction *obj)
+AccessibleAction_ref (AccessibleAction *obj)
 {
-  Accessibility_Action_ref (*obj, &ev);
+  cspi_object_ref (obj);
   return 0;
 }
 
+/**
+ * AccessibleAction_unref:
+ * @obj: a pointer to the #AccessibleAction on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleAction.
+ *
+ * Returns: 0 (no return code implemented yet).
+ *
+ **/
 int
 AccessibleAction_unref (AccessibleAction *obj)
 {
-  Accessibility_Action_unref (*obj, &ev);
+  cspi_object_unref (obj);
   return 0;
 }
 
 
 
+/**
+ * AccessibleAction_getNActions:
+ * @obj: a pointer to the #AccessibleAction to query.
+ *
+ * Get the number of actions invokable on an #AccessibleAction implementor.
+ *
+ * Returns: a #long integer indicatin the number of invokable actions.
+ *
+ **/
 long
 AccessibleAction_getNActions (AccessibleAction *obj)
 {
   return (long)
-    Accessibility_Action__get_nActions (*obj, &ev);
+    Accessibility_Action__get_nActions (CSPI_OBJREF (obj), cspi_ev ());
 }
 
 
 /**
  * AccessibleAction_getDescription:
- * @obj: a pointer to the #AccessibleAction to query.
+ * @obj: a pointer to the #AccessibleAction implementor to query.
+ * @i: a long integer indicating which action to query.
  *
- * Get the description of 'i-th' action invokable on an
+ * Get the description of '@i-th' action invokable on an
  *      object implementing #AccessibleAction.
  *
- * Returns: a UTF-8 string describing the 'i-th' invokable action.
+ * Returns: a UTF-8 string describing the '@i-th' invokable action.
  *
  **/
 char *
 AccessibleAction_getDescription (AccessibleAction *obj,
-                                 long index)
+                                 long int i)
 {
   return (char *)
-    Accessibility_Action_getDescription (*obj,
-                                        (CORBA_long) index,
-                                        &ev);
+    Accessibility_Action_getDescription (CSPI_OBJREF (obj),
+                                        (CORBA_long) i,
+                                        cspi_ev ());
 }
 
-
-
+/**
+ * AccessibleAction_getKeyBinding:
+ * @obj: a pointer to the #AccessibleAction implementor to query.
+ * @i: a long integer indicating which action to query.
+ *
+ * Get the keybindings for the @i-th action invokable on an
+ *      object implementing #AccessibleAction, if any are defined.
+ *
+ * Returns: a UTF-8 string which can be parsed to determine the @i-th
+ *       invokable action's keybindings.
+ *
+ **/
 char *
 AccessibleAction_getKeyBinding (AccessibleAction *obj,
-                               long index)
+                               long int i)
 {
   return (char *) 
-    Accessibility_Action_getKeyBinding (*obj,
-       (CORBA_long) index,
-       &ev);
+    Accessibility_Action_getKeyBinding (CSPI_OBJREF (obj),
+       (CORBA_long) i,
+       cspi_ev ());
 }
 
 
 
+/**
+ * AccessibleAction_getName:
+ * @obj: a pointer to the #AccessibleAction implementor to query.
+ * @i: a long integer indicating which action to query.
+ *
+ * Get the name of the '@i-th' action invokable on an
+ *      object implementing #AccessibleAction.
+ *
+ * Returns: the 'event type' name of the action, as a UTF-8 string.
+ *
+ **/
 char *
 AccessibleAction_getName (AccessibleAction *obj,
-                         long index)
+                         long int i)
 {
   return (char *)
-   Accessibility_Action_getName (*obj,
-                                (CORBA_long) index,
-                                &ev);
+   Accessibility_Action_getName (CSPI_OBJREF (obj),
+                                (CORBA_long) i,
+                                cspi_ev ());
 }
 
 
-boolean
+/**
+ * AccessibleAction_doAction:
+ * @obj: a pointer to the #AccessibleAction to query.
+ * @i: an integer specifying which action to invoke.
+ *
+ * Invoke the action indicated by #index.
+ *
+ * Returns: #TRUE if the action is successfully invoked, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
 AccessibleAction_doAction (AccessibleAction *obj,
-                           long index)
+                           long int i)
 {
-  return (boolean)
-    Accessibility_Action_doAction (*obj,
-                                  (CORBA_long) index,
-                                  &ev);
+  return (SPIBoolean)
+    Accessibility_Action_doAction (CSPI_OBJREF (obj),
+                                  (CORBA_long) i,
+                                  cspi_ev ());
 }