Changes to introspection generation to remove DOCTYPE and XML

[platform/core/uifw/at-spi2-atk.git] / docs / reference / cspi / tmpl / spi_registry.sgml

diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml
index f9cc3f7..458a961 100644 (file)
--- a/docs/reference/cspi/tmpl/spi_registry.sgml
+++ b/docs/reference/cspi/tmpl/spi_registry.sgml
@@ -14,6 +14,9 @@ Registry queries
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### ENUM AccessibleKeySynthType ##### -->
 <para>
 
@@ -49,8 +52,6 @@ Registry queries
 
 @desktop_list: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@list: 
 
 
 <!-- ##### FUNCTION SPI_freeDesktopList ##### -->
@@ -63,7 +64,12 @@ Registry queries
 
 <!-- ##### USER_FUNCTION AccessibleKeystrokeListenerCB ##### -->
 <para>
-
+This is a function which is specified when creating a KeystrokeListener.
+It is called when an event being listened for occurs. 
+If it returns TRUE, this indicates that the event should be consumed 
+rather than passed through; only callbacks whose listeners are
+registered with the SPI_KEYLISTENER_ALL_WINDOWS or 
+SPI_KEYLISTENER_CANCONSUME flags can be consumed.
 </para>
 
 @stroke: 
@@ -73,7 +79,17 @@ Registry queries
 
 <!-- ##### TYPEDEF AccessibleKeyEventMask ##### -->
 <para>
+AccessibleKeyEventMask is a set of types of key events. It is used 
+in SPI_registerAccessibleKeystroketListener to specify the events to be 
+listener for.
+</para>
+
 
+<!-- ##### TYPEDEF AccessibleModifierMaskType ##### -->
+<para>
+AccessibleModifierMaskType is a synonym for AccessibleKeymaskType.
+The defined values for AccessibleModifierMaskType can be found in
+libspi/keymasks.h.
 </para>
 
 
@@ -101,17 +117,10 @@ Registry queries
 
 <!-- ##### TYPEDEF AccessibleKeystroke ##### -->
 <para>
-
-</para>
-
-
-<!-- ##### MACRO SPI_KEYSET_ALL_KEYS ##### -->
-<para>
-
+This is a synonym for AccessibleDeviceEvent.
 </para>
 
 
-
 <!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
 <para>
 
@@ -245,3 +254,100 @@ Registry queries
 @Returns: 
 
 
+<!-- ##### STRUCT AccessibleDeviceEvent ##### -->
+<para>
+AccessibleDeviceEvent is a struct which encapsulates a device event.
+</para>
+
+@keystring: 
+@type: 
+@is_text: 
+
+<!-- ##### TYPEDEF AccessibleDeviceEventMask ##### -->
+<para>
+AccessibleDeviceEventMask is a set of types of key events. It is used 
+in SPI_registerDeviceEventListener to specify the events to be listener for.
+</para>
+
+
+<!-- ##### ENUM AccessibleDeviceEventType ##### -->
+<para>
+
+</para>
+
+@SPI_KEY_PRESSED: 
+@SPI_KEY_RELEASED: 
+@SPI_BUTTON_PRESSED: 
+@SPI_BUTTON_RELEASED: 
+
+<!-- ##### USER_FUNCTION AccessibleDeviceListenerCB ##### -->
+<para>
+This is a function which is specified when creating a DeviceListener.
+It is called when an event being listened for occurs. 
+</para>
+
+@stroke: 
+@user_data: 
+@Returns: 
+
+
+<!-- ##### FUNCTION SPI_createAccessibleDeviceListener ##### -->
+<para>
+
+</para>
+
+@callback: 
+@user_data: 
+@Returns: 
+
+
+<!-- ##### FUNCTION SPI_registerDeviceEventListener ##### -->
+<para>
+
+</para>
+
+@listener: 
+@eventmask: 
+@filter: 
+@Returns: 
+
+
+<!-- ##### FUNCTION SPI_deregisterDeviceEventListener ##### -->
+<para>
+
+</para>
+
+@listener: 
+@filter: 
+@Returns: 
+
+
+<!-- ##### FUNCTION AccessibleDeviceListener_addCallback ##### -->
+<para>
+
+</para>
+
+@listener: 
+@callback: 
+@user_data: 
+@Returns: 
+
+
+<!-- ##### FUNCTION AccessibleDeviceListener_removeCallback ##### -->
+<para>
+
+</para>
+
+@listener: 
+@callback: 
+@Returns: 
+
+
+<!-- ##### FUNCTION AccessibleDeviceListener_unref ##### -->
+<para>
+
+</para>
+
+@listener: 
+
+