Renamed SpiAccessibleEventListener to (just) SpiEventListener.

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

diff --git a/cspi/spi_action.c b/cspi/spi_action.c
index 37c50a1..a71e3c2 100644 (file)
--- a/cspi/spi_action.c
+++ b/cspi/spi_action.c
@@ -1,82 +1,139 @@
+/**
+ * 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
-SpiAccessibleAction_ref (
-                      SpiAccessibleAction *obj)
+AccessibleAction_ref (
+                      AccessibleAction *obj)
 {
-  Accessibility_SpiAction_ref (*obj, &ev);
+  Accessibility_Action_ref (*obj, &ev);
   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
-SpiAccessibleAction_unref (SpiAccessibleAction *obj)
+AccessibleAction_unref (AccessibleAction *obj)
 {
-  Accessibility_SpiAction_unref (*obj, &ev);
+  Accessibility_Action_unref (*obj, &ev);
   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
-SpiAccessibleAction_getNSpiActions (SpiAccessibleAction *obj)
+AccessibleAction_getNActions (AccessibleAction *obj)
 {
   return (long)
-    Accessibility_SpiAction__get_nSpiActions (*obj, &ev);
+    Accessibility_Action__get_nActions (*obj, &ev);
 }
 
 
 /**
- * SpiAccessibleAction_getDescription:
- * @obj: a pointer to the #SpiAccessibleAction to query.
+ * AccessibleAction_getDescription:
+ * @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
- *      object implementing #SpiAccessibleAction.
+ * Get the description of '@i-th' action invokable on an
+ *      object implementing #AccessibleAction.
  *
- * Not Yet Implemented.
- *
- * Returns: a UTF-8 string describing the 'i-th' invokable action.
+ * Returns: a UTF-8 string describing the '@i-th' invokable action.
  *
  **/
 char *
-SpiAccessibleAction_getDescription (SpiAccessibleAction *obj,
-                                 long index)
+AccessibleAction_getDescription (AccessibleAction *obj,
+                                 long int i)
 {
   return (char *)
-    Accessibility_SpiAction_getDescription (*obj,
-                                        (CORBA_long) index,
+    Accessibility_Action_getDescription (*obj,
+                                        (CORBA_long) i,
                                         &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 *
-SpiAccessibleAction_getKeyBinding (SpiAccessibleAction *obj,
-                               long index)
+AccessibleAction_getKeyBinding (AccessibleAction *obj,
+                               long int i)
 {
   return (char *) 
-    Accessibility_SpiAction_getKeyBinding (*obj,
-       (CORBA_long) index,
+    Accessibility_Action_getKeyBinding (*obj,
+       (CORBA_long) i,
        &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 *
-SpiAccessibleAction_getName (SpiAccessibleAction *obj,
-                         long index)
+AccessibleAction_getName (AccessibleAction *obj,
+                         long int i)
 {
   return (char *)
-                                  Accessibility_SpiAction_getName (*obj,
-                                                                (CORBA_long) index,
-                                                                &ev);
+   Accessibility_Action_getName (*obj,
+                                (CORBA_long) i,
+                                &ev);
 }
 
 
+/**
+ * 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.
+ *
+ **/
 boolean
-SpiAccessibleAction_doSpiAction (SpiAccessibleAction *obj,
-                           long index)
+AccessibleAction_doAction (AccessibleAction *obj,
+                           long int i)
 {
   return (boolean)
-    Accessibility_SpiAction_doSpiAction (*obj,
-                                  (CORBA_long) index,
+    Accessibility_Action_doAction (*obj,
+                                  (CORBA_long) i,
                                   &ev);
 }