summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2003-09-04 21:26:12 +0000
committerbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2003-09-04 21:26:12 +0000
commit755b36c42702ce2b82c67c5cf8925c27fbd04ea7 (patch)
treed23f8b544fd8c6b95cfaa3a76e78fa1df9df332d /docs/reference
parent7ea085bcd27327854fafa6cf2eddcbea89b0fde3 (diff)
downloadat-spi2-core-755b36c42702ce2b82c67c5cf8925c27fbd04ea7.tar.gz
Small documentation improvements for key listener API.
git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@542 e2bd861d-eb25-0410-b326-f6ed22b6b98c
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/cspi/tmpl/spi_registry.sgml4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/reference/cspi/tmpl/spi_registry.sgml b/docs/reference/cspi/tmpl/spi_registry.sgml
index c84a2596..5fcd3398 100644
--- a/docs/reference/cspi/tmpl/spi_registry.sgml
+++ b/docs/reference/cspi/tmpl/spi_registry.sgml
@@ -65,6 +65,10 @@ Registry queries
<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: