summaryrefslogtreecommitdiff
path: root/doc/xml-xcb.txt
diff options
context:
space:
mode:
authorChristian Linhart <chris@demorecorder.com>2017-01-25 10:31:18 +0100
committerChristian Linhart <chris@demorecorder.com>2017-03-11 10:49:27 +0100
commit4aa40fbd5e05833b72327ea37421b09dff246732 (patch)
treed64322ef12b8c29517646e77bc613fb9f366c26e /doc/xml-xcb.txt
parent89b022fdacfe7b39b2122c6ec1a4097767b1ee29 (diff)
add support for eventstruct
eventstruct is a new xml element that allows to use events as part of requests. This is, e.g., needed by the SendExtensionEvent request of the XINPUT extension. Signed-off-by: Christian Linhart <chris@demorecorder.com>
Diffstat (limited to 'doc/xml-xcb.txt')
-rw-r--r--doc/xml-xcb.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/xml-xcb.txt b/doc/xml-xcb.txt
index 9cef1de..f5b9aed 100644
--- a/doc/xml-xcb.txt
+++ b/doc/xml-xcb.txt
@@ -76,6 +76,12 @@ Top-Level Elements
the field and pad elements described in the section "Structure Contents
below".
+<eventstruct name="identifier">event-type-selector list</struct>
+
+ This element represents a data structure that is the wire-representation of
+ an event. The event can be any type that's selected by the
+ event-type-selector list.
+
<xidtype name="identifier" />
This element represents an identifier for a particular type of resource.
@@ -359,6 +365,29 @@ Expressions
This element represents the current list-element when used inside
a list-iteration expression such as <sumof>.
+
+Event-Type-Selector List
+------------------------
+
+ The event-type-selector list selects a set of eventtypes.
+ It consists of any number of the following elements:
+
+ <allowed extension="identifier" xge="boolean"
+ opcode-min="integer" opcode-max="integer" />
+
+ The extension attribute selects events from the given extension.
+
+ If the xge attribute is true, the event is an X Generic Event and
+ will be treated as such.
+
+ opcode-min and opcode-max describe the minimum and maximum opcode
+ respectively. The opcode is the same number as the number-attribute
+ of an event definition. I.e. this is the offset from the event-base
+ to the actual number used on the wire.
+
+ In the current implementation, only xge="false" is supported.
+
+
Documentation
-------------