Changed IDL for State, Component, and Image to reduce use of out params.
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_editabletext.c
index fdf8f25..23b973e 100644 (file)
+#include <cspi/spi-private.h>
+
+/**
+ * AccessibleEditableText_ref:
+ * @obj: a pointer to the #AccessibleEditableText object on which to operate.
+ *
+ * Increment the reference count for an #AccessibleEditableText object.
+ *       Since AccessibleEditableText is derived from AccessibleText,
+ *       this is the same as AccessibleText_ref().
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
-SpiAccessibleEditableText_ref (SpiAccessibleEditableText *obj)
+AccessibleEditableText_ref (AccessibleEditableText *obj)
 {
-  Accessibility_SpiEditableText_ref (*obj, &ev);
+  cspi_object_ref (obj);
   return 0;
 }
 
 
 
+/**
+ * AccessibleEditableText_unref:
+ * @obj: a pointer to the #AccessibleEditableText object on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleEdiitableText object.
+ *       Since AccessibleEditableText is derived from AccessibleText,
+ *       this is the same as AccessibleText_unref().
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
-SpiAccessibleEditableText_unref (SpiAccessibleEditableText *obj)
+AccessibleEditableText_unref (AccessibleEditableText *obj)
 {
-  Accessibility_SpiEditableText_unref (*obj, &ev);
+  cspi_object_unref (obj);
   return 0;
 }
 
 
 
-boolean
-SpiAccessibleEditableText_setAttributes (SpiAccessibleEditableText *obj,
-                                        const char *attributes,
-                                        long startPos, long endPos)
+/**
+ * AccessibleEditableText_setAttributes:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @attributes: a character string indicating the attributes to apply to the range,
+ *        delimited by ':'.
+ * @startOffset: a #long indicating the start of the desired text range.
+ * @endOffset: a #long indicating the first character past the desired range.
+ *
+ * Set the attributes applied to a range of text from an #AccessibleEditableText
+ *          object, and the bounds of the range.
+ *
+ * Returns: #TRUE if the operation was successful, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
+                                     const char *attributes,
+                                     long int startPos,
+                                     long int endPos)
 {
-  return (boolean)
-    Accessibility_SpiEditableText_setAttributes (*obj,
-                                                (CORBA_char *) attributes,
-                                                (CORBA_long) startPos, (CORBA_long) endPos, &ev);
+  return (SPIBoolean)
+    Accessibility_EditableText_setAttributes (CSPI_OBJREF (obj),
+                                             (CORBA_char *) attributes,
+                                             (CORBA_long) startPos,
+                                             (CORBA_long) endPos, cspi_ev ());
 }
 
 
 
-void
-SpiAccessibleEditableText_setTextContents (SpiAccessibleEditableText *obj,
+/**
+ * AccessibleEditableText_setTextContents:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @newContents: a character string, encoded in UTF-8, which is to
+ *      become the new text contents of the #AccessibleEditableText object.
+ *
+ * Replace the entire text contents of an #AccessibleEditableText object.
+ *
+ * Returns: #TRUE if the operation was successful, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
                                         const char *newContents)
 {
-  Accessibility_SpiEditableText_setTextContents (*obj,
-                                             (CORBA_char *) newContents, &ev);
+  Accessibility_EditableText_setTextContents (CSPI_OBJREF (obj),
+                                             (CORBA_char *) newContents, cspi_ev ());
+  return TRUE; /* TODO: make bonobo method return a boolean */
 }
 
 
 
-void
-SpiAccessibleEditableText_insertText (SpiAccessibleEditableText *obj,
-                                   long position,
+/**
+ * AccessibleEditableText_insertText:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @position: an integer indicating the character offset at which to insert
+ *       the new text.  
+ * @text: a char* pointer to the text to insert, in UTF-8 encoding.
+ * @length: (frankly I'm not sure this parameter should be here)
+ *
+ * Insert text into an #AccessibleEditableText object.
+ * As with all character offsets, the specified @position may not be the
+ *       same as the resulting byte offset, since the text is in a
+ *       variable-width encoding.
+ *
+ * Returns: #TRUE if the operation was successful, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_insertText (AccessibleEditableText *obj,
+                                   long int position,
                                    char *text,
-                                   long length)
+                                   long int length)
 {
-  Accessibility_SpiEditableText_insertText (*obj,
+  Accessibility_EditableText_insertText (CSPI_OBJREF (obj),
                                         (CORBA_long) position, (CORBA_char *) text,
-                                        (CORBA_long) length, &ev);
+                                        (CORBA_long) length, cspi_ev ());
+  return TRUE;
 }
 
 
 
-void
-SpiAccessibleEditableText_copySpiText (SpiAccessibleText *obj,
-                                 long startPos,
-                                 long endPos)
+/**
+ * AccessibleEditableText_copyText:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @startPos: an integer indicating the starting character offset
+ *       of the text to copy.
+ * @endPos: an integer indicating the offset of the first character
+ *       past the end of the text section to be copied.
+ *
+ * Copy text from an #AccessibleEditableText object into the clipboard.
+ *
+ * @see: AccessibleEditableText_pasteText 
+ *
+ * Returns: #TRUE if the operation was successful, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_copyText (AccessibleText *obj,
+                                 long int startPos,
+                                 long int endPos)
 {
-  Accessibility_SpiEditableText_copySpiText (*obj,
-                                      (CORBA_long) startPos, (CORBA_long) endPos, &ev);
+  Accessibility_EditableText_copyText (CSPI_OBJREF (obj),
+                                      (CORBA_long) startPos, (CORBA_long) endPos, cspi_ev ());
+  return TRUE;
 }
 
 
-
-void
-SpiAccessibleEditableText_cutText (SpiAccessibleEditableText *obj,
-                                long startPos,
-                                long endPos)
+/**
+ * AccessibleEditableText_cutText:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @startPos: an integer indicating the starting character offset
+ *       of the text to cut.
+ * @endPos: an integer indicating the offset of the first character
+ *       past the end of the text section to be cut.
+ *
+ * Delete text from an #AccessibleEditableText object, copying the
+ *       excised portion into the clipboard.
+ *
+ * @see: AccessibleEditableText_pasteText
+ *
+ * Returns: #TRUE if operation was successful, #FALSE otherwise.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_cutText (AccessibleEditableText *obj,
+                                long int startPos,
+                                long int endPos)
 {
-  Accessibility_SpiEditableText_cutText (*obj,
-                                      (CORBA_long) startPos, (CORBA_long) endPos, &ev);
+  Accessibility_EditableText_cutText (CSPI_OBJREF (obj),
+                                      (CORBA_long) startPos, (CORBA_long) endPos, cspi_ev ());
+  return TRUE;
 }
 
 
 
-void
-SpiAccessibleEditableText_deleteText (SpiAccessibleEditableText *obj,
+/**
+ * AccessibleEditableText_deleteText:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @startPos: an integer indicating the starting character offset
+ *       of the text to delete.
+ * @endPos: an integer indicating the offset of the first character
+ *       past the end of the text section to be deleted.
+ *
+ * Delete text from an #AccessibleEditableText object, without copying the
+ *       excised portion into the clipboard.
+ *
+ * @see: AccessibleEditableText_cutText
+ *
+ * Returns: #TRUE if the operation was successful, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_deleteText (AccessibleEditableText *obj,
                                    long startPos,
                                    long endPos)
 {
-  Accessibility_SpiEditableText_deleteText (*obj,
-                                      (CORBA_long) startPos, (CORBA_long) endPos, &ev);
+  Accessibility_EditableText_deleteText (CSPI_OBJREF (obj),
+                                      (CORBA_long) startPos, (CORBA_long) endPos, cspi_ev ());
+  return TRUE;
 }
 
 
 
-void
-SpiAccessibleEditableText_pasteText (SpiAccessibleEditableText *obj,
-                                  long position)
+/**
+ * AccessibleEditableText_pasteText:
+ * @obj: a pointer to the #AccessibleEditableText object to modify.
+ * @position: an integer indicating the character offset at which to insert
+ *       the new text.  
+ *
+ * Insert text from the clipboard into an #AccessibleEditableText object.
+ * As with all character offsets, the specified @position may not be the
+ *       same as the resulting byte offset, since the text is in a
+ *       variable-width encoding.
+ *
+ * Returns: #TRUE if the operation was successful, otherwise #FALSE.
+ *
+ **/
+SPIBoolean
+AccessibleEditableText_pasteText (AccessibleEditableText *obj,
+                                  long int position)
 {
-  Accessibility_SpiEditableText_pasteText (*obj,
-                                       (CORBA_long) position, &ev);
+  Accessibility_EditableText_pasteText (CSPI_OBJREF (obj),
+                                       (CORBA_long) position, cspi_ev ());
+  return TRUE;
 }