2003-08-19 Padraig O'Briain <padraig.obriain@sun.com>

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

diff --git a/cspi/spi_event.c b/cspi/spi_event.c
index 215fdde..695f1a2 100644 (file)
--- a/cspi/spi_event.c
+++ b/cspi/spi_event.c
@@ -379,13 +379,13 @@ char *
 AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
 /**
  * AccessibleTextSelectionChangedEvent_getSelectionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "object:text-selection-changed", 
  *         returning the newly added, removed, or modified selection string.
@@ -396,13 +396,13 @@ char *
 AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
 /**
  * AccessibleWindowEvent_getTitleString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "window:", 
  *         returning the window title.
@@ -414,13 +414,13 @@ char *
 AccessibleWindowEvent_getTitleString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
 /**
  * AccessibleChildChangedEvent_getChildAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "object:children_changed"
  *         to get a reference to the changed #Accessible.
@@ -441,7 +441,7 @@ AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e)
 
 /**
  * AccessibleParentChangedEvent_getParentAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "object:property-change:accessible-parent"
  *         to get a reference to the changed #Accessible.
@@ -460,7 +460,7 @@ AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e)
 
 /**
  * AccessibleActiveDescendantChangedEvent_getActiveDescendant:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "object:active-descendant-changed"
  *         to get a reference to the changed #Accessible.
@@ -479,7 +479,7 @@ AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEven
 
 /**
  * AccessibleTableSummaryChangedEvent_getSummaryAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "object:property-changed:accessible-table-summary"
  *         to get a reference to the changed #Accessible.
@@ -498,7 +498,7 @@ AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *
 
 /**
  * AccessibleTableHeaderChangedEvent_getHeaderAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type 
  *         "object:property-changed:accessible-table-row-header" or
@@ -532,13 +532,13 @@ char *
 AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
 /**
- * AccessibleTableRowDescriptionEvent_getDescriptionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleTableRowDescriptionChangedEvent_getDescriptionString:
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type 
  *         "object:property-changed:accessible-table-row-description" 
@@ -551,13 +551,13 @@ char *
 AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
 /**
- * AccessibleTableColumnDescriptionEvent_getDescriptionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleTableColumnDescriptionChangedEvent_getDescriptionString:
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type 
  *         "object:property-changed:accessible-table-column-description" 
@@ -570,13 +570,13 @@ char *
 AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
 /**
- * AccessibleDescriptionEvent_getDescriptionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleDescriptionChangedEvent_getDescriptionString:
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type 
  *         "object:property-changed:accessible-description" 
@@ -589,7 +589,7 @@ char *
 AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
 {
   const InternalEvent *foo = (InternalEvent *) e;
-  /* TODO: check the event type? expensive... */
+  /* TODO: check the event type. */
   return cspi_internal_event_get_text (foo);
 }
 
@@ -637,8 +637,8 @@ cspi_internal_event_remove (const InternalEvent *e)
 }
 
 /**
- * AccessibleNameChangedEvent_getNametring:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleNameChangedEvent_getNameString:
+ * @e: a pointer to the #AccessibleEvent being queried.
  *
  * Queries an #AccessibleEvent of type "object:property-change:accessible_name:", 
  *         returning the name.
@@ -653,6 +653,15 @@ AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e)
   return cspi_internal_event_get_text (foo);
 }
 
+/**
+ * AccessibleEvent_ref:
+ * @e: a pointer to the #AccessibleEvent being referenced.
+ *
+ * Increments by 1 the reference count of the event
+ *
+ * Returns: TRUE if the function succeeded; FALSE if the pointer is not a
+ *         valid event.
+ **/
 SPIBoolean
 AccessibleEvent_ref (const AccessibleEvent *e)
 {
@@ -675,6 +684,14 @@ AccessibleEvent_ref (const AccessibleEvent *e)
     return FALSE;
 }
 
+/**
+ * AccessibleEvent_unref:
+ * @e: a pointer to the #AccessibleEvent being referenced.
+ *
+ * Decrements by 1 the reference count of the event. The event is destroyed
+ * when the reference count recahes zero.
+ *
+ **/
 void
 AccessibleEvent_unref (const AccessibleEvent *e)
 {
@@ -687,7 +704,13 @@ AccessibleEvent_unref (const AccessibleEvent *e)
        {
          event->ref_count--;
          if (event->ref_count < 1)
-           cspi_internal_event_remove (event);
+            {
+             cspi_internal_event_remove (event);
+              g_free ((gpointer)e->type);
+              Accessible_unref (e->source);
+              CORBA_free (event->data);
+              g_free ((gpointer)e);
+            }
        }
     }
 }