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 7c74b06..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>
 
@@ -23,8 +26,9 @@ Registry queries
 @SPI_KEY_RELEASE: 
 @SPI_KEY_PRESSRELEASE: 
 @SPI_KEY_SYM: 
+@SPI_KEY_STRING: 
 
-<!-- ##### FUNCTION getDesktopCount ##### -->
+<!-- ##### FUNCTION SPI_getDesktopCount ##### -->
 <para>
 
 </para>
@@ -32,7 +36,7 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION getDesktop ##### -->
+<!-- ##### FUNCTION SPI_getDesktop ##### -->
 <para>
 
 </para>
@@ -41,20 +45,33 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION getDesktopList ##### -->
+<!-- ##### FUNCTION SPI_getDesktopList ##### -->
 <para>
 
 </para>
 
-@list: 
+@desktop_list: 
 @Returns: 
 
 
-<!-- ##### USER_FUNCTION AccessibleKeystrokeListenerCB ##### -->
+<!-- ##### FUNCTION SPI_freeDesktopList ##### -->
 <para>
 
 </para>
 
+@desktop_list: 
+
+
+<!-- ##### 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: 
 @user_data: 
 @Returns: 
@@ -62,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>
 
 
@@ -72,13 +99,11 @@ Registry queries
 </para>
 
 
-<!-- ##### ENUM AccessibleKeyEventType ##### -->
+<!-- ##### TYPEDEF AccessibleKeyEventType ##### -->
 <para>
 
 </para>
 
-@SPI_KEY_PRESSED: 
-@SPI_KEY_RELEASED: 
 
 <!-- ##### ENUM AccessibleKeyListenerSyncType ##### -->
 <para>
@@ -90,7 +115,33 @@ Registry queries
 @SPI_KEYLISTENER_CANCONSUME: 
 @SPI_KEYLISTENER_ALL_WINDOWS: 
 
-<!-- ##### FUNCTION createAccessibleKeystrokeListener ##### -->
+<!-- ##### TYPEDEF AccessibleKeystroke ##### -->
+<para>
+This is a synonym for AccessibleDeviceEvent.
+</para>
+
+
+<!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
+<para>
+
+</para>
+
+@len: 
+@keysyms: 
+@keycodes: 
+@keystrings: 
+@Returns: 
+
+
+<!-- ##### FUNCTION SPI_freeAccessibleKeySet ##### -->
+<para>
+
+</para>
+
+@keyset: 
+
+
+<!-- ##### FUNCTION SPI_createAccessibleKeystrokeListener ##### -->
 <para>
 
 </para>
@@ -100,7 +151,7 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION registerGlobalEventListener ##### -->
+<!-- ##### FUNCTION SPI_registerGlobalEventListener ##### -->
 <para>
 
 </para>
@@ -110,7 +161,7 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION deregisterGlobalEventListener ##### -->
+<!-- ##### FUNCTION SPI_deregisterGlobalEventListener ##### -->
 <para>
 
 </para>
@@ -120,7 +171,7 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION deregisterGlobalEventListenerAll ##### -->
+<!-- ##### FUNCTION SPI_deregisterGlobalEventListenerAll ##### -->
 <para>
 
 </para>
@@ -129,7 +180,7 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION registerAccessibleKeystrokeListener ##### -->
+<!-- ##### FUNCTION SPI_registerAccessibleKeystrokeListener ##### -->
 <para>
 
 </para>
@@ -139,15 +190,25 @@ Registry queries
 @modmask: 
 @eventmask: 
 @sync_type: 
+@Returns: 
 
 
-<!-- ##### FUNCTION deregisterAccessibleKeystrokeListener ##### -->
+<!-- ##### FUNCTION SPI_deregisterAccessibleKeystrokeListener ##### -->
 <para>
 
 </para>
 
 @listener: 
 @modmask: 
+@Returns: 
+
+
+<!-- ##### FUNCTION AccessibleKeystrokeListener_unref ##### -->
+<para>
+
+</para>
+
+@listener: 
 
 
 <!-- ##### FUNCTION AccessibleKeystrokeListener_removeCallback ##### -->
@@ -171,16 +232,18 @@ Registry queries
 @Returns: 
 
 
-<!-- ##### FUNCTION generateKeyEvent ##### -->
+<!-- ##### FUNCTION SPI_generateKeyboardEvent ##### -->
 <para>
 
 </para>
 
 @keyval: 
+@keystring: 
 @synth_type: 
+@Returns: 
 
 
-<!-- ##### FUNCTION generateMouseEvent ##### -->
+<!-- ##### FUNCTION SPI_generateMouseEvent ##### -->
 <para>
 
 </para>
@@ -188,5 +251,103 @@ Registry queries
 @x: 
 @y: 
 @name: 
+@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: