X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=cspi%2Fspi_selection.c;h=dd663ee96203e84cb556e104c26c0a9383a73084;hb=2b8f4365c549962de1f20418ca00dd503d6e28bc;hp=dbef7ef835bd99d5359fce80ee59da0819cf8e94;hpb=7ff7c0d0b863f7346f21e03b6d170e8c7c6f9878;p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git

diff --git a/cspi/spi_selection.c b/cspi/spi_selection.c
index dbef7ef..dd663ee 100644
--- a/cspi/spi_selection.c
+++ b/cspi/spi_selection.c
@@ -1,86 +1,192 @@
+#include <cspi/spi-private.h>
+
+/**
+ * AccessibleSelection_ref:
+ * @obj: a pointer to the #AccessibleSelection implementor on which to operate.
+ *
+ * Increment the reference count for an #AccessibleSelection object.
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleSelection_ref (AccessibleSelection *obj)
 {
-  Accessibility_Selection_ref (*obj, &ev);
+  cspi_object_ref (obj);
   return 0;
 }
 
 
-
+/**
+ * AccessibleSelection_unref:
+ * @obj: a pointer to the #AccessibleSelection implementor on which to operate. 
+ *
+ * Decrement the reference count for an #Accessible object.
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleSelection_unref (AccessibleSelection *obj)
 {
-  Accessibility_Selection_unref (*obj, &ev);
+  cspi_object_unref (obj);
   return 0;
 }
 
 
 
+/**
+ * AccessibleSelection_getNSelectedChildren:
+ * @obj: a pointer to the #AccessibleSelection implementor on which to operate.
+ *
+ * Get the number of children of an #AccessibleSelection implementor which are
+ *        currently selected.
+ *
+ * Returns: a #long indicating the number of #Accessible children
+ *        of the #AccessibleSelection implementor which are currently selected.
+ *
+ **/
 long
 AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj)
 {
   return (long)
-    Accessibility_Selection__get_nSelectedChildren (*obj, &ev);
+    Accessibility_Selection__get_nSelectedChildren (CSPI_OBJREF (obj), cspi_ev ());
 }
 
 
-
+/**
+ * AccessibleSelection_getSelectedChild:
+ * @obj: a pointer to the #AccessibleSelection on which to operate.
+ * @selectedChildIndex: a #long indicating which of the selected
+ *      children is specified.
+ *
+ * Get the i-th selected #Accessible child of an #AccessibleSelection.
+ *      Note that @childIndex refers to the index in the list of 'selected'
+ *      children and generally differs from that used in
+ *      #Accessible_getChildAtIndex() or returned by
+ *      #Accessible_getIndexInParent(). @selectedChildIndex must lie between 0
+ *      and #AccessibleSelection_getNSelectedChildren()-1, inclusive.
+ *
+ * Returns: a pointer to a selected #Accessible child object,
+ *          specified by @childIndex.
+ *
+ **/
 Accessible *
 AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
-                                      long selectedChildIndex)
+                                      long int selectedChildIndex)
 {
   Accessibility_Accessible child = 
-    Accessibility_Selection_getSelectedChild (*obj,
-					      (CORBA_long) selectedChildIndex, &ev);
-  spi_warn_ev (&ev, "getSelectedChild");
+    Accessibility_Selection_getSelectedChild (CSPI_OBJREF (obj),
+					      (CORBA_long) selectedChildIndex, cspi_ev ());
+  cspi_warn_ev (cspi_ev (), "getSelectedChild");
 
-  return (Accessible *) ((CORBA_Object_is_nil (child, &ev)) ? NULL : Obj_Add (child));
+  return (Accessible *) cspi_object_add (child);
 }
 
-boolean
+/**
+ * AccessibleSelection_selectChild:
+ * @obj: a pointer to the #AccessibleSelection on which to operate.
+ * @childIndex: a #long indicating which child of the #Accessible
+ *              is to be selected.
+ *
+ * Add a child to the selected children list of an #AccessibleSelection.
+ *         For #AccessibleSelection implementors that only allow
+ *         single selections, this may replace the (single) current
+ *         selection.
+ *
+ * Returns: #TRUE if the child was successfully selected, #FALSE otherwise.
+ *
+ **/
+SPIBoolean
 AccessibleSelection_selectChild (AccessibleSelection *obj,
-                                 long childIndex)
+                                 long int childIndex)
 {
-  return (boolean)
-    Accessibility_Selection_selectChild (*obj,
-					 (CORBA_long) childIndex, &ev);
+  return (SPIBoolean)
+    Accessibility_Selection_selectChild (CSPI_OBJREF (obj),
+					 (CORBA_long) childIndex, cspi_ev ());
 }
 
 
-
-boolean
+/**
+ * AccessibleSelection_deselectSelectedChild:
+ * @obj: a pointer to the #AccessibleSelection on which to operate.
+ * @selectedChildIndex: a #long indicating which of the selected children
+ *              of the #Accessible is to be selected.
+ *
+ * Remove a child to the selected children list of an #AccessibleSelection.
+ *          Note that @childIndex is the index in the selected-children list,
+ *          not the index in the parent container.  @selectedChildIndex in this
+ *          method, and @childIndex in #AccessibleSelection_selectChild
+ *          are asymmettric.
+ *
+ * Returns: #TRUE if the child was successfully deselected, #FALSE otherwise.
+ *
+ **/
+SPIBoolean
 AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
-                                           long selectedChildIndex)
+                                           long int selectedChildIndex)
 {
-  Accessibility_Selection_deselectSelectedChild (*obj,
-						 (CORBA_long) selectedChildIndex, &ev);
+  return Accessibility_Selection_deselectSelectedChild (
+	  CSPI_OBJREF (obj), (CORBA_long) selectedChildIndex, cspi_ev ());
 }
 
 
 
-boolean
+/**
+ * AccessibleSelection_isChildSelected:
+ * @obj: a pointer to the #AccessibleSelection implementor on which to operate.
+ * @childIndex: an index into the #AccessibleSelection's list of children.
+ *
+ * Determine whether a particular child of an #AccessibleSelection implementor
+ *        is currently selected.  Note that @childIndex is the index into the
+ *        standard #Accessible container's list of children.
+ *
+ * Returns: #TRUE if the specified child is currently selected,
+ *          #FALSE otherwise.
+ *
+ **/
+SPIBoolean
 AccessibleSelection_isChildSelected (AccessibleSelection *obj,
-                                     long childIndex)
+                                     long int childIndex)
 {
-  return (boolean)
-    Accessibility_Selection_isChildSelected (*obj,
-					     (CORBA_long) childIndex, &ev);
+  return (SPIBoolean)
+    Accessibility_Selection_isChildSelected (CSPI_OBJREF (obj),
+					     (CORBA_long) childIndex, cspi_ev ());
 }
 
 
 
-void
+/**
+ * AccessibleSelection_selectAll:
+ * @obj: a pointer to the #AccessibleSelection implementor on which to operate.
+ *
+ * Attempt to select all of the children of an #AccessibleSelection implementor.
+ * Not all #AccessibleSelection implementors support this operation.
+ *
+ * Returns: #TRUE if successful, #FALSE otherwise.
+ *
+ **/
+SPIBoolean
 AccessibleSelection_selectAll (AccessibleSelection *obj)
 {
-  Accessibility_Selection_selectAll (*obj, &ev);
+  Accessibility_Selection_selectAll (CSPI_OBJREF (obj), cspi_ev ());
+  return TRUE; /* TODO: change the bonobo method to return boolean */
 }
 
 
 
+/**
+ * AccessibleSelection_clearSelection:
+ * @obj: a pointer to the #AccessibleSelection implementor on which to operate.
+ *
+ * Clear the current selection, removing all selected children from the
+ *       specified #AccessibleSelection implementor's selection list.
+ *
+ **/
 void
 AccessibleSelection_clearSelection (AccessibleSelection *obj)
 {
-  Accessibility_Selection_clearSelection (*obj, &ev);
+  Accessibility_Selection_clearSelection (CSPI_OBJREF (obj), cspi_ev ());
 }