diff options
Diffstat (limited to 'specs')
| -rw-r--r-- | specs/SIAddresses/.gitignore | 4 | ||||
| -rw-r--r-- | specs/SIAddresses/IPv6.txt | 11 | ||||
| -rw-r--r-- | specs/SIAddresses/Makefile.am | 6 | ||||
| -rw-r--r-- | specs/SIAddresses/README | 4 | ||||
| -rw-r--r-- | specs/SIAddresses/hostname.txt | 11 | ||||
| -rw-r--r-- | specs/SIAddresses/localuser.txt | 20 | ||||
| -rw-r--r-- | specs/XI2proto.txt | 2715 | ||||
| -rw-r--r-- | specs/XIproto.txt | 2576 | ||||
| -rw-r--r-- | specs/bigreq.xml | 332 | ||||
| -rw-r--r-- | specs/encoding.xml | 3268 | ||||
| -rw-r--r-- | specs/fsproto.xml | 4417 | ||||
| -rw-r--r-- | specs/glossary.xml | 1320 | ||||
| -rw-r--r-- | specs/keysyms.xml | 6050 | ||||
| -rw-r--r-- | specs/sect1-9.xml | 15309 | ||||
| -rw-r--r-- | specs/x11protocol.xml | 64 |
15 files changed, 36107 insertions, 0 deletions
diff --git a/specs/SIAddresses/.gitignore b/specs/SIAddresses/.gitignore new file mode 100644 index 0000000..a50f54b --- /dev/null +++ b/specs/SIAddresses/.gitignore @@ -0,0 +1,4 @@ +# Override *.txt from toplevel .gitignore +!hostname.txt +!IPv6.txt +!localuser.txt diff --git a/specs/SIAddresses/IPv6.txt b/specs/SIAddresses/IPv6.txt new file mode 100644 index 0000000..4b69a99 --- /dev/null +++ b/specs/SIAddresses/IPv6.txt @@ -0,0 +1,11 @@ +ServerInterpreted address definition for type "IPv6": + +The X.org Architecture Task Force reserves the ServerInterpreted +address type of "IPv6" for use with IPv6 literal address formats. +The syntax for the value will be defined as specified in RFC 3513 +and the IETF RFC to be published based on the current draft at +http://www.ietf.org/internet-drafts/draft-ietf-ipv6-scoping-arch-00.txt +This address type specification will be formally issued once the +IETF IPv6 Working Group issues the corresponding RFC. + +Version 0.9, March 2004 diff --git a/specs/SIAddresses/Makefile.am b/specs/SIAddresses/Makefile.am new file mode 100644 index 0000000..662776a --- /dev/null +++ b/specs/SIAddresses/Makefile.am @@ -0,0 +1,6 @@ +dist_noinst_DATA = \ + hostname.txt \ + IPv6.txt \ + localuser.txt \ + README + diff --git a/specs/SIAddresses/README b/specs/SIAddresses/README new file mode 100644 index 0000000..8858529 --- /dev/null +++ b/specs/SIAddresses/README @@ -0,0 +1,4 @@ +This directory contains the specifications of address types for the +ServerInterpreted address family used in the ChangeHost and ListHosts +requests in the X11 Protocol. See Chapter 9 of the X11 Protocol spec +for more information. diff --git a/specs/SIAddresses/hostname.txt b/specs/SIAddresses/hostname.txt new file mode 100644 index 0000000..64023d7 --- /dev/null +++ b/specs/SIAddresses/hostname.txt @@ -0,0 +1,11 @@ +ServerInterpreted address definition for type "hostname": + +A ServerInterpreted address with type "hostname" shall have a value +representing a hostname as defined in IETF RFC 2396. Due to Mobile IP +and dynamic DNS, the name service should be consulted at connection +authentication time. Clients supporting Internationalized Domain +Names must convert to ASCII Compatible Encoding as specified in the +relevant IETF RFC's before use in the X11 protocol. Note that this +definition of hostname does not allow use of literal IP addresses. + +Version 1.0, March 2004 diff --git a/specs/SIAddresses/localuser.txt b/specs/SIAddresses/localuser.txt new file mode 100644 index 0000000..e67ff01 --- /dev/null +++ b/specs/SIAddresses/localuser.txt @@ -0,0 +1,20 @@ +Server-interpreted Authentication Types "localuser" and "localgroup": + +On systems which can determine in a secure fashion the credentials of a client +process, the "localuser" and "localgroup" authentication methods provide access +based on those credentials. The format of the values provided is platform +specific. For POSIX & UNIX platforms, if the value starts with the character +'#', the rest of the string shall be treated as a decimal uid or gid, otherwise +the string is defined as a user name or group name. + +Systems offering this MUST not simply trust a user supplied value (such as an +environment variable or IDENT protocol response). It is expected many systems +will only support this for clients running on the same host using a local IPC +transport. + +Examples: + xhost +SI:localuser:alanc + xhost +SI:localuser:#1234 + xhost +SI:localgroup:wheel + xhost +SI:localgroup:#0 + diff --git a/specs/XI2proto.txt b/specs/XI2proto.txt new file mode 100644 index 0000000..697dd89 --- /dev/null +++ b/specs/XI2proto.txt @@ -0,0 +1,2715 @@ +The X Input Extension 2.x +========================= +:toclevels: 3 +:toc: +:numbered: + +Authors: + +- Peter Hutterer (Red Hat) <peter.hutterer@redhat.com> +- Daniel Stone (Collabora Ltd.) <daniel@fooishbar.org> +- Chase Douglas (Canonical, Ltd.) <chase.douglas@canonical.com> + +[[history]] +History +------- + +- v2.3, December 2012: Pointer barrier events added +- v2.2, March 2012: Multitouch support added +- v2.1, December 2011: new raw event behaviour, smooth scrolling support + added +- v2.0, October 2009: Initial release of XI2 protocol + +[[intro-xi20]] +Introduction +------------ + +The X Input Extension version 2.0 (XI2) is the second major release of the X +Input Extension. + +XI2 provides a number of enhancements over version 1.5, including: + +- use of XGE and GenericEvents. GenericEvents are of flexible length with a + minimum length of 32 bytes. +- explicit device hierarchy of master and slave devices. See Section +<<hierarchy,The Master/Slave device hierarchy>>. +- use of multiple independent master devices (Multi-Pointer X or MPX). +- the ability for devices to change capabilities at runtime. +- raw device events + +XI2's intent is to replace both core input processing and prior versions of +the X Input Extension. Historically, the majority of applications employed the +core protocol requests and events to handle user input. The core protocol does +not provide information about which device generated the event. The X Input +Extension version up to 1.5 requires the differentiation between core and +extended devices. Extended devices may not be core devices and thus cannot be +used on applications employing the core protocol. XI2 addresses both of these +issues by enabling devices to be both extended and core devices and providing +device information in each event (with the exception of core events). + +Changes in version 2.1 +---------------------- + +- RawEvents are sent regardless of the grab state. +- Addition of the ScrollClass for smooth scrolling + +Changes in version 2.2 +---------------------- + +- Multitouch support added + +Changes in version 2.3 +---------------------- + +- Pointer barrier events added + +// ❧❧❧❧❧❧❧❧❧❧❧ + +Notations used in this document +------------------------------- + +Notation for requests: + + ┌─── + Name of request + name of request field: type of request field + name of request field: type of request field + ▶ + name of reply field: type of reply field + └─── + +Notation for events: + + ┌─── + Name of event + name of field: type of field + name of field: type of field + └─── + +Complex fields are specified in the following notation: + + name of field: COMPLEXFIELDTYPE + +or, if multiple of these fields exist: + + name of field: LISTofCOMPLEXFIELDTYPE + + COMPLEXFIELDTYPE: { name of subfield: type of subfield, + name of subfield: type of subfield } + +// ❧❧❧❧❧❧❧❧❧❧❧ + +Interoperability between version 1.x and 2.0 +-------------------------------------------- + +There is little interaction between 1.x and 2.x versions of the X Input +Extension. Clients are requested to avoid mixing XI1.x and XI2 code as much as +possible. Several direct incompatibilities are observable: + +[[interop-xi1-limitations]] +Limitations resulting from different variable ranges +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +XI2 provides a larger range for some fields than XI1. As a result, XI1 clients +may not receive data an XI2 client receives. +These fields include: + +- devices with a deviceid of greater than 127 are invisible to XI1 clients. +- key events and key grabs featuring larger than 255 can only be sent to XI2 + clients. +- no subpixel information is available to XI1 clients. If motion events are in + a subpixel range only, the server may omit these events and an XI 1.x client + will not receive events until the pixel boundary is crossed. + + +[[interop-xi1-grabs]] +Blocking of grabs +~~~~~~~~~~~~~~~~~ + +XI1 grabs are different to XI2 grab and a device may not be grabbed through an +XI2 grab if an XI1 grab is currently active on this device or vice versa. +Likewise, a keycode or button already grabbed by an XI 1.x or XI2 client may +not be grabbed with the same modifier combination by an XI2 or XI 1.x client, +respectively. + +[[interop-xi1-device-list]] +Invisibility of Master Devices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +XI 1.x was not designed with support for multiple master devices. As a +result, only the first master pointer and master keyboard are visible to XI +1.x clients; all other master devices are invisible and cannot be accessed +from XI 1.x calls. + +Smooth scrolling +~~~~~~~~~~~~~~~~ + +Historically, X implemented scrolling events by using button press events: +button 4 was one “click” of the scroll wheel upwards, button 5 was downwards, +button 6 was one unit of scrolling left, and button 7 was one unit of scrolling +right. This is insufficient for e.g. touchpads which are able to provide +scrolling events through multi-finger drag gestures, or simply dragging your +finger along a designated strip along the side of the touchpad. + +Newer X servers may provide scrolling information through valuators to +provide clients with more precision than the legacy button events. This +scrolling information is part of the valuator data in device events. +Scrolling events do not have a specific event type. + +Valuators for axes sending scrolling information must have one +ScrollClass for each scrolling axis. If scrolling valuators are present on a +device, the server must provide two-way emulation between these valuators +and the legacy button events for each delta unit of scrolling. + +One unit of scrolling in either direction is considered to be equivalent to +one button event, e.g. for a unit size of 1.0, -2.0 on an valuator type +Vertical sends two button press/release events for button 4. Likewise, a +button press event for button 7 generates an event on the Horizontal +valuator with a value of +1.0. The server may accumulate deltas of less than +one unit of scrolling. + +Any server providing this behaviour marks emulated button or valuator events +with the XIPointerEmulated flag for DeviceEvents, and the XIRawEmulated flag +for raw events, to hint at applications which event is a hardware event. + +If more than one scroll valuator of the same type is present on a device, +the valuator marked with Preferred for the same scroll direction is used to +convert legacy button events into scroll valuator events. If no valuator is +marked Preferred or more than one valuator is marked with Preferred for this +scroll direction, this should be considered a driver bug and the behaviour +is implementation-dependent. + +[[hierarchy]] +The Master/Slave device hierarchy +--------------------------------- + +XI2 introduces a device hierarchy split up into so-called Master Devices (MD) +and Slave Devices (SD). + +[[hierarchy-master]] +Master devices +~~~~~~~~~~~~~~ +An MD is a virtual device created and managed by the server. MDs may send core +events and XI events. However, an MD does not represent a physical device and +relies on SDs for event generation. MDs come in two forms: as master pointers +or as master keyboards. A master pointer is represented by a visible cursor on +the screen. A master keyboard is represented by a keyboard focus. + +Each master pointer is paired with the respective master keyboard and vice +versa, and this pairing is constant for the lifetime of both input devices. +Clients can use this pairing behaviour to implement input paradigms that +require pointer and keyboard interation (e.g. SHIFT + Click). + +[[hierarchy-slave]] +Slave devices +~~~~~~~~~~~~~ +An SD is usually a physical device configured in the server. SDs are not +represented by a cursor or keyboard focus and may be attached to a master +pointer or master keyboard. SDs can only be attached to any master of the same +type (e.g. a physical pointer device can be attached to any master pointer). + +If an event is generated by an SD + +- if the SD is attached to a master pointer, it changes the position and/or + button state of the master pointer. +- if the SD has a keyboard focus other than None, the key event is sent to + the focus window. +- if the SD is attached to a master keyboard, it sends events to this + keyboard's focus window (if applicable) and/or changes the modifier state of + this keyboard. +- if the SD is not attached to an MD ("floating"), it does not change + any master device. The SD has its own (invisible) sprite and its own focus. + Both the sprite and the focus must be managed explicitly by the client + program. + +Note: the keyboard focus of an attached slave device is independent to that +of the master device. Two keyboard events are generated, once with deviceid +and sourceid set to the slave device. This keyboard event is sent to the +slave device's focus window. The second event has a deviceid of the master +and a sourceid of the slave device. This second event is delivered to the +master keyboard's focus window. + +[[hierarchy-dcce]] +Event processing for attached slave devices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Whenever an SD changes its logical state, + +- the event is delivered as an XI event to any interested clients. If the + device is floating, event processing stops. + Otherwise, if the device is attached, +- the master device changes its classes to reflect the SD's capabilities. All + interested clients are notified of this device change. +- then, the event is delivered as an XI event from the MD to any interested + clients. If the event has been delivered, event processing stops. + Otherwise, +- the event is delivered as a core event to any interested clients. + +Given that W is the event window, and P the parent window of W, event delivery +to P is only attempted if neither the XI event, nor the core event has been +delivered on W. Once an event has been delivered as either XI or core event, +event processing stops. + +[[clientpointer]] +The ClientPointer principle +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Many core protocol and some extension requests are ambiguous when multiple +master devices are available (e.g. QueryPointer does not specify which pointer). +The X server does not have the knowledge to chose the contextually correct +master device. For each client, one master pointer is designated as this +clients's "ClientPointer". Whenever a client sends an ambiguous request (e.g. +QueryPointer), the ClientPointer or the keyboard paired with the ClientPointer +is chosen to provide the data for this request. + +This ClientPointer may be explicitly assigned to a client with the +SetClientPointer call. If no ClientPointer is set when a client issues an +ambiguous request, the server choses one device as the ClientPointer. The +method of chosing a ClientPointer from the available master pointers is +implementation-specific. + +If the master pointer currently set as ClientPointer for one or more clients is +removed, the server may either unset the ClientPointer setting or change the +ClientPointer to a different master pointer. + +[[multitouch]] +Touch device support +-------------------- + +XI 2.2 introduces support for multi-touch devices. The traditional +pointer/keyboard approach enforced by XI 2.0 with the master/slave device +hierarchy is not always suitable for multi-touch devices that can provide a +dynamic number of touchpoints per physical device; it is not known without +client-specific interpretation whether the touchpoints must be considered +separately or grouped together. + +The additions in XI 2.2 aim to: + +- support a dynamic number of simultaneous touch points, +- support devices that are both multi-touch and traditional pointer devices, +- allow touchpoints to be either grouped together or handled separately, +- be backwards-compatible to pre-XI 2.2 clients through emulation of XI 2.x/XI 1.x and core + pointer events. + +Touch events are only available to clients supporting version 2.2 or later of +the X Input Extension. Clients must use the XIQueryVersion request to announce +support for this version. Touch devices may generate emulated pointer events +alongside XI 2.2 touch events to support older clients; see Section +<<multitouch-processing,Touch event delivery>>. + +Touch event processing differs from normal event processing in a few ways. +The most notable differences are that touch events are processed partially +out-of-band from pointer and keyboard events, and that touch events may be +sent to multiple clients simultaneously. For more details see Section +<<multitouch-processing, Touch event delivery>>. + +[[multitouch-lifecycle]] +Touch event sequences +~~~~~~~~~~~~~~~~~~~~~ + +Touch input follows a three-stage cycle: + + begin - update - update - ... - end + +i.e. “begin” the sequence by touching the device, “update” the current +touch location or properties any number of times, and finally “end” the +sequence by ceasing to touch the device. Within this document, the term +"touch sequence" is used to describe the above sequence of events. +In the protocol, the three stages are represented with the event +types TouchBegin, TouchUpdate, and TouchEnd, respectively. A touch sequence +always generates TouchBegin and TouchEnd events, and may also generate +TouchUpdate events. Clients must select for all three of these events +simultaneously. + +When a touch starts, clients are sent a TouchBegin event +detailing the position of the touchpoint, as well as the +initial properties of the touchpoint. Note that the logical state of the +device (as seen through the input protocol) may lag the physical state if event +processing is affected by grabs. Multiple touchpoints may be active on the +same device at any time, potentially owned by and/or delivered to a different +set of clients. + +Whenever the touch position or any other property of the touchpoint changes, +a TouchUpdate event is sent to all clients listening +to events for that touchpoint with the updated information. + +When the touch has physically ended, or a client will otherwise not receive +any more events for a given touchpoint, a TouchEnd event will be sent to +that client. + +Passive touch grabs are similar to standard input event grabs in that they +take precedence over event selections and are searched from the root window +to the child window (as opposed to selections, which start their search at the +child window and continue up to the root window). When a touch grab activates, +the client whose grab activates becomes the “owner” of this touch sequence, +and must decide what to do with it, as per Section +<<multitouch-ownership,Ownership of touch sequences>>. See the +<<requests-passivegrabdevice,XIPassiveGrabDevice>> request +documentation for more information on passive grab activation. + +Only one client may select for touch events from a given device on a window. + +[[multitouch-ownership]] +Ownership of touch sequences +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Once a grabbing client becomes the owner of a touch, it must either “accept” or +"reject" the touch sequence using the XIAllowEvents request. If a touch sequence +is rejected, a TouchEnd event is sent to the rejecting client, and it will not +receive any more events for this touch. The server then looks to the next +window in the stack for another passive grab, and attempts to pass ownership +on to the next candidate for a passive grab (i.e. the next window towards +the final child window with a matching grab), or to the first applicable +event selection if there are no more grabs. + +If a touch sequence is accepted by its owner, all other clients receive +TouchEnd events, and the touch sequence is exclusively delivered to the +owner from that point on. + +If the touch sequence physically ends while the owner of the touch sequence +has not yet accepted or rejected ownership, the owner receives a TouchEnd +event and all other clients receive a TouchUpdate event with the +TouchPendingEnd flag set. The owner must still accept or reject the sequence +nonetheless. If the owner rejects the touch sequence, the server will still +attempt to exhaust all other passive grabs and/or event selections looking +for a final owner. + +If the touch sequence has not physically ended yet and the owner of the +touch sequence rejects, the owner receives a TouchEnd event and ownership is +passed to the next client. + +Clients may opt for touch events to be delivered before they become the +owner of the touch sequence. In this case, the logical state of the device (as +seen by means of the protocol) always matches the physical state of the device. +Clients must use caution if they opt for this feature; any action taken must be +undone if the touch sequence ends without the client becoming the owner. + +To select for touch events regardless of ownership, a client must set the +TouchOwnership event mask in addition to the +TouchBegin, TouchUpdate and TouchEnd mask. When selected, a client will receive +touch events as they occur on the device. If and when the client +becomes the owner of a touch sequence, a TouchOwnership event is sent to the +client. If the client is the initial owner of the sequence, the TouchBegin is +immediately followed by the TouchOwnership event. Otherwise, TouchUpdate events +may preceed a TouchOwnership event. A client is not guaranteed to become the +owner of any given touch sequence. + +The server delivers touch events to all clients that have selected for +TouchOwnership and to the current owner of the sequence in parallel. + +If a client has selected for TouchOwnership and is not the current owner of +the sequence and the current owner accepts the sequence, the client receives +a TouchEnd event and no further events from this sequence are sent to this +client. + +If a client has selected for TouchOwnership and the physical touch ends +before the current owner has accepted or rejected the sequence, the client +receives a TouchUpdate event with the TouchPendingEnd flag set. No further +TouchUpdate events will be sent for this sequence. If the current owner +accepts the sequence, the client receives a TouchEnd event. Otherwise, if +the current owner rejects the sequence, the client may become +the owner of the touch sequence and receive a TouchOwnership event and a +TouchEnd event. + +[[multitouch-device-modes]] +Touch device modes +~~~~~~~~~~~~~~~~~~ + +Touch devices come in many different forms with varying capabilities. The +following device modes are defined for this protocol: + +'DirectTouch': + These devices map their input region to a subset of the screen region. Touch + events are delivered to window at the location of the touch. "direct" + here refers to the user manipulating objects at their screen location. + An example of a DirectTouch device is a touchscreen. + +'DependentTouch': + These devices do not have a direct correlation between a touch location and + a position on the screen. Touch events are delivered according to the + location of the device's cursor and often need to be interpreted + relative to the current position of that cursor. Such interactions are + usually the result of a gesture performed on the device, rather than + direct manipulation. An example of a DependentTouch device is a + trackpad. + +A device is identified as only one of the device modes above at any time, and +the touch mode may change at any time. If a device's touch mode changes, an +XIDeviceChangedEvent is generated. + +[[multitouch-processing]] +Touch event delivery +~~~~~~~~~~~~~~~~~~~~ + +For direct touch devices, the window set for event propagation is the set of +windows from the root window to the topmost window lying at the co-ordinates +of the touch. + +For dependent devices, the window set for event propagation is the set of +windows from the root window to the window that contains the device's +pointer. A dependent device may only have one window set at a time, for all +touches. Any future touch sequence will use the same window set. The window set +is cleared when all touch sequences on the device end. + +A window set is calculated on TouchBegin and remains constant until the end +of the sequence. Modifications to the window hierarchy, new grabs or changed +event selection do not affect the window set. + +Pointer control of dependent devices +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +On a dependent device, the device may differ between a pointer-controlling +touch and a non-pointer-controlling touch. For example, on a touchpad the +first touch is pointer-controlling (i.e. serves only to move the visible +pointer). Multi-finger gestures on a touchpad cause all touches to be +non-pointer-controlling. + +For pointer-controlling touches, no touch events are sent; the touch +generates regular pointer events instead. Non-pointer-controlling touches +send touch events. A touch may change from pointer-controlling to +non-pointer-controlling, or vice versa. + +- If a touch changes from pointer-controlling to non-pointer-controlling, + a new touch ID is assigned and a TouchBegin is sent for the last known + position of the touch. Further events are sent as TouchUpdate events, or as + TouchEnd event if the touch terminates. + +- If a touch changes from non-pointer-controlling to pointer-controlling, a + TouchEnd is sent for that touch at the last known position of the touch. + Further events are sent as pointer events. + +The conditions to switch from pointer-controlling to non-pointer-controlling +touch is implementation-dependent. A device may support touches that are +both pointer-controlling and a touch event. + +In the dependent touch example event sequence below, touches are marked when +switching to pointer-controlling (pc) or to non-pointer-controlling (np). + +.Dependent touch example event sequence on a touchpad +[width="50%", options="header"] +|==================================================== +| Finger 1 | Finger 2 | Event generated(touchid) +| down | | Motion +| move | | Motion +| move | | Motion +| (np) | down | TouchBegin(0), TouchBegin(1) +| move | -- | TouchUpdate(0) +| -- | move | TouchUpdate(1) +| up | (pc) | TouchEnd(0), TouchEnd(1) +| | move | Motion +| down | (np) | TouchBegin(2), TouchBegin(3) +| move | -- | TouchUpdate(2) +| up | (pc) | TouchEnd(2), TouchEnd(3) +| | up | Motion +| down | | Motion +| (np) | down | TouchBegin(4), TouchBegin(5) +| (pc) | up | TouchEnd(4), TouchEnd(5) +| move | | Motion +| up | | Motion +|==================================================== + + +[[multitouch-emulation]] +Pointer emulation from multitouch events +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Touch sequences from direct touch devices may emulate pointer events. Only one +touch sequence from a device may emulate pointer events at a time; which touch +sequence emulates pointer events is implementation-dependent. + +Pointer events are emulated as follows: + +- A TouchBegin event generates a pointer motion event to the location of the + touch with the same axis values of the touch event, followed by a button press + event for button 1. +- A TouchUpdate event generates a pointer motion event to the location of the + touch and/or to update axis values of the pointer device. The button state + as seen from the protocol includes button 1 set. +- A TouchEnd event generates a pointer motion event to the location of the touch + and/or to update the axis values if either have changed, followed by a button + release event for button 1. The button state as seen from the protocol + includes button 1 set. + +If a touch sequence emulates pointer events and an emulated pointer event +triggers the activation of a passive grab, the grabbing client becomes the +owner of the touch sequence. + +The touch sequence is considered to have been accepted if + +- the grab mode is asynchronous, or +- the grab mode is synchronous and the device is thawed as a result of + AllowEvents with AsyncPointer or AsyncDevice + +Otherwise, if the button press is replayed by the client, the touch sequence +is considered to be rejected. + +Touch event delivery precedes pointer event delivery. A touch event emulating +pointer events is delivered: + +- as a touch event to the top-most window of the current window set if a + client has a touch grab on this window, +- otherwise, as a pointer event to the top-most window of the current window + set if a client has a pointer grab on this window, +- otherwise, to the next child window in the window set until a grab has been + found. + +If no touch or pointer grab on any window is active and the last window in the +window set has been reached, the event is delivered: + +- as a touch event to the window if a client has selected for touch events + on this window +- otherwise, as a pointer event to the window if a client has selected for + pointer events. +- otherwise, to the next parent window in the window set until a selection has + been found. + +Emulated pointer events will have the PointerEmulated flag set. A touch +event that emulates pointer events has the TouchEmulatingPointer flag set. + + +[[barrier-events]] +Pointer barrier events +^^^^^^^^^^^^^^^^^^^^^^ +If a master pointer moves against a pointer barrier blocking movement in +that pointer's direction, the movement of the pointer is clamped to the x or +y coordinate of the barrier, whichever applies. For a description of pointer +barriers and barrier creation and destruction see the XFixes protocol +specification v 5.0 or later. +http://cgit.freedesktop.org/xorg/proto/fixesproto/plain/fixesproto.txt + +A pointer hitting a blocking barrier creates a new barrier event sequence, +identified by a unique event ID. A new event ID is assigned when the pointer +first hits a barrier. Subsequent movements against or along the pointer +barrier are assigned the same event ID. The event generated by the pointer +leaving the barrier, or being released by a client request, is the last +event with this event ID. Any future movements of this device blocked by +this barrier will be assigned a new event ID. + +Pointer barrier events are delivered exclusively to the client that created +the barrier, and to the window specified in the CreatePointerBarrier +request (the "barrier window"). A pointer barrier blocks pointer movement +regardless of whether its window is mapped and/or viewable. If the pointer +barrier window is destroyed, the pointer barrier remains blocking but a +client will not receive further events. + +If a device is actively grabbed by a client or a passive grab activated +for this client, and the pointer moves against a pointer barrier created by +this client and the grab-window is the barrier window, that client will +receive pointer barrier events if: +- owner-events is true or false and the grab's event mask includes + pointer barrier events, or +- owner-events is true and the client has selected for barrier events on the + barrier window. + +If the grab-window is not the barrier window, the client will receive events +if: +- the client has selected for barrier events on the barrier window. + +If the barrier is not owned by this client, no barrier events are sent to +this client. The client owning the barrier will receive events if: +- the client has pointer barrier events selected on the window associated + with the pointer barrier + +The BarrierDeviceIsGrabbed flag is set whenever a pointer barrier event is +generated while the device is actively grabbed by any client or a passive +grab has activated for this device prior to the event. + +[[glossary-notations]] +Notations used in this document +------------------------------- + +Notation for requests: + + ┌─── + Name of request + name of request field: type of request field + name of request field: type of request field + ▶ + name of reply field: type of reply field + └─── + +Notation for events: + + ┌─── + Name of event + name of field: type of field + name of field: type of field + └─── + +Complex fields are specified in the following notation: + + name of field: COMPLEXFIELDTYPE + +or, if multiple of these fields exist: + + name of field: LISTofCOMPLEXFIELDTYPE + + COMPLEXFIELDTYPE: { name of subfield: type of subfield, + name of subfield: type of subfield } + + +[[glossary-datatypes]] +Data types +---------- + + BUTTONMASK + A binary mask defined as (1 << button number). + A SETofBUTTONMASK is a binary OR of zero or more BUTTONMASK. + + DEVICE { DEVICEID, AllDevices, AllMasterDevices } + A DEVICE specifies either a DEVICEID or AllDevices or + AllMasterDevices. + + DEVICEID { CARD16 } + A DEVICEID is a numerical ID for a device currently available in the + server. The server may re-use a device ID after a device's removal. + The device IDs 0 and 1 are reserved. + AllDevices ........ 0 + AllMasterDevices .. 1 + + DEVICEUSE { MasterPointer, MasterKeyboard, SlavePointer, + SlaveKeyboard, FloatingSlave } + A DEVICEUSE field specifies the current use of a device in the MD/SD + device hierarchy. See Section "The Master/Slave device hierarchy" + for more information. + + EVTYPEMASK + An EVTYPEMASK is a binary mask defined as (1 << event type). + A SETofEVTYPEMASK is a binary OR of zero or more EVTYPEMASK. + + FP1616 + Fixed point decimal in 16.16 format as one INT16 and one CARD16. + The INT16 contains the integral part, the CARD16 the decimal fraction + shifted by 16. + + FP3232 + Fixed point decimal in 32.32 format as one INT32 and one CARD32. + The INT32 contains the integral part, the CARD32 the decimal fraction + shifted by 32. + + MODIFIERMASK + A MODIFIERMASK is a binary mask defined as (1 << modifier map index). + A SETofMODIFIERMASK is a binary OR of zero or more MODIFIERMASK or + GrabAnyModifier. + + VALUATORMASK + A binary mask defined as (1 << valuator number). + A SETofVALUATORMASK is a binary OR of zero or more VALUATORMASK. + + +[[errors]] +Errors +------ + +Errors are sent using core X error reports. + + Device + A value for a DEVICE argument does not specify a valid DEVICE. + + +[[requests]] +Requests +-------- + +The server does not guarantee that the length of a reply remains constant in +future revisions of XI2. A client must always retrieve the exact length of the +protocol reply from the connection, even if the reply is longer than defined +for the XI2 version supported by the client. +Additional bytes in a request may include data supported in later versions of +XI2. Clients should ignore this data. Padding bytes in XI2 protocol requests +are required to be 0. + +[[requests-xi20]] +Requests introduced in version 2.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[[requests-queryversion]] +XIQueryVersion +^^^^^^^^^^^^^^ + ┌─── + XIQueryVersion + major_version: CARD16 + minor_version: CARD16 + ▶ + major_version: CARD16 + minor_version: CARD16 + └─── + +The client sends the highest supported version to the server and the +server sends the highest version it supports, but no higher than the +requested version. Major versions changes can introduce incompatibilities +in existing functionality, minor version changes introduce only backward +compatible changes. It is the client's responsibility to ensure that the +server supports a version which is compatible with its expectations. + + major_version + Major XI2 version. + minor_version + Minor XI2 version. + +If major_version is less than 2, a BadValue error occurs. + +[[requests-querydevice]] +XIQueryDevice +^^^^^^^^^^^^^ + ┌─── + XIQueryDevice + DEVICE deviceid + ▶ + num_devices: CARD16 + deviceinfo: LISTofDEVICEINFO + └─── + + DEVICEINFO { deviceid: DEVICEID + use: DEVICEUSE + attachment: DEVICEID + enabled: BOOL + num_classes: CARD16 + name_len: CARD16 + name: LISTofCHAR8 + classes: LISTofCLASS } + + CLASS { BUTTONCLASS, KEYCLASS, VALUATORCLASS, SCROLLCLASS, TOUCHCLASS } + + BUTTONCLASS { type: ButtonClass + length: CARD16 + sourceid: CARD16 + num_buttons: CARD16 + state: SETofBUTTONMASK + labels: LISTofATOM } + + KEYCLASS { type: KeyClass + length: CARD16 + sourceid: CARD16 + num_keys: CARD16 + keys: LISTofCARD32 } + + VALUATORCLASS { type: ValuatorClass + length: CARD16 + sourceid: CARD16 + number: CARD16 + label: ATOM + min: FP3232 + max: FP3232 + value: FP3232 + resolution: CARD32 + mode: CARD8 } + + SCROLLCLASS¹ { type: ScrollClass + length: CARD16 + sourceid: CARD16 + number: CARD16 + scroll_type: SCROLLTYPE + flags: SETofSCROLLFLAGS + increment: FP3232 } + + SCROLLTYPE { Vertical, Horizontal } + + SCROLLFLAGS { NoEmulation, Preferred } + + TOUCHCLASS² { type: TouchClass + length: CARD16 + sourceid: CARD16 + mode: TOUCHMODE + num_touches: CARD16 } + + TOUCHMODE { DirectTouch, DependentTouch } + + ¹ since XI 2.1 + ² since XI 2.2 + +XIQueryDevice details information about the requested input devices. + + devices + The device to list. If devices is AllDevices, all enabled and + disabled devices are listed. If devices is AllMasterDevices, all + enabled and disabled master devices are listed. If devices is a + valid DEVICE, only this DEVICE is listed and num_devices is 1. + num_devices + The number of deviceinfos returned. + +Each deviceinfo is detailed as follows: + + deviceid + The unique ID of the device. Device IDs may get re-used when a device + is removed. + use + If the device is a master pointer, use is MasterPointer. + If the device is a master keyboard, use is MasterKeyboard. + If the device is a slave pointer, use is SlavePointer. + If the device is a slave keyboard, use is SlaveKeyboard. + If the device is a floating slave, use is FloatingSlave. + attachment + If the device is a master pointer or a master keyboard, attachment + specifies the paired master keyboard, or the paired master pointer, + respectively. If the device is a non-floating slave device + attachment specifies the master device this device is attached to. + If the device is a floating slave, attachment is undefined. + enabled + Zero if the device is disabled, non-zero otherwise. + num_classes + Number of classes provided. + name_len + Length of the name in bytes not including padding. + classes + Details the available classes provided by the device in an undefined + order. + name + The device's name. padded to a multiple of 4 bytes. + +For all classes, type specifies the device class. Clients are required +to ignore unknown device classes. The length field specifies the length +of the class in 4 byte units. +The following classes may occur only once: ButtonClass, KeyClass + + ButtonClass: + type + Always ButtonClass. + length + Length in 4 byte units. + sourceid + The device this class originates from. + num_buttons + Number of buttons provided by the device. + labels + List of Atoms specifying the label for each button. An Atom of None + specifies an unlabeled button. Buttons are listed in the device-native + order regardless of the current button mapping. + state + The current button mask for this device after button mapping is + applied. Each bit representing a button is 1 if this button is + logically down, or 0 otherwise. State is a multiple of 4-byte units + and always contains at least num_buttons bits. + + KeyClass: + type + Always KeyClass. + length + Length in 4 byte units. + sourceid + The device this class originates from. + num_keys + Number of keycodes provided by the device. + keys + List of keycodes provided. + + ValuatorClass: + type + Always ValuatorClass. + length + Length in 4 byte units. + sourceid + The device this class originates from. + number + Valuator number of this axis. The valuator number is in device-native + order and potential axis mappings are ignored. + label + Atom specifying the axis name. An Atom of None specifies an unlabeled + axis. + min + Minimum value. + max + Minimum value. + resolution + Resolution in counts/meter. + mode + Relative or Absolute. + value + Last published axis value (if mode is absolute). + +An axis in Relative mode may specify min and max as a hint to the +client. If no min and max information is available, both must be 0. + + ScrollClass: + type + Always ScrollClass. + number + Valuator number that is referred to. This valuator number must be listed in + the ValuatorClassInfo. + scroll_type: + Vertical for a vertical scrolling axis, Horizontal for a horizontal + scrolling axis. + flags: + A set of flags that apply to this scroll axis. + NoEmulation: no legacy scroll button events are generated for events + on this scrolling axis. + Preferred: This axis is the preferred axis for emulating valuator + events from legacy scroll button events. + increment: + The valuator delta equivalent to one positive unit of scrolling. + +A ScrollClass may only exist if the device has at least one ValuatorClass +and each valuator number listed in any ScrollClass. Only one ScrollClass may +exist per ValuatorClass. + + TouchClass: + type + Always TouchClass. + length + Length in 4 byte units. + sourceid + The device this class originates from. + mode + The device type of the touch device. This mode may change at runtime. + num_touches + The maximum number of simultaneous touchpoints the device may send. + If num_touches is 0, the number of supported touches is unknown or + unlimited. + +Devices with a TouchClass emit touch events with the same axes as pointer +events. + +[[requests-selectevents]] +XISelectEvents +^^^^^^^^^^^^^^ + ┌─── + XISelectEvents + window: Window + num_masks: CARD16 + masks: LISTofEVENTMASK + + └─── + + EVENTMASK { deviceid: DEVICE, + mask_len: CARD16, + mask: SETofEVTYPEMASK } + + window + The window to select the events on. + num_masks + Number of items in masks. + deviceid + Numerical deviceid, or AllDevices, or AllMasterDevices. + mask_len + Length of mask in 4 byte units. + mask + Event mask. An event mask for an event type T is defined as (1 << T). + +XISelectEvents selects for XI2 events on window. + +If num_masks is 0, a BadValue error occurs. + +Each mask sets the (and overwrites a previous) event mask for the DEVICE +specified through deviceid. The device AllDevices or +AllMasterDevices is treated as a separate device by server. A client's +event mask is the union of AllDevices, AllMasterDevices and the +per-device event mask. +The removal of device from the server unsets the event masks for the +device. If an event mask is set for AllDevices or AllMasterDevices, the +event mask is not cleared on device removal and affects all future +devices. + +If mask_len is 0, the event mask for the given device is cleared. + +The mask for XIHierarchyEvents may only be selected for XIAllDevices. +Setting it for any other device results in a BadValue error. + +A client selecting for any of XI_TouchBegin, XI_TouchUpdate, or XI_TouchEnd +must select for all three events at the same time, else a BadValue error +will be generated. A client selecting for XI_TouchOwnership must select for +all three of the other touch events. If the selection for these touch events +overlaps a current selection by another client (e.g. selecting for a +specific device when another client has a selection for XIAllDevices), a +BadAccess error occurs. + +[[requests-getselectedevents]] +XIGetSelectedEvents +^^^^^^^^^^^^^^^^^^^ + ┌─── + XIGetSelectedEvents + window: Window + ▶ + num_masks: CARD16 + masks: LISTofEVENTMASK + └─── + + window + The window to select the events on. + num_masks + Number of items in masks. + masks + Selected event masks by this client. + +Masks are returned on a per-device basis, with masks for AllDevices and +AllMasterDevices returned separately. A client can calculate the +effective mask for a device with a bitwise OR of the AllDevices, the +AllMasterDevices and the device-specific mask. + +If num_masks is 0, no events have been selected by this client on the +given window. + +[[requests-querypointer]] +XIQueryPointer +^^^^^^^^^^^^^^ + ┌─── + XIQueryPointer + window: Window + deviceid: DEVICEID + ▶ + root: Window + child: Window + root_x: FP1616 + root_y: FP1616 + win_x: FP1616 + win_y: FP1616 + same_screen: BOOL + mods: MODIFIERINFO + group: GROUPINFO + buttons_len: CARD16 + buttons: SETofBUTTONMASK + └─── + +Query a master pointer device for its current position. + + root + The root window the pointer is logically on. + child + The child window of window that contains the pointer or None. + root_x + root_y + Pointer position relative to the root window's origin. + win_x + win_y + Pointer position relative to window or 0 if same_screen is false. + same_screen + True if window is on the same screen as the pointer. + mods + XKB modifier state on the paired device. + group + XKB group state on the paired device. + buttons_len + The length of buttons in 4 byte units. + buttons + Button state. + +If the device is not a master pointer device or not a floating slave +pointer, a BadDevice error results. + +[[requests-warppointer]] +XIWarpPointer +^^^^^^^^^^^^^ + ┌─── + XIWarpPointer + src_win: Window + dst_win: Window + src_x: FP1616 + src_y: FP1616 + src_width: INT16 + src_height: INT16 + dst_x: FP1616 + dst_y: FP1616 + deviceid: DEVICEID + └─── + +WarpPointer moves the pointer of deviceid as if the user had moved +the pointer. WarpPointer can only be called for MasterPointer and +FloatingSlave devices. + + src_win + If src_window is not None, the move only takes place if src_window + contains the pointer and the pointer is contained in the specified + rectangle of src_window. + dst_win + If dst_win is None, this request moves the pointer by offsets + dst_x/dst_y relative to the current position of the pointer. If + dst_window is a window, this request moves the pointer to + dst_x/dst_y relative to dst_win's origin. + src_x + src_y + src_width + src_height + Specifies the source window rectangle. + dst_x + dst_y + The relative coordinates to move the pointer if dst_win is None, or + the absolute coordinates if dst_win is a window. + deviceid + The device to warp. + +This request cannot be used to move the pointer outside the confine-to +window of an active pointer grab. An attempt will only move the pointer as +far as the closest edge of the confine-to window. + +This request will generate events just as if the user had instantaneously +moved the pointer. + +[[requests-changecursor]] +XIChangeCursor +^^^^^^^^^^^^^^ + ┌─── + XIChangeCursor + win: Window + cursor: Cursor + deviceid: DEVICEID + └─── + +Change a master pointer's cursor on the specified window. + + window + The window. + cursor + The new cursor or None. + deviceid + The master pointer device. + +Whenever device enters a window W, the cursor shape is selected in the +following order: + +- if the current window has a device cursor C(d) defined for device, + display this cursor C(d). +- otherwise, if the current window has a cursor C(w) defined in the core + protocol's window attributes, display cursor C(w). +- repeat on parent window until a cursor has been found. + +The device cursor for a given window is reset once the window is destroyed +or the device is removed, whichever comes earlier. + +If deviceid does not specify a master pointer, a BadDevice error +is returned. + +[[requests-changehierarchy]] +XIChangeHierarchy +^^^^^^^^^^^^^^^^^ + ┌─── + XIChangeHierarchy + num_changes: CARD8 + changes: LISTofHIERARCHYCHANGES + └─── + + HIERARCHYCHANGE { ADDMASTER, REMOVEMASTER, ATTACHSLAVE, DETACHSLAVE } + + HIERARCHYCHANGETYPE { AddMaster, RemoveMaster, AttachSlave, DetachSlave } + + CHANGEMODE { Float, Attach } + + ADDMASTER { type: HIERARCHYCHANGETYPE + length: CARD16 + name_len: CARD16 + send_core: BOOL + enable: BOOL + name: LISTofCHAR8 } + + REMOVEMASTER { type: HIERARCHYCHANGETYPE + length: CARD16 + deviceid: DEVICEID + return_mode: CHANGEMODE + return_pointer: DEVICEID + return_keyboard: DEVICEID } + + ATTACHSLAVE { type: HIERARCHYCHANGETYPE + length: CARD16 + deviceid: DEVICEID + master: DEVICEID } + + DETACHSLAVE { type: HIERARCHYCHANGETYPE + length: CARD16 + deviceid: DEVICEID } + +XIChangeHierarchy allows a client to modify the +<<hierarchy,Master/Slave device hierarchy>>. + + num_changes + The number of changes to apply to the current hierarchy. + changes + The list of changes. + +The server processes the changes in the order received from the client and +applies each requested change immediately. If an error occurs, processing +stops at the current change and returns the number of successfully applied +changes in the error. + + ADDMASTER creates a pair of master devices. + type + Always AddMaster. + length + Length in 4 byte units. + name_len + Length of name in bytes. + send_core + True if the device should send core events. + enable + True if the device is to be enabled immediately. + name + The name for the new master devices. The master pointer's name is + automatically appended with " pointer", the master keyboard's name is + automatically appended with " keyboard". + + REMOVEMASTER removes an existing master device. + type + Always RemoveMaster. + length + Length in 4 byte units. + deviceid + The device to remove. + return_mode + Return mode for attached slave devices. + If return_mode is Float, all slave devices are set to floating. + If return_mode is Attach, slave pointers are attached to + return_pointer and slave keyboards are attached to + return_keyboard. + return_pointer + return_keyboard + The master pointer and master keyboard to attach slave devices to, if + return_mode is Attach. If return_mode is Float, return_pointer + and return_keyboard are undefined. + +Removing a master pointer removes the paired master keyboard and vice +versa. + + ATTACHSLAVE attaches a slave device to a given master device. + type + Always ChangeAttachment. + length + Length in 4 byte units. + deviceid + Deviceid of the slave device. + master + The new master device to attach this slave device to. + +If any clients are selecting for touch events from the slave device, their +selection will be canceled. + + DETACHSLAVE detaches a slave device from its current master device. + type + Always ChangeAttachment. + length + Length in 4 byte units. + deviceid + Deviceid of the slave device. + +[[requests-setclientpointer]] +XISetClientPointer +^^^^^^^^^^^^^^^^^^ + ┌─── + XISetClientPointer + win: Window + deviceid: DEVICEID + └─── + +Set the ClientPointer for the client owning win to the given device. + + win + Window or client ID. + deviceid + The master pointer or master keyboard that acts as ClientPointer. + +Some protocol requests are ambiguous and the server has to choose a device +to provide data for a request or a reply. By default, the server will +choose a client's ClientPointer device to provide the data, unless the +client currently has a grab on another device. See section +<<clientpointer,The ClientPointer principle>> for more details. + +If win is None, the ClientPointer for this client is set to the given +device. Otherwise, if win is a valid window, the ClientPointer for the +client owning this window is set to the given device. Otherwise, if win is +not a valid window but a client with the client mask equal to win exists, +this client's ClientPointer is set to the given device. + +If deviceid does not specify a master pointer or master keyboard, a +BadDevice error is returned. + +If window does not specify a valid window or client ID and is not None, a +BadWindow error is returned. + +[[requests-getclientpointer]] +XIGetClientPointer +^^^^^^^^^^^^^^^^^^ + ┌─── + XIGetClientPointer + win: Window + ▶ + set: BOOL + deviceid: DEVICEID + └─── + +Query the ClientPointer for the client owning win. + + win + The window or client ID. + set + True if the client has a ClientPointer set. + deviceid + The master pointer that acts as a ClientPointer if set is True. + +No difference is made between a ClientPointer set explicitly through +XISetClientPointer and a ClientPointer implicitly assigned by the server +in response to an ambiguous request. + +[[requests-setfocus]] +XISetFocus +^^^^^^^^^^ + ┌─── + XISetFocus + focus: Window + deviceid: DEVICEID + time: Time + └─── + +Set the focus for the given device to the given window. Future key events +from this device are sent to this window. +This request generates FocusIn and FocusOut events. + + focus + A viewable window or None. + deviceid + The device to modify the focus window for. + time + Specifies the time to change the focus or CurrentTime. + +If focus is None, key events from this device are discarded until a new +focus window is set. If focus is a viewable window, key events from this +device are sent to this window. If the window becomes unviewable, the +window's first viewable ancestor automatically becomes the focus window +and FocusIn and FocusOut events are sent as if a client had changed the +focus window. +This is equivalent to RevertToParent in the core XSetInputFocus window. + +This request has no effect if the specified time is earlier than the +current last-focus-change time or is later than the current X server time. +Otherwise, the last-focus-change time is set to the specified time. + +[[requests-getfocus]] +XIGetFocus +^^^^^^^^^^ + ┌─── + XIGetFocus + deviceid: DEVICEID + ▶ + focus: Window + └─── + +Return the current focus window for the given device. + +[[requests-grabdevice]] +XIGrabDevice +^^^^^^^^^^^^ + ┌─── + XIGrabDevice + deviceid: DEVICEID + grab_window: Window + owner_events: BOOL + grab_mode: { Synchronous, Asynchronous } + paired_device_mode: { Synchronous, Asynchronous } + time: TIMESTAMP or CurrentTime + cursor: Cursor + mask_len: CARD16 + masks: SETofEVTYPEMASK + ▶ + status: Success, AlreadyGrabbed, Frozen, InvalidTime, NotViewable + └─── + +This request actively grabs control of the specified input device. Further +input events from this device are reported only to the grabbing client. +This request overides any previous active grab by this client for this +device. This request does not affect the processing of XI 2.2 +touch events. + + deviceid + The device to grab. + grab_window + Events are reported relative to the grab window. + owner_events + Specifies whether event will be reported normally or relative to the + grab window. + grab_mode + Specifies if this device will be frozen as a result of the grab. + paired_device_mode + Specifies if the master device paired with this device will be frozen + as a result of the grab. + time + A valid server time or CurrentTime. + cursor + The cursor to display for the duration of the grab or None. + mask_len + Length of mask in 4 byte units. + mask + Event mask. An event mask for an event type T is defined as (1 << T). + status + Success or the reason why the grab could not be established. + +The masks parameter specifies which events the client wishes to receive +while the device is grabbed. + +If owner-events is False, input events generated from this device are +reported with respect to grab-window, and are only reported if selected by +being included in the event-list. If owner-events is True, then if a +generated event would normally be reported to this client, it is reported +normally, otherwise the event is reported with respect to the grab-window, +and is only reported if selected by being included in the event-list. For +either value of owner-events, unreported events are discarded. + +If grab-mode is Asynchronous, device event processing continues normally. +If the device is currently frozen by this client, then processing of +device events is resumed. If grab-mode is Synchronous, the state of the +grabbed device (as seen by means of the protocol) appears to freeze, +and no further device events are generated by the server until the +grabbing client issues a releasing XIAllowEvents request or until the +device grab is released. Actual device input events are not lost while the +device is frozen; they are simply queued for later processing. + +If the device is a slave device, the paired-device-mode is ignored. +Otherwise, if this device is a master device and paired-device-mode is +Asynchronous, event processing is unaffected by activation of the grab. If +this device is a master device and paired-device-mode is Synchronous, the +state of the master device paired with this device (as seen by means of the +protocol) appears to freeze, and no further events are generated by the +server until the grabbing client issues a releasing XIAllowEvents request +or until the device grab is released. Actual events are not lost while the +devices are frozen; they are simply queued for later processing. + +If the cursor is not None and the device is a master pointer device, the +cursor will be displayed until the device is ungrabbed. + +This request fails and returns: + + AlreadyGrabbed: If the device is actively grabbed by some other client. + NotViewable: If grab-window is not viewable. + InvalidTime: If the specified time is earlier than the last-grab-time for + the specified device or later than the current X server time. + Otherwise, the last-grab-time for the specified device is set + to the specified time and CurrentTime is replaced by the + current X server time. + Frozen: If the device is frozen by an active grab of another client. + +To release a grab of a device, use XIUngrabDevice. + +[[requests-ungrabdevice]] +XIUngrabDevice +^^^^^^^^^^^^^^ + ┌─── + XIUngrabDevice + deviceid: DEVICEID + time: TIMESTAMP or CurrentTime + └─── + +This request releases the device if this client has it actively grabbed +(from either XIGrabDevice or XIPassiveGrabDevice) and +releases any queued events. If any devices were frozen by the grab, +XIUngrabDevice thaws them. + + deviceid + The device to grab. + time + A valid server time or CurrentTime. + +The request has no effect if the specified time is earlier than the +last-device-grab time or is later than the current server time. +This request generates FocusIn and FocusOut events. +An XIUngrabDevice is performed automatically if the event window for an +active device grab becomes not viewable. + +[[requests-allowevents]] +XIAllowEvents +^^^^^^^^^^^^^ + ┌─── + XIAllowEvents + deviceid: DEVICEID + time: TIMESTAMP or CurrentTime + event_mode: { AsyncDevice, SyncDevice, + AsyncPairedDevice, SyncPairedDevice, + ReplayDevice, AsyncPair, SyncPair, + AcceptTouch¹, RejectTouch¹ } + touchid¹: CARD32 + grab_window¹: Window + └─── + + ¹ since XI 2.2 + +The XIAllowEvents request releases some queued events if the client +has caused a device to freeze. It also is used to handle touch grab and +ownership processing. + + deviceid + The device to grab. + time + A valid server time or CurrentTime. + event_mode + Specifies whether a device is to be thawed and events are to be + replayed, or how to handle a grabbed touch sequence. + touchid + The ID of the touch sequence to accept or reject. The value is undefined + for event modes other than AcceptTouch and RejectTouch. + grab_window + The window on which to accept or reject a touch sequence grab. The value + is undefined for event modes other than AcceptTouch and RejectTouch. + +The request has no effect if the specified time is earlier than the last-grab +time of the most recent active grab for the client, or if the specified time is +later than the current X server time. The time parameter must be CurrentTime for +requests with event modes of AcceptTouch and RejectTouch. + +When event-mode is AcceptTouch, a BadValue error occurs if the touch ID is +invalid. A BadAccess error occurs if this client is not the current or potential +owner of the specified touch ID. + +The following describes the processing that occurs depending on what constant +you pass to the event-mode argument: + + AsyncDevice: + If the specified device is frozen by the client, event processing for that + device continues as usual. If the device is frozen multiple times by the + client on behalf of multiple separate grabs, AsyncDevice thaws for + all. + AsyncDevice has no effect if the specified device is not frozen by the + client, but the device need not be grabbed by the client. + SyncDevice: + If the specified device is frozen and actively grabbed by the client, + event processing for that device continues normally until the next + event is reported to the client. At this time, the specified device + again appears to freeze. However, if the reported event causes the + grab to be released, the specified device does not freeze. + SyncDevice has no effect if the specified device is not frozen by the + client or is not grabbed by the client. + ReplayDevice: + If the specified device is actively grabbed by the client and is frozen + as the result of an event having been sent to the client (either from + the activation of a XIGrabButton or from a previous XIAllowEvents with + mode SyncDevice, but not from a Grab), the grab is released and + that event is completely reprocessed. This time, however, the request + ignores any passive grabs at or above (towards the root) the + grab-window of the grab just released. + The request has no effect if the specified device is not grabbed by + the client or if it is not frozen as the result of an event. + AsyncPairedDevice + If the paired master device is frozen by the client, event processing + for it continues as usual. If the paired device is frozen multiple + times by the client on behalf of multiple separate grabs, + AsyncPairedDevice thaws for all. + AsyncPairedDevice has no effect if the device is not frozen by the + client, but those devices need not be grabbed by the client. + AsyncPairedDevice has no effect if deviceid specifies a slave device. + SyncPairedDevice + If the paired master device is frozen by the client, event processing (for + the paired master device) continues normally until the next button or key + event is reported to the client for the grabbed device (button event for + the grabbed device, key or motion event for the device), at which time + the device again appears to freeze. However, if the reported event causes + the grab to be released, then the device does not freeze. + SyncPairedDevice has no effect if the specified device is not grabbed + by the client or if it is no frozen as the result of an event. + SyncPairedDevice has no effect if deviceid specifies a slave device. + SyncPair + If both the device and the paired master device are frozen by the + client, event processing (for both devices) continues normally until + the next XIButtonPress, XIButtonRelease, XIKeyPress, or XIKeyRelease + event is reported to the client for a grabbed device (button event for + a pointer, key event for a keyboard), at which time the devices again + appear to freeze. However, if the reported event causes the grab to be + released, then the devices do not freeze (but if the other device is + still grabbed, then a subsequent event for it will still cause both + devices to freeze). + SyncPair has no effect unless both the device and the paired master + device are frozen by the client. If the device or paired master device + is frozen twice by the client on behalf of two separate grabs, + SyncPair thaws for both (but a subsequent freeze for SyncPair will + only freeze each device once). + SyncPair has no effect if deviceid specifies a slave device. + AsyncPair + If the device and the paired master device are frozen by the client, + event processing for both devices continues normally. If a device is + frozen twice by the client on behalf of two separate grabs, AsyncBoth + thaws for both. AsyncPair has no effect unless both the device and the + paired master device frozen by the client. + AsyncPair has no effect if deviceid specifies a slave device. + AcceptTouch + The client is deemed to have taken control of the touch sequence once it + owns the sequence. TouchEnd events will be sent to all clients listening + to the touch sequence that have either grabbed the touch sequence on a + child window of the grab_window or have received events for the touch + sequence through event selection. These clients will no longer receive + any TouchUpdate events. + RejectTouch + The client is no longer interested in the touch sequence, and will + receive a TouchEnd event. If the client is the current owner of the + sequence, ownership will be passed on to the next listener. + +[[requests-passivegrabdevice]] +XIPassiveGrabDevice +^^^^^^^^^^^^^^^^^^^ + ┌─── + XIPassiveGrabDevice + deviceid: DEVICE + detail: CARD32 + grab_type: GRABTYPE + time: TIMESTAMP + grab_window: Window + cursor: Cursor + owner_events: Bool + grab_mode: { Synchronous, Asynchronous, Touch¹ } + paired_device_mode: { Synchronous, Asynchronous } + num_modifiers: INT16 + mask_len: CARD16 + masks: SETofEVTYPEMASK + modifiers: LISTofSETofMODIFIERMASK + ▶ + num_modifiers_return: INT16 + modifiers_return: LISTofGRABMODIFIERINFO + └─── + + GRABTYPE { GrabtypeButton, GrabtypeKeycode, GrabtypeEnter, + GrabtypeFocusIn, GrabtypeTouchBegin¹ } + + GRABMODIFIERINFO { status: Access + modifiers: SETofMODIFIERMASK } + + ¹ since XI 2.2 + +Establish an explicit passive grab for a button or keycode +on the specified input device. + + cursor + The cursor to display for the duration of the grab. If grab_type + is not GrabtypeButton, this argument is ignored. + deviceid + The device to establish the passive grab on or AllDevices or + AllMasterDevices. + detail + The button number, or key symbol to grab for. + Must be 0 for GrabtypeEnter, GrabtypeFocusIn, and + GrabtypeTouchBegin. + grab_type + The type of grab to establish. + grab_window + Events are reported relative to the grab window. + grab_mode + If grab-mode is Asynchronous, device event processing continues + normally. If the device is currently frozen by this client, then + processing of device events is resumed. If grab-mode is + Synchronous, the state of the grabbed device (as seen by means of + the protocol) appears to freeze, and no further device events are + generated by the server until the grabbing client issues a + releasing XIAllowEvents request or until the device grab is + released. Actual device input events are not lost while the device + is frozen; they are simply queued for later processing. If grab_type + is GrabtypeTouchBegin, grab_mode must be set to Touch. + mask_len + Length of mask in 4 byte units. + mask + Event mask. An event mask for an event type T is defined as (1 << T). + modifiers + XKB modifier state to activate this passive grab. + num_modifiers + Number of elements in modifiers. + owner_events + Specifies whether event will be reported normally or relative to the + grab window. + num_modifiers_return + Number of elements in modifiers_return + modifiers_return + XKB modifier state that could not be grabbed. + time + This field is unused. + +If owner-events is False, input events generated from this device are +reported with respect to grab-window, and are only reported if +selected by being included in the event-list. If owner-events is +True, then if a generated event would normally be reported to this +client, it is reported normally, otherwise the event is reported +with respect to the grab-window, and is only reported if selected +by being included in the event-list. For either value of +owner-events, unreported events are discarded. + +If deviceid specifies a master pointer, the modifiers of the paired +master keyboard are used. If deviceid specifies a slave pointer +the modifiers of the master keyboard paired with the attached master +pointers are used. If deviceid specifies a slave keyboard, the +modifiers of the attached master keyboard are used. Note that +activating a grab on a slave device detaches the device from its +master. In this case, the modifiers after activation of the grab are +from the slave device only and may be different to the modifier state +when the grab was triggered. + +In the future, if grab_type is GrabtypeButton or GrabtypeKeyboard, the +device is actively grabbed if: + + - the device is not grabbed, and + - the specified modifier keys are down, and + - the grab_type is GrabtypeButton and the button specified in detail + is logically pressed or the grab_type is GrabtypeKeycode and the + keycode specified in detail is logically pressed, and + - the grab_window contains the pointer, and + - a passive grab on the same button/keycode + modifier + combination does not exist on an ancestor of grab_window. + +Otherwise, if grab_type is GrabtypeEnter or GrabtypeFocusIn, the +device is actively grabbed if: + + - the device is not actively grabbed, and + - the specified modifier keys are down, and + - the grab_type is GrabtypeEnter and the device's pointer has moved + into grab_window or a descendant of grab_window, or the grab_type is + GrabtypeFocusIn and the device's focus has been set to the + grab_window or a descendant of grab_window, and + - a passive grab of the same grab_type + modifier combination does not + does not exist on an ancestor of grab_window. + +Otherwise, if grab_type is GrabtypeTouchBegin, a touch grab begins if: + + - the device is not actively grabbed, and + - the specified modifier keys are down + - a touch begins in grab_window or a descendant of grab_window, and + - a passive grab of the same grab_type + modifier combination does not + does not exist on an ancestor of grab_window. + +Ownership of the touch sequence is granted to the grabbing client if: + + - a TouchBegin or pointer grab for an emulated touch sequence of a + direct touch device with the same modifier set does not exist on + an ancestor of grab_window, or all applicable grabs have released + ownership. + +A modifier of GrabAnyModifier is equivalent to issuing the request for +all possible modifier combinations (including no modifiers). A client +may request a grab for GrabAnyModifier and explicit modifier +combinations in the same request. + +A GrabtypeButton or GrabtypeKeyboard grab is released when all buttons +or keycode are released, independent of the state of modifier keys. +A GrabtypeEnter or GrabtypeFocusIn grab is released when the +pointer or focus leaves the window and all of its descendants, +independent of the state of modifier keys. +A GrabtypeTouchBegin grab is released when the touch sequence ends or +the client uses XIAllowEvents with mode RejectTouch. +Note that the logical state of a device (as seen by means of the +protocol) may lag the physical state if device event processing is +frozen. + +This request overrides all previous passive grabs by the same +client on the same button/key/enter/focus in + modifier combinations +on the same window. + +If some other client already has issued a XIPassiveGrabDevice request +with the same button or keycode and modifier combination, the +failed modifier combinations is returned in modifiers_return. If some +other client already has issued an XIPassiveGrabDevice request of +grab_type XIGrabtypeEnter, XIGrabtypeFocusIn, or +XIGrabtypeTouchBegin with the same grab_window and the same +modifier combination, the failed modifier combinations are returned +in modifiers_return. If num_modifiers_return is zero, all passive +grabs have been successful. + +If a button grab or enter grab activates, EnterNotify and LeaveNotify +events with mode Grab are generated as if the pointer were to suddenly +warp from its current position some position in the grab_window. +However, the pointer does not warp, and the pointer position is used +as both the initial and final positions for the events. + +If a keycode grab or focus grab activates, FocusIn and FocusOut events +with mode Grab are generated as if the focus were to change from the +current window to the grab_window. + +If an enter or focus in grab activates, additional EnterNotify events +with mode XIPassiveGrabNotify are generated as if the pointer or focus +were to suddenly warp from its current position to some position in +the grab window. These events are sent to the grabbing client only +and only if the grab event mask has selected for it. If such a passive +grab deactivates, addional LeaveNotify events with mode +XIPassiveUngrabNotify are generated and sent to the grabbing client +before the grab deactivates. + +For GrabtypeTouchBegin, grab_mode must be Touch or a BadValue error +is generated. + +See section <<multitouch-ownership, Ownership of touch sequences>> for +additional notes on touch grabs, as they do not behave like traditional +grabs: in particular, they do not freeze the device, and delivery of touch +events continues even if the device is frozen due to a grab by another +client. + +[[requests-passiveungrabdevice]] +XIPassiveUngrabDevice +^^^^^^^^^^^^^^^^^^^^^ + ┌─── + XIPassiveUngrabDevice + deviceid: DEVICEID + detail: CARD32 + grab_type: GRABTYPE + grab_window: Window + num_modifiers: INT16 + modifiers: LISTofSETofMODIFIERMASK + └─── + +Release an explicit passive grab on the specified input device. + + deviceid + The device to establish the passive grab on. + detail + The button number or key symbol to ungrab. + Must be 0 for GrabtypeEnter, GrabtypeFocusIn, and + GrabtypeTouchBegin. + grab_type + The type of grab to establish. + grab_window + Events are reported relative to the grab window. + modifiers + XKB modifier state to activate this passive grab. + num_modifiers + Number of elements in modifiers. + +This request has no effect if the client does not have a passive grab +of the same type, same button or keycode (if applicable) and modifier +combination on the grab_window. + +[[requests-listproperties]] +XIListProperties +^^^^^^^^^^^^^^^^ + ┌─── + XIListProperties + deviceid: DEVICEID + ▶ + num_properties: INT16 + properties: LISTofATOM + └─── + +List the properties associated with the given device. + + deviceid + The device to list the properties for. + num_properties + Number of properties in the reply + properties + All properties on the device. + +[[requests-changeproperty]] +XIChangeProperty +^^^^^^^^^^^^^^^^ + ┌─── + XIChangeProperty + deviceid: DEVICEID + property: ATOM + type: ATOM + format: { 8, 16, 32 } + mode: { Append, Prepend, Replace } + num_items: CARD32 + data: LISTofINT8, or LISTofINT16, or LISTofINT32 + └─── + +Change the given property on the given device. + + deviceid + The device to change the property on. + property + The property to modify. + type + The property's type. + mode + One of Append, Prepend, or Replace + num_items + Number of items following this request. + data + Property data (nitems * format/8 bytes) + +The type is uninterpreted by the server. The format specifies whether +the data should be viewed as a list of 8-bit, 16-bit, or 32-bit +quantities so that the server can correctly byte-swap as necessary. + +If the mode is Replace, the previous propert y value is discarded. If +the mode is Prepend or Append, then the type and format must match the +existing property value (or a Match error results). If the property is +undefined, it is treated as defined with the correct type and format +with zero-length data. For Prepend, the data is tacked on to the +beginning of the existing data, and for Append, it is tacked on to the +end of the existing data. + +The lifetime of a property is not tied to the storing client. Properties +remain until explicitly deleted, until the device is removed, or +until server reset. + +A property cannot be deleted by setting nitems to zero. To delete a +property, use XIDeleteProperty. + +This request generates an XIPropertyEvent. + +[[requests-deleteproperty]] +XIDeleteProperty +^^^^^^^^^^^^^^^^ + ┌─── + XIDeleteProperty + deviceid: DEVICEID + property: ATOM + └─── + +Deletes the given property on the given device. + + deviceid + The device to delete the property on. + property + The property to delete. + +If the property is deleted, an XIPropertyEvent is generated on the device. +If the property does not exist, this request does nothing. + +[[requests-getproperty]] +XIGetProperty +^^^^^^^^^^^^^ + ┌─── + XIGetProperty + deviceid: DEVICEID + property: ATOM + type: Atom or AnyPropertyType + offset: CARD32 + len: CARD32 + delete: BOOL + ▶ + type: Atom + bytes_after: CARD32 + num_items: CARD32 + format: { 8, 16, 32 } + data: LISTofINT8, or LISTofINT16, or LISTofINT32 + └─── + +Get the data for the given property on the given device. + + deviceid + The device to retrieve the property data from. + property + The property to retrieve the data from.. + type + The property type to retrieve or AnyPropertyType + offset + The offset in 4-byte units. + len + Number of bytes to receive in 4-byte units. + delete + Delete the property after retrieving the data. + bytes_after + Number of unread bytes in the stored property + num_items + Number of items in data + format + 8, 16, or 32 + data + Property data (nitems * format/8 bytes) + +If the specified property does not exist for the specified device, then +the return type is None, the format and bytes-after are zero, and the value is +empty. The delete argument is ignored in this case. If the specified property +exists but its type does not match the specified type, then the return +type is the actual type of the property, the format is the actual format of the +property (never zero), the bytes-after is the length of the property in bytes +(even if the format is 16 or 32), and the value is empty. The delete +argument is ignored in this case. If the specified property exists and +either AnyPropertyType is specified or the specified type matches the actual +type of the property, then the return type is the actual type of the property, +the format is the actual format of the property +(never zero), and the bytes-after and value are as follows, given: + N = actual length of the stored property in bytes + (even if the format is 16 or 32) + I = 4 * long-offset + T = N−I + L = MINIMUM(T, 4 * long-length) + A = N − (I + L) +The returned value starts at byte index I in the property (indexing +from 0), and its length in bytes is L. However, it is a Value error if +offset is given such that L is negative. The value of bytes_after is A, +giving the number of trailing unread bytes in the stored property. If +delete is True and the bytes_after is zero, the property is also +deleted from the device, and a XIPropertyNotify event is generated on +the device. + +[[requests-xi23]] +Requests introduced in version 2.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[[requests-barrierreleasepointer]] +XIBarrierReleasePointer +^^^^^^^^^^^^^^^^^^^^^^^ + ┌─── + XIBarrierReleasePointer + num_items: CARD32 + ▶ + data: LISTofBARRIERRELEASEINFO + └─── + + BARRIERRELEASEINFO { deviceid: DEVICEID, + barrier: Barrier, + eventid: CARD32 } + +Release a pointer currently blocked by a barrier. In the future, movement of +this pointer against the barrier will not be blocked. + + deviceid + The device currently being blocked by a barrier + barrier + The barrier currently blocking the device + eventid + The unique event ID assigned to this barrier event sequence + +If the barrier given does not currently block this device, or the eventid +is invalid, this request does nothing. + +Releasing a pointer barrier is only valid during one barrier event sequence, +and only applies to the next movement of this device against this barrier. +If the pointer moves away from the barrier following a +XIBarrierReleasePointer request, the release request is discarded. In the +future, if the pointer moves against the barrier again, a new eventid is +assigned and the client must re-issue the XIBarrierReleasePointer request. + +If the device is not a master pointer device, a BadDevice error results. +If the barrier does not name a valid barrier, a BadValue error results. + + +[[events]] +Events +------ + +An event specifies its length in 4-byte units after the initial 32 bytes. +Future versions of the protocol may provide additional information +in the same event, thus increasing the event size. Clients are required to +always read the number of bytes specified by the event, not the size of the +event they may have been compiled against. + + +The following event types are available in XI2. + +Version 2.0: + + - HierarchyChanged + - DeviceChanged + - KeyPress + - KeyRelease + - ButtonPress + - ButtonRelease + - Motion + - RawKeyPress + - RawKeyRelease + - RawButtonPress + - RawButtonRelease + - RawMotion + - Enter + - Leave + - FocusIn + - FocusOut + - PropertyEvent + +Version 2.2: + + - TouchBegin + - TouchUpdate + - TouchOwnership + - TouchEnd + - RawTouchBegin + - RawTouchUpdate + - RawTouchEnd + +Version 2.3: + + - BarrierHit + - BarrierLeave + +All events have a set of common fields specified as EVENTHEADER. + + + EVENTHEADER { type: BYTE + extension: BYTE + sequenceNumber: CARD16 + length: CARD32 + evtype: CARD16 + deviceid: DEVICEID + time: Time } + + type + Always GenericEvent. + extension + Always the X Input extension offset. + sequenceNumber + Sequence number of last request processed by the server. + length + Length in 4-byte units after the initial 32 bytes. + evtype + XI-specific event type. + deviceid + Numerical device id for a device. + time + Time in ms when the event occurred. + + +[[events-xi20]] +Events introduced in version 2.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[[events-hierarchyevent]] +HierarchyEvent +^^^^^^^^^^^^^^ + ┌─── + HierarchyEvent + EVENTHEADER + flags: SETofHIERARCHYMASK + num_info: CARD16 + info: LISTofHIERARCHYINFO + └─── + + + HIERARCHYMASK { MasterAdded, MasterRemoved, SlaveAttached, SlaveDetached, + SlaveAdded, SlaveRemoved, DeviceEnabled, DeviceDisabled } + + HIERARCHYINFO { deviceid: DEVICEID, + attachment: DEVICEID, + type: DEVICEUSE + enabled: BOOL + flags: SETofHIERARCHYMASK} + + flags + Set of the changes that have occured, causing this event. + num_info + The number of device info structs following the request. + info: + The current hierarchy information. + +An XIHierarchyEvent is sent whenever the device hierarchy been +changed. The flags specify all types of hierarchy modifiations that have +occured. +For all devices, info details the hierarchy information after the +modification of the hierarchy has occured. For each device specified with +deviceid: + +- if type is MasterPointer or MasterKeyboard, attachment decribes the + pairing of this device. +- if type is SlavePointer or SlaveKeyboard, attachment describes the + master device this device is attached to. +- if type is FloatingSlave device, attachment is undefined. + + enabled + True if the device is enabled and can send events. A disabled master + device will not forward events from an attached, enabled slave + device. + +Note: Multiple devices may be affected in one hierarchy change, +deviceid in an XIHierarchyEvent is always the first affected +device. Clients should ignore deviceid and instead use the devices list. + +[[events-devicechangedevent]] +DeviceChangedEvent +^^^^^^^^^^^^^^^^^^ + ┌─── + DeviceChangedEvent + EVENTHEADER + reason: CHANGEREASON + source: DEVICEID + num_classes: CARD16 + classes: LISTofCLASS + └─── + + CHANGEREASON { SlaveSwitch, DeviceChange } + +A DeviceChangeEvent is sent whenever a device changes it's capabilities. +This can happen either by a new slave device sending events through a +master device, or by a physical device changing capabilities at runtime. + + reason + The reason for generating this event. + If reason is SlaveSwitch, the slave device sending events through + this device has changed and source specifies the new slave device. + A SlaveSwitch reason can only occur on a master device. + If reason is DeviceChange, the device itself has changed through + other means (e.g. a physical device change) and source is + the device itself. + source + The source of the new classes. + num_classes + Number of classes provided. + classes + Details the available classes provided by the device. The order the + classes are provided in is undefined. + +For a detailed description of classes, see the XIQueryDevice request. + +[[events-deviceevent]] +DeviceEvent +^^^^^^^^^^^ + ┌─── + DeviceEvent + EVENTHEADER + detail: CARD32 + root: Window + event: Window + child: Window + root_x: FP1616 + root_y: FP1616 + event_x: FP1616 + event_y: FP1616 + buttons_len: CARD16 + valuators_len: CARD16 + sourceid: DEVICEID + mods: MODIFIERINFO + group: GROUPINFO + flags: DEVICEEEVENTFLAGS + buttons: SETofBUTTONMASK + valuators: SETofVALUATORMASK + axisvalues: LISTofFP3232 + └─── + + BUTTONBIT { (1 << Button1), (1 << Button2), ... , (1 << ButtonN) } + VALUATORBIT { (1 << 1), ( 1 << 2), ... ( 1 << n) } + + MODIFIERINFO { base_mods: CARD32, + latched_mods: CARD32, + locked_mods: CARD32, + effective_mods: CARD32} + GROUPINFO { base_group: CARD8, + latched_group: CARD8, + locked_group: CARD8, + effective_group: CARD8} + + DEVICEEVENTFLAGS (all events): none + DEVICEEVENTFLAGS (key events only): { KeyRepeat } + DEVICEEVENTFLAGS (pointer events only): { PointerEmulated } + DEVICEEVENTFLAGS (touch events only): { TouchPendingEnd, + TouchEmulatingPointer } + +An XIDeviceEvent is generated whenever the logical state of a device +changes in response to a button press, a button release, a motion, a key +press or a key release. The event type may be one of KeyPress, +KeyRelease, ButtonPress, ButtonRelease, Motion. + +XI 2.2: The event type may also be TouchBegin, TouchUpdate, or TouchEnd. + + detail + The button number, key code, touch ID, or 0. + root + event + child + The root window, event window or subwindow, respectively. See core + protocol specification for more detail. + root_x + root_y + The position of the pointer in screen coordinates (16.16 fixed point). + event_x + event_y + The position of the pointer in screen coordinates relative to the + event window (16.16 fixed point). + + buttons_len + The length of buttons in 4 byte units. + valuators_len + The length of valuators in 4 byte units. + sourceid + The source device that originally generated the event. + mods + XKB modifier state before the event occured. + group + XKB group state before the event. + buttons + Button state before the event. + valuators + Bitmask of valuators provided in axisvalues. + axisvalues + Valuator data in device-native resolution. This is a non-sparse + array, value N represents the axis corresponding to the Nth bit set + in valuators. + flags + Miscellaneous information about this event; the union of the + common flag set and either the key or pointer flag set, + depending on the event type. + KeyRepeat means that this event is for repeating purposes, and + the physical state of the key has not changed. This is only + valid for KeyPress events. + PointerEmulated signals that the event has been emulated from another + XI 2.x event for legacy client support, and that this event should + be ignored if the client listens for these events. This flag is + set on scroll ButtonPress and RawButtonPress events (buttons 4, 5, 6 + and 7) if a smooth-scrolling event on the Rel Vert Scroll or + Rel Horiz Scroll axes was also generated. It is also set on Motion, + ButtonPress, and ButtonRelease events generated by direct touch devices. + TouchPendingEnd (for touch events only) means that the touch + has physically ended, however another client still holds a grab, so the + touch should be considered alive until all grabbing clients have + accepted or passed on ownership. The touch will not generate any + further TouchUpdate events once an event with TouchPendingEnd has been + received. + TouchEmulatingPointer is set on touch events that emulate pointer + events. + +Modifier state in mods is detailed as follows: + + base_mods + XKB base modifier state. + latched_mods + XKB latched modifier state. + locked_mods + XKB locked modifier state. + +Group state in group is detailed as follows: + + base_group + XKB base group state. + latched_group + XKB latched group state. + locked_group + XKB locked group state. + +In servers supporting XI 2.2, a TouchBegin event is generated whenever a new +touch sequence initializes. +A TouchEnd event is generated whenever a touch sequence ceases. A +TouchUpdate event is generated whenever a valuator value changes, or a flag +flag (e.g. pending end) has changed for that touch sequence; this may result +in a TouchUpdate event being sent with zero valuators. + +The average finger size is significantly larger than one pixel. The +selection of the hotspot of a touchpoint is implementation dependent and +may not be the logical center of the touch. + +Touch tracking IDs are provided in the detail field of touch events. Its +value is always provided in every touch event. Tracking IDs are +represented as unsigned 32-bit values and increase strictly monotonically in +value for each new touch, wrapping back to 0 upon reaching the numerical limit +of IDs. The increment between two touch IDs is indeterminate. Clients may not +assume that any future touches will have specific touch IDs. IDs are globally +unique. + +The button state in touch events represents the state of the device's +physical buttons only, even if that sequence is emulating pointer events. + +Touch events do not generate enter/leave events. + +[[events-rawevent]] +RawEvent +^^^^^^^^ + ┌─── + RawEvent + EVENTHEADER + detail: CARD32 + sourceid¹: DEVICEID + flags: DEVICEEVENTFLAGS + valuators_len: CARD16 + valuators: SETofVALUATORMASK + axisvalues: LISTofFP3232 + axisvalues_raw: LISTofFP3232 + └─── + + ¹ since XI 2.1 + +A RawEvent provides the information provided by the driver to the +client. RawEvent provides both the raw data as supplied by the driver and +transformed data as used in the server. Transformations include, but are +not limited to, axis clipping and acceleration. +Transformed valuator data may be equivalent to raw data. In this case, +both raw and transformed valuator data is provided. +RawEvents are sent exclusively to all root windows. +Clients supporting XI 2.0 receive raw events when the device is not grabbed, +or when the device is grabbed by the client but not when the device is +grabbed by another client. +Clients supporting XI 2.1 or later receive raw events at all times, even +when the device is grabbed by another client. + + + eventtype + The type of event that occured on the device. + detail + The button number, keycode or touch ID¹. + sourceid + The source device that originally generated the event. The sourceid + is undefined for clients not supporting XI 2.1. + flags + Flags as described in DeviceEvent. + valuators_len + The length of valuators in 4 byte units. + valuators + Bitmask of valuators provided in axisvalues and axisvalues_raw. + axisvalues + Valuator data in device-native resolution. This is a non-sparse + array, value N represents the axis corresponding to the Nth bit set + in valuators. + axisvalues_raw + Untransformed valuator data in device-native resolution. This is a + non-sparse array, value N represents the axis corresponding to the + Nth bit set in valuators. + + ¹ since XI 2.2 + +[[events-enterleave]] +Enter or Leave or FocusIn or FocusOut +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ┌─── + Enter or Leave or FocusIn or FocusOut + EVENTHEADER + root: Window + event: Window + child: Window + sourceid: DEVICEID + root_x: FP1616 + root_y: FP1616 + event_x FP1616 + event_y: FP1616 + mode: NOTIFYMODE + detail: NOTIFYDETAIL + same_screen: BOOL + focus: BOOL + mods: MODIFIERINFO + group: GROUPINFO + buttons_len: CARD16 + buttons: SETofBUTTONMASK + └─── + + NOTIFYMODE { Normal, Grab, Ungrab } + NOTIFYDETAIL { Ancestor, Virtual, Inferior, Nonlinear, NonlinearVirtual, + Pointer, PointerRoot, None } + +Enter or Leave events are sent whenever a device's pointer enters or +leaves a window. +FocusIn or FocusOut events are sent whenever a device's focus is set to or +away from a window. +The enter/leave and focus in/out model is described in the core protocol +specification, Section 11. (EnterNotify, LeaveNotify events). + +For enter and leave events, the modifier and group state is the state of +the paired master device if the device is a master device, or the state of +the attached master keyboard if the device is an attached slave device, or +zero if the device is a floating slave device. + +For focus in and out events, the button state is the state of the paired +master device if the device is a master device, or the state of the +attached master keyboard if the device is an attached slave device, or +zero if the device is a floating slave device. + + root + event + child + The root window, event window, and child window, respectively. See the + core protocol specification for more detail. + sourceid + The device that caused the pointer to move. + root_x + root_y + The pointer coordinates relative to the root window. + event_x + event_y + The pointer coordinates relative to the event window. + mode + Normal pointer motion events have mode Normal. Pseudo-motion events + when a grab activates have mode Grab, and pseudo-motion events when a + grab deactivates have mode Ungrab. Pseudo-motion events caused by the + activation or deactivation of a passive enter or focus in grab have mode + XIPassiveGrabNotify or XIPassiveUngrabNotify. + detail + Specifies the relation of the event window to the window the pointer + entered or left. See the core protocol spec for details. + same_screen + True if the event window is on the same screen as the pointer's root + window. + focus + If the event window is the focus window or an inferior of the focus + window, then focus is True. Otherwise, focus is False. This field is + unspecified for focus in/out events. + mods + XKB modifier state before the event occured. + group + XKB group state before the event. + buttons_len + The length of buttons in 4 byte units. + buttons + Button state before the event. + +[[events-propertyevent]] +XIPropertyEvent +^^^^^^^^^^^^^^^ + ┌─── + XIPropertyEvent + EVENTHEADER + property: ATOM + what: { PropertyCreated, PropertyDeleted, PropertyModified } + └─── + +XIPropertyEvents are sent whenever a device property is created, deleted or +modified by a client. + + property + The property that has been created, deleted, or modified + what + Specifies what has been changed. + +[[events-xi22]] +Events introduced in version 2.2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[[events-touchownershipevent]] +TouchOwnershipEvent +^^^^^^^^^^^^^^^^^^^ + ┌─── + TouchOwnershipEvent + EVENTHEADER + touchid: CARD32 + root: Window + event: Window + child: Window + sourceid: DEVICEID + flags: SETofTOUCHOWNERSHIPFLAGS + └─── + + TOUCHOWNERSHIPFLAGS: (none currently defined) + +A TouchOwnershipEvent indicates that ownership has changed, and the client +is now the owner of the touch sequence specified by touchid. + + touchid + The identifier of the touch sequence. + root + event + child + The root window, event window, and child window, respectively. See the + core protocol specification for more detail. + sourceid + The source device that originally generated the event. + flags + A bitmask of flags for this event. + +[[events-xi23]] +Events introduced in version 2.3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[[events-barrierevent]] +BarrierEvent +^^^^^^^^^^^^ + ┌─── + BarrierEvent + EVENTHEADER + eventid: CARD32 + root: Window + event: Window + barrier: Barrier + dtime: CARD32 + flags: SETofBARRIERFLAGS + sourceid: DEVICEID + root_x: FP1616 + root_y: FP1616 + dx: FP3232 + dy: FP3232 + └─── + + BARRIERFLAGS { PointerReleased, DeviceIsGrabbed } + +A BarrierEvent indicates interaction between a barrier and a pointer device. +If the event type is BarrierHit, pointer movement has been blocked by a +barrier. If the event type is BarrierLeave, a pointer previously blocked +by a barrier has moved away from that barrier, or has moved +through the blocking barrier following an earlier XIBarrierReleasePointer +request. + + eventid + The unique event ID for this barrier event sequence. + root + event + The root window or barrier window, respectively. The barrier window + is always the drawable specified in in the CreatePointerBarrier request. + barrier + The barrier blocking pointer movement. + dtime + The relative time in milliseconds between the last event and this + event. + flags + A set of flags that apply to this barrier event + PointerReleased: + The pointer has moved through the barrier following a + XIBarrierReleasePointer request (BarrierLeave only). + DeviceIsGrabbed: + The pointer device that generated this event is currently + grabbed. + sourceid + The source device that originally generated the event. + root_x + root_y + The position of the pointer in screen coordinates (16.16 fixed + point), after being constrained by barrier and/or screen extents. + dx + dy + The relative movement of the pointer from its previous position to + the new position if pointer movement were not constrained by this + barrier. + +Root coordinates in barrier events represent the position of the cursor +after confinement by barriers, screens and RandR output extents. + +Barrier event IDs are provided in the eventid field of barrier events. Its +value is always provided in every barrier event. Event IDs are +represented as unsigned 32-bit values and increase strictly monotonically in +value for each new barrier event sequence, wrapping back to 0 upon reaching +the numerical limit of IDs. The increment between two event IDs is +indeterminate. Clients may not assume that any future barrier constraints +will have specific event IDs. IDs are unique per device per barrier. + +If a pointer is actively grabbed after a barrier event sequence has +initiated, future barrier events of this sequence continue to use the same +eventid, but all barrier events have the DeviceIsGrabbed flag set. If the +pointer is ungrabbed, future events of this sequence have the same eventid +and the DeviceIsGrabbed flag is unset. + +The PointerReleased flag may only be set on a BarrierLeave event. +A BarrierLeave(PointerReleased) event is generated when the pointer moves +through the barrier following a XIBarrierReleasePointer request. The time +between the XIBarrierReleasePointer and the BarrierLeave event thus depends +on user input. +A BarrierLeave(PointerReleased) event is also generated if the barrier is +destroyed while pointer movement is constrained by the barrier, or the +master pointer blocked by the barrier is removed. This event +has a dx/dy of 0/0. + +:numbered!: +[[xi22-usecases]] +[appendix] +XI 2.2 Use-cases +---------------- + +All use-cases that include the receiving and processing of touch events +require the client to announce XI 2.2 support in the XIQueryVersion request. + +Client C wants to process touch events from a device D on window W. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* C calls XISelectEvent for XI_Touch{Begin|Update|End} from D on W. +* C receives TouchBegin whenever a touch sequence starts within W's borders. +* C receives TouchUpdate events whenever an axis valuator value changes for a + touch sequence it received a TouchBegin event for. +* C receives TouchEnd whenever a touch it received a TouchBegin event for + ceases. + +While client I wants to pre-process touch events from device D on the parent window of W. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* C calls XISelectEvent for XI_Touch{Begin|Update|Ownership|End} from D on W. +* I calls XIPassiveGrab for XI_Touch{Begin|Update|Ownership|End} from D on a + parent window of W. +* I receives TouchBegin whenever a touch begins within window W, as well as a + TouchOwnership event indicating that it currently owns the touch sequence. + C receives a TouchBegin event as well, but without TouchOwnership. +* When an axis valuator changes in this touch sequence, both I and C receive a + TouchUpdate event. I may process the event to determine if it is going to + accept or reject the touch, whereas C may perform reversible processing. +* If I decides it is going to claim the touch sequence for its exclusive + processing, it calls XIAllowEvents with an event mode of XIAcceptTouch; at + this point, C receives a TouchEnd event, and undoes any processing it has + already performed due to the touch sequence. Further TouchUpdate events are + delivered only to I. +* Alternatively, if I decides it does not want to receive further events + from this touch sequence, it calls XIAllowEvents with an event mode of + XIRejectTouch; at this point, I receives a TouchEnd event confirming that it + has rejected the touch. C receives a TouchOwnership event confirming that it + is now the new owner of the touch, and further TouchUpdate events are + delivered only to C. As C now owns the touch, it is free to perform + irreversible processing of the sequence. +* When the touch physically ceases, a TouchEnd event is sent to C. + +While client I wants to process pointer events on window W's parent, window Y. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* I calls XIPassiveGrab for XI_{ButtonPress,MotionNotify,ButtonRelease} to + create a synchronous pointer grab from D on Y. +* C calls XISelectEvent for XI_Touch{Begin|Update|Ownership|End} from D on W. +* I receives a ButtonPress event whenever a touch begins within W, and is + considered the owner of the event. C receives a TouchBegin event, but does + not receive a TouchOwnership event. +* When the touchpoint moves, C will receive a TouchUpdate event. Event + delivery to I is subject to the synchronous delivery mechanism. The + emulated motion notify event is queued in the server while the device is + frozen. +* I may assert ownership by calling XIAllowEvents on Y with any mode other + than ReplayDevice, which will cause all further events to be sent only to I, + with a TouchEnd event being sent to C. +* Alternatively, I may reject the touch sequence by calling XIAllowEvents on + Y with mode ReplayDevice, which will cause no further events from that touch + to be sent to I, and a TouchOwnership event to be sent to C, with subsequent + motion events being sent as TouchUpdate events. + +Driver DRV provides touch support from tracked device D: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* DRV initializes a TouchClass for the device. +* DRV parses D's device protocol and selects one touch sequence to be emulated + as pointer event. +* DRV calls the respective input driver API with the touch sequence data. The + touch sequence emulating a pointer has the respective flag set. DRV does not + submit pointer data for any touchpoint. diff --git a/specs/XIproto.txt b/specs/XIproto.txt new file mode 100644 index 0000000..1095a26 --- /dev/null +++ b/specs/XIproto.txt @@ -0,0 +1,2576 @@ +X11 Input Extension Protocol Specification +========================================== + + Version 1.0 + X Consortium Standard + X Version 11, Release 6.8 + Mark Patrick, Ardent Computer + George Sachs, Hewlett-Packard + + Version 1.5 + Peter Hutterer + + Copyright © 1989, 1990, 1991 by Hewlett-Packard Company and + Ardent Computer + + Permission to use, copy, modify, and distribute this + documentation for any purpose and without fee is hereby + granted, provided that the above copyright notice and this + permission notice appear in all copies. Ardent and + Hewlett-Packard make no representations about the suitability + for any purpose of the information in this document. It is + provided "as is" without express or implied warranty. Copyright + © 1989, 1990, 1991, 1992 X Consortium + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the “Software”), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE + FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. + + Except as contained in this notice, the name of the X + Consortium shall not be used in advertising or otherwise to + promote the sale, use or other dealings in this Software + without prior written authorization from the X Consortium. X + Window System is a trademark of The Open Group. + + Copyright © 2008 by Peter Hutterer + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice + (including the next paragraph) shall be included in all copies + or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + +1. Input Extension Overview +--------------------------- + +This document defines an extension to the X11 protocol to +support input devices other than the core X keyboard and +pointer. An accompanying document defines a corresponding +extension to Xlib (similar extensions for languages other than +C are anticipated). This first section gives an overview of the +input extension. The next section defines the new protocol +requests defined by the extension. We conclude with a +description of the new input events generated by the additional +input devices. + +This document only describes the behaviour of servers supporting +up to the X Input Extension 1.5. For servers supporting the X +Input Extensions 2.0, see XI2proto.txt. New clients are discouraged +from using this protocol specification. Instead, the use of XI 2.x +is recommended. + +1.1 Design Approach +~~~~~~~~~~~~~~~~~~~ + +The design approach of the extension is to define requests and +events analogous to the core requests and events. This allows +extension input devices to be individually distinguishable from +each other and from the core input devices. These requests and +events make use of a device identifier and support the +reporting of n-dimensional motion data as well as other data +that is not reportable via the core input events. + +1.2 Core Input Devices +~~~~~~~~~~~~~~~~~~~~~~ + +The X server core protocol supports two input devices: a +pointer and a keyboard. The pointer device has two major +functions. First, it may be used to generate motion information +that client programs can detect. Second, it may also be used to +indicate the current location and focus of the X keyboard. To +accomplish this, the server echoes a cursor at the current +position of the X pointer. Unless the X keyboard has been +explicitly focused, this cursor also shows the current location +and focus of the X keyboard. The X keyboard is used to generate +input that client programs can detect. + +In servers supporting XI 1.4 and above, the core pointer and +the core keyboard are virtual devices that do not represent a +physical device connected to the host computer. +In servers supporting XI 2.0 and above, there may be multiple +core pointers and keyboards. Refer to XI2proto.txt for more +information. + +The X keyboard and X pointer are referred to in this document +as the core devices, and the input events they generate +(KeyPress, KeyRelease, ButtonPress, ButtonRelease, and +MotionNotify) are known as the core input events. All other +input devices are referred to as extension input devices and +the input events they generate are referred to as extension +input events. + +In servers supporting only XI 1.x, this input extension does +not change the behavior or functionality of the core input +devices, core events, or core protocol requests, with the +exception of the core grab requests. These requests may affect +the synchronization of events from extension devices. See the +explanation in the section titled "Event Synchronization and +Core Grabs". + +Selection of the physical devices to be initially used by the +server as the core devices is left implementation-dependent. +Requests are defined that allow client programs to change which +physical devices are used as the core devices. + +1.3 Extension Input Devices +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The input extension v1.x controls access to input devices other +than the X keyboard and X pointer. It allows client programs to +select input from these devices independently from each other +and independently from the core devices. + +A client that wishes to access a specific device must first +determine whether that device is connected to the X server. +This is done through the ListInputDevices request, which will +return a list of all devices that can be opened by the X +server. A client can then open one or more of these devices +using the OpenDevice request, specify what events they are +interested in receiving, and receive and process input events +from extension devices in the same way as events from the X +keyboard and X pointer. Input events from these devices are of +extension types ( DeviceKeyPress, DeviceKeyRelease, +DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify, +etc.) and contain a device identifier so that events of the +same type coming from different input devices can be +distinguished. + +Any kind of input device may be used as an extension input +device. Extension input devices may have 0 or more keys, 0 or +more buttons, and may report 0 or more axes of motion. Motion +may be reported as relative movements from a previous position +or as an absolute position. All valuators reporting motion +information for a given extension input device must report the +same kind of motion information (absolute or relative). + +This extension is designed to accommodate new types of input +devices that may be added in the future. The protocol requests +that refer to specific characteristics of input devices +organize that information by input classes. Server implementors +may add new classes of input devices without changing the +protocol requests. Input classes are unique numbers registered +with the X Consortium. Each extension input device may support +multiple input classes. + +In XI 1.x, all extension input devices are treated like the +core X keyboard in determining their location and focus. The +server does not track the location of these devices on an +individual basis, and therefore does not echo a cursor to +indicate their current location. Instead, their location is +determined by the location of the core X pointer. Like the core +X keyboard, some may be explicitly focused. If they are not +explicitly focused, their focus is determined by the location +of the core X pointer. + +Most input events reported by the server to a client are of +fixed size (32 bytes). In order to represent the change in +state of an input device the extension may need to generate a +sequence of input events. A client side library (such as Xlib) +will typically take these raw input events and format them into +a form more convenient to the client. + +1.4 Event Classes +----------------- + +In the core protocol a client registers interest in receiving +certain input events directed to a window by modifying that +window's event-mask. Most of the bits in the event mask are +already used to specify interest in core X events. The input +extension specifies a different mechanism by which a client can +express interest in events generated by this extension. + +When a client opens a extension input device via the OpenDevice +request, an XDevice structure is returned. Macros are provided +that extract 32-bit numbers called event classes from that +structure, that a client can use to register interest in +extension events via the SelectExtensionEvent request. The +event class combines the desired event type and device id, and +may be thought of as the equivalent of core event masks. + +1.5 Input Classes +~~~~~~~~~~~~~~~~~ + +Some of the input extension requests divide input devices into +classes based on their functionality. This is intended to allow +new classes of input devices to be defined at a later time +without changing the semantics of these requests. The following +input device classes are currently defined: + + KEY + The device reports key events. + + BUTTON + The device reports button events. + + VALUATOR + The device reports valuator data in motion events. + + PROXIMITY + The device reports proximity events. + + FOCUS + The device can be focused and reports focus events. + + FEEDBACK + The device supports feedbacks. + + OTHER + The ChangeDeviceNotify, DeviceMappingNotify, and + DeviceStateNotify macros may be invoked passing the + XDevice structure returned for this device. + +Each extension input device may support multiple input classes. +Additional classes may be added in the future. Requests that +support multiple input classes, such as the ListInputDevices +function that lists all available input devices, organize the +data they return by input class. Client programs that use these +requests should not access data unless it matches a class +defined at the time those clients were compiled. In this way, +new classes can be added without forcing existing clients that +use these requests to be recompiled. + +2. Requests +----------- + +Extension input devices are accessed by client programs through +the use of new protocol requests. This section summarizes the +new requests defined by this extension. The syntax and type +definitions used below follow the notation used for the X11 +core protocol. + +2.1 Getting the Extension Version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The GetExtensionVersion request returns version information +about the input extension. + + GetExtensionVersion + name: STRING + => + present: BOOL + protocol-major-version: CARD16 + protocol-minor-version: CARD16 + +The protocol version numbers returned indicate the version of +the input extension supported by the target X server. The +version numbers can be compared to constants defined in the +header file XI.h. Each version is a superset of the previous +versions. + +The name must be the name of the Input Extension as defined +in the header file XI.h. + +2.2 Listing Available Devices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A client that wishes to access a specific device must first +determine whether that device is connected to the X server. +This is done through the ListInputDevices request, which will +return a list of all devices that can be opened by the X +server. + + ListInputDevices + => + input-devices: ListOfDeviceInfo + +where + + DEVICEINFO: + [type: ATOM + id: CARD8 + num_classes: CARD8 + use: {IsXKeyboard, IsXPointer, IsXExtensionPointer, + IsXExtensionKeyboard, IsExtensionDevice} + info: LISTofINPUTINFO + name: STRING8] + + INPUTINFO: {KEYINFO, BUTTONINFO, VALUATORINFO} + KEYINFO: + [class: CARD8 + length: CARD8 + min-keycode: KEYCODE + max-keycode: KEYCODE + num-keys: CARD16] + BUTTONINFO: + [class: CARD8 + length: CARD8 + num-buttons: CARD16] + VALUATORINFO: + [class: CARD8 + length: CARD8 + num_axes: CARD8 + mode: SETofDEVICEMODE + motion_buffer_size: CARD32 + axes: LISTofAXISINFO] + + AXISINFO: + [resolution: CARD32 + min-val: CARD32 + max-val: CARD32] + DEVICEMODE: {Absolute, Relative} + + Errors: None + +This request returns a list of all devices that can be opened +by the X server, including the core X keyboard and X pointer. +Some implementations may open all input devices as part of X +initialization, while others may not open an input device until +requested to do so by a client program. + +The information returned for each device is as follows: + + type + The type field is of type Atom and indicates the nature + of the device. Clients may determine device types by + invoking the XInternAtom request passing one of the + names defined in the header file XI.h. The following + names have been defined to date: + + MOUSE + TABLET + KEYBOARD + TOUCHSCREEN + TOUCHPAD + BUTTONBOX + BARCODE + KNOB_BOX + TRACKBALL + QUADRATURE + SPACEBALL + DATAGLOVE + EYETRACKER + CURSORKEYS + FOOTMOUSE + ID_MODULE + ONE_KNOB + NINE_KNOB + JOYSTICK + + + id + The id is a small cardinal value in the range 0-128 that + uniquely identifies the device. It is assigned to the + device when it is initialized by the server. Some + implementations may not open an input device until + requested by a client program, and may close the device + when the last client accessing it requests that it be + closed. If a device is opened by a client program via + XOpenDevice, then closed via XCloseDevice, then opened + again, it is not guaranteed to have the same id after + the second open request. + + num_classes + The num_classes field is a small cardinal value in the + range 0-255 that specifies the number of input classes + supported by the device for which information is + returned by ListInputDevices. Some input classes, such + as class Focus and class Proximity do not have any + information to be returned by ListInputDevices. + + use + The use field specifies how the device is currently + being used. If the value is IsXKeyboard, the device is + currently being used as the X keyboard. If the value is + IsXPointer, the device is currently being used as the X + pointer. If the value is IsXExtensionPointer, the device + is available for use as an extension pointer. If the value + is IsXExtensionKeyboard, the device is available for use as + and extension keyboard. + Older versions of XI report all extension devices as + IsXExtensionDevice. + + name + The name field contains a pointer to a null-terminated + string that corresponds to one of the defined device + types. + + InputInfo + InputInfo is one of: KeyInfo, ButtonInfo or + ValuatorInfo. The first two fields are common to all + three: + + class + The class field is a cardinal value in the range + 0-255. It uniquely identifies the class of input + for which information is returned. + + length + The length field is a cardinal value in the range + 0-255. It specifies the number of bytes of data + that are contained in this input class. The length + includes the class and length fields. + +The remaining information returned for input class +KEYCLASS is as follows: + + min_keycode + min_keycode is of type KEYCODE. It specifies the + minimum keycode that the device will report. The + minimum keycode will not be smaller than 8. + + max_keycode + max_keycode is of type KEYCODE. It specifies the + maximum keycode that the device will report. The + maximum keycode will not be larger than 255. + + num_keys + num_keys is a cardinal value that specifies the + number of keys that the device has. + +The remaining information returned for input class +BUTTONCLASS is as follows: + + num_buttons + num_buttons is a cardinal value that specifies the + number of buttons that the device has. + +The remaining information returned for input class +VALUATORCLASS is as follows: + + mode + mode is a constant that has one of the following + values: Absolute or Relative. Some devices allow + the mode to be changed dynamically via the + SetDeviceMode request. + + motion_buffer_size + motion_buffer_size is a cardinal number that + specifies the number of elements that can be + contained in the motion history buffer for the + device. + + axes + The axes field contains a pointer to an AXISINFO + struture. + +The information returned for each axis reported by the +device is: + + resolution + The resolution is a cardinal value in + counts/meter. + + min_val + The min_val field is a cardinal value in that + contains the minimum value the device reports for + this axis. For devices whose mode is Relative, the + min_val field will contain 0. + + max_val + The max_val field is a cardinal value in that + contains the maximum value the device reports for + this axis. For devices whose mode is Relative, the + max_val field will contain 0. + +2.3 Enabling Devices +~~~~~~~~~~~~~~~~~~~~ + +Client programs that wish to access an extension device must +request that the server open that device. This is done via the +OpenDevice request. + + OpenDevice + id: CARD8 + => + DEVICE: + [device_id: XID + num_classes: INT32 + classes: LISTofINPUTCLASSINFO] + INPUTCLASSINFO: + [input_class: CARD8 + event_type_base: CARD8] + + Errors: Device + +This request returns the event classes to be used by the client +to indicate which events the client program wishes to receive. +Each input class may report several event classes. For example, +input class Keys reports DeviceKeyPress and DeviceKeyRelease +event classes. Input classes are unique numbers registered with +the X Consortium. Input class Other exists to report event +classes that are not specific to any one input class, such as +DeviceMappingNotify, ChangeDeviceNotify, and DeviceStateNotify. + +The information returned for each device is as follows: + + device_id + The device_id is a number that uniquely identifies the + device. + + num_classes + The num_classes field contains the number of input + classes supported by this device. + + For each class of input supported by the device, the + InputClassInfo structure contains the following information: + + input_class + The input_class is a small cardinal number that + identifies the class of input. + + event_type_base + The event_type_base is a small cardinal number that + specifies the event type of one of the events reported + by this input class. This information is not directly + used by client programs. Instead, the Device is used by + macros that return extension event types and event + classes. This is described in the section of this + document entitled "Selecting Extension Device Events". + +The information in the InputClassInfo reflects the state of +this device at the time the request was processed. + +Before it exits, the client program should explicitly request +that the server close the device. This is done via the +CloseDevice request. + +A client may open the same extension device more than once. +Requests after the first successful one return an additional +XDevice structure with the same information as the first, but +otherwise have no effect. A single CloseDevice request will +terminate that client's access to the device. + +Closing a device releases any active or passive grabs the +requesting client has established. If the device is frozen only +by an active grab of the requesting client, the queued events +are released when the client terminates. + +If a client program terminates without closing a device, the +server will automatically close that device on behalf of the +client. This does not affect any other clients that may be +accessing that device. + + CloseDevice: + device: DEVICE + + Errors: Device + +2.4 Changing The Mode Of A Device +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some devices are capable of reporting either relative or +absolute motion data. To change the mode of a device from +relative to absolute, use the SetDeviceMode request. The valid +values are Absolute or Relative. + +This request will fail and return DeviceBusy if another client +already has the device open with a different mode. It will fail +and return AlreadyGrabbed if another client has the device +grabbed. The request will fail with a BadMatch error if the +device has no valuators and reports no axes of motion. The +request will fail with a BadMode error if the requested mode +is not supported by the device. + + SetDeviceMode + device:DEVICE + mode: {Absolute, Relative} + => + status: {Success, DeviceBusy, AlreadyGrabbed} + + Errors: Device, Match, Mode + +2.5 Initializing Valuators on an Input Device +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some devices that report absolute positional data can be +initialized to a starting value. Devices that are capable of +reporting relative motion or absolute positional data may +require that their valuators be initialized to a starting value +after the mode of the device is changed to Absolute. To +initialize the valuators on such a device, use the +SetDeviceValuators request. + + SetDeviceValuators + device: DEVICE + first_valuator: CARD8 + num_valuators: CARD8 + valuators: LISTOFINT32 + => + status: {Success, AlreadyGrabbed} + + Errors: Length, Device, Match, Value + +This request initializes the specified valuators on the +specified extension input device. Valuators are numbered +beginning with zero. Only the valuators in the range specified +by first_valuator and num_valuators are set. If the number of +valuators supported by the device is less than the expression +first_valuator + num_valuators, a Value error will result. + +If the request succeeds, Success is returned. If the specifed +device is grabbed by some other client, the request will fail +and a status of AlreadyGrabbed will be returned. + +2.6 Getting Input Device Controls +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + GetDeviceControl + device: DEVICE + control: XID + => + controlState: {DeviceState} + +where + + DeviceState: DeviceResolutionState + + Errors: Length, Device, Match, Value + +This request returns the current state of the specified device +control. The device control must be supported by the target +server and device or an error will result. + +If the request is successful, a pointer to a generic +DeviceState structure will be returned. The information +returned varies according to the specified control and is +mapped by a structure appropriate for that control. + +GetDeviceControl will fail with a BadValue error if the server +does not support the specified control. It will fail with a +BadMatch error if the device does not support the specified +control. + +Supported device controls and the information returned for them +include: + + DEVICE_RESOLUTION: + [control: CARD16 + length: CARD16 + num_valuators: CARD8 + resolutions: LISTofCARD32 + min_resolutions: LISTofCARD32 + max_resolutions: LISTofCARD32] + +This device control returns a list of valuators and the range +of valid resolutions allowed for each. Valuators are numbered +beginning with 0. Resolutions for all valuators on the device +are returned. For each valuator i on the device, resolutions[i] +returns the current setting of the resolution, +min_resolutions[i] returns the minimum valid setting, and +max_resolutions[i] returns the maximum valid setting. + +When this control is specified, XGetDeviceControl will fail +with a BadMatch error if the specified device has no valuators. + + ChangeDeviceControl: + device: DEVICE + XID: controlId + control: DeviceControl + +where + + DeviceControl: DeviceResolutionControl + => + status: {Success, DeviceBusy, AlreadyGrabbed} + + Errors: Length, Device, Match, Value + +ChangeDeviceControl changes the specifed device control +according to the values specified in the DeviceControl +structure. The device control must be supported by the target +server and device or an error will result. + +The information passed with this request varies according to +the specified control and is mapped by a structure appropriate +for that control. + +ChangeDeviceControl will fail with a BadValue error if the +server does not support the specified control. It will fail +with a BadMatch error if the server supports the specified +control, but the requested device does not. The request will +fail and return a status of DeviceBusy if another client +already has the device open with a device control state that +conflicts with the one specified in the request. It will fail +with a status of AlreadyGrabbed if some other client has +grabbed the specified device. If the request succeeds, Success +is returned. If it fails, the device control is left unchanged. + +Supported device controls and the information specified for +them include: + + DEVICE_RESOLUTION: + [control: CARD16 + length: CARD16 + first_valuator: CARD8 + num_valuators: CARD8 + resolutions: LISTofCARD32] + +This device control changes the resolution of the specified +valuators on the specified extension input device. Valuators +are numbered beginning with zero. Only the valuators in the +range specified by first_valuator and num_valuators are set. A +value of -1 in the resolutions list indicates that the +resolution for this valuator is not to be changed. +num_valuators specifies the number of valuators in the +resolutions list. + +When this control is specified, XChangeDeviceControl will fail +with a BadMatch error if the specified device has no valuators. +If a resolution is specified that is not within the range of +valid values (as returned by XGetDeviceControl) the request +will fail with a BadValue error. If the number of valuators +supported by the device is less than the expression +first_valuator + num_valuators, a BadValue error will result. + +If the request fails for any reason, none of the valuator +resolutions will be changed. + +ChangeDeviceControl causes the server to send a DevicePresence +event to interested clients. + +2.7 Selecting Extension Device Events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Extension input events are selected using the +SelectExtensionEvent request. + + SelectExtensionEvent + interest: LISTofEVENTCLASS + window: WINDOW + + Errors: Window, Class, Access + +This request specifies to the server the events within the +specified window which are of interest to the client. As with +the core XSelectInput function, multiple clients can select +input on the same window. + +XSelectExtensionEvent requires a list of event classes. An +event class is a 32-bit number that combines an event type and +device id, and is used to indicate which event a client wishes +to receive and from which device it wishes to receive it. +Macros are provided to obtain event classes from the data +returned by the XOpenDevice request. The names of these macros +correspond to the desired events, i.e. the DeviceKeyPress is +used to obtain the event class for DeviceKeyPress events. The +syntax of the macro invocation is: + + DeviceKeyPress (device, event_type, event_class); + device: DEVICE + event_type: INT + event_class: INT + +The value returned in event_type is the value that will be +contained in the event type field of the XDeviceKeyPressEvent +when it is received by the client. The value returned in +event_class is the value that should be passed in making an +XSelectExtensionEvent request to receive DeviceKeyPress events. + +For DeviceButtonPress events, the client may specify whether or +not an implicit passive grab should be done when the button is +pressed. If the client wants to guarantee that it will receive +a DeviceButtonRelease event for each DeviceButtonPress event it +receives, it should specify the DeviceButtonPressGrab event +class as well as the DeviceButtonPress event class. This +restricts the client in that only one client at a time may +request DeviceButtonPress events from the same device and +window if any client specifies this class. + +If any client has specified the DeviceButtonPressGrab class, +any requests by any other client that specify the same device +and window and specify DeviceButtonPress or +DeviceButtonPressGrab will cause an Access error to be +generated. + +If only the DeviceButtonPress class is specified, no implicit +passive grab will be done when a button is pressed on the +device. Multiple clients may use this class to specify the same +device and window combination. + +A client may also specify the DeviceOwnerGrabButton class. If +it has specified both the DeviceButtonPressGrab and the +DeviceOwnerGrabButton classes, implicit passive grabs will +activate with owner_events set to True. If only the +DeviceButtonPressGrab class is specified, implicit passive +grabs will activate with owner_events set to False. + +The client may select DeviceMotion events only when a button is +down. It does this by specifying the event classes +Button1Motion through Button5Motion, or ButtonMotion. An input +device will only support as many button motion classes as it +has buttons. + +2.8 Determining Selected Events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To determine which extension events are currently selected from +a given window, use GetSelectedExtensionEvents. + + GetSelectedExtensionEvents + window: WINDOW + => + this-client: LISTofEVENTCLASS + all-clients: LISTofEVENTCLASS + + Errors: Window + +This request returns two lists specifying the events selected +on the specified window. One list gives the extension events +selected by this client from the specified window. The other +list gives the extension events selected by all clients from +the specified window. This information is equivalent to that +returned by your-event-mask and all-event-masks in a +GetWindowAttributes request. + +2.9 Controlling Event Propagation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Extension events propagate up the window hierarchy in the same +manner as core events. If a window is not interested in an +extension event, it usually propagates to the closest ancestor +that is interested, unless the dont_propagate list prohibits +it. Grabs of extension devices may alter the set of windows +that receive a particular extension event. + +Client programs may control extension event propagation through +the use of the following two requests. + +XChangeDeviceDontPropagateList adds an event to or deletes an +event from the do_not_propagate list of extension events for +the specified window. This list is maintained for the life of +the window, and is not altered if the client terminates. + + ChangeDeviceDontPropagateList + window: WINDOW + eventclass: LISTofEVENTCLASS + mode: {AddToList, DeleteFromList} + + Errors: Window, Class, Mode + +This function modifies the list specifying the events that are +not propagated to the ancestors of the specified window. You +may use the modes AddToList or DeleteFromList. + + GetDeviceDontPropagateList + window: WINDOW + => + dont-propagate-list: LISTofEVENTCLASS + + Errors: Window + +This function returns a list specifying the events that are not +propagated to the ancestors of the specified window. + +2.10 Sending Extension Events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +One client program may send an event to another via the +XSendExtensionEvent function. + +The event in the XEvent structure must be one of the events +defined by the input extension, so that the X server can +correctly byte swap the contents as necessary. The contents of +the event are otherwise unaltered and unchecked by the X server +except to force send_event to True in the forwarded event and +to set the sequence number in the event correctly. + +XSendExtensionEvent returns zero if the conversion-to-wire +protocol failed, otherwise it returns nonzero. + + SendExtensionEvent + device: DEVICE + destination: WINDOW + propagate: BOOL + eventclass: LISTofEVENTCLASS + event: XEVENT + + Errors: Device, Value, Class, Window + +2.11 Getting Motion History +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + GetDeviceMotionEvents + device: DEVICE + start, stop: TIMESTAMP or CurrentTime + => + nevents_return: CARD32 + mode_return: {Absolute, Relative} + axis_count_return: CARD8 + events: LISTofDEVICETIMECOORD + +where + + DEVICETIMECOORD: + [data: LISTofINT32 + time: TIMESTAMP] + + Errors: Device, Match + +This request returns all positions in the device's motion +history buffer that fall between the specified start and stop +times inclusive. If the start time is in the future, or is +later than the stop time, no positions are returned. + +The data field of the DEVICETIMECOORD structure is a sequence +of data items. Each item is of type INT32, and there is one +data item per axis of motion reported by the device. The number +of axes reported by the device is returned in the axis_count +variable. + +The value of the data items depends on the mode of the device, +which is returned in the mode variable. If the mode is +Absolute, the data items are the raw values generated by the +device. These may be scaled by the client program using the +maximum values that the device can generate for each axis of +motion that it reports. The maximum and minimum values for each +axis are reported by the ListInputDevices request. + +If the mode is Relative, the data items are the relative values +generated by the device. The client program must choose an +initial position for the device and maintain a current position +by accumulating these relative values. + +2.12 Changing The Core Devices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These requests are provided to change which physical device is +used as the X pointer or X keyboard. These requests are +deprecated in servers supporting XI 1.4 and above, and will +always return a a BadDevice error. + +Using these requests may change the characteristics of the core +devices. The new pointer device may have a different number of +buttons than the old one did, or the new keyboard device may +have a different number of keys or report a different range of +keycodes. Client programs may be running that depend on those +characteristics. For example, a client program could allocate +an array based on the number of buttons on the pointer device, +and then use the button numbers received in button events as +indicies into that array. Changing the core devices could cause +such client programs to behave improperly or abnormally +terminate. + +These requests change the X keyboard or X pointer device and +generate an ChangeDeviceNotify event and a MappingNotify event. +The ChangeDeviceNotify event is sent only to those clients that +have expressed an interest in receiving that event via the +XSelectExtensionEvent request. The specified device becomes the +new X keyboard or X pointer device. The location of the core +device does not change as a result of this request. + +These requests fail and return AlreadyGrabbed if either the +specified device or the core device it would replace are +grabbed by some other client. They fail and return GrabFrozen +if either device is frozen by the active grab of another +client. + +These requests fail with a BadDevice error if the specified +device is invalid, or has not previously been opened via +OpenDevice. To change the X keyboard device, use the +ChangeKeyboardDevice request. The specified device must support +input class Keys (as reported in the ListInputDevices request) +or the request will fail with a BadMatch error. Once the device +has successfully replaced one of the core devices, it is +treated as a core device until it is in turn replaced by +another ChangeDevice request, or until the server terminates. +The termination of the client that changed the device will not +cause it to change back. Attempts to use the CloseDevice +request to close the new core device will fail with a BadDevice +error. + +The focus state of the new keyboard is the same as the focus +state of the old X keyboard. If the new keyboard was not +initialized with a FocusRec, one is added by the +ChangeKeyboardDevice request. The X keyboard is assumed to have +a KbdFeedbackClassRec. If the device was initialized without a +KbdFeedbackClassRec, one will be added by this request. The +KbdFeedbackClassRec will specify a null routine as the control +procedure and the bell procedure. + + ChangeKeyboardDevice + device: DEVICE + => + status: Success, AlreadyGrabbed, Frozen + + Errors: Device, Match + +To change the X pointer device, use the ChangePointerDevice +request. The specified device must support input class +Valuators (as reported in the ListInputDevices request) or the +request will fail with a BadMatch error. The valuators to be +used as the x- and y-axes of the pointer device must be +specified. Data from other valuators on the device will be +ignored. + +The X pointer device does not contain a FocusRec. If the new +pointer was initialized with a FocusRec, it is freed by the +ChangePointerDevice request. The X pointer is assumed to have a +ButtonClassRec and a PtrFeedbackClassRec. If the device was +initialized without a ButtonClassRec or a PtrFeedbackClassRec, +one will be added by this request. The ButtonClassRec added +will have no buttons, and the PtrFeedbackClassRec will specify +a null routine as the control procedure. + +If the specified device reports absolute positional +information, and the server implementation does not allow such +a device to be used as the X pointer, the request will fail +with a BadDevice error. + +Once the device has successfully replaced one of the core +devices, it is treated as a core device until it is in turn +replaced by another ChangeDevice request, or until the server +terminates. The termination of the client that changed the +device will not cause it to change back. Attempts to use the +CloseDevice request to close the new core device will fail with +a BadDevice error. + + ChangePointerDevice + device: DEVICE + xaxis: CARD8 + yaxis: CARD8 + => + status: Success, AlreadyGrabbed, Frozen + + Errors: Device, Match + +2.12 Event Synchronization And Core Grabs +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Implementation of the input extension requires an extension of +the meaning of event synchronization for the core grab +requests. This is necessary in order to allow window managers +to freeze all input devices with a single request. + +The core grab requests require a pointer_mode and keyboard_mode +argument. The meaning of these modes is changed by the input +extension. For the XGrabPointer and XGrabButton requests, +pointer_mode controls synchronization of the pointer device, +and keyboard_mode controls the synchronization of all other +input devices. For the XGrabKeyboard and XGrabKey requests, +pointer_mode controls the synchronization of all input devices +except the X keyboard, while keyboard_mode controls the +synchronization of the keyboard. When using one of the core +grab requests, the synchronization of extension devices is +controlled by the mode specified for the device not being +grabbed. + +2.13 Extension Active Grabs +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Active grabs of extension devices are supported via the +GrabDevice request in the same way that core devices are +grabbed using the core GrabKeyboard request, except that a +Device is passed as a function parameter. A list of events that +the client wishes to receive is also passed. The UngrabDevice +request allows a previous active grab for an extension device +to be released. + +To grab an extension device, use the GrabDevice request. The +device must have previously been opened using the OpenDevice +request. + + GrabDevice + device: DEVICE + grab-window: WINDOW + owner-events: BOOL + event-list: LISTofEVENTCLASS + this-device-mode: {Synchronous, Asynchronous} + other-device-mode: {Synchronous, Asynchronous} + time:TIMESTAMP or CurrentTime + => + status: Success, AlreadyGrabbed, Frozen, + InvalidTime, NotViewable + + Errors: Device, Window, Value + +This request actively grabs control of the specified input +device. Further input events from this device are reported only +to the grabbing client. This request overrides any previous +active grab by this client for this device. + +The event-list parameter is a pointer to a list of event +classes. These are used to indicate which events the client +wishes to receive while the device is grabbed. Only event +classes obtained from the grabbed device are valid. + +If owner-events is False, input events generated from this +device are reported with respect to grab-window, and are only +reported if selected by being included in the event-list. If +owner-events is True, then if a generated event would normally +be reported to this client, it is reported normally, otherwise +the event is reported with respect to the grab-window, and is +only reported if selected by being included in the event-list. +For either value of owner-events, unreported events are +discarded. + +If this-device-mode is Asynchronous, device event processing +continues normally. If the device is currently frozen by this +client, then processing of device events is resumed. If +this-device-mode is Synchronous, the state of the grabbed +device (as seen by means of the protocol) appears to freeze, +and no further device events are generated by the server until +the grabbing client issues a releasing AllowDeviceEvents +request or until the device grab is released. Actual device +input events are not lost while the device is frozen; they are +simply queued for later processing. + +If other-device-mode is Asynchronous, event processing is +unaffected by activation of the grab. If other-device-mode is +Synchronous, the state of all input devices except the grabbed +one (as seen by means of the protocol) appears to freeze, and +no further events are generated by the server until the +grabbing client issues a releasing AllowDeviceEvents request or +until the device grab is released. Actual events are not lost +while the devices are frozen; they are simply queued for later +processing. + +This request generates DeviceFocusIn and DeviceFocusOut events. + +This request fails and returns: + + AlreadyGrabbed + If the device is actively grabbed by some other client. + + NotViewable + If grab-window is not viewable. + + InvalidTime + If the specified time is earlier than the last-grab-time + for the specified device or later than the current X + server time. Otherwise, the last-grab-time for the + specified device is set to the specified time and + CurrentTime is replaced by the current X server time. + + Frozen + If the device is frozen by an active grab of another + client. + +If a grabbed device is closed by a client while an active grab +by that client is in effect, that active grab will be released. +Any passive grabs established by that client will be released. +If the device is frozen only by an active grab of the +requesting client, it is thawed. + +To release a grab of an extension device, use UngrabDevice. + + UngrabDevice + device: DEVICE + time: TIMESTAMP or CurrentTime + + Errors: Device + +This request releases the device if this client has it actively +grabbed (from either GrabDevice or GrabDeviceKey) and releases +any queued events. If any devices were frozen by the grab, +UngrabDevice thaws them. The request has no effect if the +specified time is earlier than the last-device-grab time or is +later than the current server time. + +This request generates DeviceFocusIn and DeviceFocusOut events. + +An UngrabDevice is performed automatically if the event window +for an active device grab becomes not viewable. + +2.14 Passively Grabbing A Key +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Passive grabs of buttons and keys on extension devices are +supported via the GrabDeviceButton and GrabDeviceKey requests. +These passive grabs are released via the UngrabDeviceKey and +UngrabDeviceButton requests. + +To passively grab a single key on an extension device, use +GrabDeviceKey. That device must have previously been opened +using the OpenDevice request. + + GrabDeviceKey + device: DEVICE + keycode: KEYCODE or AnyKey + modifiers: SETofKEYMASK or AnyModifier + modifier-device: DEVICE or NULL + grab-window: WINDOW + owner-events: BOOL + event-list: LISTofEVENTCLASS + this-device-mode: {Synchronous, Asynchronous} + other-device-mode: {Synchronous, Asynchronous} + + Errors: Device, Match, Access, Window, Value + +This request is analogous to the core GrabKey request. It +establishes a passive grab on a device. Consequently, in the +future: + + * IF the device is not grabbed and the specified key, which + itself can be a modifier key, is logically pressed when the + specified modifier keys logically are down on the specified + modifier device (and no other keys are down), + * AND no other modifier keys logically are down, + * AND EITHER the grab window is an ancestor of (or is) the + focus window OR the grab window is a descendent of the + focus window and contains the pointer, + * AND a passive grab on the same device and key combination + does not exist on any ancestor of the grab window, + * THEN the device is actively grabbed, as for GrabDevice, the + last-device-grab time is set to the time at which the key + was pressed (as transmitted in the DeviceKeyPress event), + and the DeviceKeyPress event is reported. + +The interpretation of the remaining arguments is as for +GrabDevice. The active grab is terminated automatically when +logical state of the device has the specified key released +(independent of the logical state of the modifier keys). + +Note that the logical state of a device (as seen by means of +the X protocol) may lag the physical state if device event +processing is frozen. + +A modifier of AnyModifier is equivalent to issuing the request +for all possible modifier combinations (including the +combination of no modifiers). It is not required that all +modifiers specified have currently assigned keycodes. A key of +AnyKey is equivalent to issuing the request for all possible +keycodes. Otherwise, the key must be in the range specified by +min-keycode and max-keycode in the ListInputDevices request. If +it is not within that range, GrabDeviceKey generates a Value +error. + +NULL may be passed for the modifier_device. If the +modifier_device is NULL, the core X keyboard is used as the +modifier_device. + +An Access error is generated if some other client has issued a +GrabDeviceKey with the same device and key combination on the +same window. When using AnyModifier or AnyKey, the request +fails completely and the X server generates a Access error and +no grabs are established if there is a conflicting grab for any +combination. + +This request cannot be used to grab a key on the X keyboard +device. The core GrabKey request should be used for that +purpose. + +To release a passive grab of a single key on an extension +device, use UngrabDeviceKey. + + UngrabDeviceKey + device: DEVICE + keycode: KEYCODE or AnyKey + modifiers: SETofKEYMASK or AnyModifier + modifier-device: DEVICE or NULL + grab-window: WINDOW + + Errors: Device, Match, Window, Value, Alloc + +This request is analogous to the core UngrabKey request. It +releases the key combination on the specified window if it was +grabbed by this client. A modifier of AnyModifier is equivalent +to issuing the request for all possible modifier combinations +(including the combination of no modifiers). A key of AnyKey is +equivalent to issuing the request for all possible keycodes. +This request has no effect on an active grab. + +NULL may be passed for the modifier_device. If the +modifier_device is NULL, the core X keyboard is used as the +modifier_device. + +2.15 Passively Grabbing A Button +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To establish a passive grab for a single button on an extension +device, use GrabDeviceButton. + + GrabDeviceButton + device: DEVICE + button: BUTTON or AnyButton + modifiers: SETofKEYMASK or AnyModifier + modifier-device: DEVICE or NULL + grab-window: WINDOW + owner-events: BOOL + event-list: LISTofEVENTCLASS + this-device-mode: {Synchronous, Asynchronous} + other-device-mode: {Synchronous, Asynchronous} + + Errors: Device, Match, Window, Access, Value + +This request is analogous to the core GrabButton request. It +establishes an explicit passive grab for a button on an +extension input device. Since the server does not track +extension devices, no cursor is specified with this request. +For the same reason, there is no confine-to parameter. The +device must have previously been opened using the OpenDevice +request. + +The GrabDeviceButton request establishes a passive grab on a +device. Consequently, in the future, + + * IF the device is not grabbed and the specified button is + logically pressed when the specified modifier keys + logically are down (and no other buttons or modifier + keys are down), + + * AND the grab window contains the device, + + * AND a passive grab on the same device and button/ key + combination does not exist on any ancestor of the grab + window, + + * THEN the device is actively grabbed, as for GrabDevice, + the last-grab time is set to the time at which the + button was pressed (as transmitted in the + DeviceButtonPress event), and the DeviceButtonPress + event is reported. + +The interpretation of the remaining arguments is as for +GrabDevice. The active grab is terminated automatically when +logical state of the device has all buttons released +(independent of the logical state of the modifier keys). + +Note that the logical state of a device (as seen by means of +the X protocol) may lag the physical state if device event +processing is frozen. + +A modifier of AnyModifier is equivalent to issuing the request +for all possible modifier combinations (including the +combination of no modifiers). It is not required that all +modifiers specified have currently assigned keycodes. A button +of AnyButton is equivalent to issuing the request for all +possible buttons. It is not required that the specified button +be assigned to a physical button. + +NULL may be passed for the modifier_device. If the +modifier_device is NULL, the core X keyboard is used as the +modifier_device. + +An Access error is generated if some other client has issued a +GrabDeviceButton with the same device and button combination on +the same window. When using AnyModifier or AnyButton, the +request fails completely and the X server generates a Access +error and no grabs are established if there is a conflicting +grab for any combination. The request has no effect on an +active grab. + +This request cannot be used to grab a button on the X pointer +device. The core GrabButton request should be used for that +purpose. + +To release a passive grab of a button on an extension device, +use UngrabDeviceButton. + + UngrabDeviceButton + device: DEVICE + button: BUTTON or AnyButton + modifiers: SETofKEYMASK or AnyModifier + modifier-device: DEVICE or NULL + grab-window: WINDOW + + Errors: Device, Match, Window, Value, Alloc + +This request is analogous to the core UngrabButton request. It +releases the passive button/key combination on the specified +window if it was grabbed by the client. A modifiers of +AnyModifier is equivalent to issuing the request for all +possible modifier combinations (including the combination of no +modifiers). A button of AnyButton is equivalent to issuing the +request for all possible buttons. This request has no effect on +an active grab. The device must have previously been opened +using the OpenDevice request otherwise a Device error will be +generated. + +NULL may be passed for the modifier_device. If the +modifier_device is NULL, the core X keyboard is used as the +modifier_device. + +This request cannot be used to ungrab a button on the X pointer +device. The core UngrabButton request should be used for that +purpose. + +2.16 Thawing A Device +~~~~~~~~~~~~~~~~~~~~~ + +To allow further events to be processed when a device has been +frozen, use AllowDeviceEvents. + + AllowDeviceEvents + device: DEVICE + event-mode: {AsyncThisDevice, SyncThisDevice, AsyncOtherDevices, + ReplayThisdevice, AsyncAll, or SyncAll} + time:TIMESTAMP or CurrentTime + + Errors: Device, Value + +The AllowDeviceEvents request releases some queued events if +the client has caused a device to freeze. The request has no +effect if the specified time is earlier than the last-grab time +of the most recent active grab for the client, or if the +specified time is later than the current X server time. + +The following describes the processing that occurs depending on +what constant you pass to the event-mode argument: + + * If the specified device is frozen by the client, event + processing for that device continues as usual. If the + device is frozen multiple times by the client on behalf + of multiple separate grabs, AsyncThisDevice thaws for + all. AsyncThisDevice has no effect if the specified + device is not frozen by the client, but the device need + not be grabbed by the client. + + * If the specified device is frozen and actively grabbed + by the client, event processing for that device + continues normally until the next button or key event is + reported to the client. At this time, the specified + device again appears to freeze. However, if the reported + event causes the grab to be released, the specified + device does not freeze. SyncThisDevice has no effect if + the specified device is not frozen by the client or is + not grabbed by the client. + + * If the specified device is actively grabbed by the + client and is frozen as the result of an event having + been sent to the client (either from the activation of a + GrabDeviceButton or from a previous AllowDeviceEvents + with mode SyncThisDevice, but not from a Grab), the grab + is released and that event is completely reprocessed. + This time, however, the request ignores any passive + grabs at or above (towards the root) the grab-window of + the grab just released. The request has no effect if the + specified device is not grabbed by the client or if it + is not frozen as the result of an event. + + * If the remaining devices are frozen by the client, event + processing for them continues as usual. If the other + devices are frozen multiple times by the client on + behalf of multiple separate grabs, AsyncOtherDevices + “thaws” for all. AsyncOtherDevices has no effect if the + devices are not frozen by the client, but those devices + need not be grabbed by the client. + + * If all devices are frozen by the client, event + processing (for all devices) continues normally until + the next button or key event is reported to the client + for a grabbed device (button event for the grabbed + device, key or motion event for the device), at which + time the devices again appear to freeze. However, if the + reported event causes the grab to be released, then the + devices do not freeze (but if any device is still + grabbed, then a subsequent event for it will still cause + all devices to freeze). SyncAll has no effect unless all + devices are frozen by the client. If any device is + frozen twice by the client on behalf of two separate + grabs, SyncAll "thaws" for both (but a subsequent freeze + for SyncAll will only freeze each device once). + + * If all devices are frozen by the client, event + processing (for all devices) continues normally. If any + device is frozen multiple times by the client on behalf + of multiple separate grabs, AsyncAll "thaws" for all. + AsyncAll has no effect unless all devices are frozen by + the client. + +AsyncThisDevice, SyncThisDevice, and ReplayThisDevice +have no effect on the processing of events from the +remaining devices. AsyncOtherDevices has no effect on +the processing of events from the specified device. When +the event_mode is SyncAll or AsyncAll, the device +parameter is ignored. + +It is possible for several grabs of different devices +(by the same or different clients) to be active +simultaneously. If a device is frozen on behalf of any +grab, no event processing is performed for the device. +It is possible for a single device to be frozen because +of several grabs. In this case, the freeze must be +released on behalf of each grab before events can again +be processed. + +2.17 Controlling Device Focus +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The current focus window for an extension input device can be +determined using the GetDeviceFocus request. Extension devices +are focused using the SetDeviceFocus request in the same way +that the keyboard is focused using the SetInputFocus request, +except that a device is specified as part of the request. One +additional focus state, FollowKeyboard, is provided for +extension devices. + +To get the current focus state, revert state, and focus time of +an extension device, use GetDeviceFocus. + + GetDeviceFocus + device: DEVICE + => + focus: WINDOW, PointerRoot, FollowKeyboard, or None + revert-to: Parent, PointerRoot, FollowKeyboard, or None + focus-time: TIMESTAMP + + Errors: Device, Match + +This request returns the current focus state, revert-to state, +and last-focus-time of an extension device. + +To set the focus of an extension device, use SetDeviceFocus. + + SetDeviceFocus + device: DEVICE + focus: WINDOW, PointerRoot, FollowKeyboard, or None + revert-to: Parent, PointerRoot, FollowKeyboard, or None + focus-time: TIMESTAMP + + Errors: Device, Window, Value, Match + +This request changes the focus for an extension input device +and the last-focus-change-time. The request has no effect if +the specified time is earlier than the last-focus-change-time +or is later than the current X server time. Otherwise, the +last-focus-change-time is set to the specified time, with +CurrentTime replaced by the current server time. + +The action taken by the server when this request is requested +depends on the value of the focus argument: + + * If the focus argument is None, all input events from + this device will be discarded until a new focus window + is set. In this case, the revert-to argument is ignored. + + * If a window ID is assigned to the focus argument, it + becomes the focus window of the device. If an input + event from the device would normally be reported to this + window or to one of its inferiors, the event is reported + normally. Otherwise, the event is reported relative to + the focus window. + + * If you assign PointerRoot to the focus argument, the + focus window is dynamically taken to be the root window + of whatever screen the pointer is on at each input + event. In this case, the revert-to argument is ignored. + + * If you assign FollowKeyboard to the focus argument, the + focus window is dynamically taken to be the same as the + focus of the X keyboard at each input event. + The specified focus window must be viewable at the time + of the request (else a Match error). If the focus window + later becomes not viewable, the X server evaluates the + revert-to argument to determine the new focus window. + + * If you assign RevertToParent to the revert-to argument, + the focus reverts to the parent (or the closest viewable + ancestor), and the new revert-to value is taken to be + RevertToNone. + + * If you assign RevertToPointerRoot, + RevertToFollowKeyboard, or RevertToNone to the revert-to + argument, the focus reverts to that value. + +When the focus reverts, the X server generates DeviceFocusIn +and DeviceFocusOut events, but the last-focus-change time is +not affected. + +This request causes the X server to generate DeviceFocusIn and +DeviceFocusOut events. + +2.18 Controlling Device Feedback +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To get the settings of feedbacks on an extension device, use +GetFeedbackControl. This request provides functionality +equivalent to the core GetKeyboardControl and GetPointerControl +functions. It also provides a way to control displays +associated with an input device that are capable of displaying +an integer or string. + + GetFeedbackControl + device: DEVICE + => + num_feedbacks_return: CARD16 + return_value: LISTofFEEDBACKSTATE + +where + + FEEDBACKSTATE: {KbdFeedbackState, PtrFeedbackState, + IntegerFeedbackState, StringFeedbackState, + BellFeedbackState, LedFeedbackState} + +Feedbacks are reported by class. Those feedbacks that are +reported for the core keyboard device are in class KbdFeedback, +and are returned in the KbdFeedbackState structure. The members +of that structure are as follows: + + CLASS Kbd: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + key_click_percent: CARD8 + bell_percent: CARD8 + bell_pitch: CARD16 + bell_duration: CARD16 + led_value: BITMASK + global_auto_repeat: {AutoRepeatModeOn, AutoRepeatModeOff} + auto_repeats: LISTofCARD8] + +Those feedbacks that are equivalent to those reported for the +core pointer are in feedback class PtrFeedback and are reported +in the PtrFeedbackState structure. The members of that +structure are: + + CLASS Ptr: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + accelNumerator: CARD16 + accelDenominator: CARD16 + threshold: CARD16] + +Some input devices provide a means of displaying an integer. +Those devices will support feedback class IntegerFeedback, +which is reported in the IntegerFeedbackState structure. The +members of that structure are: + + CLASS Integer: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + resolution: CARD32 + min-val: INT32 + max-val: INT32] + +Some input devices provide a means of displaying a string. +Those devices will support feedback class StringFeedback, which +is reported in the StringFeedbackState structure. The members +of that structure are: + + CLASS String: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + max_symbols: CARD16 + num_keysyms_supported: CARD16 + keysyms_supported: LISTofKEYSYM] + +Some input devices contain a bell. Those devices will support +feedback class BellFeedback, which is reported in the +BellFeedbackState structure. The members of that structure are: + + CLASS Bell: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + percent: CARD8 + pitch: CARD16 + duration: CARD16] + +The percent sets the base volume for the bell between 0 (off) +and 100 (loud) inclusive, if possible. Setting to -1 restores +the default. Other negative values generate a Value error. + +The pitch sets the pitch (specified in Hz) of the bell, if +possible. Setting to -1 restores the default. Other negative +values generate a Value error. + +The duration sets the duration (specified in milliseconds) of +the bell, if possible. Setting to -1 restores the default. +Other negative values generate a Value error. + +A bell generator connected with the console but not directly on +the device is treated as if it were part of the device. Some +input devices contain LEDs. Those devices will support feedback +class Led, which is reported in the LedFeedbackState structure. +The members of that structure are: + + CLASS Led: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + led_mask: BITMASK + led_value: BITMASK] + +Each bit in led_mask indicates that the corresponding led is +supported by the feedback. At most 32 LEDs per feedback are +supported. No standard interpretation of LEDs is defined. + +This function will fail with a BadMatch error if the device +specified in the request does not support feedbacks. + + Errors: Device, Match + +To change the settings of a feedback on an extension device, +use ChangeFeedbackControl. + + ChangeFeedbackControl + device: DEVICE + feedbackid: CARD8 + value-mask: BITMASK + value: FEEDBACKCONTROL + FEEDBACKCONTROL: {KBDFEEDBACKCONTROL, + PTRFEEDBACKCONTROL, + INTEGERFEEDBACKCONTROL, + STRINGFEEDBACKCONTROL, + BELLFEEDBACKCONTROL, + LEDFEEDBACKCONTROL} + + Errors: Device, Match, Value + +Feedback controls are grouped by class. Those feedbacks that +are equivalent to those supported by the core keyboard are +controlled by feedback class KbdFeedbackClass using the +KbdFeedbackControl structure. The members of that structure +are: + + KBDFEEDBACKCTL + [class: CARD8 + length: CARD16 + feedback id: CARD8 + key_click_percent: INT8 + bell_percent: INT8 + bell_pitch: INT16 + bell_duration: INT16 + led_mask: INT32 + led_value: INT32 + key: KEYCODE + auto_repeat_mode: {AutoRepeatModeOn, AutoRepeatModeOff, + AutoRepeatModeDefault}] + +The key_click_percent sets the volume for key clicks between 0 +(off) and 100 (loud) inclusive, if possible. Setting to -1 +restores the default. Other negative values generate a Value +error. + +If both auto_repeat_mode and key are specified, then the +auto_repeat_mode of that key is changed, if possible. If only +auto_repeat_mode is specified, then the global auto-repeat mode +for the entire keyboard is changed, if possible, without +affecting the per-key settings. It is a Match error if a key is +specified without an auto_repeat_mode. + +The order in which controls are verified and altered is +server-dependent. If an error is generated, a subset of the +controls may have been altered. + +Those feedback controls equivalent to those of the core pointer +are controlled by feedback class PtrFeedbackClass using the +PtrFeedbackControl structure. The members of that structure are +as follows: + + PTRFEEDBACKCTL: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + accelNumerator: INT16 + accelDenominator: INT16 + threshold: INT16] + +The acceleration, expressed as a fraction, is a multiplier for +movement. For example, specifying 3/1 means the device moves +three times as fast as normal. The fraction may be rounded +arbitrarily by the X server. Acceleration only takes effect if +the device moves more than threshold pixels at once and only +applies to the amount beyond the value in the threshold +argument. Setting a value to -1 restores the default. The +values of the do-accel and do-threshold arguments must be +nonzero for the device values to be set. Otherwise, the +parameters will be unchanged. Negative values generate a Value +error, as does a zero value for the accel-denominator argument. + +Some devices are capable of displaying an integer. This is done +using feedback class IntegerFeedbackClass using the +IntegerFeedbackControl structure. The members of that structure +are as follows: + + INTEGERCTL: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + int_to_display: INT32] + +Some devices are capable of displaying a string. This is done +using feedback class StringFeedbackClass using the +StringFeedbackCtl structure. The members of that structure are +as follows: + + STRINGCTL: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + syms_to_display: LISTofKEYSYMS] + +Some devices contain a bell. This is done using feedback class +BellFeedbackClass using the BellFeedbackControl structure. The +members of that structure are as follows: + + BELLCTL: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + percent: INT8 + pitch: INT16 + duration: INT16] + +Some devices contain leds. These can be turned on and off using +the LedFeedbackControl structure. The members of that structure +are as follows: + + LEDCTL: + [class: CARD8 + length: CARD16 + feedback id: CARD8 + led_mask: BITMASK + led_value: BITMASK] + + Errors: Device, Match, Value + +2.20 Ringing a Bell on an Input Device +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To ring a bell on an extension input device, use DeviceBell. + + DeviceBell: + device: DEVICE + feedbackclass: CARD8 + feedbackid: CARD8 + percent: INT8 + + Errors: Device, Value + +This request is analogous to the core Bell request. It rings +the specified bell on the specified input device feedback, +using the specified volume. The specified volume is relative to +the base volume for the feedback. If the value for the percent +argument is not in the range -100 to 100 inclusive, a Value +error results. The volume at which the bell rings when the +percent argument is nonnegative is: + + base - [(base * percent) / 100] + percent + +The volume at which the bell rings when the percent argument is +negative is: + + base + [(base * percent) / 100] + +To change the base volume of the bell, use +ChangeFeedbackControl request. + +Controlling Device Encoding + +To get the keyboard mapping of an extension device that has +keys, use GetDeviceKeyMapping. + + GetDeviceKeyMapping + device: DEVICE + first-keycode: KEYCODE + count: CARD8 + => + keysyms-per-keycode: CARD8 + keysyms: LISTofKEYSYM + + Errors: Device, Match, Value + +This request returns the symbols for the specified number of +keycodes for the specified extension device, starting with the +specified keycode. The first-keycode must be greater than or +equal to min-keycode as returned in the connection setup (else +a Value error), and + + first-keycode + count - 1 + +must be less than or equal to max-keycode as returned in the +connection setup (else a Value error). The number of elements +in the keysyms list is + + count * keysyms-per-keycode + +and KEYSYM number N (counting from zero) for keycode K has an +index (counting from zero) of + + (K - first-keycode) * keysyms-per-keycode + N + +in keysyms. The keysyms-per-keycode value is chosen arbitrarily +by the server to be large enough to report all requested +symbols. A special KEYSYM value of NoSymbol is used to fill in +unused elements for individual keycodes. + +If the specified device has not first been opened by this +client via OpenDevice, or if that device does not support input +class Keys, this request will fail with a Device error. + +To change the keyboard mapping of an extension device that has +keys, use ChangeDeviceKeyMapping. + + ChangeDeviceKeyMapping + device: DEVICE + first-keycode: KEYCODE + keysyms-per-keycode: CARD8 + keysyms: LISTofKEYSYM + num_codes: CARD8 + + Errors: Device, Match, Value, Alloc + +This request is analogous to the core ChangeKeyMapping request. +It defines the symbols for the specified number of keycodes for +the specified extension device. If the specified device has not +first been opened by this client via OpenDevice, or if that +device does not support input class Keys, this request will +fail with a Device error. + +The number of elements in the keysyms list must be a multiple +of keysyms_per_keycode. Otherwise, ChangeDeviceKeyMapping +generates a Length error. The specified first_keycode must be +greater than or equal to the min_keycode value returned by the +ListInputDevices request, or this request will fail with a +Value error. In addition, if the following expression is not +less than the max_keycode value returned by the +ListInputDevices request, the request will fail with a Value +error: + + first_keycode + (num_codes / keysyms_per_keycode) - 1 + +To obtain the keycodes that are used as modifiers on an +extension device that has keys, use GetDeviceModifierMapping. + + GetDeviceModifierMapping + device: DEVICE + => + keycodes-per-modifier: CARD8 + keycodes: LISTofKEYCODE + + Errors: Device, Match + +This request is analogous to the core GetModifierMapping +request. This request returns the keycodes of the keys being +used as modifiers. The number of keycodes in the list is +8*keycodes-per-modifier. The keycodes are divided into eight +sets, with each set containing keycodes-per-modifier elements. +The sets are assigned in order to the modifiers Shift, Lock, +Control, Mod1, Mod2, Mod3, Mod4, and Mod5. The +keycodes-per-modifier value is chosen arbitrarily by the +server; zeroes are used to fill in unused elements within each +set. If only zero values are given in a set, the use of the +corresponding modifier has been disabled. The order of keycodes +within each set is chosen arbitrarily by the server. + +To set which keycodes that are to be used as modifiers for an +extension device, use SetDeviceModifierMapping. + + SetDeviceModifierMapping + device: DEVICE + keycodes-per-modifier: CARD8 + keycodes: LISTofKEYCODE + => + status: {Success, Busy, Failed} + + Errors: Device, Match, Value, Alloc + +This request is analogous to the core SetModifierMapping +request. This request specifies the keycodes (if any) of the +keys to be used as modifiers. The number of keycodes in the +list must be 8*keycodes-per-modifier (else a Length error). The +keycodes are divided into eight sets, with the sets, with each +set containing keycodes-per-modifier elements. The sets are +assigned in order to the modifiers Shift, Lock, Control, Mod1, +Mod2, Mod3, Mod4, and Mod5. Only non-zero keycode values are +used within each set; zero values are ignored. All of the +non-zero keycodes must be in the range specified by min-keycode +and max-keycode in the ListInputDevices request (else a Value +error). The order of keycodes within a set does not matter. If +no non-zero values are specified in a set, the use of the +corresponding modifier is disabled, and the modifier bit will +always be zero. Otherwise, the modifier bit will be one +whenever at least one of the keys in the corresponding set is +in the down position. + +A server can impose restrictions on how modifiers can be +changed (for example, if certain keys do not generate up +transitions in hardware or if multiple keys per modifier are +not supported). If some such restriction is violated, the status +reply is MappingFailed, and none of the modifiers are changed. + +If the new keycodes specified for a modifier differ from those +currently defined and any (current or new) keys for that +modifier are in the logically down state, the status reply is +MappingBusy, and none of the modifiers are changed. + +This request generates a DeviceMappingNotify event on a Success +status. The DeviceMappingNotify event will be sent only to +those clients that have expressed an interest in receiving that +event via the XSelectExtensionEvent request. + +2.20 Controlling Button Mapping +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These requests are analogous to the core GetPointerMapping and +ChangePointerMapping requests. They allow a client to determine +the current mapping of buttons on an extension device, and to +change that mapping. + +To get the current button mapping for an extension device, use +GetDeviceButtonMapping. + + GetDeviceButtonMapping + device: DEVICE + nmap: CARD8 + => + map_return: LISTofCARD8 + + Errors: Device, Match + +The GetDeviceButtonMapping function returns the current mapping +of the buttons on the specified device. Elements of the list +are indexed starting from one. The length of the list indicates +the number of physical buttons. The nominal mapping is the +identity mapping map[i]=i. + +nmap indicates the number of elements in the map_return array. +Only the first nmap entries will be copied by the library into +the map_return array. + +To set the button mapping for an extension device, use +SetDeviceButtonMapping. + + SetDeviceButtonMapping + device: DEVICE + map: LISTofCARD8 + nmap: CARD8 + => + status: CARD8 + + Errors: Device, Match, Value + +The SetDeviceButtonMapping function sets the mapping of the +specified device and causes the X server to generate a +DeviceMappingNotify event on a status of MappingSuccess. +Elements of the list are indexed starting from one. The length +of the list, specified in nmap, must be the same as +GetDeviceButtonMapping would return. Otherwise, +SetDeviceButtonMapping generates a Value error. A zero element +disables a button, and elements are not restricted in value by +the number of physical buttons. If any of the buttons to be +altered are in the down state, the status reply is MappingBusy +and the mapping is not changed. + +In servers supporting XI 1.x, no two elements can have the same +nonzero value. Otherwise, this function generates a Value +error. + +2.21 Obtaining The State Of A Device +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To obtain vectors that describe the state of the keys, buttons +and valuators of an extension device, use QueryDeviceState. + + QueryDeviceState + device: DEVICE + => + device-id: CARD8 + data: LISTofINPUTCLASS + +where + + INPUTCLASS: {VALUATOR, BUTTON, KEY} + CLASS VALUATOR: + [class: CARD8 + num_valuators: CARD8 + mode: CARD8 + #x01 device mode (0 = Relative, 1 = Absolute) + #x02 proximity state (0 = InProximity, 1 = OutOfProximity) + valuators: LISTofINT32] + CLASS BUTTON: + [class: CARD8 + num_buttons: CARD8 + buttons: LISTofCARD8] + CLASS KEY: + [class: CARD8 + num_keys: CARD8 + keys: LISTofCARD8] + + Errors: Device + +The QueryDeviceState request returns the current logical state +of the buttons, keys, and valuators on the specified input +device. The buttons and keys arrays, byte N (from 0) contains +the bits for key or button 8N to 8N+7 with the least +significant bit in the byte representing key or button 8N. + +If the device has valuators, a bit in the mode field indicates +whether the device is reporting Absolute or Relative data. If +it is reporting Absolute data, the valuators array will contain +the current value of the valuators. If it is reporting Relative +data, the valuators array will contain undefined data. + +If the device reports proximity information, a bit in the mode +field indicates whether the device is InProximity or +OutOfProximity. + +2.22 Listing Device Properties +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Introduced with XI 1.5 + + ListDeviceProperties + deviceid: CARD8 + => + nAtoms: CARD16 + Atoms: LISTofATOM + + Errors: Device + +Each device can store an arbitrary number of properties. These +properties can be allocated by either the client or the driver. +The client can change device properties and the server +guarantees that the device driver is notified about a change of +the device's properties. + +ListDeviceProperties returns all properties of a device. The +client is expected to retrieve details about the properties it +is interested in separately. + +2.23 Getting a Device Property +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Introduced with XI 1.5 + + GetDeviceProperty: + property: ATOM + type: ATOM + longOffset: CARD32 + longLength: CARD32 + deviceid: CARD8 + delete: BOOL + => + propertyType: ATOM + bytesAfter: CARD32 + nItems: CARD32 + format: CARD8 + deviceid: CARD8 + data: [LISTofCARD8] + + Errors: Atom, Device, Value, Access + +Retrieve the value for a property. If the property does not +exist, propertyType is None and all other fields are undefined. + +If type is not AnyPropertyType and does not match the +property's actual type, the propertyType, bytesAfter, and +format are returned but not the actual data. + +longOffset and longLength specify the offset and length +respectively in 32-bit multiples of the data to retrieve. + +If delete is True, the property is deleted after querying its +data. If the property cannot be deleted, a BadAccess error is +returned. + +propertyType returns the atom identifier that defines the +actual type of the property. + +If bytesAfter is non-zero, it specifies the number of data +4-byte units after the retrieved chunk of data. + +format specifies whether the data should be viewed as a list of +8-bit, 16-bit, or 32-bit quantities. Possible values are 8, 16, +and 32. This information allows the X server to correctly +perform byte-swap operations as necessary. + +nItem specifies the number of 8-bit, 16-bit, or 32-bit items +returned after the request. + +2.24 Changing a Device Property +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Introduced with XI 1.5 + + ChangeDeviceProperty: + property: ATOM + type: ATOM + deviceid: CARD8 + format: CARD8 + mode: CARD8 + nUnits: CARD32 + + Errors: Atom, Device, Value, Match, Access + +Changes the value of a specified property. + +The type specifies the atom identifier that defines the type of +the property. If mode is not PropModeReplace, the type must +match the current type of the property or a BadMatch error is +returned. + +format specifies whether the data should be viewed as a list of +8-bit, 16-bit, or 32-bit quantities. Possible values are 8, 16, +and 32. This information allows the X server to correctly +perform byte-swap operations as necessary. + +If mode is PropModeReplace, a preexising value for this +property is replaced with the new value. If mode is +PropModePrepend or PropModeAppend, the value is prepended or +appended, respectively, to the current value of the property. + +nUnits specifies the number of 8-bit, 16-bit, or 32-bit items +supplied after the reply. + +Changing a device property results in a +DevicePropertyNotifyEvent being sent to all clients. + +2.25 Deleting a Device Property +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Introduced with XI 1.5 + + DeleteDeviceProperty: + property: ATOM + deviceid: CARD8 + + Errors: Atom, Device, Match, Access. + +Deletes the specified property. If the property cannot be +deleted by the client, a BadAccess error is returned. + +3. Events +--------- + +The input extension creates input events analogous to the core +input events. These extension input events are generated by +manipulating one of the extension input devices. + +3.1 Button, Key, and Motion Events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + DeviceKeyPress + DeviceKeyRelease + DeviceButtonPress, + DeviceButtonRelease + DeviceMotionNotify + device: CARD8 + root, event: WINDOW + child: Window or None + same-screen: BOOL + root-x, root-y, event-x, event-y: INT16 + detail: <see below> + state: SETofKEYBUTMASK + time: TIMESTAMP + +These events are generated when a key, button, or valuator +logically changes state. The generation of these logical +changes may lag the physical changes, if device event +processing is frozen. Note that DeviceKeyPress and +DeviceKeyRelease are generated for all keys, even those mapped +to modifier bits. The “source” of the event is the window the +pointer is in. The window with respect to which the event is +normally reported is found by looking up the hierarchy +(starting with the source window) for the first window on which +any client has selected interest in the event. The actual +window used for reporting can be modified by active grabs and +by the focus window.The window the event is reported with +respect to is called the “event” window. + +The root is the root window of the “source” window, and root-x +and root-y are the pointer coordinates relative to root's +origin at the time of the event. Event is the “event” window. +If the event window is on the same screen as root, then event-x +and event-y are the pointer coordinates relative to the event +window's origin. Otherwise, event-x and event-y are zero. If +the source window is an inferior of the event window, then +child is set to the child of the event window that is an +ancestor of (or is) the source window. Otherwise, it is set to +None. + +The state component gives the logical state of the buttons on +the X pointer and modifier keys on the core X keyboard just +before the event. + +The detail component type varies with the event type: +Event Component +DeviceKeyPress KEYCODE +DeviceKeyRelease KEYCODE +DeviceButtonPress BUTTON +DeviceButtonRelease BUTTON +DeviceMotionNotify { Normal , Hint } + +The granularity of motion events is not guaranteed, but a +client selecting for motion events is guaranteed to get at +least one event when a valuator changes. If DeviceMotionHint is +selected, the server is free to send only one +DeviceMotionNotify event (with detail Hint) to the client for +the event window, until either a key or button changes state, +the pointer leaves the event window, or the client issues a +QueryDeviceState or GetDeviceMotionEvents request. + +3.2 DeviceValuator Event +~~~~~~~~~~~~~~~~~~~~~~~~ + + DeviceValuator + device: CARD8 + device_state: SETofKEYBUTMASK + num_valuators: CARD8 + first_valuator: CARD8 + valuators: LISTofINT32 + +DeviceValuator events are generated to contain valuator +information for which there is insufficient space in DeviceKey, +DeviceButton, DeviceMotion, and Proximity wire events. For +events of these types, a second event of type DeviceValuator +follows immediately. The library combines these events into a +single event that a client can receive via XNextEvent. +DeviceValuator events are not selected for by clients, they +only exist to contain information that will not fit into some +event selected by clients. + +The device_state component gives the state of the buttons and +modifiers on the device generating the event. + +Extension motion devices may report motion data for a variable +number of axes. The valuators array contains the values of all +axes reported by the device. If more than 6 axes are reported, +more than one DeviceValuator event will be sent by the server, +and more than one DeviceKey, DeviceButton, DeviceMotion, or +Proximity event will be reported by the library. Clients should +examine the corresponding fields of the event reported by the +library to determine the total number of axes reported, and the +first axis reported in the current event. Axes are numbered +beginning with zero. + +For Button, Key and Motion events on a device reporting +absolute motion data the current value of the device's +valuators is reported. For devices that report relative data, +Button and Key events may be followed by a DeviceValuator event +that contains 0s in the num_valuators field. In this case, only +the device_state component will have meaning. + +3.3 Device Focus Events +~~~~~~~~~~~~~~~~~~~~~~~ + + DeviceFocusIn + DeviceFocusOut + device: CARD8 + time: TIMESTAMP + event: WINDOW + mode: { Normal, WhileGrabbed, Grab, Ungrab} + detail: { Ancestor, Virtual, Inferior, Nonlinear, + NonlinearVirtual, Pointer, PointerRoot, None} + +These events are generated when the input focus changes and are +reported to clients selecting DeviceFocusChange for the +specified device and window. Events generated by SetDeviceFocus +when the device is not grabbed have mode Normal. Events +generated by SetDeviceFocus when the device is grabbed have +mode WhileGrabbed. Events generated when a device grab activates +have mode Grab, and events generated when a device grab +deactivates have mode Ungrab. + +All DeviceFocusOut events caused by a window unmap are +generated after any UnmapNotify event, but the ordering of +DeviceFocusOut with respect to generated EnterNotify, +LeaveNotify, VisibilityNotify and Expose events is not +constrained. + +DeviceFocusIn and DeviceFocusOut events are generated for focus +changes of extension devices in the same manner as focus events +for the core devices are generated. + +3.4 Device State Notify Event +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + DeviceStateNotify + time: TIMESTAMP + device: CARD8 + num_keys: CARD8 + num_buttons: CARD8 + num_valuators: CARD8 + classes_reported: CARD8 {SetOfDeviceMode | SetOfInputClass} + SetOfDeviceMode: + #x80 ProximityState 0 = InProxmity, 1 = OutOfProximity + #x40 Device Mode (0 = Relative, 1 = Absolute) + SetOfInputClass: #x04 reporting valuators + #x02 reporting buttons + #x01 reporting keys + buttons: LISTofCARD8 + keys: LISTofCARD8 + valuators: LISTofCARD32 + +This event reports the state of the device just as in the +QueryDeviceState request. This event is reported to clients +selecting DeviceStateNotify for the device and window and is +generated immediately after every EnterNotify and +DeviceFocusIn. If the device has no more than 32 buttons, no +more than 32 keys, and no more than 3 valuators, This event can +report the state of the device. If the device has more than 32 +buttons, the event will be immediately followed by a +DeviceButtonStateNotify event. If the device has more than 32 +keys, the event will be followed by a DeviceKeyStateNotify +event. If the device has more than 3 valuators, the event will +be followed by one or more DeviceValuator events. + +3.5 Device KeyState and ButtonState Notify Events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + DeviceKeyStateNotify + device: CARD8 + keys: LISTofCARD8 + DeviceButtonStateNotify + device: CARD8 + buttons: LISTofCARD8 + +These events contain information about the state of keys and +buttons on a device that will not fit into the +DeviceStateNotify wire event. These events are not selected by +clients, rather they may immediately follow a DeviceStateNotify +wire event and be combined with it into a single +DeviceStateNotify client event that a client may receive via +XNextEvent. + +3.6 DeviceMappingNotify Event +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + DeviceMappingNotify + time: TIMESTAMP + device: CARD8 + request: CARD8 + first_keycode: CARD8 + count: CARD8 + +This event reports a change in the mapping of keys, modifiers, +or buttons on an extension device. This event is reported to +clients selecting DeviceMappingNotify for the device and window +and is generated after every client SetDeviceButtonMapping, +ChangeDeviceKeyMapping, or ChangeDeviceModifierMapping request. + +3.7 ChangeDeviceNotify Event +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + ChangeDeviceNotify + device: CARD8 + time: TIMESTAMP + request: CARD8 + +This event reports a change in the physical device being used +as the core X keyboard or X pointer device. ChangeDeviceNotify +events are reported to clients selecting ChangeDeviceNotify for +the device and window and is generated after every client +ChangeKeyboardDevice or ChangePointerDevice request. + +3.7 Proximity Events +~~~~~~~~~~~~~~~~~~~~ + + ProximityIn + ProximityOut + device: CARD8 + root, event: WINDOW + child: Window or None + same-screen: BOOL + root-x, root-y, event-x, event-y: INT16 + state: SETofKEYBUTMASK + time: TIMESTAMP + device-state: SETofKEYBUTMASK + axis-count: CARD8 + first-axis: CARD8 + axis-data: LISTofINT32 + +These events are generated by some devices (such as graphics +tablets or touchscreens) to indicate that a stylus has moved +into or out of contact with a positional sensing surface. + +The “source” of the event is the window the pointer is in. The +window with respect to which the event is normally reported is +found by looking up the hierarchy (starting with the source +window) for the first window on which any client has selected +interest in the event. The actual window used for reporting can +be modified by active grabs and by the focus window.The window +the event is reported with respect to is called the “event” +window. + +The root is the root window of the “source” window, and root-x +and root-y are the pointer coordinates relative to root's +origin at the time of the event. Event is the “event” window. +If the event window is on the same screen as root, then event-x +and event-y are the pointer coordinates relative to the event +window's origin. Otherwise, event-x and event-y are zero. If +the source window is an inferior of the event window, then +child is set to the child of the event window that is an +ancestor of (or is) the source window. Otherwise, it is set to +None. The state component gives the logical state of the +buttons on the core X pointer and modifier keys on the core X +keyboard just before the event. The device-state component +gives the state of the buttons and modifiers on the device +generating the event. + +3.8 DevicePresenceEvents +~~~~~~~~~~~~~~~~~~~~~~~~ + +Introduced with XI 1.4. + + DevicePresence + time: TIMESTAMP + devchange: BYTE + #x00: DeviceAdded + #x01: DeviceRemoved + #x02: DeviceEnabled + #x03: DeviceDisabled + #x04: DeviceUnrecoverable + #x05: DeviceControlChanged + deviceid: BYTE + control: CARD16 + +DevicePresence events are sent when the server adds or removes, +or enables or disables an input device. The client is expected +to query the server for the list of input devices using the +ListInputDevices request to obtain the updated list of input +devices. DevicePresence events are also sent when a control on +the device has been changed. + +The devchange field specifies the type of operation. In case of +DeviceAdded, a new device has been added to the server, but +this device does not yet send events. If devchange is set to +DeviceEnabled, the device is enabled and will generate events. +If the field is DeviceDisabled or DeviceRemoved, the given +device is disabled and stops sending events or was removed from +the server, respectively. If the field is DeviceUnrecoverable, +an IO-error has occured on the device and the device is +forcibly disabled and removed by the server. If devchange is +DeviceControlChanged, control specifies the type of control +that has been changed. + +3.9 DevicePropertyNotifyEvent +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Introduced with XI 1.5. + + DevicePropertyNotifyEvent + deviceid: CARD8 + state: CARD8 + time: TIMESTAMP + atom: ATOM + +A DevicePropertyNotifyEvent is sent to all clients when a +property on the device is created, deleted, or changes value. + +The deviceid specifies the device which's property has been +modified. + +The atom specifies the named identifier of the property that +has been altered. + +If state is PropertyNewValue, the given property has a new +value or has been newly created. If state is PropertyDeleted, +the given property has been deleted. diff --git a/specs/bigreq.xml b/specs/bigreq.xml new file mode 100644 index 0000000..1d1d84d --- /dev/null +++ b/specs/bigreq.xml @@ -0,0 +1,332 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "defs.ent"> %defs; +]> + +<!-- lifted from troff+ms+XMan by doclifter --> +<book id="bigreq"> + +<bookinfo> + <title>Big Requests Extension</title> + <subtitle>X Consortium Standard</subtitle> + <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo> + <releaseinfo>Version 2.0</releaseinfo> + <authorgroup> + <author> + <firstname>Bob</firstname><surname>Scheifler</surname> + <affiliation><orgname>X Consortium</orgname></affiliation> + </author> + </authorgroup> + <copyright><year>1993</year><year>1994</year><holder>X Consortium</holder></copyright> + +<legalnotice> +<para>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</para> + +<para>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</para> + +<para>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</para> + +<para>Except as contained in this notice, the name of the X Consortium shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the X Consortium.</para> + +<para>X Window System is a trademark of The Open Group.</para> +</legalnotice> + +</bookinfo> + +<chapter id='Overview'> +<title>Overview</title> + +<para>This extension enables the use of protocol requests that exceed 262140 bytes in length.</para> + +<para>The core protocol restricts the maximum length of a protocol request to 262140 bytes, in that it uses a 16-bit length field specifying the number of 4-byte units in the request. This is a problem in the core protocol when joining large numbers of lines (<symbol role='Pn'>PolyLine</symbol>) or arcs (<symbol role='Pn'>PolyArc</symbol>), since these requests cannot be broken up into smaller requests without disturbing the rendering of the join points. It is also much more of a problem for protocol extensions, such as the PEX extension for 3D graphics and the XIE extension for imaging, that need to send long data lists in output commands.</para> + +<para>This extension defines a mechanism for extending the length field beyond 16 bits. If the normal 16-bit length field of the protocol request is zero, then an additional 32-bit field containing the actual length (in 4-byte units) is inserted into the request, immediately following the 16-bit length field.</para> + +<para>For example, a normal <function>PolyLine</function> encoding is:</para> + +<informaltable id='PolyLine' frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='4' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='3.0*'/> + <colspec colname='c3' colwidth='2.0*'/> + <colspec colname='c4' colwidth='11.0*'/> + <thead> + <row> + <entry namest="c1" nameend="c4"><function>PolyLine</function></entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>65</entry> + <entry></entry> + <entry>opcode</entry> + </row> + <row> + <entry>1</entry> + <entry></entry> + <entry></entry> + <entry>coordinate-mode</entry> + </row> + <row> + <entry></entry> + <entry>0</entry> + <entry>Origin</entry> + <entry></entry> + </row> + <row> + <entry></entry> + <entry>1</entry> + <entry>Previous</entry> + <entry></entry> + </row> + <row> + <entry>2</entry> + <entry>3+n</entry> + <entry></entry> + <entry></entry> + </row> + <row> + <entry>4</entry> + <entry>DRAWABLE</entry> + <entry></entry> + <entry>drawable</entry> + </row> + <row> + <entry>4</entry> + <entry>GCONTEXT</entry> + <entry></entry> + <entry>gc</entry> + </row> + <row> + <entry>4n</entry> + <entry>LISTofPOINT</entry> + <entry></entry> + <entry>points</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para>An extended-length <function>PolyLine</function> encoding is:</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='4' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='3.0*'/> + <colspec colname='c3' colwidth='2.0*'/> + <colspec colname='c4' colwidth='11.0*'/> + <thead> + <row> + <entry namest="c1" nameend="c4"><function>PolyLine</function></entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>65</entry> + <entry></entry> + <entry>opcode</entry> + </row> + <row> + <entry>1</entry> + <entry></entry> + <entry></entry> + <entry>coordinate-mode</entry> + </row> + <row> + <entry></entry> + <entry>0</entry> + <entry>Origin</entry> + <entry></entry> + </row> + <row> + <entry></entry> + <entry>1</entry> + <entry>Previous</entry> + <entry></entry> + </row> + <row> + <entry>2</entry> + <entry>0</entry> + <entry></entry> + <entry>extended length flag</entry> + </row> + <row> + <entry>4</entry> + <entry>4+n</entry> + <entry></entry> + <entry>request length</entry> + </row> + <row> + <entry>4</entry> + <entry>DRAWABLE</entry> + <entry></entry> + <entry>drawable</entry> + </row> + <row> + <entry>4</entry> + <entry>GCONTEXT</entry> + <entry></entry> + <entry>gc</entry> + </row> + <row> + <entry>4n</entry> + <entry>LISTofPOINT</entry> + <entry></entry> + <entry>points</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para>Extended-length protocol encodings, once enabled, can be used on all protocol requests, including all extensions.</para> +</chapter> + +<chapter id='Requests'> +<title>Requests</title> + +<para><function>BigReqEnable</function></para> + +<para> =></para> + +<para><emphasis remap='I'>maximum-request-length</emphasis>: CARD32</para> + +<para>This request enables extended-length protocol requests for the requesting client. It also returns the maximum length of a request, in 4-byte units, that can be used in extended-length protocol requests. This value will always be greater than the maximum-request-length returned in the connection setup information.</para> +</chapter> + +<chapter id='Events_and_Errors'> +<title>Events and Errors</title> + +<para>No new events or errors are defined by this extension.</para> +</chapter> + +<chapter id='Encoding'> +<title>Encoding</title> + +<para>Please refer to the X11 Protocol Encoding document as this document uses conventions established there.</para> + +<para>The name of this extension is “BIG-REQUESTS”.</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <colspec colname='c3' colwidth='15.0*'/> + <thead> + <row> + <entry namest="c1" nameend="c3">BigReqEnable</entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>Card8</entry> + <entry>opcode</entry> + </row> + <row> + <entry>1</entry> + <entry>0</entry> + <entry>bigreq opcode</entry> + </row> + <row> + <entry>2</entry> + <entry>1</entry> + <entry>request length</entry> + </row> + </tbody> + </tgroup> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <colspec colname='c3' colwidth='15.0*'/> + <thead> + <row> + <entry namest="c1" nameend="c3">=></entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>1</entry> + <entry>Reply</entry> + </row> + <row> + <entry>1</entry> + <entry></entry> + <entry>unused</entry> + </row> + <row> + <entry>2</entry> + <entry>CARD16</entry> + <entry>sequence number</entry> + </row> + <row> + <entry>4</entry> + <entry>0</entry> + <entry>length</entry> + </row> + <row> + <entry>4</entry> + <entry>CARD32</entry> + <entry>maximum-request-length</entry> + </row> + <row> + <entry>20</entry> + <entry></entry> + <entry>unused</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +</chapter> + +<chapter id='C_Language_Binding'> +<title>C language binding</title> + +<para>It is desirable for core Xlib, and other extensions, to use this extension internally when necessary. It is also desirable to make the use of this extension as transparent as possible to the X client. For example, if enabling of the extension were delayed until the first time it was needed, an application that used +<olink targetdoc='libX11' targetptr='XNextRequest'><function>XNextRequest</function></olink> +to determine the sequence number of a request would no longer get the correct sequence number. As such, +<olink targetdoc='libX11' targetptr='XOpenDisplay'><function>XOpenDisplay</function></olink> +will determine if the extension is supported by the server and, if it is, enable extended-length encodings.</para> + +<para>The core Xlib functions +<olink targetdoc='libX11' targetptr='XDrawLines'><function>XDrawLines</function></olink>, +<olink targetdoc='libX11' targetptr='XDrawArcs'><function>XDrawArcs</function></olink>, +<olink targetdoc='libX11' targetptr='XFillPolygon'><function>XFillPolygon</function></olink>, +<olink targetdoc='libX11' targetptr='XChangeProperty'><function>XChangeProperty</function></olink>, +<olink targetdoc='libX11' targetptr='XSetClipRectangles'><function>XSetClipRectangles</function></olink>, and +<olink targetdoc='libX11' targetptr='XSetRegion'><function>XSetRegion</function></olink>. +are required to use extended-length encodings when necessary, if supported by the server. Use of extended-length encodings in other core Xlib functions +(<olink targetdoc='libX11' targetptr='XDrawPoints'><function>XDrawPoints</function></olink>, +<olink targetdoc='libX11' targetptr='XDrawRectangles'><function>XDrawRectangles</function></olink>, +<olink targetdoc='libX11' targetptr='XDrawSegments'><function>XDrawSegments</function></olink>. +<olink targetdoc='libX11' targetptr='XFillArcs'><function>XFillArcs</function></olink>, +<olink targetdoc='libX11' targetptr='XFillRectangles'><function>XFillRectangles</function></olink>, +<olink targetdoc='libX11' targetptr='XPutImage'><function>XPutImage</function></olink> +is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead.</para> + +<para>To permit clients to know what the maximum-request-length for extended-length encodings is, the following function is added to Xlib: + +<funcsynopsis id='XExtendedMaxRequestSize'> +<funcprototype> + <funcdef>long <function>XExtendedMaxRequestSize</function></funcdef> + <paramdef>Display <parameter> *display</parameter></paramdef> +</funcprototype> +</funcsynopsis> + +Returns zero (0) if the specified display does not support this extension, otherwise returns the maximum-request-length (in 4-byte units) supported by the server through the extended-length encoding.</para> +</chapter> + +<chapter id='Acknowledgements'> +<title>Acknowledgements</title> + +<para>Clive Feather (IXI) originated the extended-length encoding used in this extension proposal.</para> +</chapter> +</book> diff --git a/specs/encoding.xml b/specs/encoding.xml new file mode 100644 index 0000000..0c6ef02 --- /dev/null +++ b/specs/encoding.xml @@ -0,0 +1,3268 @@ +<appendix id="protocol_encoding"> +<title>Protocol Encoding</title> +<!-- + The sections in this appendix correspond to their + number counterparts in the protocol document. +--> +<sect1 id='Syntactic_Conventions_b'> +<title>Syntactic Conventions</title> + +<para> +All numbers are in decimal, +unless prefixed with #x, in which case they are in hexadecimal (base 16). +</para> + +<para> +The general syntax used to describe requests, replies, errors, events, and +compound types is: +</para> + +<literallayout class="monospaced"> + <emphasis role='bold'>NameofThing</emphasis> + encode-form + ... + encode-form +</literallayout> + +<para> +Each encode-form describes a single component. +</para> +<para> +For components described in the protocol as: +</para> +<literallayout class="monospaced"> + name: TYPE +</literallayout> + +<para> +the encode-form is: +</para> + +<literallayout class="monospaced"> + N TYPE name +</literallayout> + +<para> +N is the number of bytes occupied in the data stream, +and TYPE is the interpretation of those bytes. +For example, +</para> + +<literallayout class="monospaced"> + depth: CARD8 +</literallayout> + +<para> +becomes: +</para> + +<literallayout class="monospaced"> + 1 CARD8 depth +</literallayout> + +<para> +For components with a static numeric value the encode-form is: +</para> + +<literallayout class="monospaced"> + N value name +</literallayout> + +<para> +The value is always interpreted as an N-byte unsigned integer. +For example, +the first two bytes of a +<emphasis role='bold'>Window</emphasis> +error are always zero (indicating an +error in general) and three (indicating the +<emphasis role='bold'>Window</emphasis> +error in particular): +</para> + +<literallayout class="monospaced"> + 1 0 Error + 1 3 code +</literallayout> + +<para> +For components described in the protocol as: +</para> + +<para> +name: +{ <emphasis role='bold'>Name1</emphasis>,..., +<emphasis role='bold'>NameI</emphasis>} +</para> + +<para> +the encode-form is: +</para> + +<literallayout class="monospaced"> + N name + value1 Name1 + ... + valueI NameI +</literallayout> + +<para> +The value is always interpreted as an N-byte unsigned integer. +Note that the size of N is sometimes larger than that strictly required +to encode the values. +For example: +</para> + +<para> +class: +{ <emphasis role='bold'>InputOutput</emphasis>, +<emphasis role='bold'>InputOnly</emphasis>, +<emphasis role='bold'>CopyFromParent</emphasis> } +</para> + +<para> +becomes: +</para> + +<literallayout class="monospaced"> +2 class + 0 CopyFromParent + 1 InputOutput + 2 InputOnly +</literallayout> + +<para> +For components described in the protocol as: +</para> + +<para> +NAME: TYPE or +<emphasis role='bold'>Alternative1 ...or</emphasis> +<emphasis role='bold'>AlternativeI</emphasis> +</para> + +<para> +the encode-form is: +</para> + +<literallayout class="monospaced"> +N TYPE NAME + value1 Alternative1 + ... + valueI AlternativeI +</literallayout> + +<para> +The alternative values are guaranteed not to conflict with the encoding +of TYPE. +For example: +</para> + +<para> +destination: WINDOW or +<emphasis role='bold'>PointerWindow</emphasis> +or +<emphasis role='bold'>InputFocus</emphasis> +</para> + +<para> +becomes: +</para> + +<literallayout class="monospaced"> +4 WINDOW destination + 0 PointerWindow + 1 InputFocus +</literallayout> + +<para> +For components described in the protocol as: +</para> + +<literallayout class="monospaced"> + value-mask: BITMASK +</literallayout> + +<para> +the encode-form is: +</para> + +<literallayout class="monospaced"> +N BITMASK value-mask + mask1 mask-name1 + ... + maskI mask-nameI +</literallayout> + +<para> +The individual bits in the mask are specified and named, +and N is 2 or 4. +The most-significant bit in a BITMASK is reserved for use in defining +chained (multiword) bitmasks, as extensions augment existing core requests. +The precise interpretation of this bit is not yet defined here, +although a probable mechanism is that a 1-bit indicates that another N bytes +of bitmask follows, with bits within the overall mask still interpreted +from least-significant to most-significant with an N-byte unit, +with N-byte units +interpreted in stream order, and with the overall mask being byte-swapped +in individual N-byte units. +</para> + +<para> +For LISTofVALUE encodings, the request is followed by a section of the form: +</para> + +<literallayout class="monospaced"> + VALUEs + encode-form + ... + encode-form +</literallayout> + +<para> +listing an encode-form for each VALUE. +The NAME in each encode-form keys to the corresponding BITMASK bit. +The encoding of a VALUE always occupies four bytes, +but the number of bytes specified in the encoding-form indicates how +many of the least-significant bytes are actually used; +the remaining bytes are unused and their values do not matter. +</para> + +<para> +In various cases, the number of bytes occupied by a component will be +specified +by a lowercase single-letter variable name instead of a specific numeric +value, and often some other component will have its value specified as a +simple numeric expression involving these variables. +Components specified with such expressions are always interpreted +as unsigned integers. +The scope of such variables is always just the enclosing request, reply, +error, event, or compound type structure. +For example: +</para> + +<literallayout class="monospaced"> +2 3+n request length +4n LISTofPOINT points +</literallayout> + +<para> +For unused bytes (the values of the bytes are undefined and do no matter), +the encode-form is: +</para> + +<literallayout class="monospaced"> + N unused +</literallayout> + +<para> +<!-- .LP --> +If the number of unused bytes is variable, the encode-form typically is: +</para> + +<literallayout class="monospaced"> + p unused, p=pad(E) +</literallayout> + +<para> +where E is some expression, +<phrase id="encoding:pad"> +<indexterm zone="encoding:pad" significance="preferred"><primary>Padding</primary></indexterm> +and pad(E) is the number of bytes needed to round E up to a multiple of four. +</phrase> +</para> + +<literallayout class="monospaced"> + pad(E) = (4 - (E mod 4)) mod 4 +</literallayout> +</sect1> + +<sect1 id='Encoding::Common_Types'> +<title>Common Types</title> +<indexterm zone="Encoding::Common_Types"><primary>Types</primary><secondary>encoding</secondary></indexterm> + +<variablelist> + <varlistentry> + <term>LISTofFOO</term> + <listitem> + <para> +In this document the LISTof notation strictly means some number of repetitions +of the FOO encoding; +the actual length of the list is encoded elsewhere. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>SETofFOO</term> + <listitem> + <para> +A set is always represented by a bitmask, with a 1-bit indicating presence in +the set. + </para> + </listitem> + </varlistentry> +</variablelist> + +<informaltable frame='none'> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +BITMASK: CARD32 + </entry> + </row> + <row> + <entry> +WINDOW: CARD32 + </entry> + </row> + <row> + <entry> +PIXMAP: CARD32 + </entry> + </row> + <row> + <entry> +CURSOR: CARD32 + </entry> + </row> + <row> + <entry> +FONT: CARD32 + </entry> + </row> + <row> + <entry> +GCONTEXT: CARD32 + </entry> + </row> + <row> + <entry> +COLORMAP: CARD32 + </entry> + </row> + <row> + <entry> +DRAWABLE: CARD32 + </entry> + </row> + <row> + <entry> +FONTABLE: CARD32 + </entry> + </row> + <row> + <entry> +ATOM: CARD32 + </entry> + </row> + <row> + <entry> +VISUALID: CARD32 + </entry> + </row> + <row> + <entry> +BYTE: 8-bit value + </entry> + </row> + <row> + <entry> +INT8: 8-bit signed integer + </entry> + </row> + <row> + <entry> +INT16: 16-bit signed integer + </entry> + </row> + <row> + <entry> +INT32: 32-bit signed integer + </entry> + </row> + <row> + <entry> +CARD8: 8-bit unsigned integer + </entry> + </row> + <row> + <entry> +CARD16: 16-bit unsigned integer + </entry> + </row> + <row> + <entry> +CARD32: 32-bit unsigned integer + </entry> + </row> + <row> + <entry> +TIMESTAMP: CARD32 + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + + +<literallayout class="monospaced"> +BITGRAVITY + 0 Forget + 1 NorthWest + 2 North + 3 NorthEast + 4 West + 5 Center + 6 East + 7 SouthWest + 8 South + 9 SouthEast + 10 Static + +WINGRAVITY + 0 Unmap + 1 NorthWest + 2 North + 3 NorthEast + 4 West + 5 Center + 6 East + 7 SouthWest + 8 South + 9 SouthEast + 10 Static + +BOOL + 0 False + 1 True + +SETofEVENT + #x00000001 KeyPress + #x00000002 KeyRelease + #x00000004 ButtonPress + #x00000008 ButtonRelease + #x00000010 EnterWindow + #x00000020 LeaveWindow + #x00000040 PointerMotion + #x00000080 PointerMotionHint + #x00000100 Button1Motion + #x00000200 Button2Motion + #x00000400 Button3Motion + #x00000800 Button4Motion + #x00001000 Button5Motion + #x00002000 ButtonMotion + #x00004000 KeymapState + #x00008000 Exposure + #x00010000 VisibilityChange + #x00020000 StructureNotify + #x00040000 ResizeRedirect + #x00080000 SubstructureNotify + #x00100000 SubstructureRedirect + #x00200000 FocusChange + #x00400000 PropertyChange + #x00800000 ColormapChange + #x01000000 OwnerGrabButton + #xFE000000 unused but must be zero + +SETofPOINTEREVENT + encodings are the same as for SETofEVENT, except with + #xFFFF8003 unused but must be zero + +SETofDEVICEEVENT + encodings are the same as for SETofEVENT, except with + #xFFFFC0B0 unused but must be zero + +KEYSYM: CARD32 +KEYCODE: CARD8 +BUTTON: CARD8 + +SETofKEYBUTMASK + #x0001 Shift + #x0002 Lock + #x0004 Control + #x0008 Mod1 + #x0010 Mod2 + #x0020 Mod3 + #x0040 Mod4 + #x0080 Mod5 + #x0100 Button1 + #x0200 Button2 + #x0400 Button3 + #x0800 Button4 + #x1000 Button5 + #xE000 unused but must be zero + +SETofKEYMASK + encodings are the same as for SETofKEYBUTMASK, except with + #xFF00 unused but must be zero +STRING8: LISTofCARD8 +STRING16: LISTofCHAR2B + +CHAR2B + 1 CARD8 byte1 + 1 CARD8 byte2 + +POINT + 2 INT16 x + 2 INT16 y + +RECTANGLE + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + +ARC + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 INT16 angle1 + 2 INT16 angle2 + +HOST + 1 family + 0 Internet + 1 DECnet + 2 Chaos + 5 ServerInterpreted + 6 InternetV6 + 1 unused + 2 n length of address + n LISTofBYTE address + p unused, p=pad(n) + +STR + 1 n length of name in bytes + n STRING8 name + +</literallayout> +</sect1> + +<sect1 id='Encoding::Errors'> +<title>Errors</title> +<indexterm zone="Encoding::Errors"><primary>Error report</primary><secondary>encoding</secondary></indexterm> + +<literallayout class="monospaced"> +<emphasis role='bold'>Request</emphasis> + 1 0 Error + 1 1 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Value</emphasis> + 1 0 Error + 1 2 code + 2 CARD16 sequence number + 4 <32-bits> bad value + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Window</emphasis> + 1 0 Error + 1 3 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Pixmap</emphasis> + 1 0 Error + 1 4 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Atom</emphasis> + 1 0 Error + 1 5 code + 2 CARD16 sequence number + 4 CARD32 bad atom id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Cursor</emphasis> + 1 0 Error + 1 6 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Font</emphasis> + 1 0 Error + 1 7 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Match</emphasis> + 1 0 Error + 1 8 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Drawable</emphasis> + 1 0 Error + 1 9 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Access</emphasis> + 1 0 Error + 1 10 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Alloc</emphasis> + 1 0 Error + 1 11 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Colormap</emphasis> + 1 0 Error + 1 12 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>GContext</emphasis> + 1 0 Error + 1 13 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>IDChoice</emphasis> + 1 0 Error + 1 14 code + 2 CARD16 sequence number + 4 CARD32 bad resource id + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Name</emphasis> + 1 0 Error + 1 15 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Length</emphasis> + 1 0 Error + 1 16 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused + +<emphasis role='bold'>Implementation</emphasis> + 1 0 Error + 1 17 code + 2 CARD16 sequence number + 4 unused + 2 CARD16 minor opcode + 1 CARD8 major opcode + 21 unused +</literallayout> +</sect1> + +<sect1 id='Encoding::Keyboards'> +<title>Keyboards</title> + +<para> +KEYCODE values are always greater than 7 (and less than 256). +</para> + +<para> +KEYSYM values with the bit #x10000000 set are reserved as vendor-specific. +</para> + +<para> +The names and encodings of the standard KEYSYM values are contained in +<link linkend="keysym_encoding">Appendix A, Keysym Encoding</link>. +</para> +</sect1> + +<sect1 id='Encoding::Pointers'> +<title>Pointers</title> + +<para> +BUTTON values are numbered starting with one. +</para> + +</sect1> +<sect1 id='Encoding::Predefined_Atoms'> +<title>Predefined Atoms</title> +<indexterm zone="Encoding::Predefined_Atoms"><primary>Atom</primary><secondary>predefined</secondary></indexterm> + +<literallayout class="monospaced"> +PRIMARY 1 WM_NORMAL_HINTS 40 +SECONDARY 2 WM_SIZE_HINTS 41 +ARC 3 WM_ZOOM_HINTS 42 +ATOM 4 MIN_SPACE 43 +BITMAP 5 NORM_SPACE 44 +CARDINAL 6 MAX_SPACE 45 +COLORMAP 7 END_SPACE 46 +CURSOR 8 SUPERSCRIPT_X 47 +CUT_BUFFER0 9 SUPERSCRIPT_Y 48 +CUT_BUFFER1 10 SUBSCRIPT_X 49 +CUT_BUFFER2 11 SUBSCRIPT_Y 50 +CUT_BUFFER3 12 UNDERLINE_POSITION 51 +CUT_BUFFER4 13 UNDERLINE_THICKNESS 52 +CUT_BUFFER5 14 STRIKEOUT_ASCENT 53 +CUT_BUFFER6 15 STRIKEOUT_DESCENT 54 +CUT_BUFFER7 16 ITALIC_ANGLE 55 +DRAWABLE 17 X_HEIGHT 56 +FONT 18 QUAD_WIDTH 57 +INTEGER 19 WEIGHT 58 +PIXMAP 20 POINT_SIZE 59 +POINT 21 RESOLUTION 60 +RECTANGLE 22 COPYRIGHT 61 +RESOURCE_MANAGER 23 NOTICE 62 +RGB_COLOR_MAP 24 FONT_NAME 63 +RGB_BEST_MAP 25 FAMILY_NAME 64 +RGB_BLUE_MAP 26 FULL_NAME 65 +RGB_DEFAULT_MAP 27 CAP_HEIGHT 66 +RGB_GRAY_MAP 28 WM_CLASS 67 +RGB_GREEN_MAP 29 WM_TRANSIENT_FOR 68 +RGB_RED_MAP 30 +STRING 31 +VISUALID 32 +WINDOW 33 +WM_COMMAND 34 +WM_HINTS 35 +WM_CLIENT_MACHINE 36 +WM_ICON_NAME 37 +WM_ICON_SIZE 38 +WM_NAME 39 +</literallayout> +</sect1> + +<sect1 id='Encoding::Connection_Setup'> +<title>Connection Setup</title> + +<para> +For TCP connections, +displays on a given host are numbered starting from 0, +and the server for display N listens and accepts connections on port 6000 + N. +For DECnet connections, +displays on a given host are numbered starting from 0, +and the server for display N listens and accepts connections on the object +name obtained by concatenating "X$X" with the decimal representation of N, +for example, X$X0 and X$X1. +</para> + +<para> +Information sent by the client at connection setup: +</para> + +<literallayout class="monospaced"> + 1 byte-order + #x42 MSB first + #x6C LSB first + 1 unused + 2 CARD16 protocol-major-version + 2 CARD16 protocol-minor-version + 2 n length of authorization-protocol-name + 2 d length of authorization-protocol-data + 2 unused + n STRING8 authorization-protocol-name + p unused, p=pad(n) + d STRING8 authorization-protocol-data + q unused, q=pad(d) +</literallayout> + +<para> +Except where explicitly noted in the protocol, +all 16-bit and 32-bit quantities sent by the client must be transmitted +with the specified byte order, +and all 16-bit and 32-bit quantities returned by the server will be transmitted +with this byte order. +</para> + +<para> +Information received by the client if the connection is refused: +</para> + +<literallayout class="monospaced"> + 1 0 Failed + 1 n length of reason in bytes + 2 CARD16 protocol-major-version + 2 CARD16 protocol-minor-version + 2 (n+p)/4 length in 4-byte units of "additional data" + n STRING8 reason + p unused, p=pad(n) +</literallayout> + +<para> +Information received by the client if further authentication is required: +</para> + +<literallayout class="monospaced"> + 1 2 Authenticate + 5 unused + 2 (n+p)/4 length in 4-byte units of "additional data" + n STRING8 reason + p unused, p=pad(n) +</literallayout> + +<para> +Information received by the client if the connection is accepted: +</para> + +<literallayout class="monospaced"> + 1 1 Success + 1 unused + 2 CARD16 protocol-major-version + 2 CARD16 protocol-minor-version + 2 8+2n+(v+p+m)/4 length in 4-byte units of + "additional data" + 4 CARD32 release-number + 4 CARD32 resource-id-base + 4 CARD32 resource-id-mask + 4 CARD32 motion-buffer-size + 2 v length of vendor + 2 CARD16 maximum-request-length + 1 CARD8 number of SCREENs in roots + 1 n number for FORMATs in + pixmap-formats + 1 image-byte-order + 0 LSBFirst + 1 MSBFirst + 1 bitmap-format-bit-order + 0 LeastSignificant + 1 MostSignificant + 1 CARD8 bitmap-format-scanline-unit + 1 CARD8 bitmap-format-scanline-pad + 1 KEYCODE min-keycode + 1 KEYCODE max-keycode + 4 unused + v STRING8 vendor + p unused, p=pad(v) + 8n LISTofFORMAT pixmap-formats + m LISTofSCREEN roots (m is always a multiple of 4) +</literallayout> + +<literallayout class="monospaced"> +FORMAT + 1 CARD8 depth + 1 CARD8 bits-per-pixel + 1 CARD8 scanline-pad + 5 unused +</literallayout> + +<literallayout class="monospaced"> +SCREEN + 4 WINDOW root + 4 COLORMAP default-colormap + 4 CARD32 white-pixel + 4 CARD32 black-pixel + 4 SETofEVENT current-input-masks + 2 CARD16 width-in-pixels + 2 CARD16 height-in-pixels + 2 CARD16 width-in-millimeters + 2 CARD16 height-in-millimeters + 2 CARD16 min-installed-maps + 2 CARD16 max-installed-maps + 4 VISUALID root-visual + 1 backing-stores + 0 Never + 1 WhenMapped + 2 Always + 1 BOOL save-unders + 1 CARD8 root-depth + 1 CARD8 number of DEPTHs in allowed-depths + n LISTofDEPTH allowed-depths (n is always a + multiple of 4) +</literallayout> + +<literallayout class="monospaced"> +DEPTH + 1 CARD8 depth + 1 unused + 2 n number of VISUALTYPES in visuals + 4 unused + 24n LISTofVISUALTYPE visuals +</literallayout> + +<literallayout class="monospaced"> +VISUALTYPE + 4 VISUALID visual-id + 1 class + 0 StaticGray + 1 GrayScale + 2 StaticColor + 3 PseudoColor + 4 TrueColor + 5 DirectColor + 1 CARD8 bits-per-rgb-value + 2 CARD16 colormap-entries + 4 CARD32 red-mask + 4 CARD32 green-mask + 4 CARD32 blue-mask + 4 unused +</literallayout> +</sect1> + +<sect1 id='Encoding::Requests'> +<title>Requests</title> +<indexterm zone="Encoding::Requests"><primary>Request</primary><secondary>encoding</secondary></indexterm> + +<literallayout class="monospaced"> +<link linkend="requests:CreateWindow"><emphasis role='bold'>CreateWindow</emphasis></link> + 1 1 opcode + 1 CARD8 depth + 2 8+n request length + 4 WINDOW wid + 4 WINDOW parent + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 2 class + 0 CopyFromParent + 1 InputOutput + 2 InputOnly + 4 VISUALID visual + 0 CopyFromParent + 4 BITMASK value-mask (has n bits set to 1) + #x00000001 background-pixmap + #x00000002 background-pixel + #x00000004 border-pixmap + #x00000008 border-pixel + #x00000010 bit-gravity + #x00000020 win-gravity + #x00000040 backing-store + #x00000080 backing-planes + #x00000100 backing-pixel + #x00000200 override-redirect + #x00000400 save-under + #x00000800 event-mask + #x00001000 do-not-propagate-mask + #x00002000 colormap + #x00004000 cursor + 4n LISTofVALUE value-list + + VALUEs + 4 PIXMAP background-pixmap + 0 None + 1 ParentRelative + 4 CARD32 background-pixel + 4 PIXMAP border-pixmap + 0 CopyFromParent + 4 CARD32 border-pixel + 1 BITGRAVITY bit-gravity + 1 WINGRAVITY win-gravity + 1 backing-store + 0 NotUseful + 1 WhenMapped + 2 Always + 4 CARD32 backing-planes + 4 CARD32 backing-pixel + 1 BOOL override-redirect + 1 BOOL save-under + 4 SETofEVENT event-mask + 4 SETofDEVICEEVENT do-not-propagate-mask + 4 COLORMAP colormap + 0 CopyFromParent + 4 CURSOR cursor + 0 None + +<link linkend="requests:ChangeWindowAttributes"><emphasis role='bold'>ChangeWindowAttributes</emphasis></link> + 1 2 opcode + 1 unused + 2 3+n request length + 4 WINDOW window + 4 BITMASK value-mask (has n bits set to 1) + encodings are the same as for CreateWindow + 4n LISTofVALUE value-list + encodings are the same as for CreateWindow + +<link linkend="requests:GetWindowAttributes"><emphasis role='bold'>GetWindowAttributes</emphasis></link> + 1 3 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 backing-store + 0 NotUseful + 1 WhenMapped + 2 Always + 2 CARD16 sequence number + 4 3 reply length + 4 VISUALID visual + 2 class + 1 InputOutput + 2 InputOnly + 1 BITGRAVITY bit-gravity + 1 WINGRAVITY win-gravity + 4 CARD32 backing-planes + 4 CARD32 backing-pixel + 1 BOOL save-under + 1 BOOL map-is-installed + 1 map-state + 0 Unmapped + 1 Unviewable + 2 Viewable + 1 BOOL override-redirect + 4 COLORMAP colormap + 0 None + 4 SETofEVENT all-event-masks + 4 SETofEVENT your-event-mask + 2 SETofDEVICEEVENT do-not-propagate-mask + 2 unused + +<link linkend="requests:DestroyWindow"><emphasis role='bold'>DestroyWindow</emphasis></link> + 1 4 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +<link linkend="requests:DestroySubwindows"><emphasis role='bold'>DestroySubwindows</emphasis></link> + 1 5 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +<link linkend="requests:ChangeSaveSet"><emphasis role='bold'>ChangeSaveSet</emphasis></link> + 1 6 opcode + 1 mode + 0 Insert + 1 Delete + 2 2 request length + 4 WINDOW window + +<link linkend="requests:ReparentWindow"><emphasis role='bold'>ReparentWindow</emphasis></link> + 1 7 opcode + 1 unused + 2 4 request length + 4 WINDOW window + 4 WINDOW parent + 2 INT16 x + 2 INT16 y + +<link linkend="requests:MapWindow"><emphasis role='bold'>MapWindow</emphasis></link> + 1 8 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +<link linkend="requests:MapSubwindows"><emphasis role='bold'>MapSubwindows</emphasis></link> + 1 9 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +<link linkend="requests:UnmapWindow"><emphasis role='bold'>UnmapWindow</emphasis></link> + 1 10 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +<link linkend="requests:UnmapSubwindows"><emphasis role='bold'>UnmapSubwindows</emphasis></link> + 1 11 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +<link linkend="requests:ConfigureWindow"><emphasis role='bold'>ConfigureWindow</emphasis></link> + 1 12 opcode + 1 unused + 2 3+n request length + 4 WINDOW window + 2 BITMASK value-mask (has n bits set to 1) + #x0001 x + #x0002 y + #x0004 width + #x0008 height + #x0010 border-width + #x0020 sibling + #x0040 stack-mode + 2 unused + 4n LISTofVALUE value-list + + VALUEs + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 4 WINDOW sibling + 1 stack-mode + 0 Above + 1 Below + 2 TopIf + 3 BottomIf + 4 Opposite + +<link linkend="requests:CirculateWindow"><emphasis role='bold'>CirculateWindow</emphasis></link> + 1 13 opcode + 1 direction + 0 RaiseLowest + 1 LowerHighest + 2 2 request length + 4 WINDOW window + +<link linkend="requests:GetGeometry"><emphasis role='bold'>GetGeometry</emphasis></link> + 1 14 opcode + 1 unused + 2 2 request length + 4 DRAWABLE drawable + +▶ + 1 1 Reply + 1 CARD8 depth + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW root + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 10 unused + +<link linkend="requests:QueryTree"><emphasis role='bold'>QueryTree</emphasis></link> + 1 15 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 4 WINDOW root + 4 WINDOW parent + 0 None + 2 n number of WINDOWs in children + 14 unused + 4n LISTofWINDOW children + +<link linkend="requests:InternAtom"><emphasis role='bold'>InternAtom</emphasis></link> + 1 16 opcode + 1 BOOL only-if-exists + 2 2+(n+p)/4 request length + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 ATOM atom + 0 None + 20 unused + +<link linkend="requests:GetAtomName"><emphasis role='bold'>GetAtomName</emphasis></link> + 1 17 opcode + 1 unused + 2 2 request length + 4 ATOM atom + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 2 n length of name + 22 unused + n STRING8 name + p unused, p=pad(n) + +<link linkend="requests:ChangeProperty"><emphasis role='bold'>ChangeProperty</emphasis></link> + 1 18 opcode + 1 mode + 0 Replace + 1 Prepend + 2 Append + 2 6+(n+p)/4 request length + 4 WINDOW window + 4 ATOM property + 4 ATOM type + 1 CARD8 format + 3 unused + 4 CARD32 length of data in format units + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + n LISTofBYTE data + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) + + +<link linkend="requests:DeleteProperty"><emphasis role='bold'>DeleteProperty</emphasis></link> + 1 19 opcode + 1 unused + 2 3 request length + 4 WINDOW window + 4 ATOM property + +<link linkend="requests:GetProperty"><emphasis role='bold'>GetProperty</emphasis></link> + 1 20 opcode + 1 BOOL delete + 2 6 request length + 4 WINDOW window + 4 ATOM property + 4 ATOM type + 0 AnyPropertyType + 4 CARD32 long-offset + 4 CARD32 long-length + +▶ + 1 1 Reply + 1 CARD8 format + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 4 ATOM type + 0 None + 4 CARD32 bytes-after + 4 CARD32 length of value in format units + (= 0 for format = 0) + (= n for format = 8) + (= n/2 for format = 16) + (= n/4 for format = 32) + 12 unused + n LISTofBYTE value + (n is zero for format = 0) + (n is a multiple of 2 for format = 16) + (n is a multiple of 4 for format = 32) + p unused, p=pad(n) + +<link linkend="requests:ListProperties"><emphasis role='bold'>ListProperties</emphasis></link> + 1 21 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of ATOMs in atoms + 22 unused + 4n LISTofATOM atoms + +<link linkend="requests:SetSelectionOwner"><emphasis role='bold'>SetSelectionOwner</emphasis></link> + 1 22 opcode + 1 unused + 2 4 request length + 4 WINDOW owner + 0 None + 4 ATOM selection + 4 TIMESTAMP time + 0 CurrentTime + +<link linkend="requests:GetSelectionOwner"><emphasis role='bold'>GetSelectionOwner</emphasis></link> + 1 23 opcode + 1 unused + 2 2 request length + 4 ATOM selection + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW owner + 0 None + 20 unused + +<link linkend="requests:ConvertSelection"><emphasis role='bold'>ConvertSelection</emphasis></link> + 1 24 opcode + 1 unused + 2 6 request length + 4 WINDOW requestor + 4 ATOM selection + 4 ATOM target + 4 ATOM property + 0 None + 4 TIMESTAMP time + 0 CurrentTime + +<link linkend="requests:SendEvent"><emphasis role='bold'>SendEvent</emphasis></link> + 1 25 opcode + 1 BOOL propagate + 2 11 requestlength + 4 WINDOW destination + 0 PointerWindow + 1 InputFocus + 4 SETofEVENT event-mask + 32 event + standard event format (see <link linkend='Events'>the Events section</link>) + +<link linkend="requests:GrabPointer"><emphasis role='bold'>GrabPointer</emphasis></link> + 1 26 opcode + 1 BOOL owner-events + 2 6 request length + 4 WINDOW grab-window + 2 SETofPOINTEREVENT event-mask + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 4 WINDOW confine-to + 0 None + 4 CURSOR cursor + 0 None + 4 TIMESTAMP time + 0 CurrentTime + +▶ + 1 1 Reply + 1 status + 0 Success + 1 AlreadyGrabbed + 2 InvalidTime + 3 NotViewable + 4 Frozen + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +<link linkend="requests:UngrabPointer"><emphasis role='bold'>UngrabPointer</emphasis></link> + 1 27 opcode + 1 unused + 2 2 request length + 4 TIMESTAMP time + 0 CurrentTime + +<link linkend="requests:GrabButton"><emphasis role='bold'>GrabButton</emphasis></link> + 1 28 opcode + 1 BOOL owner-events + 2 6 request length + 4 WINDOW grab-window + 2 SETofPOINTEREVENT event-mask + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 4 WINDOW confine-to + 0 None + 4 CURSOR cursor + 0 None + 1 BUTTON button + 0 AnyButton + 1 unused + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + +<link linkend="requests:UngrabButton"><emphasis role='bold'>UngrabButton</emphasis></link> + 1 29 opcode + 1 BUTTON button + 0 AnyButton + 2 3 request length + 4 WINDOW grab-window + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + 2 unused + +<link linkend="requests:ChangeActivePointerGrab"><emphasis role='bold'>ChangeActivePointerGrab</emphasis></link> + 1 30 opcode + 1 unused + 2 4 request length + 4 CURSOR cursor + 0 None + 4 TIMESTAMP time + 0 CurrentTime + 2 SETofPOINTEREVENT event-mask + 2 unused + +<link linkend="requests:GrabKeyboard"><emphasis role='bold'>GrabKeyboard</emphasis></link> + 1 31 opcode + 1 BOOL owner-events + 2 4 request length + 4 WINDOW grab-window + 4 TIMESTAMP time + 0 CurrentTime + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 2 unused + +▶ + 1 1 Reply + 1 status + 0 Success + 1 AlreadyGrabbed + 2 InvalidTime + 3 NotViewable + 4 Frozen + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +<link linkend="requests:UngrabKeyboard"><emphasis role='bold'>UngrabKeyboard</emphasis></link> + 1 32 opcode + 1 unused + 2 2 request length + 4 TIMESTAMP time + 0 CurrentTime + +<link linkend="requests:GrabKey"><emphasis role='bold'>GrabKey</emphasis></link> + 1 33 opcode + 1 BOOL owner-events + 2 4 request length + 4 WINDOW grab-window + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + 1 KEYCODE key + 0 AnyKey + 1 pointer-mode + 0 Synchronous + 1 Asynchronous + 1 keyboard-mode + 0 Synchronous + 1 Asynchronous + 3 unused + +<link linkend="requests:UngrabKey"><emphasis role='bold'>UngrabKey</emphasis></link> + 1 34 opcode + 1 KEYCODE key + 0 AnyKey + 2 3 request length + 4 WINDOW grab-window + 2 SETofKEYMASK modifiers + #x8000 AnyModifier + 2 unused + +<link linkend="requests:AllowEvents"><emphasis role='bold'>AllowEvents</emphasis></link> + 1 35 opcode + 1 mode + 0 AsyncPointer + 1 SyncPointer + 2 ReplayPointer + 3 AsyncKeyboard + 4 SyncKeyboard + 5 ReplayKeyboard + 6 AsyncBoth + 7 SyncBoth + 2 2 request length + 4 TIMESTAMP time + 0 CurrentTime + +<link linkend="requests:GrabServer"><emphasis role='bold'>GrabServer</emphasis></link> + 1 36 opcode + 1 unused + 2 1 request length + +<link linkend="requests:UngrabServer"><emphasis role='bold'>UngrabServer</emphasis></link> + 1 37 opcode + 1 unused + 2 1 request length + +<link linkend="requests:QueryPointer"><emphasis role='bold'>QueryPointer</emphasis></link> + 1 38 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 BOOL same-screen + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW root + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 win-x + 2 INT16 win-y + 2 SETofKEYBUTMASK mask + 6 unused + +<link linkend="requests:GetMotionEvents"><emphasis role='bold'>GetMotionEvents</emphasis></link> + 1 39 opcode + 1 unused + 2 4 request length + 4 WINDOW window + 4 TIMESTAMP start + 0 CurrentTime + 4 TIMESTAMP stop + 0 CurrentTime + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2n reply length + 4 n number of TIMECOORDs in events + 20 unused + 8n LISTofTIMECOORD events + + TIMECOORD + 4 TIMESTAMP time + 2 INT16 x + 2 INT16 y + +<link linkend="requests:TranslateCoordinates"><emphasis role='bold'>TranslateCoordinates</emphasis></link> + 1 40 opcode + 1 unused + 2 4 request length + 4 WINDOW src-window + 4 WINDOW dst-window + 2 INT16 src-x + 2 INT16 src-y +▶ + 1 1 Reply + 1 BOOL same-screen + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW child + 0 None + 2 INT16 dst-x + 2 INT16 dst-y + 16 unused + +<link linkend="requests:WarpPointer"><emphasis role='bold'>WarpPointer</emphasis></link> + 1 41 opcode + 1 unused + 2 6 request length + 4 WINDOW src-window + 0 None + 4 WINDOW dst-window + 0 None + 2 INT16 src-x + 2 INT16 src-y + 2 CARD16 src-width + 2 CARD16 src-height + 2 INT16 dst-x + 2 INT16 dst-y + +<link linkend="requests:SetInputFocus"><emphasis role='bold'>SetInputFocus</emphasis></link> + 1 42 opcode + 1 revert-to + 0 None + 1 PointerRoot + 2 Parent + 2 3 request length + 4 WINDOW focus + 0 None + 1 PointerRoot + 4 TIMESTAMP time + 0 CurrentTime + +<link linkend="requests:GetInputFocus"><emphasis role='bold'>GetInputFocus</emphasis></link> + 1 43 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 revert-to + 0 None + 1 PointerRoot + 2 Parent + 2 CARD16 sequence number + 4 0 reply length + 4 WINDOW focus + 0 None + 1 PointerRoot + 20 unused + +<link linkend="requests:QueryKeymap"><emphasis role='bold'>QueryKeymap</emphasis></link> + 1 44 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2 reply length + 32 LISTofCARD8 keys + +<link linkend="requests:OpenFont"><emphasis role='bold'>OpenFont</emphasis></link> + 1 45 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 FONT fid + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +<link linkend="requests:CloseFont"><emphasis role='bold'>CloseFont</emphasis></link> + 1 46 opcode + 1 unused + 2 2 request length + 4 FONT font + +<link linkend="requests:QueryFont"><emphasis role='bold'>QueryFont</emphasis></link> + 1 47 opcode + 1 unused + 2 2 request length + 4 FONTABLE font + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 7+2n+3m reply length + 12 CHARINFO min-bounds + 4 unused + 12 CHARINFO max-bounds + 4 unused + 2 CARD16 min-char-or-byte2 + 2 CARD16 max-char-or-byte2 + 2 CARD16 default-char + 2 n number of FONTPROPs in properties + 1 draw-direction + 0 LeftToRight + 1 RightToLeft + 1 CARD8 min-byte1 + 1 CARD8 max-byte1 + 1 BOOL all-chars-exist + 2 INT16 font-ascent + 2 INT16 font-descent + 4 m number of CHARINFOs in char-infos + 8n LISTofFONTPROP properties + 12m LISTofCHARINFO char-infos + + FONTPROP + 4 ATOM name + 4 <32-bits> value + + CHARINFO + 2 INT16 left-side-bearing + 2 INT16 right-side-bearing + 2 INT16 character-width + 2 INT16 ascent + 2 INT16 descent + 2 CARD16 attributes + +<link linkend="requests:QueryTextExtents"><emphasis role='bold'>QueryTextExtents</emphasis></link> + 1 48 opcode + 1 BOOL odd length, True if p = 2 + 2 2+(2n+p)/4 request length + 4 FONTABLE font + 2n STRING16 string + p unused, p=pad(2n) + +▶ + 1 1 Reply + 1 draw-direction + 0 LeftToRight + 1 RightToLeft + 2 CARD16 sequence number + 4 0 reply length + 2 INT16 font-ascent + 2 INT16 font-descent + 2 INT16 overall-ascent + 2 INT16 overall-descent + 4 INT32 overall-width + 4 INT32 overall-left + 4 INT32 overall-right + 4 unused + +<link linkend="requests:ListFonts"><emphasis role='bold'>ListFonts</emphasis></link> + 1 49 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 CARD16 max-names + 2 n length of pattern + n STRING8 pattern + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 2 CARD16 number of STRs in names + 22 unused + n LISTofSTR names + p unused, p=pad(n) + +<link linkend="requests:ListFontsWithInfo"><emphasis role='bold'>ListFontsWithInfo</emphasis></link> + 1 50 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 CARD16 max-names + 2 n length of pattern + n STRING8 pattern + p unused, p=pad(n) + +▶ (except for last in series) + 1 1 Reply + 1 n length of name in bytes + 2 CARD16 sequence number + 4 7+2m+(n+p)/4 reply length + 12 CHARINFO min-bounds + 4 unused + 12 CHARINFO max-bounds + 4 unused + 2 CARD16 min-char-or-byte2 + 2 CARD16 max-char-or-byte2 + 2 CARD16 default-char + 2 m number of FONTPROPs in properties + 1 draw-direction + 0 LeftToRight + 1 RightToLeft + 1 CARD8 min-byte1 + 1 CARD8 max-byte1 + 1 BOOL all-chars-exist + 2 INT16 font-ascent + 2 INT16 font-descent + 4 CARD32 replies-hint + 8m LISTofFONTPROP properties + n STRING8 name + p unused, p=pad(n) + + FONTPROP + encodings are the same as for QueryFont + + CHARINFO + encodings are the same as for QueryFont + +▶ (last in series) + 1 1 Reply + 1 0 last-reply indicator + 2 CARD16 sequence number + 4 7 reply length + 52 unused + +<link linkend="requests:SetFontPath"><emphasis role='bold'>SetFontPath</emphasis></link> + 1 51 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 CARD16 number of STRs in path + 2 unused + n LISTofSTR path + p unused, p=pad(n) + +<link linkend="requests:GetFontPath"><emphasis role='bold'>GetFontPath</emphasis></link> + 1 52 opcode + 1 unused + 2 1 request list + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 2 CARD16 number of STRs in path + 22 unused + n LISTofSTR path + p unused, p=pad(n) + +<link linkend="requests:CreatePixmap"><emphasis role='bold'>CreatePixmap</emphasis></link> + 1 53 opcode + 1 CARD8 depth + 2 4 request length + 4 PIXMAP pid + 4 DRAWABLE drawable + 2 CARD16 width + 2 CARD16 height + +<link linkend="requests:FreePixmap"><emphasis role='bold'>FreePixmap</emphasis></link> + 1 54 opcode + 1 unused + 2 2 request length + 4 PIXMAP pixmap + +<link linkend="requests:CreateGC"><emphasis role='bold'>CreateGC</emphasis></link> + 1 55 opcode + 1 unused + 2 4+n request length + 4 GCONTEXT cid + 4 DRAWABLE drawable + 4 BITMASK value-mask (has n bits set to 1) + #x00000001 function + #x00000002 plane-mask + #x00000004 foreground + #x00000008 background + #x00000010 line-width + #x00000020 line-style + #x00000040 cap-style + #x00000080 join-style + #x00000100 fill-style + #x00000200 fill-rule + #x00000400 tile + #x00000800 stipple + #x00001000 tile-stipple-x-origin + #x00002000 tile-stipple-y-origin + #x00004000 font + #x00008000 subwindow-mode + #x00010000 graphics-exposures + #x00020000 clip-x-origin + #x00040000 clip-y-origin + #x00080000 clip-mask + #x00100000 dash-offset + #x00200000 dashes + #x00400000 arc-mode + 4n LISTofVALUE value-list + + VALUEs + 1 function + 0 Clear + 1 And + 2 AndReverse + 3 Copy + 4 AndInverted + 5 NoOp + 6 Xor + 7 Or + 8 Nor + 9 Equiv + 10 Invert + 11 OrReverse + 12 CopyInverted + 13 OrInverted + 14 Nand + 15 Set + 4 CARD32 plane-mask + 4 CARD32 foreground + 4 CARD32 background + 2 CARD16 line-width + 1 line-style + 0 Solid + 1 OnOffDash + 2 DoubleDash + 1 cap-style + 0 NotLast + 1 Butt + 2 Round + 3 Projecting + 1 join-style + 0 Miter + 1 Round + 2 Bevel + 1 fill-style + 0 Solid + 1 Tiled + 2 Stippled + 3 OpaqueStippled + 1 fill-rule + 0 EvenOdd + 1 Winding + 4 PIXMAP tile + 4 PIXMAP stipple + 2 INT16 tile-stipple-x-origin + 2 INT16 tile-stipple-y-origin + 4 FONT font + 1 subwindow-mode + 0 ClipByChildren + 1 IncludeInferiors + 1 BOOL graphics-exposures + 2 INT16 clip-x-origin + 2 INT16 clip-y-origin + 4 PIXMAP clip-mask + 0 None + 2 CARD16 dash-offset + 1 CARD8 dashes + 1 arc-mode + 0 Chord + 1 PieSlice + +<link linkend="requests:ChangeGC"><emphasis role='bold'>ChangeGC</emphasis></link> + 1 56 opcode + 1 unused + 2 3+n request length + 4 GCONTEXT gc + 4 BITMASK value-mask (has n bits set to 1) + encodings are the same as for CreateGC + 4n LISTofVALUE value-list + encodings are the same as for CreateGC + +<link linkend="requests:CopyGC"><emphasis role='bold'>CopyGC</emphasis></link> + 1 57 opcode + 1 unused + 2 4 request length + 4 GCONTEXT src-gc + 4 GCONTEXT dst-gc + 4 BITMASK value-mask + encodings are the same as for CreateGC + +<link linkend="requests:SetDashes"><emphasis role='bold'>SetDashes</emphasis></link> + 1 58 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 GCONTEXT gc + 2 CARD16 dash-offset + 2 n length of dashes + n LISTofCARD8 dashes + p unused, p=pad(n) + +<link linkend="requests:SetClipRectangles"><emphasis role='bold'>SetClipRectangles</emphasis></link> + 1 59 opcode + 1 ordering + 0 UnSorted + 1 YSorted + 2 YXSorted + 3 YXBanded + 2 3+2n request length + 4 GCONTEXT gc + 2 INT16 clip-x-origin + 2 INT16 clip-y-origin + 8n LISTofRECTANGLE rectangles + +<link linkend="requests:FreeGC"><emphasis role='bold'>FreeGC</emphasis></link> + 1 60 opcode + 1 unused + 2 2 request length + 4 GCONTEXT gc + +<link linkend="requests:ClearArea"><emphasis role='bold'>ClearArea</emphasis></link> + 1 61 opcode + 1 BOOL exposures + 2 4 request length + 4 WINDOW window + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + +<link linkend="requests:CopyArea"><emphasis role='bold'>CopyArea</emphasis></link> + 1 62 opcode + 1 unused + 2 7 request length + 4 DRAWABLE src-drawable + 4 DRAWABLE dst-drawable + 4 GCONTEXT gc + 2 INT16 src-x + 2 INT16 src-y + 2 INT16 dst-x + 2 INT16 dst-y + 2 CARD16 width + 2 CARD16 height + +<link linkend="requests:CopyPlane"><emphasis role='bold'>CopyPlane</emphasis></link> + 1 63 opcode + 1 unused + 2 8 request length + 4 DRAWABLE src-drawable + 4 DRAWABLE dst-drawable + 4 GCONTEXT gc + 2 INT16 src-x + 2 INT16 src-y + 2 INT16 dst-x + 2 INT16 dst-y + 2 CARD16 width + 2 CARD16 height + 4 CARD32 bit-plane + +<link linkend="requests:PolyPoint"><emphasis role='bold'>PolyPoint</emphasis></link> + 1 64 opcode + 1 coordinate-mode + 0 Origin + 1 Previous + 2 3+n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 4n LISTofPOINT points + +<link linkend="requests:PolyLine"><emphasis role='bold'>PolyLine</emphasis></link> + 1 65 opcode + 1 coordinate-mode + 0 Origin + 1 Previous + 2 3+n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 4n LISTofPOINT points + +<link linkend="requests:PolySegment"><emphasis role='bold'>PolySegment</emphasis></link> + 1 66 opcode + 1 unused + 2 3+2n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 8n LISTofSEGMENT segments + + SEGMENT + 2 INT16 x1 + 2 INT16 y1 + 2 INT16 x2 + 2 INT16 y2 + +<link linkend="requests:PolyRectangle"><emphasis role='bold'>PolyRectangle</emphasis></link> + 1 67 opcode + 1 unused + 2 3+2n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 8n LISTofRECTANGLE rectangles + +<link linkend="requests:PolyArc"><emphasis role='bold'>PolyArc</emphasis></link> + 1 68 opcode + 1 unused + 2 3+3n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 12n LISTofARC arcs + +<link linkend="requests:FillPoly"><emphasis role='bold'>FillPoly</emphasis></link> + 1 69 opcode + 1 unused + 2 4+n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 1 shape + 0 Complex + 1 Nonconvex + 2 Convex + 1 coordinate-mode + 0 Origin + 1 Previous + 2 unused + 4n LISTofPOINT points + +<link linkend="requests:PolyFillRectangle"><emphasis role='bold'>PolyFillRectangle</emphasis></link> + 1 70 opcode + 1 unused + 2 3+2n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 8n LISTofRECTANGLE rectangles + +<link linkend="requests:PolyFillArc"><emphasis role='bold'>PolyFillArc</emphasis></link> + 1 71 opcode + 1 unused + 2 3+3n request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 12n LISTofARC arcs + +<link linkend="requests:PutImage"><emphasis role='bold'>PutImage</emphasis></link> + 1 72 opcode + 1 format + 0 Bitmap + 1 XYPixmap + 2 ZPixmap + 2 6+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 CARD16 width + 2 CARD16 height + 2 INT16 dst-x + 2 INT16 dst-y + 1 CARD8 left-pad + 1 CARD8 depth + 2 unused + n LISTofBYTE data + p unused, p=pad(n) + +<link linkend="requests:GetImage"><emphasis role='bold'>GetImage</emphasis></link> + 1 73 opcode + 1 format + 1 XYPixmap + 2 ZPixmap + 2 5 request length + 4 DRAWABLE drawable + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 4 CARD32 plane-mask + +▶ + 1 1 Reply + 1 CARD8 depth + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 4 VISUALID visual + 0 None + 20 unused + n LISTofBYTE data + p unused, p=pad(n) + +<link linkend="requests:PolyText8"><emphasis role='bold'>PolyText8</emphasis></link> + 1 74 opcode + 1 unused + 2 4+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + n LISTofTEXTITEM8 items + p unused, p=pad(n) (p is always 0 + or 1) + + TEXTITEM8 + 1 m length of string (cannot be 255) + 1 INT8 delta + m STRING8 string + or + 1 255 font-shift indicator + 1 font byte 3 (most-significant) + 1 font byte 2 + 1 font byte 1 + 1 font byte 0 (least-significant) + +<link linkend="requests:PolyText16"><emphasis role='bold'>PolyText16</emphasis></link> + 1 75 opcode + 1 unused + 2 4+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + n LISTofTEXTITEM16 items + p unused, p=pad(n) (p must be 0 or + 1) + + TEXTITEM16 + 1 m number of CHAR2Bs in string + (cannot be 255) + 1 INT8 delta + 2m STRING16 string + or + 1 255 font-shift indicator + 1 font byte 3 (most-significant) + 1 font byte 2 + 1 font byte 1 + 1 font byte 0 (least-significant) + +<link linkend="requests:ImageText8"><emphasis role='bold'>ImageText8</emphasis></link> + 1 76 opcode + 1 n length of string + 2 4+(n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + n STRING8 string + p unused, p=pad(n) + +<link linkend="requests:ImageText16"><emphasis role='bold'>ImageText16</emphasis></link> + 1 77 opcode + 1 n number of CHAR2Bs in string + 2 4+(2n+p)/4 request length + 4 DRAWABLE drawable + 4 GCONTEXT gc + 2 INT16 x + 2 INT16 y + 2n STRING16 string + p unused, p=pad(2n) + +<link linkend="requests:CreateColormap"><emphasis role='bold'>CreateColormap</emphasis></link> + 1 78 opcode + 1 alloc + 0 None + 1 All + 2 4 request length + 4 COLORMAP mid + 4 WINDOW window + 4 VISUALID visual + +<link linkend="requests:FreeColormap"><emphasis role='bold'>FreeColormap</emphasis></link> + 1 79 opcode + 1 unused + 2 2 request length + 4 COLORMAP cmap + +<link linkend="requests:CopyColormapAndFree"><emphasis role='bold'>CopyColormapAndFree</emphasis></link> + 1 80 opcode + 1 unused + 2 3 request length + 4 COLORMAP mid + 4 COLORMAP src-cmap + +<link linkend="requests:InstallColormap"><emphasis role='bold'>InstallColormap</emphasis></link> + 1 81 opcode + 1 unused + 2 2 request length + 4 COLORMAP cmap + +<link linkend="requests:UninstallColormap"><emphasis role='bold'>UninstallColormap</emphasis></link> + 1 82 opcode + 1 unused + 2 2 request length + 4 COLORMAP cmap + +<link linkend="requests:ListInstalledColormaps"><emphasis role='bold'>ListInstalledColormaps</emphasis></link> + 1 83 opcode + 1 unused + 2 2 request length + 4 WINDOW window + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of COLORMAPs in cmaps + 22 unused + 4n LISTofCOLORMAP cmaps + +<link linkend="requests:AllocColor"><emphasis role='bold'>AllocColor</emphasis></link> + 1 84 opcode + 1 unused + 2 4 request length + 4 COLORMAP cmap + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 2 unused + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 2 unused + 4 CARD32 pixel + 12 unused + +<link linkend="requests:AllocNamedColor"><emphasis role='bold'>AllocNamedColor</emphasis></link> + 1 85 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 COLORMAP cmap + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 4 CARD32 pixel + 2 CARD16 exact-red + 2 CARD16 exact-green + 2 CARD16 exact-blue + 2 CARD16 visual-red + 2 CARD16 visual-green + 2 CARD16 visual-blue + 8 unused + +<link linkend="requests:AllocColorCells"><emphasis role='bold'>AllocColorCells</emphasis></link> + 1 86 opcode + 1 BOOL contiguous + 2 3 request length + 4 COLORMAP cmap + 2 CARD16 colors + 2 CARD16 planes + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n+m reply length + 2 n number of CARD32s in pixels + 2 m number of CARD32s in masks + 20 unused + 4n LISTofCARD32 pixels + 4m LISTofCARD32 masks + +<link linkend="requests:AllocColorPlanes"><emphasis role='bold'>AllocColorPlanes</emphasis></link> + 1 87 opcode + 1 BOOL contiguous + 2 4 request length + 4 COLORMAP cmap + 2 CARD16 colors + 2 CARD16 reds + 2 CARD16 greens + 2 CARD16 blues + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 n reply length + 2 n number of CARD32s in pixels + 2 unused + 4 CARD32 red-mask + 4 CARD32 green-mask + 4 CARD32 blue-mask + 8 unused + 4n LISTofCARD32 pixels + +<link linkend="requests:FreeColors"><emphasis role='bold'>FreeColors</emphasis></link> + 1 88 opcode + 1 unused + 2 3+n request length + 4 COLORMAP cmap + 4 CARD32 plane-mask + 4n LISTofCARD32 pixels + +<link linkend="requests:StoreColors"><emphasis role='bold'>StoreColors</emphasis></link> + 1 89 opcode + 1 unused + 2 2+3n request length + 4 COLORMAP cmap + 12n LISTofCOLORITEM items + + COLORITEM + 4 CARD32 pixel + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 1 do-red, do-green, do-blue + #x01 do-red (1 is True, 0 is False) + #x02 do-green (1 is True, 0 is False) + #x04 do-blue (1 is True, 0 is False) + #xF8 unused + 1 unused + +<link linkend="requests:StoreNamedColor"><emphasis role='bold'>StoreNamedColor</emphasis></link> + 1 90 opcode + 1 do-red, do-green, do-blue + #x01 do-red (1 is True, 0 is False) + #x02 do-green (1 is True, 0 is False) + #x04 do-blue (1 is True, 0 is False) + #xF8 unused + 2 4+(n+p)/4 request length + 4 COLORMAP cmap + 4 CARD32 pixel + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +<link linkend="requests:QueryColors"><emphasis role='bold'>QueryColors</emphasis></link> + 1 91 opcode + 1 unused + 2 2+n request length + 4 COLORMAP cmap + 4n LISTofCARD32 pixels + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 2n reply length + 2 n number of RGBs in colors + 22 unused + 8n LISTofRGB colors + + RGB + 2 CARD16 red + 2 CARD16 green + 2 CARD16 blue + 2 unused + +<link linkend="requests:LookupColor"><emphasis role='bold'>LookupColor</emphasis></link> + 1 92 opcode + 1 unused + 2 3+(n+p)/4 request length + 4 COLORMAP cmap + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 exact-red + 2 CARD16 exact-green + 2 CARD16 exact-blue + 2 CARD16 visual-red + 2 CARD16 visual-green + 2 CARD16 visual-blue + 12 unused + +<link linkend="requests:CreateCursor"><emphasis role='bold'>CreateCursor</emphasis></link> + 1 93 opcode + 1 unused + 2 8 request length + 4 CURSOR cid + 4 PIXMAP source + 4 PIXMAP mask + 0 None + 2 CARD16 fore-red + 2 CARD16 fore-green + 2 CARD16 fore-blue + 2 CARD16 back-red + 2 CARD16 back-green + 2 CARD16 back-blue + 2 CARD16 x + 2 CARD16 y + +<link linkend="requests:CreateGlyphCursor"><emphasis role='bold'>CreateGlyphCursor</emphasis></link> + 1 94 opcode + 1 unused + 2 8 request length + 4 CURSOR cid + 4 FONT source-font + 4 FONT mask-font + 0 None + 2 CARD16 source-char + 2 CARD16 mask-char + 2 CARD16 fore-red + 2 CARD16 fore-green + 2 CARD16 fore-blue + 2 CARD16 back-red + 2 CARD16 back-green + 2 CARD16 back-blue + +<link linkend="requests:FreeCursor"><emphasis role='bold'>FreeCursor</emphasis></link> + 1 95 opcode + 1 unused + 2 2 request length + 4 CURSOR cursor + +<link linkend="requests:RecolorCursor"><emphasis role='bold'>RecolorCursor</emphasis></link> + 1 96 opcode + 1 unused + 2 5 request length + 4 CURSOR cursor + 2 CARD16 fore-red + 2 CARD16 fore-green + 2 CARD16 fore-blue + 2 CARD16 back-red + 2 CARD16 back-green + 2 CARD16 back-blue + +<link linkend="requests:QueryBestSize"><emphasis role='bold'>QueryBestSize</emphasis></link> + 1 97 opcode + 1 class + 0 Cursor + 1 Tile + 2 Stipple + 2 3 request length + 4 DRAWABLE drawable + 2 CARD16 width + 2 CARD16 height + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 width + 2 CARD16 height + 20 unused + +<link linkend="requests:QueryExtension"><emphasis role='bold'>QueryExtension</emphasis></link> + 1 98 opcode + 1 unused + 2 2+(n+p)/4 request length + 2 n length of name + 2 unused + n STRING8 name + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 1 BOOL present + 1 CARD8 major-opcode + 1 CARD8 first-event + 1 CARD8 first-error + 20 unused + +<link linkend="requests:ListExtensions"><emphasis role='bold'>ListExtensions</emphasis></link> + 1 99 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 CARD8 number of STRs in names + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 24 unused + n LISTofSTR names + p unused, p=pad(n) + +<link linkend="requests:ChangeKeyboardMapping"><emphasis role='bold'>ChangeKeyboardMapping</emphasis></link> + 1 100 opcode + 1 n keycode-count + 2 2+nm request length + 1 KEYCODE first-keycode + 1 m keysyms-per-keycode + 2 unused + 4nm LISTofKEYSYM keysyms + +<link linkend="requests:GetKeyboardMapping"><emphasis role='bold'>GetKeyboardMapping</emphasis></link> + 1 101 opcode + 1 unused + 2 2 request length + 1 KEYCODE first-keycode + 1 m count + 2 unused + +▶ + 1 1 Reply + 1 n keysyms-per-keycode + 2 CARD16 sequence number + 4 nm reply length (m = count field + from the request) + 24 unused + 4nm LISTofKEYSYM keysyms + +<link linkend="requests:ChangeKeyboardControl"><emphasis role='bold'>ChangeKeyboardControl</emphasis></link> + 1 102 opcode + 1 unused + 2 2+n request length + 4 BITMASK value-mask (has n bits set to 1) + #x0001 key-click-percent + #x0002 bell-percent + #x0004 bell-pitch + #x0008 bell-duration + #x0010 led + #x0020 led-mode + #x0040 key + #x0080 auto-repeat-mode + 4n LISTofVALUE value-list + + VALUEs + 1 INT8 key-click-percent + 1 INT8 bell-percent + 2 INT16 bell-pitch + 2 INT16 bell-duration + 1 CARD8 led + 1 led-mode + 0 Off + 1 On + 1 KEYCODE key + 1 auto-repeat-mode + 0 Off + 1 On + 2 Default + +<link linkend="requests:GetKeyboardControl"><emphasis role='bold'>GetKeyboardControl</emphasis></link> + 1 103 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 global-auto-repeat + 0 Off + 1 On + 2 CARD16 sequence number + 4 5 reply length + 4 CARD32 led-mask + 1 CARD8 key-click-percent + 1 CARD8 bell-percent + 2 CARD16 bell-pitch + 2 CARD16 bell-duration + 2 unused + 32 LISTofCARD8 auto-repeats + +<link linkend="requests:Bell"><emphasis role='bold'>Bell</emphasis></link> + 1 104 opcode + 1 INT8 percent + 2 1 request length + +<link linkend="requests:ChangePointerControl"><emphasis role='bold'>ChangePointerControl</emphasis></link> + 1 105 opcode + 1 unused + 2 3 request length + 2 INT16 acceleration-numerator + 2 INT16 acceleration-denominator + 2 INT16 threshold + 1 BOOL do-acceleration + 1 BOOL do-threshold + +<link linkend="requests:GetPointerControl"><emphasis role='bold'>GetPointerControl</emphasis></link> + 1 106 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 acceleration-numerator + 2 CARD16 acceleration-denominator + 2 CARD16 threshold + 18 unused + +<link linkend="requests:SetScreenSaver"><emphasis role='bold'>SetScreenSaver</emphasis></link> + 1 107 opcode + 1 unused + 2 3 request length + 2 INT16 timeout + 2 INT16 interval + 1 prefer-blanking + 0 No + 1 Yes + 2 Default + 1 allow-exposures + 0 No + 1 Yes + 2 Default + 2 unused + +<link linkend="requests:GetScreenSaver"><emphasis role='bold'>GetScreenSaver</emphasis></link> + 1 108 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 unused + 2 CARD16 sequence number + 4 0 reply length + 2 CARD16 timeout + 2 CARD16 interval + 1 prefer-blanking + 0 No + 1 Yes + 1 allow-exposures + 0 No + 1 Yes + 18 unused + +<link linkend="requests:ChangeHosts"><emphasis role='bold'>ChangeHosts</emphasis></link> + 1 109 opcode + 1 mode + 0 Insert + 1 Delete + 2 2+(n+p)/4 request length + 1 family + 0 Internet + 1 DECnet + 2 Chaos + 1 unused + 2 n length of address + n LISTofCARD8 address + p unused, p=pad(n) + +<link linkend="requests:ListHosts"><emphasis role='bold'>ListHosts</emphasis></link> + 1 110 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 mode + 0 Disabled + 1 Enabled + 2 CARD16 sequence number + 4 n/4 reply length + 2 CARD16 number of HOSTs in hosts + 22 unused + n LISTofHOST hosts (n always a multiple of 4) + +<link linkend="requests:SetAccessControl"><emphasis role='bold'>SetAccessControl</emphasis></link> + 1 111 opcode + 1 mode + 0 Disable + 1 Enable + 2 1 request length + +<link linkend="requests:SetCloseDownMode"><emphasis role='bold'>SetCloseDownMode</emphasis></link> + 1 112 opcode + 1 mode + 0 Destroy + 1 RetainPermanent + 2 RetainTemporary + 2 1 request length + +<link linkend="requests:KillClient"><emphasis role='bold'>KillClient</emphasis></link> + 1 113 opcode + 1 unused + 2 2 request length + 4 CARD32 resource + 0 AllTemporary + +<link linkend="requests:RotateProperties"><emphasis role='bold'>RotateProperties</emphasis></link> + 1 114 opcode + 1 unused + 2 3+n request length + 4 WINDOW window + 2 n number of properties + 2 INT16 delta + 4n LISTofATOM properties + +<link linkend="requests:ForceScreenSaver"><emphasis role='bold'>ForceScreenSaver</emphasis></link> + 1 115 opcode + 1 mode + 0 Reset + 1 Activate + 2 1 request length + +<link linkend="requests:SetPointerMapping"><emphasis role='bold'>SetPointerMapping</emphasis></link> + 1 116 opcode + 1 n length of map + 2 1+(n+p)/4 request length + n LISTofCARD8 map + p unused, p=pad(n) + +▶ + 1 1 Reply + 1 status + 0 Success + 1 Busy + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +<link linkend="requests:GetPointerMapping"><emphasis role='bold'>GetPointerMapping</emphasis></link> + 1 117 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 n length of map + 2 CARD16 sequence number + 4 (n+p)/4 reply length + 24 unused + n LISTofCARD8 map + p unused, p=pad(n) + +<link linkend="requests:SetModifierMapping"><emphasis role='bold'>SetModifierMapping</emphasis></link> + 1 118 opcode + 1 n keycodes-per-modifier + 2 1+2n request length + 8n LISTofKEYCODE keycodes + +▶ + 1 1 Reply + 1 status + 0 Success + 1 Busy + 2 Failed + 2 CARD16 sequence number + 4 0 reply length + 24 unused + +<link linkend="requests:GetModifierMapping"><emphasis role='bold'>GetModifierMapping</emphasis></link> + 1 119 opcode + 1 unused + 2 1 request length + +▶ + 1 1 Reply + 1 n keycodes-per-modifier + 2 CARD16 sequence number + 4 2n reply length + 24 unused + 8n LISTofKEYCODE keycodes + +<link linkend="requests:NoOperation"><emphasis role='bold'>NoOperation</emphasis></link> + 1 127 opcode + 1 unused + 2 1+n request length + 4n unused +</literallayout> +</sect1> + +<sect1 id='Encoding::Events'> +<title>Events</title> +<indexterm zone="Encoding::Events"><primary>Event</primary><secondary>encoding</secondary></indexterm> + +<literallayout class="monospaced"> +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link> + 1 2 code + 1 KEYCODE detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +<link linkend="events:KeyRelease"><emphasis role='bold'>KeyRelease</emphasis></link> + 1 3 code + 1 KEYCODE detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +<link linkend="events:ButtonPress"><emphasis role='bold'>ButtonPress</emphasis></link> + 1 4 code + 1 BUTTON detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +<link linkend="events:ButtonRelease"><emphasis role='bold'>ButtonRelease</emphasis></link> + 1 5 code + 1 BUTTON detail + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +<link linkend="events:MotionNotify"><emphasis role='bold'>MotionNotify</emphasis></link> + 1 6 code + 1 detail + 0 Normal + 1 Hint + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 BOOL same-screen + 1 unused + +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link> + 1 7 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 1 same-screen, focus + #x01 focus (1 is True, 0 is False) + #x02 same-screen (1 is True, 0 is False) + #xFC unused + +<link linkend="events:LeaveNotify"><emphasis role='bold'>LeaveNotify</emphasis></link> + 1 8 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW root + 4 WINDOW event + 4 WINDOW child + 0 None + 2 INT16 root-x + 2 INT16 root-y + 2 INT16 event-x + 2 INT16 event-y + 2 SETofKEYBUTMASK state + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 1 same-screen, focus + #x01 focus (1 is True, 0 is False) + #x02 same-screen (1 is True, 0 is False) + #xFC unused + +<link linkend="events:FocusIn"><emphasis role='bold'>FocusIn</emphasis></link> + 1 9 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 5 Pointer + 6 PointerRoot + 7 None + 2 CARD16 sequence number + 4 WINDOW event + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 3 WhileGrabbed + 23 unused + +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link> + 1 10 code + 1 detail + 0 Ancestor + 1 Virtual + 2 Inferior + 3 Nonlinear + 4 NonlinearVirtual + 5 Pointer + 6 PointerRoot + 7 None + 2 CARD16 sequence number + 4 WINDOW event + 1 mode + 0 Normal + 1 Grab + 2 Ungrab + 3 WhileGrabbed + 23 unused + +<link linkend="events:KeymapNotify"><emphasis role='bold'>KeymapNotify</emphasis></link> + 1 11 code + 31 LISTofCARD8 keys (byte for keycodes 0-7 is + omitted) + +<link linkend="events:Expose"><emphasis role='bold'>Expose</emphasis></link> + 1 12 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 2 CARD16 x + 2 CARD16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 count + 14 unused + +<link linkend="events:GraphicsExposure"><emphasis role='bold'>GraphicsExposure</emphasis></link> + 1 13 code + 1 unused + 2 CARD16 sequence number + 4 DRAWABLE drawable + 2 CARD16 x + 2 CARD16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 minor-opcode + 2 CARD16 count + 1 CARD8 major-opcode + 11 unused + +<link linkend="events:NoExposure"><emphasis role='bold'>NoExposure</emphasis></link> + 1 14 code + 1 unused + 2 CARD16 sequence number + 4 DRAWABLE drawable + 2 CARD16 minor-opcode + 1 CARD8 major-opcode + 21 unused + +<link linkend="events:VisibilityNotify"><emphasis role='bold'>VisibilityNotify</emphasis></link> + 1 15 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 1 state + 0 Unobscured + 1 PartiallyObscured + 2 FullyObscured + 23 unused + +<link linkend="events:CreateNotify"><emphasis role='bold'>CreateNotify</emphasis></link> + 1 16 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 1 BOOL override-redirect + 9 unused + +<link linkend="events:DestroyNotify"><emphasis role='bold'>DestroyNotify</emphasis></link> + 1 17 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 20 unused + +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link> + 1 18 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 1 BOOL from-configure + 19 unused + +<link linkend="events:MapNotify"><emphasis role='bold'>MapNotify</emphasis></link> + 1 19 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 1 BOOL override-redirect + 19 unused + +<link linkend="events:MapRequest"><emphasis role='bold'>MapRequest</emphasis></link> + 1 20 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 20 unused + +<link linkend="events:ReparentNotify"><emphasis role='bold'>ReparentNotify</emphasis></link> + 1 21 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 4 WINDOW parent + 2 INT16 x + 2 INT16 y + 1 BOOL override-redirect + 11 unused + +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link> + 1 22 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 4 WINDOW above-sibling + 0 None + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 1 BOOL override-redirect + 5 unused + +<link linkend="events:ConfigureRequest"><emphasis role='bold'>ConfigureRequest</emphasis></link> + 1 23 code + 1 stack-mode + 0 Above + 1 Below + 2 TopIf + 3 BottomIf + 4 Opposite + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 4 WINDOW sibling + 0 None + 2 INT16 x + 2 INT16 y + 2 CARD16 width + 2 CARD16 height + 2 CARD16 border-width + 2 BITMASK value-mask + #x0001 x + #x0002 y + #x0004 width + #x0008 height + #x0010 border-width + #x0020 sibling + #x0040 stack-mode + 4 unused + +<link linkend="events:GravityNotify"><emphasis role='bold'>GravityNotify</emphasis></link> + 1 24 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 2 INT16 x + 2 INT16 y + 16 unused + +<link linkend="events:ResizeRequest"><emphasis role='bold'>ResizeRequest</emphasis></link> + 1 25 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 2 CARD16 width + 2 CARD16 height + 20 unused + +<link linkend="events:CirculateNotify"><emphasis role='bold'>CirculateNotify</emphasis></link> + 1 26 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW event + 4 WINDOW window + 4 WINDOW unused + 1 place + 0 Top + 1 Bottom + 15 unused + +<link linkend="events:CirculateRequest"><emphasis role='bold'>CirculateRequest</emphasis></link> + 1 27 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW parent + 4 WINDOW window + 4 unused + 1 place + 0 Top + 1 Bottom + 15 unused + +<link linkend="events:PropertyNotify"><emphasis role='bold'>PropertyNotify</emphasis></link> + 1 28 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 4 ATOM atom + 4 TIMESTAMP time + 1 state + 0 NewValue + 1 Deleted + 15 unused + +<link linkend="events:SelectionClear"><emphasis role='bold'>SelectionClear</emphasis></link> + 1 29 code + 1 unused + 2 CARD16 sequence number + 4 TIMESTAMP time + 4 WINDOW owner + 4 ATOM selection + 16 unused + +<link linkend="events:SelectionRequest"><emphasis role='bold'>SelectionRequest</emphasis></link> + 1 30 code + 1 unused + 2 CARD16 sequence number + 4 TIMESTAMP time + 0 CurrentTime + 4 WINDOW owner + 4 WINDOW requestor + 4 ATOM selection + 4 ATOM target + 4 ATOM property + 0 None + 4 unused + +<link linkend="events:SelectionNotify"><emphasis role='bold'>SelectionNotify</emphasis></link> + 1 31 code + 1 unused + 2 CARD16 sequence number + 4 TIMESTAMP time + 0 CurrentTime + 4 WINDOW requestor + 4 ATOM selection + 4 ATOM target + 4 ATOM property + 0 None + 8 unused + +<link linkend="events:ColormapNotify"><emphasis role='bold'>ColormapNotify</emphasis></link> + 1 32 code + 1 unused + 2 CARD16 sequence number + 4 WINDOW window + 4 COLORMAP colormap + 0 None + 1 BOOL new + 1 state + 0 Uninstalled + 1 Installed + 18 unused + +<link linkend="events:ClientMessage"><emphasis role='bold'>ClientMessage</emphasis></link> + 1 33 code + 1 CARD8 format + 2 CARD16 sequence number + 4 WINDOW window + 4 ATOM type + 20 data + +<link linkend="events:MappingNotify"><emphasis role='bold'>MappingNotify</emphasis></link> + 1 34 code + 1 unused + 2 CARD16 sequence number + 1 request + 0 Modifier + 1 Keyboard + 2 Pointer + 1 KEYCODE first-keycode + 1 CARD8 count + 25 unused +</literallayout> + +</sect1> +</appendix> diff --git a/specs/fsproto.xml b/specs/fsproto.xml new file mode 100644 index 0000000..74f2428 --- /dev/null +++ b/specs/fsproto.xml @@ -0,0 +1,4417 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "defs.ent"> %defs; +]> + + +<book id="fsproto"> + +<bookinfo> + <title>The X Font Service Protocol</title> + <subtitle>X Consortium Standard</subtitle> + <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo> + <releaseinfo>Version 2.0</releaseinfo> + <authorgroup> + <author> + <firstname>Jim</firstname><surname>Fulton</surname> + <affiliation><orgname>Network Computing Devices, Inc.</orgname></affiliation> + </author> + </authorgroup> + <edition>Revised May 2, 1994</edition> + <copyright><year>1991</year><holder>Network Computing Devices, Inc.</holder></copyright> + +<legalnotice> +<para> +Permission to use, copy, modify, distribute, and sell this +documentation for any purpose is hereby granted without fee, +provided that the above copyright notice and this permission +notice appear in all copies. Network Computing Devices, Inc. +makes no representations about the suitability for any purpose +of the information in this document. This documentation is +provided “as is” without express or implied warranty. +</para> +</legalnotice> + +<legalnotice> +<para role="multiLicensing">Copyright © 1994 X Consortium</para> +<para> +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: +</para> +<para> +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. +</para> +<para> +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +</para> +<para> +Except as contained in this notice, the name of the X Consortium shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the X Consortium. +</para> +</legalnotice> +</bookinfo> + +<chapter id='Introduction'> +<title>Introduction</title> +<para> +The management of fonts in large, heterogeneous environments is one of the +hardest aspects of using the X Window System +<footnote id='footnote1'><para> +<firstterm><trademark>X Window System</trademark></firstterm> +is a trademark of The Open Group. +</para></footnote> +. Multiple formats and the lack of +a consistent mechanism for exporting font data to all displays on a network +prevent the transparent use of applications across different display platforms. +The X Font Service protocol is designed to address this and other issues, with +specific emphasis on the needs of the core X protocol. Upward-compatible +changes (typically in the form of new requests) are expected as consensus is +reached on new features (particularly outline font support). +</para> +<para> +Currently, most X displays use network file protocols such as +<acronym>NFS</acronym> and <acronym>TFTP</acronym> to +obtain raw font data which they parse directly. Since a common binary format +for this data doesn't exist, displays must be able to interpret a variety of +formats if they are to be used with different application hosts. This leads to +wasted code and data space and a loss of interoperability as displays are used +in unforeseen environments. +</para> +<para> +By moving the interpretation of font data out of the X server into a separate +service on the network, these problems can be greatly reduced. In addition, +new technologies, such as dynamically generating bitmaps from scaled or outline +fonts, can be provided to all displays transparently. For horizontal text, +caching techniques and increased processor power can potentially make +rasterization more efficient on large, centralized hosts than on individual +displays. +</para> +<para> +Each font server provides sets of fonts that may be listed and queried for +header, property, glyph extents, and bitmap information. This data is +transmitted over the network using a binary format (with variations to support +different bit- and byte-orders) designed to minimize the amount of processing +required by the display. Since the font server, rather than the display, is +responsible for parsing the raw font data, new formats can be used by all +displays by modifying a single font server. +</para> +<para> +From the user's point of view, font servers are simply a new type of name in +the X font path. Network name services allow descriptive names (such as +DEPARTMENT-FONTS or APPLICATION-FONTS) to be translated into proper network +addresses. X displays send requests to and read replies from the font server +rather than reading directly from files. Since the X Font Service protocol is +designed to allow subsets of the font data to be requested, displays may easily +implement a variety of strategies for fine-grained demand-loading of glyphs. +</para> +</chapter> + +<chapter id='Architectural_Model'> +<title>Architectural Model</title> +<!-- .XS --> +<!-- (SN Architectural Model --> +<!-- .XE --> +<para> +In this document, the words <firstterm>client</firstterm> and +<firstterm>server</firstterm> refer to the consumer and +provider of a font, respectively, unless otherwise indicated. It is important +to note that in this context, the X server is also a font client. +</para> +<para> +The X Font Service protocol does not require any changes to the core X protocol +or to any applications. To the user, font servers are simply additional types +of font path elements. As such, X servers may connect to multiple font +servers, as shown in Figure 2.1. Although the font protocol is geared towards +the X Window System, it may be also used by other consumers of font data (such +as printer drivers). +</para> + +<figure id="figure2.1" label="2.1"><title>Connecting to a Font Server</title> +<literallayout class="monospaced"> + ┌────────┐ ┌───────────────┐ + │ X1 ├──────────────┤ │ + │ Server │ │ Font Server │ + └────────┘ ┌───────┤ 1 │ + │ └───────────────┘ + ┌────────┐ │ + │ X2 ├──────┘ ┌───────────────┐ + │ Server ├──────────────┤ │ + └────────┘ │ Font Server │ + ┌───────┤ 2 │ +┌─────────┐ │ └───────────────┘ +│ other │ │ +│ clients ├──────┘ +└─────────┘ +</literallayout> +</figure> + +<para> +Clients communicate with the font server using the request/reply/event model +over any mutually-understood virtual stream connection (such as +<acronym>TCP/IP</acronym>, DECnet, +<footnote id='footnote2'><para> +<firstterm><trademark>DECnet</trademark></firstterm> is a trademark +of Digital Equipment Corporation. +</para></footnote> +etc.). Font servers are responsible for providing data in the bit and byte +orders requested by the client. The set of requests and events provided in the +first version of the X Font Service protocol is limited to supporting the needs +of the bitmap-oriented core X Window System protocol. Extensions are expected +as new needs evolve. +</para> +<para> +A font server reads raw font data from a variety of sources (possibly +including other font servers) and converts it into a common format that is +transmitted to the client using the protocol described in +<link linkend='Protocol'>Section 4</link>. New font +formats are handled by adding new converters to a font server, as shown in +Figure 2.2. +</para> + +<figure id="figure2.2" label="2.2"><title>Where Font Data Comes From</title> +<literallayout class="monospaced"> + ┌────────────┐ + │ client │ + │ (X server) │ + └─────┬──────┘ + │ + network + │ +┌─────────────────────┴──────────────────────┐ +│ │ +│ font server 1 │ +│ │ +├─────┬─────┬─────┬─────┬────┬─────┬───┬─────┤ +│ bdf │ snf │ pcf │ atm │ f3 │ dwf │ │ │ ... │ +└─────┴─────┴─────┴─────┴────┴─────┴─│─┴─────┘ + │ + network + │ + ┌─────┴────┐ + │ font │ + │ server 2 │ + └──────────┘ +</literallayout> +</figure> + +<para> +The server may choose to provide named sets of fonts called +<firstterm>catalogues</firstterm>. +Clients may specify which of the sets should be used in listing or opening a +font. +</para> + +<para> +An event mechanism similar to that used in the X protocol is provided for +asynchronous notification of clients by the server. +</para> + +<para> +Clients may provide authorization data for the server to be used in determining +(according to the server's licensing policy) whether or not access should be +granted to particular fonts. This is particularly useful for clients whose +authorization changes over time (such as an X server that can verify the +identity of the user). +</para> +<para> +Implementations that wish to provide additional requests or events may use the +extension mechanism. Adding to the core font service protocol (with the +accompanying change in the major or minor version numbers) is reserved to the X +Consortium. +</para> +</chapter> + +<chapter id='Font_Server_Naming'> +<title>Font Server Naming</title> +<!-- .XS --> +<!-- (SN Font Server Naming --> +<!-- .XE --> +<para> +Font clients that expose font server names to the user are encouraged to +provide ways of naming font servers symbolically (e.g. DEPARTMENT-FONTS). +However, for environments that lack appropriate name services +transport-specific names are necessary. Since these names do occur in the +protocol, clients and servers should support at least the applicable formats +described below. Formats for additional transports may be registered with the +X Consortium. +</para> + +<section id='TCPIP_Names'> +<title>TCP/IP Names</title> +<!-- .XS --> +<!-- (SN TCP/IP Names --> +<!-- .XE --> +<para> +The following syntax should be used for TCP/IP names: + +<literallayout class="monospaced"> + <replaceable>TCP name</replaceable> ::= <literal>tcp/</literal> <replaceable>hostname</replaceable> <literal>:</literal> <replaceable>ipportnumber</replaceable> <optional><literal>/</literal> <replaceable>cataloguelist</replaceable></optional> +</literallayout> + +where <replaceable>hostname</replaceable> is either symbolic (such as +<systemitem class="systemname">expo.lcs.mit.edu</systemitem>) or numeric +decimal (such as <systemitem class="ipaddress">18.30.0.212</systemitem>). +The <replaceable>ipportnumber</replaceable> is the port on which the +font server is listening for connections. +The <replaceable>cataloguelist</replaceable> string at +the end is optional and specifies a plus-separated list of catalogues +that may be requested. For example: +<literallayout class="monospaced"> + tcp/expo.lcs.mit.edu:8012/available+special + tcp/18.30.0.212:7890 +</literallayout> +</para> +</section> + +<section id='DECnet_Names'> +<title>DECnet Names</title> +<!-- .XS --> +<!-- (SN DECnet Names --> +<!-- .XE --> +<para> +The following syntax should be used for DECnet names: + +<literallayout class="monospaced"> + <replaceable>DECnet name</replaceable> ::= <literal>decnet/</literal> <replaceable>nodename</replaceable> <literal>::font$</literal> <replaceable>objname</replaceable> <optional><literal>/</literal> <replaceable>cataloguelist</replaceable></optional> +</literallayout> + +where <replaceable>nodename</replaceable> is either symbolic (such as +<systemitem class="systemname">SRVNOD</systemitem>) or the +numeric decimal form of the DECnet address (such as +<systemitem class="ipaddress">44.70</systemitem>). +The <replaceable>objname</replaceable> is normal, case-insensitive DECnet +object name. The <replaceable>cataloguelist</replaceable> string +at the end is +optional and specifies a plus-separated list of catalogues that may be +requested. For example: + +<literallayout class="monospaced"> + DECNET/SRVNOD::FONT$DEFAULT/AVAILABLE + decnet/44.70::font$other +</literallayout> +</para> +</section> +</chapter> + +<chapter id='Protocol'> +<title>Protocol</title> +<!-- .XS --> +<!-- (SN Protocol --> +<!-- .XE --> +<para> +The protocol described below uses the request/reply/error model and is +specified using the same conventions outlined in +<olink targetdoc='x11protocol' targetptr='Syntactic_Conventions'>Section 2 +of the core X Window System protocol</olink> +<xref linkend="References:x11proto"/>: +</para> +<itemizedlist> + <listitem> + <para> +<!-- .IP \(bu 5 --> +Data type names are spelled in upper case with no word separators, +as in: <link linkend="Data_Types:FONTID"><type>FONTID</type></link> + </para> + </listitem> + <listitem> + <para> +<!-- .IP \(bu 5 --> +Alternate values are capitalized with no word separators, +as in: <constant>MaxWidth</constant> + </para> + </listitem> + <listitem> + <para> +<!-- .IP \(bu 5 --> +Structure element declarations are in lower case with hyphens +as word separators, as in: <structfield>byte-order-msb</structfield> + </para> + <note> + <para> +Structure element names are referred to in +upper case (e.g. <structfield>BYTE-ORDER-MSB</structfield>) when used in +descriptions to set them off from the surrounding +text. When this document is typeset they will be +printed in lower case in a distinct font. + </para> + </note> + </listitem> + <listitem> + <para> +Type declarations have the form <quote><type>name</type>: type</quote>, +as in: <type>CARD8</type>: 8-bit byte + </para> + </listitem> + <listitem> + <para> +Comma-separated lists of alternate values are enclosed in +braces, as in: { <constant>Min</constant>, <constant>MaxWidth</constant>, +<constant>Max</constant> } + </para> + </listitem> + <listitem> + <para> +Comma-separated lists of structure elements are enclosed in +brackets, as in: [ <structfield>byte1</structfield>: <type>CARD8</type>, +<structfield>byte2</structfield>: <type>CARD8</type> ] + </para> + </listitem> +</itemizedlist> + +<para> +A type with a prefix <quote>LISTof</quote> represents a counted list of +elements of that type, as in: <type>LISTofCARD8</type> +</para> + +<section id='Data_Types'> +<title>Data Types</title> +<!-- .XS --> +<!-- (SN Data Types --> +<!-- .XE --> +<para> +The following data types are used in the core X Font Server protocol: +</para> + +<section id="Data_Types:ACCESSCONTEXT"> + <title><type>ACCESSCONTEXT</type></title> + <indexterm zone="Data_Types:ACCESSCONTEXT" significance="preferred"><primary>ACCESSCONTEXT</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>ACCESSCONTEXT</type>:</entry><entry><link linkend="Data_Types:ID"><type>ID</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> +<para> +This value is specified in the CreateAC request as the identifier +to be used when referring to a particular AccessContext resource +within the server. These resources are used by the server to +store client-specified authorization information. This +information may be used by the server to determine whether or not +the client should be granted access to particular font data. +</para> +<para> +In order to preserve the integrity of font licensing being performed by +the font server, care must be taken by a client to properly represent the +identity of the true user of the font. Some font clients will in fact +be servers (for example, X servers) requesting fonts for their own clients. +Other font clients may be doing work on behalf of a number of different +users over time (for example, print spoolers). +</para> +<para> +<type>AccessContext</type>s +must be created (with +<link linkend="Requests:CreateAC"><function>CreateAC</function></link>) +and switched among (with +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link>) +to represent all of these <quote>font users</quote> properly. + </para> +</section> + +<section id="Data_Types:ALTERNATESERVER"> + <title><type>ALTERNATESERVER</type></title> + <indexterm zone="Data_Types:ALTERNATESERVER" significance="preferred"><primary>ALTERNATESERVER</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows="1"><type>ALTERNATESERVER</type>:</entry> + <entry> [ <structfield>name</structfield>:</entry><entry> <link linkend="Data_Types:STRING8"><type>STRING8</type></link>,</entry></row> + <row><entry> <structfield>subset</structfield>:</entry><entry> <link linkend="Data_Types:BOOL"><type>BOOL</type></link> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This structure specifies the <structfield>NAME</structfield>, +encoded in <acronym>ISO</acronym> 8859-1 according +to <link linkend='Font_Server_Naming'>Section 3</link>, +of another font server that may be useful as a +substitute for this font server. +The <structfield>SUBSET</structfield> field indicates +whether or not the alternate server is likely to only contain a +subset of the fonts available from this font server. This +information is returned during the initial connection setup and +may be used by the client to find a backup server in case of +failure. + </para> +</section> + +<section id="Data_Types:AUTH"> + <title><type>AUTH</type></title> + <indexterm zone="Data_Types:AUTH" significance="preferred"><primary>AUTH</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows="1"><type>AUTH</type>:</entry><entry>[ <structfield>name</structfield>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link>,</entry></row> + <row><entry> <structfield>data</structfield>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +This structure specifies the name of an authorization protocol and +initial data for that protocol. It is used in the authorization +negotiation in the initial connection setup and in the CreateAC +request. +</para> +</section> + +<section id="Data_Types:BITMAPFORMAT"> + <title><type>BITMAPFORMAT</type></title> + <indexterm zone="Data_Types:BITMAPFORMAT" significance="preferred"><primary>BITMAPFORMAT</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>BITMAPFORMAT</type>:</entry><entry><type>CARD32</type></entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> + <type>CARD32</type> containing the following fields defined by the + sets of values given further below + </para> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry>[</entry></row> + <row><entry> <structfield>byte-order-msb</structfield>:</entry><entry> 1 bit,</entry></row> + <row><entry> <structfield>bit-order-msb</structfield>:</entry><entry> 1 bit,</entry></row> + <row><entry> <structfield>image-rect</structfield>:</entry><entry> 2 bits</entry><entry>{ <constant>Min</constant>, + <constant>MaxWidth</constant>, + <constant>Max</constant> },</entry></row> + <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 4 bits,</entry></row> + <row><entry> <structfield>scanline-pad</structfield>:</entry><entry> 2 bits</entry><entry>{ <constant>ScanlinePad8</constant>, + <constant>ScanlinePad16</constant>, + <constant>ScanlinePad32</constant>, + <constant>ScanlinePad64</constant> },</entry></row> + <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 2 bits,</entry></row> + <row><entry> <structfield>scanline-unit</structfield>:</entry><entry> 2 bits</entry><entry>{ <constant>ScanlineUnit8</constant>, + <constant>ScanlineUnit16</constant>, + <constant>ScanlineUnit32</constant>, + <constant>ScanlineUnit64</constant> },</entry></row> + <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 2 bits,</entry></row> + <row><entry> <structfield>zero-pad</structfield>:</entry><entry> 16 bits,</entry></row> + <row><entry>]</entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +This structure specifies how glyph images are transmitted in +response to +<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link> +and +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +requests. +</para> +<para> +If the <structfield>BYTE-ORDER-MSB</structfield> bit +<literal>(1 << 0)</literal> is set, the Most Significant +Byte of each scanline unit is returned first. Otherwise, the +Least Significant Byte is returned first. +</para> +<para> +If the <structfield>BIT-ORDER-MSB</structfield> bit +<literal>(1 << 1)</literal> is set, the left-most bit in +each glyph scanline unit is stored in the Most Significant Bit of +each transmitted scanline unit. Otherwise, the left-most bit is +stored in the Least Significant Bit. +</para> +<para> +The <structfield>IMAGE-RECT</structfield> field specifies a rectangle of +pixels within the +glyph image. It contains one of the following alternate values: + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>ImageRectMin</constant></entry><entry><literal>(0 << 2)</literal></entry></row> + <row><entry><constant>ImageRectMaxWidth</constant></entry><entry><literal>(1 << 2)</literal></entry></row> + <row><entry><constant>ImageRectMax</constant></entry><entry><literal>(2 << 2)</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +For a glyph with extents <link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link> in a font with header +information <link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link>, the <structfield>IMAGE-RECT</structfield> +values have the following meanings: +<variablelist> + <varlistentry id="Constant:ImageRectMin"> + <term><constant>ImageRectMin</constant></term> + <listitem> + <indexterm zone="Constant:ImageRectMin" significance="preferred"><primary>ImageRectMin</primary></indexterm> + <para> +This refers to the minimal bounding rectangle +surrounding the inked pixels in the glyph. This is the +most compact representation. The edges of the rectangle +are: +<literallayout class="monospaced"> + left: <structfield>XCHARINFO.LBEARING</structfield> + right: <structfield>XCHARINFO.RBEARING</structfield> + top: <structfield>XCHARINFO.ASCENT</structfield> + bottom: <structfield>XCHARINFO.DESCENT</structfield> +</literallayout> + </para> + </listitem> + </varlistentry> + <varlistentry id="Constant:ImageRectMaxWidth"> + <term><constant>ImageRectMaxWidth</constant></term> + <listitem> + <indexterm zone="Constant:ImageRectMaxWidth" significance="preferred"><primary>ImageRectMaxWidth</primary></indexterm> + <para> +This refers to the scanlines between the +glyph's ascent and descent, padded on the left to the minimum +left-bearing (or 0, whichever is less) and on the right to +the maximum right-bearing (or logical-width, whichever is +greater). All glyph images share a common horizontal +origin. This is a combination of <constant>ImageRectMax</constant> in the +horizontal direction and <constant>ImageRectMin</constant> in the vertical +direction. The edges of the rectangle are: + +<literallayout class="monospaced"> +left: min (<structfield>XFONTINFO.MIN-BOUNDS.LBEARING</structfield>, 0) +right: max (<structfield>XFONTINFO.MAX-BOUNDS.RBEARING</structfield>, + <structfield>XFONTINFO.MAX-BOUNDS.WIDTH</structfield>) +top: <structfield>XCHARINFO.ASCENT</structfield> +bottom: <structfield>XCHARINFO.DESCENT</structfield> +</literallayout> + </para> + </listitem> + </varlistentry> + <varlistentry id="Constant:ImageRectMax"> + <term><constant>ImageRectMax</constant></term> + <listitem> + <indexterm zone="Constant:ImageRectMax" significance="preferred"><primary>ImageRectMax</primary></indexterm> + <para> +This refers to all scanlines, from the maximum +ascent (or the font ascent, whichever is greater) to the +maximum descent (or the font descent, whichever is greater), +padded to the same horizontal extents as <constant>MaxWidth</constant>. +All glyph images have the same sized bitmap and share a +common origin. This is the least compact representation, +but may be the easiest or most efficient (particularly for +character cell fonts) for some clients to use. The edges of +the rectangle are: + +<literallayout class="monospaced"> +left: min (<structfield>XFONTINFO.MIN-BOUNDS.LBEARING</structfield>, 0) +right: max (<structfield>XFONTINFO.MAX-BOUNDS.RBEARING</structfield>, + <structfield>XFONTINFO.MAX-BOUNDS.WIDTH</structfield>) +top: max (<structfield>XFONTINFO.FONT-ASCENT</structfield>, + <structfield>XFONTINFO.MAX-BOUNDS.ASCENT</structfield>) +bottom: max (<structfield>XFONTINFO.FONT-DESCENT</structfield>, + <structfield>XFONTINFO.MAX-BOUNDS.DESCENT</structfield>) +</literallayout> + </para> + </listitem> + </varlistentry> +</variablelist> +</para> +<para> +The <structfield>SCANLINE-PAD</structfield> field specifies the number of +bits (8, 16, 32, +or 64) to which each glyph scanline is padded before transmitting. +It contains one of the following alternate values: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>ScanlinePad8</constant></entry><entry><literal>(0 << 8)</literal></entry></row> + <row><entry><constant>ScanlinePad16</constant></entry><entry><literal>(1 << 8)</literal></entry></row> + <row><entry><constant>ScanlinePad32</constant></entry><entry><literal>(2 << 8)</literal></entry></row> + <row><entry><constant>ScanlinePad64</constant></entry><entry><literal>(3 << 8)</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +The <structfield>SCANLINE-UNIT</structfield> field specifies the number of +bits (8, 16, 32, or 64) that should be treated as a unit for swapping. +This value must be less than or equal to the number of bits specified by the +<structfield>SCANLINE-PAD</structfield>. It contains one of the following +alternate values: + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>ScanlineUnit8</constant></entry><entry><literal>(0 << 12)</literal></entry></row> + <row><entry><constant>ScanlineUnit16</constant></entry><entry><literal>(1 << 12)</literal></entry></row> + <row><entry><constant>ScanlineUnit32</constant></entry><entry><literal>(2 << 12)</literal></entry></row> + <row><entry><constant>ScanlineUnit64</constant></entry><entry><literal>(3 << 12)</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +<link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link>s are byte-swapped as <type>CARD32</type>s. +All unspecified bits must be zero. +</para> +<para> +Use of an invalid <link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link> causes a +<link linkend="Errors:Format"><errorname>Format</errorname></link> error to be returned. +</para> +</section> + +<section id="Data_Types:BITMAPFORMATMASK"> + <title><type>BITMAPFORMATMASK</type></title> + <indexterm zone="Data_Types:BITMAPFORMATMASK" significance="preferred"><primary>BITMAPFORMATMASK</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>BITMAPFORMATMASK</type>:</entry><entry> <type>CARD32</type> mask</entry></row> + </tbody> + </tgroup> + </informaltable> +<para> +This is a mask of bits representing the fields in a <link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link>: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>ByteOrderMask</constant></entry><entry><literal>(1 << 0)</literal></entry></row> + <row><entry><constant>BitOrderMask</constant></entry><entry><literal>(1 << 1)</literal></entry></row> + <row><entry><constant>ImageRectMask</constant></entry><entry><literal>(1 << 2)</literal></entry></row> + <row><entry><constant>ScanlinePadMask</constant></entry><entry><literal>(1 << 3)</literal></entry></row> + <row><entry><constant>ScanlineUnitMask</constant></entry><entry><literal>(1 << 4)</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +Unspecified bits are required to be zero or else a +<link linkend="Errors:Format"><errorname>Format</errorname></link> error is returned. +</para> +</section> + +<section id="Data_Types:BOOL"> + <title><type>BOOL</type></title> + <indexterm zone="Data_Types:BOOL" significance="preferred"><primary>BOOL</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>BOOL</type>:</entry><entry> <type>CARD8</type></entry></row> + </tbody> + </tgroup> + </informaltable> +<para> +This is a boolean value containing one of the following alternate +values: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>False</constant></entry><entry><literal>0</literal></entry></row> + <row><entry><constant>True</constant></entry><entry><literal>1</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +</section> + +<section id="Data_Types:BYTE"> + <title><type>BYTE</type></title> + <indexterm zone="Data_Types:BYTE" significance="preferred"><primary>BYTE</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>BYTE</type>:</entry><entry> 8-bit value</entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +This is an unsigned byte of data whose encoding +is determined by the context in which it is used. +</para> + +</section> + +<section id="Data_Types:CARDn"> + <title><type>CARD8</type>, <type>CARD16</type>, <type>CARD32</type></title> + <indexterm zone="Data_Types:CARDn" significance="preferred"><primary>CARD8</primary></indexterm> + <indexterm zone="Data_Types:CARDn" significance="preferred"><primary>CARD16</primary></indexterm> + <indexterm zone="Data_Types:CARDn" significance="preferred"><primary>CARD32</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>CARD8</type>:</entry><entry> 8-bit unsigned integer</entry></row> + <row><entry><type>CARD16</type>:</entry><entry> 16-bit unsigned integer</entry></row> + <row><entry><type>CARD32</type>:</entry><entry> 32-bit unsigned integer</entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +These are unsigned numbers. The latter two are byte-swapped when +the server and client have different byte orders. +</para> + +</section> + +<section id="Data_Types:CHAR2B"> + <title><type>CHAR2B</type></title> + <indexterm zone="Data_Types:CHAR2B" significance="preferred"><primary>CHAR2B</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>CHAR2B</type>:</entry><entry>[ <structfield>byte1</structfield>, <structfield>byte2</structfield>:</entry><entry><type>CARD8</type> ]</entry></row> + </tbody> + </tgroup> + </informaltable> +<para> +This structure specifies an individual character code within +either a 2-dimensional matrix (using <structfield>BYTE1</structfield> +and <structfield>BYTE2</structfield> as the row and column indices, +respectively) or a vector (using <structfield>BYTE1</structfield> and +<structfield>BYTE2</structfield> as most- and least-significant bytes, +respectively). This data type is treated as a pair of 8-bit values and +is never byte-swapped. Therefore, the client should always transmit +<structfield>BYTE1</structfield> first. +</para> + +</section> + +<section id="Data_Types:EVENTMASK"> + <title><type>EVENTMASK</type></title> + <indexterm zone="Data_Types:EVENTMASK" significance="preferred"><primary>EVENTMASK</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>EVENTMASK</type>:</entry><entry> <type>CARD32</type> mask</entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +This is a mask of bits indicating which of an extension's (or the +core's) maskable events the client would like to receive. Each +bit indicates one or more events, and a bit value of one indicates +interest in a corresponding set of events. The following bits are +defined for event masks specified for the core protocol (i.e. an +<parameter>EXTENSION-OPCODE</parameter> of zero in +<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link> +and +<link linkend="Requests:GetEventMask"><function>GetEventMask</function></link> +requests): + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>CatalogueListChangeMask</constant></entry><entry><literal>(1 << 0)</literal></entry></row> + <row><entry><constant>FontListChangeMask</constant></entry><entry><literal>(1 << 1)</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> + +<para> +If +<constant>CatalogueListChangeMask</constant> +is set, client is interested in +receiving +<link linkend="Events:CatalogueListNotify"><function>CatalogueListNotify</function></link> +events. If +<constant>FontListChangeMask</constant> +is set, the client is interested in +receiving +<link linkend="Events:FontListNotify"><function>FontListNotify</function></link> +events. +</para> +<para> +Extensions that provide additional events may define their own +event masks. These event masks have their own scope and may use +the same bit values as the core or other extensions. + </para> + <para> +All unused bits must be set to zero. In +<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link> +requests, if +any bits are set that are not defined for the extension (or core) +for which this <type>EVENTMASK</type> is intended (according to the +<parameter>EXTENSION-OPCODE</parameter> given in the +<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link> +request), an +<link linkend="Errors:EventMask"><errorname>EventMask</errorname></link> +error is generated. + </para> + <para> +This value is swapped as a <type>CARD32</type>. + </para> + +</section> + +<section id="Data_Types:FONTID"> + <title><type>FONTID</type></title> + <indexterm zone="Data_Types:FONTID" significance="preferred"><primary>FONTID</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>FONTID</type>:</entry><entry> <link linkend="Data_Types:ID"><type>ID</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +This is specified by the client in the request +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +as the identifier to be used when referring to a particular open +font. +</para> + +</section> + +<section id="Data_Types:ID"> + <title><type>ID</type></title> + <indexterm zone="Data_Types:ID" significance="preferred"><primary>ID</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>ID</type>:</entry><entry> <type>CARD32</type></entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +This is a 32-bit value in which the top 3 bits must be clear, and +at least 1 other bit must be set (yielding a range of 1 through +2<superscript>29</superscript>-1). +It is specified by the client to represent objects in +the server. Identifiers are scoped according to their type are +private to the client; thus, the same identifier may be used for +both a <link linkend="Data_Types:FONTID"><type>FONTID</type></link> and an <link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> +as well as by multiple clients. +</para> +<para> +An <type>ID</type> of zero is referred to as <constant>None</constant>. +</para> +</section> + +<section id="Data_Types:INTn"> + <title><type>INT8</type>, <type>INT16</type>, <type>INT32</type></title> + <indexterm zone="Data_Types:INTn" significance="preferred"><primary>INT8</primary></indexterm> + <indexterm zone="Data_Types:INTn" significance="preferred"><primary>INT16</primary></indexterm> + <indexterm zone="Data_Types:INTn" significance="preferred"><primary>INT32</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>INT8</type>:</entry><entry> 8-bit signed integer</entry></row> + <row><entry><type>INT16</type>:</entry><entry> 16-bit signed integer</entry></row> + <row><entry><type>INT32</type>:</entry><entry> 32-bit signed integer</entry></row> + </tbody> + </tgroup> + </informaltable> + +<para> +These are signed numbers. The latter two are byte-swapped when +the client and server have different byte orders. +</para> +</section> + +<section id="Data_Types:OFFSET32"> + <title><type>OFFSET32</type></title> + <indexterm zone="Data_Types:OFFSET32" significance="preferred"><primary>OFFSET32</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows='1'><type>OFFSET32</type>:</entry> + <entry>[ <structfield>position</structfield>:</entry><entry><type>CARD32</type>,</entry></row> + <row><entry> <structfield>length</structfield>:</entry><entry><type>CARD32</type> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This structure indicates a position and length within a block of +data. + </para> +</section> + +<section id="Data_Types:PROPINFO"> + <title><type>PROPINFO</type></title> + <indexterm zone="Data_Types:PROPINFO" significance="preferred"><primary>PROPINFO</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows='1'><type>PROPINFO</type>:</entry> + <entry>[ <structfield>offsets</structfield>:</entry><entry><link linkend="Data_Types:PROPOFFSET"><type>LISTofPROPOFFSET</type></link>,</entry></row> + <row><entry> <structfield>data</structfield>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This structure describes the list of properties provided by a +font. Strings for all of the properties names and values are +stored within the data block and are located using a table of +offsets and lengths. + </para> + <para> +This structure is padded to 32-bit alignment. + </para> + +</section> + +<section id="Data_Types:PROPOFFSET"> + <title><type>PROPOFFSET</type></title> + <indexterm zone="Data_Types:PROPOFFSET" significance="preferred"><primary>PROPOFFSET</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows='3'><type>PROPOFFSET</type>:</entry> + <entry>[ <structfield>name</structfield>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>OFFSET32</type></link>,</entry></row> + <row><entry> <structfield>value</structfield>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>OFFSET32</type></link>,</entry></row> + <row><entry> <structfield>type</structfield>:</entry><entry><type>CARD8</type>,</entry></row> + <row><entry> <structfield>zero-pad3</structfield>:</entry><entry><link linkend="Data_Types:BYTE"><type>BYTE</type></link>, <link linkend="Data_Types:BYTE"><type>BYTE</type></link>, <link linkend="Data_Types:BYTE"><type>BYTE</type></link> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This structure specifies the position, length, and type of +of data for a property. + </para> + <para> +The <structfield>NAME</structfield> field specifies the position and length +(which must be +greater than zero) of the property name relative to the beginning +of the <structfield>PROPINFO.DATA</structfield> block for this font. +The interpretation of +the position and length of the <structfield>VALUE</structfield> field is +determined by the <structfield>TYPE</structfield> field, which contains +one of the following alternate values: + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>String</constant></entry><entry><literal>0</literal></entry></row> + <row><entry><constant>Unsigned</constant></entry><entry><literal>1</literal></entry></row> + <row><entry><constant>Signed</constant></entry><entry><literal>2</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +which have the following meanings: +<variablelist> + <varlistentry id="Constant:String"> + <term><constant>String</constant></term> + <listitem> + <indexterm zone="Constant:String" significance="preferred"><primary>String</primary></indexterm> + <para> +This property contains a counted string of bytes. The +data is stored in the <structfield>PROPINFO.DATA</structfield> +block beginning at +relative byte VALUE.POSITION (beginning with zero), extending +for VALUE.LENGTH (at least zero) bytes. + </para> + </listitem> + </varlistentry> + <varlistentry id="Constant:Unsigned"> + <term><constant>Unsigned</constant></term> + <listitem> + <indexterm zone="Constant:Unsigned" significance="preferred"><primary>Unsigned</primary></indexterm> + <para> +This property contains a unsigned, 32-bit number stored +as a <type>CARD32</type> in VALUE.POSITION (VALUE.LENGTH is zero). + </para> + </listitem> + </varlistentry> + <varlistentry id="Constant:Signed"> + <term><constant>Signed</constant></term> + <listitem> + <indexterm zone="Constant:Signed" significance="preferred"><primary>Signed</primary></indexterm> + <para> +This property contains a signed, 32-bit number stored as +an <type>INT32</type> in VALUE.POSITION (VALUE.LENGTH is zero). + </para> + </listitem> + </varlistentry> +</variablelist> +This structure is zero-padded to 32-bit alignment. +</para> + +</section> + +<section id="Data_Types:RANGE"> + <title><type>RANGE</type></title> + <indexterm zone="Data_Types:RANGE" significance="preferred"><primary>RANGE</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>RANGE</type>:</entry> + <entry>[ <structfield>min-char</structfield>, <structfield>max-char</structfield>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This structure specifies a range of character codes. A single +character is represented by <structfield>MIN-CHAR</structfield> equals +<structfield>MAX-CHAR</structfield>. If the linear interpretation of +<structfield>MAX-CHAR</structfield> is less than that of +<structfield>MIN-CHAR</structfield>, or if +<structfield>MIN-CHAR</structfield> is less than the font's +<structfield>XFONTINFO.CHAR-RANGE.MIN-CHAR</structfield>, or if +<structfield>MAX-CHAR</structfield> is greater than the +font's <structfield>XFONTINFO.CHAR-RANGE.MAX-CHAR</structfield>, +the range is invalid. + </para> + +</section> + +<section id="Data_Types:RESOLUTION"> + <title><type>RESOLUTION</type></title> + <indexterm zone="Data_Types:RESOLUTION" significance="preferred"><primary>RESOLUTION</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows='2'><type>RESOLUTION</type>:</entry> + <entry>[ <structfield>x-resolution</structfield>:</entry><entry><type>CARD16</type>,</entry></row> + <row><entry> <structfield>y-resolution</structfield>:</entry><entry><type>CARD16</type>,</entry></row> + <row><entry> <structfield>decipoint-size</structfield>:</entry><entry><type>CARD16</type> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This structure specifies resolution and point size to be used in +resolving partially-specified scaled font names. The +<structfield>X-RESOLUTION</structfield> and +<structfield>Y-RESOLUTION</structfield> are measured in +pixels-per-inch and must be greater than zero. +The <structfield>DECIPOINT-SIZE</structfield> is the preferred font +size, measured in tenths of a point, and must be greater than zero. + </para> + +</section> + +<section id="Data_Types:STRING8"> + <title><type>STRING8</type></title> + <indexterm zone="Data_Types:STRING8" significance="preferred"><primary>STRING8</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>STRING8</type>:</entry><entry> <type>LISTofCARD8</type></entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This is a counted list of 1-byte character codes, typically +encoded in <acronym>ISO</acronym> 8859-1. A character code +<quote><literal>c</literal></quote> is equivalent to a +<link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link> structure whose <structfield>BYTE1</structfield> +is zero and whose <structfield>BYTE2</structfield> is +<quote><literal>c</literal></quote>. + </para> + +</section> + +<section id="Data_Types:TIMESTAMP"> + <title><type>TIMESTAMP</type></title> + <indexterm zone="Data_Types:TIMESTAMP" significance="preferred"><primary>TIMESTAMP</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><type>TIMESTAMP</type>:</entry><entry> <type>CARD32</type></entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This is the number of milliseconds that have passed since a +server-dependent origin. It is provided in errors and events and is +permitted to wrap. + </para> +</section> + +<section id="Data_Types:XCHARINFO"> + <title><type>XCHARINFO</type></title> + <indexterm zone="Data_Types:XCHARINFO" significance="preferred"><primary>XCHARINFO</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows='3'><type>XCHARINFO</type>:</entry> + <entry>[ <structfield>lbearing</structfield>, <structfield>rbearing</structfield>:</entry><entry><type>INT16</type>,</entry></row> + <row><entry> <structfield>width</structfield>:</entry><entry><type>INT16</type>,</entry></row> + <row><entry> <structfield>ascent</structfield>, <structfield>descent</structfield>:</entry><entry><type>INT16</type>,</entry></row> + <row><entry> <structfield>attributes</structfield>:</entry><entry><type>CARD16</type> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This structure specifies the ink extents and horizontal escapement +(also known as the set- or logical width) of an individual +character. The first five values represent directed distances in +a coordinate system whose origin is aligned with the lower-left +edge of the left-most pixel of the glyph baseline (i.e. the +baseline falls between two pixels as shown in Figure 3-1 of the +<citetitle>Bitmap Distribution Format 2.1</citetitle> Consortium standard +<xref linkend="References:bdf-spec"/>). + </para> + <para> +The <structfield>LBEARING</structfield> field specifies the +directed distance measured to the +right from the origin to the left edge of the left-most inked +pixel in the glyph. + </para> + <para> +The <structfield>RBEARING</structfield> field specifies the +directed distance (measured to +the right) from the origin to the right edge of the right-most +inked pixel in the glyph. + </para> + <para> +The <structfield>WIDTH</structfield> field specifies the +directed distance (measured to the +right) from the origin to the position where the next character +should appear (called the <firstterm>escapement point</firstterm>). This +distance includes any whitespace used for intercharacter padding and is +also referred to as the <firstterm>logical width</firstterm> or +<firstterm>horizontal escapement</firstterm>. +<indexterm zone="Data_Types:XCHARINFO" significance="preferred"><primary>horizontal escapement</primary></indexterm> + </para> + <para> +The <structfield>ASCENT</structfield> field specifies the +directed distance (measured up) +from the baseline to the top edge of the top-most inked pixel +in the glyph. + </para> + <para> +The <structfield>DESCENT</structfield> field specifies the +directed distance (measured +down) from the baseline to the bottom edge of the bottom-most +inked pixel. + </para> + <para> +The <structfield>ATTRIBUTES</structfield> field specifies +glyph-specific information that +is passed through the application. If this value is not being +used, it should be zero. + </para> + <para> +The ink bounding box of a glyph is defined to be the smallest +rectangle that encloses all of the inked pixels. This box has +a width of +<structfield>RBEARING</structfield> − <structfield>LBEARING</structfield> +pixels and a height of +<structfield>ASCENT</structfield> + <structfield>DESCENT</structfield> pixels. + </para> +</section> + +<section id="Data_Types:XFONTINFO"> + <title><type>XFONTINFO</type></title> + <indexterm zone="Data_Types:XFONTINFO" significance="preferred"><primary>XFONTINFO</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry morerows='8'><type>XFONTINFO</type>:</entry> + <entry>[ <structfield>flags</structfield>:</entry><entry><type>CARD32</type>,</entry></row> + <row><entry> <structfield>drawing-direction</structfield>:</entry><entry>{ <constant>LeftToRight</constant>, <constant>RightToLeft</constant> }</entry></row> + <row><entry> <structfield>char-range</structfield>:</entry><entry><link linkend="Data_Types:RANGE"><type>RANGE</type></link>,</entry></row> + <row><entry> <structfield>default-char</structfield>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link>,</entry></row> + <row><entry> <structfield>min-bounds</structfield>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link>,</entry></row> + <row><entry> <structfield>max-bounds</structfield>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link>,</entry></row> + <row><entry> <structfield>font-ascent</structfield>:</entry><entry><type>INT16</type>,</entry></row> + <row><entry> <structfield>font-descent</structfield>:</entry><entry><type>INT16</type>,</entry></row> + <row><entry> <structfield>properties</structfield>:</entry><entry><link linkend="Data_Types:PROPINFO"><type>PROPINFO</type></link> ]</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This structure specifies attributes related to the font as a +whole. + </para> + <para> +The <structfield>FLAGS</structfield> field is a bit mask containing zero +or more of the following boolean values (unspecified bits must be zero): + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>AllCharactersExist</constant></entry><entry><literal>(1 << 0)</literal></entry></row> + <row><entry><constant>InkInside</constant></entry><entry><literal>(1 << 1)</literal></entry></row> + <row><entry><constant>HorizontalOverlap</constant></entry><entry><literal>(1 << 2)</literal></entry></row> + </tbody> + </tgroup> + </informaltable> + +which have the following meanings: +<variablelist> + <varlistentry id="Constant:AllCharactersExist"> + <term><constant>AllCharactersExist</constant></term> + <listitem> + <indexterm zone="Constant:AllCharactersExist" significance="preferred"><primary>AllCharactersExist</primary></indexterm> + <para> +If this bit is set, all of the characters in the range given by +<structfield>CHAR-RANGE</structfield> have glyphs encoded in +the font. If this bit is clear, some of the characters +may not have encoded glyphs. + </para> + </listitem> + </varlistentry> + <varlistentry id="Constant:InkInside"> + <term><constant>InkInside</constant></term> + <listitem> + <indexterm zone="Constant:InkInside" significance="preferred"><primary>InkInside</primary></indexterm> + <para> +If this bit is set, the inked pixels of each glyph +fall within the rectangle described by the font's ascent, +descent, origin, and the glyph's escapement point. If +this bit is clear, there may be glyphs whose ink extends +outside this rectangle. + </para> + </listitem> + </varlistentry> + <varlistentry id="Constant:HorizontalOverlap"> + <term><constant>HorizontalOverlap</constant></term> + <listitem> + <indexterm zone="Constant:HorizontalOverlap" significance="preferred"><primary>HorizontalOverlap</primary></indexterm> + <para> +If this bit is set, the two ink bounding +boxes (smallest rectangle enclosing the inked pixels) of +some pairs of glyphs in the font may overlap when displayed +side-by-side (i.e. the second character is imaged at the +escapement point of the first) on a common baseline. If +this bit is clear, there are no pairs of glyphs whose ink +bounding boxes overlap. + </para> + </listitem> + </varlistentry> +</variablelist> +</para> +<para id="Data_Types:XFONTINFO.DRAWING-DIRECTION"> + <indexterm zone="Data_Types:XFONTINFO.DRAWING-DIRECTION" significance="preferred"><primary>LeftToRight</primary></indexterm> + <indexterm zone="Data_Types:XFONTINFO.DRAWING-DIRECTION" significance="preferred"><primary>RightToLeft</primary></indexterm> +The <structfield>DRAWING-DIRECTION</structfield> field contains a hint +indicating whether most of the character metrics have a positive (or +<quote><constant>LeftToRight</constant></quote>) logical width or a +negative (<quote><constant>RightToLeft</constant></quote>) logical width. It +contains the following alternate values: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>LeftToRight</constant></entry><entry><literal>0</literal></entry></row> + <row><entry><constant>RightToLeft</constant></entry><entry><literal>1</literal></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +The <structfield>CHAR-RANGE.MIN-CHAR</structfield> +and <structfield>CHAR-RANGE.MAX-CHAR</structfield> fields specify the +first and last character codes that have glyphs encoded in this font. +All fonts must have at least one encoded glyph (in which case the +<structfield>MIN-CHAR</structfield> and <structfield>MAX-CHAR</structfield> +are equal), but are not required to have glyphs +encoded at all positions between the first and last characters. +</para> +<para> +The <structfield>DEFAULT-CHAR</structfield> field specifies +the character code of the glyph +that the client should substitute for unencoded characters. Requests +for extents or bitmaps for an unencoded character generate zero-filled +metrics and a zero-length glyph bitmap, respectively. +</para> +<para> +The <structfield>MIN-BOUNDS</structfield> and +<structfield>MAX-BOUNDS</structfield> fields contain the minimum and maximum +values of each of the extents field of all encoded characters in the +font (i.e. non-existent characters are ignored). +</para> +<para> +The <structfield>FONT-ASCENT</structfield> and +<structfield>FONT-DESCENT</structfield> fields specify the font designer's +logical height of the font, above and below the baseline, +respectively. The sum of the two values is often used as the +vertical line spacing of the font. Individual glyphs are permitted +to have ascents and descents that are greater than these values. +</para> +<para> +The <structfield>PROPERTIES</structfield> field contains the +property data associated with this font. +</para> +<para> +This structure is padded to 32-bit alignment. +</para> +</section> +</section> + +<section id='Requests'> +<title>Requests</title> +<!-- .XS --> +<!-- (SN Requests --> +<!-- .XE --> +<para> +This section describes the requests that may be sent by the client and the +replies or errors that are generated in response. Versions of the protocol +with the same major version are required to be upward-compatible. +</para> +<para> +Every request on a given connection is implicitly assigned a sequence number, +starting with 1, that is used in replies, error, and events. Servers are +required to generate replies and errors in the order in which the corresponding +requests are received. Servers are permitted to add or remove fonts to the +list visible to the client between any two requests, but requests must be +processed atomically. Each request packet is at least 4 bytes long and +contains the following fields: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>major-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>minor-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>length</parameter>:</entry><entry><type>CARD16</type></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> + +The <parameter>MAJOR-OPCODE</parameter> specifies which core request or +extension package this packet represents. If the +<parameter>MAJOR-OPCODE</parameter> corresponds to a core request, the +<parameter>MINOR-OPCODE</parameter> contains 8 bits of request-specific data. +Otherwise, the <parameter>MINOR-OPCODE</parameter> specifies which extension +request this packet represents. The <parameter>LENGTH</parameter> field +specifies the number of 4-byte units contained within the packet +and must be at least one. If this field contains a value greater than one it +is followed by (<parameter>LENGTH</parameter> - 1) * 4 bytes +of request-specific data. Unless +otherwise specified, unused bytes are not required to be zero. +</para> +<para> +If a request packet contains too little or too much data, the server returns +a <link linkend="Errors:Length"><errorname>Length</errorname></link> error. +If the server runs out of internal +resources (such as memory) while processing a request, it returns an +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link> error. +If a server is deficient (and therefore non-compliant) and is unable to +process a request, it may return an +<link linkend="Errors:Implementation"><errorname>Implementation</errorname></link> error. +If a client uses an extension request without previously having issued a +<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link> +request for that extension, the server responds with a +<link linkend="Errors:Request"><errorname>Request</errorname></link> +error. If the server encounters a request with an unknown +<parameter>MAJOR-OPCODE</parameter> or <parameter>MINOR-OPCODE</parameter>, +it responds with a +<link linkend="Errors:Request"><errorname>Request</errorname></link> +error. +At most one error is generated per request. If more than one error condition +is encountered in processing a requests, the choice of which error is returned +is server-dependent. +</para> +<para> +Core requests have <parameter>MAJOR-OPCODE</parameter> values between 0 and +127, inclusive. Extension requests have <parameter>MAJOR-OPCODE</parameter> +values between 128 and 255, inclusive, that are assigned by by the server. +All <parameter>MINOR-OPCODE</parameter> values in extension requests are +between 0 and 255, inclusive. +</para> +<para> +Each reply is at least 8 bytes long and contains the following fields: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>type</parameter>:</entry><entry><type>CARD8</type></entry><entry>value of 0</entry></row> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>sequence-number</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +The <parameter>TYPE</parameter> field has a value of zero. +The <parameter>DATA-OR-UNUSED</parameter> field may be used to +encode one byte of reply-specific data (see +<link linkend="Encoding::Requests">Section 5.2 on request encoding</link>). +The least-significant 16 bits of the sequence number of the request that +generated the reply are stored in the <parameter>SEQUENCE-NUMBER</parameter> +field. The <parameter>LENGTH</parameter> field specifies the number of +4-byte units in this reply packet, including the fields described above, +and must be at least two. If <parameter>LENGTH</parameter> is greater +than two, the fields described above are followed by +(<parameter>LENGTH</parameter> - 2) * 4 bytes of additional data. +</para> +<para> +Requests that have replies are described using the following syntax: + <blockquote><para> + <emphasis role="bold"><function>RequestName</function></emphasis> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>arg1</parameter>:</entry><entry><type>type1</type></entry></row> + <row><entry><parameter>arg2</parameter>:</entry><entry><type>type2</type></entry></row> + <row><entry> ...</entry></row> + <row><entry><parameter>argN</parameter>:</entry><entry><type>typeN</type></entry></row> + <row><entry> ▶</entry></row> + <row><entry><parameter>result1</parameter>:</entry><entry><type>type1</type></entry></row> + <row><entry><parameter>result2</parameter>:</entry><entry><type>type2</type></entry></row> + <row><entry> ...</entry></row> + <row rowsep="1"><entry><parameter>resultM</parameter>:</entry><entry><type>typeM</type></entry></row> + <row><entry>Errors:</entry><entry><errorname>kind1</errorname>, <errorname>kind2</errorname> ..., <errorname>kindK</errorname></entry></row> + </tbody> + </tgroup> + </informaltable> + Description + </para></blockquote> +</para> +<para> +If a request does not generate a reply, the ▶ and result lines are +omitted. If a request may generate multiple replies, the ▶ is replaced by +a ▶+. In the authorization data exchanges in the initial connection setup +and the CreateAC request, ◀ indicates data sent by the client in response +to data sent by the server. +</para> +<para> +The protocol begins with the establishment of a connection over a +mutually-understood virtual stream: +</para> + +<section id="Requests:open_connection"> + <title>open connection</title> + <indexterm zone="Requests:open_connection" significance="preferred"><primary>open connection</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='2.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>byte-order</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>BYTE</type></link></entry></row> + <row><entry><parameter>client-major-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>client-minor-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>authorization-protocols</parameter>:</entry><entry><link linkend="Data_Types:AUTH"><type>LISTofAUTH</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> +<para> +The initial byte of the connection specifies the +<parameter>BYTE-ORDER</parameter> in +which subsequent 16-bit and 32-bit numeric values are to be +transmitted. The octal value <literal>102</literal> +(<acronym>ASCII</acronym> uppercase <quote><literal>B</literal></quote>) +indicates that the most-significant byte is to be transmitted +first; the octal value <literal>154</literal> +(<acronym>ASCII</acronym> lowercase <quote><literal>l</literal></quote>) +indicates that the least-significant byte is to be transmitted first. +If any other value is encountered the server closes the +connection without any response. +</para> + <para> +The <parameter>CLIENT-MAJOR-PROTOCOL-VERSION</parameter> and +<parameter>CLIENT-MINOR-PROTOCOL-VERSION</parameter> specify +which version of the +font service protocol the client would like to use. If the +client can support multiple versions, the highest version +should be given. This version of the protocol has a +major version of 2 and a minor version of 0. + </para> + <para> +The <parameter>AUTHORIZATION-PROTOCOLS</parameter> +contains a list of protocol names and +optional initial data for which the client can provide +information. The server may use this to determine which +protocol to use or as part of the initial exchange of +authorization data. + </para> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='2.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>▶</entry></row> + <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, + <constant>Busy</constant>, <constant>Denied</constant> }</entry></row> + <row><entry><parameter>server-major-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>server-minor-protocol-version</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>alternate-servers-hint</parameter>:</entry><entry><link linkend="Data_Types:ALTERNATESERVER"><type>LISTofALTERNATESERVER</type></link></entry></row> + <row><entry><parameter>authorization-index</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +The <parameter>SERVER-MAJOR-PROTOCOL-VERSION</parameter> and +<parameter>SERVER-MINOR-PROTOCOL-VERSION</parameter> specify +the version of the font +service protocol that the server expects from the client. If +the server supports the version specified by the client, this +version number should be returned. If the client has +requested a higher version than is supported by the server, +the server's highest version should be returned. Otherwise, +if the client has requested a lower version than is supported +by the server, the server's lowest version should be returned. +It is the client's responsibility to decide whether or not it +can match this version of the protocol. + </para> + <para> +The <parameter>ALTERNATE-SERVERS-HINT</parameter> +is a list of other font servers +that may have related sets of fonts (determined by means +outside this protocol, typically by the system administrator). +Clients may choose to contact these font servers if the +connection is rejected or lost. + </para> + <para> +The <parameter>STATUS</parameter> field indicates whether the server accepted, +rejected, or would like more information about the connection. +It has one of the following alternate values: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='2.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><constant>Success</constant></entry><entry><literal>0</literal></entry></row> + <row><entry><constant>Continue</constant></entry><entry><literal>1</literal></entry></row> + <row><entry><constant>Busy</constant></entry><entry><literal>2</literal></entry></row> + <row><entry><constant>Denied</constant></entry><entry><literal>3</literal></entry></row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> +If <parameter>STATUS</parameter> is <constant>Denied</constant>, +the server has rejected the client's authorization information. +If <parameter>STATUS</parameter> is <constant>Busy</constant>, the server has +simply decided that it cannot provide fonts to this client at +this time (it may be able to at a later time). In both cases, +<parameter>AUTHORIZATION-INDEX</parameter> is set to zero, +no authorization-data is +returned, and the server closes the connection after sending +the data described so far. + </para> + <para> +Otherwise the <parameter>AUTHORIZATION-INDEX</parameter> is set to the index +(beginning with 1) into the <parameter>AUTHORIZATION-PROTOCOLS</parameter> +list of the protocol that the server will use for this connection. If +the server does not want to use any of the given protocols, +this value is set to zero. The <parameter>AUTHORIZATION-DATA</parameter> +field is used to send back authorization protocol-dependent data to the +client (such as a challenge, authentication of the server, +etc.). + </para> +<para> +If <parameter>STATUS</parameter> is <constant>Success</constant>, +the following section of protocol is omitted. Otherwise, if +<parameter>STATUS</parameter> is <constant>Continue</constant>, +the server expects +more authorization data from the client (i.e. the connection +setup is not finished, so no requests or events may be sent): + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>◀</entry></row> + <row><entry><parameter>more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry>▶</entry></row> + <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, <constant>Busy</constant>, <constant>Denied</constant> }</entry></row> + <row><entry><parameter>more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +The values in <parameter>STATUS</parameter> have the same meanings as described +above. This section of protocol is repeated until the server +either accepts (sets <parameter>STATUS</parameter> to +<constant>Success</constant>) or rejects (sets <parameter>STATUS</parameter> +to <constant>Denied</constant> or <constant>Busy</constant>) the connection. +</para> +<para> +Once the connection has been accepted and <parameter>STATUS</parameter> +is <constant>Success</constant>, +an implicit AccessContext is created for the authorization +data and the protocol continues with the following data sent +from the server: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>▶</entry></row> + <row><entry><parameter>remaining-length</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>maximum-request-length</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>release-number</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>vendor</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +The <parameter>REMAINING-LENGTH</parameter> specifies the length in 4-byte +units of the remaining data to be transmitted to the client. The +<parameter>MAXIMUM-REQUEST-LENGTH</parameter> specifies the largest request +size in 4-byte units that is accepted by the server and must have a +value of at least 4096. Requests with a length field larger +than this value are ignored and a +<link linkend="Errors:Length"><errorname>Length</errorname></link> +error is returned. +The <parameter>VENDOR</parameter> string specifies the name of the +manufacturer of the font server. The +<parameter>RELEASE-NUMBER</parameter> specifies the particular +release of the server in a manufacturer-dependent manner. +</para> +</section> +<section><title /> +<para> +After the connection is established and the setup information has been +exchanged, the client may issue any of requests described below: +</para> +</section> +<section id="Requests:NoOp"> + <title><function>NoOp</function></title> + <indexterm zone="Requests:NoOp" significance="preferred"><primary>NoOp</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request does nothing. It is typically used in response +to a +<link linkend="Events:KeepAlive"><function>KeepAlive</function></link> +event. + </para> +</section> + +<section id="Requests:ListExtensions"> + <title><function>ListExtensions</function></title> + <indexterm zone="Requests:ListExtensions" significance="preferred"><primary>ListExtensions</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + + <para> +This request returns the names of the extension packages +that are supported by the server. Extension names are +case-sensitive and are encoded in <acronym>ISO</acronym> 8859-1. + </para> + +</section> + +<section id="Requests:QueryExtension"> + <title><function>QueryExtension</function></title> + <indexterm zone="Requests:QueryExtension" significance="preferred"><primary>QueryExtension</primary></indexterm> + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>name</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry>▶</entry></row> + <row><entry><parameter>present</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>major-version</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>minor-version</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>major-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>first-event</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>number-events</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>first-error</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row rowsep='1'><entry><parameter>number-errors</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request determines whether or not the extension package specified by +<parameter>NAME</parameter> (encoded in <acronym>ISO</acronym> 8859-1) is +supported by the server and that there is sufficient number of major opcode, +event, and error codes available. If so, then <parameter>PRESENT</parameter> +is set to <constant>True</constant>, <parameter>MAJOR-VERSION</parameter> +and <parameter>MINOR-VERSION</parameter> are set to the +respective major and minor version numbers of the protocol +that the server would prefer; <parameter>MAJOR-OPCODE</parameter> is set to +the value to use in extension requests; <parameter>FIRST-EVENT</parameter> +is set to the value of the first extension-specific event code or zero if the +extension does not have any events; <parameter>NUMBER-EVENTS</parameter> is +set to the number of new events that the event defines; +<parameter>FIRST-ERROR</parameter> +is set to the value of the first extension-specific error code +or zero if the extension does not define any new errors; and +<parameter>NUMBER-ERRORS</parameter> is set to the number of +new errors the extension defines. + </para> + <para> +Otherwise, <parameter>PRESENT</parameter> is set to +<constant>False</constant> and the remaining fields are +set to zero. + </para> + <para> +The server is free to return different values to different +clients. Therefore, clients must use this request before +issuing any of the requests in the named extension package or +using the +<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link> request to express interest in any of +this extension's events. Otherwise, a +<link linkend="Errors:Request"><errorname>Request</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:ListCatalogues"> + <title><function>ListCatalogues</function></title> + <indexterm zone="Requests:ListCatalogues" significance="preferred"><primary>ListCatalogues</primary></indexterm> + + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>max-names</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry>▶+</entry></row> + <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns a list of at most <parameter>MAX-NAMES</parameter> names +of collections (called catalogues) of fonts that match +the specified <parameter>PATTERN</parameter>. In the pattern (which is encoded +in <acronym>ISO</acronym> 8859-1), the +<quote><literal>?</literal></quote> character (octal <literal>77</literal>) +matches any single character; the +<quote><literal>*</literal></quote> character (octal <literal>52</literal>) +matches any series of zero or more characters; and alphabetic +characters match either upper- or lowercase. The +returned <parameter>NAMES</parameter> are encoded in +<acronym>ISO</acronym> 8859-1 and may contain +mixed character cases. + </para> + <para> +If <parameter>PATTERN</parameter> is of zero length or +<parameter>MAX-NAMES</parameter> is equal to zero, +one reply containing a zero-length list of names is returned. +This may be used to synchronize the client with the server. + </para> + <para> +Servers are free to add or remove catalogues to the set returned by +<function>ListCatalogues</function> +between any two requests. This request is not +cumulative; repeated uses are processed in isolation and do +result in an iteration through the list. + </para> + <para> +To reduce the amount of buffering needed by the server, the +list of names may be split across several reply packets, so +long as the names arrive in the same order that they would +have appeared had they been in a single packet. The +<parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the last reply +contains a positive value that specifies the number of +replies that are likely, but not required, to follow. In the +last reply, which may contain zero or more names, this field +is set to zero. + </para> +</section> + +<section id="Requests:SetCatalogues"> + <title><function>SetCatalogues</function></title> + <indexterm zone="Requests:SetCatalogues" significance="preferred"><primary>SetCatalogues</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link>, +<link linkend="Errors:Name"><errorname>Name</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request sets the list of catalogues whose fonts should be +visible to the client. The union of the fonts provided by +each of the named catalogues forms the set of fonts whose +names match patterns in +<link linkend="Requests:ListFonts"><function>ListFonts</function></link>, +<link linkend="Requests:ListFontsWithXInfo"><function>ListFontsWithXInfo</function></link>, +and +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +requests. The catalogue names are +case-insensitive and are encoded in <acronym>ISO</acronym> 8859-1. A zero-length +list resets the client's catalogue list to the +server-dependent default. + </para> + <para> +If any of the catalogue names are invalid, a +<link linkend="Errors:Name"><errorname>Name</errorname></link> +error is returned and the request is ignored. + </para> +</section> + +<section id="Requests:GetCatalogues"> + <title><function>GetCatalogues</function></title> + <indexterm zone="Requests:GetCatalogues" significance="preferred"><primary>GetCatalogues</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns the current list of catalogue names +(encoded in <acronym>ISO</acronym> 8859-1) associated with the client. These +catalogues determine the set of fonts that are visible +to +<link linkend="Requests:ListFonts"><function>ListFonts</function></link>, +<link linkend="Requests:ListFontsWithXInfo"><function>ListFontsWithXInfo</function></link>, +and +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>. +A zero-length list indicates the server's default set of +fonts. Catalogue names are case-insensitive and may be +returned in mixed case. + </para> +</section> + +<section id="Requests:SetEventMask"> + <title><function>SetEventMask</function></title> + <indexterm zone="Requests:SetEventMask" significance="preferred"><primary>SetEventMask</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>extension-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row rowsep='1'><entry><parameter>event-mask</parameter>:</entry><entry><link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:EventMask"><errorname>EventMask</errorname></link>, +<link linkend="Errors:Request"><errorname>Request</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request specifies the set of maskable events that the +extension indicated by <parameter>EXTENSION-OPCODE</parameter> +(or zero for the core) +should generate for the client. Event masks are limited in +scope to the extension (or core) for which they are defined, +so expressing interest in events from one or more extensions +requires multiple uses of this request. + </para> + <para> +The default event mask if +<function>SetEventMask</function> +has not been called +is zero, indicating no interest in any maskable events. +Some events are not maskable and cannot be blocked. + </para> + <para> +If <parameter>EXTENSION-OPCODE</parameter> is not a valid extension +opcode previously returned by +<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link> +or zero, a +<link linkend="Errors:Request"><errorname>Request</errorname></link> +error is +returned. If <parameter>EVENT-MASK</parameter> contains any bits that do not +correspond to valid events for the specified extension (or +core), an +<link linkend="Errors:EventMask"><errorname>EventMask</errorname></link> +error is returned and the request is +ignored. + </para> +</section> + +<section id="Requests:GetEventMask"> + <title><function>GetEventMask</function></title> + <indexterm zone="Requests:GetEventMask" significance="preferred"><primary>GetEventMask</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>extension-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>event-mask</parameter>:</entry><entry><link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Request"><errorname>Request</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns the set of maskable core events the +extension indicated by <parameter>EXTENSION-OPCODE</parameter> +(or the core if zero) +should generate for the client. Non-maskable events are +always sent to the client. + </para> + <para> +If <parameter>EXTENSION-OPCODE</parameter> is not a valid extension opcode +previously returned by +<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link> +or zero, a +<link linkend="Errors:Request"><errorname>Request</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:CreateAC"> + <title><function>CreateAC</function></title> + <indexterm zone="Requests:CreateAC" significance="preferred"><primary>CreateAC</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry></row> + <row><entry><parameter>authorization-protocols</parameter>:</entry><entry><link linkend="Data_Types:AUTH"><type>LISTofAUTH</type></link></entry></row> + <row><entry>▶</entry></row> + <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, <constant>Denied</constant> }</entry></row> + <row><entry><parameter>authorization-index</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row rowsep='1'><entry><parameter>authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request creates a new +<type>AccessContext</type> +object within the +server containing the specified authorization data. When +this +<type>AccessContext</type> +is selected by the client using the +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link> +request, the data may be used by the server +to determine whether or not the client should be granted +access to particular font information. + </para> + <para> +If <parameter>STATUS</parameter> is <constant>Denied</constant>, the server +rejects the client's authorization information and does not associate +<parameter>AC</parameter> with any valid <type>AccessContext</type>. +In this case, <parameter>AUTHORIZATION-INDEX</parameter> is set +to zero, and zero bytes of <parameter>AUTHORIZATION-DATA</parameter> +is returned. + </para> + <para> +Otherwise, <parameter>AUTHORIZATION-INDEX</parameter> is set to the index +(beginning with 1) into the <parameter>AUTHORIZATION-PROTOCOLS</parameter> +list of the protocol +that the server will use for this connection. If the server +does not want to use any of the given protocols, this value is +set to zero. The <parameter>AUTHORIZATION-DATA</parameter> field is used +to send back authorization protocol-dependent data to the client (such +as a challenge, authentication of the server, etc.). + </para> + <para> +If <parameter>STATUS</parameter> is <constant>Continue</constant>, +the client is expected to continue +the request by sending the following protocol and receiving +the indicated response from the server. This continues +until <parameter>STATUS</parameter> is set to either +<constant>Success</constant> or <constant>Denied</constant>. + </para> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry> ◀</entry></row> + <row><entry><parameter> more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry> ▶</entry></row> + <row><entry><parameter>status</parameter>:</entry><entry>{ <constant>Success</constant>, <constant>Continue</constant>, <constant>Denied</constant> }</entry></row> + <row><entry><parameter> more-authorization-data</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +Once the connection has been accepted and <parameter>STATUS</parameter> +is <constant>Success</constant>, the request is complete. + </para> + <para> +If <parameter>AC</parameter> is not in the range +[1..2<superscript>29</superscript>-1] or is already associated +with an access context, an <link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link> error is returned. + </para> +</section> + +<section id="Requests:FreeAC"> + <title><function>FreeAC</function></title> + <indexterm zone="Requests:FreeAC" significance="preferred"><primary>FreeAC</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry></row> + <row rowsep='1'><entry>Errors:</entry><entry><link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request indicates that the specified <parameter>AC</parameter> should +no longer be associated with a valid access context. +If <parameter>AC</parameter> is also the current +<type>AccessContext</type> +(as set by the +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link> +request), an implicit +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link> +of <constant>None</constant> is done to +restore the +<type>AccessContext</type> +established for the initial +connection setup. Operations on fonts that were opened under +<parameter>AC</parameter> are not affected. The client may reuse the +value of <parameter>AC</parameter> in a subsequent +<link linkend="Requests:CreateAC"><function>CreateAC</function></link> +request. + </para> + <para> +If <parameter>AC</parameter> isn't associated with any valid authorization +previously created by +<link linkend="Requests:CreateAC"><function>CreateAC</function></link>, an +<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:SetAuthorization"> + <title><function>SetAuthorization</function></title> + <indexterm zone="Requests:SetAuthorization" significance="preferred"><primary>SetAuthorization</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry></row> + <row rowsep='1'><entry>Errors:</entry><entry><link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request sets the +<type>AccessContext</type> +to be used for subsequent +requests (except for +<link linkend="Requests:QueryXInfo"><function>QueryXInfo</function></link>, +<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>, +<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>, +<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>, +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +and +<link linkend="Requests:CloseFont"><function>CloseFont</function></link> +which are done under the +<type>AccessContext</type> +of the +corresponding +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +). +An <parameter>AC</parameter> of <constant>None</constant> restores the +<type>AccessContext</type> +established for the initial connection setup. + </para> + <para> +If <parameter>AC</parameter> is neither <constant>None</constant> +nor a value associated with a valid <type>AccessContext</type> +previously created by +<link linkend="Requests:CreateAC"><function>CreateAC</function></link>, +an +<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:SetResolution"> + <title><function>SetResolution</function></title> + <indexterm zone="Requests:SetResolution" significance="preferred"><primary>SetResolution</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row rowsep='1'><entry><parameter>resolutions</parameter>:</entry><entry><link linkend="Data_Types:RESOLUTION"><type>LISTofRESOLUTION</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Resolution"><errorname>Resolution</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request provides a hint as to the resolution and +preferred point size of the drawing surfaces for which the +client will be requesting fonts. The server may use this +information to set the RESOLUTION_X and RESOLUTION_Y fields +of scalable <acronym>XLFD</acronym> font names, to order sets of names based on +their resolutions, and to choose the server-dependent +instance that is used when a partially-specified scalable +fontname is opened. + </para> + <para> +If a zero-length list of <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link>s is given, the +server-dependent default value is restored. Otherwise, if +elements of all of the specified <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link>s are non-zero, the +default resolutions for this client are changed. + </para> + <para> +If a <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link> entry contains a zero, +a <link linkend="Errors:Resolution"><errorname>Resolution</errorname></link> error is +returned and the default resolutions are not changed. + </para> +</section> + +<section id="Requests:GetResolution"> + <title><function>GetResolution</function></title> + <indexterm zone="Requests:GetResolution" significance="preferred"><primary>GetResolution</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>resolutions</parameter>:</entry><entry><link linkend="Data_Types:RESOLUTION"><type>LISTofRESOLUTION</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns the current list of default resolutions. +If a client has not performed a +<link linkend="Requests:SetResolution"><function>SetResolution</function></link>, +a server-dependent default value is returned. + </para> +</section> + +<section id="Requests:ListFonts"> + <title><function>ListFonts</function></title> + <indexterm zone="Requests:ListFonts" significance="preferred"><primary>ListFonts</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>max-names</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry>▶+</entry></row> + <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row rowsep='1'><entry><parameter>names</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>LISTofSTRING8</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns a list of at most <parameter>MAX-NAMES</parameter> +font names that match the specified <parameter>PATTERN</parameter>, +according to matching rules +of the <olink targetdoc='xlfd' targetptr='xlfd'><citetitle>X Logical +Font Description Conventions</citetitle></olink> +<xref linkend="References:xlfd-spec"/>. +In the pattern (which is encoded in <acronym>ISO</acronym> 8859-1) the +<quote><literal>?</literal></quote> character (octal <literal>77</literal>) +matches any single character; the +<quote><literal>*</literal></quote> character (octal <literal>52</literal>) +matches any series of zero or more characters; and +alphabetic characters match either upper- or lowercase. The +returned <parameter>NAMES</parameter> are encoded in +<acronym>ISO</acronym> 8859-1 and may contain mixed +character cases. Font names are not required to be in <acronym>XLFD</acronym> +format. + </para> + <para> +If <parameter>PATTERN</parameter> is of zero length or +<parameter>MAX-NAMES</parameter> is equal to zero, +one reply containing a zero-length list of names is returned. +This may be used to synchronize the client with the server. + </para> + <para> +Servers are free to add or remove fonts to the set returned by +<function>ListFonts</function> +between any two requests. This request is not +cumulative; repeated uses are processed in isolation and do +result in an iteration through the list. + </para> + <para> +To reduce the amount of buffering needed by the server, the +list of names may be split across several reply packets, so +long as the names arrive in the same order that they would +have appeared had they been in a single packet. The +<parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the last reply +contains a positive value that specifies the number of +replies that are likely, but not required, to follow. In the +last reply, which may contain zero or more names, this field +is set to zero. + </para> +</section> + +<section id="Requests:ListFontsWithXInfo"> + <title><function>ListFontsWithXInfo</function></title> + <indexterm zone="Requests:ListFontsWithXInfo" significance="preferred"><primary>ListFontsWithXInfo</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>max-names</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry>▶+</entry></row> + <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>info</parameter>:</entry><entry><link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link></entry></row> + <row rowsep='1'><entry><parameter>name</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request is similar to +<link linkend="Requests:ListFonts"><function>ListFonts</function></link> +except that a separate +reply containing the name, header, and property data is +generated for each matching font name. Following these +replies, if any, a final reply containing a zero-length +<parameter>NAME</parameter> and no <parameter>INFO</parameter> is sent. + </para> + <para> +The <parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the +last reply contains a positive value that specifies the number of replies +that are likely, but not required, to follow. In the last +reply, this field is set to zero. + </para> + <para> +If <parameter>PATTERN</parameter> is of zero length or if +<parameter>MAX-NAMES</parameter> is equal to zero, only the final reply +containing a zero-length <parameter>NAME</parameter> and no +<parameter>INFO</parameter> is returned. This may be used to synchronize the +client with the server. + </para> +</section> + +<section id="Requests:OpenBitmapFont"> + <title><function>OpenBitmapFont</function></title> + <indexterm zone="Requests:OpenBitmapFont" significance="preferred"><primary>OpenBitmapFont</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry><parameter>pattern</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>format-mask</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMATMASK"><type>BITMAPFORMATMASK</type></link></entry></row> + <row><entry><parameter>format-hint</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry></row> + <row><entry>▶</entry></row> + <row><entry><parameter>otherid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link> or <constant>None</constant></entry></row> + <row><entry><parameter>otherid-valid</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row rowsep='1'><entry><parameter>cachable</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry>Errors:</entry><entry> +<link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link>, +<link linkend="Errors:Name"><errorname>Name</errorname></link>, +<link linkend="Errors:Format"><errorname>Format</errorname></link>, +<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request looks for a server-dependent choice of the +font names that match the specified <parameter>PATTERN</parameter> +according to the rules described for +<link linkend="Requests:ListFonts"><function>ListFonts</function></link>. +If no matches are found, a +<link linkend="Errors:Name"><errorname>Name</errorname></link> +error is returned. Otherwise, the server attempts to +open the font associated with the chosen name. + </para> + <para> +Permission to access the font is determined by the server +according the licensing policy used for this font. The server +may use the client's current +<type>AccessContext</type> +(as set by the most +recent +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link> +request or the original connection +setup) to determine any client-specific sets of permissions. +After the font has been opened, the client is allowed to +specify a new +<type>AccessContext</type> +with +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link> +or release +the +<type>AccessContext</type> +using +<link linkend="Requests:FreeAC"><function>FreeAC</function></link> +. Subsequent +<link linkend="Requests:QueryXInfo"><function>QueryXInfo</function></link>, +<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>, +<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>, +<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>, +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +and +<link linkend="Requests:CloseFont"><function>CloseFont</function></link> +requests on this <link linkend="Data_Types:FONTID"><type>FONTID</type></link> are +performed according to permissions granted at the time of the +<function>OpenBitmapFont</function> +request. + </para> + <para> +If the server is willing and able to detect that the client +has already opened the font successfully (possibly under a +different name), the <parameter>OTHERID</parameter> field +may be set to one of the +identifiers previously used to open the font. The +<parameter>OTHERID-VALID</parameter> field indicates whether or not +<parameter>OTHERID</parameter> is still associated with an open font: +if it is <constant>True</constant>, the client may use +<parameter>OTHERID</parameter> as an alternative to +<parameter>FONTID</parameter>. Otherwise, if +<parameter>OTHERID-VALID</parameter> is <constant>False</constant>, +<parameter>OTHERID</parameter> is no longer +open but has not been reused by a subsequent +<function>OpenBitmapFont</function> +request. + </para> + <para> +If <parameter>OTHERID</parameter> is set to <constant>None</constant>, +then <parameter>OTHERID-VALID</parameter> should be set +to <constant>False</constant>. + </para> + <para> +The <parameter>FORMAT-MASK</parameter> indicates which fields in +<parameter>FORMAT-HINT</parameter> +the client is likely to use in subsequent +<function>GetXBitmaps8</function> +and +<function>GetXBitmaps16</function> +requests. Servers may wish to use +this information to precompute certain values. + </para> + <para> +If <parameter>CACHABLE</parameter> is set to <constant>True</constant>, +the client may cache the font +(so that redundant opens of the same font may be avoided) +and use it with all +<type>AccessContext</type>s +during the life of the +client without violating the font's licensing policy. This +flag is typically set whenever a font is unlicensed or is +licensed on a per-display basis. If <parameter>CACHABLE</parameter> +is <constant>False</constant>, the +client should reopen the font for each +<type>AccessContext</type>. + </para> + <para> +The server is permitted to add to or remove from the set of +fonts returned by +<link linkend="Requests:ListFonts"><function>ListFonts</function></link> +between any two requests, though +mechanisms outside the protocol. Therefore, it is possible +for this request (which is atomic) to return a different font +than would result from separate a +<link linkend="Requests:ListFonts"><function>ListFonts</function></link> +followed by an +<function>OpenBitmapFont</function> +with a non-wildcarded font name. + </para> + <para> +If <parameter>FONTID</parameter> is not in the range +[1..2<superscript>29</superscript>-1] or if it is already +associated with an open font, an +<link linkend="Errors:IDChoice"><errorname>IDChoice</errorname></link> +error is returned. +If no font is available that matches the specified +<parameter>PATTERN</parameter>, a +<link linkend="Errors:Name"><errorname>Name</errorname></link> +error is returned. If the font is present but the client +is not permitted access, an +<link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> +error is returned. +If <parameter>FORMAT-MASK</parameter> has any unspecified bits set or if any +of the fields in <parameter>FORMAT-HINT</parameter> indicated by +<parameter>FORMAT-MASK</parameter> are invalid, a +<link linkend="Errors:Format"><errorname>Format</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:QueryXInfo"> + <title><function>QueryXInfo</function></title> + <indexterm zone="Requests:QueryXInfo" significance="preferred"><primary>QueryXInfo</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>info</parameter>:</entry><entry><link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns the font header and property information +for the open font associated with <parameter>FONTID</parameter>. + </para> + <para> +If <parameter>FONTID</parameter> is not associated with any open fonts, a +<link linkend="Errors:Font"><errorname>Font</errorname></link> +error +is returned. + </para> +</section> + +<section id="Requests:QueryXExtents8"> + <title><function>QueryXExtents8</function></title> + <indexterm zone="Requests:QueryXExtents8" significance="preferred"><primary>QueryXExtents8</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>extents</parameter>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>LISTofXCHARINFO</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, +<link linkend="Errors:Range"><errorname>Range</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request is equivalent to +<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link> +except that it +uses 1-byte character codes. + </para> +</section> + +<section id="Requests:QueryXExtents16"> + <title><function>QueryXExtents16</function></title> + <indexterm zone="Requests:QueryXExtents16" significance="preferred"><primary>QueryXExtents16</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>LISTofCHAR2B</type></link></entry></row> + <row><entry>▶</entry></row> + <row rowsep='1'><entry><parameter>extents</parameter>:</entry><entry><link linkend="Data_Types:XCHARINFO"><type>LISTofXCHARINFO</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, +<link linkend="Errors:Range"><errorname>Range</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns a list of glyph extents from the open +font associated with FONTID for the series of characters +specified by <parameter>RANGE</parameter> and <parameter>CHARS</parameter>. + </para> + <para> +If <parameter>RANGE</parameter> is <constant>True</constant>, +each succeeding pair of elements in <parameter>CHARS</parameter> is +treated as a range of characters for which extents should be +returned. If <parameter>CHARS</parameter> contains an odd number of elements, +the font's <structfield>XFONTINFO.CHAR-RANGE.MAX-CHAR</structfield> +is implicitly appended to +the list. If <parameter>CHARS</parameter> contains no elements, the list is +implicitly replaced with the font's +<structfield>XFONTINFO.CHAR-RANGE.</structfield> If +any of the resulting character ranges are invalid, a +<link linkend="Errors:Range"><errorname>Range</errorname></link> +error is returned. Otherwise, the character ranges are +concatenated in the order given by <parameter>CHARS</parameter> to produce +a set of character codes for which extents are returned. + </para> + <para> +If <parameter>RANGE</parameter> is <constant>False</constant>, +then <parameter>CHARS</parameter> specifies the set of character +codes for which extents are returned. If <parameter>CHARS</parameter> is of +zero length, then a zero-length list of extents is returned. + </para> + <para> +The extents for each character code in the resulting set (which +may contain duplicates) are returned in the order in +which the character codes appear in the set. +At least one metric for each character shall be non-zero +unless the character is not encoded in the font, in which case +all-zero metrics are returned. +A blank, zero-width character can be encoded +with non-zero but equal left and right bearings. + </para> + <para> +If <parameter>FONTID</parameter> is not associated with any open fonts, a +<link linkend="Errors:Font"><errorname>Font</errorname></link> +error is +returned. If <parameter>RANGE</parameter> is <constant>True</constant> +and <parameter>CHARS</parameter> contains any invalid ranges, a +<link linkend="Errors:Range"><errorname>Range</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:QueryXBitmaps8"> + <title><function>QueryXBitmaps8</function></title> + <indexterm zone="Requests:QueryXBitmaps8" significance="preferred"><primary>QueryXBitmaps8</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:STRING8"><type>STRING8</type></link></entry></row> + <row><entry><parameter>format</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry></row> + <row><entry>▶+</entry></row> + <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>offsets</parameter>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>LISTofOFFSET32</type></link></entry></row> + <row><entry><parameter>bitmaps</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row> + <row rowsep='1'><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, +<link linkend="Errors:Range"><errorname>Range</errorname></link>, +<link linkend="Errors:Format"><errorname>Format</errorname></link>, +<link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request is equivalent to +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +except that it +uses 1-byte character codes. + </para> +</section> + +<section id="Requests:QueryXBitmaps16"> + <title><function>QueryXBitmaps16</function></title> + <indexterm zone="Requests:QueryXBitmaps16" significance="preferred"><primary>QueryXBitmaps16</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>chars</parameter>:</entry><entry><link linkend="Data_Types:CHAR2B"><type>LISTofCHAR2B</type></link></entry></row> + <row><entry><parameter>format</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry></row> + <row><entry>▶+</entry></row> + <row><entry><parameter>replies-following-hint</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>offsets</parameter>:</entry><entry><link linkend="Data_Types:OFFSET32"><type>LISTofOFFSET32</type></link></entry></row> + <row rowsep='1'><entry><parameter>bitmaps</parameter>:</entry><entry><link linkend="Data_Types:BYTE"><type>LISTofBYTE</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, + <link linkend="Errors:Range"><errorname>Range</errorname></link>, + <link linkend="Errors:Format"><errorname>Format</errorname></link>, + <link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request returns a list of glyph bitmaps from the open font associated +with <parameter>FONTID</parameter> for the series of characters +specified by <parameter>RANGE</parameter> and <parameter>CHARS</parameter>. + </para> + <para> +If <parameter>RANGE</parameter> is <constant>True</constant>, each succeeding +pair of elements in <parameter>CHARS</parameter> is +treated as a range of characters for which bitmaps should be +returned. If <parameter>CHARS</parameter> contains an odd number of elements, +the font's <structfield>XFONTINFO.CHAR-RANGE.MAX-CHAR</structfield> +is implicitly appended to +the list. If <parameter>CHARS</parameter> contains no elements, the list is +implicitly replaced with the font's +<structfield>XFONTINFO.CHAR-RANGE.</structfield> If +any of the resulting character ranges are invalid, a <link linkend="Errors:Range"><errorname>Range</errorname></link> +error is returned. Otherwise, the character ranges are +concatenated in the order given by <parameter>CHARS</parameter> to produce +a set of character codes for which bitmaps are returned. + </para> + <para> +If <parameter>RANGE</parameter> is <constant>False</constant>, +then <parameter>CHARS</parameter> specifies the set of character +codes for which bitmaps are returned. If <parameter>CHARS</parameter> +is of zero length, then a single reply containing a zero-length list of +offsets and bitmaps is returned. + </para> + <para> +If any of the resulting character ranges are invalid, a +<link linkend="Errors:Range"><errorname>Range</errorname></link> +error is returned. Otherwise, the resulting character ranges +are concatenated in the order given by <parameter>CHARS</parameter> +to produce a set of character codes for which bitmaps are returned. + </para> + <para> +The server is free to return the glyph bitmaps in multiple +replies to reduce the amount of buffering that is necessary. +In this situation, the set of characters obtained above is +partitioned into an implementation-dependent number of +ordered, non-overlapping subsets containing runs of one or +more consecutive characters. The global ordering of +characters must be maintained such that concatenating the +subsets in order that they were produced yields the original +set. A reply is generated for each subset, in the order that +it was produced. + </para> + <para> +For each character in a subset, an image of that character's +glyph is described by a rectangle of bits corresponding to the +pixels specified by FORMAT.IMAGE-RECT. Within the image, set +and clear bits represent inked and non-inked pixels, +respectively. + </para> + <para> +Each scanline of a glyph image, from top to bottom, is zero-padded +on the right to a multiple of the number of bits specified by +FORMAT.SCANLINE-PAD. The scanline is then divided from left +to right into a sequence of FORMAT.SCANLINE-UNIT bits. The +bits of each unit are then arranged such that the left-most +pixel is stored in the most- or least-significant bit, +according to FORMAT.BIT-ORDER-MSB. The bytes of each unit are +then arranged such that the most- or least-significant byte, +according to FORMAT.BYTE-ORDER-MSB, is transmitted first. +Finally, the units are arranged such that the left-most is +transmitted first and the right-most is transmitted last. + </para> + <para> +The individual images within a subset are then concatenated in +a server-dependent order to form the <parameter>BITMAPS</parameter> data +of the reply. If a glyph image is duplicated within a reply, the +server is free to return fewer (but at least one) copies of +the image. If a character is not encoded within the font, a +zero-length bitmap is substituted for this character. Each +glyph image must begin at a bit position that is a multiple of +the FORMAT.SCANLINE-UNIT. + </para> + <para> +The <parameter>OFFSETS</parameter> array in a reply contains one entry +for each character in the subset being returned, in the order that the +characters appear in the subset. Each entry specifies the +starting location in bytes and size in bytes of the +corresponding glyph image in the <parameter>BITMAPS</parameter> data of that +reply (i.e. an offset may not refer to data in another reply). + </para> + <para> +The <parameter>REPLIES-FOLLOWING-HINT</parameter> field in all but the +last reply contains a positive value that specifies the number of replies +that are likely, but not required, to follow. In the last +reply, which may contain data for zero or more characters, +this field is set to zero. + </para> + <para> +If <parameter>FONTID</parameter> is not associated with any open fonts, +a <link linkend="Errors:Font"><errorname>Font</errorname></link> +error is returned. If <parameter>RANGE</parameter> is +<constant>True</constant> and <parameter>CHARS</parameter> contains any +invalid ranges, a +<link linkend="Errors:Range"><errorname>Range</errorname></link> error +is returned. If <parameter>FORMAT</parameter> is invalid, a +<link linkend="Errors:Format"><errorname>Format</errorname></link> error +is returned. + </para> +</section> + +<section id="Requests:CloseFont"> + <title><function>CloseFont</function></title> + <indexterm zone="Requests:CloseFont" significance="preferred"><primary>CloseFont</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row rowsep='1'><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry></row> + <row><entry>Errors:</entry><entry><link linkend="Errors:Font"><errorname>Font</errorname></link>, <link linkend="Errors:Alloc"><errorname>Alloc</errorname></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This request indicates that the specified <parameter>FONTID</parameter> +should no longer be associated with an open font. The server is free to +release any client-specific storage or licenses allocated for +the font. The client may reuse the value of <parameter>FONTID</parameter> +in a subsequent +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +request. + </para> + <para> +If <parameter>FONTID</parameter> is not associated with any open fonts, a +<link linkend="Errors:Font"><errorname>Font</errorname></link> +error is returned. + </para> +</section> + +<section id="Requests:close_connection"> + <title>close connection</title> + <indexterm zone="Requests:close_connection" significance="preferred"><primary>close connection</primary></indexterm> + + <para> +When a connection is closed, a +<link linkend="Requests:CloseFont"><function>CloseFont</function></link> +is done on all fonts +that are open on the connection. In addition, the server is +free to release any storage or licenses allocated on behalf of +the client that made the connection. + </para> +</section> +</section> + +<section id='Errors'> +<title>Errors</title> +<!-- .XS --> +<!-- (SN Errors --> +<!-- .XE --> +<para> +All errors are at least 16 bytes long and contain the following fields: +</para> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>type</parameter>:</entry><entry><type>CARD8</type></entry><entry>value of 1</entry></row> + <row><entry><parameter>error-code</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>sequence-number</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>timestamp</parameter>:</entry><entry><link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link></entry></row> + <row><entry><parameter>major-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>minor-opcode</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry></row> + </tbody> + </tgroup> + </informaltable> +<para> +The TYPE field has a value of one. The ERROR-CODE field specifies which error +occurred. Core errors codes are in the range 0 through 127, extension error +codes are in the range 128 through 255. The SEQUENCE-NUMBER field contains the +least significant 16 bits of the sequence number of the request that caused the +error. The LENGTH field specifies the length of the error packet in 4-byte +units and must have a value of at least 4. The TIMESTAMP specifies the server +time when the error occurred. The MAJOR-OPCODE and MINOR-OPCODE (zero for core +requests) fields specify the type of request that generated the error. The +DATA-OR-UNUSED field may be used for 16 bits of error-specific information. If +LENGTH is greater than four, these fields are followed by (LENGTH - 4) * 4 +bytes of extra data. +</para> +<para> +The following errors are defined for the core protocol: +</para> + +<section id="Errors:Request"> + <title><errorname>Request</errorname></title> + <indexterm zone="Errors:Request" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Request</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by any request that has an unknown +combination of major and minor request numbers, or by any +extension request that is issued before a +<link linkend="Requests:QueryExtension"><function>QueryExtension</function></link> +of that extension. + </para> +</section> + +<section id="Errors:Format"> + <title><errorname>Format</errorname></title> + <indexterm zone="Errors:Format" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Format</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>format</parameter>:</entry><entry><link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link></entry><entry>bad format value</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by the use of an invalid <link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link> +in the +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link>, +<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>, and +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +requests. +The value that caused the error is included as extra data. + </para> +</section> + +<section id="Errors:Font"> + <title><errorname>Font</errorname></title> + <indexterm zone="Errors:Font" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Font</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>fontid</parameter>:</entry><entry><link linkend="Data_Types:FONTID"><type>FONTID</type></link></entry><entry>bad font identifier</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by an invalid <link linkend="Data_Types:FONTID"><type>FONTID</type></link> in the +<link linkend="Requests:QueryXInfo"><function>QueryXInfo</function></link>, +<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>, +<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>, +<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link>, +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +and +<link linkend="Requests:CloseFont"><function>CloseFont</function></link> +requests. The value that caused +the error is included as extra data. + </para> +</section> + +<section id="Errors:Range"> + <title><errorname>Range</errorname></title> + <indexterm zone="Errors:Range" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Range</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>range</parameter>:</entry><entry><link linkend="Data_Types:RANGE"><type>RANGE</type></link></entry><entry>bad range</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by an invalid <link linkend="Data_Types:RANGE"><type>RANGE</type></link> in the +<link linkend="Requests:QueryXExtents8"><function>QueryXExtents8</function></link>, +<link linkend="Requests:QueryXExtents16"><function>QueryXExtents16</function></link>, +<link linkend="Requests:QueryXBitmaps8"><function>QueryXBitmaps8</function></link> +and +<link linkend="Requests:QueryXBitmaps16"><function>QueryXBitmaps16</function></link> +requests. The +value that caused the error is included as extra data. + </para> +</section> + +<section id="Errors:EventMask"> + <title><errorname>EventMask</errorname></title> + <indexterm zone="Errors:EventMask" significance="preferred"><primary>Error Codes</primary><secondary><errorname>EventMask</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>event-mask</parameter>:</entry><entry><link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link></entry><entry>bad event mask</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by an invalid <link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link> in the +<link linkend="Requests:SetEventMask"><function>SetEventMask</function></link> +request. The value that caused the error is +included as extra data. + </para> +</section> + +<section id="Errors:AccessContext"> + <title><errorname>AccessContext</errorname></title> + <indexterm zone="Errors:AccessContext" significance="preferred"><primary>Error Codes</primary><secondary><errorname>AccessContext</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>ac</parameter>:</entry><entry><link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link></entry><entry>unaccepted <type>AccessContext</type></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by an invalid <link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> in the +<link linkend="Requests:FreeAC"><function>FreeAC</function></link> +or +<link linkend="Requests:SetAuthorization"><function>SetAuthorization</function></link> +request or by an +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +request performed without sufficient authorization. In the +first two cases, the <link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> of the errant request is +returned as extra data. In the third case, the current +<link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> is returned as extra data. + </para> +</section> + +<section id="Errors:IDChoice"> + <title><errorname>IDChoice</errorname></title> + <indexterm zone="Errors:IDChoice" significance="preferred"><primary>Error Codes</primary><secondary><errorname>IDChoice</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>id</parameter>:</entry><entry><link linkend="Data_Types:ID"><type>ID</type></link></entry><entry>bad identifier</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by an invalid or already associated +<link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> identifier in a +<link linkend="Requests:CreateAC"><function>CreateAC</function></link> +request or <link linkend="Data_Types:FONTID"><type>FONTID</type></link> identifier +in an +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +request. The value that caused the error +is included as extra data. + </para> +</section> + +<section id="Errors:Name"> + <title><errorname>Name</errorname></title> + <indexterm zone="Errors:Name" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Name</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by a font name pattern that matches +no fonts in an +<link linkend="Requests:OpenBitmapFont"><function>OpenBitmapFont</function></link> +request or no catalogue names in a +<link linkend="Requests:SetCatalogues"><function>SetCatalogues</function></link> +request. + </para> +</section> + +<section id="Errors:Resolution"> + <title><errorname>Resolution</errorname></title> + <indexterm zone="Errors:Resolution" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Resolution</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>X value of errant resolution</entry></row> + <row><entry><parameter>y-resolution</parameter>:</entry><entry><type>CARD16</type></entry><entry>Y value of errant resolution</entry></row> + <row><entry><parameter>point-size</parameter>:</entry><entry><type>CARD16</type></entry><entry>point size of errant resolution</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated in response to an invalid <link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link> +structure in a +<link linkend="Requests:SetResolution"><function>SetResolution</function></link> +request. The value that caused the +error is included in the DATA-OR-UNUSED field and as extra data. + </para> +</section> + +<section id="Errors:Alloc"> + <title><errorname>Alloc</errorname></title> + <indexterm zone="Errors:Length" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Alloc</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by any request for which the server +lacks sufficient resources (especially memory). + </para> +</section> + +<section id="Errors:Length"> + <title><errorname>Length</errorname></title> + <indexterm zone="Errors:Length" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Length</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry><entry>bad length value</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error is generated by any request that has a length field +greater than (MAXIMUM-REQUEST-LENGTH * 4) bytes. The value that +caused the error is included as extra data. + </para> +</section> + +<section id="Errors:Implementation"> + <title><errorname>Implementation</errorname></title> + <indexterm zone="Errors:Implementation" significance="preferred"><primary>Error Codes</primary><secondary><errorname>Implementation</errorname></secondary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>data-or-unused</parameter>:</entry><entry><type>CARD16</type></entry><entry>unused</entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This error may be generated in response to any request that +the server is unable to process because it is deficient. Use +of this error is highly discouraged and indicates lack of +conformance to the protocol. + </para> +</section> +<section id="Errors:Extensions"> + <title>Extensions</title> + <para> +Additional errors may be defined by extensions. + </para> +</section> +</section> + +<section id='Events'> +<title>Events</title> +<!-- .XS --> +<!-- (SN Events --> +<!-- .XE --> +<para> +Events may be generated in response to requests or at the server's discretion +after the initial connection setup information has been exchanged. Each event +is at least 12 bytes long and contains the following fields: + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>type</parameter>:</entry><entry><type>CARD8</type></entry><entry>value of 2</entry></row> + <row><entry><parameter>event-code</parameter>:</entry><entry><type>CARD8</type></entry></row> + <row><entry><parameter>sequence-number</parameter>:</entry><entry><type>CARD16</type></entry></row> + <row><entry><parameter>length</parameter>:</entry><entry><type>CARD32</type></entry></row> + <row><entry><parameter>timestamp</parameter>:</entry><entry><link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> +</para> +<para> +The TYPE field contains the value 2. The EVENT-CODE field specifies the number +of the event and is in the range 0-127 for core events or the range 128-255 for +extensions. The SEQUENCE-NUMBER field specifies the least significant 16 bits +of the sequence number of the last request to have been processed by the +server. The LENGTH field specifies the number of 4-byte units in this event +packet and must always have a value of at least 3. The <link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link> field +specifies the server time when the event occurred. If LENGTH is greater than +three, these fields are followed by (LENGTH - 3) * 4 bytes of additional data. +</para> +<para> +Events are described using the following syntax: + <blockquote><para> + <emphasis role="bold"><function>EventName</function></emphasis> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>arg1</parameter>:</entry><entry><type>type1</type></entry></row> + <row><entry> ...</entry></row> + <row><entry><parameter>argN</parameter>:</entry><entry><type>typeN</type></entry></row> + </tbody> + </tgroup> + </informaltable> + Description + </para></blockquote> +</para> +<para> +If an event does not provide any extra arguments, the +<parameter>arg1</parameter>...<parameter>argN</parameter> +lines are omitted from the description. +</para> +<para> +The core X Font Service protocol defines the following events: +</para> + +<section id="Events:KeepAlive"> + <title><function>KeepAlive</function></title> + <indexterm zone="Events:KeepAlive" significance="preferred"><primary>KeepAlive</primary></indexterm> + <para> +This unsolicited, nonmaskable event may be sent by the +server to verify that the connection has not been broken +(for transports that do not provide this information). +Clients should acknowledge receipt of this request +by sending any request (such as +<link linkend="Requests:NoOp"><function>NoOp</function></link> +). + </para> +</section> + +<section id="Events:CatalogueListNotify"> + <title><function>CatalogueListNotify</function></title> + <indexterm zone="Events:CatalogueListNotify" significance="preferred"><primary>CatalogueListNotify</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>added</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>deleted</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This event is sent to clients that have included +<function><constant>CatalogueListChangeMask</constant></function> +in their core event mask +whenever the list of catalogues that are available has +changed. The ADDED field is <constant>True</constant> if new catalogues have +been added to the server, otherwise it is <constant>False</constant>. The +DELETED field is <constant>True</constant> if any existing catalogues have +been removed from the server, otherwise it is <constant>False</constant>. + </para> +</section> + +<section id="Events:FontListNotify"> + <title><function>FontListNotify</function></title> + <indexterm zone="Events:FontListNotify" significance="preferred"><primary>FontListNotify</primary></indexterm> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <tbody> + <row><entry><parameter>added</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + <row><entry><parameter>deleted</parameter>:</entry><entry><link linkend="Data_Types:BOOL"><type>BOOL</type></link></entry></row> + </tbody> + </tgroup> + </informaltable> + <para> +This event is sent to clients that have included +<function><constant>FontListChangeMask</constant></function> +in their event mask whenever the +list of fonts that are provided by the currently selected +catalogues has changed. The ADDED field is <constant>True</constant> if new +fonts have been added to any of the catalogues currently +used by the client, otherwise it is <constant>False</constant>. The DELETED +field is <constant>True</constant> if any existing fonts have been removed +from any of catalogues used by the client, otherwise it +is <constant>False</constant>. + </para> +</section> +<section id="Events:Extensions"> + <title>Extensions</title> + <para> +Additional events may be defined by extensions. + </para> +</section> +</section> +</chapter> + +<chapter id='Protocol_Encoding'> +<title>Protocol Encoding</title> +<!-- .XS --> +<!-- (SN Protocol Encoding --> +<!-- .XE --> +<para> +Numbers that are prefixed with <quote><literal>#x</literal></quote> +are in hexadecimal (base 16). All other +numbers are in decimal. Requests, replies, errors, events, and compound types +are described using the syntax: +</para> +<!-- .RS --> +<literallayout class="monospaced"> + + Name + <emphasis remap='I'>count</emphasis> <emphasis remap='I'>contents</emphasis> <emphasis remap='I'>name</emphasis> + ... + <emphasis remap='I'>count</emphasis> <emphasis remap='I'>contents</emphasis> <emphasis remap='I'>name</emphasis> +</literallayout> + +<!-- .RE --> +<para> +where COUNT is the number of bytes in the data stream occupied by this +field, CONTENTS is the name of the type as given in +<link linkend='Data_Types'>Section 4</link> or the value if +this field contains a constant, and NAME is a description of this field. +</para> +<para> +Objects containing counted lists use a lowercase single-letter variable (whose +scope is limited to the request, reply, event, or error in which it is found) +to represent the number of objects in the list. These variables, and any +expressions in which they are used, should be treated as unsigned integers. +Multiple copies of an object are indicated by CONTENTS prefix +<quote>LISTof</quote>. +</para> +<para> +Unused bytes (whose value is undefined) will have a blank CONTENTS field and a +NAME field of <quote>unused</quote>. Zeroed bytes (whose value must be zero) +will have a blank CONTENTS field and a NAME field of <quote>zero</quote>. +The expression pad(e) refers to the number of bytes +needed to round a value <quote>e</quote> up to the closed +multiple of four: +</para> +<!-- .RS --> +<literallayout class="monospaced"> + + pad(e) = (4 - (e mod 4)) mod 4 +</literallayout> + +<section id='Encoding::Data_Types'> +<title>Data Types</title> +<!-- .XS --> +<!-- (SN Data Types --> +<!-- .XE --> +<literallayout class="monospaced"> +<link linkend="Data_Types:ACCESSCONTEXT"><type>ACCESSCONTEXT</type></link> +4 <type>CARD32</type> access context + + with at least one of the following bits set: + + #x1fffffff + + but none of the following bits set: + + #xe0000000 zero + + +<link linkend="Data_Types:ALTERNATESERVER"><type>ALTERNATESERVER</type></link> +1 <type>BOOL</type> subset +1 n length of name +n <type>STRING8</type> name +p unused, p=pad(n+2) + +<link linkend="Data_Types:AUTH"><type>AUTH</type></link> +2 n length of name +2 d length of data +n <type>STRING8</type> name +p unused, p=pad(n) +d <type>STRING8</type> data +q unused, q=pad(d) + + +<link linkend="Data_Types:BITMAPFORMAT"><type>BITMAPFORMAT</type></link> +4 <type>CARD32</type> value, union of the following bits: + + #x00000001 ByteOrderMSB + #x00000002 BitOrderMSB + #x00000000 <constant>ImageRectMin</constant> + #x00000004 <constant>ImageRectMaxWidth</constant> + #x00000008 <constant>ImageRectMax</constant> + #x00000000 <constant>ScanlinePad8</constant> + #x00000100 <constant>ScanlinePad16</constant> + #x00000200 <constant>ScanlinePad32</constant> + #x00000300 <constant>ScanlinePad64</constant> + #x00000000 <constant>ScanlineUnit8</constant> + #x00001000 <constant>ScanlineUnit16</constant> + #x00002000 <constant>ScanlineUnit32</constant> + #x00003000 <constant>ScanlineUnit64</constant> + + except for the following bits which must be zero: + + #xffffccf0 zero + + and the following of which at most one bit may be set: + + #x0000000c at most one bit can be set + + +<link linkend="Data_Types:BITMAPFORMATMASK"><type>BITMAPFORMATMASK</type></link> +4 <type>CARD32</type> value, mask of the following bits: + + #x00000001 <constant>ByteOrderMask</constant> + #x00000002 <constant>BitOrderMask</constant> + #x00000004 <constant>ImageRectMask</constant> + #x00000008 <constant>ScanlinePadMask</constant> + #x00000010 <constant>ScanlineUnitMask</constant> + + except for the following bits which must be zero: + + #xffffffe0 zero + +<link linkend="Data_Types:BOOL"><type>BOOL</type></link> +1 <type>BOOL</type> boolean, one of the following values: + 0 <constant>False</constant> + 1 <constant>True</constant> + +<link linkend="Data_Types:BYTE"><type>BYTE</type></link> +1 <type>BYTE</type> unsigned byte of data + +<type>CARD8</type> +1 <type>CARD8</type> 8-bit unsigned integer + +<type>CARD16</type> +2 <type>CARD16</type> 16-bit unsigned integer + +<type>CARD32</type> +4 <type>CARD32</type> 32-bit unsigned integer + +<link linkend="Data_Types:CHAR2B"><type>CHAR2B</type></link> +1 <type>CARD8</type> byte1 +1 <type>CARD8</type> byte2 + +<link linkend="Data_Types:EVENTMASK"><type>EVENTMASK</type></link> +4 <type>CARD32</type> event mask + + for core events, this is union of the following bits: + + #00000001 <constant>CatalogueListChangeMask</constant> + #00000002 <constant>FontListChangeMask</constant> + + but none of the following bits set: + + #fffffffc + + extensions define their own sets of bits + +<link linkend="Data_Types:FONTID"><type>FONTID</type></link> +4 <type>CARD32</type> font identifier + + with at least one of the following bits set: + + #x1fffffff + + but none of the following bits set: + + #xe0000000 zero + +<type>INT8</type> +1 <type>INT8</type> 8-bit signed integer + +<type>INT16</type> +2 <type>INT16</type> 16-bit signed integer + +<type>INT32</type> +4 <type>INT32</type> 32-bit signed integer + +<link linkend="Data_Types:OFFSET32"><type>OFFSET32</type></link> +4 <type>CARD32</type> position (or integer value) +4 <type>CARD32</type> length + +<link linkend="Data_Types:PROPINFO"><type>PROPINFO</type></link> +4 n number of <type>PROPOFFSET</type> components +4 m number of bytes of property data +20*n <type>PROPOFFSET</type> property offsets into data block +m <type>LISTofBYTE</type> property data block + +<link linkend="Data_Types:PROPOFFSET"><type>PROPOFFSET</type></link> +8 <type>OFFSET32</type> name in data block +8 <type>OFFSET32</type> value in data block +1 <type>CARD8</type> type, one of the following values: + 0 <constant>String</constant> + 1 <constant>Unsigned</constant> + 2 <constant>Signed</constant> + 3 zero + +<link linkend="Data_Types:RANGE"><type>RANGE</type></link> +2 <type>CHAR2B</type> minimum character code +2 <type>CHAR2B</type> maximum character code + +<link linkend="Data_Types:RESOLUTION"><type>RESOLUTION</type></link> +2 <type>CARD16</type> x resolution in pixels per inch +2 <type>CARD16</type> y resolution in pixels per inch +2 <type>CARD16</type> point size in decipoints + +STRNAME +1 n length of name +n <type>STRING8</type> name + +<link linkend="Data_Types:STRING8"><type>STRING8</type></link> +n <type>LISTofBYTE</type> array of 8-bit character values + +<link linkend="Data_Types:TIMESTAMP"><type>TIMESTAMP</type></link> +4 <type>CARD32</type> milliseconds since server time origin + +<link linkend="Data_Types:XCHARINFO"><type>XCHARINFO</type></link> +2 <type>INT16</type> left bearing +2 <type>INT16</type> right bearing +2 <type>INT16</type> width +2 <type>INT16</type> ascent +2 <type>INT16</type> descent +2 <type>CARD16</type> attributes + +<link linkend="Data_Types:XFONTINFO"><type>XFONTINFO</type></link> +4 <type>CARD32</type> flags, union of the following bits: + + #x00000001 <constant>AllCharactersExist</constant> + #x00000002 <constant>InkInside</constant> + #x00000004 <constant>HorizontalOverlap</constant> + + but none of the following bits set: + + #xfffffff8 zero + +4 <type>RANGE</type> range of characters in font +1 <type>CARD8</type> drawing direction + 0 <constant>LeftToRight</constant> + 1 <constant>RightToLeft</constant> +1 unused +2 <type>CHAR2B</type> default character +12 <type>XCHARINFO</type> minimum bounds +12 <type>XCHARINFO</type> maximum bounds +2 <type>INT16</type> font ascent +2 <type>INT16</type> font descent +n <type>PROPINFO</type> property data +</literallayout> +</section> + +<section id='Encoding::Requests'> +<title>Requests</title> +<para><link linkend="Requests:open_connection"><emphasis role="bold">open connection</emphasis></link></para> +<literallayout class="monospaced"> +1 <type>BYTE</type> byteorder, one of the values: + #x42 MostSignificant Byte first + #x6c LeastSignificant Byte first +1 <type>CARD8</type> numberof auth in auth-data +2 2 client-major-protocol-version +2 0 client-minor-protocol-version +2 a/4 lengthof auth-data +a <type>LISTofAUTH</type> auth-data +▶ +2 <type>CARD16</type> status + 0 <constant>Success</constant> + 1 <constant>Continue</constant> + 2 <constant>Busy</constant> + 3 <constant>Denied</constant> +2 2 major version +2 0 version +1 <type>CARD8</type> numberof alternate-servers-hint +1 <type>CARD8</type> authorization-index +2 a/4 lengthof alternate-servers-hint +2 (d+q)/4 lengthof authorization-data +a <type>LISTofALTERNATESERVER</type> alternate-servers-hint +d <type>LISTofBYTE</type> authorization-data +q unused, q=pad(d) +</literallayout> + +<para> +If STATUS is <constant>Busy</constant> or <constant>Denied</constant>, the protocol stops and the connection is +closed. If STATUS is <constant>Continue</constant>, the client is expected to respond with +additional data, to which the server responds with +a new status value and more data. This dialog continues until the status +is set to <constant>Success</constant>, or until the server sets STATUS to <constant>Busy</constant> or <constant>Denied</constant> +and closes the connection: +</para> + +<literallayout class="monospaced"> +◀ +4 1+(d+q)/4 length +d <type>LISTofBYTE</type> more-authorization-data +q unused, q=pad(d) +▶ +4 2+(d+q)/4 length +2 <type>CARD16</type> status + 0 <constant>Success</constant> + 1 <constant>Continue</constant> + 2 <constant>Busy</constant> + 3 <constant>Denied</constant> +2 unused +d <type>LISTofBYTE</type> more-authorization-data +q unused, q=pad(d) +</literallayout> +<para> +When STATUS is <constant>Success</constant>, the protocol resumes with the following +sent by the server: +</para> + +<literallayout class="monospaced"> +4 3+(v+w)/4 length of rest of data +2 <type>CARD16</type> maximum-request-length +2 v length of vendor string +4 <type>CARD32</type> release-number +v <type>STRING8</type> vendor-string +w unused, w=pad(v) +</literallayout> +<para> +Once the connection has been established, the client may send the +following requests: +</para> + +<literallayout class="monospaced"> +<link linkend="Requests:NoOp"><emphasis role="bold"><function>NoOp</function></emphasis></link> +1 0 major-opcode +1 unused +2 1 length + +<link linkend="Requests:ListExtensions"><emphasis role="bold"><function>ListExtensions</function></emphasis></link> +1 1 major-opcode +1 unused +2 1 length +▶ +1 0 type reply +1 <type>CARD8</type> numberof names +2 <type>CARD16</type> sequence-number +4 2+(n+p)/4 length +n LISTofSTRNAME names +p unused, p=pad(n) + +<link linkend="Requests:QueryExtension"><emphasis role="bold"><function>QueryExtension</function></emphasis></link> +1 2 major-opcode +1 n length of name +2 1+(n+p)/4 length +n <type>STRING8</type> name +p unused, p=pad(n) +▶ +1 0 type reply +1 <type>BOOL</type> present +2 <type>CARD16</type> sequence-number +4 5 length +2 <type>CARD16</type> major-version +2 <type>CARD16</type> minor-version +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> first-event +1 <type>CARD8</type> number-events +1 <type>CARD8</type> first-error +1 <type>CARD8</type> number-errors +3 unused + +<link linkend="Requests:ListCatalogues"><emphasis role="bold"><function>ListCatalogues</function></emphasis></link> +1 3 major-opcode +1 unused +2 3+(n+p)/4 length +4 <type>CARD32</type> max-names +2 n length of pattern +2 unused +n <type>STRING8</type> pattern +p unused, p=pad(n) +▶+ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 4+(n+p)/4 length +4 <type>CARD32</type> replies-following-hint +4 <type>CARD32</type> numberof catalogue-names +n LISTofSTRNAME catalogue-names +p unused, p=pad(n) + +<link linkend="Requests:SetCatalogues"><emphasis role="bold"><function>SetCatalogues</function></emphasis></link> +1 4 major-opcode +1 <type>CARD8</type> numberof catalogue-names +2 1+(n+p)/4 length +n LISTofSTRNAME catalogue-names +p unused, p=pad(n) + +<link linkend="Requests:GetCatalogues"><emphasis role="bold"><function>GetCatalogues</function></emphasis></link> +1 5 major-opcode +1 unused +2 1 length +▶ +1 0 type reply +1 <type>CARD8</type> numberof catalogue-names +2 <type>CARD16</type> sequence-number +4 2+(n+p)/4 length +n LISTofSTRNAME catalogue-names +p unused, p=pad(n) + +<link linkend="Requests:SetEventMask"><emphasis role="bold"><function>SetEventMask</function></emphasis></link> +1 6 major-opcode +1 <type>CARD8</type> extension-opcode +2 2 length +4 <type>EVENTMASK</type> event-mask + +<link linkend="Requests:GetEventMask"><emphasis role="bold"><function>GetEventMask</function></emphasis></link> +1 7 major-opcode +1 <type>CARD8</type> extension-opcode +2 1 length +▶ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 3 length +4 <type>EVENTMASK</type> event-mask + +<link linkend="Requests:CreateAC"><emphasis role="bold"><function>CreateAC</function></emphasis></link> +1 8 major-opcode +1 <type>CARD8</type> numberof authorization-protocols +2 2+a/4 length +4 <type>ACCESSCONTEXT</type> ac +a <type>LISTofAUTH</type> authorization-protocols +▶ +1 0 type reply +1 <type>CARD8</type> authorization-index +2 <type>CARD16</type> sequence-number +4 3+(d+q)/4 length +2 <type>CARD16</type> status + 0 <constant>Success</constant> + 1 <constant>Continue</constant> + 2 <constant>Busy</constant> + 3 <constant>Denied</constant> +2 unused +d <type>LISTofBYTE</type> authorization-data +q unused, q=pad(d) +</literallayout> + +<para> +If STATUS is <constant>Continue</constant>, the client is expected to respond with additional +data, to which the server +responds with a new status value and more data. This dialog continues +until the status is set to +<constant>Success</constant>, <constant>Busy</constant>, or <constant>Denied</constant> at which point the request is finished. +</para> + +<literallayout class="monospaced"> +◀ +4 1+(d+q)/4 length +d <type>LISTofBYTE</type> more-authorization-data +q unused, q=pad(d) +▶ +4 2+(d+q)/4 length +2 <type>CARD16</type> status + 0 <constant>Success</constant> + 1 <constant>Continue</constant> + 2 <constant>Busy</constant> + 3 <constant>Denied</constant> +2 unused +d <type>LISTofBYTE</type> authorization-data +q unused, q=pad(d) + +<link linkend="Requests:FreeAC"><emphasis role="bold"><function>FreeAC</function></emphasis></link> +1 9 major-opcode +1 unused +2 2 length +4 <type>ACCESSCONTEXT</type> ac + +<link linkend="Requests:SetAuthorization"><emphasis role="bold"><function>SetAuthorization</function></emphasis></link> +1 10 major-opcode +1 unused +2 2 length +4 <type>ACCESSCONTEXT</type> ac + +<link linkend="Requests:SetResolution"><emphasis role="bold"><function>SetResolution</function></emphasis></link> +1 11 major-opcode +1 n number of resolutions +2 1+(6*n+p)/4 length +6*n <type>LISTofRESOLUTION</type> resolutions +p p=pad(6*n) + +<link linkend="Requests:GetResolution"><emphasis role="bold"><function>GetResolution</function></emphasis></link> +1 12 major-opcode +1 unused +2 1 length +▶ +1 0 type reply +1 n number of resolutions +2 <type>CARD16</type> sequence-number +4 2+(6*n+p)/4 length +6*n <type>LISTofRESOLUTION</type> resolutions +p p=pad(6*n) + +<link linkend="Requests:ListFonts"><emphasis role="bold"><function>ListFonts</function></emphasis></link> +1 13 major-opcode +1 unused +2 3+(n+p)/4 length +4 <type>CARD32</type> max-names +2 n length of pattern +2 unused +n <type>STRING8</type> pattern +p unused, p=pad(n) +▶+ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 4+(n+p)/4 length +4 <type>CARD32</type> replies-following-hint +4 <type>CARD32</type> numberof font-names +n LISTofSTRNAME font-names +p unused, p=pad(n) + +<link linkend="Requests:ListFontsWithXInfo"><emphasis role="bold"><function>ListFontsWithXInfo</function></emphasis></link> +1 14 major-opcode +1 unused +2 3+(n+p)/4 length +4 <type>CARD32</type> max-names +2 n length of pattern +2 unused +n <type>STRING8</type> pattern +p unused, p=pad(n) +▶+ (except for last in series) +1 0 type reply +1 n length of name +2 <type>CARD16</type> sequence-number +4 3+(n+p+f)/4 length +4 <type>CARD32</type> replies-hint +f <type>XFONTINFO</type> fontinfo +n <type>STRING8</type> name +p unused, p=pad(n) +▶ (last in series) +1 0 type reply +1 0 last-reply indicator +2 <type>CARD16</type> sequence-number +4 2 reply length + +<link linkend="Requests:OpenBitmapFont"><emphasis role="bold"><function>OpenBitmapFont</function></emphasis></link> +1 15 major-opcode +1 unused +2 4+(n+p)/4 length +4 <type>FONTID</type> fontid +4 <type>BITMAPFORMATMASK</type> format-mask +4 <type>BITMAPFORMAT</type> format +n STRNAME pattern +p unused, p=pad(n) +▶ +1 0 type reply +1 <type>BOOL</type> otherid-valid +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>FONTID</type> otherid +1 <type>BOOL</type> cachable +3 unused + +<link linkend="Requests:QueryXInfo"><emphasis role="bold"><function>QueryXInfo</function></emphasis></link> +1 16 major-opcode +1 unused +2 2 length +4 <type>FONTID</type> fontid +▶ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 2+f/4 length +f <type>XFONTINFO</type> fontinfo +p unused, p=pad(f) + +<link linkend="Requests:QueryXExtents8"><emphasis role="bold"><function>QueryXExtents8</function></emphasis></link> +1 17 major-opcode +1 <type>BOOL</type> range +2 3+(n+p)/4 length +4 <type>FONTID</type> fontid +4 n number chars entries +n <type>STRING8</type> chars +p unused, p=pad(n) +▶ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 3+3*n length +4 n number of extents +12*n <type>LISTofXCHARINFO</type> extents + +<link linkend="Requests:QueryXExtents16"><emphasis role="bold"><function>QueryXExtents16</function></emphasis></link> +1 18 major-opcode +1 <type>BOOL</type> range +2 3+(2*n+p)/4 length +4 <type>FONTID</type> fontid +4 n number chars entries +2*n <type>LISTofCHAR2B</type> chars +p unused, p=pad(2*n) +▶ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 3+3*n length +4 n number of extents +12*n <type>LISTofXCHARINFO</type> extents + +<link linkend="Requests:QueryXBitmaps8"><emphasis role="bold"><function>QueryXBitmaps8</function></emphasis></link> +1 19 major-opcode +1 <type>BOOL</type> range +2 4+(n+p)/4 length +4 <type>FONTID</type> fontid +4 <type>BITMAPFORMAT</type> format +4 n number of chars entries +n <type>STRING8</type> chars +p unused, p=pad(n) +▶+ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 5+2*n+(m+p)/4 length +4 <type>CARD32</type> replies-following-hint +4 n number of offsets +4 m number of bytes of glyph images +8*n <type>LISTofOFFSET32</type> offsets +m <type>LISTofBYTE</type> glyphimages +p unused, p=pad(m) + +<link linkend="Requests:QueryXBitmaps16"><emphasis role="bold"><function>QueryXBitmaps16</function></emphasis></link> +1 20 major-opcode +1 <type>BOOL</type> range +2 4+(2*n+p)/4 length +4 <type>FONTID</type> fontid +4 <type>BITMAPFORMAT</type> format +4 n number of chars entries +2*n <type>LISTofCHAR2B</type> chars +p unused, p=pad(2*n) +▶ +1 0 type reply +1 unused +2 <type>CARD16</type> sequence-number +4 5+2*n+(m+p)/4 length +4 <type>CARD32</type> replies-following-hint +4 n number of offsets +4 m number of bytes of glyph images +8*n <type>LISTofOFFSET32</type> offsets +m <type>LISTofBYTE</type> glyphimages +p unused, p=pad(m) + +<link linkend="Requests:CloseFont"><emphasis role="bold"><function>CloseFont</function></emphasis></link> +1 21 major-opcode +1 unused +2 2 length +4 <type>FONTID</type> fontid +</literallayout> +</section> + +<section id='Encoding::Errors'> +<title>Errors</title> +<literallayout class="monospaced"> + +<link linkend="Errors:Request"><emphasis role="bold"><errorname>Request</errorname></emphasis></link> +1 1 type error +1 0 <errorname>Request</errorname> +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused + +<link linkend="Errors:Format"><emphasis role="bold"><errorname>Format</errorname></emphasis></link> +1 1 type error +1 1 <errorname>Format</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>BITMAPFORMAT</type> bad-format + +<link linkend="Errors:Font"><emphasis role="bold"><errorname>Font</errorname></emphasis></link> +1 1 type error +1 2 <errorname>Font</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>FONTID</type> bad-fontid + +<link linkend="Errors:Range"><emphasis role="bold"><errorname>Range</errorname></emphasis></link> +1 1 type error +1 3 <errorname>Range</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>RANGE</type> bad-range + +<link linkend="Errors:EventMask"><emphasis role="bold"><errorname>EventMask</errorname></emphasis></link> +1 1 type error +1 4 <errorname>EventMask</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>EVENTMASK</type> event-mask + +<link linkend="Errors:AccessContext"><emphasis role="bold"><errorname>AccessContext</errorname></emphasis></link> +1 1 type error +1 5 <errorname>AccessContext</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>ACCESSCONTEXT</type> access context + +<link linkend="Errors:IDChoice"><emphasis role="bold"><errorname>IDChoice</errorname></emphasis></link> +1 1 type error +1 6 <errorname>IDChoice</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>FONTID</type> bad-fontid + +<link linkend="Errors:Name"><emphasis role="bold"><errorname>Name</errorname></emphasis></link> +1 1 type error +1 7 <errorname>Name</errorname> +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused + +<link linkend="Errors:Resolution"><emphasis role="bold"><errorname>Resolution</errorname></emphasis></link> +1 1 type error +1 8 <errorname>Resolution</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +6 <type>RESOLUTION</type> resolution + +<link linkend="Errors:Alloc"><emphasis role="bold"><errorname>Alloc</errorname></emphasis></link> +1 1 type error +1 9 <errorname>Alloc</errorname> +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused + +<link linkend="Errors:Length"><emphasis role="bold"><errorname>Length</errorname></emphasis></link> +1 1 type error +1 10 <errorname>Length</errorname> +2 <type>CARD16</type> sequence-number +4 5 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused +4 <type>CARD32</type> bad-length + +<link linkend="Errors:Implementation"><emphasis role="bold"><errorname>Implementation</errorname></emphasis></link> +1 1 type error +1 11 <errorname>Implementation</errorname> +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>TIMESTAMP</type> timestamp +1 <type>CARD8</type> major-opcode +1 <type>CARD8</type> minor-opcode +2 unused + +</literallayout> +</section> + +<section id='Encoding::Events'> +<title>Events</title> +<literallayout class="monospaced"> +<link linkend="Events:KeepAlive"><emphasis role="bold"><function>KeepAlive</function></emphasis></link> +1 2 type event +1 0 event KeepAlive +2 <type>CARD16</type> sequence-number +4 3 length +4 <type>TIMESTAMP</type> timestamp + +<link linkend="Events:CatalogueListNotify"><emphasis role="bold"><function>CatalogueListNotify</function></emphasis></link> +1 2 type event +1 1 event CatalogueListNotify +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>TIMESTAMP</type> timestamp +1 <type>BOOL</type> added +1 <type>BOOL</type> deleted +2 unused + +<link linkend="Events:FontListNotify"><emphasis role="bold"><function>FontListNotify</function></emphasis></link> +1 2 type event +1 2 event FontListNotify +2 <type>CARD16</type> sequence-number +4 4 length +4 <type>TIMESTAMP</type> timestamp +1 <type>BOOL</type> added +1 <type>BOOL</type> deleted +2 unused + +</literallayout> +</section> +</chapter> + +<chapter id='Acknowledgements'> +<title>Acknowledgements</title> +<!-- .XS --> +<!-- (SN Acknowledgements --> +<!-- .XE --> +<para> +This document represents the culmination of several years of debate and +experiments done under the auspices of the +<orgname class="consortium">MIT X Consortium</orgname> font working group. +Although this was a group effort, the author remains responsible for any errors +or omissions. The protocol presented here was primarily designed by +<personname><firstname>Jim</firstname><surname>Fulton</surname></personname>, +<personname><firstname>Keith</firstname><surname>Packard</surname></personname>, +and +<personname><firstname>Bob</firstname><surname>Scheifler</surname></personname>. +Special thanks goes to +<personname><firstname>Ned</firstname><surname>Batchelder</surname></personname>, +<personname><firstname>Jim</firstname><surname>Flowers</surname></personname>, +and +<personname><firstname>Axel</firstname><surname>Deininger</surname></personname> +for their invigorating comments +which never failed to make this a better document. +<personname><firstname>Stephen</firstname><surname>Gildea</surname></personname> +edited version 2 of this document. Finally, +<personname><firstname>David</firstname><surname>Lemke</surname></personname> +deserves great credit for designing and coding the sample implementation. +</para> +</chapter> + +<bibliography id='References'> +<title>References</title> +<para> +All of the following documents are X Consortium standards available from +the X Consortium. +</para> +<biblioentry id='References:x11proto'> + <abbrev>1</abbrev> + <title><olink targetdoc='x11protocol' targetptr='x11protocol'>X Window System Protocol Version 11</olink></title> + <author><firstname>Robert W.</firstname><surname>Scheifler</surname></author> +</biblioentry> + +<biblioentry id='References:bdf-spec'> + <abbrev>2</abbrev> + <corpauthor>Adobe Systems</corpauthor> + <title>Bitmap Distribution Format 2.1</title> +</biblioentry> + +<biblioentry id='References:xlfd-spec'> + <abbrev>3</abbrev> + <corpauthor>X Consortium</corpauthor> + <title><olink targetdoc='xlfd' targetptr='xlfd'>X Logical Font + Description Conventions, Version 1.5</olink></title> +</biblioentry> + +</bibliography> + +<appendix id="suggested_licensing_policies"> +<title>Suggested Licensing Policies</title> +<para> +The authorization data passed by the client in the initial connection +setup information may be used by the font server to implement restrictions +on which fonts may be accessed. Furthermore, the font server is free to +refuse new connections at any time. +</para> +<para> +Configuration or management of the license restrictions is outside the scope of +the font service protocol and is done in a server-dependent manner. Possible +policies might include, but are not limited to, combinations of the following: + +<variablelist> + <?dbhtml list-presentation="list"?> + <varlistentry> + <term>No restrictions</term> + <listitem> + <para> +anyone may access any fonts. The server neither refuses any connections +nor generates <link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> errors on any +fonts. For environments without specially-licensed fonts, this is +sufficient. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Per-machine</term> + <listitem> + <para> +only those clients connecting from a known set of +machines are permitted access. The server could get the address +of the connection and look in a list of allowed machines. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Per-user</term> + <listitem> + <para> +only a known set of users may access the fonts. The +server can use the authorization data (such as a Kerberos ticket +or a Secure RPC credential) to verify the identity of the user +and then look in a list of allowed users. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Simultaneous Use</term> + <listitem> + <para> +only a certain number of clients may use a given font at any one time. +Additional clients would receive <link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> +errors if they attempt to open the font. This is only effective if +the initial clients keep the font open for the entire time that it +is being used (even if all of the data has been transmitted and is +being cached). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Postage Meter</term> + <listitem> + <para> +a particular font may only be accessed a limited +number of times before its license must be renewed. Each time +the font is opened, the server decrements a counter. When the +counter reaches zero, all further attempts to open the font +return an <link linkend="Errors:AccessContext"><errorname>AccessContext</errorname></link> error. + </para> + </listitem> + </varlistentry> +</variablelist> +</para> + +<para> +It should be noted that chaining of font servers (obtaining font data from +other font servers) may conflict with certain license policies. +</para> +</appendix> + +<appendix id="implementation_suggestions"> +<title>Implementation Suggestions</title> +<para> +Font server implementations will probably wish to use techniques such as the +following to avoid limits on the number of simultaneous connections: +</para> +<itemizedlist> + <listitem> + <para> +The initial connection information returned by the font +server contains the names of other font servers that +may be used as substitutes. A font server may refuse to +accept a connection, indicating that the client should +try one of the alternatives instead. + </para> + </listitem> + <listitem> + <para> +On operating systems that support processing forking, font +servers might choose to fork so that the child can continue +processing the existing connections and the parent can accept +new connections. Such implementations are encouraged to use +shared memory so that in-memory font databases can be shared. + </para> + </listitem> + <listitem> + <para> +On operating systems that support passing stream file descriptors +between processes, cooperating font servers could collect +connections in a single process when there are few connections +and spread them among several processes as the load increases. + </para> + </listitem> + <listitem> + <para> +If a font client is unable to connect to a server (as opposed +to having the connection terminated), it should retry for an +implementation-dependent length of time (see Xlib's +handling of ECONNREFUSED in XConnDis.c). + </para> + </listitem> +</itemizedlist> +</appendix> +<index id="index" /> +</book> diff --git a/specs/glossary.xml b/specs/glossary.xml new file mode 100644 index 0000000..61233e3 --- /dev/null +++ b/specs/glossary.xml @@ -0,0 +1,1320 @@ +<glossary id='glossary'> +<title>Glossary</title> + + +<glossentry id="glossary:Access_control_list"> + <glossterm>Access control list</glossterm> + <indexterm zone="glossary:Access_control_list" significance="preferred"><primary>Access control list</primary></indexterm> + <glossdef> + <para> +X maintains a list of hosts from which client programs can be run. +By default, +only programs on the local host and hosts specified in an initial list read +by the server can use the display. +Clients on the local host can change this access control list. +Some server implementations can also implement other authorization mechanisms +in addition to or in place of this mechanism. +The action of this mechanism can be conditional based on the authorization +protocol name and data received by the server at connection setup. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Active_grab"> + <glossterm>Active grab</glossterm> + <indexterm zone="glossary:Active_grab" significance="preferred"><primary>Active grab</primary></indexterm> + <glossdef> + <para> +A grab is active when the pointer or keyboard is actually owned by +the single grabbing client. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Ancestors"> + <glossterm>Ancestors</glossterm> + <indexterm zone="glossary:Ancestors" significance="preferred"><primary>Ancestors</primary></indexterm> + <glossdef> + <para> +If W is an <glossterm linkend="glossary:Inferiors">inferior</glossterm> of A, then A is an ancestor of W. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Atom"> + <glossterm>Atom</glossterm> + <indexterm zone="glossary:Atom" significance="preferred"><primary>Atom</primary></indexterm> + <glossdef> + <para> +An atom is a unique ID corresponding to a string name. +Atoms are used to identify properties, types, and selections. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Background"> + <glossterm>Background</glossterm> + <indexterm zone="glossary:Background" significance="preferred"><primary>Background</primary></indexterm> + <glossdef> + <para> +An +<glossterm linkend="glossary:InputOutput_window"><emphasis role='bold'>InputOutput</emphasis></glossterm> +window can have a background, which is defined as a pixmap. +When regions of the window have their contents lost or invalidated, +the server will automatically tile those regions with the background. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Backing_store"> + <glossterm>Backing store</glossterm> + <indexterm zone="glossary:Backing_store" significance="preferred"><primary>Backing store</primary></indexterm> + <glossdef> + <para> +When a server maintains the contents of a window, +the pixels saved off screen are known as a backing store. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Bit_gravity"> + <glossterm>Bit gravity</glossterm> + <indexterm zone="glossary:Bit_gravity" significance="preferred"><primary>Bit</primary><secondary>gravity</secondary></indexterm> + <glossdef> + <para> +When a window is resized, +the contents of the window are not necessarily discarded. +It is possible to request that the server relocate the previous contents +to some region of the window (though no guarantees are made). +This attraction of window contents for some location of +a window is known as bit gravity. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Bit_plane"> + <glossterm>Bit plane</glossterm> + <indexterm zone="glossary:Bit_plane" significance="preferred"><primary>Bit</primary><secondary>plane</secondary></indexterm> + <glossdef> + <para> +When a pixmap or window is thought of as a stack of bitmaps, +each bitmap is called a bit plane or plane. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Bitmap"> + <glossterm>Bitmap</glossterm> + <indexterm zone="glossary:Bitmap" significance="preferred"><primary>Bitmap</primary></indexterm> + <glossdef> + <para> +A bitmap is a <glossterm linkend="glossary:Pixmap">pixmap</glossterm> of depth one. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Border"> + <glossterm>Border</glossterm> + <indexterm zone="glossary:Border" significance="preferred"><primary>Border</primary></indexterm> + <glossdef> + <para> +An +<glossterm linkend="glossary:InputOutput_window"><emphasis role='bold'>InputOutput</emphasis></glossterm> +window can have a border of equal thickness on all four sides of the window. +A pixmap defines the contents of the border, +and the server automatically maintains the contents of the border. +Exposure events are never generated for border regions. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Button_grabbing"> + <glossterm>Button grabbing</glossterm> + <indexterm zone="glossary:Button_grabbing" significance="preferred"><primary>Button</primary><secondary>grabbing</secondary></indexterm> + <glossdef> + <para> +Buttons on the pointer may be passively grabbed by a client. +When the button is pressed, +the pointer is then actively grabbed by the client. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Byte_order"> + <glossterm>Byte order</glossterm> + <indexterm zone="glossary:Byte_order" significance="preferred"><primary>Byte order</primary></indexterm> + <glossdef> + <para> +For image (pixmap/bitmap) data, +the server defines the byte order, +and clients with different native byte ordering must swap bytes as necessary. +For all other parts of the protocol, +the client defines the byte order, +and the server swaps bytes as necessary. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Children"> + <glossterm>Children</glossterm> + <indexterm zone="glossary:Children" significance="preferred"><primary>Children</primary></indexterm> + <indexterm zone="glossary:Children" significance="preferred"><primary>Window</primary><secondary>children</secondary></indexterm> + <glossdef> + <para> +The children of a window are its first-level subwindows. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Client"> + <glossterm>Client</glossterm> + <indexterm zone="glossary:Client" significance="preferred"><primary>Client</primary></indexterm> + <glossdef> + <para> +An application program connects to the window system server by some +interprocess communication path, such as a TCP connection or a +shared memory buffer. +This program is referred to as a client of the window system server. +More precisely, +the client is the communication path itself; +a program with multiple paths open to the server is viewed as +multiple clients by the protocol. +Resource lifetimes are controlled by connection lifetimes, +not by program lifetimes. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Clipping_region"> + <glossterm>Clipping region</glossterm> + <indexterm zone="glossary:Clipping_region" significance="preferred"><primary>Clipping region</primary></indexterm> + <glossdef> + <para> +In a <glossterm linkend="glossary:Graphics_context">graphics context</glossterm>, +a bitmap or list of rectangles can be specified +to restrict output to a particular region of the window. +The image defined by the bitmap or rectangles is called a clipping region. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Colormap"> + <glossterm>Colormap</glossterm> + <indexterm zone="glossary:Colormap" significance="preferred"><primary>Colormap</primary></indexterm> + <glossdef> + <para> +A colormap consists of a set of entries defining color values. +The colormap associated with a window is used to display the contents of +the window; each pixel value indexes the colormap to produce RGB values +that drive the guns of a monitor. +Depending on hardware limitations, +one or more colormaps may be installed at one time, +so that windows associated with those maps display with correct colors. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Connection"> + <glossterm>Connection</glossterm> + <indexterm zone="glossary:Connection" significance="preferred"><primary>Connection</primary></indexterm> + <glossdef> + <para> +The interprocess communication path between the server and client +program is known as a connection. +A client program typically (but not necessarily) has one +connection to the server over which requests and events are sent. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Containment"> + <glossterm>Containment</glossterm> + <indexterm zone="glossary:Containment" significance="preferred"><primary>Containment</primary></indexterm> + <glossdef> + <para> +A window <quote>contains</quote> the pointer if the window is viewable and the +<glossterm linkend="glossary:Hotspot">hotspot</glossterm> of the cursor is +within a visible region of the window or a +visible region of one of its inferiors. +The border of the window is included as part of the window for containment. +The pointer is <quote>in</quote> a window if the window contains the pointer +but no inferior contains the pointer. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Coordinate_system"> + <glossterm>Coordinate system</glossterm> + <indexterm zone="glossary:Coordinate_system" significance="preferred"><primary>Coordinate system</primary></indexterm> + <glossdef> + <para> +The coordinate system has the X axis horizontal and the Y axis vertical, +with the origin [0, 0] at the upper left. +Coordinates are integral, +in terms of pixels, +and coincide with pixel centers. +Each window and pixmap has its own coordinate system. +For a window, +the origin is inside the border at the inside upper left. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Cursor"> + <glossterm>Cursor</glossterm> + <indexterm zone="glossary:Cursor" significance="preferred"><primary>Cursor</primary></indexterm> + <glossdef> + <para> +A cursor is the visible shape of the pointer on a screen. +It consists of a <glossterm linkend="glossary:Hotspot">hotspot</glossterm>, +a source bitmap, a shape bitmap, and a pair of colors. +The cursor defined for a window controls the visible appearance +when the pointer is in that window. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Depth"> + <glossterm>Depth</glossterm> + <indexterm zone="glossary:Depth" significance="preferred"><primary>Depth</primary></indexterm> + <glossdef> + <para> +The depth of a window or pixmap is the number of bits per pixel that it has. +The depth of a graphics context is the depth of the drawables it can be +used in conjunction with for graphics output. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Device"> + <glossterm>Device</glossterm> + <indexterm zone="glossary:Device" significance="preferred"><primary>Device</primary></indexterm> + <glossdef> + <para> +Keyboards, mice, tablets, track-balls, button boxes, and so on are all +collectively known as input devices. +The core protocol only deals with two devices, +<quote>the keyboard</quote> and <quote>the pointer.</quote> +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:DirectColor"> + <glossterm>DirectColor</glossterm> + <indexterm zone="glossary:DirectColor" significance="preferred"><primary>DirectColor</primary></indexterm> + <glossdef> + <para> +<emphasis role='bold'>DirectColor</emphasis> +is a class of colormap in which a pixel value is decomposed into three +separate subfields for indexing. +The first subfield indexes an array to produce red intensity values. +The second subfield indexes a second array to produce blue intensity values. +The third subfield indexes a third array to produce green intensity values. +The RGB values can be changed dynamically. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Display"> + <glossterm>Display</glossterm> + <indexterm zone="glossary:Display" significance="preferred"><primary>Display</primary></indexterm> + <glossdef> + <para> +A server, together with its screens and input devices, is called a display. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Drawable"> + <glossterm>Drawable</glossterm> + <indexterm zone="glossary:Drawable" significance="preferred"><primary>Drawable</primary></indexterm> + <glossdef> + <para> +Both windows and pixmaps can be used as sources and destinations in +graphics operations. +These windows and pixmaps are collectively known as drawables. +However, an +<glossterm linkend="glossary:InputOnly_window"><emphasis role='bold'>InputOnly</emphasis></glossterm> +window cannot be used as a source or destination in a graphics operation. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Event"> + <glossterm>Event</glossterm> + <indexterm zone="glossary:Event" significance="preferred"><primary>Event</primary></indexterm> + <glossdef> + <para> +Clients are informed of information asynchronously by means of events. +These events can be generated either asynchronously from devices +or as side effects of client requests. +Events are grouped into types. +The server never sends events to a client unless the +client has specificially asked to be informed of that type of event. +However, other clients can force events to be sent to other clients. +Events are typically reported relative to a window. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Event_mask"> + <glossterm>Event mask</glossterm> + <indexterm zone="glossary:Event_mask" significance="preferred"><primary>Event</primary><secondary>mask</secondary></indexterm> + <glossdef> + <para> +Events are requested relative to a window. +The set of event types that a client requests relative to a window +is described by using an event mask. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Event_synchronization"> + <glossterm>Event synchronization</glossterm> + <indexterm zone="glossary:Event_synchronization" significance="preferred"><primary>Event</primary><secondary>synchronization</secondary></indexterm> + <glossdef> + <para> +There are certain race conditions possible when demultiplexing device +events to clients (in particular deciding where pointer and keyboard +events should be sent when in the middle of window management +operations). +The event synchronization mechanism allows synchronous processing +of device events. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Event_propagation"> + <glossterm>Event propagation</glossterm> + <indexterm zone="glossary:Event_propagation" significance="preferred"><primary>Event</primary><secondary>propagation</secondary></indexterm> + <glossdef> + <para> +Device-related events propagate from the source window to ancestor +windows until some client has expressed interest in handling that type +of event or until the event is discarded explicitly. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Event_source"> + <glossterm>Event source</glossterm> + <indexterm zone="glossary:Event_source" significance="preferred"><primary>Event</primary><secondary>source</secondary></indexterm> + <glossdef> + <para> +The window the pointer is in is the source of a device-related +event. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Exposure_event"> + <glossterm>Exposure event</glossterm> + <indexterm zone="glossary:Exposure_event" significance="preferred"><primary>Event</primary><secondary>Exposure</secondary></indexterm> + <glossdef> + <para> +Servers do not guarantee to preserve the contents of windows when +windows are obscured or reconfigured. +Exposure events are sent to clients to inform them when contents +of regions of windows have been lost. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Extension"> + <glossterm>Extension</glossterm> + <indexterm zone="glossary:Extension" significance="preferred"><primary>Extension</primary></indexterm> + <glossdef> + <para> +Named extensions to the core protocol can be defined to extend the +system. +Extension to output requests, resources, and event types are +all possible and are expected. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Focus_window"> + <glossterm>Focus window</glossterm> + <indexterm zone="glossary:Focus_window" significance="preferred"><primary>Focus window</primary></indexterm> + <glossdef> + <para> +The focus window is another term for the <glossterm linkend="glossary:Input_focus">input focus</glossterm>. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Font"> + <glossterm>Font</glossterm> + <indexterm zone="glossary:Font" significance="preferred"><primary>Font</primary></indexterm> + <glossdef> + <para> +A font is a matrix of glyphs (typically characters). +The protocol does no translation or interpretation of character sets. +The client simply indicates values used to index the glyph array. +A font contains additional metric information to determine interglyph +and interline spacing. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:GC"> + <glossterm>GC, GContext</glossterm> + <indexterm zone="glossary:GC" significance="preferred"><primary>GC</primary><seealso>Graphics context</seealso></indexterm> + <indexterm zone="glossary:GC" significance="preferred"><primary>GContext</primary><seealso>Graphics context</seealso></indexterm> + <glossdef> + <para> +GC and gcontext are abbreviations for <glossterm linkend="glossary:Graphics_context">graphics context</glossterm>. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Glyph"> + <glossterm>Glyph</glossterm> + <indexterm zone="glossary:Glyph" significance="preferred"><primary>Glyph</primary></indexterm> + <glossdef> + <para> +A glyph is an image, typically of a character, in a font. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Grab"> + <glossterm>Grab</glossterm> + <indexterm zone="glossary:Grab" significance="preferred"><primary>Grab</primary><seealso>Active grab</seealso><seealso>Passive grab</seealso></indexterm> + <glossdef> + <para> +Keyboard keys, the keyboard, pointer buttons, the pointer, and the +server can be grabbed for exclusive use by a client. +In general, +these facilities are not intended to be used by normal applications +but are intended for various input and window managers to implement +various styles of user interfaces. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Graphics_context"> + <glossterm>Graphics context</glossterm> + <indexterm zone="glossary:Graphics_context" significance="preferred"><primary>Graphics context</primary></indexterm> + <glossdef> + <para> +Various information for graphics output is stored in a graphics context +such as foreground pixel, background pixel, line width, +<glossterm linkend="glossary:Clipping_region">clipping region</glossterm>, +and so on. +A graphics context can only be used with drawables that have the same root +and the same depth as the graphics context. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Gravity"> + <glossterm>Gravity</glossterm> + <indexterm zone="glossary:Gravity" significance="preferred"><primary>Gravity</primary></indexterm> + <glossdef> + <para> +See <glossterm linkend="glossary:Bit_gravity">bit gravity</glossterm> +and <glossterm linkend="glossary:Window_gravity">window gravity</glossterm>. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:GrayScale"> + <glossterm>GrayScale</glossterm> + <indexterm zone="glossary:GrayScale" significance="preferred"><primary>GrayScale</primary></indexterm> + <glossdef> + <para> +<emphasis role='bold'>GrayScale</emphasis> +can be viewed as a degenerate case of +<glossterm linkend="glossary:PseudoColor"><emphasis role='bold'>PseudoColor</emphasis></glossterm>, +in which the red, green, and blue values in any given colormap entry are equal, +thus producing shades of gray. +The gray values can be changed dynamically. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Hotspot"> + <glossterm>Hotspot</glossterm> + <indexterm zone="glossary:Hotspot" significance="preferred"><primary>Hotspot</primary></indexterm> + <glossdef> + <para> +A cursor has an associated hotspot that defines the point in the +cursor corresponding to the coordinates reported for the pointer. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Identifier"> + <glossterm>Identifier</glossterm> + <indexterm zone="glossary:Identifier" significance="preferred"><primary>Identifier</primary></indexterm> + <glossdef> + <para> +An identifier is a unique value associated with a resource that clients use +to name that resource. +The identifier can be used over any connection. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Inferiors"> + <glossterm>Inferiors</glossterm> + <indexterm zone="glossary:Inferiors" significance="preferred"><primary>Inferiors</primary></indexterm> + <glossdef> + <para> +The inferiors of a window are all of the subwindows nested below it: +the children, the children's children, and so on. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Input_focus"> + <glossterm>Input focus</glossterm> + <indexterm zone="glossary:Input_focus" significance="preferred"><primary>Input focus</primary></indexterm> + <glossdef> + <para> +The input focus is normally a window defining the scope for +processing of keyboard input. +If a generated keyboard event would normally be reported to this window +or one of its inferiors, +the event is reported normally. +Otherwise, the event is reported with respect to +the focus window. +The input focus also can be set such that all +keyboard events are discarded and such that the focus +window is dynamically taken to be the root window of whatever screen +the pointer is on at each keyboard event. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Input_manager"> + <glossterm>Input manager</glossterm> + <indexterm zone="glossary:Input_manager" significance="preferred"><primary>Input manager</primary></indexterm> + <glossdef> + <para> +Control over keyboard input is typically provided by an input manager client. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:InputOnly_window"> + <glossterm>InputOnly window</glossterm> + <indexterm zone="glossary:InputOnly_window" significance="preferred"><primary>Window</primary><secondary>InputOnly</secondary></indexterm> + <glossdef> + <para> +An +<emphasis role='bold'>InputOnly</emphasis> +window is a window that cannot be used for graphics requests. +<emphasis role='bold'>InputOnly</emphasis> +windows are invisible and can be used to control such things +as cursors, input event generation, and grabbing. +<emphasis role='bold'>InputOnly</emphasis> +windows cannot have +<emphasis role='bold'>InputOutput</emphasis> +windows as inferiors. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:InputOutput_window"> + <glossterm>InputOutput window</glossterm> + <indexterm zone="glossary:InputOutput_window" significance="preferred"><primary>Window</primary><secondary>InputOutput</secondary></indexterm> + <glossdef> + <para> +An +<emphasis role='bold'>InputOutput</emphasis> +window is the normal kind of opaque window, used for both input and output. +<emphasis role='bold'>InputOutput</emphasis> +windows can have both +<emphasis role='bold'>InputOutput</emphasis> +and +<emphasis role='bold'>InputOnly</emphasis> +windows as inferiors. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Key_grabbing"> + <glossterm>Key grabbing</glossterm> + <indexterm zone="glossary:Key_grabbing" significance="preferred"><primary>Key</primary><secondary>grabbing</secondary></indexterm> + <glossdef> + <para> +Keys on the keyboard can be passively grabbed by a client. +When the key is pressed, +the keyboard is then actively grabbed by the client. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Keyboard_grabbing"> + <glossterm>Keyboard grabbing</glossterm> + <indexterm zone="glossary:Keyboard_grabbing" significance="preferred"><primary>Keyboard</primary><secondary>grabbing</secondary></indexterm> + <glossdef> + <para> +A client can actively grab control of the keyboard, and key events +will be sent to that client rather than the client the events would +normally have been sent to. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Keysym"> + <glossterm>Keysym</glossterm> + <indexterm zone="glossary:Keysym" significance="preferred"><primary>Keysym</primary></indexterm> + <glossdef> + <para> +An encoding of a symbol on a keycap on a keyboard. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Mapped"> + <glossterm>Mapped</glossterm> + <indexterm zone="glossary:Mapped" significance="preferred"><primary>Mapped window</primary></indexterm> + <glossdef> + <para> +A window is said to be mapped if a map call has been performed on it. +Unmapped windows and their inferiors are never viewable or visible. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Modifier_keys"> + <glossterm>Modifier keys</glossterm> + <indexterm zone="glossary:Modifier_keys" significance="preferred"><primary>Modifier keys</primary></indexterm> + <indexterm zone="glossary:Modifier_keys"><primary>Key</primary><secondary>modifier</secondary><see>Modifier keys</see></indexterm> + <glossdef> + <para> +Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock, +ShiftLock, and similar keys are called modifier keys. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Monochrome"> + <glossterm>Monochrome</glossterm> + <indexterm zone="glossary:Monochrome" significance="preferred"><primary>Monochrome</primary></indexterm> + <glossdef> + <para> +Monochrome is a special case of +<glossterm linkend="glossary:StaticGray"><emphasis role='bold'>StaticGray</emphasis></glossterm> +in which there are only two colormap entries. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Obscure"> + <glossterm>Obscure</glossterm> + <indexterm zone="glossary:Obscure" significance="preferred"><primary>Obscure</primary></indexterm> + <glossdef> + <para> +A window is obscured if some other window obscures it. +Window A obscures window B if both are viewable +<glossterm linkend="glossary:InputOutput_window"><emphasis role='bold'>InputOutput</emphasis></glossterm> +windows, A is higher in the global stacking order, +and the rectangle defined by the outside edges of A intersects +the rectangle defined by the outside edges of B. +Note the distinction between obscure and occludes. +Also note that window borders are included in the calculation +and that a window can be obscured and yet still have visible regions. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Occlude"> + <glossterm>Occlude</glossterm> + <indexterm zone="glossary:Occlude" significance="preferred"><primary>Occlude</primary></indexterm> + <glossdef> + <para> +A window is occluded if some other window occludes it. +Window A occludes window B if both are mapped, A is higher in the global +stacking order, and the rectangle defined by the outside edges of A +intersects the rectangle defined by the outside edges of B. +Note the distinction between occludes and obscures. +Also note that window borders are included in the calculation. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Padding"> + <glossterm>Padding</glossterm> + <indexterm zone="glossary:Padding" significance="preferred"><primary>Padding</primary></indexterm> + <glossdef> + <para> +Some padding bytes are inserted in the data stream to maintain +alignment of the protocol requests on natural boundaries. +This increases ease of portability to some machine architectures. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Parent_window"> + <glossterm>Parent window</glossterm> + <indexterm zone="glossary:Parent_window" significance="preferred"><primary>Window</primary><secondary>parent</secondary></indexterm> + <glossdef> + <para> +If C is a <glossterm linkend="glossary:Children">child</glossterm> of P, +then P is the parent of C. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Passive_grab"> + <glossterm>Passive grab</glossterm> + <indexterm zone="glossary:Passive_grab" significance="preferred"><primary>Passive grab</primary></indexterm> + <glossdef> + <para> +Grabbing a key or button is a passive grab. +The grab activates when the key or button is actually pressed. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Pixel_value"> + <glossterm>Pixel value</glossterm> + <indexterm zone="glossary:Pixel_value" significance="preferred"><primary>Pixel value</primary></indexterm> + <glossdef> + <para> +A pixel is an N-bit value, where N is the number of bit planes used +in a particular window or pixmap (that is, +N is the depth of the window or pixmap). +For a window, +a pixel value indexes a colormap to derive an actual color to be displayed. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Pixmap"> + <glossterm>Pixmap</glossterm> + <indexterm zone="glossary:Pixmap" significance="preferred"><primary>Pixmap</primary></indexterm> + <glossdef> + <para> +A pixmap is a three-dimensional array of bits. +A pixmap is normally thought of as a two-dimensional array of pixels, +where each pixel can be a value from 0 to (2^N)-1 +and where N is the depth (z axis) of the pixmap. +A pixmap can also be thought of as a stack of N bitmaps. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Plane"> + <glossterm>Plane</glossterm> + <indexterm zone="glossary:Plane" significance="preferred"><primary>Plane</primary></indexterm> + <glossdef> + <para> +When a pixmap or window is thought of as a stack of bitmaps, +each bitmap is called a plane or bit plane. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Plane_mask"> + <glossterm>Plane mask</glossterm> + <indexterm zone="glossary:Plane_mask" significance="preferred"><primary>Plane</primary><secondary>mask</secondary></indexterm> + <glossdef> + <para> +Graphics operations can be restricted to only affect a subset of bit +planes of a destination. +A plane mask is a bit mask describing which planes are to be modified. +The plane mask is stored in a graphics context. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Pointer"> + <glossterm>Pointer</glossterm> + <indexterm zone="glossary:Pointer" significance="preferred"><primary>Pointer</primary></indexterm> + <glossdef> + <para> +The pointer is the pointing device attached to the cursor +and tracked on the screens. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Pointer_grabbing"> + <glossterm>Pointer grabbing</glossterm> + <indexterm zone="glossary:Pointer_grabbing" significance="preferred"><primary>Pointer</primary><secondary>grabbing</secondary></indexterm> + <glossdef> + <para> +A client can actively grab control of the pointer. +Then button and motion events will be sent to that client +rather than the client the events would normally have been sent to. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Pointing_device"> + <glossterm>Pointing device</glossterm> + <indexterm zone="glossary:Pointing_device" significance="preferred"><primary>Pointing device</primary></indexterm> + <glossdef> + <para> +A pointing device is typically a mouse, tablet, or some other +device with effective dimensional motion. +There is only one visible cursor defined by the core protocol, +and it tracks whatever pointing device is attached as the pointer. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Property"> + <glossterm>Property</glossterm> + <indexterm zone="glossary:Property" significance="preferred"><primary>Property</primary></indexterm> + <glossdef> + <para> +Windows may have associated properties, +which consist of a name, a type, a data format, and some data. +The protocol places no interpretation on properties. +They are intended as a general-purpose naming mechanism for clients. +For example, clients might use properties to share information such as resize +hints, program names, and icon formats with a window manager. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Property_list"> + <glossterm>Property list</glossterm> + <indexterm zone="glossary:Property_list" significance="preferred"><primary>Property list</primary></indexterm> + <glossdef> + <para> +The property list of a window is the list of properties that have +been defined for the window. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:PseudoColor"> + <glossterm>PseudoColor</glossterm> + <indexterm zone="glossary:PseudoColor" significance="preferred"><primary>PseudoColor</primary></indexterm> + <glossdef> + <para> +<emphasis role='bold'>PseudoColor</emphasis> +is a class of colormap in which a pixel value indexes the colormap to +produce independent red, green, and blue values; +that is, the colormap is viewed as an array of triples (RGB values). +The RGB values can be changed dynamically. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Redirecting_control"> + <glossterm>Redirecting control</glossterm> + <indexterm zone="glossary:Redirecting_control" significance="preferred"><primary>Redirecting control</primary></indexterm> + <glossdef> + <para> +Window managers (or client programs) may want to enforce window layout +policy in various ways. +When a client attempts to change the size or position of a window, +the operation may be redirected to a specified client +rather than the operation actually being performed. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Reply"> + <glossterm>Reply</glossterm> + <indexterm zone="glossary:Reply" significance="preferred"><primary>Reply</primary></indexterm> + <glossdef> + <para> +Information requested by a client program is sent back to the client +with a reply. +Both events and replies are multiplexed on the same connection. +Most requests do not generate replies, +although some requests generate multiple replies. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Request"> + <glossterm>Request</glossterm> + <indexterm zone="glossary:Request" significance="preferred"><primary>Request</primary></indexterm> + <glossdef> + <para> +A command to the server is called a request. +It is a single block of data sent over a connection. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Resource"> + <glossterm>Resource</glossterm> + <indexterm zone="glossary:Resource" significance="preferred"><primary>Resource</primary></indexterm> + <glossdef> + <para> +Windows, pixmaps, cursors, fonts, graphics contexts, and colormaps are +known as resources. +They all have unique identifiers associated with them for naming purposes. +The lifetime of a resource usually is bounded by the lifetime of the connection +over which the resource was created. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:RGB_values"> + <glossterm>RGB values</glossterm> + <indexterm zone="glossary:RGB_values" significance="preferred"><primary>RGB values</primary></indexterm> + <glossdef> + <para> +Red, green, and blue (RGB) intensity values are used to define color. +These values are always represented as 16-bit unsigned numbers, +with 0 being the minimum intensity and 65535 being the maximum intensity. +The server scales the values to match the display hardware. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Root"> + <glossterm>Root</glossterm> + <indexterm zone="glossary:Root" significance="preferred"><primary>Root</primary></indexterm> + <glossdef> + <para> +The root of a pixmap, colormap, or graphics context is the same as the root of +whatever drawable was used when the pixmap, colormap, or graphics context was +created. +The root of a window is the root window under which the window was created. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Root_window"> + <glossterm>Root window</glossterm> + <indexterm zone="glossary:Root_window" significance="preferred"><primary>Window</primary><secondary>root</secondary></indexterm> + <glossdef> + <para> +Each screen has a root window covering it. +It cannot be reconfigured or unmapped, +but it otherwise acts as a full-fledged window. +A root window has no parent. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Save_set"> + <glossterm>Save set</glossterm> + <indexterm zone="glossary:Save_set" significance="preferred"><primary>Save set</primary></indexterm> + <glossdef> + <para> +The save set of a client is a list of other clients' windows that, +if they are inferiors of one of the client's windows at connection close, +should not be destroyed and that should be remapped if currently unmapped. +Save sets are typically used by window managers to avoid +lost windows if the manager terminates abnormally. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Scanline"> + <glossterm>Scanline</glossterm> + <indexterm zone="glossary:Scanline" significance="preferred"><primary>Scanline</primary></indexterm> + <glossdef> + <para> +A scanline is a list of pixel or bit values viewed as a horizontal +row (all values having the same y coordinate) of an image, with the +values ordered by increasing x coordinate. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Scanline_order"> + <glossterm>Scanline order</glossterm> + <indexterm zone="glossary:Scanline_order" significance="preferred"><primary>Scanline order</primary></indexterm> + <glossdef> + <para> +An image represented in scanline order contains scanlines ordered by +increasing y coordinate. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Screen"> + <glossterm>Screen</glossterm> + <indexterm zone="glossary:Screen" significance="preferred"><primary>Screen</primary></indexterm> + <glossdef> + <para> +A server can provide several independent screens, +which typically have physically independent monitors. +This would be the expected configuration when there is only a single keyboard +and pointer shared among the screens. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Selection"> + <glossterm>Selection</glossterm> + <indexterm zone="glossary:Selection" significance="preferred"><primary>Selection</primary></indexterm> + <glossdef> + <para> +A selection can be thought of as an indirect property with dynamic +type; that is, rather than having the property stored in the server, +it is maintained by some client (the <quote>owner</quote>). +A selection is global in nature and is thought of as belonging to the user +(although maintained by clients), rather than as being private to a particular +window subhierarchy or a particular set of clients. +When a client asks for the contents of a selection, +it specifies a selection <quote>target type</quote>. +This target type can be used to control the transmitted representation of the +contents. +For example, +if the selection is <quote>the last thing the user clicked on</quote> +and that is currently an image, then the target type might specify +whether the contents of the image should be sent in XY format or Z format. +The target type can also be used to control the class of contents transmitted; +for example, asking for the <quote>looks</quote> (fonts, line +spacing, indentation, and so on) of a paragraph selection rather than the +text of the paragraph. +The target type can also be used for other purposes. +The protocol does not constrain the semantics. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Server"> + <glossterm>Server</glossterm> + <indexterm zone="glossary:Server" significance="preferred"><primary>Server</primary></indexterm> + <glossdef> + <para> +The server provides the basic windowing mechanism. +It handles connections from clients, +multiplexes graphics requests onto the screens, +and demultiplexes input back to the appropriate clients. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Server_grabbing"> + <glossterm>Server grabbing</glossterm> + <indexterm zone="glossary:Server_grabbing" significance="preferred"><primary>Server</primary><secondary>grabbing</secondary></indexterm> + <glossdef> + <para> +The server can be grabbed by a single client for exclusive use. +This prevents processing of any requests from other client connections until +the grab is completed. +This is typically only a transient state for +such things as rubber-banding, pop-up menus, or to execute requests +indivisibly. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Sibling"> + <glossterm>Sibling</glossterm> + <indexterm zone="glossary:Sibling" significance="preferred"><primary>Sibling</primary></indexterm> + <glossdef> + <para> +Children of the same parent window are known as sibling windows. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Stacking_order"> + <glossterm>Stacking order</glossterm> + <indexterm zone="glossary:Stacking_order" significance="preferred"><primary>Stacking order</primary></indexterm> + <glossdef> + <para> +Sibling windows may stack on top of each other. +Windows above other windows both obscure and occlude those lower windows. +This is similar to paper on a desk. +The relationship between sibling windows is known as the stacking order. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:StaticColor"> + <glossterm>StaticColor</glossterm> + <indexterm zone="glossary:StaticColor" significance="preferred"><primary>StaticColor</primary></indexterm> + <glossdef> + <para> +<emphasis role='bold'>StaticColor</emphasis> +can be viewed as a degenerate case of +<glossterm linkend="glossary:PseudoColor"><emphasis role='bold'>PseudoColor</emphasis></glossterm> +in which the RGB values are predefined and read-only. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:StaticGray"> + <glossterm>StaticGray</glossterm> + <indexterm zone="glossary:StaticGray" significance="preferred"><primary>StaticGray</primary></indexterm> + <glossdef> + <para> +<emphasis role='bold'>StaticGray</emphasis> +can be viewed as a degenerate case of +<glossterm linkend="glossary:GrayScale"><emphasis role='bold'>GrayScale</emphasis></glossterm> +in which the gray values are predefined and read-only. +The values are typically linear or near-linear increasing ramps. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Stipple"> + <glossterm>Stipple</glossterm> + <indexterm zone="glossary:Stipple" significance="preferred"><primary>Stipple</primary></indexterm> + <glossdef> + <para> +A stipple pattern is a bitmap that is used to tile a region that will serve +as an additional clip mask for a fill operation with the foreground +color. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:String_Equivalence"> + <glossterm>String Equivalence</glossterm> + <indexterm zone="glossary:String_Equivalence" significance="preferred"><primary>String Equivalence</primary></indexterm> + <glossdef> + <para> +Two ISO Latin-1 STRING8 values are considered equal if they are the same +length and if corresponding bytes are either equal or are equivalent as +follows: decimal values 65 to 90 inclusive (characters <quote>A</quote> to <quote>Z</quote>) are +pairwise equivalent to decimal values 97 to 122 inclusive +(characters <quote>a</quote> to <quote>z</quote>), decimal values 192 to 214 inclusive +(characters <quote>A grave</quote> to <quote>O diaeresis</quote>) are pairwise equivalent to decimal +values 224 to 246 inclusive (characters <quote>a grave</quote> to <quote>o diaeresis</quote>), +and decimal values 216 to 222 inclusive (characters <quote>O oblique</quote> to <quote>THORN</quote>) +are pairwise equivalent to decimal values 246 to 254 inclusive +(characters <quote>o oblique</quote> to <quote>thorn</quote>). +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Tile"> + <glossterm>Tile</glossterm> + <indexterm zone="glossary:Tile" significance="preferred"><primary>Tile</primary></indexterm> + <glossdef> + <para> +A pixmap can be replicated in two dimensions to tile a region. +The pixmap itself is also known as a tile. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Timestamp"> + <glossterm>Timestamp</glossterm> + <indexterm zone="glossary:Timestamp" significance="preferred"><primary>Timestamp</primary></indexterm> + <indexterm zone="glossary:Timestamp" significance="preferred"><primary>CurrentTime</primary></indexterm> + <glossdef> + <para> +A timestamp is a time value, expressed in milliseconds. +It typically is the time since the last +server reset. +Timestamp values wrap around (after about 49.7 days). +The server, given its current time is represented by timestamp T, +always interprets timestamps from clients by treating half of the +timestamp space as being earlier in time than T and half of the +timestamp space as being later in time than T. +One timestamp value (named +<emphasis role='bold'>CurrentTime</emphasis>) +is never generated by the server. +This value is reserved for use in requests to represent the current +server time. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:TrueColor"> + <glossterm>TrueColor</glossterm> + <indexterm zone="glossary:TrueColor" significance="preferred"><primary>TrueColor</primary></indexterm> + <glossdef> + <para> +<emphasis role='bold'>TrueColor</emphasis> +can be viewed as a degenerate case of +<glossterm linkend="glossary:DirectColor"><emphasis role='bold'>DirectColor</emphasis></glossterm> +in which the subfields in the pixel value directly encode +the corresponding RGB values; that is, the colormap has predefined +read-only RGB values. +The values are typically linear or near-linear increasing ramps. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Type"> + <glossterm>Type</glossterm> + <indexterm zone="glossary:Type" significance="preferred"><primary>Type</primary></indexterm> + <glossdef> + <para> +A type is an arbitrary atom used to identify the interpretation of +property data. +Types are completely uninterpreted by the server +and are solely for the benefit of clients. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Viewable"> + <glossterm>Viewable</glossterm> + <indexterm zone="glossary:Viewable" significance="preferred"><primary>Viewable</primary></indexterm> + <glossdef> + <para> +A window is viewable if it and all of its ancestors are mapped. +This does not imply that any portion of the window is actually visible. +Graphics requests can be performed on a window when it is not viewable, +but output will not be retained unless the server is maintaining +backing store. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Visible"> + <glossterm>Visible</glossterm> + <indexterm zone="glossary:Visible" significance="preferred"><primary>Visible</primary></indexterm> + <glossdef> + <para> +A region of a window is visible if someone looking at the screen can +actually see it; +that is, the window is viewable and the region is not occluded by any +other window. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Window_gravity"> + <glossterm>Window gravity</glossterm> + <indexterm zone="glossary:Window_gravity" significance="preferred"><primary>Window</primary><secondary>gravity</secondary></indexterm> + <glossdef> + <para> +When windows are resized, +subwindows may be repositioned automatically relative to some position +in the window. +This attraction of a subwindow to some part of its parent is known +as window gravity. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:Window_manager"> + <glossterm>Window manager</glossterm> + <indexterm zone="glossary:Window_manager" significance="preferred"><primary>Window</primary><secondary>manager</secondary></indexterm> + <glossdef> + <para> +Manipulation of windows on the screen and much of the user interface +(policy) is typically provided by a window manager client. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:XYFormat"> + <glossterm>XYFormat</glossterm> + <indexterm zone="glossary:XYFormat" significance="preferred"><primary>XYFormat</primary></indexterm> + <glossdef> + <para> +The data for a pixmap is said to be in XY format if it is organized as +a set of bitmaps representing individual bit planes, with the planes +appearing from most-significant to least-significant in bit order. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +<glossentry id="glossary:ZFormat"> + <glossterm>ZFormat</glossterm> + <indexterm zone="glossary:ZFormat" significance="preferred"><primary>ZFormat</primary></indexterm> + <glossdef> + <para> +The data for a pixmap is said to be in Z format if it is organized as +a set of pixel values in scanline order. +<!-- .KE --> + </para> + </glossdef> +</glossentry> +</glossary> diff --git a/specs/keysyms.xml b/specs/keysyms.xml new file mode 100644 index 0000000..e2fa0d0 --- /dev/null +++ b/specs/keysyms.xml @@ -0,0 +1,6050 @@ +<appendix id="keysym_encoding"> +<title>KEYSYM Encoding</title> +<indexterm zone="keysym_encoding"><primary>Types</primary><secondary>KEYSYM</secondary></indexterm> +<indexterm zone="keysym_encoding"><primary>Keysym</primary></indexterm> + +<para> +KEYSYM values are 32-bit integers that encode the symbols on the +keycaps of a keyboard. The three most significant bits are always +zero, which leaves a 29-bit number space. For convenience, KEYSYM +values can be viewed as split into four bytes: +</para> + +<itemizedlist> + <listitem> + <para> +Byte 1 is the most significant eight bits (three zero bits and +the most-significant five bits of the 29-bit effective value) + </para> + </listitem> + <listitem> + <para> +Byte 2 is the next most-significant eight bits + </para> + </listitem> + <listitem> + <para> +Byte 3 is the next most-significant eight bits + </para> + </listitem> + <listitem> + <para> +Byte 4 is the least-significant eight bits + </para> + </listitem> +</itemizedlist> + +<para> +There are six categories of KEYSYM values. +</para> + +<sect1 id='Special_KEYSYMs'> +<title>Special KEYSYMs</title> +<para> +There are two special values: +<keysym>NoSymbol</keysym> +and +<keysym>VoidSymbol</keysym>. +They are used to indicate the absence of symbols (see +<link linkend='Keyboards'>Section 5, Keyboards</link>). +</para> + +<informaltable frame="topbot"> + <?dbfo keep-together="always" ?> + <tgroup cols='6' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <colspec colname='c4' colwidth='1.0*'/> + <colspec colname='c5' colwidth='1.0*'/> + <colspec colname='c6' colwidth='1.0*'/> + <thead> + <row rowsep='1'> + <entry>Byte 1</entry> + <entry>Byte 2</entry> + <entry>Byte 3</entry> + <entry>Byte 4</entry> + <entry>Hex. value</entry> + <entry>Name</entry> + </row> + </thead> + <tbody> + <row> + <entry>0</entry> + <entry>0</entry> + <entry>0</entry> + <entry>0</entry> + <entry>#x00000000</entry> + <entry><keysym>NoSymbol</keysym></entry> + </row> + <row> + <entry>0</entry> + <entry>255</entry> + <entry>255</entry> + <entry>255</entry> + <entry>#x00FFFFFF</entry> + <entry><keysym>VoidSymbol</keysym></entry> + </row> + </tbody> + </tgroup> +</informaltable> +</sect1> + +<sect1 id='Latin_1_KEYSYMs'> +<title>Latin-1 KEYSYMs</title> + +<para> +The Latin-1 KEYSYMs occupy the range #x0020 to #x007E and #x00A0 to +#00FF and represent the ISO 10646 / Unicode characters U+0020 to +U+007E and U+00A0 to U+00FF, respectively. +</para> +</sect1> + +<sect1 id='Unicode_KEYSYMs'> +<title>Unicode KEYSYMs</title> +<indexterm zone="Unicode_KEYSYMs"><primary>Keysym</primary><secondary>Unicode</secondary></indexterm> + +<para> +These occupy the range #x01000100 to #x0110FFFF and represent the ISO +10646 / Unicode characters U+0100 to U+10FFFF, respectively. The +numeric value of a Unicode KEYSYM is the Unicode position of the +corresponding character plus #x01000000. In the interest of backwards +compatibility, clients should be able to process both the Unicode +KEYSYM and the Legacy KEYSYM for those characters where both exist. +</para> +<para> +Dead keys, which place an accent on the next character entered, shall +be encoded as Function KEYSYMs, and not as the Unicode KEYSYM +corresponding to an equivalent combining character. Where a keycap +indicates a specific function with a graphical symbol that is also +available in Unicode (e.g., an upwards arrow for the cursor up +function), the appropriate Function KEYSYM should be used, and not +the Unicode KEYSYM corresponding to the depicted symbol. +</para> +</sect1> +<sect1 id='Function_KEYSYMs'> +<title>Function KEYSYMs</title> + +<para> +These represent keycap symbols that do not directly represent elements +of a coded character set. Instead, they typically identify a software +function, mode, or operation (e.g., cursor up, caps lock, insert) that +can be activated using a dedicated key. Function KEYSYMs have zero +values for bytes 1 and 2. Byte 3 distinguishes between several 8-bit +sets within which byte 4 identifies the individual function key. +</para> + +<informaltable frame="topbot"> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <thead> + <row rowsep='1'> + <entry>Byte 3</entry> + <entry>Byte 4</entry> + </row> + </thead> + <tbody> + <row> + <entry>255</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>254</entry> + <entry>Keyboard (XKB) Extension</entry> + </row> + <row> + <entry>253</entry> + <entry>3270</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +Within a national market, keyboards tend to be comparatively standard +with respect to the character keys, but they can differ significantly +on the miscellaneous function keys. Some have function keys left over +from early timesharing days, others were designed for a specific +application, such as text processing, web browsing, or accessing +audiovisual data. The symbols on the keycaps can differ significantly +between manufacturers and national markets, even where they denote the +same software function (e.g., Ctrl in the U.S. versus Strg in Germany) +</para> +<para> +<!-- .LP --> +There are two ways of thinking about how to define KEYSYMs for such a +world: +</para> +<itemizedlist> + <listitem> + <para> +The Engraving approach + </para> + </listitem> + <listitem> + <para> +The Common approach + </para> + </listitem> +</itemizedlist> +<para> +<!-- .LP --> +The Engraving approach is to create a KEYSYM for every unique key +engraving. This is effectively taking the union of all key engravings +on all keyboards. For example, some keyboards label function keys +across the top as F1 through Fn, and others label them as PF1 through +PFn. These would be different keys under the Engraving +approach. Likewise, Lock would differ from Shift Lock, which is +different from the up-arrow symbol that has the effect of changing +lowercase to uppercase. There are lots of other aliases such as Del, +DEL, Delete, Remove, and so forth. The Engraving approach makes it +easy to decide if a new entry should be added to the KEYSYM set: if it +does not exactly match an existing one, then a new one is created. +</para> +<para> +<!-- .LP --> +The Common approach tries to capture all of the keys present on an +interesting number of keyboards, folding likely aliases into the same +KEYSYM. For example, Del, DEL, and Delete are all merged into a single +KEYSYM. Vendors can augment the KEYSYM set (using the vendor-specific +encoding space) to include all of their unique keys that were not +included in the standard set. Each vendor decides which of its keys +map into the standard KEYSYMs, which presumably can be overridden by a +user. It is more difficult to implement this approach, because +judgment is required about when a sufficient set of keyboards +implements an engraving to justify making it a KEYSYM in the standard +set and about which engravings should be merged into a single +KEYSYM. +</para> +<para> +<!-- .LP --> +Although neither scheme is perfect or elegant, the Common approach has +been selected because it makes it easier to write a portable +application. Having the Delete functionality merged into a single +KEYSYM allows an application to implement a deletion function and +expect reasonable bindings on a wide set of workstations. Under the +Common approach, application writers are still free to look for and +interpret vendor-specific KEYSYMs, but because they are in the +extended set, the application developer is more conscious that they +are writing the application in a nonportable fashion. +</para> +<para> +<!-- .LP --> +The Keyboard set is a miscellaneous collection of commonly occurring +keys on keyboards. Within this set, the numeric keypad symbols are +generally duplicates of symbols found on keys on the main part of the +keyboard, but they are distinguished here because they often have a +distinguishable semantics associated with them. +</para> + +<informaltable frame="topbot"> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='3.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <thead> + <row rowsep="1"> + <entry>KEYSYM value</entry> + <entry>Name</entry> + <entry>Set</entry> + </row> + </thead> + <tbody> + <row> + <entry>#xFF08</entry> + <entry>BACKSPACE, BACK SPACE, BACK CHAR</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF09</entry> + <entry>TAB</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF0A</entry> + <entry>LINEFEED, LF</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF0B</entry> + <entry>CLEAR</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF0D</entry> + <entry>RETURN, ENTER</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF13</entry> + <entry>PAUSE, HOLD</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF14</entry> + <entry>SCROLL LOCK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF15</entry> + <entry>SYS REQ, SYSTEM REQUEST</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF1B</entry> + <entry>ESCAPE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF20</entry> + <entry>MULTI-KEY CHARACTER PREFACE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF21</entry> + <entry>KANJI, KANJI CONVERT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF22</entry> + <entry>MUHENKAN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF23</entry> + <entry>HENKAN MODE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF24</entry> + <entry>ROMAJI</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF25</entry> + <entry>HIRAGANA</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF26</entry> + <entry>KATAKANA</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF27</entry> + <entry>HIRAGANA/KATAKANA TOGGLE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF28</entry> + <entry>ZENKAKU</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF29</entry> + <entry>HANKAKU</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF2A</entry> + <entry>ZENKAKU/HANKAKU TOGGLE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF2B</entry> + <entry>TOUROKU</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF2C</entry> + <entry>MASSYO</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF2D</entry> + <entry>KANA LOCK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF2E</entry> + <entry>KANA SHIFT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF2F</entry> + <entry>EISU SHIFT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF30</entry> + <entry>EISU TOGGLE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF31</entry> + <entry>HANGUL START/STOP (TOGGLE)</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF32</entry> + <entry>HANGUL START</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF33</entry> + <entry>HANGUL END, ENGLISH START</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF34</entry> + <entry>START HANGUL/HANJA CONVERSION</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF35</entry> + <entry>HANGUL JAMO MODE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF36</entry> + <entry>HANGUL ROMAJA MODE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF37</entry> + <entry>HANGUL CODE INPUT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF38</entry> + <entry>HANGUL JEONJA MODE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF39</entry> + <entry>HANGUL BANJA MODE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF3A</entry> + <entry>HANGUL PREHANJA CONVERSION</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF3B</entry> + <entry>HANGUL POSTHANJA CONVERSION</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF3C</entry> + <entry>HANGUL SINGLE CANDIDATE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF3D</entry> + <entry>HANGUL MULTIPLE CANDIDATE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF3E</entry> + <entry>HANGUL PREVIOUS CANDIDATE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF3F</entry> + <entry>HANGUL SPECIAL SYMBOLS</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF50</entry> + <entry>HOME</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF51</entry> + <entry>LEFT, MOVE LEFT, LEFT ARROW</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF52</entry> + <entry>UP, MOVE UP, UP ARROW</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF53</entry> + <entry>RIGHT, MOVE RIGHT, RIGHT ARROW</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF54</entry> + <entry>DOWN, MOVE DOWN, DOWN ARROW</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF55</entry> + <entry>PRIOR, PREVIOUS, PAGE UP</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF56</entry> + <entry>NEXT, PAGE DOWN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF57</entry> + <entry>END, EOL</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF58</entry> + <entry>BEGIN, BOL</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF60</entry> + <entry>SELECT, MARK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF61</entry> + <entry>PRINT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF62</entry> + <entry>EXECUTE, RUN, DO</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF63</entry> + <entry>INSERT, INSERT HERE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF65</entry> + <entry>UNDO, OOPS</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF66</entry> + <entry>REDO, AGAIN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF67</entry> + <entry>MENU</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF68</entry> + <entry>FIND, SEARCH</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF69</entry> + <entry>CANCEL, STOP, ABORT, EXIT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF6A</entry> + <entry>HELP</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF6B</entry> + <entry>BREAK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF7E</entry> + <entry>MODE SWITCH, SCRIPT SWITCH, CHARACTER SET SWITCH</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF7F</entry> + <entry>NUM LOCK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF80</entry> + <entry>KEYPAD SPACE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF89</entry> + <entry>KEYPAD TAB</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF8D</entry> + <entry>KEYPAD ENTER</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF91</entry> + <entry>KEYPAD F1, PF1, A</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF92</entry> + <entry>KEYPAD F2, PF2, B</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF93</entry> + <entry>KEYPAD F3, PF3, C</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF94</entry> + <entry>KEYPAD F4, PF4, D</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF95</entry> + <entry>KEYPAD HOME</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF96</entry> + <entry>KEYPAD LEFT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF97</entry> + <entry>KEYPAD UP</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF98</entry> + <entry>KEYPAD RIGHT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF99</entry> + <entry>KEYPAD DOWN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF9A</entry> + <entry>KEYPAD PRIOR, PAGE UP</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF9B</entry> + <entry>KEYPAD NEXT, PAGE DOWN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF9C</entry> + <entry>KEYPAD END</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF9D</entry> + <entry>KEYPAD BEGIN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF9E</entry> + <entry>KEYPAD INSERT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFF9F</entry> + <entry>KEYPAD DELETE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFAA</entry> + <entry>KEYPAD MULTIPLICATION SIGN, ASTERISK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFAB</entry> + <entry>KEYPAD PLUS SIGN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFAC</entry> + <entry>KEYPAD SEPARATOR, COMMA</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFAD</entry> + <entry>KEYPAD MINUS SIGN, HYPHEN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFAE</entry> + <entry>KEYPAD DECIMAL POINT, FULL STOP</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFAF</entry> + <entry>KEYPAD DIVISION SIGN, SOLIDUS</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB0</entry> + <entry>KEYPAD DIGIT ZERO</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB1</entry> + <entry>KEYPAD DIGIT ONE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB2</entry> + <entry>KEYPAD DIGIT TWO</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB3</entry> + <entry>KEYPAD DIGIT THREE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB4</entry> + <entry>KEYPAD DIGIT FOUR</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB5</entry> + <entry>KEYPAD DIGIT FIVE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB6</entry> + <entry>KEYPAD DIGIT SIX</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB7</entry> + <entry>KEYPAD DIGIT SEVEN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB8</entry> + <entry>KEYPAD DIGIT EIGHT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFB9</entry> + <entry>KEYPAD DIGIT NINE</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFBD</entry> + <entry>KEYPAD EQUALS SIGN</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFBE</entry> + <entry>F1</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFBF</entry> + <entry>F2</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC0</entry> + <entry>F3</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC1</entry> + <entry>F4</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC2</entry> + <entry>F5</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC3</entry> + <entry>F6</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC4</entry> + <entry>F7</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC5</entry> + <entry>F8</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC6</entry> + <entry>F9</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC7</entry> + <entry>F10</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC8</entry> + <entry>F11, L1</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFC9</entry> + <entry>F12, L2</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFCA</entry> + <entry>F13, L3</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFCB</entry> + <entry>F14, L4</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFCC</entry> + <entry>F15, L5</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFCD</entry> + <entry>F16, L6</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFCE</entry> + <entry>F17, L7</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFCF</entry> + <entry>F18, L8</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD0</entry> + <entry>F19, L9</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD1</entry> + <entry>F20, L10</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD2</entry> + <entry>F21, R1</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD3</entry> + <entry>F22, R2</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD4</entry> + <entry>F23, R3</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD5</entry> + <entry>F24, R4</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD6</entry> + <entry>F25, R5</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD7</entry> + <entry>F26, R6</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD8</entry> + <entry>F27, R7</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFD9</entry> + <entry>F28, R8</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFDA</entry> + <entry>F29, R9</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFDB</entry> + <entry>F30, R10</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFDC</entry> + <entry>F31, R11</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFDD</entry> + <entry>F32, R12</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFDE</entry> + <entry>F33, R13</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFDF</entry> + <entry>F34, R14</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE0</entry> + <entry>F35, R15</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE1</entry> + <entry>LEFT SHIFT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE2</entry> + <entry>RIGHT SHIFT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE3</entry> + <entry>LEFT CONTROL</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE4</entry> + <entry>RIGHT CONTROL</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE5</entry> + <entry>CAPS LOCK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE6</entry> + <entry>SHIFT LOCK</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE7</entry> + <entry>LEFT META</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE8</entry> + <entry>RIGHT META</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFE9</entry> + <entry>LEFT ALT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFEA</entry> + <entry>RIGHT ALT</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFEB</entry> + <entry>LEFT SUPER</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFEC</entry> + <entry>RIGHT SUPER</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFED</entry> + <entry>LEFT HYPER</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFEE</entry> + <entry>RIGHT HYPER</entry> + <entry>Keyboard</entry> + </row> + <row> + <entry>#xFFFF</entry> + <entry>DELETE, RUBOUT</entry> + <entry>Keyboard</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +The Keyboard (XKB) Extension set, which provides among other things +a range of dead keys, is defined in "The X Keyboard Extension: +Protocol Specification", Appendix C. <!-- xref --> +</para> + +<para> +The 3270 set defines additional keys that are specific to IBM 3270 +terminals. +</para> + +<informaltable frame="topbot"> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*' /> + <colspec colname='c2' colwidth='3.0*' /> + <colspec colname='c3' colwidth='1.0*' /> + <thead> + <row rowsep="1"> + <entry>KEYSYM value</entry> + <entry>Name</entry> + <entry>Set</entry> + </row> + </thead> + <tbody> + <row> + <entry>#xFD01</entry> + <entry>3270 DUPLICATE</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD02</entry> + <entry>3270 FIELDMARK</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD03</entry> + <entry>3270 RIGHT2</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD04</entry> + <entry>3270 LEFT2</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD05</entry> + <entry>3270 BACKTAB</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD06</entry> + <entry>3270 ERASEEOF</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD07</entry> + <entry>3270 ERASEINPUT</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD08</entry> + <entry>3270 RESET</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD09</entry> + <entry>3270 QUIT</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD0A</entry> + <entry>3270 PA1</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD0B</entry> + <entry>3270 PA2</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD0C</entry> + <entry>3270 PA3</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD0D</entry> + <entry>3270 TEST</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD0E</entry> + <entry>3270 ATTN</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD0F</entry> + <entry>3270 CURSORBLINK</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD10</entry> + <entry>3270 ALTCURSOR</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD11</entry> + <entry>3270 KEYCLICK</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD12</entry> + <entry>3270 JUMP</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD13</entry> + <entry>3270 IDENT</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD14</entry> + <entry>3270 RULE</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD15</entry> + <entry>3270 COPY</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD16</entry> + <entry>3270 PLAY</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD17</entry> + <entry>3270 SETUP</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD18</entry> + <entry>3270 RECORD</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD19</entry> + <entry>3270 CHANGESCREEN</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD1A</entry> + <entry>3270 DELETEWORD</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD1B</entry> + <entry>3270 EXSELECT</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD1C</entry> + <entry>3270 CURSORSELECT</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD1D</entry> + <entry>3270 PRINTSCREEN</entry> + <entry>3270</entry> + </row> + <row> + <entry>#xFD1E</entry> + <entry>3270 ENTER</entry> + <entry>3270</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +</sect1> + +<sect1 id='Vendor_KEYSYMs'> +<title>Vendor KEYSYMs</title> + +<para> +The KEYSYM number range #x10000000 to #x1FFFFFFF is available for +vendor-specific extentions. Among these, the range #x11000000 to +#x1100FFFF is designated for keypad KEYSYMs. +</para> +</sect1> + +<sect1 id='Legacy_KEYSYMs'> +<title>Legacy KEYSYMs</title> + +<para> +These date from the time before ISO 10646 / Unicode was +available. They represent characters from a number of different older +8-bit coded character sets and have zero values for bytes 1 and +2. Byte 3 indicates a coded character set and byte 4 is the 8-bit +value of the particular character within that set. +</para> + +<informaltable frame="topbot"> + <tgroup cols='4' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*' /> + <colspec colname='c2' colwidth='2.0*' /> + <colspec colname='c3' colwidth='1.0*' /> + <colspec colname='c4' colwidth='1.0*' /> + <thead> + <row rowsep="1"> + <entry>Byte 3</entry> + <entry>Byte 4</entry> + <entry>Byte 3</entry> + <entry>Byte 4</entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>Latin-2</entry> + <entry>11</entry> + <entry>APL</entry> + </row> + <row> + <entry>2</entry> + <entry>Latin-3</entry> + <entry>12</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>3</entry> + <entry>Latin-4</entry> + <entry>13</entry> + <entry>Thai</entry> + </row> + <row> + <entry>4</entry> + <entry>Kana</entry> + <entry>14</entry> + <entry>Korean</entry> + </row> + <row> + <entry>5</entry> + <entry>Arabic</entry> + <entry>15</entry> + <entry>Latin-5</entry> + </row> + <row> + <entry>6</entry> + <entry>Cyrillic</entry> + <entry>16</entry> + <entry>Latin-6</entry> + </row> + <row> + <entry>7</entry> + <entry>Greek</entry> + <entry>17</entry> + <entry>Latin-7</entry> + </row> + <row> + <entry>8</entry> + <entry>Technical</entry> + <entry>18</entry> + <entry>Latin-8</entry> + </row> + <row> + <entry>9</entry> + <entry>Special</entry> + <entry>19</entry> + <entry>Latin-9</entry> + </row> + <row> + <entry>10</entry> + <entry>Publishing</entry> + <entry>32</entry> + <entry>Currency</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +Each character set contains gaps where codes have been removed that +were duplicates with codes in previous character sets (that is, +character sets with lesser byte 3 value). +</para> + +<para> +The Latin, Arabic, Cyrillic, Greek, Hebrew, and Thai sets were taken +from the early drafts of the relevant ISO 8859 parts available at the +time. However, in the case of the Cyrillic and Greek sets, these +turned out differently in the final versions of the ISO standard. The +Technical, Special, and Publishing sets are based on Digital Equipment +Corporation standards, as no equivalent international standards were +available at the time. +</para> + +<para> +The table below lists all standardized Legacy KEYSYMs, along with the +name used in the source document. Where there exists an unambiguous +equivalent in Unicode, as it is the case with all ISO 8859 characters, +it is given in the second column as a cross reference. Where there is +no Unicode number provided, the exact semantics of the KEYSYM may have +been lost and a Unicode KEYSYM should be used instead, if available. +</para> + +<para> +As support of Unicode KEYSYMs increases, some or all of the Legacy +KEYSYMs may be phased out and withdrawn in future versions of this +standard. Most KEYSYMs in the sets Technical, Special, Publishing, APL +and Currency (with the exception of #x20AC) were probably never used +in practice, and were not supported by pre-Unicode fonts. In +particular, the Currency set, which was copied from Unicode, has +already been deprecated by the introduction of the Unicode KEYSYMs. +</para> + +<informaltable frame="topbot"> + <tgroup cols='4' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*' /> + <colspec colname='c2' colwidth='1.0*' /> + <colspec colname='c3' colwidth='5.0*' /> + <colspec colname='c4' colwidth='1.0*' /> + <thead> + <row rowsep="1"> + <entry>KEYSYM value</entry> + <entry>Unicode value</entry> + <entry>Name</entry> + <entry>Set</entry> + </row> + </thead> + <tbody> + <row> + <entry>#x01A1</entry> + <entry>U+0104</entry> + <entry>LATIN CAPITAL LETTER A WITH OGONEK</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01A2</entry> + <entry>U+02D8</entry> + <entry>BREVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01A3</entry> + <entry>U+0141</entry> + <entry>LATIN CAPITAL LETTER L WITH STROKE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01A5</entry> + <entry>U+013D</entry> + <entry>LATIN CAPITAL LETTER L WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01A6</entry> + <entry>U+015A</entry> + <entry>LATIN CAPITAL LETTER S WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01A9</entry> + <entry>U+0160</entry> + <entry>LATIN CAPITAL LETTER S WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01AA</entry> + <entry>U+015E</entry> + <entry>LATIN CAPITAL LETTER S WITH CEDILLA</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01AB</entry> + <entry>U+0164</entry> + <entry>LATIN CAPITAL LETTER T WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01AC</entry> + <entry>U+0179</entry> + <entry>LATIN CAPITAL LETTER Z WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01AE</entry> + <entry>U+017D</entry> + <entry>LATIN CAPITAL LETTER Z WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01AF</entry> + <entry>U+017B</entry> + <entry>LATIN CAPITAL LETTER Z WITH DOT ABOVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B1</entry> + <entry>U+0105</entry> + <entry>LATIN SMALL LETTER A WITH OGONEK</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B2</entry> + <entry>U+02DB</entry> + <entry>OGONEK</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B3</entry> + <entry>U+0142</entry> + <entry>LATIN SMALL LETTER L WITH STROKE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B5</entry> + <entry>U+013E</entry> + <entry>LATIN SMALL LETTER L WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B6</entry> + <entry>U+015B</entry> + <entry>LATIN SMALL LETTER S WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B7</entry> + <entry>U+02C7</entry> + <entry>CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01B9</entry> + <entry>U+0161</entry> + <entry>LATIN SMALL LETTER S WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01BA</entry> + <entry>U+015F</entry> + <entry>LATIN SMALL LETTER S WITH CEDILLA</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01BB</entry> + <entry>U+0165</entry> + <entry>LATIN SMALL LETTER T WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01BC</entry> + <entry>U+017A</entry> + <entry>LATIN SMALL LETTER Z WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01BD</entry> + <entry>U+02DD</entry> + <entry>DOUBLE ACUTE ACCENT</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01BE</entry> + <entry>U+017E</entry> + <entry>LATIN SMALL LETTER Z WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01BF</entry> + <entry>U+017C</entry> + <entry>LATIN SMALL LETTER Z WITH DOT ABOVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01C0</entry> + <entry>U+0154</entry> + <entry>LATIN CAPITAL LETTER R WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01C3</entry> + <entry>U+0102</entry> + <entry>LATIN CAPITAL LETTER A WITH BREVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01C5</entry> + <entry>U+0139</entry> + <entry>LATIN CAPITAL LETTER L WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01C6</entry> + <entry>U+0106</entry> + <entry>LATIN CAPITAL LETTER C WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01C8</entry> + <entry>U+010C</entry> + <entry>LATIN CAPITAL LETTER C WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01CA</entry> + <entry>U+0118</entry> + <entry>LATIN CAPITAL LETTER E WITH OGONEK</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01CC</entry> + <entry>U+011A</entry> + <entry>LATIN CAPITAL LETTER E WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01CF</entry> + <entry>U+010E</entry> + <entry>LATIN CAPITAL LETTER D WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01D0</entry> + <entry>U+0110</entry> + <entry>LATIN CAPITAL LETTER D WITH STROKE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01D1</entry> + <entry>U+0143</entry> + <entry>LATIN CAPITAL LETTER N WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01D2</entry> + <entry>U+0147</entry> + <entry>LATIN CAPITAL LETTER N WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01D5</entry> + <entry>U+0150</entry> + <entry>LATIN CAPITAL LETTER O WITH DOUBLE ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01D8</entry> + <entry>U+0158</entry> + <entry>LATIN CAPITAL LETTER R WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01D9</entry> + <entry>U+016E</entry> + <entry>LATIN CAPITAL LETTER U WITH RING ABOVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01DB</entry> + <entry>U+0170</entry> + <entry>LATIN CAPITAL LETTER U WITH DOUBLE ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01DE</entry> + <entry>U+0162</entry> + <entry>LATIN CAPITAL LETTER T WITH CEDILLA</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01E0</entry> + <entry>U+0155</entry> + <entry>LATIN SMALL LETTER R WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01E3</entry> + <entry>U+0103</entry> + <entry>LATIN SMALL LETTER A WITH BREVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01E5</entry> + <entry>U+013A</entry> + <entry>LATIN SMALL LETTER L WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01E6</entry> + <entry>U+0107</entry> + <entry>LATIN SMALL LETTER C WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01E8</entry> + <entry>U+010D</entry> + <entry>LATIN SMALL LETTER C WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01EA</entry> + <entry>U+0119</entry> + <entry>LATIN SMALL LETTER E WITH OGONEK</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01EC</entry> + <entry>U+011B</entry> + <entry>LATIN SMALL LETTER E WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01EF</entry> + <entry>U+010F</entry> + <entry>LATIN SMALL LETTER D WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01F0</entry> + <entry>U+0111</entry> + <entry>LATIN SMALL LETTER D WITH STROKE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01F1</entry> + <entry>U+0144</entry> + <entry>LATIN SMALL LETTER N WITH ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01F2</entry> + <entry>U+0148</entry> + <entry>LATIN SMALL LETTER N WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01F5</entry> + <entry>U+0151</entry> + <entry>LATIN SMALL LETTER O WITH DOUBLE ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01F8</entry> + <entry>U+0159</entry> + <entry>LATIN SMALL LETTER R WITH CARON</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01F9</entry> + <entry>U+016F</entry> + <entry>LATIN SMALL LETTER U WITH RING ABOVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01FB</entry> + <entry>U+0171</entry> + <entry>LATIN SMALL LETTER U WITH DOUBLE ACUTE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01FE</entry> + <entry>U+0163</entry> + <entry>LATIN SMALL LETTER T WITH CEDILLA</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x01FF</entry> + <entry>U+02D9</entry> + <entry>DOT ABOVE</entry> + <entry>Latin-2</entry> + </row> + <row> + <entry>#x02A1</entry> + <entry>U+0126</entry> + <entry>LATIN CAPITAL LETTER H WITH STROKE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02A6</entry> + <entry>U+0124</entry> + <entry>LATIN CAPITAL LETTER H WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02A9</entry> + <entry>U+0130</entry> + <entry>LATIN CAPITAL LETTER I WITH DOT ABOVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02AB</entry> + <entry>U+011E</entry> + <entry>LATIN CAPITAL LETTER G WITH BREVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02AC</entry> + <entry>U+0134</entry> + <entry>LATIN CAPITAL LETTER J WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02B1</entry> + <entry>U+0127</entry> + <entry>LATIN SMALL LETTER H WITH STROKE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02B6</entry> + <entry>U+0125</entry> + <entry>LATIN SMALL LETTER H WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02B9</entry> + <entry>U+0131</entry> + <entry>LATIN SMALL LETTER DOTLESS I</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02BB</entry> + <entry>U+011F</entry> + <entry>LATIN SMALL LETTER G WITH BREVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02BC</entry> + <entry>U+0135</entry> + <entry>LATIN SMALL LETTER J WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02C5</entry> + <entry>U+010A</entry> + <entry>LATIN CAPITAL LETTER C WITH DOT ABOVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02C6</entry> + <entry>U+0108</entry> + <entry>LATIN CAPITAL LETTER C WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02D5</entry> + <entry>U+0120</entry> + <entry>LATIN CAPITAL LETTER G WITH DOT ABOVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02D8</entry> + <entry>U+011C</entry> + <entry>LATIN CAPITAL LETTER G WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02DD</entry> + <entry>U+016C</entry> + <entry>LATIN CAPITAL LETTER U WITH BREVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02DE</entry> + <entry>U+015C</entry> + <entry>LATIN CAPITAL LETTER S WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02E5</entry> + <entry>U+010B</entry> + <entry>LATIN SMALL LETTER C WITH DOT ABOVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02E6</entry> + <entry>U+0109</entry> + <entry>LATIN SMALL LETTER C WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02F5</entry> + <entry>U+0121</entry> + <entry>LATIN SMALL LETTER G WITH DOT ABOVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02F8</entry> + <entry>U+011D</entry> + <entry>LATIN SMALL LETTER G WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02FD</entry> + <entry>U+016D</entry> + <entry>LATIN SMALL LETTER U WITH BREVE</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x02FE</entry> + <entry>U+015D</entry> + <entry>LATIN SMALL LETTER S WITH CIRCUMFLEX</entry> + <entry>Latin-3</entry> + </row> + <row> + <entry>#x03A2</entry> + <entry>U+0138</entry> + <entry>LATIN SMALL LETTER KRA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03A3</entry> + <entry>U+0156</entry> + <entry>LATIN CAPITAL LETTER R WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03A5</entry> + <entry>U+0128</entry> + <entry>LATIN CAPITAL LETTER I WITH TILDE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03A6</entry> + <entry>U+013B</entry> + <entry>LATIN CAPITAL LETTER L WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03AA</entry> + <entry>U+0112</entry> + <entry>LATIN CAPITAL LETTER E WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03AB</entry> + <entry>U+0122</entry> + <entry>LATIN CAPITAL LETTER G WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03AC</entry> + <entry>U+0166</entry> + <entry>LATIN CAPITAL LETTER T WITH STROKE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03B3</entry> + <entry>U+0157</entry> + <entry>LATIN SMALL LETTER R WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03B5</entry> + <entry>U+0129</entry> + <entry>LATIN SMALL LETTER I WITH TILDE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03B6</entry> + <entry>U+013C</entry> + <entry>LATIN SMALL LETTER L WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03BA</entry> + <entry>U+0113</entry> + <entry>LATIN SMALL LETTER E WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03BB</entry> + <entry>U+0123</entry> + <entry>LATIN SMALL LETTER G WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03BC</entry> + <entry>U+0167</entry> + <entry>LATIN SMALL LETTER T WITH STROKE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03BD</entry> + <entry>U+014A</entry> + <entry>LATIN CAPITAL LETTER ENG</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03BF</entry> + <entry>U+014B</entry> + <entry>LATIN SMALL LETTER ENG</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03C0</entry> + <entry>U+0100</entry> + <entry>LATIN CAPITAL LETTER A WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03C7</entry> + <entry>U+012E</entry> + <entry>LATIN CAPITAL LETTER I WITH OGONEK</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03CC</entry> + <entry>U+0116</entry> + <entry>LATIN CAPITAL LETTER E WITH DOT ABOVE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03CF</entry> + <entry>U+012A</entry> + <entry>LATIN CAPITAL LETTER I WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03D1</entry> + <entry>U+0145</entry> + <entry>LATIN CAPITAL LETTER N WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03D2</entry> + <entry>U+014C</entry> + <entry>LATIN CAPITAL LETTER O WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03D3</entry> + <entry>U+0136</entry> + <entry>LATIN CAPITAL LETTER K WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03D9</entry> + <entry>U+0172</entry> + <entry>LATIN CAPITAL LETTER U WITH OGONEK</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03DD</entry> + <entry>U+0168</entry> + <entry>LATIN CAPITAL LETTER U WITH TILDE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03DE</entry> + <entry>U+016A</entry> + <entry>LATIN CAPITAL LETTER U WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03E0</entry> + <entry>U+0101</entry> + <entry>LATIN SMALL LETTER A WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03E7</entry> + <entry>U+012F</entry> + <entry>LATIN SMALL LETTER I WITH OGONEK</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03EC</entry> + <entry>U+0117</entry> + <entry>LATIN SMALL LETTER E WITH DOT ABOVE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03EF</entry> + <entry>U+012B</entry> + <entry>LATIN SMALL LETTER I WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03F1</entry> + <entry>U+0146</entry> + <entry>LATIN SMALL LETTER N WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03F2</entry> + <entry>U+014D</entry> + <entry>LATIN SMALL LETTER O WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03F3</entry> + <entry>U+0137</entry> + <entry>LATIN SMALL LETTER K WITH CEDILLA</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03F9</entry> + <entry>U+0173</entry> + <entry>LATIN SMALL LETTER U WITH OGONEK</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03FD</entry> + <entry>U+0169</entry> + <entry>LATIN SMALL LETTER U WITH TILDE</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x03FE</entry> + <entry>U+016B</entry> + <entry>LATIN SMALL LETTER U WITH MACRON</entry> + <entry>Latin-4</entry> + </row> + <row> + <entry>#x047E</entry> + <entry>U+203E</entry> + <entry>OVERLINE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A1</entry> + <entry>U+3002</entry> + <entry>KANA FULL STOP</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A2</entry> + <entry>U+300C</entry> + <entry>KANA OPENING BRACKET</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A3</entry> + <entry>U+300D</entry> + <entry>KANA CLOSING BRACKET</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A4</entry> + <entry>U+3001</entry> + <entry>KANA COMMA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A5</entry> + <entry>U+30FB</entry> + <entry>KANA CONJUNCTIVE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A6</entry> + <entry>U+30F2</entry> + <entry>KANA LETTER WO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A7</entry> + <entry>U+30A1</entry> + <entry>KANA LETTER SMALL A</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A8</entry> + <entry>U+30A3</entry> + <entry>KANA LETTER SMALL I</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04A9</entry> + <entry>U+30A5</entry> + <entry>KANA LETTER SMALL U</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04AA</entry> + <entry>U+30A7</entry> + <entry>KANA LETTER SMALL E</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04AB</entry> + <entry>U+30A9</entry> + <entry>KANA LETTER SMALL O</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04AC</entry> + <entry>U+30E3</entry> + <entry>KANA LETTER SMALL YA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04AD</entry> + <entry>U+30E5</entry> + <entry>KANA LETTER SMALL YU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04AE</entry> + <entry>U+30E7</entry> + <entry>KANA LETTER SMALL YO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04AF</entry> + <entry>U+30C3</entry> + <entry>KANA LETTER SMALL TSU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B0</entry> + <entry>U+30FC</entry> + <entry>PROLONGED SOUND SYMBOL</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B1</entry> + <entry>U+30A2</entry> + <entry>KANA LETTER A</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B2</entry> + <entry>U+30A4</entry> + <entry>KANA LETTER I</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B3</entry> + <entry>U+30A6</entry> + <entry>KANA LETTER U</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B4</entry> + <entry>U+30A8</entry> + <entry>KANA LETTER E</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B5</entry> + <entry>U+30AA</entry> + <entry>KANA LETTER O</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B6</entry> + <entry>U+30AB</entry> + <entry>KANA LETTER KA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B7</entry> + <entry>U+30AD</entry> + <entry>KANA LETTER KI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B8</entry> + <entry>U+30AF</entry> + <entry>KANA LETTER KU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04B9</entry> + <entry>U+30B1</entry> + <entry>KANA LETTER KE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04BA</entry> + <entry>U+30B3</entry> + <entry>KANA LETTER KO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04BB</entry> + <entry>U+30B5</entry> + <entry>KANA LETTER SA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04BC</entry> + <entry>U+30B7</entry> + <entry>KANA LETTER SHI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04BD</entry> + <entry>U+30B9</entry> + <entry>KANA LETTER SU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04BE</entry> + <entry>U+30BB</entry> + <entry>KANA LETTER SE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04BF</entry> + <entry>U+30BD</entry> + <entry>KANA LETTER SO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C0</entry> + <entry>U+30BF</entry> + <entry>KANA LETTER TA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C1</entry> + <entry>U+30C1</entry> + <entry>KANA LETTER CHI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C2</entry> + <entry>U+30C4</entry> + <entry>KANA LETTER TSU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C3</entry> + <entry>U+30C6</entry> + <entry>KANA LETTER TE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C4</entry> + <entry>U+30C8</entry> + <entry>KANA LETTER TO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C5</entry> + <entry>U+30CA</entry> + <entry>KANA LETTER NA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C6</entry> + <entry>U+30CB</entry> + <entry>KANA LETTER NI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C7</entry> + <entry>U+30CC</entry> + <entry>KANA LETTER NU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C8</entry> + <entry>U+30CD</entry> + <entry>KANA LETTER NE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04C9</entry> + <entry>U+30CE</entry> + <entry>KANA LETTER NO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04CA</entry> + <entry>U+30CF</entry> + <entry>KANA LETTER HA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04CB</entry> + <entry>U+30D2</entry> + <entry>KANA LETTER HI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04CC</entry> + <entry>U+30D5</entry> + <entry>KANA LETTER FU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04CD</entry> + <entry>U+30D8</entry> + <entry>KANA LETTER HE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04CE</entry> + <entry>U+30DB</entry> + <entry>KANA LETTER HO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04CF</entry> + <entry>U+30DE</entry> + <entry>KANA LETTER MA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D0</entry> + <entry>U+30DF</entry> + <entry>KANA LETTER MI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D1</entry> + <entry>U+30E0</entry> + <entry>KANA LETTER MU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D2</entry> + <entry>U+30E1</entry> + <entry>KANA LETTER ME</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D3</entry> + <entry>U+30E2</entry> + <entry>KANA LETTER MO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D4</entry> + <entry>U+30E4</entry> + <entry>KANA LETTER YA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D5</entry> + <entry>U+30E6</entry> + <entry>KANA LETTER YU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D6</entry> + <entry>U+30E8</entry> + <entry>KANA LETTER YO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D7</entry> + <entry>U+30E9</entry> + <entry>KANA LETTER RA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D8</entry> + <entry>U+30EA</entry> + <entry>KANA LETTER RI</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04D9</entry> + <entry>U+30EB</entry> + <entry>KANA LETTER RU</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04DA</entry> + <entry>U+30EC</entry> + <entry>KANA LETTER RE</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04DB</entry> + <entry>U+30ED</entry> + <entry>KANA LETTER RO</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04DC</entry> + <entry>U+30EF</entry> + <entry>KANA LETTER WA</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04DD</entry> + <entry>U+30F3</entry> + <entry>KANA LETTER N</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04DE</entry> + <entry>U+309B</entry> + <entry>VOICED SOUND SYMBOL</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x04DF</entry> + <entry>U+309C</entry> + <entry>SEMIVOICED SOUND SYMBOL</entry> + <entry>Kana</entry> + </row> + <row> + <entry>#x05AC</entry> + <entry>U+060C</entry> + <entry>ARABIC COMMA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05BB</entry> + <entry>U+061B</entry> + <entry>ARABIC SEMICOLON</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05BF</entry> + <entry>U+061F</entry> + <entry>ARABIC QUESTION MARK</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C1</entry> + <entry>U+0621</entry> + <entry>ARABIC LETTER HAMZA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C2</entry> + <entry>U+0622</entry> + <entry>ARABIC LETTER ALEF WITH MADDA ABOVE</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C3</entry> + <entry>U+0623</entry> + <entry>ARABIC LETTER ALEF WITH HAMZA ABOVE</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C4</entry> + <entry>U+0624</entry> + <entry>ARABIC LETTER WAW WITH HAMZA ABOVE</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C5</entry> + <entry>U+0625</entry> + <entry>ARABIC LETTER ALEF WITH HAMZA BELOW</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C6</entry> + <entry>U+0626</entry> + <entry>ARABIC LETTER YEH WITH HAMZA ABOVE</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C7</entry> + <entry>U+0627</entry> + <entry>ARABIC LETTER ALEF</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C8</entry> + <entry>U+0628</entry> + <entry>ARABIC LETTER BEH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05C9</entry> + <entry>U+0629</entry> + <entry>ARABIC LETTER TEH MARBUTA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05CA</entry> + <entry>U+062A</entry> + <entry>ARABIC LETTER TEH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05CB</entry> + <entry>U+062B</entry> + <entry>ARABIC LETTER THEH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05CC</entry> + <entry>U+062C</entry> + <entry>ARABIC LETTER JEEM</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05CD</entry> + <entry>U+062D</entry> + <entry>ARABIC LETTER HAH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05CE</entry> + <entry>U+062E</entry> + <entry>ARABIC LETTER KHAH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05CF</entry> + <entry>U+062F</entry> + <entry>ARABIC LETTER DAL</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D0</entry> + <entry>U+0630</entry> + <entry>ARABIC LETTER THAL</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D1</entry> + <entry>U+0631</entry> + <entry>ARABIC LETTER REH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D2</entry> + <entry>U+0632</entry> + <entry>ARABIC LETTER ZAIN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D3</entry> + <entry>U+0633</entry> + <entry>ARABIC LETTER SEEN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D4</entry> + <entry>U+0634</entry> + <entry>ARABIC LETTER SHEEN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D5</entry> + <entry>U+0635</entry> + <entry>ARABIC LETTER SAD</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D6</entry> + <entry>U+0636</entry> + <entry>ARABIC LETTER DAD</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D7</entry> + <entry>U+0637</entry> + <entry>ARABIC LETTER TAH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D8</entry> + <entry>U+0638</entry> + <entry>ARABIC LETTER ZAH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05D9</entry> + <entry>U+0639</entry> + <entry>ARABIC LETTER AIN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05DA</entry> + <entry>U+063A</entry> + <entry>ARABIC LETTER GHAIN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E0</entry> + <entry>U+0640</entry> + <entry>ARABIC TATWEEL</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E1</entry> + <entry>U+0641</entry> + <entry>ARABIC LETTER FEH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E2</entry> + <entry>U+0642</entry> + <entry>ARABIC LETTER QAF</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E3</entry> + <entry>U+0643</entry> + <entry>ARABIC LETTER KAF</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E4</entry> + <entry>U+0644</entry> + <entry>ARABIC LETTER LAM</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E5</entry> + <entry>U+0645</entry> + <entry>ARABIC LETTER MEEM</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E6</entry> + <entry>U+0646</entry> + <entry>ARABIC LETTER NOON</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E7</entry> + <entry>U+0647</entry> + <entry>ARABIC LETTER HEH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E8</entry> + <entry>U+0648</entry> + <entry>ARABIC LETTER WAW</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05E9</entry> + <entry>U+0649</entry> + <entry>ARABIC LETTER ALEF MAKSURA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05EA</entry> + <entry>U+064A</entry> + <entry>ARABIC LETTER YEH</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05EB</entry> + <entry>U+064B</entry> + <entry>ARABIC FATHATAN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05EC</entry> + <entry>U+064C</entry> + <entry>ARABIC DAMMATAN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05ED</entry> + <entry>U+064D</entry> + <entry>ARABIC KASRATAN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05EE</entry> + <entry>U+064E</entry> + <entry>ARABIC FATHA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05EF</entry> + <entry>U+064F</entry> + <entry>ARABIC DAMMA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05F0</entry> + <entry>U+0650</entry> + <entry>ARABIC KASRA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05F1</entry> + <entry>U+0651</entry> + <entry>ARABIC SHADDA</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x05F2</entry> + <entry>U+0652</entry> + <entry>ARABIC SUKUN</entry> + <entry>Arabic</entry> + </row> + <row> + <entry>#x06A1</entry> + <entry>U+0452</entry> + <entry>CYRILLIC SMALL LETTER DJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A2</entry> + <entry>U+0453</entry> + <entry>CYRILLIC SMALL LETTER GJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A3</entry> + <entry>U+0451</entry> + <entry>CYRILLIC SMALL LETTER IO</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A4</entry> + <entry>U+0454</entry> + <entry>CYRILLIC SMALL LETTER UKRAINIAN IE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A5</entry> + <entry>U+0455</entry> + <entry>CYRILLIC SMALL LETTER DZE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A6</entry> + <entry>U+0456</entry> + <entry>CYRILLIC SMALL LETTER BYELORUSSIAN-UKRAINIAN I</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A7</entry> + <entry>U+0457</entry> + <entry>CYRILLIC SMALL LETTER YI</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A8</entry> + <entry>U+0458</entry> + <entry>CYRILLIC SMALL LETTER JE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06A9</entry> + <entry>U+0459</entry> + <entry>CYRILLIC SMALL LETTER LJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06AA</entry> + <entry>U+045A</entry> + <entry>CYRILLIC SMALL LETTER NJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06AB</entry> + <entry>U+045B</entry> + <entry>CYRILLIC SMALL LETTER TSHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06AC</entry> + <entry>U+045C</entry> + <entry>CYRILLIC SMALL LETTER KJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06AD</entry> + <entry>U+0491</entry> + <entry>CYRILLIC SMALL LETTER GHE WITH UPTURN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06AE</entry> + <entry>U+045E</entry> + <entry>CYRILLIC SMALL LETTER SHORT U</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06AF</entry> + <entry>U+045F</entry> + <entry>CYRILLIC SMALL LETTER DZHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B0</entry> + <entry>U+2116</entry> + <entry>NUMERO SIGN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B1</entry> + <entry>U+0402</entry> + <entry>CYRILLIC CAPITAL LETTER DJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B2</entry> + <entry>U+0403</entry> + <entry>CYRILLIC CAPITAL LETTER GJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B3</entry> + <entry>U+0401</entry> + <entry>CYRILLIC CAPITAL LETTER IO</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B4</entry> + <entry>U+0404</entry> + <entry>CYRILLIC CAPITAL LETTER UKRAINIAN IE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B5</entry> + <entry>U+0405</entry> + <entry>CYRILLIC CAPITAL LETTER DZE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B6</entry> + <entry>U+0406</entry> + <entry>CYRILLIC CAPITAL LETTER BYELORUSSIAN-UKRAINIAN I</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B7</entry> + <entry>U+0407</entry> + <entry>CYRILLIC CAPITAL LETTER YI</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B8</entry> + <entry>U+0408</entry> + <entry>CYRILLIC CAPITAL LETTER JE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06B9</entry> + <entry>U+0409</entry> + <entry>CYRILLIC CAPITAL LETTER LJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06BA</entry> + <entry>U+040A</entry> + <entry>CYRILLIC CAPITAL LETTER NJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06BB</entry> + <entry>U+040B</entry> + <entry>CYRILLIC CAPITAL LETTER TSHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06BC</entry> + <entry>U+040C</entry> + <entry>CYRILLIC CAPITAL LETTER KJE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06BD</entry> + <entry>U+0490</entry> + <entry>CYRILLIC CAPITAL LETTER GHE WITH UPTURN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06BE</entry> + <entry>U+040E</entry> + <entry>CYRILLIC CAPITAL LETTER SHORT U</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06BF</entry> + <entry>U+040F</entry> + <entry>CYRILLIC CAPITAL LETTER DZHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C0</entry> + <entry>U+044E</entry> + <entry>CYRILLIC SMALL LETTER YU</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C1</entry> + <entry>U+0430</entry> + <entry>CYRILLIC SMALL LETTER A</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C2</entry> + <entry>U+0431</entry> + <entry>CYRILLIC SMALL LETTER BE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C3</entry> + <entry>U+0446</entry> + <entry>CYRILLIC SMALL LETTER TSE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C4</entry> + <entry>U+0434</entry> + <entry>CYRILLIC SMALL LETTER DE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C5</entry> + <entry>U+0435</entry> + <entry>CYRILLIC SMALL LETTER IE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C6</entry> + <entry>U+0444</entry> + <entry>CYRILLIC SMALL LETTER EF</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C7</entry> + <entry>U+0433</entry> + <entry>CYRILLIC SMALL LETTER GHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C8</entry> + <entry>U+0445</entry> + <entry>CYRILLIC SMALL LETTER HA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06C9</entry> + <entry>U+0438</entry> + <entry>CYRILLIC SMALL LETTER I</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06CA</entry> + <entry>U+0439</entry> + <entry>CYRILLIC SMALL LETTER SHORT I</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06CB</entry> + <entry>U+043A</entry> + <entry>CYRILLIC SMALL LETTER KA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06CC</entry> + <entry>U+043B</entry> + <entry>CYRILLIC SMALL LETTER EL</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06CD</entry> + <entry>U+043C</entry> + <entry>CYRILLIC SMALL LETTER EM</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06CE</entry> + <entry>U+043D</entry> + <entry>CYRILLIC SMALL LETTER EN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06CF</entry> + <entry>U+043E</entry> + <entry>CYRILLIC SMALL LETTER O</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D0</entry> + <entry>U+043F</entry> + <entry>CYRILLIC SMALL LETTER PE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D1</entry> + <entry>U+044F</entry> + <entry>CYRILLIC SMALL LETTER YA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D2</entry> + <entry>U+0440</entry> + <entry>CYRILLIC SMALL LETTER ER</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D3</entry> + <entry>U+0441</entry> + <entry>CYRILLIC SMALL LETTER ES</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D4</entry> + <entry>U+0442</entry> + <entry>CYRILLIC SMALL LETTER TE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D5</entry> + <entry>U+0443</entry> + <entry>CYRILLIC SMALL LETTER U</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D6</entry> + <entry>U+0436</entry> + <entry>CYRILLIC SMALL LETTER ZHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D7</entry> + <entry>U+0432</entry> + <entry>CYRILLIC SMALL LETTER VE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D8</entry> + <entry>U+044C</entry> + <entry>CYRILLIC SMALL LETTER SOFT SIGN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06D9</entry> + <entry>U+044B</entry> + <entry>CYRILLIC SMALL LETTER YERU</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06DA</entry> + <entry>U+0437</entry> + <entry>CYRILLIC SMALL LETTER ZE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06DB</entry> + <entry>U+0448</entry> + <entry>CYRILLIC SMALL LETTER SHA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06DC</entry> + <entry>U+044D</entry> + <entry>CYRILLIC SMALL LETTER E</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06DD</entry> + <entry>U+0449</entry> + <entry>CYRILLIC SMALL LETTER SHCHA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06DE</entry> + <entry>U+0447</entry> + <entry>CYRILLIC SMALL LETTER CHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06DF</entry> + <entry>U+044A</entry> + <entry>CYRILLIC SMALL LETTER HARD SIGN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E0</entry> + <entry>U+042E</entry> + <entry>CYRILLIC CAPITAL LETTER YU</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E1</entry> + <entry>U+0410</entry> + <entry>CYRILLIC CAPITAL LETTER A</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E2</entry> + <entry>U+0411</entry> + <entry>CYRILLIC CAPITAL LETTER BE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E3</entry> + <entry>U+0426</entry> + <entry>CYRILLIC CAPITAL LETTER TSE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E4</entry> + <entry>U+0414</entry> + <entry>CYRILLIC CAPITAL LETTER DE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E5</entry> + <entry>U+0415</entry> + <entry>CYRILLIC CAPITAL LETTER IE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E6</entry> + <entry>U+0424</entry> + <entry>CYRILLIC CAPITAL LETTER EF</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E7</entry> + <entry>U+0413</entry> + <entry>CYRILLIC CAPITAL LETTER GHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E8</entry> + <entry>U+0425</entry> + <entry>CYRILLIC CAPITAL LETTER HA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06E9</entry> + <entry>U+0418</entry> + <entry>CYRILLIC CAPITAL LETTER I</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06EA</entry> + <entry>U+0419</entry> + <entry>CYRILLIC CAPITAL LETTER SHORT I</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06EB</entry> + <entry>U+041A</entry> + <entry>CYRILLIC CAPITAL LETTER KA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06EC</entry> + <entry>U+041B</entry> + <entry>CYRILLIC CAPITAL LETTER EL</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06ED</entry> + <entry>U+041C</entry> + <entry>CYRILLIC CAPITAL LETTER EM</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06EE</entry> + <entry>U+041D</entry> + <entry>CYRILLIC CAPITAL LETTER EN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06EF</entry> + <entry>U+041E</entry> + <entry>CYRILLIC CAPITAL LETTER O</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F0</entry> + <entry>U+041F</entry> + <entry>CYRILLIC CAPITAL LETTER PE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F1</entry> + <entry>U+042F</entry> + <entry>CYRILLIC CAPITAL LETTER YA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F2</entry> + <entry>U+0420</entry> + <entry>CYRILLIC CAPITAL LETTER ER</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F3</entry> + <entry>U+0421</entry> + <entry>CYRILLIC CAPITAL LETTER ES</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F4</entry> + <entry>U+0422</entry> + <entry>CYRILLIC CAPITAL LETTER TE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F5</entry> + <entry>U+0423</entry> + <entry>CYRILLIC CAPITAL LETTER U</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F6</entry> + <entry>U+0416</entry> + <entry>CYRILLIC CAPITAL LETTER ZHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F7</entry> + <entry>U+0412</entry> + <entry>CYRILLIC CAPITAL LETTER VE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F8</entry> + <entry>U+042C</entry> + <entry>CYRILLIC CAPITAL LETTER SOFT SIGN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06F9</entry> + <entry>U+042B</entry> + <entry>CYRILLIC CAPITAL LETTER YERU</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06FA</entry> + <entry>U+0417</entry> + <entry>CYRILLIC CAPITAL LETTER ZE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06FB</entry> + <entry>U+0428</entry> + <entry>CYRILLIC CAPITAL LETTER SHA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06FC</entry> + <entry>U+042D</entry> + <entry>CYRILLIC CAPITAL LETTER E</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06FD</entry> + <entry>U+0429</entry> + <entry>CYRILLIC CAPITAL LETTER SHCHA</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06FE</entry> + <entry>U+0427</entry> + <entry>CYRILLIC CAPITAL LETTER CHE</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x06FF</entry> + <entry>U+042A</entry> + <entry>CYRILLIC CAPITAL LETTER HARD SIGN</entry> + <entry>Cyrillic</entry> + </row> + <row> + <entry>#x07A1</entry> + <entry>U+0386</entry> + <entry>GREEK CAPITAL LETTER ALPHA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A2</entry> + <entry>U+0388</entry> + <entry>GREEK CAPITAL LETTER EPSILON WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A3</entry> + <entry>U+0389</entry> + <entry>GREEK CAPITAL LETTER ETA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A4</entry> + <entry>U+038A</entry> + <entry>GREEK CAPITAL LETTER IOTA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A5</entry> + <entry>U+03AA</entry> + <entry>GREEK CAPITAL LETTER IOTA WITH DIALYTIKA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A7</entry> + <entry>U+038C</entry> + <entry>GREEK CAPITAL LETTER OMICRON WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A8</entry> + <entry>U+038E</entry> + <entry>GREEK CAPITAL LETTER UPSILON WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07A9</entry> + <entry>U+03AB</entry> + <entry>GREEK CAPITAL LETTER UPSILON WITH DIALYTIKA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07AB</entry> + <entry>U+038F</entry> + <entry>GREEK CAPITAL LETTER OMEGA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07AE</entry> + <entry>U+0385</entry> + <entry>GREEK DIALYTIKA TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07AF</entry> + <entry>U+2015</entry> + <entry>HORIZONTAL BAR</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B1</entry> + <entry>U+03AC</entry> + <entry>GREEK SMALL LETTER ALPHA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B2</entry> + <entry>U+03AD</entry> + <entry>GREEK SMALL LETTER EPSILON WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B3</entry> + <entry>U+03AE</entry> + <entry>GREEK SMALL LETTER ETA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B4</entry> + <entry>U+03AF</entry> + <entry>GREEK SMALL LETTER IOTA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B5</entry> + <entry>U+03CA</entry> + <entry>GREEK SMALL LETTER IOTA WITH DIALYTIKA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B6</entry> + <entry>U+0390</entry> + <entry>GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B7</entry> + <entry>U+03CC</entry> + <entry>GREEK SMALL LETTER OMICRON WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B8</entry> + <entry>U+03CD</entry> + <entry>GREEK SMALL LETTER UPSILON WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07B9</entry> + <entry>U+03CB</entry> + <entry>GREEK SMALL LETTER UPSILON WITH DIALYTIKA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07BA</entry> + <entry>U+03B0</entry> + <entry>GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07BB</entry> + <entry>U+03CE</entry> + <entry>GREEK SMALL LETTER OMEGA WITH TONOS</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C1</entry> + <entry>U+0391</entry> + <entry>GREEK CAPITAL LETTER ALPHA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C2</entry> + <entry>U+0392</entry> + <entry>GREEK CAPITAL LETTER BETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C3</entry> + <entry>U+0393</entry> + <entry>GREEK CAPITAL LETTER GAMMA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C4</entry> + <entry>U+0394</entry> + <entry>GREEK CAPITAL LETTER DELTA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C5</entry> + <entry>U+0395</entry> + <entry>GREEK CAPITAL LETTER EPSILON</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C6</entry> + <entry>U+0396</entry> + <entry>GREEK CAPITAL LETTER ZETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C7</entry> + <entry>U+0397</entry> + <entry>GREEK CAPITAL LETTER ETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C8</entry> + <entry>U+0398</entry> + <entry>GREEK CAPITAL LETTER THETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07C9</entry> + <entry>U+0399</entry> + <entry>GREEK CAPITAL LETTER IOTA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07CA</entry> + <entry>U+039A</entry> + <entry>GREEK CAPITAL LETTER KAPPA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07CB</entry> + <entry>U+039B</entry> + <entry>GREEK CAPITAL LETTER LAMDA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07CC</entry> + <entry>U+039C</entry> + <entry>GREEK CAPITAL LETTER MU</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07CD</entry> + <entry>U+039D</entry> + <entry>GREEK CAPITAL LETTER NU</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07CE</entry> + <entry>U+039E</entry> + <entry>GREEK CAPITAL LETTER XI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07CF</entry> + <entry>U+039F</entry> + <entry>GREEK CAPITAL LETTER OMICRON</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D0</entry> + <entry>U+03A0</entry> + <entry>GREEK CAPITAL LETTER PI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D1</entry> + <entry>U+03A1</entry> + <entry>GREEK CAPITAL LETTER RHO</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D2</entry> + <entry>U+03A3</entry> + <entry>GREEK CAPITAL LETTER SIGMA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D4</entry> + <entry>U+03A4</entry> + <entry>GREEK CAPITAL LETTER TAU</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D5</entry> + <entry>U+03A5</entry> + <entry>GREEK CAPITAL LETTER UPSILON</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D6</entry> + <entry>U+03A6</entry> + <entry>GREEK CAPITAL LETTER PHI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D7</entry> + <entry>U+03A7</entry> + <entry>GREEK CAPITAL LETTER CHI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D8</entry> + <entry>U+03A8</entry> + <entry>GREEK CAPITAL LETTER PSI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07D9</entry> + <entry>U+03A9</entry> + <entry>GREEK CAPITAL LETTER OMEGA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E1</entry> + <entry>U+03B1</entry> + <entry>GREEK SMALL LETTER ALPHA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E2</entry> + <entry>U+03B2</entry> + <entry>GREEK SMALL LETTER BETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E3</entry> + <entry>U+03B3</entry> + <entry>GREEK SMALL LETTER GAMMA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E4</entry> + <entry>U+03B4</entry> + <entry>GREEK SMALL LETTER DELTA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E5</entry> + <entry>U+03B5</entry> + <entry>GREEK SMALL LETTER EPSILON</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E6</entry> + <entry>U+03B6</entry> + <entry>GREEK SMALL LETTER ZETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E7</entry> + <entry>U+03B7</entry> + <entry>GREEK SMALL LETTER ETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E8</entry> + <entry>U+03B8</entry> + <entry>GREEK SMALL LETTER THETA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07E9</entry> + <entry>U+03B9</entry> + <entry>GREEK SMALL LETTER IOTA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07EA</entry> + <entry>U+03BA</entry> + <entry>GREEK SMALL LETTER KAPPA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07EB</entry> + <entry>U+03BB</entry> + <entry>GREEK SMALL LETTER LAMDA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07EC</entry> + <entry>U+03BC</entry> + <entry>GREEK SMALL LETTER MU</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07ED</entry> + <entry>U+03BD</entry> + <entry>GREEK SMALL LETTER NU</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07EE</entry> + <entry>U+03BE</entry> + <entry>GREEK SMALL LETTER XI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07EF</entry> + <entry>U+03BF</entry> + <entry>GREEK SMALL LETTER OMICRON</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F0</entry> + <entry>U+03C0</entry> + <entry>GREEK SMALL LETTER PI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F1</entry> + <entry>U+03C1</entry> + <entry>GREEK SMALL LETTER RHO</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F2</entry> + <entry>U+03C3</entry> + <entry>GREEK SMALL LETTER SIGMA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F3</entry> + <entry>U+03C2</entry> + <entry>GREEK SMALL LETTER FINAL SIGMA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F4</entry> + <entry>U+03C4</entry> + <entry>GREEK SMALL LETTER TAU</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F5</entry> + <entry>U+03C5</entry> + <entry>GREEK SMALL LETTER UPSILON</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F6</entry> + <entry>U+03C6</entry> + <entry>GREEK SMALL LETTER PHI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F7</entry> + <entry>U+03C7</entry> + <entry>GREEK SMALL LETTER CHI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F8</entry> + <entry>U+03C8</entry> + <entry>GREEK SMALL LETTER PSI</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x07F9</entry> + <entry>U+03C9</entry> + <entry>GREEK SMALL LETTER OMEGA</entry> + <entry>Greek</entry> + </row> + <row> + <entry>#x08A1</entry> + <entry>U+23B7</entry> + <entry>LEFT RADICAL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A2</entry> + <entry>-</entry> + <entry>TOP LEFT RADICAL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A3</entry> + <entry>-</entry> + <entry>HORIZONTAL CONNECTOR</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A4</entry> + <entry>U+2320</entry> + <entry>TOP INTEGRAL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A5</entry> + <entry>U+2321</entry> + <entry>BOTTOM INTEGRAL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A6</entry> + <entry>-</entry> + <entry>VERTICAL CONNECTOR</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A7</entry> + <entry>U+23A1</entry> + <entry>TOP LEFT SQUARE BRACKET</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A8</entry> + <entry>U+23A3</entry> + <entry>BOTTOM LEFT SQUARE BRACKET</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08A9</entry> + <entry>U+23A4</entry> + <entry>TOP RIGHT SQUARE BRACKET</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08AA</entry> + <entry>U+23A6</entry> + <entry>BOTTOM RIGHT SQUARE BRACKET</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08AB</entry> + <entry>U+239B</entry> + <entry>TOP LEFT PARENTHESIS</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08AC</entry> + <entry>U+239D</entry> + <entry>BOTTOM LEFT PARENTHESIS</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08AD</entry> + <entry>U+239E</entry> + <entry>TOP RIGHT PARENTHESIS</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08AE</entry> + <entry>U+23A0</entry> + <entry>BOTTOM RIGHT PARENTHESIS</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08AF</entry> + <entry>U+23A8</entry> + <entry>LEFT MIDDLE CURLY BRACE</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B0</entry> + <entry>U+23AC</entry> + <entry>RIGHT MIDDLE CURLY BRACE</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B1</entry> + <entry>-</entry> + <entry>TOP LEFT SUMMATION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B2</entry> + <entry>-</entry> + <entry>BOTTOM LEFT SUMMATION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B3</entry> + <entry>-</entry> + <entry>TOP VERTICAL SUMMATION CONNECTOR</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B4</entry> + <entry>-</entry> + <entry>BOTTOM VERTICAL SUMMATION CONNECTOR</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B5</entry> + <entry>-</entry> + <entry>TOP RIGHT SUMMATION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B6</entry> + <entry>-</entry> + <entry>BOTTOM RIGHT SUMMATION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08B7</entry> + <entry>-</entry> + <entry>RIGHT MIDDLE SUMMATION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08BC</entry> + <entry>U+2264</entry> + <entry>LESS THAN OR EQUAL SIGN</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08BD</entry> + <entry>U+2260</entry> + <entry>NOT EQUAL SIGN</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08BE</entry> + <entry>U+2265</entry> + <entry>GREATER THAN OR EQUAL SIGN</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08BF</entry> + <entry>U+222B</entry> + <entry>INTEGRAL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08C0</entry> + <entry>U+2234</entry> + <entry>THEREFORE</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08C1</entry> + <entry>U+221D</entry> + <entry>VARIATION, PROPORTIONAL TO</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08C2</entry> + <entry>U+221E</entry> + <entry>INFINITY</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08C5</entry> + <entry>U+2207</entry> + <entry>NABLA, DEL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08C8</entry> + <entry>U+223C</entry> + <entry>IS APPROXIMATE TO</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08C9</entry> + <entry>U+2243</entry> + <entry>SIMILAR OR EQUAL TO</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08CD</entry> + <entry>U+21D4</entry> + <entry>IF AND ONLY IF</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08CE</entry> + <entry>U+21D2</entry> + <entry>IMPLIES</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08CF</entry> + <entry>U+2261</entry> + <entry>IDENTICAL TO</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08D6</entry> + <entry>U+221A</entry> + <entry>RADICAL</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08DA</entry> + <entry>U+2282</entry> + <entry>IS INCLUDED IN</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08DB</entry> + <entry>U+2283</entry> + <entry>INCLUDES</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08DC</entry> + <entry>U+2229</entry> + <entry>INTERSECTION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08DD</entry> + <entry>U+222A</entry> + <entry>UNION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08DE</entry> + <entry>U+2227</entry> + <entry>LOGICAL AND</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08DF</entry> + <entry>U+2228</entry> + <entry>LOGICAL OR</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08EF</entry> + <entry>U+2202</entry> + <entry>PARTIAL DERIVATIVE</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08F6</entry> + <entry>U+0192</entry> + <entry>FUNCTION</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08FB</entry> + <entry>U+2190</entry> + <entry>LEFT ARROW</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08FC</entry> + <entry>U+2191</entry> + <entry>UPWARD ARROW</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08FD</entry> + <entry>U+2192</entry> + <entry>RIGHT ARROW</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x08FE</entry> + <entry>U+2193</entry> + <entry>DOWNWARD ARROW</entry> + <entry>Technical</entry> + </row> + <row> + <entry>#x09DF</entry> + <entry>-</entry> + <entry>BLANK</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E0</entry> + <entry>U+25C6</entry> + <entry>SOLID DIAMOND</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E1</entry> + <entry>U+2592</entry> + <entry>CHECKERBOARD</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E2</entry> + <entry>U+2409</entry> + <entry>"HT"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E3</entry> + <entry>U+240C</entry> + <entry>"FF"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E4</entry> + <entry>U+240D</entry> + <entry>"CR"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E5</entry> + <entry>U+240A</entry> + <entry>"LF"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E8</entry> + <entry>U+2424</entry> + <entry>"NL"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09E9</entry> + <entry>U+240B</entry> + <entry>"VT"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09EA</entry> + <entry>U+2518</entry> + <entry>LOWER-RIGHT CORNER</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09EB</entry> + <entry>U+2510</entry> + <entry>UPPER-RIGHT CORNER</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09EC</entry> + <entry>U+250C</entry> + <entry>UPPER-LEFT CORNER</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09ED</entry> + <entry>U+2514</entry> + <entry>LOWER-LEFT CORNER</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09EE</entry> + <entry>U+253C</entry> + <entry>CROSSING-LINES</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09EF</entry> + <entry>U+23BA</entry> + <entry>HORIZONTAL LINE, SCAN 1</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F0</entry> + <entry>U+23BB</entry> + <entry>HORIZONTAL LINE, SCAN 3</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F1</entry> + <entry>U+2500</entry> + <entry>HORIZONTAL LINE, SCAN 5</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F2</entry> + <entry>U+23BC</entry> + <entry>HORIZONTAL LINE, SCAN 7</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F3</entry> + <entry>U+23BD</entry> + <entry>HORIZONTAL LINE, SCAN 9</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F4</entry> + <entry>U+251C</entry> + <entry>LEFT "T"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F5</entry> + <entry>U+2524</entry> + <entry>RIGHT "T"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F6</entry> + <entry>U+2534</entry> + <entry>BOTTOM "T"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F7</entry> + <entry>U+252C</entry> + <entry>TOP "T"</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x09F8</entry> + <entry>U+2502</entry> + <entry>VERTICAL BAR</entry> + <entry>Special</entry> + </row> + <row> + <entry>#x0AA1</entry> + <entry>U+2003</entry> + <entry>EM SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA2</entry> + <entry>U+2002</entry> + <entry>EN SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA3</entry> + <entry>U+2004</entry> + <entry>3/EM SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA4</entry> + <entry>U+2005</entry> + <entry>4/EM SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA5</entry> + <entry>U+2007</entry> + <entry>DIGIT SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA6</entry> + <entry>U+2008</entry> + <entry>PUNCTUATION SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA7</entry> + <entry>U+2009</entry> + <entry>THIN SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA8</entry> + <entry>U+200A</entry> + <entry>HAIR SPACE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AA9</entry> + <entry>U+2014</entry> + <entry>EM DASH</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AAA</entry> + <entry>U+2013</entry> + <entry>EN DASH</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AAC</entry> + <entry>-</entry> + <entry>SIGNIFICANT BLANK SYMBOL</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AAE</entry> + <entry>U+2026</entry> + <entry>ELLIPSIS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AAF</entry> + <entry>U+2025</entry> + <entry>DOUBLE BASELINE DOT</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB0</entry> + <entry>U+2153</entry> + <entry>VULGAR FRACTION ONE THIRD</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB1</entry> + <entry>U+2154</entry> + <entry>VULGAR FRACTION TWO THIRDS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB2</entry> + <entry>U+2155</entry> + <entry>VULGAR FRACTION ONE FIFTH</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB3</entry> + <entry>U+2156</entry> + <entry>VULGAR FRACTION TWO FIFTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB4</entry> + <entry>U+2157</entry> + <entry>VULGAR FRACTION THREE FIFTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB5</entry> + <entry>U+2158</entry> + <entry>VULGAR FRACTION FOUR FIFTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB6</entry> + <entry>U+2159</entry> + <entry>VULGAR FRACTION ONE SIXTH</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB7</entry> + <entry>U+215A</entry> + <entry>VULGAR FRACTION FIVE SIXTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AB8</entry> + <entry>U+2105</entry> + <entry>CARE OF</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ABB</entry> + <entry>U+2012</entry> + <entry>FIGURE DASH</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ABC</entry> + <entry>-</entry> + <entry>LEFT ANGLE BRACKET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ABD</entry> + <entry>-</entry> + <entry>DECIMAL POINT</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ABE</entry> + <entry>-</entry> + <entry>RIGHT ANGLE BRACKET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ABF</entry> + <entry>-</entry> + <entry>MARKER</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AC3</entry> + <entry>U+215B</entry> + <entry>VULGAR FRACTION ONE EIGHTH</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AC4</entry> + <entry>U+215C</entry> + <entry>VULGAR FRACTION THREE EIGHTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AC5</entry> + <entry>U+215D</entry> + <entry>VULGAR FRACTION FIVE EIGHTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AC6</entry> + <entry>U+215E</entry> + <entry>VULGAR FRACTION SEVEN EIGHTHS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AC9</entry> + <entry>U+2122</entry> + <entry>TRADEMARK SIGN</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ACA</entry> + <entry>-</entry> + <entry>SIGNATURE MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ACB</entry> + <entry>-</entry> + <entry>TRADEMARK SIGN IN CIRCLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ACC</entry> + <entry>-</entry> + <entry>LEFT OPEN TRIANGLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ACD</entry> + <entry>-</entry> + <entry>RIGHT OPEN TRIANGLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ACE</entry> + <entry>-</entry> + <entry>EM OPEN CIRCLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ACF</entry> + <entry>-</entry> + <entry>EM OPEN RECTANGLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD0</entry> + <entry>U+2018</entry> + <entry>LEFT SINGLE QUOTATION MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD1</entry> + <entry>U+2019</entry> + <entry>RIGHT SINGLE QUOTATION MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD2</entry> + <entry>U+201C</entry> + <entry>LEFT DOUBLE QUOTATION MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD3</entry> + <entry>U+201D</entry> + <entry>RIGHT DOUBLE QUOTATION MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD4</entry> + <entry>U+211E</entry> + <entry>PRESCRIPTION, TAKE, RECIPE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD5</entry> + <entry>U+2030</entry> + <entry>PER MILLE SIGN</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD6</entry> + <entry>U+2032</entry> + <entry>MINUTES</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD7</entry> + <entry>U+2033</entry> + <entry>SECONDS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AD9</entry> + <entry>U+271D</entry> + <entry>LATIN CROSS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ADA</entry> + <entry>-</entry> + <entry>HEXAGRAM</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ADB</entry> + <entry>-</entry> + <entry>FILLED RECTANGLE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ADC</entry> + <entry>-</entry> + <entry>FILLED LEFT TRIANGLE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ADD</entry> + <entry>-</entry> + <entry>FILLED RIGHT TRIANGLE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ADE</entry> + <entry>-</entry> + <entry>EM FILLED CIRCLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0ADF</entry> + <entry>-</entry> + <entry>EM FILLED RECTANGLE</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE0</entry> + <entry>-</entry> + <entry>EN OPEN CIRCLE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE1</entry> + <entry>-</entry> + <entry>EN OPEN SQUARE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE2</entry> + <entry>-</entry> + <entry>OPEN RECTANGULAR BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE3</entry> + <entry>-</entry> + <entry>OPEN TRIANGULAR BULLET UP</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE4</entry> + <entry>-</entry> + <entry>OPEN TRIANGULAR BULLET DOWN</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE5</entry> + <entry>-</entry> + <entry>OPEN STAR</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE6</entry> + <entry>-</entry> + <entry>EN FILLED CIRCLE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE7</entry> + <entry>-</entry> + <entry>EN FILLED SQUARE BULLET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE8</entry> + <entry>-</entry> + <entry>FILLED TRIANGULAR BULLET UP</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AE9</entry> + <entry>-</entry> + <entry>FILLED TRIANGULAR BULLET DOWN</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AEA</entry> + <entry>-</entry> + <entry>LEFT POINTER</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AEB</entry> + <entry>-</entry> + <entry>RIGHT POINTER</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AEC</entry> + <entry>U+2663</entry> + <entry>CLUB</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AED</entry> + <entry>U+2666</entry> + <entry>DIAMOND</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AEE</entry> + <entry>U+2665</entry> + <entry>HEART</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF0</entry> + <entry>U+2720</entry> + <entry>MALTESE CROSS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF1</entry> + <entry>U+2020</entry> + <entry>DAGGER</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF2</entry> + <entry>U+2021</entry> + <entry>DOUBLE DAGGER</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF3</entry> + <entry>U+2713</entry> + <entry>CHECK MARK, TICK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF4</entry> + <entry>U+2717</entry> + <entry>BALLOT CROSS</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF5</entry> + <entry>U+266F</entry> + <entry>MUSICAL SHARP</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF6</entry> + <entry>U+266D</entry> + <entry>MUSICAL FLAT</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF7</entry> + <entry>U+2642</entry> + <entry>MALE SYMBOL</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF8</entry> + <entry>U+2640</entry> + <entry>FEMALE SYMBOL</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AF9</entry> + <entry>U+260E</entry> + <entry>TELEPHONE SYMBOL</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AFA</entry> + <entry>U+2315</entry> + <entry>TELEPHONE RECORDER SYMBOL</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AFB</entry> + <entry>U+2117</entry> + <entry>PHONOGRAPH COPYRIGHT SIGN</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AFC</entry> + <entry>U+2038</entry> + <entry>CARET</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AFD</entry> + <entry>U+201A</entry> + <entry>SINGLE LOW QUOTATION MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AFE</entry> + <entry>U+201E</entry> + <entry>DOUBLE LOW QUOTATION MARK</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0AFF</entry> + <entry>-</entry> + <entry>CURSOR</entry> + <entry>Publish</entry> + </row> + <row> + <entry>#x0BA3</entry> + <entry>-</entry> + <entry>LEFT CARET</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BA6</entry> + <entry>-</entry> + <entry>RIGHT CARET</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BA8</entry> + <entry>-</entry> + <entry>DOWN CARET</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BA9</entry> + <entry>-</entry> + <entry>UP CARET</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BC0</entry> + <entry>-</entry> + <entry>OVERBAR</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BC2</entry> + <entry>U+22A5</entry> + <entry>DOWN TACK</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BC3</entry> + <entry>-</entry> + <entry>UP SHOE (CAP)</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BC4</entry> + <entry>U+230A</entry> + <entry>DOWN STILE</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BC6</entry> + <entry>-</entry> + <entry>UNDERBAR</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BCA</entry> + <entry>U+2218</entry> + <entry>JOT</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BCC</entry> + <entry>U+2395</entry> + <entry>QUAD</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BCE</entry> + <entry>U+22A4</entry> + <entry>UP TACK</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BCF</entry> + <entry>U+25CB</entry> + <entry>CIRCLE</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BD3</entry> + <entry>U+2308</entry> + <entry>UP STILE</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BD6</entry> + <entry>-</entry> + <entry>DOWN SHOE (CUP)</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BD8</entry> + <entry>-</entry> + <entry>RIGHT SHOE</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BDA</entry> + <entry>-</entry> + <entry>LEFT SHOE</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BDC</entry> + <entry>U+22A2</entry> + <entry>LEFT TACK</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0BFC</entry> + <entry>U+22A3</entry> + <entry>RIGHT TACK</entry> + <entry>APL</entry> + </row> + <row> + <entry>#x0CDF</entry> + <entry>U+2017</entry> + <entry>DOUBLE LOW LINE</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE0</entry> + <entry>U+05D0</entry> + <entry>HEBREW LETTER ALEF</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE1</entry> + <entry>U+05D1</entry> + <entry>HEBREW LETTER BET</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE2</entry> + <entry>U+05D2</entry> + <entry>HEBREW LETTER GIMEL</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE3</entry> + <entry>U+05D3</entry> + <entry>HEBREW LETTER DALET</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE4</entry> + <entry>U+05D4</entry> + <entry>HEBREW LETTER HE</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE5</entry> + <entry>U+05D5</entry> + <entry>HEBREW LETTER VAV</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE6</entry> + <entry>U+05D6</entry> + <entry>HEBREW LETTER ZAYIN</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE7</entry> + <entry>U+05D7</entry> + <entry>HEBREW LETTER HET</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE8</entry> + <entry>U+05D8</entry> + <entry>HEBREW LETTER TET</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CE9</entry> + <entry>U+05D9</entry> + <entry>HEBREW LETTER YOD</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CEA</entry> + <entry>U+05DA</entry> + <entry>HEBREW LETTER FINAL KAF</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CEB</entry> + <entry>U+05DB</entry> + <entry>HEBREW LETTER KAF</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CEC</entry> + <entry>U+05DC</entry> + <entry>HEBREW LETTER LAMED</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CED</entry> + <entry>U+05DD</entry> + <entry>HEBREW LETTER FINAL MEM</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CEE</entry> + <entry>U+05DE</entry> + <entry>HEBREW LETTER MEM</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CEF</entry> + <entry>U+05DF</entry> + <entry>HEBREW LETTER FINAL NUN</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF0</entry> + <entry>U+05E0</entry> + <entry>HEBREW LETTER NUN</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF1</entry> + <entry>U+05E1</entry> + <entry>HEBREW LETTER SAMEKH</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF2</entry> + <entry>U+05E2</entry> + <entry>HEBREW LETTER AYIN</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF3</entry> + <entry>U+05E3</entry> + <entry>HEBREW LETTER FINAL PE</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF4</entry> + <entry>U+05E4</entry> + <entry>HEBREW LETTER PE</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF5</entry> + <entry>U+05E5</entry> + <entry>HEBREW LETTER FINAL TSADI</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF6</entry> + <entry>U+05E6</entry> + <entry>HEBREW LETTER TSADI</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF7</entry> + <entry>U+05E7</entry> + <entry>HEBREW LETTER QOF</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF8</entry> + <entry>U+05E8</entry> + <entry>HEBREW LETTER RESH</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CF9</entry> + <entry>U+05E9</entry> + <entry>HEBREW LETTER SHIN</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0CFA</entry> + <entry>U+05EA</entry> + <entry>HEBREW LETTER TAV</entry> + <entry>Hebrew</entry> + </row> + <row> + <entry>#x0DA1</entry> + <entry>U+0E01</entry> + <entry>THAI CHARACTER KO KAI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA2</entry> + <entry>U+0E02</entry> + <entry>THAI CHARACTER KHO KHAI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA3</entry> + <entry>U+0E03</entry> + <entry>THAI CHARACTER KHO KHUAT</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA4</entry> + <entry>U+0E04</entry> + <entry>THAI CHARACTER KHO KHWAI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA5</entry> + <entry>U+0E05</entry> + <entry>THAI CHARACTER KHO KHON</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA6</entry> + <entry>U+0E06</entry> + <entry>THAI CHARACTER KHO RAKHANG</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA7</entry> + <entry>U+0E07</entry> + <entry>THAI CHARACTER NGO NGU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA8</entry> + <entry>U+0E08</entry> + <entry>THAI CHARACTER CHO CHAN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DA9</entry> + <entry>U+0E09</entry> + <entry>THAI CHARACTER CHO CHING</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DAA</entry> + <entry>U+0E0A</entry> + <entry>THAI CHARACTER CHO CHANG</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DAB</entry> + <entry>U+0E0B</entry> + <entry>THAI CHARACTER SO SO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DAC</entry> + <entry>U+0E0C</entry> + <entry>THAI CHARACTER CHO CHOE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DAD</entry> + <entry>U+0E0D</entry> + <entry>THAI CHARACTER YO YING</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DAE</entry> + <entry>U+0E0E</entry> + <entry>THAI CHARACTER DO CHADA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DAF</entry> + <entry>U+0E0F</entry> + <entry>THAI CHARACTER TO PATAK</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB0</entry> + <entry>U+0E10</entry> + <entry>THAI CHARACTER THO THAN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB1</entry> + <entry>U+0E11</entry> + <entry>THAI CHARACTER THO NANGMONTHO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB2</entry> + <entry>U+0E12</entry> + <entry>THAI CHARACTER THO PHUTHAO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB3</entry> + <entry>U+0E13</entry> + <entry>THAI CHARACTER NO NEN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB4</entry> + <entry>U+0E14</entry> + <entry>THAI CHARACTER DO DEK</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB5</entry> + <entry>U+0E15</entry> + <entry>THAI CHARACTER TO TAO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB6</entry> + <entry>U+0E16</entry> + <entry>THAI CHARACTER THO THUNG</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB7</entry> + <entry>U+0E17</entry> + <entry>THAI CHARACTER THO THAHAN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB8</entry> + <entry>U+0E18</entry> + <entry>THAI CHARACTER THO THONG</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DB9</entry> + <entry>U+0E19</entry> + <entry>THAI CHARACTER NO NU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DBA</entry> + <entry>U+0E1A</entry> + <entry>THAI CHARACTER BO BAIMAI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DBB</entry> + <entry>U+0E1B</entry> + <entry>THAI CHARACTER PO PLA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DBC</entry> + <entry>U+0E1C</entry> + <entry>THAI CHARACTER PHO PHUNG</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DBD</entry> + <entry>U+0E1D</entry> + <entry>THAI CHARACTER FO FA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DBE</entry> + <entry>U+0E1E</entry> + <entry>THAI CHARACTER PHO PHAN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DBF</entry> + <entry>U+0E1F</entry> + <entry>THAI CHARACTER FO FAN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC0</entry> + <entry>U+0E20</entry> + <entry>THAI CHARACTER PHO SAMPHAO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC1</entry> + <entry>U+0E21</entry> + <entry>THAI CHARACTER MO MA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC2</entry> + <entry>U+0E22</entry> + <entry>THAI CHARACTER YO YAK</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC3</entry> + <entry>U+0E23</entry> + <entry>THAI CHARACTER RO RUA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC4</entry> + <entry>U+0E24</entry> + <entry>THAI CHARACTER RU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC5</entry> + <entry>U+0E25</entry> + <entry>THAI CHARACTER LO LING</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC6</entry> + <entry>U+0E26</entry> + <entry>THAI CHARACTER LU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC7</entry> + <entry>U+0E27</entry> + <entry>THAI CHARACTER WO WAEN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC8</entry> + <entry>U+0E28</entry> + <entry>THAI CHARACTER SO SALA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DC9</entry> + <entry>U+0E29</entry> + <entry>THAI CHARACTER SO RUSI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DCA</entry> + <entry>U+0E2A</entry> + <entry>THAI CHARACTER SO SUA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DCB</entry> + <entry>U+0E2B</entry> + <entry>THAI CHARACTER HO HIP</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DCC</entry> + <entry>U+0E2C</entry> + <entry>THAI CHARACTER LO CHULA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DCD</entry> + <entry>U+0E2D</entry> + <entry>THAI CHARACTER O ANG</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DCE</entry> + <entry>U+0E2E</entry> + <entry>THAI CHARACTER HO NOKHUK</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DCF</entry> + <entry>U+0E2F</entry> + <entry>THAI CHARACTER PAIYANNOI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD0</entry> + <entry>U+0E30</entry> + <entry>THAI CHARACTER SARA A</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD1</entry> + <entry>U+0E31</entry> + <entry>THAI CHARACTER MAI HAN-AKAT</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD2</entry> + <entry>U+0E32</entry> + <entry>THAI CHARACTER SARA AA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD3</entry> + <entry>U+0E33</entry> + <entry>THAI CHARACTER SARA AM</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD4</entry> + <entry>U+0E34</entry> + <entry>THAI CHARACTER SARA I</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD5</entry> + <entry>U+0E35</entry> + <entry>THAI CHARACTER SARA II</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD6</entry> + <entry>U+0E36</entry> + <entry>THAI CHARACTER SARA UE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD7</entry> + <entry>U+0E37</entry> + <entry>THAI CHARACTER SARA UEE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD8</entry> + <entry>U+0E38</entry> + <entry>THAI CHARACTER SARA U</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DD9</entry> + <entry>U+0E39</entry> + <entry>THAI CHARACTER SARA UU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DDA</entry> + <entry>U+0E3A</entry> + <entry>THAI CHARACTER PHINTHU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DDF</entry> + <entry>U+0E3F</entry> + <entry>THAI CURRENCY SYMBOL BAHT</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE0</entry> + <entry>U+0E40</entry> + <entry>THAI CHARACTER SARA E</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE1</entry> + <entry>U+0E41</entry> + <entry>THAI CHARACTER SARA AE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE2</entry> + <entry>U+0E42</entry> + <entry>THAI CHARACTER SARA O</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE3</entry> + <entry>U+0E43</entry> + <entry>THAI CHARACTER SARA AI MAIMUAN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE4</entry> + <entry>U+0E44</entry> + <entry>THAI CHARACTER SARA AI MAIMALAI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE5</entry> + <entry>U+0E45</entry> + <entry>THAI CHARACTER LAKKHANGYAO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE6</entry> + <entry>U+0E46</entry> + <entry>THAI CHARACTER MAIYAMOK</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE7</entry> + <entry>U+0E47</entry> + <entry>THAI CHARACTER MAITAIKHU</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE8</entry> + <entry>U+0E48</entry> + <entry>THAI CHARACTER MAI EK</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DE9</entry> + <entry>U+0E49</entry> + <entry>THAI CHARACTER MAI THO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DEA</entry> + <entry>U+0E4A</entry> + <entry>THAI CHARACTER MAI TRI</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DEB</entry> + <entry>U+0E4B</entry> + <entry>THAI CHARACTER MAI CHATTAWA</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DEC</entry> + <entry>U+0E4C</entry> + <entry>THAI CHARACTER THANTHAKHAT</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DED</entry> + <entry>U+0E4D</entry> + <entry>THAI CHARACTER NIKHAHIT</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF0</entry> + <entry>U+0E50</entry> + <entry>THAI DIGIT ZERO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF1</entry> + <entry>U+0E51</entry> + <entry>THAI DIGIT ONE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF2</entry> + <entry>U+0E52</entry> + <entry>THAI DIGIT TWO</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF3</entry> + <entry>U+0E53</entry> + <entry>THAI DIGIT THREE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF4</entry> + <entry>U+0E54</entry> + <entry>THAI DIGIT FOUR</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF5</entry> + <entry>U+0E55</entry> + <entry>THAI DIGIT FIVE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF6</entry> + <entry>U+0E56</entry> + <entry>THAI DIGIT SIX</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF7</entry> + <entry>U+0E57</entry> + <entry>THAI DIGIT SEVEN</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF8</entry> + <entry>U+0E58</entry> + <entry>THAI DIGIT EIGHT</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0DF9</entry> + <entry>U+0E59</entry> + <entry>THAI DIGIT NINE</entry> + <entry>Thai</entry> + </row> + <row> + <entry>#x0EA1</entry> + <entry>-</entry> + <entry>HANGUL KIYEOG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA2</entry> + <entry>-</entry> + <entry>HANGUL SSANG KIYEOG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA3</entry> + <entry>-</entry> + <entry>HANGUL KIYEOG SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA4</entry> + <entry>-</entry> + <entry>HANGUL NIEUN</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA5</entry> + <entry>-</entry> + <entry>HANGUL NIEUN JIEUJ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA6</entry> + <entry>-</entry> + <entry>HANGUL NIEUN HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA7</entry> + <entry>-</entry> + <entry>HANGUL DIKEUD</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA8</entry> + <entry>-</entry> + <entry>HANGUL SSANG DIKEUD</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EA9</entry> + <entry>-</entry> + <entry>HANGUL RIEUL</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EAA</entry> + <entry>-</entry> + <entry>HANGUL RIEUL KIYEOG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EAB</entry> + <entry>-</entry> + <entry>HANGUL RIEUL MIEUM</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EAC</entry> + <entry>-</entry> + <entry>HANGUL RIEUL PIEUB</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EAD</entry> + <entry>-</entry> + <entry>HANGUL RIEUL SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EAE</entry> + <entry>-</entry> + <entry>HANGUL RIEUL TIEUT</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EAF</entry> + <entry>-</entry> + <entry>HANGUL RIEUL PHIEUF</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB0</entry> + <entry>-</entry> + <entry>HANGUL RIEUL HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB1</entry> + <entry>-</entry> + <entry>HANGUL MIEUM</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB2</entry> + <entry>-</entry> + <entry>HANGUL PIEUB</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB3</entry> + <entry>-</entry> + <entry>HANGUL SSANG PIEUB</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB4</entry> + <entry>-</entry> + <entry>HANGUL PIEUB SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB5</entry> + <entry>-</entry> + <entry>HANGUL SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB6</entry> + <entry>-</entry> + <entry>HANGUL SSANG SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB7</entry> + <entry>-</entry> + <entry>HANGUL IEUNG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB8</entry> + <entry>-</entry> + <entry>HANGUL JIEUJ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EB9</entry> + <entry>-</entry> + <entry>HANGUL SSANG JIEUJ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EBA</entry> + <entry>-</entry> + <entry>HANGUL CIEUC</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EBB</entry> + <entry>-</entry> + <entry>HANGUL KHIEUQ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EBC</entry> + <entry>-</entry> + <entry>HANGUL TIEUT</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EBD</entry> + <entry>-</entry> + <entry>HANGUL PHIEUF</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EBE</entry> + <entry>-</entry> + <entry>HANGUL HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EBF</entry> + <entry>-</entry> + <entry>HANGUL A</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC0</entry> + <entry>-</entry> + <entry>HANGUL AE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC1</entry> + <entry>-</entry> + <entry>HANGUL YA</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC2</entry> + <entry>-</entry> + <entry>HANGUL YAE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC3</entry> + <entry>-</entry> + <entry>HANGUL EO</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC4</entry> + <entry>-</entry> + <entry>HANGUL E</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC5</entry> + <entry>-</entry> + <entry>HANGUL YEO</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC6</entry> + <entry>-</entry> + <entry>HANGUL YE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC7</entry> + <entry>-</entry> + <entry>HANGUL O</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC8</entry> + <entry>-</entry> + <entry>HANGUL WA</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EC9</entry> + <entry>-</entry> + <entry>HANGUL WAE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ECA</entry> + <entry>-</entry> + <entry>HANGUL OE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ECB</entry> + <entry>-</entry> + <entry>HANGUL YO</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ECC</entry> + <entry>-</entry> + <entry>HANGUL U</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ECD</entry> + <entry>-</entry> + <entry>HANGUL WEO</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ECE</entry> + <entry>-</entry> + <entry>HANGUL WE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ECF</entry> + <entry>-</entry> + <entry>HANGUL WI</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED0</entry> + <entry>-</entry> + <entry>HANGUL YU</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED1</entry> + <entry>-</entry> + <entry>HANGUL EU</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED2</entry> + <entry>-</entry> + <entry>HANGUL YI</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED3</entry> + <entry>-</entry> + <entry>HANGUL I</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED4</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG KIYEOG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED5</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG SSANG KIYEOG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED6</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG KIYEOG SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED7</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG NIEUN</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED8</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG NIEUN JIEUJ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0ED9</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG NIEUN HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EDA</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG DIKEUD</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EDB</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EDC</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL KIYEOG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EDD</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL MIEUM</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EDE</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL PIEUB</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EDF</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE0</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL TIEUT</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE1</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL PHIEUF</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE2</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG RIEUL HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE3</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG MIEUM</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE4</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG PIEUB</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE5</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG PIEUB SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE6</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE7</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG SSANG SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE8</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG IEUNG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EE9</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG JIEUJ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EEA</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG CIEUC</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EEB</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG KHIEUQ</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EEC</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG TIEUT</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EED</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG PHIEUF</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EEE</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EEF</entry> + <entry>-</entry> + <entry>HANGUL RIEUL YEORIN HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF0</entry> + <entry>-</entry> + <entry>HANGUL SUNKYEONGEUM MIEUM</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF1</entry> + <entry>-</entry> + <entry>HANGUL SUNKYEONGEUM PIEUB</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF2</entry> + <entry>-</entry> + <entry>HANGUL PAN SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF3</entry> + <entry>-</entry> + <entry>HANGUL KKOGJI DALRIN IEUNG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF4</entry> + <entry>-</entry> + <entry>HANGUL SUNKYEONGEUM PHIEUF</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF5</entry> + <entry>-</entry> + <entry>HANGUL YEORIN HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF6</entry> + <entry>-</entry> + <entry>HANGUL ARAE A</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF7</entry> + <entry>-</entry> + <entry>HANGUL ARAE AE</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF8</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG PAN SIOS</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EF9</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG KKOGJI DALRIN IEUNG</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EFA</entry> + <entry>-</entry> + <entry>HANGUL JONG SEONG YEORIN HIEUH</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x0EFF</entry> + <entry>-</entry> + <entry>KOREAN WON</entry> + <entry>Korean</entry> + </row> + <row> + <entry>#x13BC</entry> + <entry>U+0152</entry> + <entry>LATIN CAPITAL LIGATURE OE</entry> + <entry>Latin-9</entry> + </row> + <row> + <entry>#x13BD</entry> + <entry>U+0153</entry> + <entry>LATIN SMALL LIGATURE OE</entry> + <entry>Latin-9</entry> + </row> + <row> + <entry>#x13BE</entry> + <entry>U+0178</entry> + <entry>LATIN CAPITAL LETTER Y WITH DIAERESIS</entry> + <entry>Latin-9</entry> + </row> + <row> + <entry>#x20A0</entry> + <entry>-</entry> + <entry>CURRENCY ECU SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A1</entry> + <entry>-</entry> + <entry>CURRENCY COLON SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A2</entry> + <entry>-</entry> + <entry>CURRENCY CRUZEIRO SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A3</entry> + <entry>-</entry> + <entry>CURRENCY FRENCH FRANC SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A4</entry> + <entry>-</entry> + <entry>CURRENCY LIRA SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A5</entry> + <entry>-</entry> + <entry>CURRENCY MILL SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A6</entry> + <entry>-</entry> + <entry>CURRENCY NAIRA SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A7</entry> + <entry>-</entry> + <entry>CURRENCY PESETA SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A8</entry> + <entry>-</entry> + <entry>CURRENCY RUPEE SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20A9</entry> + <entry>-</entry> + <entry>CURRENCY WON SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20AA</entry> + <entry>-</entry> + <entry>CURRENCY NEW SHEQEL SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20AB</entry> + <entry>-</entry> + <entry>CURRENCY DONG SIGN</entry> + <entry>Currency</entry> + </row> + <row> + <entry>#x20AC</entry> + <entry>U+20AC</entry> + <entry>CURRENCY EURO SIGN</entry> + <entry>Currency</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +</sect1> +</appendix> diff --git a/specs/sect1-9.xml b/specs/sect1-9.xml new file mode 100644 index 0000000..f8e8b7c --- /dev/null +++ b/specs/sect1-9.xml @@ -0,0 +1,15309 @@ +<part id="sect1-9"> +<preface id="acknowledgements"> +<title>Acknowledgements</title> +<para> +The primary contributers to the X11 protocol are: +</para> + +<itemizedlist> +<listitem><para>Dave Carver (Digital HPW)</para></listitem> +<listitem><para>Branko Gerovac (Digital HPW)</para></listitem> +<listitem><para>Jim Gettys (MIT/Project Athena, Digital)</para></listitem> +<listitem><para>Phil Karlton (Digital WSL)</para></listitem> +<listitem><para>Scott McGregor (Digital SSG)</para></listitem> +<listitem><para>Ram Rao (Digital UEG)</para></listitem> +<listitem><para>David Rosenthal (Sun)</para></listitem> +<listitem><para>Dave Winchell (Digital UEG)</para></listitem> +</itemizedlist> + +<para> +The implementors of initial server who provided useful +input are: +</para> + +<itemizedlist> +<listitem><para>Susan Angebranndt (Digital)</para></listitem> +<listitem><para>Raymond Drewry (Digital)</para></listitem> +<listitem><para>Todd Newman (Digital)</para></listitem> +</itemizedlist> + +<para> +The invited reviewers who provided useful input are: +</para> + +<itemizedlist> +<listitem><para>Andrew Cherenson (Berkeley)</para></listitem> +<listitem><para>Burns Fisher (Digital)</para></listitem> +<listitem><para>Dan Garfinkel (HP)</para></listitem> +<listitem><para>Leo Hourvitz (Next)</para></listitem> +<listitem><para>Brock Krizan (HP)</para></listitem> +<listitem><para>David Laidlaw (Stellar)</para></listitem> +<listitem><para>Dave Mellinger (Interleaf)</para></listitem> +<listitem><para>Ron Newman (MIT)</para></listitem> +<listitem><para>John Ousterhout (Berkeley)</para></listitem> +<listitem><para>Andrew Palay (ITC CMU)</para></listitem> +<listitem><para>Ralph Swick (MIT)</para></listitem> +<listitem><para>Craig Taylor (Sun)</para></listitem> +<listitem><para>Jeffery Vroom (Stellar)</para></listitem> +</itemizedlist> + +<para> +Thanks go to Al Mento of Digital's UEG Documentation Group for +formatting this document. +</para> + +<para> +This document does not attempt to provide the rationale or pragmatics required +to fully understand the protocol or to place it in perspective within a +complete system. +</para> + +<para> +The protocol contains many management mechanisms that are not intended for +normal applications. +Not all mechanisms are needed to build a particular user interface. +It is important to keep in mind that the protocol is intended to +provide mechanism, not policy. +</para> + +<para> +Robert W. Scheifler +</para> +<para> +X Consortium, Inc. +</para> +</preface> + +<chapter id='Protocol_Formats'> + <title>Protocol Formats</title> + + <section id="request_format"> + <title>Request Format</title> + <indexterm zone="request_format" significance="preferred"><primary>Request</primary><secondary>format</secondary></indexterm> + <para> +Every request contains an 8-bit <firstterm id="major_opcode">major opcode</firstterm> +<indexterm zone="major_opcode" significance="preferred"><primary>Opcode</primary><secondary>major</secondary></indexterm> +and a 16-bit <firstterm id="request_length">length field</firstterm> +<indexterm zone="request_length" significance="preferred"><primary>Request</primary><secondary>length</secondary></indexterm> +expressed in units of four bytes. +Every request consists of four bytes of a header +(containing the major opcode, the length field, and a data byte) +followed by zero or more additional bytes of data. +The length field defines the total length of the request, including the header. +The length field in a request must equal the minimum length required to contain +the request. +If the specified length is smaller or larger than the required length, +an error is generated. +Unused bytes in a request are not required to be zero. +Major opcodes 128 through 255 are reserved for +<firstterm id="extension">extensions</firstterm>. +<indexterm zone="extension"><primary>Extension</primary></indexterm> +Extensions are intended to contain multiple requests, +so extension requests typically have an additional +<firstterm id="minor_opcode">minor opcode</firstterm> encoded +in the second data byte in the request header. +<indexterm zone="minor_opcode" significance="preferred"><primary>Opcode</primary><secondary>minor</secondary></indexterm> +However, the placement and interpretation of this minor opcode and of all +other fields in extension requests are not defined by the core protocol. +Every request on a given connection is implicitly assigned a +<firstterm id="sequence_number">sequence number</firstterm>, +<indexterm zone="sequence_number" significance="preferred"><primary>Sequence number</primary></indexterm> +starting with one, that is used in replies, errors, and events. + </para> + </section> + + <section id="reply_format"> + <title>Reply Format</title> + <indexterm zone="reply_format" significance="preferred"><primary>Reply</primary><secondary>format</secondary></indexterm> + <para> +Every <firstterm>reply</firstterm> contains a 32-bit length field +expressed in units of four bytes. +Every reply consists of 32 bytes followed by zero or more additional bytes of +data, as specified in the length field. +Unused bytes within a reply are not guaranteed to be zero. +Every reply also contains the least significant 16 bits of the sequence number +of the corresponding request. + </para> + </section> + + <section id="error_format"> + <title>Error Format</title> + <indexterm zone="error_format" significance="preferred"><primary>Error report</primary><secondary>format</secondary></indexterm> + <para> +Error reports are 32 bytes long. +Every error includes an 8-bit error code. +<phrase id="errors:extensions"> +Error codes 128 through 255 are reserved for extensions. +</phrase> +<indexterm zone="errors:extensions" significance="preferred"><primary>Error Codes</primary><secondary>extensions</secondary></indexterm> +<indexterm zone="errors:extensions" significance="preferred"><primary>Extension</primary><secondary>error codes</secondary></indexterm> +Every error also includes the major and minor opcodes of the failed request +and the least significant 16 bits of the sequence number of the request. +For the following errors (see <link linkend='Errors'>section 4</link>), +the failing resource ID is also returned: +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Pixmap</emphasis> +and +<emphasis role='bold'>Window</emphasis>. +For +<emphasis role='bold'>Atom</emphasis> +errors, the failing atom is returned. +For +<emphasis role='bold'>Value</emphasis> +errors, the failing value is returned. +Other core errors return no additional data. +Unused bytes within an error are not guaranteed to be zero. + </para> + </section> + + <section id="event_format"> + <title>Event Format</title> + <indexterm zone="event_format" significance="preferred"><primary>Event</primary><secondary>format</secondary></indexterm> + <para> +<firstterm>Events</firstterm> are 32 bytes long. +Unused bytes within an event are not guaranteed to be zero. +Every event contains an 8-bit type code. +The most significant bit in this code is set if the event was generated from a +<link linkend="requests:SendEvent"><emphasis role='bold'>SendEvent</emphasis></link> +request. +<phrase id="events:extensions"> +Event codes 64 through 127 are reserved for extensions, although the core +protocol does not define a mechanism for selecting interest in such events. +</phrase> +<indexterm zone="events:extensions" significance="preferred"><primary>Event</primary><secondary>extension</secondary></indexterm> +<indexterm zone="events:extensions" significance="preferred"><primary>Extension</primary><secondary>event</secondary></indexterm> +Every core event (with the exception of +<link linkend="events:KeymapNotify"><emphasis role='bold'>KeymapNotify</emphasis></link>) +also contains the least significant 16 bits of the sequence number of the last +request issued by the client that was (or is currently being) processed by +the server. + </para> + </section> +</chapter> + +<chapter id='Syntactic_Conventions'> +<title>Syntactic Conventions</title> +<!-- .XS --> +<!-- (SN Syntactic Conventions --> +<!-- .XE --> +<para> +<!-- .LP --> +The rest of this document uses the following syntactic conventions. +</para> +<itemizedlist> + <listitem> + <para> +The syntax {...} encloses a set of alternatives. + </para> + </listitem> + <listitem> + <para> +The syntax [...] encloses a set of structure components. + </para> + </listitem> + <listitem> + <para> +In general, TYPEs are in uppercase and +<emphasis role='bold'>AlternativeValues</emphasis> +are capitalized. + </para> + </listitem> + <listitem> + <para> +Requests in <link linkend='Requests'>section 9</link> are described +in the following format: +<literallayout class="monospaced"> +<emphasis role='bold'>RequestName</emphasis> + <emphasis remap='I'>arg1</emphasis>: type1 + ... + <emphasis remap='I'>argN</emphasis>: typeN + ▶ + result1: type1 + ... + resultM: typeM + + Errors: kind1, ..., kindK + + Description. +</literallayout> + </para> + <para> +If no ▶ is present in the description, +then the request has no reply (it is asynchronous), +although errors may still be reported. +If ▶+ is used, +then one or more replies can be generated for a single request. + </para> + </listitem> + <listitem> + <para> +Events in <link linkend='Events'>section 11</link> are described +in the following format: +<literallayout class="monospaced"> +<emphasis role='bold'>EventName</emphasis> + <emphasis remap='I'>value1</emphasis>: type1 + ... + <emphasis remap='I'>valueN</emphasis>: typeN + + Description. +</literallayout> + </para> + </listitem> +</itemizedlist> +</chapter> + +<chapter id='Common_Types'> +<title>Common Types</title> +<!-- .XS --> +<!-- (SN Common Types --> +<!-- .XE --> +<informaltable frame="topbot"> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry id="types:LISTofFOO">LISTofFOO<indexterm zone="types:LISTofFOO" significance="preferred"><primary>Types</primary><secondary>LISTofFOO</secondary></indexterm></entry> + <entry> + +A type name of the form LISTofFOO means a counted list of elements of type +FOO. +The size of the length field may vary (it is not necessarily the same +size as a FOO), and in some cases, it may be implicit. +It is fully specified in Appendix B. +Except where explicitly noted, +zero-length lists are legal. + </entry> + </row> + <row> + <entry><para id="types:BITMASK">BITMASK<indexterm zone="types:BITMASK" significance="preferred"><primary>Types</primary><secondary>BITMASK</secondary></indexterm></para><para id="types:LISTofVALUE">LISTofVALUE<indexterm zone="types:LISTofVALUE" significance="preferred"><primary>Types</primary><secondary>LISTofVALUE</secondary></indexterm></para></entry> + <entry> +<para> +The types BITMASK and LISTofVALUE are somewhat special. +Various requests contain arguments of the form: +</para> +<para> +<emphasis remap='I'>value-mask</emphasis>: BITMASK +</para> +<para> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +</para> +<para> +These are used to allow the client to specify a subset of a heterogeneous +collection of optional arguments. +The value-mask specifies which arguments are to be provided; +each such argument is assigned a unique bit position. +The representation of the BITMASK will typically contain more bits than +there are defined arguments. +The unused bits in the value-mask must be zero (or the server generates a +<emphasis role='bold'>Value</emphasis> +error). +The value-list contains one value for each bit set to 1 in the mask, +from least significant to most significant bit in the mask. +Each value is represented with four bytes, +but the actual value occupies only the least significant bytes as required. +The values of the unused bytes do not matter. +</para> + </entry> + </row> + <row> + <entry id="types:OR">OR<indexterm zone="types:OR" significance="preferred"><primary>Types</primary><secondary>OR</secondary></indexterm></entry> + <entry> +A type of the form "T1 or ... or Tn" means the union of the indicated types. +A single-element type is given as the element without enclosing braces. + </entry> + </row> + <row> + <entry id="types:WINDOW">WINDOW<indexterm zone="types:WINDOW" significance="preferred"><primary>Types</primary><secondary>WINDOW</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:PIXMAP">PIXMAP<indexterm zone="types:PIXMAP" significance="preferred"><primary>Types</primary><secondary>PIXMAP</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:CURSOR">CURSOR<indexterm zone="types:CURSOR" significance="preferred"><primary>Types</primary><secondary>CURSOR</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:FONT">FONT<indexterm zone="types:FONT" significance="preferred"><primary>Types</primary><secondary>FONT</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:GCONTEXT">GCONTEXT<indexterm zone="types:GCONTEXT" significance="preferred"><primary>Types</primary><secondary>GCONTEXT</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:COLORMAP">COLORMAP<indexterm zone="types:COLORMAP" significance="preferred"><primary>Types</primary><secondary>COLORMAP</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:DRAWABLE">DRAWABLE<indexterm zone="types:DRAWABLE" significance="preferred"><primary>Types</primary><secondary>DRAWABLE</secondary></indexterm></entry> + <entry>WINDOW or PIXMAP</entry> + </row> + <row> + <entry id="types:FONTABLE">FONTABLE<indexterm zone="types:FONTABLE" significance="preferred"><primary>Types</primary><secondary>FONTABLE</secondary></indexterm></entry> + <entry>FONT or GCONTEXT</entry> + </row> + <row> + <entry id="types:ATOM">ATOM<indexterm zone="types:ATOM" significance="preferred"><primary>Types</primary><secondary>ATOM</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:VISUALID">VISUALID<indexterm zone="types:VISUALID" significance="preferred"><primary>Types</primary><secondary>VISUALID</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:VALUE">VALUE<indexterm zone="types:VALUE" significance="preferred"><primary>Types</primary><secondary>VALUE</secondary></indexterm></entry> + <entry>32-bit quantity (used only in LISTofVALUE)</entry> + </row> + <row> + <entry id="types:BYTE">BYTE<indexterm zone="types:BYTE" significance="preferred"><primary>Types</primary><secondary>BYTE</secondary></indexterm></entry> + <entry>8-bit value</entry> + </row> + <row> + <entry id="types:INT8">INT8<indexterm zone="types:INT8" significance="preferred"><primary>Types</primary><secondary>INT8</secondary></indexterm></entry> + <entry>8-bit signed integer</entry> + </row> + <row> + <entry id="types:INT16">INT16<indexterm zone="types:INT16" significance="preferred"><primary>Types</primary><secondary>INT16</secondary></indexterm></entry> + <entry>16-bit signed integer</entry> + </row> + <row> + <entry id="types:INT32">INT32<indexterm zone="types:INT32" significance="preferred"><primary>Types</primary><secondary>INT32</secondary></indexterm></entry> + <entry>32-bit signed integer</entry> + </row> + <row> + <entry id="types:CARD8">CARD8<indexterm zone="types:CARD8" significance="preferred"><primary>Types</primary><secondary>CARD8</secondary></indexterm></entry> + <entry>8-bit unsigned integer</entry> + </row> + <row> + <entry id="types:CARD16">CARD16<indexterm zone="types:CARD16" significance="preferred"><primary>Types</primary><secondary>CARD16</secondary></indexterm></entry> + <entry>16-bit unsigned integer</entry> + </row> + <row> + <entry id="types:CARD32">CARD32<indexterm zone="types:CARD32" significance="preferred"><primary>Types</primary><secondary>CARD32</secondary></indexterm></entry> + <entry>32-bit unsigned integer</entry> + </row> + <row> + <entry id="types:TIMESTAMP">TIMESTAMP<indexterm zone="types:TIMESTAMP" significance="preferred"><primary>Types</primary><secondary>TIMESTAMP</secondary></indexterm></entry> + <entry>CARD32</entry> + </row> + <row> + <entry id="types:BITGRAVITY">BITGRAVITY<indexterm zone="types:BITGRAVITY" significance="preferred"><primary>Types</primary><secondary>BITGRAVITY</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>Forget</emphasis>, +<emphasis role='bold'>Static</emphasis>, +<emphasis role='bold'>NorthWest</emphasis>, +<emphasis role='bold'>North</emphasis>, +<emphasis role='bold'>NorthEast</emphasis>, +<emphasis role='bold'>West</emphasis>, +<emphasis role='bold'>Center</emphasis>, +<emphasis role='bold'>East</emphasis>, +<emphasis role='bold'>SouthWest</emphasis>, +<emphasis role='bold'>South</emphasis>, +<emphasis role='bold'>SouthEast</emphasis> } + </entry> + </row> + <row> + <entry id="types:WINGRAVITY">WINGRAVITY<indexterm zone="types:WINGRAVITY" significance="preferred"><primary>Types</primary><secondary>WINGRAVITY</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>Unmap</emphasis>, +<emphasis role='bold'>Static</emphasis>, +<emphasis role='bold'>NorthWest</emphasis>, +<emphasis role='bold'>North</emphasis>, +<emphasis role='bold'>NorthEast</emphasis>, +<emphasis role='bold'>West</emphasis>, +<emphasis role='bold'>Center</emphasis>, +<emphasis role='bold'>East</emphasis>, +<emphasis role='bold'>SouthWest</emphasis>, +<emphasis role='bold'>South</emphasis>, +<emphasis role='bold'>SouthEast</emphasis> } + </entry> + </row> + <row> + <entry id="types:BOOL">BOOL<indexterm zone="types:BOOL" significance="preferred"><primary>Types</primary><secondary>BOOL</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>True</emphasis>, +<emphasis role='bold'>False</emphasis> } + </entry> + </row> + <row> + <entry id="types:EVENT">EVENT<indexterm zone="types:EVENT" significance="preferred"><primary>Types</primary><secondary>EVENT</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>KeyPress</emphasis>, +<emphasis role='bold'>KeyRelease</emphasis>, +<emphasis role='bold'>OwnerGrabButton</emphasis>, +<emphasis role='bold'>ButtonPress</emphasis>, +<emphasis role='bold'>ButtonRelease</emphasis>, +<emphasis role='bold'>EnterWindow</emphasis>, +<emphasis role='bold'>LeaveWindow</emphasis>, +<emphasis role='bold'>PointerMotion</emphasis>, +<emphasis role='bold'>PointerMotionHint</emphasis>, +<emphasis role='bold'>Button1Motion</emphasis>, +<emphasis role='bold'>Button2Motion</emphasis>, +<emphasis role='bold'>Button3Motion</emphasis>, +<emphasis role='bold'>Button4Motion</emphasis>, +<emphasis role='bold'>Button5Motion</emphasis>, +<emphasis role='bold'>ButtonMotion</emphasis>, +<emphasis role='bold'>Exposure</emphasis>, +<emphasis role='bold'>VisibilityChange</emphasis>, +<emphasis role='bold'>StructureNotify</emphasis>, +<emphasis role='bold'>ResizeRedirect</emphasis>, +<emphasis role='bold'>SubstructureNotify</emphasis>, +<emphasis role='bold'>SubstructureRedirect</emphasis>, +<emphasis role='bold'>FocusChange</emphasis>, +<emphasis role='bold'>PropertyChange</emphasis>, +<emphasis role='bold'>ColormapChange</emphasis>, +<emphasis role='bold'>KeymapState</emphasis> } + </entry> + </row> + <row> + <entry id="types:POINTEREVENT">POINTEREVENT<indexterm zone="types:POINTEREVENT" significance="preferred"><primary>Types</primary><secondary>POINTEREVENT</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>ButtonPress</emphasis>, +<emphasis role='bold'>ButtonRelease</emphasis>, +<emphasis role='bold'>EnterWindow</emphasis>, +<emphasis role='bold'>LeaveWindow</emphasis>, +<emphasis role='bold'>PointerMotion</emphasis>, +<emphasis role='bold'>PointerMotionHint</emphasis>, +<emphasis role='bold'>Button1Motion</emphasis>, +<emphasis role='bold'>Button2Motion</emphasis>, +<emphasis role='bold'>Button3Motion</emphasis>, +<emphasis role='bold'>Button4Motion</emphasis>, +<emphasis role='bold'>Button5Motion</emphasis>, +<emphasis role='bold'>ButtonMotion</emphasis>, +<emphasis role='bold'>KeymapState</emphasis> } + </entry> + </row> + <row> + <entry id="types:DEVICEEVENT">DEVICEEVENT<indexterm zone="types:DEVICEEVENT" significance="preferred"><primary>Types</primary><secondary>DEVICEEVENT</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>KeyPress</emphasis>, +<emphasis role='bold'>KeyRelease</emphasis>, +<emphasis role='bold'>ButtonPress</emphasis>, +<emphasis role='bold'>ButtonRelease</emphasis>, +<emphasis role='bold'>PointerMotion</emphasis>, +<emphasis role='bold'>Button1Motion</emphasis>, +<emphasis role='bold'>Button2Motion</emphasis>, +<emphasis role='bold'>Button3Motion</emphasis>, +<emphasis role='bold'>Button4Motion</emphasis>, +<emphasis role='bold'>Button5Motion</emphasis>, +<emphasis role='bold'>ButtonMotion</emphasis> } + </entry> + </row> + <row> + <entry id="types:KEYSYM">KEYSYM<indexterm zone="types:KEYSYM" significance="preferred"><primary>Types</primary><secondary>KEYSYM</secondary></indexterm></entry> + <entry>32-bit value (top three bits guaranteed to be zero)</entry> + </row> + <row> + <entry id="types:KEYCODE">KEYCODE<indexterm zone="types:KEYCODE" significance="preferred"><primary>Types</primary><secondary>KEYCODE</secondary></indexterm></entry> + <entry>CARD8</entry> + </row> + <row> + <entry id="types:BUTTON">BUTTON<indexterm zone="types:BUTTON" significance="preferred"><primary>Types</primary><secondary>BUTTON</secondary></indexterm></entry> + <entry>CARD8</entry> + </row> + <row> + <entry id="types:KEYMASK">KEYMASK<indexterm zone="types:KEYMASK" significance="preferred"><primary>Types</primary><secondary>KEYMASK</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>Shift</emphasis>, +<emphasis role='bold'>Lock</emphasis>, +<emphasis role='bold'>Control</emphasis>, +<emphasis role='bold'>Mod1</emphasis>, +<emphasis role='bold'>Mod2</emphasis>, +<emphasis role='bold'>Mod3</emphasis>, +<emphasis role='bold'>Mod4</emphasis>, +<emphasis role='bold'>Mod5</emphasis> } + </entry> + </row> + <row> + <entry id="types:BUTMASK">BUTMASK<indexterm zone="types:BUTMASK" significance="preferred"><primary>Types</primary><secondary>BUTMASK</secondary></indexterm></entry> + <entry> +{ <emphasis role='bold'>Button1</emphasis>, +<emphasis role='bold'>Button2</emphasis>, +<emphasis role='bold'>Button3</emphasis>, +<emphasis role='bold'>Button4</emphasis>, +<emphasis role='bold'>Button5</emphasis> } + </entry> + </row> + <row> + <entry id="types:KEYBUTMASK">KEYBUTMASK<indexterm zone="types:KEYBUTMASK" significance="preferred"><primary>Types</primary><secondary>KEYBUTMASK</secondary></indexterm></entry> + <entry>KEYMASK or BUTMASK</entry> + </row> + <row> + <entry id="types:STRING8">STRING8<indexterm zone="types:STRING8" significance="preferred"><primary>Types</primary><secondary>STRING8</secondary></indexterm></entry> + <entry>LISTofCARD8</entry> + </row> + <row> + <entry id="types:STRING16">STRING16<indexterm zone="types:STRING16" significance="preferred"><primary>Types</primary><secondary>STRING16</secondary></indexterm></entry> + <entry>LISTofCHAR2B</entry> + </row> + <row> + <entry id="types:CHAR2B">CHAR2B<indexterm zone="types:CHAR2B" significance="preferred"><primary>Types</primary><secondary>CHAR2B</secondary></indexterm></entry> + <entry>[byte1, byte2: CARD8]</entry> + </row> + <row> + <entry id="types:POINT">POINT<indexterm zone="types:POINT" significance="preferred"><primary>Types</primary><secondary>POINT</secondary></indexterm></entry> + <entry>[x, y: INT16]</entry> + </row> + <row> + <entry id="types:RECTANGLE">RECTANGLE<indexterm zone="types:RECTANGLE" significance="preferred"><primary>Types</primary><secondary>RECTANGLE</secondary></indexterm></entry> + <entry> +<para>[x, y: INT16,</para> +<para>width, height: CARD16]</para> + </entry> + </row> + <row> + <entry id="types:ARC">ARC<indexterm zone="types:ARC" significance="preferred"><primary>Types</primary><secondary>ARC</secondary></indexterm></entry> + <entry> +<para>[x, y: INT16,</para> +<para>width, height: CARD16,</para> +<para>angle1, angle2: INT16]</para> + </entry> + </row> + <row> + <entry id="types:HOST">HOST<indexterm zone="types:HOST" significance="preferred"><primary>Types</primary><secondary>HOST</secondary></indexterm></entry> + <entry> +<para> +[family: +{ <emphasis role='bold'>Internet</emphasis>, +<emphasis role='bold'>InternetV6</emphasis>, +<emphasis role='bold'>ServerInterpreted</emphasis>, +<emphasis role='bold'>DECnet</emphasis>, +<emphasis role='bold'>Chaos</emphasis> } +</para> +<para>address: LISTofBYTE]</para> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +The [x,y] coordinates of a RECTANGLE specify the upper-left corner. +</para> + +<para> +The primary interpretation of large characters in a STRING16 is that they +are composed of two bytes used to index a two-dimensional matrix, +hence, the use of CHAR2B rather than CARD16. +This corresponds to the JIS/ISO method of indexing 2-byte characters. +It is expected that most large fonts will be defined with 2-byte +matrix indexing. +For large fonts constructed with linear indexing, +a CHAR2B can be interpreted as a 16-bit number by treating byte1 as +the most significant byte. +This means that clients should always transmit such +16-bit character values most significant byte first, as the server will never +byte-swap CHAR2B quantities. +</para> + +<para> +The length, format, and interpretation of a HOST address are specific to the +family (see +<link linkend="requests:ChangeHosts"><emphasis role='bold'>ChangeHosts</emphasis></link> +request). +</para> +</chapter> + +<chapter id='Errors'> +<title>Errors</title> +<!-- .XS --> +<!-- (SN Errors --> +<!-- .XE --> +<para> +<!-- .LP --> +In general, when a request terminates with an error, +the request has no side effects (that is, there is no partial execution). +The only requests for which this is not true are +<link linkend="requests:ChangeWindowAttributes"><emphasis role='bold'>ChangeWindowAttributes</emphasis></link>, +<link linkend="requests:ChangeGC"><emphasis role='bold'>ChangeGC</emphasis></link>, +<link linkend="requests:PolyText8"><emphasis role='bold'>PolyText8</emphasis></link>, +<link linkend="requests:PolyText16"><emphasis role='bold'>PolyText16</emphasis></link>, +<link linkend="requests:FreeColors"><emphasis role='bold'>FreeColors</emphasis></link>, +<link linkend="requests:StoreColors"><emphasis role='bold'>StoreColors</emphasis></link> +and +<link linkend="requests:ChangeKeyboardControl"><emphasis role='bold'>ChangeKeyboardControl</emphasis></link>. +</para> + +<para> +The following error codes result from various requests as follows: +</para> + +<informaltable frame="topbot"> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Error</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry id="errors:Access"><emphasis role='bold'>Access</emphasis><indexterm zone="errors:Access" significance="preferred"><primary>Error Codes</primary><secondary>Access</secondary></indexterm></entry> + <entry> +An attempt is made to grab a key/button combination already grabbed by another +client. +An attempt is made to free a colormap entry not allocated by the client +or to free an entry in a colormap that was created with all entries writable. +An attempt is made to store into a read-only or an unallocated colormap entry. +An attempt is made to modify the access control list from other than the local +host (or otherwise authorized client). +An attempt is made to select an event type that only one client can +select at a time when another client has already selected it. + </entry> + </row> + <row> + <entry id="errors:Alloc"><emphasis role='bold'>Alloc</emphasis><indexterm zone="errors:Alloc" significance="preferred"><primary>Error Codes</primary><secondary>Alloc</secondary></indexterm></entry> + <entry> +The server failed to allocate the requested resource. +Note that the explicit listing of +<emphasis role='bold'>Alloc</emphasis> +errors in request only covers allocation errors at a very coarse level +and is not intended to cover all cases +of a server running out of allocation space in the middle of service. +The semantics when a server runs out of allocation space are left unspecified, +but a server may generate an +<emphasis role='bold'>Alloc</emphasis> +error on any request for this reason, +and clients should be prepared to receive such errors and handle +or discard them. + </entry> + </row> + <row> + <entry id="errors:Atom"><emphasis role='bold'>Atom</emphasis><indexterm zone="errors:Atom" significance="preferred"><primary>Error Codes</primary><secondary>Atom</secondary></indexterm></entry> + <entry> +A value for an ATOM argument does not name a defined ATOM. + </entry> + </row> + <row> + <entry id="errors:Colormap"><emphasis role='bold'>Colormap</emphasis><indexterm zone="errors:Colormap" significance="preferred"><primary>Error Codes</primary><secondary>Colormap</secondary></indexterm></entry> + <entry> +A value for a COLORMAP argument does not name a defined COLORMAP. + </entry> + </row> + <row> + <entry id="errors:Cursor"><emphasis role='bold'>Cursor</emphasis><indexterm zone="errors:Cursor" significance="preferred"><primary>Error Codes</primary><secondary>Cursor</secondary></indexterm></entry> + <entry> +A value for a CURSOR argument does not name a defined CURSOR. + </entry> + </row> + <row> + <entry id="errors:Drawable"><emphasis role='bold'>Drawable</emphasis><indexterm zone="errors:Drawable" significance="preferred"><primary>Error Codes</primary><secondary>Drawable</secondary></indexterm></entry> + <entry> +A value for a DRAWABLE argument does not name a defined WINDOW +or PIXMAP. + </entry> + </row> + <row> + <entry id="errors:Font"><emphasis role='bold'>Font</emphasis><indexterm zone="errors:Font" significance="preferred"><primary>Error Codes</primary><secondary>Font</secondary></indexterm></entry> + <entry> +A value for a FONT argument does not name a defined FONT. +A value for a FONTABLE argument does not name a defined FONT or a +defined GCONTEXT. + </entry> + </row> + <row> + <entry id="errors:GContext"><emphasis role='bold'>GContext</emphasis><indexterm zone="errors:GContext" significance="preferred"><primary>Error Codes</primary><secondary>GContext</secondary></indexterm></entry> + <entry> +A value for a GCONTEXT argument does not name a defined GCONTEXT. + </entry> + </row> + <row> + <entry id="errors:IDChoice"><emphasis role='bold'>IDChoice</emphasis><indexterm zone="errors:IDChoice" significance="preferred"><primary>Error Codes</primary><secondary>IDChoice</secondary></indexterm></entry> + <entry> +The value chosen for a resource identifier either is not included +in the range assigned to the client or is already in use. + </entry> + </row> + <row> + <entry id="errors:Implementation"><emphasis role='bold'>Implementation</emphasis><indexterm zone="errors:Implementation" significance="preferred"><primary>Error Codes</primary><secondary>Implementation</secondary></indexterm></entry> + <entry> +The server does not implement some aspect of the request. +A server that generates this error for a core request is deficient. +As such, this error is not listed for any of the requests, +but clients should be prepared to receive such errors +and handle or discard them. + </entry> + </row> + <row> + <entry id="errors:Length"><emphasis role='bold'>Length</emphasis><indexterm zone="errors:Length" significance="preferred"><primary>Error Codes</primary><secondary>Length</secondary></indexterm></entry> + <entry> +The length of a request is shorter or longer than that required +to minimally contain the arguments. +The length of a request exceeds the maximum length accepted by the +server. + </entry> + </row> + <row> + <entry id="errors:Match"><emphasis role='bold'>Match</emphasis><indexterm zone="errors:Match" significance="preferred"><primary>Error Codes</primary><secondary>Match</secondary></indexterm></entry> + <entry> +An +<emphasis role='bold'>InputOnly</emphasis> +window is used as a DRAWABLE. +In a graphics request, the GCONTEXT argument does not have the same +root and depth as the destination DRAWABLE argument. +Some argument (or pair of arguments) has the correct type and range, +but it fails to match in some other way required by the request. + </entry> + </row> + <row> + <entry id="errors:Name"><emphasis role='bold'>Name</emphasis><indexterm zone="errors:Name" significance="preferred"><primary>Error Codes</primary><secondary>Name</secondary></indexterm></entry> + <entry> +A font or color of the specified name does not exist. + </entry> + </row> + <row> + <entry id="errors:Pixmap"><emphasis role='bold'>Pixmap</emphasis><indexterm zone="errors:Pixmap" significance="preferred"><primary>Error Codes</primary><secondary>Pixmap</secondary></indexterm></entry> + <entry> +A value for a PIXMAP argument does not name a defined PIXMAP. + </entry> + </row> + <row> + <entry id="errors:Request"><emphasis role='bold'>Request</emphasis><indexterm zone="errors:Request" significance="preferred"><primary>Error Codes</primary><secondary>Request</secondary></indexterm></entry> + <entry> +The major or minor opcode does not specify a valid request. + </entry> + </row> + <row> + <entry id="errors:Value"><emphasis role='bold'>Value</emphasis><indexterm zone="errors:Value" significance="preferred"><primary>Error Codes</primary><secondary>Value</secondary></indexterm></entry> + <entry> +Some numeric value falls outside the range of values accepted by the request. +Unless a specific range is specified for an argument, +the full range defined by the argument's type is accepted. +Any argument defined as a set of alternatives typically can generate +this error (due to the encoding). + </entry> + </row> + <row> + <entry id="errors:Window"><emphasis role='bold'>Window</emphasis><indexterm zone="errors:Window" significance="preferred"><primary>Error Codes</primary><secondary>Window</secondary></indexterm></entry> + <entry> +A value for a WINDOW argument does not name a defined WINDOW. + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<note><para> +The +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Pixmap</emphasis> +and +<emphasis role='bold'>Window</emphasis> +errors are also used when the argument type is extended by union with a +set of fixed alternatives, for example, <WINDOW or +<emphasis role='bold'>PointerRoot</emphasis> +or +<emphasis role='bold'>None</emphasis>>. +</para></note> +</chapter> + +<chapter id='Keyboards'> +<title>Keyboards</title> +<indexterm zone="Keyboards"><primary>Keyboard</primary></indexterm> +<!-- .XS --> +<!-- (SN Keyboards --> +<!-- .XE --> +<para id="keycode"> +A KEYCODE represents a physical (or logical) key. +<indexterm zone="keycode"><primary>Types</primary><secondary>KEYCODE</secondary></indexterm> +<indexterm zone="keycode" significance="preferred"><primary>Keycode</primary></indexterm> +Keycodes lie in the inclusive range [8,255]. +A keycode value carries no intrinsic information, +although server implementors may attempt to encode geometry information +(for example, matrix) to be interpreted in a server-dependent fashion. +The mapping between keys and keycodes cannot be changed using the +protocol. +</para> +<para id="keysym"> +A KEYSYM is an encoding of a symbol on the cap of a key. +<indexterm zone="keysym"><primary>Types</primary><secondary>KEYSYM</secondary></indexterm> +<indexterm zone="keysym"><primary>Keysym</primary></indexterm> +The set of defined KEYSYMs include the character sets Latin-1, Latin-2, +Latin-3, Latin-4, Kana, Arabic, Cyrillic, Greek, Tech, Special, Publish, APL, +Hebrew, Thai, and Korean as well as a set of symbols common on keyboards +(Return, Help, Tab, +and so on). +KEYSYMs with the most significant bit (of the 29 bits) set are reserved +as vendor-specific. +</para> +<para> +A list of KEYSYMs is associated with each KEYCODE. +The list is intended to convey the set of symbols on the corresponding key. +If the list (ignoring trailing +<keysym>NoSymbol</keysym> +entries) is a single KEYSYM "<emphasis remap='I'>K</emphasis>", +then the list is treated as if it were +the list "<emphasis remap='I'>K</emphasis> <keysym>NoSymbol</keysym> +<emphasis remap='I'>K</emphasis> <keysym>NoSymbol</keysym>". +If the list (ignoring trailing <keysym>NoSymbol</keysym> entries) +is a pair of KEYSYMs +"<emphasis remap='I'>K1 K2</emphasis>", then the list is treated as +if it were the list +"<emphasis remap='I'>K1 K2 K1 K2</emphasis>". +If the list (ignoring trailing +<keysym>NoSymbol</keysym> +entries) is +a triple of KEYSYMs "<emphasis remap='I'>K1 K2 K3</emphasis>", +then the list is treated as if it were the list " +<emphasis remap='I'>K1 K2 K3</emphasis> <keysym>NoSymbol</keysym>". +When an explicit "void" element is desired in the list, +the value +<keysym>VoidSymbol</keysym> +can be used. +</para> +<para> +<!-- .LP --> +The first four elements of the list are split into two groups of KEYSYMs. +Group 1 contains the first and second KEYSYMs, Group 2 contains the third and +fourth KEYSYMs. +Within each group, +if the second element of the group is +<keysym>NoSymbol</keysym>, +then the group should be treated as if the second element were the +same as the first element, except when the first element is an alphabetic +KEYSYM "<emphasis remap='I'>K</emphasis>" for which both lowercase +and uppercase forms are defined. +In that case, the group should be treated as if the first element were the +lowercase form of "<emphasis remap='I'>K</emphasis>" and the second +element were the uppercase form +of "<emphasis remap='I'>K</emphasis>". +</para> + +<para id="keysym_from_keypress"> +The standard rules for obtaining a KEYSYM from a +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link> +<indexterm zone="keysym_from_keypress"><primary>KeyPress</primary></indexterm> +event make use of only the Group 1 and Group 2 KEYSYMs; no interpretation of +other KEYSYMs in the list is defined. The modifier state determines which +group to use. Switching between groups is controlled by the KEYSYM named +MODE SWITCH, by attaching that KEYSYM to some KEYCODE and attaching that +KEYCODE to any one of the modifiers +<emphasis role='bold'>Mod1</emphasis> +through +<emphasis role='bold'>Mod5</emphasis>. +This modifier is +<indexterm zone="group_modifier" significance="preferred"><primary>modifier</primary><secondary>group</secondary></indexterm> +called the "<firstterm id="group_modifier">group modifier</firstterm>". For any KEYCODE, Group 1 is used when the +group modifier is off, and Group 2 is used when the group modifier is on. +</para> + +<para id="modifier:lock"> +The +<emphasis role='bold'>Lock</emphasis> +<indexterm zone="modifier:lock" significance="preferred"><primary>modifier</primary><secondary>Lock</secondary></indexterm> +modifier is interpreted as CapsLock when the KEYSYM named CAPS +LOCK is attached to some KEYCODE and that KEYCODE is attached to the +<emphasis role='bold'>Lock</emphasis> +modifier. The +<emphasis role='bold'>Lock</emphasis> +modifier is interpreted as ShiftLock when the KEYSYM +named SHIFT LOCK is attached to some KEYCODE and that KEYCODE is attached +to the +<emphasis role='bold'>Lock</emphasis> +modifier. If the +<emphasis role='bold'>Lock</emphasis> +modifier could be interpreted as both +CapsLock and ShiftLock, the CapsLock interpretation is used. +</para> + +<para id="modifier:numlock"> +<!-- .LP --> +The operation of "keypad" keys is controlled by the KEYSYM named NUM LOCK, +by attaching that KEYSYM to some KEYCODE and attaching that KEYCODE to any +one of the modifiers +<emphasis role='bold'>Mod1</emphasis> +through +<emphasis role='bold'>Mod5</emphasis>. +This modifier is called the +<indexterm zone="modifier:lock" significance="preferred"><primary>modifier</primary><secondary>NumLock</secondary></indexterm> +"numlock modifier". The standard KEYSYMs with the prefix KEYPAD in their +name are called "keypad" KEYSYMs; these are KEYSYMS with numeric value in +the hexadecimal range #xFF80 to #xFFBD inclusive. In addition, +vendor-specific KEYSYMS in the hexadecimal range #x11000000 to #x1100FFFF +are also keypad KEYSYMs. +</para> +<para> +<!-- .LP --> +Within a group, the choice of KEYSYM is determined by applying the first +rule that is satisfied from the following list: +</para> + +<itemizedlist> + <listitem> + <para> +The numlock modifier is on and the second KEYSYM is a keypad KEYSYM. In +this case, if the +<emphasis role='bold'>Shift</emphasis> +modifier is on, or if the +<emphasis role='bold'>Lock</emphasis> +modifier is on and +is interpreted as ShiftLock, then the first KEYSYM is used; otherwise, the +second KEYSYM is used. + </para> + </listitem> + <listitem> + <para> +The +<emphasis role='bold'>Shift</emphasis> +and +<emphasis role='bold'>Lock</emphasis> +modifiers are both off. In this case, the first +KEYSYM is used. + </para> + </listitem> + <listitem> + <para> +The +<emphasis role='bold'>Shift</emphasis> +modifier is off, and the +<emphasis role='bold'>Lock</emphasis> +modifier is on and is +interpreted as CapsLock. In this case, the first KEYSYM is used, but if +that KEYSYM is lowercase alphabetic, then the corresponding uppercase +KEYSYM is used instead. + </para> + </listitem> + <listitem> + <para> +The +<emphasis role='bold'>Shift</emphasis> +modifier is on, and the +<emphasis role='bold'>Lock</emphasis> +modifier is on and is interpreted +as CapsLock. In this case, the second KEYSYM is used, but if that KEYSYM +is lowercase alphabetic, then the corresponding uppercase KEYSYM is used +instead. + </para> + </listitem> + <listitem> + <para> +The +<emphasis role='bold'>Shift</emphasis> +modifier is on, or the +<emphasis role='bold'>Lock</emphasis> +modifier is on and is interpreted +as ShiftLock, or both. In this case, the second KEYSYM is used. + </para> + </listitem> +</itemizedlist> + +<para> +<!-- .LP --> +The mapping between KEYCODEs and KEYSYMs is not used directly by the server; +it is merely stored for reading and writing by clients. +</para> +</chapter> + +<chapter id='Pointers'> +<title>Pointers</title> +<!-- .XS --> +<!-- (SN Pointers --> +<!-- .XE --> +<para id="pointers:buttons"> +Buttons are always numbered starting with one. +<indexterm zone="pointers:buttons"><primary>Button</primary><secondary>number</secondary></indexterm> +</para> +</chapter> + +<chapter id='Predefined_Atoms'> +<title>Predefined Atoms</title> +<!-- .XS --> +<!-- (SN Predefined Atoms --> +<!-- .XE --> +<para> +<!-- .LP --> +<indexterm zone="Predefined_Atoms"><primary>Atom</primary><secondary>predefined</secondary></indexterm> +Predefined atoms are not strictly necessary and may not be useful in all +environments, but they will eliminate many +<link linkend="requests:InternAtom"><emphasis role='bold'>InternAtom</emphasis></link> +requests in most applications. +Note that they are predefined only in the sense of having numeric values, +not in the sense of having required semantics. +The core protocol imposes no semantics on these names, +but semantics are specified in other X Window System standards, +such as the +<citetitle>Inter-Client Communication Conventions Manual</citetitle> +and the <citetitle>X Logical Font Description Conventions</citetitle>. +</para> + +<para> +The following names have predefined atom values. +Note that uppercase and lowercase matter. +</para> + +<simplelist type='vert' columns='3'> + <member>ARC</member> + <member>ATOM</member> + <member>BITMAP</member> + <member>CAP_HEIGHT</member> + <member>CARDINAL</member> + <member>COLORMAP</member> + <member>COPYRIGHT</member> + <member>CURSOR</member> + <member>CUT_BUFFER0</member> + <member>CUT_BUFFER1</member> + <member>CUT_BUFFER2</member> + <member>CUT_BUFFER3</member> + <member>CUT_BUFFER4</member> + <member>CUT_BUFFER5</member> + <member>CUT_BUFFER6</member> + <member>CUT_BUFFER7</member> + <member>DRAWABLE</member> + <member>END_SPACE</member> + <member>FAMILY_NAME</member> + <member>FONT</member> + <member>FONT_NAME</member> + <member>FULL_NAME</member> + <member>INTEGER</member> + <member>ITALIC_ANGLE</member> + <member>MAX_SPACE</member> + <member>MIN_SPACE</member> + <member>NORM_SPACE</member> + <member>NOTICE</member> + <member>PIXMAP</member> + <member>POINT</member> + <member>POINT_SIZE</member> + <member>PRIMARY</member> + <member>QUAD_WIDTH</member> + <member>RECTANGLE</member> + <member>RESOLUTION</member> + <member>RESOURCE_MANAGER</member> + <member>RGB_BEST_MAP</member> + <member>RGB_BLUE_MAP</member> + <member>RGB_COLOR_MAP</member> + <member>RGB_DEFAULT_MAP</member> + <member>RGB_GRAY_MAP</member> + <member>RGB_GREEN_MAP</member> + <member>RGB_RED_MAP</member> + <member>SECONDARY</member> + <member>STRIKEOUT_ASCENT</member> + <member>STRIKEOUT_DESCENT</member> + <member>STRING</member> + <member>SUBSCRIPT_X</member> + <member>SUBSCRIPT_Y</member> + <member>SUPERSCRIPT_X</member> + <member>SUPERSCRIPT_Y</member> + <member>UNDERLINE_POSITION</member> + <member>UNDERLINE_THICKNESS</member> + <member>VISUALID</member> + <member>WEIGHT</member> + <member>WINDOW</member> + <member>WM_CLASS</member> + <member>WM_CLIENT_MACHINE</member> + <member>WM_COMMAND</member> + <member>WM_HINTS</member> + <member>WM_ICON_NAME</member> + <member>WM_ICON_SIZE</member> + <member>WM_NAME</member> + <member>WM_NORMAL_HINTS</member> + <member>WM_SIZE_HINTS</member> + <member>WM_TRANSIENT_FOR</member> + <member>WM_ZOOM_HINTS</member> + <member>X_HEIGHT</member> +</simplelist> + +<para> +<!-- .LP --> +To avoid conflicts with possible future names for which semantics might be +imposed (either at the protocol level or in terms of higher level user +interface models), +names beginning with an underscore should be used for atoms +that are private to a particular vendor or organization. +To guarantee no conflicts between vendors and organizations, +additional prefixes need to be used. +However, the protocol does not define the mechanism for choosing such prefixes. +For names private to a single application or end user but stored in globally +accessible locations, +it is suggested that two leading underscores be used to avoid conflicts with +other names. +</para> +</chapter> + +<chapter id='Connection_Setup'> + <title>Connection Setup</title> + <indexterm zone="Connection_Setup"><primary>Connection</primary></indexterm> + + <para> +For remote clients, +the X protocol can be built on top of any reliable byte stream. + </para> + + <section id="connection_initiation"> + <title>Connection Initiation</title> + <indexterm zone="connection_initiation"><primary>Connection</primary><secondary>opening</secondary></indexterm> + + <para id="byte-order"> +The client must send an initial byte of data to identify the byte order to be +employed. +<indexterm zone="byte-order"><primary>Byte order</primary></indexterm> +The value of the byte must be octal 102 or 154. +The value 102 (ASCII uppercase B) means values are transmitted most significant +byte first, and value 154 (ASCII lowercase l) means values are transmitted +least significant byte first. +Except where explicitly noted in the protocol, +all 16-bit and 32-bit quantities sent by the client must be transmitted with +this byte order, +and all 16-bit and 32-bit quantities returned by the server will be transmitted +with this byte order. + </para> + <para> +Following the byte-order byte, +the client sends the following information at connection setup: + </para> + <blockquote> + <para> +protocol-major-version: CARD16 + </para> + <para> +protocol-minor-version: CARD16 + </para> + <para> +authorization-protocol-name: STRING8 + </para> + <para> +authorization-protocol-data: STRING8 + </para> + </blockquote> + <para> +The version numbers indicate what version of the protocol the client +expects the server to implement. + </para> + <para id="authorization"> +The authorization name indicates what authorization (and authentication) +protocol the client +expects the server to use, and the data is specific to that protocol. +<indexterm zone="authorization" significance="preferred"><primary>Authorization</primary></indexterm> +Specification of valid authorization mechanisms is not part of the core +X protocol. +A server that does not implement the protocol the client expects +or that only implements the host-based mechanism may simply ignore this +information. +If both name and data strings are empty, +this is to be interpreted as "no explicit authorization." + </para> + </section> + + <section id="server_response"> + <title>Server Response</title> + + <para> +The client receives the following information at connection setup: + </para> + +<itemizedlist> + <listitem> + <para> +success: +{ <emphasis role='bold'>Failed</emphasis>, +<emphasis role='bold'>Success</emphasis>, +<emphasis role='bold'>Authenticate</emphasis>} + </para> + </listitem> +</itemizedlist> + + <para> +The client receives the following additional data if the returned success +value is +<emphasis role='bold'>Failed</emphasis>, +and the connection is not successfully established: + </para> + +<blockquote> + <para> +protocol-major-version: CARD16 + </para> + <para> +protocol-minor-version: CARD16 + </para> + <para> +reason: STRING8 + </para> +</blockquote> + + <para> +The client receives the following additional data if the returned success +value is +<emphasis role='bold'>Authenticate</emphasis>, +and further authentication negotiation is required: + </para> + +<blockquote> + <para> +reason: STRING8 + </para> +</blockquote> + + <para> +The contents of the reason string are specific to the authorization +protocol in use. The semantics of this authentication negotiation are +not constrained, except that the negotiation must eventually terminate +with a reply from the server containing a success value of +<emphasis role='bold'>Failed</emphasis> +or +<emphasis role='bold'>Success</emphasis>. + </para> + + <para> +The client receives the following additional data if the returned success +value is +<emphasis role='bold'>Success</emphasis>, +and the connection is successfully established: + </para> + +<blockquote> + <para> +protocol-major-version: CARD16 + </para> + <para> +<!-- .br --> +protocol-minor-version: CARD16 + </para> + <para> +<!-- .br --> +vendor: STRING8 + </para> + <para> +<!-- .br --> +release-number: CARD32 + </para> + <para> +<!-- .br --> +resource-id-base, resource-id-mask: CARD32 + </para> + <para> +<!-- .br --> +image-byte-order: +{ <emphasis role='bold'>LSBFirst</emphasis>, +<emphasis role='bold'>MSBFirst</emphasis> } + </para> + <para> +<!-- .br --> +bitmap-scanline-unit: {8, 16, 32} + </para> + <para> +<!-- .br --> +bitmap-scanline-pad: {8, 16, 32} + </para> + <para> +<!-- .br --> +bitmap-bit-order: +{ <emphasis role='bold'>LeastSignificant</emphasis>, +<emphasis role='bold'>MostSignificant</emphasis> } + </para> + <para> +<!-- .br --> +pixmap-formats: LISTofFORMAT + </para> + <para> +<!-- .br --> +roots: LISTofSCREEN + </para> + <para> +<!-- .br --> +motion-buffer-size: CARD32 + </para> + <para> +<!-- .br --> +maximum-request-length: CARD16 + </para> + <para> +<!-- .br --> +min-keycode, max-keycode: KEYCODE + </para> + <para> +where: + </para> + <blockquote> +<informaltable frame="none"> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry>FORMAT:</entry> + <entry>[depth: CARD8,</entry> + </row> + <row> + <entry></entry> + <entry> +bits-per-pixel: {1, 4, 8, 16, 24, 32} + </entry> + </row> + <row> + <entry></entry> + <entry> +scanline-pad: {8, 16, 32}] + </entry> + </row> + <row> + <entry>SCREEN:</entry> + <entry>[root: WINDOW</entry> + </row> + <row> + <entry></entry> + <entry>width-in-pixels, height-in-pixels: CARD16</entry> + </row> + <row> + <entry></entry> + <entry>width-in-millimeters, height-in-millimeters: CARD16</entry> + </row> + <row> + <entry></entry> + <entry>allowed-depths: LISTofDEPTH</entry> + </row> + <row> + <entry></entry> + <entry>root-depth: CARD8</entry> + </row> + <row> + <entry></entry> + <entry>root-visual: VISUALID</entry> + </row> + <row> + <entry></entry> + <entry>default-colormap: COLORMAP</entry> + </row> + <row> + <entry></entry> + <entry>white-pixel, black-pixel: CARD32</entry> + </row> + <row> + <entry></entry> + <entry>min-installed-maps, max-installed-maps: CARD16</entry> + </row> + <row> + <entry></entry> + <entry>backing-stores: {Never, WhenMapped, Always}</entry> + </row> + <row> + <entry></entry> + <entry>save-unders: BOOL</entry> + </row> + <row> + <entry></entry> + <entry>current-input-masks: SETofEVENT]</entry> + </row> + <row> + <entry>DEPTH:</entry> + <entry>[depth: CARD8</entry> + </row> + <row> + <entry></entry> + <entry>visuals: LISTofVISUALTYPE]</entry> + </row> + <row> + <entry>VISUALTYPE:</entry> + <entry>[visual-id: VISUALID</entry> + </row> + <row> + <entry></entry> + <entry> +class: {StaticGray, StaticColor, TrueColor, GrayScale, +PseudoColor, DirectColor} + </entry> + </row> + <row> + <entry></entry> + <entry>red-mask, green-mask, blue-mask: CARD32</entry> + </row> + <row> + <entry></entry> + <entry>bits-per-rgb-value: CARD8</entry> + </row> + <row> + <entry></entry> + <entry>colormap-entries: CARD16]</entry> + </row> + </tbody> + </tgroup> +</informaltable> + </blockquote> +</blockquote> + </section> + + <section id="server_information"> + <title>Server Information</title> + + <para> +The information that is global to the server is: + </para> + + <para> +The protocol version numbers are an escape hatch in case future revisions of +the protocol are necessary. +In general, +the major version would increment for incompatible changes, +and the minor version would increment for small upward compatible changes. +Barring changes, +the major version will be 11, and the minor version will be 0. +The protocol version numbers returned indicate the protocol the server +actually supports. +This might not equal the version sent by the client. +The server can (but need not) refuse connections from clients that offer a +different version than the server supports. +A server can (but need not) support more than one version simultaneously. + </para> + <para> +The vendor string gives some identification of the owner of the server +implementation. +The vendor controls the semantics of the release number. + </para> + <para id="resource-id-mask"> +The resource-id-mask contains a single contiguous set of bits (at least 18). +The client allocates resource IDs for types WINDOW, PIXMAP, +CURSOR, FONT, GCONTEXT, and COLORMAP by choosing a value with only +some subset of these bits set and ORing it with resource-id-base. +<indexterm zone="resource-id-mask"><primary>Resource</primary><secondary>ID</secondary></indexterm> +Only values constructed in this way can be used to name newly created +resources over this connection. +Resource IDs never have the top three bits set. +The client is not restricted to linear or contiguous allocation +of resource IDs. +Once an ID has been freed, +it can be reused. +An ID must be unique with respect to the IDs of all other resources, +not just other resources of the same type. +However, note that the value spaces of resource identifiers, +atoms, visualids, and keysyms are distinguished by context, and +as such, are not required to be disjoint; for example, a given numeric value +might be both a valid window ID, a valid atom, and a valid keysym. + </para> + <para> +Although the server is in general responsible for byte-swapping data to +match the client, +images are always transmitted and received in formats (including byte order) +specified by the server. +The byte order for images is given by image-byte-order and applies to each +scanline unit in XY format (bitmap format) and to each pixel value in Z format. + </para> + <para id="bitmap-format"> +A bitmap is represented in <glossterm linkend="glossary:Scanline_order">scanline order</glossterm>. +<indexterm zone="bitmap-format"><primary>Bitmap</primary><secondary>format</secondary></indexterm> +Each <glossterm linkend="glossary:Scanline">scanline</glossterm> +is padded to a multiple of bits as given by bitmap-scanline-pad. +The pad bits are of arbitrary value. +The scanline is quantized in multiples of bits as given by bitmap-scanline-unit. +The bitmap-scanline-unit is always less than or equal to the +bitmap-scanline-pad. +Within each unit, +the leftmost bit in the bitmap is either the least significant +or most significant bit in the unit, as given by bitmap-bit-order. +<indexterm zone="bitmap-format"><primary>XYFormat</primary></indexterm> +If a pixmap is represented in XY format, +each plane is represented as a bitmap, and the planes appear from +most significant to least significant in bit order with no padding +between planes. + </para> + <para id="pixmap-formats"> +Pixmap-formats contains one entry for each +<glossterm linkend="glossary:Depth">depth</glossterm> value. +<indexterm zone="pixmap-formats"><primary>Pixmap</primary><secondary>format</secondary></indexterm> +<indexterm zone="pixmap-formats"><primary>ZFormat</primary></indexterm> +The entry describes the <glossterm linkend="glossary:ZFormat">Z format</glossterm> +used to represent images of that depth. +An entry for a depth is included if any screen supports that depth, +and all screens supporting that depth must support only that Z format for that +depth. +In Z format, +the pixels are in scanline order, left to right within a scanline. +The number of bits used to hold each pixel is given by bits-per-pixel. +Bits-per-pixel may be larger than strictly required by the depth, +in which case the least significant bits are used to hold +the pixmap data, and the values of the unused high-order bits are +undefined. +When the bits-per-pixel is 4, +the order of nibbles in the byte is the same as the image byte-order. +When the bits-per-pixel is 1, +the format is identical for bitmap format. +Each scanline is padded to a multiple of bits as given by scanline-pad. +When bits-per-pixel is 1, +this will be identical to bitmap-scanline-pad. + </para> + <para> +How a pointing device roams the screens is up to the server +implementation and is transparent to the protocol. +No geometry is defined among screens. + </para> + <para> +The server may retain the recent history of pointer motion and do so to a +finer granularity than is reported by +<link linkend="events:MotionNotify"><emphasis role='bold'>MotionNotify</emphasis></link> +events. +The +<link linkend="requests:GetMotionEvents"><emphasis role='bold'>GetMotionEvents</emphasis></link> +request makes such history available. +The motion-buffer-size gives the approximate maximum number +of elements in the history buffer. + </para> + <para id="Maximum-request-length"> +Maximum-request-length specifies the maximum length of a request +accepted by the server, in 4-byte units. +<indexterm zone="Maximum-request-length"><primary>Request</primary><secondary>length</secondary></indexterm> +That is, length is the maximum value that can appear in the length field of a +request. +Requests larger than this maximum generate a +<emphasis role='bold'>Length</emphasis> +error, +and the server will read and simply discard the entire request. +Maximum-request-length will always be at least 4096 +(that is, requests of length up to and including 16384 bytes +will be accepted by all servers). + </para> + <para id="keycode_range"> +<indexterm zone="keycode_range"><primary>Types</primary><secondary>KEYCODE</secondary></indexterm> +<indexterm zone="keycode_range"><primary>Keycode</primary></indexterm> +Min-keycode and max-keycode specify the smallest and largest keycode +values transmitted by the server. +Min-keycode is never less than 8, +and max-keycode is never greater than 255. +Not all keycodes in this range are required to have corresponding keys. + </para> + </section> + + <section id="screen_information"> + <title>Screen Information</title> + <indexterm zone="screen_information"><primary>Screen</primary></indexterm> + + <para> +The information that applies per screen is: + </para> + + <para> +The allowed-depths specifies what pixmap and window depths are supported. +Pixmaps are supported for each depth listed, +and windows of that depth are supported if at least one visual type is listed +for the depth. +A pixmap depth of one is always supported and listed, +but windows of depth one might not be supported. +A depth of zero is never listed, +but zero-depth +<emphasis role='bold'>InputOnly</emphasis> +windows are always supported. + </para> + <para> +Root-depth and root-visual specify the depth and visual type of the +root window. +Width-in-pixels and height-in-pixels specify the size of +the root window (which cannot be changed). +The class of the root window is always +<emphasis role='bold'>InputOutput</emphasis>. +Width-in-millimeters and height-in-millimeters can be used to determine the +physical size and the aspect ratio. + </para> + <para> +The default-colormap is the one initially associated with the root window. +Clients with minimal color requirements creating windows of +the same depth as the root may want to allocate from this map by +default. + </para> + <para> +Black-pixel and white-pixel can be used in implementing a monochrome +application. +These pixel values are for permanently allocated entries in the +default-colormap. +The actual RGB values may be settable on some screens +and, in any case, may not actually be black and white. +The names are intended to convey the expected relative intensity of the colors. + </para> + <para> +The border of the root window is initially a pixmap filled with the black-pixel. +The initial background of the root window is a pixmap filled with some +unspecified two-color pattern using black-pixel and white-pixel. + </para> + <para> +Min-installed-maps specifies the number of maps that can be guaranteed +to be installed simultaneously (with +<link linkend="requests:InstallColormap"><emphasis role='bold'>InstallColormap</emphasis></link>), +regardless of the number of entries allocated in each map. +Max-installed-maps specifies the maximum number of maps that might possibly be +installed simultaneously, depending on their allocations. +Multiple static-visual colormaps with identical contents but differing in +resource ID should be considered as a single map for the purposes of this +number. +For the typical case of a single hardware colormap, both values will be 1. + </para> + <para id="Backing-stores"> +<indexterm zone="Backing-stores"><primary>Backing store</primary></indexterm> +Backing-stores indicates when the server supports backing stores for +this screen, although it may be storage limited in the number of +windows it can support at once. +If save-unders is +<emphasis role='bold'>True</emphasis>, +the server can support the save-under mode in +<link linkend="requests:CreateWindow"><emphasis role='bold'>CreateWindow</emphasis></link> +and +<link linkend="requests:ChangeWindowAttributes"><emphasis role='bold'>ChangeWindowAttributes</emphasis></link>, +although again it may be storage limited. + </para> + <para> +The current-input-events is what +<link linkend="requests:GetWindowAttributes"><emphasis role='bold'>GetWindowAttributes</emphasis></link> +would return for the all-event-masks for the root window. + </para> + </section> + + <section id="visual_information"> + <title>Visual Information</title> + <indexterm zone="visual_information" significance="preferred"><primary>Visual</primary><secondary>information</secondary></indexterm> + + <para> +The information that applies per visual-type is: + </para> + + <para> +A given visual type might be listed for more than one depth or for +more than one screen. + </para> + + <para id="colormap_types"> +<indexterm zone="colormap_types" significance="preferred"><primary>Colormap</primary><secondary>types</secondary></indexterm> +<indexterm zone="colormap_types"><primary>Pixel value</primary></indexterm> +For +<emphasis role='bold'>PseudoColor</emphasis>, +a pixel value indexes a colormap to produce independent RGB values; +the RGB values can be changed dynamically. +<emphasis role='bold'>GrayScale</emphasis> +is treated in the same way as +<emphasis role='bold'>PseudoColor</emphasis> +except which primary drives the screen is undefined; +thus, the client should always store the +same value for red, green, and blue in colormaps. +For +<emphasis role='bold'>DirectColor</emphasis>, +a pixel value is decomposed into separate RGB subfields, +and each subfield separately indexes the colormap for the corresponding value. +The RGB values can be changed dynamically. +<emphasis role='bold'>TrueColor</emphasis> +is treated in the same way as +<emphasis role='bold'>DirectColor</emphasis> +except the colormap has predefined read-only RGB values. +These values are server-dependent but provide linear or near-linear +increasing ramps in each primary. +<emphasis role='bold'>StaticColor</emphasis> +is treated in the same way as +<emphasis role='bold'>PseudoColor</emphasis> +except the colormap has predefined read-only RGB values, +which are server-dependent. +<emphasis role='bold'>StaticGray</emphasis> +is treated in the same way as +<emphasis role='bold'>StaticColor</emphasis> +except the red, green, and blue values are equal for any +single pixel value, resulting in shades of gray. +<emphasis role='bold'>StaticGray</emphasis> +with a two-entry colormap can be thought of as monochrome. + </para> + + <para> +The red-mask, green-mask, and blue-mask are only defined for +<emphasis role='bold'>DirectColor</emphasis> +and +<emphasis role='bold'>TrueColor</emphasis>. +Each has one contiguous set of bits set to 1 with no intersections. +Usually each mask has the same number of bits set to 1. + </para> + + <para> +The bits-per-rgb-value specifies the log base 2 of the number of +distinct color intensity values (individually) of red, green, and blue. +This number need not bear any relation to the number of colormap entries. +Actual RGB values are always passed in the protocol within a +16-bit spectrum, with 0 being minimum intensity and 65535 being the +maximum intensity. +On hardware that provides a linear zero-based intensity ramp, +the following relationship exists: + </para> + + <para> +<literallayout class="monospaced"> + hw-intensity = protocol-intensity / (65536 / total-hw-intensities) +</literallayout> + </para> + + <para> +Colormap entries are indexed from 0. +The colormap-entries defines the number of available colormap entries in a +newly created colormap. +For +<emphasis role='bold'>DirectColor</emphasis> +and +<emphasis role='bold'>TrueColor</emphasis>, +this will usually be 2 to the power of the maximum number of bits set to 1 in +red-mask, green-mask, and blue-mask. + </para> + </section> +</chapter> + +<chapter id='Requests'> + <title>Requests</title> + <section id="requests:CreateWindow"> + <title>CreateWindow</title> + <indexterm zone="requests:CreateWindow" significance="preferred"><primary>CreateWindow</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>wid</emphasis>, <emphasis remap='I'>parent</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>class</emphasis>: +{ <emphasis role='bold'>InputOutput</emphasis>, +<emphasis role='bold'>InputOnly</emphasis>, +<emphasis role='bold'>CopyFromParent</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>depth</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>visual</emphasis>: VISUALID or +<emphasis role='bold'>CopyFromParent</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, <emphasis remap='I'>border-width</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Pixmap</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request creates an unmapped window and assigns the identifier wid to it. +</para> +<para> +A class of +<emphasis role='bold'>CopyFromParent</emphasis> +means the class is taken from the parent. +A depth of zero for class +<emphasis role='bold'>InputOutput</emphasis> +or +<emphasis role='bold'>CopyFromParent</emphasis> +means the depth is taken from the parent. +A visual of +<emphasis role='bold'>CopyFromParent</emphasis> +means the visual type is taken from the parent. +For class +<emphasis role='bold'>InputOutput</emphasis>, +the visual type and depth must be a combination supported for the screen +(or a +<emphasis role='bold'>Match</emphasis> +error results). +The depth need not be the same as the parent, +but the parent must not be of class +<emphasis role='bold'>InputOnly</emphasis> +(or a +<emphasis role='bold'>Match</emphasis> +error results). +For class +<emphasis role='bold'>InputOnly</emphasis>, +the depth must be zero (or a +<emphasis role='bold'>Match</emphasis> +error results), and the visual must be one supported for the screen (or a +<emphasis role='bold'>Match</emphasis> +error results). +However, the parent can have any depth and class. +</para> +<para> +The server essentially acts as if +<emphasis role='bold'>InputOnly</emphasis> +windows do not exist for the purposes of graphics requests, +exposure processing, and +<link linkend="events:VisibilityNotify"><emphasis role='bold'>VisibilityNotify</emphasis></link> +events. +An +<emphasis role='bold'>InputOnly</emphasis> +window cannot be used as a drawable (as a source or destination for graphics +requests). +<emphasis role='bold'>InputOnly</emphasis> +and +<emphasis role='bold'>InputOutput</emphasis> +windows act identically in other respects-properties, +grabs, input control, and so on. +</para> +<para> +The coordinate system has the X axis horizontal and the Y axis vertical +with the origin [0, 0] at the upper-left corner. +Coordinates are integral, +in terms of pixels, +and coincide with pixel centers. +Each window and pixmap has its own coordinate system. +For a window, +the origin is inside the border at the inside, upper-left corner. +</para> +<para> +The x and y coordinates +for the window are relative to the parent's origin +and specify the position of the upper-left outer corner of the window +(not the origin). +The width and height specify the inside size (not including the border) +and must be nonzero (or a +<emphasis role='bold'>Value</emphasis> +error results). +The border-width for an +<emphasis role='bold'>InputOnly</emphasis> +window must be zero (or a +<emphasis role='bold'>Match</emphasis> +error results). +</para> +<para> +The window is placed on top in the stacking order with respect to siblings. +</para> +<para> +The value-mask and value-list specify attributes of the window that are +to be explicitly initialized. +The possible values are: +</para> +<informaltable frame='topbot'> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Attribute</entry> + <entry>Type</entry> + </row> + </thead> + <tbody> + <row> + <entry>background-pixmap</entry> + <entry> +PIXMAP or +<emphasis role='bold'>None</emphasis> +or +<emphasis role='bold'>ParentRelative</emphasis> + </entry> + </row> + <row> + <entry>background-pixel</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>border-pixmap</entry> + <entry> +PIXMAP or +<emphasis role='bold'>CopyFromParent</emphasis> + </entry> + </row> + <row> + <entry>border-pixel</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>bit-gravity</entry> + <entry>BITGRAVITY</entry> + </row> + <row> + <entry>win-gravity</entry> + <entry>WINGRAVITY</entry> + </row> + <row> + <entry>backing-store</entry> + <entry> +{ <emphasis role='bold'>NotUseful</emphasis>, +<emphasis role='bold'>WhenMapped</emphasis>, +<emphasis role='bold'>Always</emphasis> } + </entry> + </row> + <row> + <entry>backing-planes</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>backing-pixel</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>save-under</entry> + <entry>BOOL</entry> + </row> + <row> + <entry>event-mask</entry> + <entry>SETofEVENT</entry> + </row> + <row> + <entry>do-not-propagate-mask</entry> + <entry>SETofDEVICEEVENT</entry> + </row> + <row> + <entry>override-redirect</entry> + <entry>BOOL</entry> + </row> + <row> + <entry>colormap</entry> + <entry> +COLORMAP or +<emphasis role='bold'>CopyFromParent</emphasis> + </entry> + </row> + <row> + <entry>cursor</entry> + <entry> +CURSOR or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +The default values when attributes are not explicitly initialized +are: +</para> + +<informaltable frame='topbot'> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Attribute</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>background-pixmap</entry> + <entry> +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry>border-pixmap</entry> + <entry> +<emphasis role='bold'>CopyFromParent</emphasis> + </entry> + </row> + <row> + <entry>bit-gravity</entry> + <entry> +<emphasis role='bold'>Forget</emphasis> + </entry> + </row> + <row> + <entry>win-gravity</entry> + <entry> +<emphasis role='bold'>NorthWest</emphasis> + </entry> + </row> + <row> + <entry>backing-store</entry> + <entry> +<emphasis role='bold'>NotUseful</emphasis> + </entry> + </row> + <row> + <entry>backing-planes</entry> + <entry>all ones</entry> + </row> + <row> + <entry>backing-pixel</entry> + <entry>zero</entry> + </row> + <row> + <entry>save-under</entry> + <entry> +<emphasis role='bold'>False</emphasis> + </entry> + </row> + <row> + <entry>event-mask</entry> + <entry>{} (empty set)</entry> + </row> + <row> + <entry>do-not-propagate-mask</entry> + <entry>{} (empty set)</entry> + </row> + <row> + <entry>override-redirect</entry> + <entry> +<emphasis role='bold'>False</emphasis> + </entry> + </row> + <row> + <entry>colormap</entry> + <entry> +<emphasis role='bold'>CopyFromParent</emphasis> + </entry> + </row> + <row rowsep='1'> + <entry>cursor</entry> + <entry> +<emphasis role='bold'>None</emphasis> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +Only the following attributes are defined for +<emphasis role='bold'>InputOnly</emphasis> +windows: +</para> + +<itemizedlist> + <listitem> + <para> +win-gravity + </para> + </listitem> + <listitem> + <para> +event-mask + </para> + </listitem> + <listitem> + <para> +do-not-propagate-mask + </para> + </listitem> + <listitem> + <para> +override-redirect + </para> + </listitem> + <listitem> + <para> +cursor + </para> + </listitem> +</itemizedlist> + +<para> +It is a +<emphasis role='bold'>Match</emphasis> +error to specify any other attributes for +<emphasis role='bold'>InputOnly</emphasis> +windows. +</para> +<para id="requests:CreateWindow:background"> +<indexterm zone="requests:CreateWindow:background"><primary>Background</primary></indexterm> +If background-pixmap is given, +it overrides the default background-pixmap. +The background pixmap and the window must have the +same root and the same depth (or a +<emphasis role='bold'>Match</emphasis> +error results). +Any size pixmap can be used, although some sizes may be faster than others. +If background +<emphasis role='bold'>None</emphasis> +is specified, the window has no defined background. +If background +<emphasis role='bold'>ParentRelative</emphasis> +is specified, the parent's background is used, +but the window must have the same depth as the parent (or a +<emphasis role='bold'>Match</emphasis> +error results). +If the parent has background +<emphasis role='bold'>None</emphasis>, +then the window will also have background +<emphasis role='bold'>None</emphasis>. +A copy of the parent's background is not made. +The parent's background is reexamined each time the window background is +required. +If background-pixel is given, it overrides the default +background-pixmap and any background-pixmap given explicitly, +and a pixmap of undefined size filled with background-pixel is used for the +background. +Range checking is not performed on the background-pixel value; +it is simply truncated to the appropriate number of bits. +For a +<emphasis role='bold'>ParentRelative</emphasis> +background, +the background tile origin always aligns with the parent's background tile +origin. +Otherwise, the background tile origin is always the window origin. +</para> +<para> +When no valid contents are available for regions of a window +and the regions are either visible or the server is maintaining backing store, +the server automatically tiles the regions with the window's background +unless the window has a background of +<emphasis role='bold'>None</emphasis>. +If the background is +<emphasis role='bold'>None</emphasis>, +the previous screen contents from other windows of the same depth as the window +are simply left in place if the contents come from the parent of the window +or an inferior of the parent; +otherwise, the initial contents of the exposed regions are undefined. +Exposure events are then generated for the regions, even if the background is +<emphasis role='bold'>None</emphasis>. +</para> +<para> +The border tile origin is always the same as the background tile origin. +If border-pixmap is given, +it overrides the default border-pixmap. +The border pixmap and the window must have the same root +and the same depth (or a +<emphasis role='bold'>Match</emphasis> +error results). +Any size pixmap can be used, +although some sizes may be faster than others. +If +<emphasis role='bold'>CopyFromParent</emphasis> +is given, the parent's border pixmap is copied (subsequent changes to +the parent's border attribute do not affect the child), +but the window must have the same depth as the parent (or a +<emphasis role='bold'>Match</emphasis> +error results). +The pixmap might be copied by sharing the same pixmap object between the +child and parent or by making a complete copy of the pixmap contents. +If border-pixel is given, +it overrides the default border-pixmap and any border-pixmap given explicitly, +and a pixmap of undefined size filled with border-pixel is used for the border. +Range checking is not performed on the border-pixel value; +it is simply truncated to the appropriate number of bits. +</para> +<para> +Output to a window is always clipped to the inside of the window, +so that the border is never affected. +</para> +<para> +The bit-gravity defines which region of the window should be retained +if the window is resized, and win-gravity defines how the window should +be repositioned if the parent is resized (see +<link linkend="requests:ConfigureWindow"><emphasis role='bold'>ConfigureWindow</emphasis></link> +request). +</para> +<para> +A backing-store of +<emphasis role='bold'>WhenMapped</emphasis> +advises the server that maintaining contents of obscured regions +when the window is mapped would be beneficial. +A backing-store of +<emphasis role='bold'>Always</emphasis> +advises the server that maintaining contents even when the window is +unmapped would be beneficial. +In this case, +the server may generate an exposure event when the window is created. +A value of +<emphasis role='bold'>NotUseful</emphasis> +advises the server that maintaining contents is unnecessary, +although a server may still choose to maintain contents while the window +is mapped. +Note that if the server maintains contents, +then the server should maintain complete contents +not just the region within the parent boundaries, +even if the window is larger than its parent. +While the server maintains contents, +exposure events will not normally be generated, +but the server may stop maintaining contents at any time. +</para> +<para> +If save-under is +<emphasis role='bold'>True</emphasis>, +the server is advised that when this window is +mapped, saving the contents of windows it obscures would be beneficial. +</para> +<para> +When the contents of obscured regions of a window are being maintained, +regions obscured by noninferior windows are included in the +destination (and source, when the window is the source) of graphics +requests, but regions obscured by inferior windows are not included. +</para> +<para> +The backing-planes indicates (with bits set to 1) which bit planes +of the window hold dynamic data that must be preserved in backing-stores +and during save-unders. +The backing-pixel specifies what value to use in planes not +covered by backing-planes. +The server is free to save only the specified bit planes in the backing-store +or save-under and regenerate the remaining planes with the specified pixel +value. +Any bits beyond the specified depth of the window in these +values are simply ignored. +</para> +<para id="requests:CreateWindow:event-mask"> +<indexterm zone="requests:CreateWindow:event-mask"><primary>Event</primary><secondary>mask</secondary></indexterm> +<indexterm zone="requests:CreateWindow:event-mask"><primary>Event</primary><secondary>propagation</secondary></indexterm> +The event-mask defines which events the client is interested in for +this window (or for some event types, inferiors of the window). +The do-not-propagate-mask defines which events should not be propagated to +ancestor windows when no client has the event type selected in this +window. +</para> +<para> +The override-redirect specifies whether map and configure requests on this +window should override a +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent, typically to inform a window manager not to tamper with +the window. +</para> +<para> +The colormap specifies the colormap that best reflects the true +colors of the window. +Servers capable of supporting multiple hardware colormaps may use this +information, and window managers may use it for +<link linkend="requests:InstallColormap"><emphasis role='bold'>InstallColormap</emphasis></link> +requests. +The colormap must have the same visual type and root as the window (or a +<emphasis role='bold'>Match</emphasis> +error results). +If +<emphasis role='bold'>CopyFromParent</emphasis> +is specified, +the parent's colormap is copied (subsequent changes to the parent's +colormap attribute do not affect the child). +However, the window must have the same visual type as the parent (or a +<emphasis role='bold'>Match</emphasis> +error results), and the parent must not have a colormap of +<emphasis role='bold'>None</emphasis> +(or a +<emphasis role='bold'>Match</emphasis> +error results). +For an explanation of +<emphasis role='bold'>None</emphasis>, +see <link linkend="requests:FreeColormap"><emphasis role='bold'>FreeColormap</emphasis></link> +request. +The colormap is copied by sharing the colormap object between the child +and the parent, +not by making a complete copy of the colormap contents. +</para> +<para> +If a cursor is specified, +it will be used whenever the pointer is in the window. +If +<emphasis role='bold'>None</emphasis> +is specified, +the parent's cursor will be used when the pointer is in the window, +and any change in the parent's cursor will cause an immediate change +in the displayed cursor. +</para> +<para> +This request generates a +<link linkend="events:CreateNotify"><emphasis role='bold'>CreateNotify</emphasis></link> +event. +</para> +<para> +The background and border pixmaps and the cursor may be freed +immediately if no further explicit references to them are to be made. +</para> +<para> +Subsequent drawing into the background or border pixmap has an +undefined effect on the window state. +The server might or might not make a copy of the pixmap. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeWindowAttributes"> + <title>ChangeWindowAttributes</title> + <indexterm zone="requests:ChangeWindowAttributes" significance="preferred"><primary>ChangeWindowAttributes</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Pixmap</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The value-mask and value-list specify which attributes are to be changed. +The values and restrictions are the same as for +<link linkend="requests:CreateWindow"><emphasis role='bold'>CreateWindow</emphasis></link>. +</para> +<para> +Setting a new background, whether by background-pixmap or +background-pixel, overrides any previous background. +Setting a new border, whether by border-pixel or border-pixmap, +overrides any previous border. +</para> +<para> +Changing the background does not cause the window contents to be changed. +Setting the border or changing the background such that the +border tile origin changes causes the border to be repainted. +Changing the background of a root window to +<emphasis role='bold'>None</emphasis> +or +<emphasis role='bold'>ParentRelative</emphasis> +restores the default background pixmap. +Changing the border of a root window to +<emphasis role='bold'>CopyFromParent</emphasis> +restores the default border pixmap. +</para> +<para> +Changing the win-gravity does not affect the current position of the +window. +</para> +<para> +Changing the backing-store of an obscured window to +<emphasis role='bold'>WhenMapped</emphasis> +or +<emphasis role='bold'>Always</emphasis> +or changing the backing-planes, backing-pixel, or save-under of +a mapped window may have no immediate effect. +</para> +<para> +Multiple clients can select input on the same window; +their event-masks are disjoint. +When an event is generated, +it will be reported to all interested clients. +However, only one client at a time can select for +<emphasis role='bold'>SubstructureRedirect</emphasis>, +only one client at a time can select for +<emphasis role='bold'>ResizeRedirect</emphasis>, +and only one client at a time can select for +<link linkend="events:ButtonPress"><emphasis role='bold'>ButtonPress</emphasis></link>. +An attempt to violate these restrictions results in an +<emphasis role='bold'>Access</emphasis> +error. +</para> +<para> +There is only one do-not-propagate-mask for a window, not one per +client. +</para> +<para> +Changing the colormap of a window (by defining a new map, not by +changing the contents of the existing map) generates a +<link linkend="events:ColormapNotify"><emphasis role='bold'>ColormapNotify</emphasis></link> +event. +Changing the colormap of a visible window might have no immediate effect +on the screen (see +<link linkend="requests:InstallColormap"><emphasis role='bold'>InstallColormap</emphasis></link> +request). +</para> +<para> +Changing the cursor of a root window to +<emphasis role='bold'>None</emphasis> +restores the default cursor. +</para> +<para> +The order in which attributes are verified and altered is server-dependent. +If an error is generated, +a subset of the attributes may have been altered. +<!-- .sp --> +</para> + </section> + <section id="requests:GetWindowAttributes"> + <title>GetWindowAttributes</title> + <indexterm zone="requests:GetWindowAttributes" significance="preferred"><primary>GetWindowAttributes</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +visual: VISUALID + </entry> + </row> + <row> + <entry> +class: +{ <emphasis role='bold'>InputOutput</emphasis>, +<emphasis role='bold'>InputOnly</emphasis>} + </entry> + </row> + <row> + <entry> +bit-gravity: BITGRAVITY + </entry> + </row> + <row> + <entry> +win-gravity: WINGRAVITY + </entry> + </row> + <row> + <entry> +backing-store: +{ <emphasis role='bold'>NotUseful</emphasis>, +<emphasis role='bold'>WhenMapped</emphasis>, +<emphasis role='bold'>Always</emphasis>} + </entry> + </row> + <row> + <entry> +backing-planes: CARD32 + </entry> + </row> + <row> + <entry> +backing-pixel: CARD32 + </entry> + </row> + <row> + <entry> +save-under: BOOL + </entry> + </row> + <row> + <entry> +colormap: COLORMAP or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +map-is-installed: BOOL + </entry> + </row> + <row> + <entry> +map-state: +{ <emphasis role='bold'>Unmapped</emphasis>, +<emphasis role='bold'>Unviewable</emphasis>, +<emphasis role='bold'>Viewable</emphasis>} + </entry> + </row> + <row> + <entry> +all-event-masks, your-event-mask: SETofEVENT + </entry> + </row> + <row> + <entry> +do-not-propagate-mask: SETofDEVICEEVENT + </entry> + </row> + <row> + <entry> +override-redirect: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current attributes of the window. +A window is +<emphasis role='bold'>Unviewable</emphasis> +if it is mapped but some ancestor is unmapped. +All-event-masks is the inclusive-OR of all event masks selected on the window +by clients. +Your-event-mask is the event mask selected by the querying client. +<!-- .sp --> +</para> + </section> + <section id="requests:DestroyWindow"> + <title>DestroyWindow</title> + <indexterm zone="requests:DestroyWindow" significance="preferred"><primary>DestroyWindow</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the argument window is mapped, +an +<link linkend="requests:UnmapWindow"><emphasis role='bold'>UnmapWindow</emphasis></link> +request is performed automatically. +The window and all inferiors are then destroyed, and a +<link linkend="events:DestroyNotify"><emphasis role='bold'>DestroyNotify</emphasis></link> +event is generated for each window. +The ordering of the +<emphasis role='bold'>DestroyNotify</emphasis> +events is such that for any given window, +<emphasis role='bold'>DestroyNotify</emphasis> +is generated on all inferiors of the window before being generated on +the window itself. +The ordering among siblings and across subhierarchies is not otherwise +constrained. +</para> +<para> +Normal exposure processing on formerly obscured windows is performed. +</para> +<para> +If the window is a root window, +this request has no effect. +<!-- .sp --> +</para> + </section> + <section id="requests:DestroySubwindows"> + <title>DestroySubwindows</title> + <indexterm zone="requests:DestroySubwindows" significance="preferred"><primary>DestroySubwindows</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request performs a +<link linkend="requests:DestroyWindow"><emphasis role='bold'>DestroyWindow</emphasis></link> +request on all children of the window, in bottom-to-top stacking order. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeSaveSet"> + <title>ChangeSaveSet</title> + <indexterm zone="requests:ChangeSaveSet" significance="preferred"><primary>ChangeSaveSet</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Insert</emphasis>, +<emphasis role='bold'>Delete</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +Errors: +<!-- .in +.2i --> +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request adds or removes the specified window from the client's +save-set. +The window must have been created by some other client (or a +<emphasis role='bold'>Match</emphasis> +error results). +For further information about the use of the save-set, +see <link linkend='Connection_Close'>section 10</link>. +</para> +<para> +When windows are destroyed, +the server automatically removes them from the save-set. +<!-- .sp --> +</para> + </section> + <section id="requests:ReparentWindow"> + <title>ReparentWindow</title> + <indexterm zone="requests:ReparentWindow" significance="preferred"><primary>ReparentWindow</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>, <emphasis remap='I'>parent</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the window is mapped, +an +<link linkend="requests:UnmapWindow"><emphasis role='bold'>UnmapWindow</emphasis></link> +request is performed automatically first. +The window is then removed from its current position in the hierarchy +and is inserted as a child of the specified parent. +The x and y coordinates are relative to the parent's origin +and specify the new position of the upper-left outer corner of the +window. +The window is placed on top in the stacking order with respect +to siblings. +A +<link linkend="events:ReparentNotify"><emphasis role='bold'>ReparentNotify</emphasis></link> +event is then generated. +The override-redirect attribute of the window is passed on in this event; +a value of +<emphasis role='bold'>True</emphasis> +indicates that a window manager should not tamper with this window. +Finally, if the window was originally mapped, a +<link linkend="requests:MapWindow"><emphasis role='bold'>MapWindow</emphasis></link> +request is performed automatically. +</para> +<para> +Normal exposure processing on formerly obscured windows is performed. +The server might not generate exposure events for regions from the +initial unmap that are immediately obscured by the final map. +</para> +<para> +A +<emphasis role='bold'>Match</emphasis> +error is generated if: +<!-- .IP bu 5 --> +The new parent is not on the same screen as the old parent. +<!-- .IP bu 5 --> +The new parent is the window itself or an inferior of the window. +<!-- .IP bu 5 --> +The new parent is +<emphasis role='bold'>InputOnly</emphasis>, +and the window is not. +<!-- .IP bu 5 --> +The window has a +<emphasis role='bold'>ParentRelative</emphasis> +background, and the new parent is not the same depth as the window. +<!-- .sp --> +</para> + </section> + <section id="requests:MapWindow"> + <title>MapWindow</title> + <indexterm zone="requests:MapWindow" significance="preferred"><primary>MapWindow</primary></indexterm> + <indexterm zone="requests:MapWindow"><primary>Mapped window</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the window is already mapped, this request has no effect. +</para> +<para> +If the override-redirect attribute of the window is +<emphasis role='bold'>False</emphasis> +and some other client has selected +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent, then a +<link linkend="events:MapRequest"><emphasis role='bold'>MapRequest</emphasis></link> +event is generated, but the window remains unmapped. +Otherwise, the window is mapped, +and a +<link linkend="events:MapNotify"><emphasis role='bold'>MapNotify</emphasis></link> +event is generated. +</para> +<para> +If the window is now viewable and its contents have been discarded, +the window is tiled with its background (if no background is defined, +the existing screen contents are not altered), and zero or more exposure +events are generated. +If a backing-store has been maintained while the window was unmapped, +no exposure events are generated. +If a backing-store will now be maintained, +a full-window exposure is always generated. +Otherwise, only visible regions may be reported. +Similar tiling and exposure take place for any newly viewable inferiors. +<!-- .sp --> +</para> + </section> + <section id="requests:MapSubwindows"> + <title>MapSubwindows</title> + <indexterm zone="requests:MapSubwindows" significance="preferred"><primary>MapSubwindows</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request performs a +<link linkend="requests:MapWindow"><emphasis role='bold'>MapWindow</emphasis></link> +request on all unmapped children of the window, +in top-to-bottom stacking order. +<!-- .sp --> +</para> + </section> + <section id="requests:UnmapWindow"> + <title>UnmapWindow</title> + <indexterm zone="requests:UnmapWindow" significance="preferred"><primary>UnmapWindow</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the window is already unmapped, this request has no effect. +Otherwise, the window is unmapped, and an +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link> +event is generated. +Normal exposure processing on formerly obscured windows is performed. +<!-- .sp --> +</para> + </section> + <section id="requests:UnmapSubwindows"> + <title>UnmapSubwindows</title> + <indexterm zone="requests:UnmapSubwindows" significance="preferred"><primary>UnmapSubwindows</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request performs an +<link linkend="requests:UnmapWindow"><emphasis role='bold'>UnmapWindow</emphasis></link> +request on all mapped children of the window, +in bottom-to-top stacking order. +<!-- .sp --> +</para> + </section> + <section id="requests:ConfigureWindow"> + <title>ConfigureWindow</title> + <indexterm zone="requests:ConfigureWindow" significance="preferred"><primary>ConfigureWindow</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes the configuration of the window. +The value-mask and value-list specify which values are to be given. +The possible values are: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Attribute</entry> + <entry>Type</entry> + </row> + </thead> + <tbody> + <row> + <entry>x</entry> + <entry>INT16</entry> + </row> + <row> + <entry>y</entry> + <entry>INT16</entry> + </row> + <row> + <entry>width</entry> + <entry>CARD16</entry> + </row> + <row> + <entry>height</entry> + <entry>CARD16</entry> + </row> + <row> + <entry>border-width</entry> + <entry>CARD16</entry> + </row> + <row> + <entry>sibling</entry> + <entry>WINDOW</entry> + </row> + <row> + <entry>stack-mode</entry> + <entry> +{ <emphasis role='bold'>Above</emphasis>, +<emphasis role='bold'>Below</emphasis>, +<emphasis role='bold'>TopIf</emphasis>, +<emphasis role='bold'>BottomIf</emphasis>, +<emphasis role='bold'>Opposite</emphasis> } + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +The x and y coordinates are relative to the parent's origin +and specify the position of the upper-left outer corner of the window. +The width and height specify the inside size, not including the border, and +must be nonzero (or a +<emphasis role='bold'>Value</emphasis> +error results). +Those values not specified are taken from the existing geometry of the window. +Note that changing just the border-width leaves the outer-left corner +of the window in a fixed position but moves the absolute position of the +window's origin. +It is a +<emphasis role='bold'>Match</emphasis> +error to attempt to make the border-width of an +<emphasis role='bold'>InputOnly</emphasis> +window nonzero. +</para> +<para> +If the override-redirect attribute of the window is +<emphasis role='bold'>False</emphasis> +and some other client has selected +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent, a +<link linkend="events:ConfigureRequest"><emphasis role='bold'>ConfigureRequest</emphasis></link> +event is generated, and no further processing is performed. +Otherwise, the following is performed: +</para> +<para> +If some other client has selected +<emphasis role='bold'>ResizeRedirect</emphasis> +on the window and the inside width or height of the window is being changed, +a +<link linkend="events:ResizeRequest"><emphasis role='bold'>ResizeRequest</emphasis></link> +event is generated, +and the current inside width and height are used instead. +Note that the override-redirect attribute of the window has no effect on +<emphasis role='bold'>ResizeRedirect</emphasis> +and that +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent has precedence over +<emphasis role='bold'>ResizeRedirect</emphasis> +on the window. +</para> +<para id="requests:ConfigureWindow:gravity"> +<indexterm zone="requests:ConfigureWindow:gravity"><primary>Gravity</primary></indexterm> +<indexterm zone="requests:ConfigureWindow:gravity"><primary>Bit</primary><secondary>gravity</secondary></indexterm> +<indexterm zone="requests:ConfigureWindow:gravity"><primary>Window</primary><secondary>gravity</secondary></indexterm> +The geometry of the window is changed as specified, +the window is restacked among siblings, and a +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link> +event is generated if the state of the window actually changes. +If the inside width or height of the window has actually changed, +then children of the window are affected, +according to their win-gravity. +Exposure processing is performed on formerly obscured windows +(including the window itself and its inferiors if regions of them were +obscured but now are not). +Exposure processing is also performed on any new regions of the window +(as a result of increasing the width or height) +and on any regions where window contents are lost. +</para> +<para> +If the inside width or height of a window is not changed +but the window is moved or its border is changed, +then the contents of the window are not lost but move with the window. +Changing the inside width or height of the window causes its contents to be +moved or lost, depending on the bit-gravity of the window. +It also causes children to be reconfigured, depending on their win-gravity. +For a change of width and height of W and H, +we define the [x, y] pairs as: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Direction</entry> + <entry>Deltas</entry> + </row> + </thead> + <tbody> + <row> + <entry> +<emphasis role='bold'>NorthWest</emphasis> + </entry> + <entry>[0, 0]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>North</emphasis> + </entry> + <entry>[W/2, 0]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>NorthEast</emphasis> + </entry> + <entry>[W, 0]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>West</emphasis> + </entry> + <entry>[0, H/2]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Center</emphasis> + </entry> + <entry>[W/2, H/2]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>East</emphasis> + </entry> + <entry>[W, H/2]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>SouthWest</emphasis> + </entry> + <entry>[0, H]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>South</emphasis> + </entry> + <entry>[W/2, H]</entry> + </row> + <row> + <entry> +<emphasis role='bold'>SouthEast</emphasis> + </entry> + <entry>[W, H]</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +When a window with one of these bit-gravities is resized, +the corresponding pair defines the change in position of each pixel in the +window. +When a window with one of these win-gravities has its parent window resized, +the corresponding pair defines the change in position +of the window within the parent. +This repositioning generates a +<link linkend="events:GravityNotify"><emphasis role='bold'>GravityNotify</emphasis></link> +event. +<emphasis role='bold'>GravityNotify</emphasis> +events are generated after the +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link> +event is generated. +</para> +<para> +A gravity of +<emphasis role='bold'>Static</emphasis> +indicates that the contents or origin should not move relative to the origin +of the root window. +If the change in size of the window is coupled with a change +in position of [X, Y], +then for bit-gravity the change in position of each pixel is [-X, -Y] and for +win-gravity the change in position of a child when its parent is so +resized is [-X, -Y]. +Note that +<emphasis role='bold'>Static</emphasis> +gravity still only takes effect when the width or height of the +window is changed, not when the window is simply moved. +</para> +<para> +A bit-gravity of +<emphasis role='bold'>Forget</emphasis> +indicates that the window contents are always discarded after a size change, +even if backing-store or save-under has been requested. +The window is tiled with its background (except, if no background is defined, +the existing screen contents are not altered) +and zero or more exposure events are generated. +</para> +<para> +The contents and borders of inferiors are not affected by their parent's +bit-gravity. +A server is permitted to ignore the specified bit-gravity and use +<emphasis role='bold'>Forget</emphasis> +instead. +</para> +<para> +A win-gravity of +<emphasis role='bold'>Unmap</emphasis> +is like +<emphasis role='bold'>NorthWest</emphasis>, +but the child is also unmapped when the parent is resized, +and an +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link> +event is generated. +<emphasis role='bold'>UnmapNotify</emphasis> +events are generated after the +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link> +event is generated. +</para> +<para> +If a sibling and a stack-mode are specified, +the window is restacked as follows: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='3.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>Above</emphasis> + </entry> + <entry> +The window is placed just above the sibling. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Below</emphasis> + </entry> + <entry> +The window is placed just below the sibling. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>TopIf</emphasis> + </entry> + <entry> +If the sibling occludes the window, +then the window is placed at the top of the stack. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>BottomIf</emphasis> + </entry> + <entry> +If the window occludes the sibling, +then the window is placed at the bottom of the stack. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Opposite</emphasis> + </entry> + <entry> +If the sibling occludes the window, +then the window is placed at the top of the stack. +Otherwise, if the window occludes the sibling, +then the window is placed at the bottom of the stack. + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +If a stack-mode is specified but no sibling is specified, +the window is restacked as follows: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='3.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>Above</emphasis> + </entry> + <entry> +The window is placed at the top of the stack. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Below</emphasis> + </entry> + <entry> +The window is placed at the bottom of the stack. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>TopIf</emphasis> + </entry> + <entry> +If any sibling occludes the window, +then the window is placed at the top of the stack. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>BottomIf</emphasis> + </entry> + <entry> +If the window occludes any sibling, +then the window is placed at the bottom of the stack. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Opposite</emphasis> + </entry> + <entry> +If any sibling occludes the window, +then the window is placed at the top of the stack. +Otherwise, if the window occludes any sibling, +then the window is placed at the bottom of the stack. + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +It is a +<emphasis role='bold'>Match</emphasis> +error if a sibling is specified without a stack-mode +or if the window is not actually a sibling. +</para> +<para> +Note that the computations for +<emphasis role='bold'>BottomIf</emphasis>, +<emphasis role='bold'>TopIf</emphasis>, +and +<emphasis role='bold'>Opposite</emphasis> +are performed with respect to the window's final geometry (as controlled by +the other arguments to the request), not to its initial geometry. +</para> +<para> +Attempts to configure a root window have no effect. +</para> + + </section> + <section id="requests:CirculateWindow"> + <title>CirculateWindow</title> + <indexterm zone="requests:CirculateWindow" significance="preferred"><primary>CirculateWindow</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>direction</emphasis>: +{ <emphasis role='bold'>RaiseLowest</emphasis>, +<emphasis role='bold'>LowerHighest</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If some other client has selected +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the window, then a +<link linkend="events:CirculateRequest"><emphasis role='bold'>CirculateRequest</emphasis></link> +event is generated, and no further processing is performed. +Otherwise, the following is performed, and then a +<link linkend="events:CirculateNotify"><emphasis role='bold'>CirculateNotify</emphasis></link> +event is generated if the window is actually restacked. +</para> +<para> +For +<emphasis role='bold'>RaiseLowest</emphasis>, +<emphasis role='bold'>CirculateWindow</emphasis> +raises the lowest mapped child (if any) that is +occluded by another child to the top of the stack. +For +<emphasis role='bold'>LowerHighest</emphasis>, +<emphasis role='bold'>CirculateWindow</emphasis> +lowers the highest mapped child (if any) that occludes another child to +the bottom of the stack. +Exposure processing is performed on formerly obscured windows. +<!-- .sp --> +</para> + </section> + <section id="requests:GetGeometry"> + <title>GetGeometry</title> + <indexterm zone="requests:GetGeometry" significance="preferred"><primary>GetGeometry</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +root: WINDOW + </entry> + </row> + <row> + <entry> +depth: CARD8 + </entry> + </row> + <row> + <entry> +x, y: INT16 + </entry> + </row> + <row> + <entry> +width, height, border-width: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the root and current geometry of the drawable. +The depth is the number of bits per pixel for the object. +The x, y, and border-width will always be zero for pixmaps. +For a window, +the x and y coordinates specify the upper-left outer corner of the window +relative to its parent's origin, +and the width and height specify the inside size, not including the border. +</para> +<para> +It is legal to pass an +<emphasis role='bold'>InputOnly</emphasis> +window as a drawable to this request. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryTree"> + <title>QueryTree</title> + <indexterm zone="requests:QueryTree" significance="preferred"><primary>QueryTree</primary></indexterm> + <indexterm zone="requests:QueryTree"><primary>Children</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +root: WINDOW + </entry> + </row> + <row> + <entry> +parent: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +children: LISTofWINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the root, the parent, and the children of the window. +The children are listed in bottom-to-top stacking order. +<!-- .sp --> +</para> + </section> + <section id="requests:InternAtom"> + <title>InternAtom</title> + <indexterm zone="requests:InternAtom" significance="preferred"><primary>InternAtom</primary></indexterm> + <indexterm zone="requests:InternAtom"><primary>Atom</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>name</emphasis>: STRING8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>only-if-exists</emphasis>: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +atom: ATOM or +<emphasis role='bold'>None</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the atom for the given name. +If only-if-exists is +<emphasis role='bold'>False</emphasis>, +then the atom is created if it does not exist. +The string should use the ISO Latin-1 encoding. +Uppercase and lowercase matter. +</para> +<para> +The lifetime of an atom is not tied to the interning client. +Atoms remain defined until server reset (see <link linkend='Connection_Close'>section 10</link>). +<!-- .sp --> +</para> + </section> + <section id="requests:GetAtomName"> + <title>GetAtomName</title> + <indexterm zone="requests:GetAtomName" significance="preferred"><primary>GetAtomName</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>atom</emphasis>: ATOM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +name: STRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the name for the given atom. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeProperty"> + <title>ChangeProperty</title> + <indexterm zone="requests:ChangeProperty" significance="preferred"><primary>ChangeProperty</primary></indexterm> + <indexterm zone="requests:ChangeProperty"><primary>Property</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>property</emphasis>, <emphasis remap='I'>type</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>format</emphasis>: {8, 16, 32} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Replace</emphasis>, +<emphasis role='bold'>Prepend</emphasis>, +<emphasis role='bold'>Append</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>data</emphasis>: LISTofINT8 or LISTofINT16 or LISTofINT32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request alters the property for the specified window. +The type is uninterpreted by the server. +The format specifies whether the data should be viewed as a list of 8-bit, +16-bit, or 32-bit quantities so that the server can correctly byte-swap +as necessary. +</para> +<para> +If the mode is +<emphasis role='bold'>Replace</emphasis>, +the previous property value is discarded. +If the mode is +<emphasis role='bold'>Prepend</emphasis> +or +<emphasis role='bold'>Append</emphasis>, +then the type and format must match the existing property value (or a +<emphasis role='bold'>Match</emphasis> +error results). +If the property is undefined, +it is treated as defined with the correct type +and format with zero-length data. +For +<emphasis role='bold'>Prepend</emphasis>, +the data is tacked on to the beginning of the existing data, and for +<emphasis role='bold'>Append</emphasis>, +it is tacked on to the end of the existing data. +</para> +<para> +This request generates a +<link linkend="events:PropertyNotify"><emphasis role='bold'>PropertyNotify</emphasis></link> +event on the window. +</para> +<para> +The lifetime of a property is not tied to the storing client. +Properties remain until explicitly deleted, until the window is destroyed, +or until server reset (see <link linkend='Connection_Close'>section 10</link>). +</para> +<para> +The maximum size of a property is server-dependent and may vary dynamically. +<!-- .sp --> +</para> + </section> + <section id="requests:DeleteProperty"> + <title>DeleteProperty</title> + <indexterm zone="requests:DeleteProperty" significance="preferred"><primary>DeleteProperty</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>property</emphasis>: ATOM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request deletes the property from the specified window +if the property exists and generates a +<link linkend="events:PropertyNotify"><emphasis role='bold'>PropertyNotify</emphasis></link> +event on the window unless the property does not exist. +<!-- .sp --> +</para> + </section> + <section id="requests:GetProperty"> + <title>GetProperty</title> + <indexterm zone="requests:GetProperty" significance="preferred"><primary>GetProperty</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>property</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>type</emphasis>: ATOM or +<emphasis role='bold'>AnyPropertyType</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>long-offset</emphasis>, <emphasis remap='I'>long-length</emphasis>: CARD32 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>delete</emphasis>: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +type: ATOM or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +format: {0, 8, 16, 32} + </entry> + </row> + <row> + <entry> +bytes-after: CARD32 + </entry> + </row> + <row> + <entry> +value: LISTofINT8 or LISTofINT16 or LISTofINT32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the specified property does not exist for the specified window, +then the return type is +<emphasis role='bold'>None</emphasis>, +the format and bytes-after are zero, +and the value is empty. +The delete argument is ignored in this case. +If the specified property exists but its type does not match the specified type, +then the return type is the actual type of the property, +the format is the actual format of the property (never zero), +the bytes-after is the length of the property in bytes +(even if the format is 16 or 32), +and the value is empty. +The delete argument is ignored in this case. +If the specified property exists and either +<emphasis role='bold'>AnyPropertyType</emphasis> +is specified or the specified type matches the actual type of the property, +then the return type is the actual type of the property, +the format is the actual format of the property (never zero), +and the bytes-after and value are as follows, given: +<literallayout class="monospaced"> + N = actual length of the stored property in bytes + (even if the format is 16 or 32) + I = 4 * long-offset + T = N - I + L = MINIMUM(T, 4 * long-length) + A = N - (I + L) +</literallayout> +</para> +<para> +The returned value starts at byte index I in the property (indexing from 0), +and its length in bytes is L. +However, it is a +<emphasis role='bold'>Value</emphasis> +error if long-offset is given such that L is negative. +The value of bytes-after is A, +giving the number of trailing unread bytes in the stored +property. +If delete is +<emphasis role='bold'>True</emphasis> +and the bytes-after is zero, +the property is also deleted from the window, +and a +<link linkend="events:PropertyNotify"><emphasis role='bold'>PropertyNotify</emphasis></link> +event is generated on the window. +<!-- .sp --> +</para> + </section> + <section id="requests:RotateProperties"> + <title>RotateProperties</title> + <indexterm zone="requests:RotateProperties" significance="preferred"><primary>RotateProperties</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>delta</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>properties</emphasis>: LISTofATOM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the property names in the list are viewed as being numbered starting +from zero, and there are N property names in the list, +then the value associated with property name I becomes the value +associated with property name (I + delta) mod N, for all I from zero to N - 1. +The effect is to rotate the states by delta places around the virtual ring +of property names (right for positive delta, left for negative delta). +</para> +<para> +If delta mod N is nonzero, +a +<link linkend="events:PropertyNotify"><emphasis role='bold'>PropertyNotify</emphasis></link> +event is generated for each property in the order listed. +</para> +<para> +If an atom occurs more than once in the list or no property with that +name is defined for the window, +a +<emphasis role='bold'>Match</emphasis> +error is generated. +If an +<emphasis role='bold'>Atom</emphasis> +or +<emphasis role='bold'>Match</emphasis> +error is generated, no properties are changed. +<!-- .sp --> +</para> + </section> + <section id="requests:ListProperties"> + <title>ListProperties</title> + <indexterm zone="requests:ListProperties" significance="preferred"><primary>ListProperties</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +atoms: LISTofATOM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the atoms of properties currently defined on the window. +<!-- .sp --> +</para> + </section> + <section id="requests:SetSelectionOwner"> + <title>SetSelectionOwner</title> + <indexterm zone="requests:SetSelectionOwner" significance="preferred"><primary>SetSelectionOwner</primary></indexterm> + <indexterm zone="requests:SetSelectionOwner"><primary>Selection</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>selection</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>owner</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes the owner, owner window, +and last-change time of the specified selection. +This request has no effect if the specified time is earlier +than the current last-change time of the specified selection or is +later than the current server time. +Otherwise, the last-change time is set to the specified time +with +<emphasis role='bold'>CurrentTime</emphasis> +replaced by the current server time. +If the owner window is specified as +<emphasis role='bold'>None</emphasis>, +then the owner of the selection becomes +<emphasis role='bold'>None</emphasis> +(that is, no owner). +Otherwise, the owner of the selection becomes the client executing the request. +If the new owner (whether a client or +<emphasis role='bold'>None</emphasis>) +is not the same as the current owner +and the current owner is not +<emphasis role='bold'>None</emphasis>, +then the current owner is sent a +<link linkend="events:SelectionClear"><emphasis role='bold'>SelectionClear</emphasis></link> +event. +</para> +<para> +If the client that is the owner of a selection is later terminated +(that is, its connection is closed) or if the owner window it has +specified in the request is later destroyed, +then the owner of the selection automatically reverts to +<emphasis role='bold'>None</emphasis>, +but the last-change time is not affected. +</para> +<para> +The selection atom is uninterpreted by the server. +The owner window is returned by the +<link linkend="requests:GetSelectionOwner"><emphasis role='bold'>GetSelectionOwner</emphasis></link> +request and is reported in +<link linkend="events:SelectionRequest"><emphasis role='bold'>SelectionRequest</emphasis></link> +and +<link linkend="events:SelectionClear"><emphasis role='bold'>SelectionClear</emphasis></link> +events. +</para> +<para> +Selections are global to the server. +<!-- .sp --> +</para> + </section> + <section id="requests:GetSelectionOwner"> + <title>GetSelectionOwner</title> + <indexterm zone="requests:GetSelectionOwner" significance="preferred"><primary>GetSelectionOwner</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>selection</emphasis>: ATOM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +owner: WINDOW or +<emphasis role='bold'>None</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current owner window of the specified selection, +if any. +If +<emphasis role='bold'>None</emphasis> +is returned, then there is no owner for the selection. +<!-- .sp --> +</para> + </section> + <section id="requests:ConvertSelection"> + <title>ConvertSelection</title> + <indexterm zone="requests:ConvertSelection" significance="preferred"><primary>ConvertSelection</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>selection</emphasis>, <emphasis remap='I'>target</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>property</emphasis>: ATOM or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>requestor</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Atom</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the specified selection has an owner, +the server sends a +<link linkend="events:SelectionRequest"><emphasis role='bold'>SelectionRequest</emphasis></link> +event to that owner. +If no owner for the specified selection exists, +the server generates a +<link linkend="events:SelectionNotify"><emphasis role='bold'>SelectionNotify</emphasis></link> +event to the requestor with property +<emphasis role='bold'>None</emphasis>. +The arguments are passed on unchanged in either of the events. +<!-- .sp --> +</para> + </section> + <section id="requests:SendEvent"> + <title>SendEvent</title> + <indexterm zone="requests:SendEvent" significance="preferred"><primary>SendEvent</primary></indexterm> + <indexterm zone="requests:SendEvent" significance="preferred"><primary>Event</primary><secondary>sending</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>destination</emphasis>: WINDOW or +<emphasis role='bold'>PointerWindow</emphasis> +or +<emphasis role='bold'>InputFocus</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>propagate</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>event-mask</emphasis>: SETofEVENT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>event</emphasis>: <normal-event-format> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If +<emphasis role='bold'>PointerWindow</emphasis> +is specified, +destination is replaced with the window that the pointer is in. +If +<emphasis role='bold'>InputFocus</emphasis> +is specified and the focus window contains the pointer, +destination is replaced with the window that the pointer is in. +Otherwise, destination is replaced with the focus window. +</para> +<para> +If the event-mask is the empty set, +then the event is sent to the client that created the destination window. +If that client no longer exists, no event is sent. +</para> +<para> +If propagate is +<emphasis role='bold'>False</emphasis>, +then the event is sent to every client selecting +on destination any of the event types in event-mask. +</para> +<para> +If propagate is +<emphasis role='bold'>True</emphasis> +and no clients have selected on destination any +of the event types in event-mask, +then destination is replaced with the +closest ancestor of destination for which some client has selected a +type in event-mask and no intervening window has that type in its +do-not-propagate-mask. +If no such window exists or if the window is an ancestor of the focus window +and +<emphasis role='bold'>InputFocus</emphasis> +was originally specified as the destination, +then the event is not sent to any clients. +Otherwise, the event is reported to every client selecting on the final +destination any of the types specified in event-mask. +</para> +<para> +The event code must be one of the core events or one of the events +defined by an extension (or a +<emphasis role='bold'>Value</emphasis> +error results) so that the server can correctly byte-swap the +contents as necessary. +The contents of the event are otherwise unaltered and unchecked +by the server except to force on the most significant bit of the event code +and to set the sequence number in the event correctly. +</para> +<para> +Active grabs are ignored for this request. +<!-- .sp --> +</para> + </section> + <section id="requests:GrabPointer"> + <title>GrabPointer</title> + <indexterm zone="requests:GrabPointer" significance="preferred"><primary>GrabPointer</primary></indexterm> + <indexterm zone="requests:GrabPointer"><primary>Active grab</primary><secondary>pointer</secondary></indexterm> + <indexterm zone="requests:GrabPointer"><primary>Pointer</primary><secondary>grabbing</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>grab-window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>owner-events</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>event-mask</emphasis>: SETofPOINTEREVENT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pointer-mode</emphasis>, <emphasis remap='I'>keyboard-mode</emphasis>: +{ <emphasis role='bold'>Synchronous</emphasis>, +<emphasis role='bold'>Asynchronous</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>confine-to</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>cursor</emphasis>: CURSOR or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +status: +{ <emphasis role='bold'>Success</emphasis>, +<emphasis role='bold'>AlreadyGrabbed</emphasis>, +<emphasis role='bold'>Frozen</emphasis>, +<emphasis role='bold'>InvalidTime</emphasis>, +<emphasis role='bold'>NotViewable</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request actively grabs control of the pointer. +Further pointer events are only reported to the grabbing client. +The request overrides any active pointer grab by this client. +</para> +<para> +If owner-events is +<emphasis role='bold'>False</emphasis>, +all generated pointer events are reported with respect to grab-window +and are only reported if selected by event-mask. +If owner-events is +<emphasis role='bold'>True</emphasis> +and a generated pointer event would normally be reported to this client, +it is reported normally. +Otherwise, the event is reported with respect to the grab-window and is +only reported if selected by event-mask. +For either value of owner-events, +unreported events are simply discarded. +</para> +<para> +If pointer-mode is +<emphasis role='bold'>Asynchronous</emphasis>, +pointer event processing continues normally. +If the pointer is currently frozen by this client, +then processing of pointer events is resumed. +If pointer-mode is +<emphasis role='bold'>Synchronous</emphasis>, +the state of the pointer (as seen by means of the protocol) appears to freeze, +and no further pointer events are generated by the server until the +grabbing client issues a releasing +<link linkend="requests:AllowEvents"><emphasis role='bold'>AllowEvents</emphasis></link> +request or until the pointer grab is released. +Actual pointer changes are not lost while the pointer is frozen. +They are simply queued for later processing. +</para> +<para> +If keyboard-mode is +<emphasis role='bold'>Asynchronous</emphasis>, +keyboard event processing is unaffected by activation of the grab. +If keyboard-mode is +<emphasis role='bold'>Synchronous</emphasis>, +the state of the keyboard (as seen by means of the protocol) appears to freeze, +and no further keyboard events are generated by the server until the grabbing +client issues a releasing +<emphasis role='bold'>AllowEvents</emphasis> +request or until the pointer grab is released. +Actual keyboard changes are not lost while the keyboard is frozen. +They are simply queued for later processing. +</para> +<para> +If a cursor is specified, +then it is displayed regardless of what window the pointer is in. +If no cursor is specified, +then when the pointer is in grab-window or one of its subwindows, +the normal cursor for that window is displayed. +Otherwise, the cursor for grab-window is displayed. +</para> +<para> +If a confine-to window is specified, +then the pointer will be restricted to stay contained in that window. +The confine-to window need have no relationship to the grab-window. +If the pointer is not initially in the confine-to window, +then it is warped automatically to the closest edge +(and enter/leave events are generated normally) just before the grab activates. +If the confine-to window is subsequently reconfigured, +the pointer will be warped automatically as necessary to +keep it contained in the window. +</para> +<para> +This request generates +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link> +and +<link linkend="events:LeaveNotify"><emphasis role='bold'>LeaveNotify</emphasis></link> +events. +</para> +<para> +The request fails with status +<emphasis role='bold'>AlreadyGrabbed</emphasis> +if the pointer is actively grabbed by some other client. +The request fails with status +<emphasis role='bold'>Frozen</emphasis> +if the pointer is frozen by an active grab of another client. +The request fails with status +<emphasis role='bold'>NotViewable</emphasis> +if grab-window or confine-to window is not viewable +or if the confine-to window lies completely outside the boundaries +of the root window. +The request fails with status +<emphasis role='bold'>InvalidTime</emphasis> +if the specified time is earlier than the last-pointer-grab time or later than +the current server time. +Otherwise, the last-pointer-grab time is set to the specified time, with +<emphasis role='bold'>CurrentTime</emphasis> +replaced by the current server time. +<!-- .sp --> +</para> + </section> + <section id="requests:UngrabPointer"> + <title>UngrabPointer</title> + <indexterm zone="requests:UngrabPointer" significance="preferred"><primary>UngrabPointer</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request releases the pointer if this client has it actively grabbed (from +either +<link linkend="requests:GrabPointer"><emphasis role='bold'>GrabPointer</emphasis></link> +or +<link linkend="requests:GrabButton"><emphasis role='bold'>GrabButton</emphasis></link> +or from a normal button press) and releases any queued events. +The request has no effect if the specified time is earlier than +the last-pointer-grab time or is later than the current server time. +</para> +<para> +This request generates +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link> +and +<link linkend="events:LeaveNotify"><emphasis role='bold'>LeaveNotify</emphasis></link> +events. +</para> +<para> +An +<link linkend="requests:UngrabPointer"><emphasis role='bold'>UngrabPointer</emphasis></link> +request is performed automatically if the event window or +confine-to window for an active pointer grab becomes not viewable +or if window reconfiguration causes the confine-to window to lie +completely outside the boundaries of the root window. +<!-- .sp --> +</para> + </section> + <section id="requests:GrabButton"> + <title>GrabButton</title> + <indexterm zone="requests:GrabButton" significance="preferred"><primary>GrabButton</primary></indexterm> + <indexterm zone="requests:GrabButton"><primary>Button</primary><secondary>grabbing</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>modifiers</emphasis>: SETofKEYMASK or +<emphasis role='bold'>AnyModifier</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>button</emphasis>: BUTTON or +<emphasis role='bold'>AnyButton</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>grab-window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>owner-events</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>event-mask</emphasis>: SETofPOINTEREVENT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pointer-mode</emphasis>, <emphasis remap='I'>keyboard-mode</emphasis>: +{ <emphasis role='bold'>Synchronous</emphasis>, +<emphasis role='bold'>Asynchronous</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>confine-to</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>cursor</emphasis>: CURSOR or +<emphasis role='bold'>None</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request establishes a passive grab. +<indexterm zone="requests:GrabButton"><primary>Passive grab</primary><secondary>pointer</secondary></indexterm> +In the future, +the pointer is actively grabbed as described in +<link linkend="requests:GrabPointer"><emphasis role='bold'>GrabPointer</emphasis></link>, +the last-pointer-grab time is set to the time at which the button was +pressed (as transmitted in the +<link linkend="events:ButtonPress"><emphasis role='bold'>ButtonPress</emphasis></link> +event), and the +<emphasis role='bold'>ButtonPress</emphasis> +event is reported if all of the following conditions are true: +<!-- .IP bu 5 --> +The pointer is not grabbed and the specified button is logically pressed +when the specified modifier keys are logically down, +and no other buttons or modifier keys are logically down. +<!-- .IP bu 5 --> +The grab-window contains the pointer. +<!-- .IP bu 5 --> +The confine-to window (if any) is viewable. +<!-- .IP bu 5 --> +A passive grab on the same button/key combination does not exist +on any ancestor of grab-window. +</para> +<para> +The interpretation of the remaining arguments is the same as for +<link linkend="requests:GrabPointer"><emphasis role='bold'>GrabPointer</emphasis></link>. +The active grab is terminated automatically when +the logical state of the pointer has all buttons released, +independent of the logical state of modifier keys. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. +</para> +<para> +This request overrides all previous passive grabs by the same client on +the same button/key combinations on the same window. +A modifier of +<emphasis role='bold'>AnyModifier</emphasis> +is equivalent to issuing the request for all possible modifier combinations +(including the combination of no modifiers). +It is not required that all specified modifiers have currently assigned +keycodes. +A button of +<emphasis role='bold'>AnyButton</emphasis> +is equivalent to issuing the request for all possible buttons. +Otherwise, it is not required that the button specified currently be assigned +to a physical button. +</para> +<para> +An +<emphasis role='bold'>Access</emphasis> +error is generated if some other client has already issued a +<emphasis role='bold'>GrabButton</emphasis> +request with the same button/key combination on the same window. +When using +<emphasis role='bold'>AnyModifier</emphasis> +or +<emphasis role='bold'>AnyButton</emphasis>, +the request fails completely (no grabs are established), and an +<emphasis role='bold'>Access</emphasis> +error is generated if there is a conflicting grab for any combination. +The request has no effect on an active grab. +<!-- .sp --> +</para> + </section> + <section id="requests:UngrabButton"> + <title>UngrabButton</title> + <indexterm zone="requests:UngrabButton" significance="preferred"><primary>UngrabButton</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>modifiers</emphasis>: SETofKEYMASK or +<emphasis role='bold'>AnyModifier</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>button</emphasis>: BUTTON or +<emphasis role='bold'>AnyButton</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>grab-window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request releases the passive button/key combination +on the specified window if it was grabbed by this client. +A modifiers argument of +<emphasis role='bold'>AnyModifier</emphasis> +is equivalent to issuing the request for all possible modifier +combinations (including the combination of no modifiers). +A button of +<emphasis role='bold'>AnyButton</emphasis> +is equivalent to issuing the request for all possible buttons. +The request has no effect on an active grab. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeActivePointerGrab"> + <title>ChangeActivePointerGrab</title> + <indexterm zone="requests:ChangeActivePointerGrab" significance="preferred"><primary>ChangeActivePointerGrab</primary></indexterm> + <indexterm zone="requests:ChangeActivePointerGrab"><primary>Active grab</primary><secondary>pointer</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event-mask</emphasis>: SETofPOINTEREVENT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>cursor</emphasis>: CURSOR or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes the specified dynamic parameters if the pointer is +actively grabbed by the client and the specified time is no earlier than the +last-pointer-grab time and no later than the current server time. +The interpretation of event-mask and cursor are the same as in +<link linkend="requests:GrabPointer"><emphasis role='bold'>GrabPointer</emphasis></link>. +This request has no effect on the parameters of any passive grabs established +with +<link linkend="requests:GrabButton"><emphasis role='bold'>GrabButton</emphasis></link>. +<!-- .sp --> +</para> + </section> + <section id="requests:GrabKeyboard"> + <title>GrabKeyboard</title> + <indexterm zone="requests:GrabKeyboard" significance="preferred"><primary>GrabKeyboard</primary></indexterm> + <indexterm zone="requests:GrabKeyboard"><primary>Active grab</primary><secondary>keyboard</secondary></indexterm> + <indexterm zone="requests:GrabKeyboard"><primary>Keyboard</primary><secondary>grabbing</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>grab-window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>owner-events</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pointer-mode</emphasis>, <emphasis remap='I'>keyboard-mode</emphasis>: +{ <emphasis role='bold'>Synchronous</emphasis>, +<emphasis role='bold'>Asynchronous</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +status: +{ <emphasis role='bold'>Success</emphasis>, +<emphasis role='bold'>AlreadyGrabbed</emphasis>, +<emphasis role='bold'>Frozen</emphasis>, +<emphasis role='bold'>InvalidTime</emphasis>, +<emphasis role='bold'>NotViewable</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request actively grabs control of the keyboard. +Further key events are reported only to the grabbing client. +This request overrides any active keyboard grab by this client. +</para> +<para> +If owner-events is +<emphasis role='bold'>False</emphasis>, +all generated key events are reported with respect to grab-window. +If owner-events is +<emphasis role='bold'>True</emphasis> +and if a generated key event would normally be reported to this client, +it is reported normally. +Otherwise, the event is reported with respect to the grab-window. +Both +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link> +and +<link linkend="events:KeyRelease"><emphasis role='bold'>KeyRelease</emphasis></link> +events are always reported, +independent of any event selection made by the client. +</para> +<para> +If keyboard-mode is +<emphasis role='bold'>Asynchronous</emphasis>, +keyboard event processing continues normally. +If the keyboard is currently frozen by this client, +then processing of keyboard events is resumed. +If keyboard-mode is +<emphasis role='bold'>Synchronous</emphasis>, +the state of the keyboard (as seen by means of the protocol) appears to freeze. +No further keyboard events are generated by the server until the +grabbing client issues a releasing +<link linkend="requests:AllowEvents"><emphasis role='bold'>AllowEvents</emphasis></link> +request or until the keyboard grab is released. +Actual keyboard changes are not lost while the keyboard is frozen. +They are simply queued for later processing. +</para> +<para> +If pointer-mode is +<emphasis role='bold'>Asynchronous</emphasis>, +pointer event processing is unaffected by activation of the grab. +If pointer-mode is +<emphasis role='bold'>Synchronous</emphasis>, +the state of the pointer (as seen by means of the protocol) appears to freeze. +No further pointer events are generated by the server +until the grabbing client issues a releasing +<link linkend="requests:AllowEvents"><emphasis role='bold'>AllowEvents</emphasis></link> +request or until the keyboard grab is released. +Actual pointer changes are not lost while the pointer is frozen. +They are simply queued for later processing. +</para> +<para> +This request generates +<link linkend="events:FocusIn"><emphasis role='bold'>FocusIn</emphasis></link> +and +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link> +events. +</para> +<para> +The request fails with status +<emphasis role='bold'>AlreadyGrabbed</emphasis> +if the keyboard is actively grabbed by some other client. +The request fails with status +<emphasis role='bold'>Frozen</emphasis> +if the keyboard is frozen by an active grab of another client. +The request fails with status +<emphasis role='bold'>NotViewable</emphasis> +if grab-window is not viewable. +The request fails with status +<emphasis role='bold'>InvalidTime</emphasis> +if the specified time is earlier than the last-keyboard-grab time +or later than the current server time. +Otherwise, the last-keyboard-grab time is set to the specified time with +<emphasis role='bold'>CurrentTime</emphasis> +replaced by the current server time. +<!-- .sp --> +</para> + </section> + <section id="requests:UngrabKeyboard"> + <title>UngrabKeyboard</title> + <indexterm zone="requests:UngrabKeyboard" significance="preferred"><primary>UngrabKeyboard</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request releases the keyboard if this client has it actively grabbed +(as a result of either +<link linkend="requests:GrabKeyboard"><emphasis role='bold'>GrabKeyboard</emphasis></link> +or +<link linkend="requests:GrabKey"><emphasis role='bold'>GrabKey</emphasis></link>) +and releases any queued events. +The request has no effect if the specified time is earlier than the +last-keyboard-grab time or is later than the current server time. +</para> +<para> +This request generates +<link linkend="events:FocusIn"><emphasis role='bold'>FocusIn</emphasis></link> +and +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link> +events. +</para> +<para> +An +<link linkend="requests:UngrabKeyboard"><emphasis role='bold'>UngrabKeyboard</emphasis></link> +is performed automatically if the event window for an active keyboard grab +becomes not viewable. +<!-- .sp --> +</para> + </section> + <section id="requests:GrabKey"> + <title>GrabKey</title> + <indexterm zone="requests:GrabKey" significance="preferred"><primary>GrabKey</primary></indexterm> + <indexterm zone="requests:GrabKey"><primary>Key</primary><secondary>grabbing</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>key</emphasis>: KEYCODE or +<emphasis role='bold'>AnyKey</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>modifiers</emphasis>: SETofKEYMASK or +<emphasis role='bold'>AnyModifier</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>grab-window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>owner-events</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pointer-mode</emphasis>, <emphasis remap='I'>keyboard-mode</emphasis>: +{ <emphasis role='bold'>Synchronous</emphasis>, +<emphasis role='bold'>Asynchronous</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request establishes a passive grab on the keyboard. +<indexterm zone="requests:GrabKey"><primary>Passive grab</primary><secondary>keyboard</secondary></indexterm> +In the future, +the keyboard is actively grabbed as described in +<link linkend="requests:GrabKeyboard"><emphasis role='bold'>GrabKeyboard</emphasis></link>, +the last-keyboard-grab time is set to the time at which the key was pressed +(as transmitted in the +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link> +event), and the +<emphasis role='bold'>KeyPress</emphasis> +event is reported if all of the following conditions are true: +<!-- .IP bu 5 --> +The keyboard is not grabbed and the specified key +(which can itself be a modifier key) is logically pressed +when the specified modifier keys are logically down, +and no other modifier keys are logically down. +<!-- .IP bu 5 --> +Either the grab-window is an ancestor of (or is) the focus window, +or the grab-window is a descendent of the focus window and contains the pointer. +<!-- .IP bu 5 --> +A passive grab on the same key combination does not exist +on any ancestor of grab-window. +</para> +<para> +The interpretation of the remaining arguments is the same as for +<link linkend="requests:GrabKeyboard"><emphasis role='bold'>GrabKeyboard</emphasis></link>. +The active grab is terminated automatically when the logical state +of the keyboard has the specified key released, +independent of the logical state of modifier keys. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. +</para> +<para> +This request overrides all previous passive grabs by the same client +on the same key combinations on the same window. +A modifier of +<emphasis role='bold'>AnyModifier</emphasis> +is equivalent to issuing the request for all possible modifier combinations +(including the combination of no modifiers). +It is not required that all modifiers specified have +currently assigned keycodes. +A key of +<emphasis role='bold'>AnyKey</emphasis> +is equivalent to issuing the request for all possible keycodes. +Otherwise, the key must be in the range specified by min-keycode +and max-keycode in the connection setup (or a +<emphasis role='bold'>Value</emphasis> +error results). +</para> +<para> +An +<emphasis role='bold'>Access</emphasis> +error is generated if some other client has issued a +<emphasis role='bold'>GrabKey</emphasis> +with the same key combination on the same window. +When using +<emphasis role='bold'>AnyModifier</emphasis> +or +<emphasis role='bold'>AnyKey</emphasis>, +the request fails completely (no grabs are established), +and an +<emphasis role='bold'>Access</emphasis> +error is generated if there is a conflicting grab for any combination. +<!-- .sp --> +</para> + </section> + <section id="requests:UngrabKey"> + <title>UngrabKey</title> + <indexterm zone="requests:UngrabKey" significance="preferred"><primary>UngrabKey</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>key</emphasis>: KEYCODE or +<emphasis role='bold'>AnyKey</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>modifiers</emphasis>: SETofKEYMASK or +<emphasis role='bold'>AnyModifier</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>grab-window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request releases the key combination on the specified window +if it was grabbed by this client. +A modifiers argument of +<emphasis role='bold'>AnyModifier</emphasis> +is equivalent to issuing the request for all possible modifier combinations +(including the combination of no modifiers). +A key of +<emphasis role='bold'>AnyKey</emphasis> +is equivalent to issuing the request for all possible keycodes. +This request has no effect on an active grab. +<!-- .sp --> +</para> + </section> + <section id="requests:AllowEvents"> + <title>AllowEvents</title> + <indexterm zone="requests:AllowEvents" significance="preferred"><primary>AllowEvents</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>AsyncPointer</emphasis>, +<emphasis role='bold'>SyncPointer</emphasis>, +<emphasis role='bold'>ReplayPointer</emphasis>, +<emphasis role='bold'>AsyncKeyboard</emphasis>, + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>SyncKeyboard</emphasis>, +<emphasis role='bold'>ReplayKeyboard</emphasis>, +<emphasis role='bold'>AsyncBoth</emphasis>, +<emphasis role='bold'>SyncBoth</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request releases some queued events if the client has caused a device to +freeze. +The request has no effect if the specified time is earlier +than the last-grab time of the most recent active grab for the client +or if the specified time is later than the current server time. +</para> +<para> +For +<emphasis role='bold'>AsyncPointer</emphasis>, +if the pointer is frozen by the client, +pointer event processing continues normally. +If the pointer is frozen twice by the client on behalf of two separate grabs, +<emphasis role='bold'>AsyncPointer</emphasis> +thaws for both. +<emphasis role='bold'>AsyncPointer</emphasis> +has no effect if the pointer is not frozen by the client, +but the pointer need not be grabbed by the client. +</para> +<para> +For +<emphasis role='bold'>SyncPointer</emphasis>, +if the pointer is frozen and actively grabbed by the client, +pointer event processing continues normally until the next +<link linkend="events:ButtonPress"><emphasis role='bold'>ButtonPress</emphasis></link> +or +<link linkend="events:ButtonRelease"><emphasis role='bold'>ButtonRelease</emphasis></link> +event is reported to the client, +at which time the pointer again appears to freeze. +However, if the reported event causes the pointer grab to be released, +then the pointer does not freeze. +<emphasis role='bold'>SyncPointer</emphasis> +has no effect if the pointer is not frozen by the +client or if the pointer is not grabbed by the client. +</para> +<para> +For +<emphasis role='bold'>ReplayPointer</emphasis>, +if the pointer is actively grabbed by the client and +is frozen as the result of an event having been sent to the client +(either from the activation of a +<link linkend="requests:GrabButton"><emphasis role='bold'>GrabButton</emphasis></link> +or from a previous +<emphasis role='bold'>AllowEvents</emphasis> +with mode +<emphasis role='bold'>SyncPointer</emphasis> +but not from a +<link linkend="requests:GrabPointer"><emphasis role='bold'>GrabPointer</emphasis></link>), +then the pointer grab is released and that event is completely reprocessed, +this time ignoring any passive grabs at or above (towards the root) +the grab-window of the grab just released. +The request has no effect if the pointer is not grabbed by the client +or if the pointer is not frozen as the result of an event. +</para> +<para> +For +<emphasis role='bold'>AsyncKeyboard</emphasis>, +if the keyboard is frozen by the client, +keyboard event processing continues normally. +If the keyboard is frozen twice by the client on behalf of two separate grabs, +<emphasis role='bold'>AsyncKeyboard</emphasis> +thaws for both. +<emphasis role='bold'>AsyncKeyboard</emphasis> +has no effect if the keyboard is not frozen by the client, +but the keyboard need not be grabbed by the client. +</para> +<para> +For +<emphasis role='bold'>SyncKeyboard</emphasis>, +if the keyboard is frozen and actively grabbed by the client, +keyboard event processing continues normally until the next +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link> +or +<link linkend="events:KeyRelease"><emphasis role='bold'>KeyRelease</emphasis></link> +event is reported to the client, +at which time the keyboard again appears to freeze. +However, if the reported event causes the keyboard grab to be released, +then the keyboard does not freeze. +<emphasis role='bold'>SyncKeyboard</emphasis> +has no effect if the keyboard is not frozen by the client or +if the keyboard is not grabbed by the client. +</para> +<para> +For +<emphasis role='bold'>ReplayKeyboard</emphasis>, +if the keyboard is actively grabbed by the client +and is frozen as the result of an event having been sent to the client +(either from the activation of a +<link linkend="requests:GrabKey"><emphasis role='bold'>GrabKey</emphasis></link> +or from a previous +<emphasis role='bold'>AllowEvents</emphasis> +with mode +<emphasis role='bold'>SyncKeyboard</emphasis> +but not from a +<link linkend="requests:GrabKeyboard"><emphasis role='bold'>GrabKeyboard</emphasis></link>), +then the keyboard grab is released and that event is completely reprocessed, +this time ignoring any passive grabs at or above (towards the root) +the grab-window of the grab just released. +The request has no effect if the keyboard is not grabbed by the client +or if the keyboard is not frozen as the result of an event. +</para> +<para> +For +<emphasis role='bold'>SyncBoth</emphasis>, +if both pointer and keyboard are frozen by the client, +event processing (for both devices) continues normally until the next +<link linkend="events:ButtonPress"><emphasis role='bold'>ButtonPress</emphasis></link>, +<link linkend="events:ButtonRelease"><emphasis role='bold'>ButtonRelease</emphasis></link>, +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link>, +or +<link linkend="events:KeyRelease"><emphasis role='bold'>KeyRelease</emphasis></link> +event is reported to the client for a grabbed device +(button event for the pointer, key event for the keyboard), +at which time the devices again appear to freeze. +However, if the reported event causes the grab to be released, +then the devices do not freeze (but if the other device is still +grabbed, then a subsequent event for it will still cause both devices +to freeze). +<emphasis role='bold'>SyncBoth</emphasis> +has no effect unless both pointer and keyboard are frozen by the client. +If the pointer or keyboard is frozen twice by the client on behalf +of two separate grabs, +<emphasis role='bold'>SyncBoth</emphasis> +thaws for both (but a subsequent freeze for +<emphasis role='bold'>SyncBoth</emphasis> +will only freeze each device once). +</para> +<para> +For +<emphasis role='bold'>AsyncBoth</emphasis>, +if the pointer and the keyboard are frozen by the client, +event processing for both devices continues normally. +If a device is frozen twice by the client on behalf of two separate grabs, +<emphasis role='bold'>AsyncBoth</emphasis> +thaws for both. +<emphasis role='bold'>AsyncBoth</emphasis> +has no effect unless both pointer and keyboard are frozen by the client. +</para> +<para> +<emphasis role='bold'>AsyncPointer</emphasis>, +<emphasis role='bold'>SyncPointer</emphasis>, +and +<emphasis role='bold'>ReplayPointer</emphasis> +have no effect on processing of keyboard events. +<emphasis role='bold'>AsyncKeyboard</emphasis>, +<emphasis role='bold'>SyncKeyboard</emphasis>, +and +<emphasis role='bold'>ReplayKeyboard</emphasis> +have no effect on processing of pointer events. +</para> +<para> +It is possible for both a pointer grab and a keyboard grab to be active +simultaneously (by the same or different clients). +When a device is frozen on behalf of either grab, +no event processing is performed for the device. +It is possible for a single device to be frozen because of both grabs. +In this case, the freeze must be released on behalf of both grabs +before events can again be processed. +If a device is frozen twice by a single client, then a single +<emphasis role='bold'>AllowEvents</emphasis> +releases both. +<!-- .sp --> +</para> + </section> + <section id="requests:GrabServer"> + <title>GrabServer</title> + <indexterm zone="requests:GrabServer" significance="preferred"><primary>GrabServer</primary></indexterm> + <indexterm zone="requests:GrabServer"><primary>Server</primary><secondary>grabbing</secondary></indexterm> +<para> +This request disables processing of requests and close-downs on all +connections other than the one this request arrived on. +<!-- .sp --> +</para> + </section> + <section id="requests:UngrabServer"> + <title>UngrabServer</title> + <indexterm zone="requests:UngrabServer" significance="preferred"><primary>UngrabServer</primary></indexterm> +<para> +This request restarts processing of requests and close-downs +on other connections. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryPointer"> + <title>QueryPointer</title> + <indexterm zone="requests:QueryPointer" significance="preferred"><primary>QueryPointer</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +root: WINDOW + </entry> + </row> + <row> + <entry> +child: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +same-screen: BOOL + </entry> + </row> + <row> + <entry> +root-x, root-y, win-x, win-y: INT16 + </entry> + </row> + <row> + <entry> +mask: SETofKEYBUTMASK +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The root window the pointer is logically on and the pointer coordinates +relative to the root's origin are returned. +If same-screen is +<emphasis role='bold'>False</emphasis>, +then the pointer is not on the same screen as the argument window, +child is +<emphasis role='bold'>None</emphasis>, +and win-x and win-y are zero. +If same-screen is +<emphasis role='bold'>True</emphasis>, +then win-x and win-y are the pointer coordinates relative to the +argument window's origin, and child is the child containing the +pointer, if any. +The current logical state of the modifier keys and the buttons +are also returned. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. +<!-- .sp --> +</para> + </section> + <section id="requests:GetMotionEvents"> + <title>GetMotionEvents</title> + <indexterm zone="requests:GetMotionEvents" significance="preferred"><primary>GetMotionEvents</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>start</emphasis>, +<emphasis remap='I'>stop</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +events: LISTofTIMECOORD +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +where: + </entry> + </row> + <row> + <entry> +TIMECOORD: [x, y: INT16 + </entry> + </row> + <row> + <entry> + time: TIMESTAMP] +<!-- .TE --> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns all events in the motion history buffer that fall +between the specified start and stop times (inclusive) +and that have coordinates that lie within (including borders) +the specified window at its present placement. +The x and y coordinates are reported relative to the origin of the window. +</para> +<para> +If the start time is later than the stop time or if the start time is +in the future, no events are returned. +If the stop time is in the future, it is equivalent to specifying +<emphasis role='bold'>CurrentTime</emphasis>. +<!-- .sp --> +</para> + </section> + <section id="requests:TranslateCoordinates"> + <title>TranslateCoordinates</title> + <indexterm zone="requests:TranslateCoordinates" significance="preferred"><primary>TranslateCoordinates</primary></indexterm> + <indexterm zone="glossary:Coordinate_system"><primary>Coordinate system</primary><secondary>translating</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>src-window</emphasis>, <emphasis remap='I'>dst-window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>src-x</emphasis>, <emphasis remap='I'>src-y</emphasis>: INT16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +same-screen: BOOL + </entry> + </row> + <row> + <entry> +child: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +dst-x, dst-y: INT16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The src-x and src-y coordinates are taken relative to src-window's +origin and are returned as dst-x and dst-y coordinates relative to +dst-window's origin. +If same-screen is +<emphasis role='bold'>False</emphasis>, +then src-window and dst-window are on different screens, +and dst-x and dst-y are zero. +If the coordinates are contained in a mapped child of dst-window, +then that child is returned. +<!-- .sp --> +</para> + </section> + <section id="requests:WarpPointer"> + <title>WarpPointer</title> + <indexterm zone="requests:WarpPointer" significance="preferred"><primary>WarpPointer</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>src-window</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dst-window</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>src-x</emphasis>, <emphasis remap='I'>src-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>src-width</emphasis>, <emphasis remap='I'>src-height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dst-x</emphasis>, <emphasis remap='I'>dst-y</emphasis>: INT16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If dst-window is +<emphasis role='bold'>None</emphasis>, +this request moves the pointer by offsets [dst-x, dst-y] +relative to the current position of the pointer. +If dst-window is a window, +this request moves the pointer to [dst-x, dst-y] relative to dst-window's +origin. +However, if src-window is not +<emphasis role='bold'>None</emphasis>, +the move only takes place if src-window contains the pointer +and the pointer is contained in the specified rectangle of src-window. +</para> +<para> +The src-x and src-y coordinates are relative to src-window's origin. +If src-height is zero, +it is replaced with the current height of src-window minus src-y. +If src-width is zero, +it is replaced with the current width of src-window minus src-x. +</para> +<para> +This request cannot be used to move the pointer outside the confine-to +window of an active pointer grab. +An attempt will only move the pointer as far as the closest edge +of the confine-to window. +</para> +<para> +This request will generate events just as if the user had instantaneously +moved the pointer. +<!-- .sp --> +</para> + </section> + <section id="requests:SetInputFocus"> + <title>SetInputFocus</title> + <indexterm zone="requests:SetInputFocus" significance="preferred"><primary>SetInputFocus</primary></indexterm> + <indexterm zone="requests:SetInputFocus"><primary>Input focus</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>focus</emphasis>: WINDOW or +<emphasis role='bold'>PointerRoot</emphasis> +or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>revert-to</emphasis>: +{ <emphasis role='bold'>Parent</emphasis>, +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>None</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes the input focus and the last-focus-change time. +The request has no effect if the specified time is earlier than the current +last-focus-change time or is later than the current server time. +Otherwise, the last-focus-change time is set to the specified time +with +<emphasis role='bold'>CurrentTime</emphasis> +replaced by the current server time. +</para> +<para> +If +<emphasis role='bold'>None</emphasis> +is specified as the focus, +all keyboard events are discarded until a new focus window is set. +In this case, the revert-to argument is ignored. +</para> +<para> +If a window is specified as the focus, +it becomes the keyboard's focus window. +If a generated keyboard event would normally be reported to +this window or one of its inferiors, the event is reported normally. +Otherwise, the event is reported with respect to the focus window. +</para> +<para> +If +<emphasis role='bold'>PointerRoot</emphasis> +is specified as the focus, +the focus window is dynamically taken to be the root window of whatever screen +the pointer is on at each keyboard event. +In this case, +the revert-to argument is ignored. +</para> +<para> +This request generates +<link linkend="events:FocusIn"><emphasis role='bold'>FocusIn</emphasis></link> +and +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link> +events. +</para> +<para> +The specified focus window must be viewable at the time of the request (or a +<emphasis role='bold'>Match</emphasis> +error results). +If the focus window later becomes not viewable, +the new focus window depends on the revert-to argument. +If revert-to is +<emphasis role='bold'>Parent</emphasis>, +the focus reverts to the parent (or the closest viewable ancestor) +and the new revert-to value is taken to be +<emphasis role='bold'>None</emphasis>. +If revert-to is +<emphasis role='bold'>PointerRoot</emphasis> +or +<emphasis role='bold'>None</emphasis>, +the focus reverts to that value. +When the focus reverts, +<link linkend="events:FocusIn"><emphasis role='bold'>FocusIn</emphasis></link> +and +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link> +events are generated, +but the last-focus-change time is not affected. +<!-- .sp --> +</para> + </section> + <section id="requests:GetInputFocus"> + <title>GetInputFocus</title> + <indexterm zone="requests:GetInputFocus" significance="preferred"><primary>GetInputFocus</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +focus: WINDOW or +<emphasis role='bold'>PointerRoot</emphasis> +or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +revert-to: +{ <emphasis role='bold'>Parent</emphasis>, +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>None</emphasis>} +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current focus state. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryKeymap"> + <title>QueryKeymap</title> + <indexterm zone="requests:QueryKeymap" significance="preferred"><primary>QueryKeymap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +keys: LISTofCARD8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns a bit vector for the logical state of the keyboard. +Each bit set to 1 indicates that the corresponding key is currently pressed. +The vector is represented as 32 bytes. +Byte N (from 0) contains the bits for keys 8N to 8N + 7 +with the least significant bit in the byte representing key 8N. +Note that the logical state of a device (as seen by means of the protocol) +may lag the physical state if device event processing is frozen. +<!-- .sp --> +</para> + </section> + <section id="requests:OpenFont"> + <title>OpenFont</title> + <indexterm zone="requests:OpenFont" significance="preferred"><primary>OpenFont</primary></indexterm> + <indexterm zone="requests:OpenFont"><primary>Font</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>fid</emphasis>: FONT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>name</emphasis>: STRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Name</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request loads the specified font, if necessary, +and associates identifier fid with it. +The font name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +When the characters <quote>?</quote> and <quote>*</quote> are used in a font name, a +pattern match is performed and any matching font is used. +In the pattern, +the <quote>?</quote> character (octal value 77) will match any single character, +and the <quote>*</quote> character (octal value 52) will match any number +of characters. +A structured format for font names is specified in the +X.Org standard <citetitle>X Logical Font Description Conventions</citetitle>. +</para> +<para> +Fonts are not associated with a particular screen +and can be stored as a component of any graphics context. +<!-- .sp --> +</para> + </section> + <section id="requests:CloseFont"> + <title>CloseFont</title> + <indexterm zone="requests:CloseFont" significance="preferred"><primary>CloseFont</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>font</emphasis>: FONT +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Font</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request deletes the association between the resource ID and the font. +The font itself will be freed when no other resource references it. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryFont"> + <title>QueryFont</title> + <indexterm zone="requests:QueryFont" significance="preferred"><primary>QueryFont</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <spanspec spanname='all' namest='c1' nameend='c3'/> + <tbody> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +<emphasis remap='I'>font</emphasis>: FONTABLE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry spanname='all'> + ▶ + </entry> + </row> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +font-info: FONTINFO + </entry> + </row> + <row> + <entry spanname='all'> +char-infos: LISTofCHARINFO +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry valign='top' morerows='18'> +<!-- .in +.2i --> +where: + </entry> + </row> + <row> + <entry valign='top' morerows='9'> +FONTINFO: + </entry> + <entry> +[draw-direction: +{ <emphasis role='bold'>LeftToRight</emphasis>, +<emphasis role='bold'>RightToLeft</emphasis> } + </entry> + </row> + <row> + <entry> +min-char-or-byte2, max-char-or-byte2: CARD16 + </entry> + </row> + <row> + <entry> +min-byte1, max-byte1: CARD8 + </entry> + </row> + <row> + <entry> +all-chars-exist: BOOL + </entry> + </row> + <row> + <entry> +default-char: CARD16 + </entry> + </row> + <row> + <entry> +min-bounds: CHARINFO + </entry> + </row> + <row> + <entry> +max-bounds: CHARINFO + </entry> + </row> + <row> + <entry> +font-ascent: INT16 + </entry> + </row> + <row> + <entry> +font-descent: INT16 + </entry> + </row> + <row> + <entry> +properties: LISTofFONTPROP] + </entry> + </row> + <row> + <entry valign='top' morerows='1'> +FONTPROP: + </entry> + <entry> +[name: ATOM + </entry> + </row> + <row> + <entry> +value: <32-bit-value>] + </entry> + </row> + <row> + <entry valign='top' morerows='5'> +CHARINFO: + </entry> + <entry> +[left-side-bearing: INT16 + </entry> + </row> + <row> + <entry> +right-side-bearing: INT16 + </entry> + </row> + <row> + <entry> +character-width: INT16 + </entry> + </row> + <row> + <entry> +ascent: INT16 + </entry> + </row> + <row> + <entry> +descent: INT16 + </entry> + </row> + <row> + <entry> +attributes: CARD16] + </entry> + </row> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Font</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns logical information about a font. +If a gcontext is given for font, +the currently contained font is used. +</para> +<para> +The draw-direction is just a hint +and indicates whether most char-infos have a positive, +<emphasis role='bold'>LeftToRight</emphasis>, +or a negative, +<emphasis role='bold'>RightToLeft</emphasis>, +character-width metric. +The core protocol defines no support for vertical text. +</para> +<para> +If min-byte1 and max-byte1 are both zero, +then min-char-or-byte2 specifies the linear character index corresponding +to the first element of char-infos, +and max-char-or-byte2 specifies the linear character index of the last element. +If either min-byte1 or max-byte1 are nonzero, +then both min-char-or-byte2 and max-char-or-byte2 will be less than 256, +and the 2-byte character index values corresponding to char-infos element N +(counting from 0) are: +<literallayout class="monospaced"> + byte1 = N/D + min-byte1 + byte2 = N\\D + min-char-or-byte2 +</literallayout> +</para> +<para> +where: +<literallayout class="monospaced"> + D = max-char-or-byte2 - min-char-or-byte2 + 1 + / = integer division + \\ = integer modulus +</literallayout> +</para> +<para> +If char-infos has length zero, +then min-bounds and max-bounds will be identical, +and the effective char-infos is one filled with this char-info, of length: +<literallayout class="monospaced"> + L = D * (max-byte1 - min-byte1 + 1) +</literallayout> +</para> +<para> +That is, +all glyphs in the specified linear or matrix range have the same information, +as given by min-bounds (and max-bounds). +If all-chars-exist is +<emphasis role='bold'>True</emphasis>, +then all characters in char-infos have nonzero bounding boxes. +</para> +<para> +The default-char specifies the character that will be used when an +undefined or nonexistent character is used. +Note that default-char is a CARD16, not CHAR2B. +For a font using 2-byte matrix format, +the default-char has byte1 in the most significant byte +and byte2 in the least significant byte. +If the default-char itself specifies an undefined or nonexistent character, +then no printing is performed for an undefined or nonexistent character. +</para> +<para> +The min-bounds and max-bounds contain the minimum and maximum values of +each individual CHARINFO component over all char-infos (ignoring +nonexistent characters). +The bounding box of the font (that is, the +smallest rectangle enclosing the shape obtained by superimposing all +characters at the same origin [x,y]) has its upper-left coordinate at: +<literallayout class="monospaced"> + [x + min-bounds.left-side-bearing, y - max-bounds.ascent] +</literallayout> +with a width of: +<literallayout class="monospaced"> + max-bounds.right-side-bearing - min-bounds.left-side-bearing +</literallayout> +</para> +<para> +and a height of: +<literallayout class="monospaced"> + max-bounds.ascent + max-bounds.descent +</literallayout> +</para> +<para> +The font-ascent is the logical extent of the font above the baseline +and is used for determining line spacing. +Specific characters may extend beyond this. +The font-descent is the logical extent of the font at or below the baseline +and is used for determining line spacing. +Specific characters may extend beyond this. +If the baseline is at Y-coordinate y, +then the logical extent of the font is inclusive +between the Y-coordinate values (y - font-ascent) and (y + font-descent - 1). +</para> +<para> +A font is not guaranteed to have any properties. +The interpretation of the property value (for example, INT32, CARD32) +must be derived from <emphasis remap='I'>a priori</emphasis> knowledge of the property. +A basic set of font properties is specified in the X.Org +standard <citetitle>X Logical Font Description Conventions</citetitle>. +</para> +<para> +For a character origin at [x,y], +the bounding box of a character (that is, +the smallest rectangle enclosing the character's shape), described in +terms of CHARINFO components, is a rectangle with its upper-left corner at: +<literallayout class="monospaced"> + [x + left-side-bearing, y - ascent] +</literallayout> +</para> +<para> +with a width of: +<literallayout class="monospaced"> + right-side-bearing - left-side-bearing +</literallayout> +</para> +<para> +and a height of: +<literallayout class="monospaced"> + ascent + descent +</literallayout> +</para> +<para> +and the origin for the next character is defined to be: +<literallayout class="monospaced"> + [x + character-width, y] +</literallayout> +</para> +<para> +Note that the baseline is logically viewed as being just below +nondescending characters (when descent is zero, only pixels with +Y-coordinates less than y are drawn) and that the origin is logically +viewed as being coincident with the left edge of a nonkerned character +(when left-side-bearing is zero, no pixels with X-coordinate less than +x are drawn). +</para> +<para> +Note that CHARINFO metric values can be negative. +</para> +<para> +A nonexistent character is represented with all CHARINFO components +zero. +</para> +<para> +The interpretation of the per-character attributes field is +server-dependent. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryTextExtents"> + <title>QueryTextExtents</title> + <indexterm zone="requests:QueryTextExtents" significance="preferred"><primary>QueryTextExtents</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>font</emphasis>: FONTABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>string</emphasis>: STRING16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +draw-direction: +{ <emphasis role='bold'>LeftToRight</emphasis>, +<emphasis role='bold'>RightToLeft</emphasis>} + </entry> + </row> + <row> + <entry> +font-ascent: INT16 + </entry> + </row> + <row> + <entry> +font-descent: INT16 + </entry> + </row> + <row> + <entry> +overall-ascent: INT16 + </entry> + </row> + <row> + <entry> +overall-descent: INT16 + </entry> + </row> + <row> + <entry> +overall-width: INT32 + </entry> + </row> + <row> + <entry> +overall-left: INT32 + </entry> + </row> + <row> + <entry> +overall-right: INT32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Font</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the logical extents of the specified string of characters +in the specified font. +If a gcontext is given for font, +the currently contained font is used. +The draw-direction, font-ascent, and font-descent are the same as +described in +<link linkend="requests:QueryFont"><emphasis role='bold'>QueryFont</emphasis></link>. +The overall-ascent is the maximum of the ascent metrics of all characters +in the string, and the overall-descent is the maximum of the descent metrics. +The overall-width is the sum of the character-width metrics of all characters +in the string. +For each character in the string, +let W be the sum of the character-width metrics of all characters preceding it +in the string, +let L be the left-side-bearing metric of the character plus W, +and let R be the right-side-bearing metric of the character plus W. +The overall-left is the minimum L of all characters in the string, +and the overall-right is the maximum R. +</para> +<para> +For fonts defined with linear indexing rather than 2-byte matrix indexing, +the server will interpret each CHAR2B as a 16-bit number that +has been transmitted most significant byte first (that is, byte1 of the +CHAR2B is taken as the most significant byte). +</para> +<para> +Characters with all zero metrics are ignored. +If the font has no defined default-char, +then undefined characters in the string are also ignored. +<!-- .sp --> +</para> + </section> + <section id="requests:ListFonts"> + <title>ListFonts</title> + <indexterm zone="requests:ListFonts" significance="preferred"><primary>ListFonts</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>pattern</emphasis>: STRING8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>max-names</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +names: LISTofSTRING8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns a list +of available font names (as controlled by the font search path; see +<link linkend="requests:SetFontPath"><emphasis role='bold'>SetFontPath</emphasis></link> +request) +that match the pattern. +At most, max-names names will be returned. +The pattern should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +In the pattern, +the <quote>?</quote> character (octal value 77) will match any single character, +and the <quote>*</quote> character (octal value 52) will match any number +of characters. +The returned names are in lowercase. +<!-- .sp --> +</para> + </section> + <section id="requests:ListFontsWithInfo"> + <title>ListFontsWithInfo</title> + <indexterm zone="requests:ListFontsWithInfo" significance="preferred"><primary>ListFontsWithInfo</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>pattern</emphasis>: STRING8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>max-names</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +name: STRING8 + </entry> + </row> + <row> + <entry> +info FONTINFO + </entry> + </row> + <row> + <entry> +replies-hint: CARD32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +where: +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +FONTINFO: <same type definition as in +<link linkend="requests:QueryFont"><emphasis role='bold'>QueryFont</emphasis></link>> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request is similar to +<link linkend="requests:ListFonts"><emphasis role='bold'>ListFonts</emphasis></link>, +but it also returns information about each font. +The information returned for each font is identical to what +<link linkend="requests:QueryFont"><emphasis role='bold'>QueryFont</emphasis></link> +would return except that the per-character metrics are not returned. +Note that this request can generate multiple replies. +With each reply, +replies-hint may provide an indication of how many more fonts will be returned. +This number is a hint only and may be larger or smaller than +the number of fonts actually returned. +A zero value does not guarantee that no more fonts will be returned. +After the font replies, +a reply with a zero-length name is sent to indicate the end of the reply +sequence. +<!-- .sp --> +</para> + </section> + <section id="requests:SetFontPath"> + <title>SetFontPath</title> + <indexterm zone="requests:SetFontPath" significance="preferred"><primary>SetFontPath</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>path</emphasis>: LISTofSTRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request defines the search path for font lookup. +There is only one search path per server, not one per client. +The interpretation of the strings is operating-system-dependent, +but the strings are intended to specify directories to be searched in the +order listed. +</para> +<para> +Setting the path to the empty list restores the default path defined +for the server. +</para> +<para> +As a side effect of executing this request, +the server is guaranteed to flush all cached information about fonts +for which there currently are no explicit resource IDs allocated. +</para> +<para> +The meaning of an error from this request is system specific. +<!-- .sp --> +</para> + </section> + <section id="requests:GetFontPath"> + <title>GetFontPath</title> + <indexterm zone="requests:GetFontPath" significance="preferred"><primary>GetFontPath</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +path: LISTofSTRING8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current search path for fonts. +<!-- .sp --> +</para> + </section> + <section id="requests:CreatePixmap"> + <title>CreatePixmap</title> + <indexterm zone="requests:CreatePixmap" significance="preferred"><primary>CreatePixmap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>pid</emphasis>: PIXMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>depth</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request creates a pixmap and assigns the identifier pid to it. +The width and height must be nonzero (or a +<emphasis role='bold'>Value</emphasis> +error results). +The depth must be one of the depths supported by the root of the specified +drawable (or a +<emphasis role='bold'>Value</emphasis> +error results). +The initial contents of the pixmap are undefined. +</para> +<para> +It is legal to pass an +<emphasis role='bold'>InputOnly</emphasis> +window as a drawable to this request. +<!-- .sp --> +</para> + </section> + <section id="requests:FreePixmap"> + <title>FreePixmap</title> + <indexterm zone="requests:FreePixmap" significance="preferred"><primary>FreePixmap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>pixmap</emphasis>: PIXMAP +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Pixmap</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request deletes the association between the resource ID and the pixmap. +The pixmap storage will be freed when no other resource references it. +<!-- .sp --> +</para> + </section> + <section id="requests:CreateGC"> + <title>CreateGC</title> + <indexterm zone="requests:CreateGC" significance="preferred"><primary>CreateGC</primary></indexterm> + <indexterm zone="requests:CreateGC"><primary>Graphics context</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cid</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Pixmap</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +This request creates a graphics context +and assigns the identifier cid to it. +The gcontext can be used with any destination drawable having the same root +and depth as the specified drawable; +use with other drawables results in a +<emphasis role='bold'>Match</emphasis> +error. +</para> +<para> +The value-mask and value-list specify which components are to be +explicitly initialized. +The context components are: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Component</entry> + <entry>Type</entry> + </row> + </thead> + <tbody> + <row> + <entry>function</entry> + <entry> +{ <emphasis role='bold'>Clear</emphasis>, +<emphasis role='bold'>And</emphasis>, +<emphasis role='bold'>AndReverse</emphasis>, +<emphasis role='bold'>Copy</emphasis>, +<emphasis role='bold'>AndInverted</emphasis>, +<emphasis role='bold'>NoOp</emphasis>, +<emphasis role='bold'>Xor</emphasis>, +<emphasis role='bold'>Or</emphasis>, +<emphasis role='bold'>Nor</emphasis>, +<emphasis role='bold'>Equiv</emphasis>, +<emphasis role='bold'>Invert</emphasis>, +<emphasis role='bold'>OrReverse</emphasis>, +<emphasis role='bold'>CopyInverted</emphasis>, +<emphasis role='bold'>OrInverted</emphasis>, +<emphasis role='bold'>Nand</emphasis>, +<emphasis role='bold'>Set</emphasis> } + </entry> + </row> + <row> + <entry>plane-mask</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>foreground</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>background</entry> + <entry>CARD32</entry> + </row> + <row> + <entry>line-width</entry> + <entry>CARD16</entry> + </row> + <row> + <entry>line-style</entry> + <entry> +{ <emphasis role='bold'>Solid</emphasis>, +<emphasis role='bold'>OnOffDash</emphasis>, +<emphasis role='bold'>DoubleDash</emphasis> } + </entry> + </row> + <row> + <entry>cap-style</entry> + <entry> +{ <emphasis role='bold'>NotLast</emphasis>, +<emphasis role='bold'>Butt</emphasis>, +<emphasis role='bold'>Round</emphasis>, +<emphasis role='bold'>Projecting</emphasis> } + </entry> + </row> + <row> + <entry>join-style</entry> + <entry> +{ <emphasis role='bold'>Miter</emphasis>, +<emphasis role='bold'>Round</emphasis>, +<emphasis role='bold'>Bevel</emphasis> } + </entry> + </row> + <row> + <entry>fill-style</entry> + <entry> +{ <emphasis role='bold'>Solid</emphasis>, +<emphasis role='bold'>Tiled</emphasis>, +<emphasis role='bold'>OpaqueStippled</emphasis>, +<emphasis role='bold'>Stippled</emphasis> } + </entry> + </row> + <row> + <entry>fill-rule</entry> + <entry> +{ <emphasis role='bold'>EvenOdd</emphasis>, +<emphasis role='bold'>Winding</emphasis> } + </entry> + </row> + <row> + <entry>arc-mode</entry> + <entry> +{ <emphasis role='bold'>Chord</emphasis>, +<emphasis role='bold'>PieSlice</emphasis> } + </entry> + </row> + <row> + <entry>tile</entry> + <entry>PIXMAP</entry> + </row> + <row> + <entry>stipple</entry> + <entry>PIXMAP</entry> + </row> + <row> + <entry>tile-stipple-x-origin</entry> + <entry>INT16</entry> + </row> + <row> + <entry>tile-stipple-y-origin</entry> + <entry>INT16</entry> + </row> + <row> + <entry>font</entry> + <entry>FONT</entry> + </row> + <row> + <entry>subwindow-mode</entry> + <entry> +{ <emphasis role='bold'>ClipByChildren</emphasis>, +<emphasis role='bold'>IncludeInferiors</emphasis> } + </entry> + </row> + <row> + <entry>graphics-exposures</entry> + <entry>BOOL</entry> + </row> + <row> + <entry>clip-x-origin</entry> + <entry>INT16</entry> + </row> + <row> + <entry>clip-y-origin</entry> + <entry>INT16</entry> + </row> + <row> + <entry>clip-mask</entry> + <entry> +PIXMAP or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry>dash-offset</entry> + <entry>CARD16</entry> + </row> + <row> + <entry>dashes</entry> + <entry>CARD8</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para id="requests:CreateGC:plane-mask"> +<indexterm zone="requests:CreateGC:plane-mask"><primary>Plane</primary><secondary>mask</secondary></indexterm> +In graphics operations, +given a source and destination pixel, +the result is computed bitwise on corresponding bits of the pixels; +that is, a Boolean operation is performed in each bit plane. +The plane-mask restricts the operation to a subset of planes, +so the result is: +</para> + +<literallayout class="monospaced"> + ((src FUNC dst) AND plane-mask) OR (dst AND (NOT plane-mask)) +</literallayout> + +<para> +Range checking is not performed on the values for foreground, background, +or plane-mask. +They are simply truncated to the appropriate number of bits. +</para> + +<para id="requests:CreateGC:function"> +The meanings of the functions are: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Function</entry> + <entry>Operation</entry> + </row> + </thead> + <tbody> + <row> + <entry> +<emphasis role='bold'>Clear</emphasis> + </entry> + <entry>0</entry> + </row> + <row> + <entry> +<emphasis role='bold'>And</emphasis> + </entry> + <entry>src AND dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>AndReverse</emphasis> + </entry> + <entry>src AND (NOT dst)</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Copy</emphasis> + </entry> + <entry>src</entry> + </row> + <row> + <entry> +<emphasis role='bold'>AndInverted</emphasis> + </entry> + <entry>(NOT src) AND dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>NoOp</emphasis> + </entry> + <entry>dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Xor</emphasis> + </entry> + <entry>src XOR dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Or</emphasis> + </entry> + <entry>src OR dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Nor</emphasis> + </entry> + <entry>(NOT src) AND (NOT dst)</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Equiv</emphasis> + </entry> + <entry>(NOT src) XOR dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Invert</emphasis> + </entry> + <entry>NOT dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>OrReverse</emphasis> + </entry> + <entry>src OR (NOT dst)</entry> + </row> + <row> + <entry> +<emphasis role='bold'>CopyInverted</emphasis> + </entry> + <entry>NOT src</entry> + </row> + <row> + <entry> +<emphasis role='bold'>OrInverted</emphasis> + </entry> + <entry>(NOT src) OR dst</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Nand</emphasis> + </entry> + <entry>(NOT src) OR (NOT dst)</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Set</emphasis> + </entry> + <entry>1</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para id="requests:CreateGC:line-width"> +<indexterm zone="requests:CreateGC:line-width"><primary>Line</primary><secondary>drawing</secondary></indexterm> +The line-width is measured in pixels and can be greater than or equal to +one, a wide line, or the special value zero, a thin line. +</para> + +<para> +Wide lines are drawn centered on the path described by the graphics request. +Unless otherwise specified by the join or cap style, +the bounding box of a wide line with endpoints [x1, y1], [x2, y2] and +width w is a rectangle with vertices at the following real coordinates: +</para> + +<literallayout class="monospaced"> + [x1-(w*sn/2), y1+(w*cs/2)], [x1+(w*sn/2), y1-(w*cs/2)], + [x2-(w*sn/2), y2+(w*cs/2)], [x2+(w*sn/2), y2-(w*cs/2)] +</literallayout> + +<para> +The sn is the sine of the angle of the line and cs is the cosine of +the angle of the line. +A pixel is part of the line (and hence drawn) if the center of the pixel +is fully inside the bounding box, which is viewed as having infinitely thin +edges. +If the center of the pixel is exactly on the bounding box, +it is part of the line if and only if the interior is immediately to its right +(x increasing direction). +Pixels with centers on a horizontal edge are a special case and are part of +the line if and only if the interior or the boundary is immediately below +(y increasing direction) and if the interior or the boundary is immediately +to the right (x increasing direction). +Note that this description is a mathematical model describing the pixels +that are drawn for a wide line and does not imply that trigonometry is required +to implement such a model. +Real or fixed point arithmetic is recommended for computing the corners of the +line endpoints for lines greater than one pixel in width. +</para> +<para> +Thin lines (zero line-width) are nominally one pixel wide lines drawn using an +unspecified, device-dependent algorithm. +There are only two constraints on this algorithm. +First, if a line is drawn unclipped from [x1,y1] to [x2,y2] +and another line is drawn unclipped from [x1+dx,y1+dy] to [x2+dx,y2+dy], +then a point [x,y] is touched by drawing the first line if +and only if the point [x+dx,y+dy] is touched by drawing the second line. +Second, the effective set of points comprising a line cannot be affected +by clipping. +Thus, a point is touched in a clipped line if and only if the point lies +inside the clipping region and the point would be touched by the line +when drawn unclipped. +</para> +<para> +Note that a wide line drawn from [x1,y1] to [x2,y2] always draws the +same pixels as a wide line drawn from [x2,y2] to [x1,y1], not counting +cap-style and join-style. +Implementors are encouraged to make this property true for thin lines, +but it is not required. +A line-width of zero may differ from a line-width of one in which pixels +are drawn. +In general, +drawing a thin line will be faster than drawing a wide line of width one, +but thin lines may not mix well aesthetically with wide lines +because of the different drawing algorithms. +If it is desirable to obtain precise and uniform results across all displays, +a client should always use a line-width of one, rather than a line-width of +zero. +</para> +<para id="requests:CreateGC:line-style"> +The line-style defines which sections of a line are drawn: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>Solid</emphasis> + </entry> + <entry> +The full path of the line is drawn. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>DoubleDash</emphasis> + </entry> + <entry> +The full path of the line is drawn, +but the even dashes are filled differently than the odd dashes +(see fill-style), with +<emphasis role='bold'>Butt</emphasis> +cap-style used where even and odd dashes meet. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>OnOffDash</emphasis> + </entry> + <entry> +Only the even dashes are drawn, +and cap-style applies to all internal ends of the individual dashes +(except +<emphasis role='bold'>NotLast</emphasis> +is treated as +<emphasis role='bold'>Butt</emphasis>). + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para id="requests:CreateGC:cap-style"> +The cap-style defines how the endpoints of a path are drawn: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>NotLast</emphasis> + </entry> + <entry> +The result is equivalent to +<emphasis role='bold'>Butt</emphasis>, +except that for a line-width of zero the final endpoint is not drawn. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Butt</emphasis> + </entry> + <entry> +The result is square at the endpoint (perpendicular to the slope of the +line) with no projection beyond. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Round</emphasis> + </entry> + <entry> +The result is a circular arc with its diameter equal to the line-width, +centered on the endpoint; it is equivalent to +<emphasis role='bold'>Butt</emphasis> +for line-width zero. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Projecting</emphasis> + </entry> + <entry> +The result is square at the end, but the path continues beyond the +endpoint for a distance equal to half the line-width; +it is equivalent to +<emphasis role='bold'>Butt</emphasis> +for line-width zero. + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + + + +<para id="requests:CreateGC:join-style"> +The join-style defines how corners are drawn for wide lines: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>Miter</emphasis> + </entry> + <entry> +The outer edges of the two lines extend to meet at an angle. +However, if the angle is less than 11 degrees, a +<emphasis role='bold'>Bevel</emphasis> +join-style is used instead. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Round</emphasis> + </entry> + <entry> +The result is a circular arc with a diameter equal to the line-width, +centered on the joinpoint. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Bevel</emphasis> + </entry> + <entry> +The result is +<emphasis role='bold'>Butt</emphasis> +endpoint styles, and then the triangular notch is filled. + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + + +<para> +For a line with coincident endpoints (x1=x2, y1=y2), when the cap-style +is applied to both endpoints, the semantics depends on the line-width +and the cap-style: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='4.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>NotLast</emphasis> + </entry> + <entry>thin</entry> + <entry> +This is device-dependent, but the desired effect is that nothing is drawn. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Butt</emphasis> + </entry> + <entry>thin</entry> + <entry> +This is device-dependent, but the desired effect is that +a single pixel is drawn. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Round</emphasis> + </entry> + <entry>thin</entry> + <entry> +This is the same as +<emphasis role='bold'>Butt</emphasis>/thin. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Projecting</emphasis> + </entry> + <entry>thin</entry> + <entry> +This is the same as +<emphasis role='bold'>Butt</emphasis>/thin. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Butt</emphasis> + </entry> + <entry>wide</entry> + <entry> +Nothing is drawn. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Round</emphasis> + </entry> + <entry>wide</entry> + <entry> +The closed path is a circle, centered at the endpoint and +with a diameter equal to the line-width. + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Projecting</emphasis> + </entry> + <entry>wide</entry> + <entry> +The closed path is a square, aligned with the coordinate axes, +centered at the endpoint and with sides equal to the line-width. + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +For a line with coincident endpoints (x1=x2, y1=y2), +when the join-style is applied at one or both endpoints, +the effect is as if the line was removed from the overall path. +However, if the total path consists of (or is reduced to) a single point +joined with itself, +the effect is the same as when the cap-style is applied at both endpoints. +</para> +<para> +The tile/stipple represents an infinite two-dimensional plane +with the tile/stipple +replicated in all dimensions. When that plane is superimposed on +the drawable for use in a graphics operation, the upper-left corner +of some instance of the tile/stipple is at the coordinates within +the drawable specified by the tile/stipple origin. +The tile/stipple and clip origins are interpreted relative to the +origin of whatever destination drawable is specified in a graphics +request. +</para> +<para> +The tile pixmap must have the same root and depth as the gcontext (or a +<emphasis role='bold'>Match</emphasis> +error results). +The stipple pixmap must have depth one and must have the same root +as the gcontext (or a +<emphasis role='bold'>Match</emphasis> +error results). +For fill-style +<emphasis role='bold'>Stippled</emphasis> +(but not fill-style +<emphasis role='bold'>OpaqueStippled</emphasis>), +the stipple pattern is tiled in a single plane +and acts as an additional clip mask to be ANDed with the clip-mask. +Any size pixmap can be used for tiling or stippling, +although some sizes may be faster to use than others. +</para> +<para> +The fill-style defines the contents of the source for line, text, and +fill requests. +For all text and fill requests (for example, +<link linkend="requests:PolyText8"><emphasis role='bold'>PolyText8</emphasis></link>, +<link linkend="requests:PolyText16"><emphasis role='bold'>PolyText16</emphasis></link>, +<link linkend="requests:PolyFillRectangle"><emphasis role='bold'>PolyFillRectangle</emphasis></link>, +<link linkend="requests:FillPoly"><emphasis role='bold'>FillPoly</emphasis></link>, +and +<link linkend="requests:PolyFillArc"><emphasis role='bold'>PolyFillArc</emphasis></link>) +as well as for line requests with line-style +<emphasis role='bold'>Solid</emphasis>, +(for example, +<link linkend="requests:PolyLine"><emphasis role='bold'>PolyLine</emphasis></link>, +<link linkend="requests:PolySegment"><emphasis role='bold'>PolySegment</emphasis></link>, +<link linkend="requests:PolyRectangle"><emphasis role='bold'>PolyRectangle</emphasis></link>, +<link linkend="requests:PolyArc"><emphasis role='bold'>PolyArc</emphasis></link> ) +and for the even dashes for line requests with line-style +<emphasis role='bold'>OnOffDash</emphasis> +or +<emphasis role='bold'>DoubleDash</emphasis>: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>Solid</emphasis> + </entry> + <entry>Foreground</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Tiled</emphasis> + </entry> + <entry>Tile</entry> + </row> + <row> + <entry> +<emphasis role='bold'>OpaqueStippled</emphasis> + </entry> + <entry> +A tile with the same width and height as stipple +but with background everywhere stipple has a zero +and with foreground everywhere stipple has a one + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>Stippled</emphasis> + </entry> + <entry> +Foreground masked by stipple + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +For the odd dashes for line requests with line-style +<emphasis role='bold'>DoubleDash</emphasis>: +</para> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry> +<emphasis role='bold'>Solid</emphasis> + </entry> + <entry>Background</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Tiled</emphasis> + </entry> + <entry>Same as for even dashes</entry> + </row> + <row> + <entry> +<emphasis role='bold'>OpaqueStippled</emphasis> + </entry> + <entry>Same as for even dashes</entry> + </row> + <row> + <entry> +<emphasis role='bold'>Stippled</emphasis> + </entry> + <entry>Background masked by stipple</entry> + </row> + </tbody> + </tgroup> +</informaltable> + + +<para> +The dashes value allowed here is actually a simplified form of the more +general patterns that can be set with +<link linkend="requests:SetDashes"><emphasis role='bold'>SetDashes</emphasis></link>. +Specifying a value of N here is equivalent to specifying +the two element list [N, N] in +<link linkend="requests:SetDashes"><emphasis role='bold'>SetDashes</emphasis></link>. +The value must be nonzero (or a +<emphasis role='bold'>Value</emphasis> +error results). +The meaning of dash-offset and dashes are explained in the +<link linkend="requests:SetDashes"><emphasis role='bold'>SetDashes</emphasis></link> +request. +</para> +<para id="requests:CreateGC:clip-mask"> +<indexterm zone="requests:CreateGC:clip-mask"><primary>Clipping region</primary></indexterm> +The clip-mask restricts writes to the destination drawable. +Only pixels where the clip-mask has bits set to 1 are drawn. +Pixels are not drawn outside the area covered by the clip-mask +or where the clip-mask has bits set to 0. +The clip-mask affects all graphics requests, +but it does not clip sources. +The clip-mask origin is interpreted relative to the origin of whatever +destination drawable is specified in a graphics request. +If a pixmap is specified as the clip-mask, +it must have depth 1 and have the same root as the gcontext (or a +<emphasis role='bold'>Match</emphasis> +error results). +If clip-mask is +<emphasis role='bold'>None</emphasis>, +then pixels are always drawn, regardless of the clip origin. +The clip-mask can also be set with the +<link linkend="requests:SetClipRectangles"><emphasis role='bold'>SetClipRectangles</emphasis></link> +request. +</para> +<para> +For +<emphasis role='bold'>ClipByChildren</emphasis>, +both source and destination windows are additionally clipped by all viewable +<emphasis role='bold'>InputOutput</emphasis> +children. +For +<emphasis role='bold'>IncludeInferiors</emphasis>, +neither source nor destination window is clipped by inferiors. +This will result in including subwindow contents in the +source and drawing through subwindow boundaries of the destination. +The use of +<emphasis role='bold'>IncludeInferiors</emphasis> +with a source or destination window of one depth with mapped inferiors +of differing depth is not illegal, +but the semantics is undefined by the core protocol. +</para> +<para id="requests:CreateGC:fill-rule"> +<indexterm zone="requests:CreateGC:fill-rule" significance="preferred"><primary>Winding rule</primary></indexterm> +<indexterm zone="requests:CreateGC:fill-rule" significance="preferred"><primary>Fill rule</primary></indexterm> +The fill-rule defines what pixels are inside (that is, are drawn) for +paths given in +<link linkend="requests:FillPoly"><emphasis role='bold'>FillPoly</emphasis></link> +requests. +<emphasis role='bold'>EvenOdd</emphasis> +means a point is inside if an infinite ray with the point as origin crosses +the path an odd number of times. +For +<emphasis role='bold'>Winding</emphasis>, +a point is inside if an infinite ray with the point as origin crosses an +unequal number of clockwise and counterclockwise directed path segments. +A clockwise directed path segment is one that crosses the ray from left +to right as observed from the point. +A counter-clockwise segment is one that crosses the ray from right to left +as observed from the point. +The case where a directed line segment is coincident with the ray is +uninteresting because one can simply choose a different ray that is not +coincident with a segment. +</para> +<para> +For both fill rules, +a point is infinitely small and the path is an infinitely thin line. +A pixel is inside if the center point of the pixel is inside +and the center point is not on the boundary. +If the center point is on the boundary, +the pixel is inside if and only if the polygon interior is immediately +to its right (x increasing direction). +Pixels with centers along a horizontal edge are a special case +and are inside if and only if the polygon interior is immediately below +(y increasing direction). +</para> +<para> +The arc-mode controls filling in the +<link linkend="requests:PolyFillArc"><emphasis role='bold'>PolyFillArc</emphasis></link> +request. +</para> +<para> +The graphics-exposures flag controls +<link linkend="events:GraphicsExposure"><emphasis role='bold'>GraphicsExposure</emphasis></link> +event generation for +<link linkend="requests:CopyArea"><emphasis role='bold'>CopyArea</emphasis></link> +and +<link linkend="requests:CopyPlane"><emphasis role='bold'>CopyPlane</emphasis></link> +requests (and any similar requests defined by extensions). +</para> +<para> +The default component values are: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Component</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>function</entry> + <entry> +<emphasis role='bold'>Copy</emphasis> + </entry> + </row> + <row> + <entry>plane-mask</entry> + <entry>all ones</entry> + </row> + <row> + <entry>foreground</entry> + <entry>0</entry> + </row> + <row> + <entry>background</entry> + <entry>1</entry> + </row> + <row> + <entry>line-width</entry> + <entry>0</entry> + </row> + <row> + <entry>line-style</entry> + <entry><emphasis role='bold'>Solid</emphasis></entry> + </row> + <row> + <entry>cap-style</entry> + <entry><emphasis role='bold'>Butt</emphasis></entry> + </row> + <row> + <entry>join-style</entry> + <entry><emphasis role='bold'>Miter</emphasis></entry> + </row> + <row> + <entry>fill-style</entry> + <entry><emphasis role='bold'>Solid</emphasis></entry> + </row> + <row> + <entry>fill-rule</entry> + <entry><emphasis role='bold'>EvenOdd</emphasis></entry> + </row> + <row> + <entry>arc-mode</entry> + <entry><emphasis role='bold'>PieSlice</emphasis></entry> + </row> + <row> + <entry>tile</entry> + <entry> +<para> +Pixmap of unspecified size filled with foreground pixel +</para> +<para> +(that is, client specified pixel if any, else 0) +</para> +<para> +(subsequent changes to foreground do not affect this pixmap) +</para> + </entry> + </row> + <row> + <entry>stipple</entry> + <entry> +Pixmap of unspecified size filled with ones + </entry> + </row> + <row> + <entry>tile-stipple-x-origin</entry> + <entry>0</entry> + </row> + <row> + <entry>tile-stipple-y-origin</entry> + <entry>0</entry> + </row> + <row> + <entry>font</entry> + <entry><server-dependent-font></entry> + </row> + <row> + <entry>subwindow-mode</entry> + <entry> +<emphasis role='bold'>ClipByChildren</emphasis> + </entry> + </row> + <row> + <entry>graphics-exposures</entry> + <entry> +<emphasis role='bold'>True</emphasis> + </entry> + </row> + <row> + <entry>clip-x-origin</entry> + <entry>0</entry> + </row> + <row> + <entry>clip-y-origin</entry> + <entry>0</entry> + </row> + <row> + <entry>clip-mask</entry> + <entry> +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry>dash-offset</entry> + <entry>0</entry> + </row> + <row> + <entry>dashes</entry> + <entry>4 (that is, the list [4, 4])</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +Storing a pixmap in a gcontext might or might not result in a copy +being made. +If the pixmap is later used as the destination for a graphics request, +the change might or might not be reflected in the gcontext. +If the pixmap is used simultaneously in a graphics request +as both a destination and as a tile or stipple, +the results are not defined. +</para> +<para> +It is quite likely that some amount of gcontext information will be +cached in display hardware and that such hardware can only cache a +small number of gcontexts. +Given the number and complexity of components, +clients should view switching between gcontexts with nearly +identical state as significantly more expensive than making minor +changes to a single gcontext. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeGC"> + <title>ChangeGC</title> + <indexterm zone="requests:ChangeGC" significance="preferred"><primary>ChangeGC</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Pixmap</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes components in gc. +The value-mask and value-list specify which components are to be changed. +The values and restrictions are the same +as for +<link linkend="requests:CreateGC"><emphasis role='bold'>CreateGC</emphasis></link>. +</para> +<para> +Changing the clip-mask also overrides any previous +<link linkend="requests:SetClipRectangles"><emphasis role='bold'>SetClipRectangles</emphasis></link> +request on the context. +Changing dash-offset or dashes overrides any previous +<link linkend="requests:SetDashes"><emphasis role='bold'>SetDashes</emphasis></link> +request on the context. +</para> +<para> +The order in which components are verified and altered is server-dependent. +If an error is generated, +a subset of the components may have been altered. +<!-- .sp --> +</para> + </section> + <section id="requests:CopyGC"> + <title>CopyGC</title> + <indexterm zone="requests:CopyGC" significance="preferred"><primary>CopyGC</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>src-gc</emphasis>, <emphasis remap='I'>dst-gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request copies components from src-gc to dst-gc. +The value-mask specifies which components to copy, as for +<link linkend="requests:CreateGC"><emphasis role='bold'>CreateGC</emphasis></link>. +The two gcontexts must have the same root and the same depth (or a +<emphasis role='bold'>Match</emphasis> +error results). +<!-- .sp --> +</para> + </section> + <section id="requests:SetDashes"> + <title>SetDashes</title> + <indexterm zone="requests:SetDashes" significance="preferred"><primary>SetDashes</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dash-offset</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dashes</emphasis>: LISTofCARD8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request sets dash-offset and dashes in gc for dashed line styles. +Dashes cannot be empty (or a +<emphasis role='bold'>Value</emphasis> +error results). +Specifying an odd-length list is equivalent to specifying the same list +concatenated with itself to produce an even-length list. +The initial and alternating elements of dashes are the even dashes; +the others are the odd dashes. +Each element specifies a dash length in pixels. +All of the elements must be nonzero (or a +<emphasis role='bold'>Value</emphasis> +error results). +The dash-offset defines the phase of the pattern, +specifying how many pixels into dashes the pattern should actually begin in +any single graphics request. +Dashing is continuous through path elements combined with a join-style +but is reset to the dash-offset between each sequence of joined lines. +</para> +<para> +The unit of measure for dashes is the same as in the ordinary +coordinate system. +Ideally, a dash length is measured along the slope of the line, +but implementations are only required to match this ideal +for horizontal and vertical lines. +Failing the ideal semantics, +it is suggested that the length be measured along the major axis of the line. +The major axis is defined as the x axis for lines drawn at an angle of +between -45 and +45 degrees or between 135 and 225 degrees from the x axis. +For all other lines, the major axis is the y axis. +</para> +<para> +For any graphics primitive, the computation of the endpoint of an individual +dash only depends on the geometry of the primitive, the start position +of the dash, the direction of the dash, and the dash length. +</para> +<para> +For any graphics primitive, the total set of pixels used to render the +primitive (both even and odd numbered dash elements) with +<emphasis role='bold'>DoubleDash</emphasis> +line-style is the same as the set of pixels used to render the +primitive with +<emphasis role='bold'>Solid</emphasis> +line-style. +</para> +<para> +For any graphics primitive, if the primitive is drawn with +<emphasis role='bold'>OnOffDash</emphasis> +or +<emphasis role='bold'>DoubleDash</emphasis> +line-style unclipped at position [x,y] and again at position +[x+dx,y+dy], then a point [x1,y1] is included in a dash in the first +instance if and only if the point [x1+dx,y1+dy] is included in the dash in +the second instance. In addition, the effective set of points comprising a +dash cannot be affected by clipping. A point is included in a clipped dash +if and only if the point lies inside the clipping region and the point +would be included in the dash when drawn unclipped. +<!-- .sp --> +</para> + </section> + <section id="requests:SetClipRectangles"> + <title>SetClipRectangles</title> + <indexterm zone="requests:SetClipRectangles" significance="preferred"><primary>SetClipRectangles</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>clip-x-origin</emphasis>, <emphasis remap='I'>clip-y-origin</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>rectangles</emphasis>: LISTofRECTANGLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>ordering</emphasis>: +{ <emphasis role='bold'>UnSorted</emphasis>, +<emphasis role='bold'>YSorted</emphasis>, +<emphasis role='bold'>YXSorted</emphasis>, +<emphasis role='bold'>YXBanded</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes clip-mask in gc to the specified list of rectangles +and sets the clip origin. +Output will be clipped to remain contained within the rectangles. +The clip origin is interpreted relative to the origin of +whatever destination drawable is specified in a graphics request. +The rectangle coordinates are interpreted relative to the clip origin. +The rectangles should be nonintersecting, or graphics results will be +undefined. +Note that the list of rectangles can be empty, +which effectively disables output. +This is the opposite of passing +<emphasis role='bold'>None</emphasis> +as the clip-mask in +<link linkend="requests:CreateGC"><emphasis role='bold'>CreateGC</emphasis></link> +and +<link linkend="requests:ChangeGC"><emphasis role='bold'>ChangeGC</emphasis></link>. +</para> +<para> +If known by the client, +ordering relations on the rectangles can be specified with the ordering +argument. +This may provide faster operation by the server. +If an incorrect ordering is specified, +the server may generate a +<emphasis role='bold'>Match</emphasis> +error, but it is not required to do so. +If no error is generated, +the graphics results are undefined. +<emphasis role='bold'>UnSorted</emphasis> +means that the rectangles are in arbitrary order. +<emphasis role='bold'>YSorted</emphasis> +means that the rectangles are nondecreasing in their Y origin. +<emphasis role='bold'>YXSorted</emphasis> +additionally constrains +<emphasis role='bold'>YSorted</emphasis> +order in that all rectangles with an equal Y origin are +nondecreasing in their X origin. +<emphasis role='bold'>YXBanded</emphasis> +additionally constrains +<emphasis role='bold'>YXSorted</emphasis> +by requiring that, for every possible Y scanline, +all rectangles that include that scanline have identical Y origins and Y +extents. +<!-- .sp --> +</para> + </section> + <section id="requests:FreeGC"> + <title>FreeGC</title> + <indexterm zone="requests:FreeGC" significance="preferred"><primary>FreeGC</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>gc</emphasis>: GCONTEXT +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>GContext</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request deletes the association between the resource ID and the gcontext +and destroys the gcontext. +<!-- .sp --> +</para> + </section> + <section id="requests:ClearArea"> + <title>ClearArea</title> + <indexterm zone="requests:ClearArea" significance="preferred"><primary>ClearArea</primary></indexterm> + <indexterm zone="requests:ClearArea"><primary>Background</primary></indexterm><informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>exposures</emphasis>: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The x and y coordinates are relative to the window's origin +and specify the upper-left corner of the rectangle. +If width is zero, +it is replaced with the current width of the window minus x. +If height is zero, +it is replaced with the current height of the window minus y. +If the window has a defined background tile, +the rectangle is tiled with a plane-mask of all ones and function of +<emphasis role='bold'>Copy</emphasis> +and a subwindow-mode of +<emphasis role='bold'>ClipByChildren</emphasis>. +If the window has background +<emphasis role='bold'>None</emphasis>, +the contents of the window are not changed. +In either case, +if exposures is +<emphasis role='bold'>True</emphasis>, +then one or more exposure events are generated for regions of the rectangle +that are either visible or are being retained in a backing store. +</para> +<para> +It is a +<emphasis role='bold'>Match</emphasis> +error to use an +<emphasis role='bold'>InputOnly</emphasis> +window in this request. +<!-- .sp --> +</para> + </section> + <section id="requests:CopyArea"> + <title>CopyArea</title> + <indexterm zone="requests:CopyArea" significance="preferred"><primary>CopyArea</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>src-drawable</emphasis>, <emphasis remap='I'>dst-drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>src-x</emphasis>, <emphasis remap='I'>src-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dst-x</emphasis>, <emphasis remap='I'>dst-y</emphasis>: INT16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request combines the specified rectangle of src-drawable with the +specified rectangle of dst-drawable. +The src-x and src-y coordinates are relative to src-drawable's origin. +The dst-x and dst-y are relative to dst-drawable's origin, +each pair specifying the upper-left corner of the rectangle. +The src-drawable must have the same root and the same depth +as dst-drawable (or a +<emphasis role='bold'>Match</emphasis> +error results). +</para> +<para> +If regions of the source rectangle are obscured and have not been retained +in backing store +or if regions outside the boundaries of the source drawable are specified, +then those regions are not copied, +but the following occurs on all corresponding destination regions that are +either visible or are retained in backing-store. +If the dst-drawable is a window with a background other than +<emphasis role='bold'>None</emphasis>, +these corresponding destination regions are tiled +(with plane-mask of all ones and function +<emphasis role='bold'>Copy</emphasis>) +with that background. +Regardless of tiling and whether the destination is a window or a pixmap, +if graphics-exposures in gc is +<emphasis role='bold'>True</emphasis>, +then +<link linkend="events:GraphicsExposure"><emphasis role='bold'>GraphicsExposure</emphasis></link> +events for all corresponding destination regions are generated. +</para> +<para> +If graphics-exposures is +<emphasis role='bold'>True</emphasis> +but no +<emphasis role='bold'>GraphicsExposure</emphasis> +events are generated, +then a +<link linkend="events:NoExposure"><emphasis role='bold'>NoExposure</emphasis></link> +event is generated. +</para> +<para> +GC components: function, plane-mask, subwindow-mode, +graphics-exposures, clip-x-origin, clip-y-origin, clip-mask +<!-- .sp --> +</para> + </section> + <section id="requests:CopyPlane"> + <title>CopyPlane</title> + <indexterm zone="requests:CopyPlane" significance="preferred"><primary>CopyPlane</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>src-drawable</emphasis>, <emphasis remap='I'>dst-drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>src-x</emphasis>, <emphasis remap='I'>src-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dst-x</emphasis>, <emphasis remap='I'>dst-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>bit-plane</emphasis>: CARD32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The src-drawable must have the same root as dst-drawable (or a +<emphasis role='bold'>Match</emphasis> +error results), but it need not have the same depth. +The bit-plane must have exactly one bit set to 1 and the value of bit-plane +must be less than %2 sup n% where <emphasis remap='I'>n</emphasis> is the depth of src-drawable (or a +<emphasis role='bold'>Value</emphasis> +error results). +Effectively, a pixmap of the same depth as dst-drawable and with size specified +by the source region is formed using the foreground/background pixels in gc +(foreground everywhere the bit-plane in src-drawable contains a bit set to 1, +background everywhere the bit-plane contains a bit set to 0), +and the equivalent of a +<link linkend="requests:CopyArea"><emphasis role='bold'>CopyArea</emphasis></link> +is performed, with all the same exposure semantics. +This can also be thought of as using the specified region of the source +bit-plane as a stipple with a fill-style of +<emphasis role='bold'>OpaqueStippled</emphasis> +for filling a rectangular area of the destination. +</para> +<para> +GC components: function, plane-mask, foreground, background, +subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin, +clip-mask +<!-- .sp --> +</para> + </section> + <section id="requests:PolyPoint"> + <title>PolyPoint</title> + <indexterm zone="requests:PolyPoint" significance="preferred"><primary>PolyPoint</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>coordinate-mode</emphasis>: +{ <emphasis role='bold'>Origin</emphasis>, +<emphasis role='bold'>Previous</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>points</emphasis>: LISTofPOINT +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request combines the foreground pixel in gc with the pixel +at each point in the drawable. +The points are drawn in the order listed. +</para> +<para> +The first point is always relative to the drawable's origin. +The rest are relative either to that origin or the previous point, +depending on the coordinate-mode. +</para> +<para> +GC components: function, plane-mask, foreground, subwindow-mode, +clip-x-origin, clip-y-origin, clip-mask +<!-- .sp --> +</para> + </section> + <section id="requests:PolyLine"> + <title>PolyLine</title> + <indexterm zone="requests:PolyLine" significance="preferred"><primary>PolyLine</primary></indexterm> + <indexterm zone="requests:PolyLine"><primary>Line</primary><secondary>drawing</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>coordinate-mode</emphasis>: +{ <emphasis role='bold'>Origin</emphasis>, +<emphasis role='bold'>Previous</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>points</emphasis>: LISTofPOINT +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request draws lines between each pair of points (point[i], point[i+1]). +The lines are drawn in the order listed. +The lines join correctly at all intermediate points, +and if the first and last points coincide, +the first and last lines also join correctly. +</para> +<para> +For any given line, +no pixel is drawn more than once. +If thin (zero line-width) lines intersect, +the intersecting pixels are drawn multiple times. +If wide lines intersect, +the intersecting pixels are drawn only once, as though the entire +<emphasis role='bold'>PolyLine</emphasis> +were a single filled shape. +</para> +<para> +The first point is always relative to the drawable's origin. +The rest are relative either to that origin or the previous point, +depending on the coordinate-mode. +</para> +<para> +When either of the two lines involved in a +<emphasis role='bold'>Bevel</emphasis> +join is neither vertical +nor horizontal, then the slope and position of the line segment defining +the bevel join edge is implementation dependent. However, the computation +of the slope and distance (relative to the join point) only depends on +the line width and the slopes of the two lines. +</para> +<para> +GC components: function, plane-mask, line-width, line-style, +cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes +<!-- .sp --> +</para> + </section> + <section id="requests:PolySegment"> + <title>PolySegment</title> + <indexterm zone="requests:PolySegment" significance="preferred"><primary>PolySegment</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>segments</emphasis>: LISTofSEGMENT +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +where: +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +SEGMENT: [x1, y1, x2, y2: INT16] +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +For each segment, +this request draws a line between [x1, y1] and [x2, y2]. +The lines are drawn in the order listed. +No joining is performed at coincident endpoints. +For any given line, +no pixel is drawn more than once. +If lines intersect, +the intersecting pixels are drawn multiple times. +</para> +<para> +GC components: function, plane-mask, line-width, line-style, +cap-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, +clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes +<!-- .sp --> +</para> + </section> + <section id="requests:PolyRectangle"> + <title>PolyRectangle</title> + <indexterm zone="requests:PolyRectangle" significance="preferred"><primary>PolyRectangle</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>rectangles</emphasis>: LISTofRECTANGLE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request draws the outlines of the specified rectangles, as if a five-point +<link linkend="requests:PolyLine"><emphasis role='bold'>PolyLine</emphasis></link> +were specified for each rectangle: +</para> +<para> +<literallayout class="monospaced"> + [x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y] +</literallayout> +</para> +<para> +The x and y coordinates of each rectangle are relative to the drawable's origin +and define the upper-left corner of the rectangle. +</para> +<para> +The rectangles are drawn in the order listed. +For any given rectangle, +no pixel is drawn more than once. +If rectangles intersect, +the intersecting pixels are drawn multiple times. +</para> +<para> +GC components: function, plane-mask, line-width, line-style, +cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes +<!-- .sp --> +</para> + </section> + <section id="requests:PolyArc"> + <title>PolyArc</title> + <indexterm zone="requests:PolyArc" significance="preferred"><primary>PolyArc</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>arcs</emphasis>: LISTofARC +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request draws circular or elliptical arcs. +Each arc is specified by a rectangle and two angles. +The angles are signed integers in degrees scaled by 64, +with positive indicating counterclockwise motion and +negative indicating clockwise motion. +The start of the arc is specified by angle1 relative to the three-o'clock +position from the center of the rectangle, +and the path and extent of the arc is specified by angle2 relative to the +start of the arc. +If the magnitude of angle2 is greater than 360 degrees, +it is truncated to 360 degrees. +The x and y coordinates of the rectangle are relative to the origin of +the drawable. +For an arc specified as [x,y,w,h,a1,a2], +the origin of the major and minor axes is at [x+(w/2),y+(h/2)], +and the infinitely thin path describing the entire circle/ellipse intersects +the horizontal axis at [x,y+(h/2)] and [x+w,y+(h/2)] and intersects the +vertical axis at [x+(w/2),y] and [x+(w/2),y+h]. +These coordinates are not necessarily integral; that is, +they are not truncated to discrete coordinates. +</para> +<para> +For a wide line with line-width lw, the ideal bounding outlines for filling +are given by the two infinitely thin paths consisting of all points whose +perpendicular distance from a tangent to the path of the circle/ellipse is +equal to lw/2 (which may be a fractional value). When the width and height +of the arc are not equal and both are nonzero, then the actual bounding +outlines are implementation dependent. However, the computation of the +shape and position of the bounding outlines (relative to the center of the +arc) only depends on the width and height of the arc and the +line-width. +</para> +<para> +The cap-style is applied the same as for a line corresponding to the +tangent of the circle/ellipse at the endpoint. When the angle of an arc +face is not an integral multiple of 90 degrees, and the width and height of +the arc are both are nonzero, then the shape and position of the cap at +that face is implementation dependent. However, for a +<emphasis role='bold'>Butt</emphasis> +cap, the face +is defined by a straight line, and the computation of the position +(relative to the center of the arc) and the slope of the line only +depends on the width and height of the arc and the angle of the arc face. +For other cap styles, the computation of the position (relative to the +center of the arc) and the shape of the cap only depends on the width +and height of the arc, the line-width, the angle of the arc face, and the +direction (clockwise or counter clockwise) of the arc from the endpoint. +</para> +<para> +The join-style is applied the same as for two lines corresponding to the +tangents of the circles/ellipses at the join point. When the width and +height of both arcs are nonzero, and the angle of either arc face is not an +integral multiple of 90 degrees, then the shape of the join is +implementation dependent. However, the computation of the shape only +depends on the width and height of each arc, the line-width, the angles of +the two arc faces, the direction (clockwise or counter clockwise) of the +arcs from the join point, and the relative orientation of the two arc +center points. +</para> +<para> +For an arc specified as [x,y,w,h,a1,a2], +the angles must be specified in the effectively skewed coordinate system of +the ellipse (for a circle, the angles and coordinate systems are identical). +The relationship between these angles and angles expressed in the normal +coordinate system of the screen (as measured with a protractor) is as +follows: +<literallayout class="monospaced"> + skewed-angle = atan(tan(normal-angle) * w/h) + adjust +</literallayout> +</para> +<para> +The skewed-angle and normal-angle are expressed in radians (rather +than in degrees scaled by 64) in the range [0,2*PI). +The atan returns a value in the range [-PI/2,PI/2]. +The adjust is: +<informaltable frame="none"> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry>0</entry> + <entry>for normal-angle in the range [0,PI/2)</entry> + </row> + <row> + <entry>PI</entry> + <entry>for normal-angle in the range [PI/2,(3*PI)/2)</entry> + </row> + <row> + <entry>2*PI</entry> + <entry>for normal-angle in the range [(3*PI)/2,2*PI)</entry> + </row> + </tbody> + </tgroup> +</informaltable> +</para> +<para> +The arcs are drawn in the order listed. +If the last point in one arc coincides with the first point in the following +arc, +the two arcs will join correctly. +If the first point in the first arc coincides with the last point +in the last arc, +the two arcs will join correctly. +For any given arc, +no pixel is drawn more than once. +If two arcs join correctly and the line-width is greater than zero +and the arcs intersect, +no pixel is drawn more than once. +Otherwise, the intersecting pixels of intersecting arcs are drawn multiple +times. +Specifying an arc with one endpoint and a clockwise extent draws the +same pixels as specifying the other endpoint and an equivalent +counterclockwise extent, except as it affects joins. +</para> +<para> +By specifying one axis to be zero, +a horizontal or vertical line can be drawn. +</para> +<para> +Angles are computed based solely on the coordinate system, +ignoring the aspect ratio. +</para> +<para> +GC components: function, plane-mask, line-width, line-style, +cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, dashes +<!-- .sp --> +</para> + </section> + <section id="requests:FillPoly"> + <title>FillPoly</title> + <indexterm zone="requests:FillPoly" significance="preferred"><primary>FillPoly</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2in --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>shape</emphasis>: +{ <emphasis role='bold'>Complex</emphasis>, +<emphasis role='bold'>Nonconvex</emphasis>, +<emphasis role='bold'>Convex</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>coordinate-mode</emphasis>: +{ <emphasis role='bold'>Origin</emphasis>, +<emphasis role='bold'>Previous</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>points</emphasis>: LISTofPOINT +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request fills the region closed by the specified path. +The path is closed automatically if the last point in the list does not +coincide with the first point. +No pixel of the region is drawn more than once. +</para> +<para> +The first point is always relative to the drawable's origin. +The rest are relative either to that origin or the previous point, +depending on the coordinate-mode. +</para> +<para> +The shape parameter may be used by the server to improve performance. +<emphasis role='bold'>Complex</emphasis> +means the path may self-intersect. +Contiguous coincident points in the path are not treated +as self-intersection. +</para> +<para> +<emphasis role='bold'>Nonconvex</emphasis> +means the path does not self-intersect, +but the shape is not wholly convex. +If known by the client, +specifying +<emphasis role='bold'>Nonconvex</emphasis> +over +<emphasis role='bold'>Complex</emphasis> +may improve performance. +If +<emphasis role='bold'>Nonconvex</emphasis> +is specified for a self-intersecting path, +the graphics results are undefined. +</para> +<para> +<emphasis role='bold'>Convex</emphasis> +means that for every pair of points inside the polygon, +the line segment connecting them does not intersect the path. +If known by the client, +specifying +<emphasis role='bold'>Convex</emphasis> +can improve performance. +If +<emphasis role='bold'>Convex</emphasis> +is specified for a path that is not convex, +the graphics results are undefined. +</para> +<para> +GC components: function, plane-mask, fill-style, fill-rule, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin +<!-- .sp --> +</para> + </section> + <section id="requests:PolyFillRectangle"> + <title>PolyFillRectangle</title> + <indexterm zone="requests:PolyFillRectangle" significance="preferred"><primary>PolyFillRectangle</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>rectangles</emphasis>: LISTofRECTANGLE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request fills the specified rectangles, as if a four-point +<link linkend="requests:FillPoly"><emphasis role='bold'>FillPoly</emphasis></link> +were specified for each rectangle: +<literallayout class="monospaced"> + [x,y] [x+width,y] [x+width,y+height] [x,y+height] +</literallayout> +</para> +<para> +The x and y coordinates of each rectangle are relative to the drawable's origin +and define the upper-left corner of the rectangle. +</para> +<para> +The rectangles are drawn in the order listed. +For any given rectangle, +no pixel is drawn more than once. +If rectangles intersect, +the intersecting pixels are drawn multiple times. +</para> +<para> +GC components: function, plane-mask, fill-style, subwindow-mode, +clip-x-origin, clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin +<!-- .sp --> +</para> + </section> + <section id="requests:PolyFillArc"> + <title>PolyFillArc</title> + <indexterm zone="requests:PolyFillArc" significance="preferred"><primary>PolyFillArc</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>arcs</emphasis>: LISTofARC +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +For each arc, +this request fills the region closed by the infinitely thin path +described by the specified arc and one or two line segments, +depending on the arc-mode. +For +<emphasis role='bold'>Chord</emphasis>, +the single line segment joining the endpoints of the arc is used. +For +<emphasis role='bold'>PieSlice</emphasis>, +the two line segments joining the endpoints of the arc with the center point +are used. +</para> +<para> +For an arc specified as [x,y,w,h,a1,a2], the origin of the major and minor +axes is at [x+(w/2),y+(h/2)], and the infinitely thin path describing the +entire circle/ellipse intersects the horizontal axis at [x,y+(h/2)] and +[x+w,y+(h/2)] and intersects the vertical axis at [x+(w/2),y] and +[x+(w/2),y+h]. These coordinates are not necessarily integral; that is, +they are not truncated to discrete coordinates. +</para> +<para> +The arc angles are interpreted as specified in the +<link linkend="requests:PolyArc"><emphasis role='bold'>PolyArc</emphasis></link> +request. When +the angle of an arc face is not an integral multiple of 90 degrees, then +the precise endpoint on the arc is implementation dependent. However, for +<emphasis role='bold'>Chord</emphasis> +arc-mode, the computation of the pair of endpoints (relative to the +center of the arc) only depends on the width and height of the arc and +the angles of the two arc faces. For +<emphasis role='bold'>PieSlice</emphasis> +arc-mode, the computation of +an endpoint only depends on the angle of the arc face for that +endpoint and the ratio of the arc width to arc height. +</para> +<para> +The arcs are filled in the order listed. +For any given arc, +no pixel is drawn more than once. +If regions intersect, +the intersecting pixels are drawn multiple times. +</para> +<para> +GC components: function, plane-mask, fill-style, arc-mode, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin +<!-- .sp --> +</para> + </section> + <section id="requests:PutImage"> + <title>PutImage</title> + <indexterm zone="requests:PutImage" significance="preferred"><primary>PutImage</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>depth</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>dst-x</emphasis>, <emphasis remap='I'>dst-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>left-pad</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>format</emphasis>: +{ <emphasis role='bold'>Bitmap</emphasis>, +<emphasis role='bold'>XYPixmap</emphasis>, +<emphasis role='bold'>ZPixmap</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>data</emphasis>: LISTofBYTE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request combines an image with a rectangle of the drawable. +The dst-x and dst-y coordinates are relative to the drawable's origin. +</para> +<para> +If +<emphasis role='bold'>Bitmap</emphasis> +format is used, +then depth must be one (or a +<emphasis role='bold'>Match</emphasis> +error results), and the image must be in XY format. +The foreground pixel in gc defines the source for bits set to 1 in the image, +and the background pixel defines the source for the bits set to 0. +</para> +<para> +For +<emphasis role='bold'>XYPixmap</emphasis> +and +<emphasis role='bold'>ZPixmap</emphasis>, +the depth must match the depth of the drawable (or a +<emphasis role='bold'>Match</emphasis> +error results). +For +<emphasis role='bold'>XYPixmap</emphasis>, +the image must be sent in XY format. +For +<emphasis role='bold'>ZPixmap</emphasis>, +the image must be sent in the Z format defined for the given depth. +</para> +<para> +The left-pad must be zero for +<emphasis role='bold'>ZPixmap</emphasis> +format (or a +<emphasis role='bold'>Match</emphasis> +error results). +For +<emphasis role='bold'>Bitmap</emphasis> +and +<emphasis role='bold'>XYPixmap</emphasis> +format, +left-pad must be less than bitmap-scanline-pad as given in the server +connection setup information (or a +<emphasis role='bold'>Match</emphasis> +error results). +The first left-pad bits in every scanline are to be ignored by the server. +The actual image begins that many bits into the data. +The width argument defines the width of the actual image +and does not include left-pad. +</para> +<para> +GC components: function, plane-mask, subwindow-mode, clip-x-origin, +clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background +<!-- .sp --> +</para> + </section> + <section id="requests:GetImage"> + <title>GetImage</title> + <indexterm zone="requests:GetImage" significance="preferred"><primary>GetImage</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>plane-mask</emphasis>: CARD32 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>format</emphasis>: +{ <emphasis role='bold'>XYPixmap</emphasis>, +<emphasis role='bold'>ZPixmap</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +depth: CARD8 + </entry> + </row> + <row> + <entry> +visual: VISUALID or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +data: LISTofBYTE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the contents of the given rectangle of the drawable in the +given format. +The x and y coordinates are relative to the drawable's origin +and define the upper-left corner of the rectangle. +If +<emphasis role='bold'>XYPixmap</emphasis> +is specified, +only the bit planes specified in plane-mask are transmitted, +with the planes appearing from most significant to least significant +in bit order. +If +<emphasis role='bold'>ZPixmap</emphasis> +is specified, then bits in all planes not specified in plane-mask are +transmitted as zero. +Range checking is not performed on plane-mask; +extraneous bits are simply ignored. +The returned depth is as specified when the drawable was created +and is the same as a depth component in a FORMAT structure (in the connection +setup), not a bits-per-pixel component. +If the drawable is a window, +its visual type is returned. +If the drawable is a pixmap, +the visual is +<emphasis role='bold'>None</emphasis>. +</para> +<para> +If the drawable is a pixmap, +then the given rectangle must be wholly contained within the pixmap (or a +<emphasis role='bold'>Match</emphasis> +error results). +If the drawable is a window, +the window must be viewable, +and it must be the case that, +if there were no inferiors or overlapping windows, +the specified rectangle of the window would be fully visible on the screen +and wholly contained within the outside edges of the window (or a +<emphasis role='bold'>Match</emphasis> +error results). +Note that the borders of the window can be included and read with this request. +If the window has a backing store, +then the backing-store contents are returned for regions of the window +that are obscured by noninferior windows; +otherwise, the returned contents of such obscured regions are undefined. +Also undefined are the returned contents of visible +regions of inferiors of different depth than the specified window. +The pointer cursor image is not included in the contents returned. +</para> +<para> +This request is not general-purpose in the same sense as other +graphics-related requests. +It is intended specifically for rudimentary hardcopy support. +<!-- .sp --> +</para> + </section> + <section id="requests:PolyText8"> + <title>PolyText8</title> + <indexterm zone="requests:PolyText8" significance="preferred"><primary>PolyText8</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <spanspec spanname='all' namest='c1' nameend='c3'/> + <tbody> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry spanname='all'> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry spanname='all'> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry spanname='all'> +<emphasis remap='I'>items</emphasis>: LISTofTEXTITEM8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry valign='top' morerows='3'> +<!-- .in +.2i --> +where: + </entry> + </row> + <row> + <entry> +TEXTITEM8: + </entry> + <entry> +TEXTELT8 or FONT + </entry> + </row> + <row> + <entry valign='top' morerows='1'> +TEXTELT8: + </entry> + <entry> +[delta: INT8 + </entry> + </row> + <row> + <entry> +string: STRING8] +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The x and y coordinates are relative to the drawable's origin +and specify the baseline starting position (the initial character origin). +Each text item is processed in turn. +A font item causes the font to be stored in gc +and to be used for subsequent text. +Switching among fonts does not affect the next character origin. +A text element delta specifies an additional change in the position +along the x axis before the string is drawn; +the delta is always added to the character origin. +Each character image, as defined by the font in gc, +is treated as an additional mask for a fill operation on the drawable. +</para> +<para> +All contained FONTs are always transmitted most significant byte first. +</para> +<para> +If a +<emphasis role='bold'>Font</emphasis> +error is generated for an item, +the previous items may have been drawn. +</para> +<para> +For fonts defined with 2-byte matrix indexing, +each STRING8 byte is interpreted as a byte2 value of a CHAR2B with a byte1 +value of zero. +</para> +<para> +GC components: function, plane-mask, fill-style, font, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask +</para> +<para> +GC mode-dependent components: foreground, background, tile, stipple, +tile-stipple-x-origin, tile-stipple-y-origin +<!-- .sp --> +</para> + </section> + <section id="requests:PolyText16"> + <title>PolyText16</title> + <indexterm zone="requests:PolyText16" significance="preferred"><primary>PolyText16</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='3' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='1.0*'/> + <colspec colname='c3' colwidth='1.0*'/> + <spanspec spanname='all' namest='c1' nameend='c3'/> + <tbody> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry spanname='all'> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry spanname='all'> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry spanname='all'> +<emphasis remap='I'>items</emphasis>: LISTofTEXTITEM16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry valign='top' morerows='3'> +<!-- .in +.2i --> +where: + </entry> + </row> + <row> + <entry> +TEXTITEM16: + </entry> + <entry> +TEXTELT16 or FONT + </entry> + </row> + <row> + <entry valign='top' morerows='1'> +TEXTELT16: + </entry> + <entry> +[delta: INT8 + </entry> + </row> + <row> + <entry> +string: STRING16] +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry spanname='all'> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request is similar to +<link linkend="requests:PolyText8"><emphasis role='bold'>PolyText8</emphasis></link>, +except 2-byte (or 16-bit) characters are used. +For fonts defined with linear indexing rather than 2-byte matrix indexing, +the server will interpret each CHAR2B as a 16-bit number that +has been transmitted most significant byte first (that is, byte1 of the +CHAR2B is taken as the most significant byte). +<!-- .sp --> +</para> + </section> + <section id="requests:ImageText8"> + <title>ImageText8</title> + <indexterm zone="requests:ImageText8" significance="preferred"><primary>ImageText8</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>string</emphasis>: STRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The x and y coordinates are relative to the drawable's origin +and specify the baseline starting position (the initial character origin). +The effect is first to fill a destination rectangle with the background +pixel defined in gc and then to paint the text with the foreground pixel. +The upper-left corner of the filled rectangle is at: +<literallayout class="monospaced"> + [x, y - font-ascent] +</literallayout> +</para> +<para> +the width is: +<literallayout class="monospaced"> + overall-width +</literallayout> +</para> +<para> +and the height is: +<literallayout class="monospaced"> + font-ascent + font-descent +</literallayout> +</para> +<para> +The overall-width, font-ascent, and font-descent are as +they would be returned by a +<link linkend="requests:QueryTextExtents"><emphasis role='bold'>QueryTextExtents</emphasis></link> +call using gc and string. +</para> +<para> +The function and fill-style defined in gc are ignored for this request. +The effective function is +<emphasis role='bold'>Copy</emphasis>, +and the effective fill-style +<emphasis role='bold'>Solid</emphasis>. +</para> +<para> +For fonts defined with 2-byte matrix indexing, +each STRING8 byte is interpreted as a byte2 value of a CHAR2B with a byte1 +value of zero. +</para> +<para> +GC components: plane-mask, foreground, background, font, +subwindow-mode, clip-x-origin, clip-y-origin, clip-mask +<!-- .sp --> +</para> + </section> + <section id="requests:ImageText16"> + <title>ImageText16</title> + <indexterm zone="requests:ImageText16" significance="preferred"><primary>ImageText16</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>gc</emphasis>: GCONTEXT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>string</emphasis>: STRING16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>GContext</emphasis>, +<emphasis role='bold'>Match</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request is similar to +<link linkend="requests:ImageText8"><emphasis role='bold'>ImageText8</emphasis></link>, +except 2-byte (or 16-bit) characters are used. +For fonts defined with linear indexing rather than 2-byte matrix indexing, +the server will interpret each CHAR2B as a 16-bit number that +has been transmitted most significant byte first (that is, byte1 of the +CHAR2B is taken as the most significant byte). +<!-- .sp --> +</para> + </section> + <section id="requests:CreateColormap"> + <title>CreateColormap</title> + <indexterm zone="requests:CreateColormap" significance="preferred"><primary>CreateColormap</primary></indexterm> + <indexterm zone="requests:CreateColormap"><primary>Colormap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mid</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>visual</emphasis>: VISUALID + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>alloc</emphasis>: +{ <emphasis role='bold'>None</emphasis>, +<emphasis role='bold'>All</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis>, +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request creates a colormap of the specified visual type for the screen +on which the window resides and associates the identifier mid with it. +The visual type must be one supported by the screen (or a +<emphasis role='bold'>Match</emphasis> +error results). +The initial values of the colormap entries are undefined for classes +<emphasis role='bold'>GrayScale</emphasis>, +<emphasis role='bold'>PseudoColor</emphasis>, +and +<emphasis role='bold'>DirectColor</emphasis>. +For +<emphasis role='bold'>StaticGray</emphasis>, +<emphasis role='bold'>StaticColor</emphasis>, +and +<emphasis role='bold'>TrueColor</emphasis>, +the entries will have defined values, +but those values are specific to the visual and are not defined +by the core protocol. +For +<emphasis role='bold'>StaticGray</emphasis>, +<emphasis role='bold'>StaticColor</emphasis>, +and +<emphasis role='bold'>TrueColor</emphasis>, +alloc must be specified as +<emphasis role='bold'>None</emphasis> +(or a +<emphasis role='bold'>Match</emphasis> +error results). +For the other classes, if alloc is +<emphasis role='bold'>None</emphasis>, +the colormap initially has no allocated entries, +and clients can allocate entries. +</para> +<para> +If alloc is +<emphasis role='bold'>All</emphasis>, +then the entire colormap is allocated writable. +The initial values of all allocated entries are undefined. +For +<emphasis role='bold'>GrayScale</emphasis> +and +<emphasis role='bold'>PseudoColor</emphasis>, +the effect is as if an +<link linkend="requests:AllocColorCells"><emphasis role='bold'>AllocColorCells</emphasis></link> +request returned all pixel values from zero to N - 1, +where N is the colormap-entries value in the specified visual. +For +<emphasis role='bold'>DirectColor</emphasis>, +the effect is as if an +<link linkend="requests:AllocColorPlanes"><emphasis role='bold'>AllocColorPlanes</emphasis></link> +request returned a pixel value of zero and red-mask, +green-mask, and blue-mask values containing the same bits as the +corresponding masks in the specified visual. +However, +in all cases, none of these entries can be freed with +<link linkend="requests:FreeColors"><emphasis role='bold'>FreeColors</emphasis></link>. +<!-- .sp --> +</para> + </section> + <section id="requests:FreeColormap"> + <title>FreeColormap</title> + <indexterm zone="requests:FreeColormap" significance="preferred"><primary>FreeColormap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Colormap</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request deletes the association between the resource ID and the colormap +and frees the colormap storage. +If the colormap is an installed map for a screen, +it is uninstalled (see +<link linkend="requests:UninstallColormap"><emphasis role='bold'>UninstallColormap</emphasis></link> +request). +If the colormap is defined as the colormap for a window (by means of +<link linkend="requests:CreateWindow"><emphasis role='bold'>CreateWindow</emphasis></link> +or +<link linkend="requests:ChangeWindowAttributes"><emphasis role='bold'>ChangeWindowAttributes</emphasis></link>), +the colormap for the window is changed to +<emphasis role='bold'>None</emphasis>, +and a +<link linkend="events:ColormapNotify"><emphasis role='bold'>ColormapNotify</emphasis></link> +event is generated. +The protocol does not define the colors displayed for a window with a colormap of +<emphasis role='bold'>None</emphasis>. +</para> +<para> +This request has no effect on a default colormap for a screen. +<!-- .sp --> +</para> + </section> + <section id="requests:CopyColormapAndFree"> + <title>CopyColormapAndFree</title> + <indexterm zone="requests:CopyColormapAndFree" significance="preferred"><primary>CopyColormapAndFree</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mid</emphasis>, <emphasis remap='I'>src-cmap</emphasis>: COLORMAP +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>IDChoice</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request creates a colormap of the same visual type +and for the same screen as src-cmap, +and it associates identifier mid with it. +It also moves all of the client's existing allocations from src-cmap +to the new colormap with their color values intact +and their read-only or writable characteristics intact, +and it frees those entries in src-cmap. +Color values in other entries in the new colormap are undefined. +If src-cmap was created by the client with alloc +<emphasis role='bold'>All</emphasis> +(see +<link linkend="requests:CreateColormap"><emphasis role='bold'>CreateColormap</emphasis></link> +request), +then the new colormap is also created with alloc +<emphasis role='bold'>All</emphasis>, +all color values for all entries are copied from src-cmap, +and then all entries in src-cmap are freed. +If src-cmap was not created by the client with alloc +<emphasis role='bold'>All</emphasis>, +then the allocations to be moved are all those pixels and planes that have +been allocated by the client using either +<link linkend="requests:AllocColor"><emphasis role='bold'>AllocColor</emphasis></link>, +<link linkend="requests:AllocNamedColor"><emphasis role='bold'>AllocNamedColor</emphasis></link>, +<link linkend="requests:AllocColorCells"><emphasis role='bold'>AllocColorCells</emphasis></link>, +or +<link linkend="requests:AllocColorPlanes"><emphasis role='bold'>AllocColorPlanes</emphasis></link> +and that have not been freed since they were allocated. +<!-- .sp --> +</para> + </section> + <section id="requests:InstallColormap"> + <title>InstallColormap</title> + <indexterm zone="requests:InstallColormap" significance="preferred"><primary>InstallColormap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Colormap</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request makes this colormap an installed map for its screen. +All windows associated with this colormap immediately display with true colors. +As a side effect, +additional colormaps might be implicitly installed +or uninstalled by the server. +Which other colormaps get installed or uninstalled is server-dependent +except that the required list must remain installed. +</para> +<para> +If cmap is not already an installed map, a +<link linkend="events:ColormapNotify"><emphasis role='bold'>ColormapNotify</emphasis></link> +event is generated on every window having cmap as an attribute. +In addition, +for every other colormap that is installed or uninstalled as a result +of the request, a +<emphasis role='bold'>ColormapNotify</emphasis> +event is generated on every window having that colormap as an attribute. +</para> +<para> +At any time, there is a subset of the installed maps that are viewed as an +ordered list and are called the required list. +The length of the required list is at most M, +where M is the min-installed-maps specified for the screen in the +connection setup. +The required list is maintained as follows. +When a colormap is an explicit argument to +<emphasis role='bold'>InstallColormap</emphasis>, +it is added to the head of the list; the list is truncated at the +tail, if necessary, to keep the length of the list to at most M. +When a colormap is an explicit argument to +<link linkend="requests:UninstallColormap"><emphasis role='bold'>UninstallColormap</emphasis></link> +and it is in the required list, it is removed from the list. +A colormap is not added to the required list when it is installed implicitly +by the server, and the server cannot implicitly uninstall a colormap that is +in the required list. +</para> +<para> +Initially the default colormap for a screen is installed (but is not in +the required list). +<!-- .sp --> +</para> + </section> + <section id="requests:UninstallColormap"> + <title>UninstallColormap</title> + <indexterm zone="requests:UninstallColormap" significance="preferred"><primary>UninstallColormap</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Colormap</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If cmap is on the required list for its screen (see +<link linkend="requests:InstallColormap"><emphasis role='bold'>InstallColormap</emphasis></link> +request), +it is removed from the list. +As a side effect, +cmap might be uninstalled, +and additional colormaps might be implicitly installed or uninstalled. +Which colormaps get installed or uninstalled is server-dependent +except that the required list must remain installed. +</para> +<para> +If cmap becomes uninstalled, a +<link linkend="events:ColormapNotify"><emphasis role='bold'>ColormapNotify</emphasis></link> +event is generated on every window having cmap as an attribute. +In addition, +for every other colormap that is installed or uninstalled as a result of +the request, a +<emphasis role='bold'>ColormapNotify</emphasis> +event is generated on every window having that colormap as an attribute. +<!-- .sp --> +</para> + </section> + <section id="requests:ListInstalledColormaps"> + <title>ListInstalledColormaps</title> + <indexterm zone="requests:ListInstalledColormaps" significance="preferred"><primary>ListInstalledColormaps</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +cmaps: LISTofCOLORMAP +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Window</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns a list of the currently installed colormaps for the +screen of the specified window. +The order of colormaps is not significant, +and there is no explicit indication of the required list (see +<link linkend="requests:InstallColormap"><emphasis role='bold'>InstallColormap</emphasis></link> +request). +<!-- .sp --> +</para> + </section> + <section id="requests:AllocColor"> + <title>AllocColor</title> + <indexterm zone="requests:AllocColor" significance="preferred"><primary>AllocColor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>red</emphasis>, <emphasis remap='I'>green</emphasis>, <emphasis remap='I'>blue</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +pixel: CARD32 + </entry> + </row> + <row> + <entry> +red, green, blue: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Colormap</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request allocates a read-only colormap entry corresponding to the closest +RGB values provided by the hardware. +It also returns the pixel and the RGB values actually used. +Multiple clients requesting the same effective RGB values can be assigned +the same read-only entry, allowing entries to be shared. +<!-- .sp --> +</para> + </section> + <section id="requests:AllocNamedColor"> + <title>AllocNamedColor</title> + <indexterm zone="requests:AllocNamedColor" significance="preferred"><primary>AllocNamedColor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>name</emphasis>: STRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +pixel: CARD32 + </entry> + </row> + <row> + <entry> +exact-red, exact-green, exact-blue: CARD16 + </entry> + </row> + <row> + <entry> +visual-red, visual-green, visual-blue: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Name</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request looks up the named color with respect to the screen associated +with the colormap. +Then, it does an +<link linkend="requests:AllocColor"><emphasis role='bold'>AllocColor</emphasis></link> +on cmap. +The name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +The exact RGB values specify the true values for the color, +and the visual values specify the values actually used in the colormap. +<!-- .sp --> +</para> + </section> + <section id="requests:AllocColorCells"> + <title>AllocColorCells</title> + <indexterm zone="requests:AllocColorCells" significance="preferred"><primary>AllocColorCells</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>colors</emphasis>, <emphasis remap='I'>planes</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>contiguous</emphasis>: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +pixels, masks: LISTofCARD32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The number of colors must be positive, +and the number of planes must be nonnegative (or a +<emphasis role='bold'>Value</emphasis> +error results). +If C colors and P planes are requested, +then C pixels and P masks are returned. +No mask will have any bits in common with any other mask +or with any of the pixels. +By ORing together masks and pixels, +C*%2 sup P% distinct pixels can be produced; +all of these are allocated writable by the request. +For +<emphasis role='bold'>GrayScale</emphasis> +or +<emphasis role='bold'>PseudoColor</emphasis>, +each mask will have exactly one bit set to 1; for +<emphasis role='bold'>DirectColor</emphasis>, +each will have exactly three bits set to 1. +If contiguous is +<emphasis role='bold'>True</emphasis> +and if all masks are ORed together, +a single contiguous set of bits will be formed for +<emphasis role='bold'>GrayScale</emphasis> +or +<emphasis role='bold'>PseudoColor</emphasis>, +and three contiguous sets of bits (one within each pixel subfield) for +<emphasis role='bold'>DirectColor</emphasis>. +The RGB values of the allocated entries are undefined. +<!-- .sp --> +</para> + </section> + <section id="requests:AllocColorPlanes"> + <title>AllocColorPlanes</title> + <indexterm zone="requests:AllocColorPlanes" significance="preferred"><primary>AllocColorPlanes</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>colors</emphasis>, <emphasis remap='I'>reds</emphasis>, <emphasis remap='I'>greens</emphasis>, <emphasis remap='I'>blues</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>contiguous</emphasis>: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +pixels: LISTofCARD32 + </entry> + </row> + <row> + <entry> +red-mask, green-mask, blue-mask: CARD32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The number of colors must be positive, +and the reds, greens, and blues must be nonnegative (or a +<emphasis role='bold'>Value</emphasis> +error results). +If C colors, R reds, G greens, and B blues are requested, +then C pixels are returned, and the masks have R, G, and B bits set, +respectively. +If contiguous is +<emphasis role='bold'>True</emphasis>, +then each mask will have a contiguous set of bits. +No mask will have any bits in common with any other mask +or with any of the pixels. +For +<emphasis role='bold'>DirectColor</emphasis>, +each mask will lie within the corresponding pixel subfield. +By ORing together subsets of masks with pixels, +C*%2 sup R+G+B% distinct pixels can be produced; +all of these are allocated writable by the request. +The initial RGB values of the allocated entries are undefined. +In the colormap, +there are only C*%2 sup R% independent red entries, +C*%2 sup G% independent green entries, +and C*%2 sup B% independent blue entries. +This is true even for +<emphasis role='bold'>PseudoColor</emphasis>. +When the colormap entry for a pixel value is changed using +<link linkend="requests:StoreColors"><emphasis role='bold'>StoreColors</emphasis></link> +or +<link linkend="requests:StoreNamedColor"><emphasis role='bold'>StoreNamedColor</emphasis></link>, +the pixel is decomposed according to the masks and the +corresponding independent entries are updated. +<!-- .sp --> +</para> + </section> + <section id="requests:FreeColors"> + <title>FreeColors</title> + <indexterm zone="requests:FreeColors" significance="preferred"><primary>FreeColors</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pixels</emphasis>: LISTofCARD32 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>plane-mask</emphasis>: CARD32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The plane-mask should not have any bits in common with any of the +pixels. +The set of all pixels is produced by ORing together subsets of +plane-mask with the pixels. +The request frees all of these pixels that +were allocated by the client (using +<link linkend="requests:AllocColor"><emphasis role='bold'>AllocColor</emphasis></link>, +<link linkend="requests:AllocNamedColor"><emphasis role='bold'>AllocNamedColor</emphasis></link>, +<link linkend="requests:AllocColorCells"><emphasis role='bold'>AllocColorCells</emphasis></link>, +and +<link linkend="requests:AllocColorPlanes"><emphasis role='bold'>AllocColorPlanes</emphasis></link>). +Note that freeing an +individual pixel obtained from +<link linkend="requests:AllocColorPlanes"><emphasis role='bold'>AllocColorPlanes</emphasis></link> +may not actually allow it to be reused until all of its related pixels +are also freed. +Similarly, a read-only entry is not actually freed until it has been +freed by all clients, and if a client allocates the same read-only entry +multiple times, it must free the entry that many times before the +entry is actually freed. +</para> +<para> +All specified pixels that are allocated by the client in cmap are freed, +even if one or more pixels produce an error. +A +<emphasis role='bold'>Value</emphasis> +error is generated if a specified pixel is not a valid index into cmap. +An +<emphasis role='bold'>Access</emphasis> +error is generated if a specified pixel is not allocated by the +client (that is, is unallocated or is only allocated by another client) +or if the colormap was created with all entries writable (using an alloc +value of +<emphasis role='bold'>All</emphasis> +in +<link linkend="requests:CreateColormap"><emphasis role='bold'>CreateColormap</emphasis></link>). +If more than one pixel is in error, +it is arbitrary as to which pixel is reported. +<!-- .sp --> +</para> + </section> + <section id="requests:StoreColors"> + <title>StoreColors</title> + <indexterm zone="requests:StoreColors" significance="preferred"><primary>StoreColors</primary></indexterm> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>items</emphasis>: LISTofCOLORITEM + </entry> + </row> + <row> + <entry> +where: + </entry> + </row> + <row> + <entry> + <para> + <informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <tbody> + <row> + <entry>COLORITEM:</entry> + <entry>[pixel: CARD32</entry> + </row> + <row> + <entry></entry> + <entry> +do-red, do-green, do-blue: BOOL + </entry> + </row> + <row> + <entry></entry> + <entry> +red, green, blue: CARD16] + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </entry> + </row> + <row> + <entry> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Value</emphasis> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +This request changes the colormap entries of the specified pixels. +The do-red, do-green, and do-blue fields indicate which components +should actually be changed. +If the colormap is an installed map for its screen, +the changes are visible immediately. +</para> +<para> +All specified pixels that are allocated writable in cmap (by any client) +are changed, even if one or more pixels produce an error. +A +<emphasis role='bold'>Value</emphasis> +error is generated if a specified pixel is not a valid index into cmap, and an +<emphasis role='bold'>Access</emphasis> +error is generated if a specified pixel is unallocated or is allocated +read-only. +If more than one pixel is in error, +it is arbitrary as to which pixel is reported. +<!-- .sp --> +</para> + </section> + <section id="requests:StoreNamedColor"> + <title>StoreNamedColor</title> + <indexterm zone="requests:StoreNamedColor" significance="preferred"><primary>StoreNamedColor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pixel</emphasis>: CARD32 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>name</emphasis>: STRING8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>do-red</emphasis>, <emphasis remap='I'>do-green</emphasis>, <emphasis remap='I'>do-blue</emphasis>: BOOL +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Name</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request looks up the named color with respect to the screen associated +with cmap and then does a +<link linkend="requests:StoreColors"><emphasis role='bold'>StoreColors</emphasis></link> +in cmap. +The name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +The +<emphasis role='bold'>Access</emphasis> +and +<emphasis role='bold'>Value</emphasis> +errors are the same as in +<emphasis role='bold'>StoreColors</emphasis>. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryColors"> + <title>QueryColors</title> + <indexterm zone="requests:QueryColors" significance="preferred"><primary>QueryColors</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>pixels</emphasis>: LISTofCARD32 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +colors: LISTofRGB +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +where: +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +RGB: [red, green, blue: CARD16] +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the hardware-specific color values stored in cmap for +the specified pixels. +The values returned for an unallocated entry are undefined. +A +<emphasis role='bold'>Value</emphasis> +error is generated if a pixel is not a valid index into cmap. +If more than one pixel is in error, +it is arbitrary as to which pixel is reported. +<!-- .sp --> +</para> + </section> + <section id="requests:LookupColor"> + <title>LookupColor</title> + <indexterm zone="requests:LookupColor" significance="preferred"><primary>LookupColor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cmap</emphasis>: COLORMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>name</emphasis>: STRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +exact-red, exact-green, exact-blue: CARD16 + </entry> + </row> + <row> + <entry> +visual-red, visual-green, visual-blue: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Colormap</emphasis>, +<emphasis role='bold'>Name</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request looks up the string name of a color with respect to the screen +associated with cmap and returns both the exact color values and +the closest values provided by the hardware with respect to the visual +type of cmap. +The name should use the ISO Latin-1 encoding, +and uppercase and lowercase do not matter. +<!-- .sp --> +</para> + </section> + <section id="requests:CreateCursor"> + <title>CreateCursor</title> + <indexterm zone="requests:CreateCursor" significance="preferred"><primary>CreateCursor</primary></indexterm> + <indexterm zone="requests:CreateCursor"><primary>Cursor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cid</emphasis>: CURSOR + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>source</emphasis>: PIXMAP + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>mask</emphasis>: PIXMAP or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>fore-red</emphasis>, <emphasis remap='I'>fore-green</emphasis>, <emphasis remap='I'>fore-blue</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>back-red</emphasis>, <emphasis remap='I'>back-green</emphasis>, <emphasis remap='I'>back-blue</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Pixmap</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request creates a cursor and associates identifier cid with it. +The foreground and background RGB values must be specified, +even if the server only has a +<emphasis role='bold'>StaticGray</emphasis> +or +<emphasis role='bold'>GrayScale</emphasis> +screen. +The foreground is used for the bits set to 1 in the source, +and the background is used for the bits set to 0. +Both source and mask (if specified) must have depth one (or a +<emphasis role='bold'>Match</emphasis> +error results), but they can have any root. +The mask pixmap defines the shape of the cursor. +That is, +the bits set to 1 in the mask define which source pixels will be displayed, +and where the mask has bits set to 0, +the corresponding bits of the source pixmap are ignored. +If no mask is given, +all pixels of the source are displayed. +The mask, if present, must be the same size as the source (or a +<emphasis role='bold'>Match</emphasis> +error results). +The x and y coordinates define the hotspot relative to the source's origin +and must be a point within the source (or a +<emphasis role='bold'>Match</emphasis> +error results). +</para> +<para> +The components of the cursor may be transformed arbitrarily to meet +display limitations. +</para> +<para> +The pixmaps can be freed immediately if no further explicit references +to them are to be made. +</para> +<para> +Subsequent drawing in the source or mask pixmap has an undefined effect +on the cursor. +The server might or might not make a copy of the pixmap. +<!-- .sp --> +</para> + </section> + <section id="requests:CreateGlyphCursor"> + <title>CreateGlyphCursor</title> + <indexterm zone="requests:CreateGlyphCursor" significance="preferred"><primary>CreateGlyphCursor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cid</emphasis>: CURSOR + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>source-font</emphasis>: FONT + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>mask-font</emphasis>: FONT or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>source-char</emphasis>, <emphasis remap='I'>mask-char</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>fore-red</emphasis>, <emphasis remap='I'>fore-green</emphasis>, <emphasis remap='I'>fore-blue</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>back-red</emphasis>, <emphasis remap='I'>back-green</emphasis>, <emphasis remap='I'>back-blue</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Font</emphasis>, +<emphasis role='bold'>IDChoice</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request is similar to +<link linkend="requests:CreateCursor"><emphasis role='bold'>CreateCursor</emphasis></link>, +except the source and mask bitmaps are obtained from the specified font glyphs. +The source-char must be a defined glyph in source-font, +and if mask-font is given, mask-char must be a defined glyph in mask-font +(or a +<emphasis role='bold'>Value</emphasis> +error results). +The mask font and character are optional. +The origins of the source and mask (if it is defined) glyphs +are positioned coincidently and define the hotspot. +The source and mask need not have the same bounding box metrics, +and there is no restriction on the placement of the hotspot relative +to the bounding boxes. +If no mask is given, +all pixels of the source are displayed. +Note that source-char and mask-char are CARD16, not CHAR2B. +For 2-byte matrix fonts, +the 16-bit value should be formed with byte1 in the most significant byte +and byte2 in the least significant byte. +</para> +<para> +The components of the cursor may be transformed arbitrarily to meet +display limitations. +</para> +<para> +The fonts can be freed immediately if no further explicit references to +them are to be made. +<!-- .sp --> +</para> + </section> + <section id="requests:FreeCursor"> + <title>FreeCursor</title> + <indexterm zone="requests:FreeCursor" significance="preferred"><primary>FreeCursor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cursor</emphasis>: CURSOR +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Cursor</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request deletes the association between the resource ID and the cursor. +The cursor storage will be freed when no other resource references it. +<!-- .sp --> +</para> + </section> + <section id="requests:RecolorCursor"> + <title>RecolorCursor</title> + <indexterm zone="requests:RecolorCursor" significance="preferred"><primary>RecolorCursor</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>cursor</emphasis>: CURSOR + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>fore-red</emphasis>, <emphasis remap='I'>fore-green</emphasis>, <emphasis remap='I'>fore-blue</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>back-red</emphasis>, <emphasis remap='I'>back-green</emphasis>, <emphasis remap='I'>back-blue</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Cursor</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request changes the color of a cursor. +If the cursor is being displayed on a screen, +the change is visible immediately. +<!-- .sp --> +</para> + </section> + <section id="requests:QueryBestSize"> + <title>QueryBestSize</title> + <indexterm zone="requests:QueryBestSize" significance="preferred"><primary>QueryBestSize</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>class</emphasis>: +{ <emphasis role='bold'>Cursor</emphasis>, +<emphasis role='bold'>Tile</emphasis>, +<emphasis role='bold'>Stipple</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +width, height: CARD16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Drawable</emphasis>, +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the best size that is closest to the argument size. +For +<emphasis role='bold'>Cursor</emphasis>, +this is the largest size that can be fully displayed. +For +<emphasis role='bold'>Tile</emphasis>, +this is the size that can be tiled fastest. +For +<emphasis role='bold'>Stipple</emphasis>, +this is the size that can be stippled fastest. +</para> +<para> +For +<emphasis role='bold'>Cursor</emphasis>, +the drawable indicates the desired screen. +For +<emphasis role='bold'>Tile</emphasis> +and +<emphasis role='bold'>Stipple</emphasis>, +the drawable indicates the screen and also possibly the window class and depth. +An +<emphasis role='bold'>InputOnly</emphasis> +window cannot be used as the drawable for +<emphasis role='bold'>Tile</emphasis> +or +<emphasis role='bold'>Stipple</emphasis> +(or a +<emphasis role='bold'>Match</emphasis> +error results). +<!-- .sp --> +</para> + </section> + <section id="requests:QueryExtension"> + <title>QueryExtension</title> + <indexterm zone="requests:QueryExtension" significance="preferred"><primary>QueryExtension</primary></indexterm> + <indexterm zone="requests:QueryExtension"><primary>Extension</primary><secondary>querying</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>name</emphasis>: STRING8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +present: BOOL + </entry> + </row> + <row> + <entry> +major-opcode: CARD8 + </entry> + </row> + <row> + <entry> +first-event: CARD8 + </entry> + </row> + <row> + <entry> +first-error: CARD8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request determines if the named extension is present. +If so, +the major opcode for the extension is returned, if it has one. +Otherwise, zero is returned. +Any minor opcode and the request formats are specific to the extension. +If the extension involves additional event types, +the base event type code is returned. +Otherwise, zero is returned. +The format of the events is specific to the extension. +If the extension involves additional error codes, +the base error code is returned. +Otherwise, zero is returned. +The format of additional data in the errors is specific to the extension. +</para> +<para> +The extension name should use the ISO Latin-1 encoding, +and uppercase and lowercase matter. +<!-- .sp --> +</para> + </section> + <section id="requests:ListExtensions"> + <title>ListExtensions</title> + <indexterm zone="requests:ListExtensions" significance="preferred"><primary>ListExtensions</primary></indexterm> + <indexterm zone="requests:ListExtensions"><primary>Extension</primary><secondary>listing</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +names: LISTofSTRING8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns a list of all extensions supported by the server. +</para> + </section> + <section id="requests:SetModifierMapping"> + <title>SetModifierMapping</title> + <indexterm zone="requests:SetModifierMapping" significance="preferred"><primary>SetModifierMapping</primary></indexterm> + <indexterm zone="requests:SetModifierMapping"><primary>Modifier keys</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>keycodes-per-modifier</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>keycodes</emphasis>: LISTofKEYCODE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +status: +{ <emphasis role='bold'>Success</emphasis>, +<emphasis role='bold'>Busy</emphasis>, +<emphasis role='bold'>Failed</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request specifies the keycodes (if any) of the keys to be used as +modifiers. +The number of keycodes in the list must be 8*keycodes-per-modifier (or a +<emphasis role='bold'>Length</emphasis> +error results). +The keycodes are divided into eight sets, +with each set containing keycodes-per-modifier elements. +The sets are assigned to the modifiers +<emphasis role='bold'>Shift</emphasis>, +<emphasis role='bold'>Lock</emphasis>, +<emphasis role='bold'>Control</emphasis>, +<emphasis role='bold'>Mod1</emphasis>, +<emphasis role='bold'>Mod2</emphasis>, +<emphasis role='bold'>Mod3</emphasis>, +<emphasis role='bold'>Mod4</emphasis>, +and +<emphasis role='bold'>Mod5</emphasis>, +in order. +Only nonzero keycode values are used within each set; +zero values are ignored. +All of the nonzero keycodes must be in the range specified by min-keycode +and max-keycode in the connection setup (or a +<emphasis role='bold'>Value</emphasis> +error results). +The order of keycodes within a set does not matter. +If no nonzero values are specified in a set, +the use of the corresponding modifier is disabled, +and the modifier bit will always be zero. +Otherwise, the modifier bit will be one whenever +at least one of the keys in the corresponding set is in the down +position. +</para> +<para> +A server can impose restrictions on how modifiers can be changed (for example, +if certain keys do not generate up transitions in hardware, +if auto-repeat cannot be disabled on certain keys, +or if multiple keys per modifier are not supported). +The status reply is +<emphasis role='bold'>Failed</emphasis> +if some such restriction is violated, +and none of the modifiers is changed. +</para> +<para> +If the new nonzero keycodes specified for a modifier differ from those +currently defined and any (current or new) keys for that modifier are +logically in the down state, then the status reply is +<emphasis role='bold'>Busy</emphasis>, +and none of the modifiers is changed. +</para> +<para> +This request generates a +<link linkend="events:MappingNotify"><emphasis role='bold'>MappingNotify</emphasis></link> +event on a +<emphasis role='bold'>Success</emphasis> +status. +<!-- .sp --> +</para> + </section> + <section id="requests:GetModifierMapping"> + <title>GetModifierMapping</title> + <indexterm zone="requests:GetModifierMapping" significance="preferred"><primary>GetModifierMapping</primary></indexterm> + <indexterm zone="requests:GetModifierMapping"><primary>Modifier keys</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +keycodes-per-modifier: CARD8 + </entry> + </row> + <row> + <entry> +keycodes: LISTofKEYCODE +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the keycodes of the keys being used as modifiers. +The number of keycodes in the list is 8*keycodes-per-modifier. +The keycodes are divided into eight sets, +with each set containing keycodes-per-modifier elements. +The sets are assigned to the modifiers +<emphasis role='bold'>Shift</emphasis>, +<emphasis role='bold'>Lock</emphasis>, +<emphasis role='bold'>Control</emphasis>, +<emphasis role='bold'>Mod1</emphasis>, +<emphasis role='bold'>Mod2</emphasis>, +<emphasis role='bold'>Mod3</emphasis>, +<emphasis role='bold'>Mod4</emphasis>, +and +<emphasis role='bold'>Mod5</emphasis>, +in order. +The keycodes-per-modifier value is chosen arbitrarily by the server; +zeroes are used to fill in unused elements within each set. +If only zero values are given in a set, +the use of the corresponding modifier has been disabled. +The order of keycodes within each set is chosen arbitrarily by the server. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeKeyboardMapping"> + <title>ChangeKeyboardMapping</title> + <indexterm zone="requests:ChangeKeyboardMapping" significance="preferred"><primary>ChangeKeyboardMapping</primary></indexterm> + <indexterm zone="requests:ChangeKeyboardMapping"><primary>Keysym</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>first-keycode</emphasis>: KEYCODE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>keysyms-per-keycode</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>keysyms</emphasis>: LISTofKEYSYM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Alloc</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request defines the symbols for the specified number of keycodes, +starting with the specified keycode. +The symbols for keycodes outside this range remained unchanged. +The number of elements in the keysyms list must be a multiple of +keysyms-per-keycode (or a +<emphasis role='bold'>Length</emphasis> +error results). +The first-keycode must be greater than or equal to min-keycode as returned +in the connection setup (or a +<emphasis role='bold'>Value</emphasis> +error results) and: +<literallayout class="monospaced"> + first-keycode + (keysyms-length / keysyms-per-keycode) - 1 +</literallayout> +</para> +<para> +must be less than or equal to max-keycode as returned in the connection +setup (or a +<emphasis role='bold'>Value</emphasis> +error results). +KEYSYM number N (counting from zero) for keycode K has an index +(counting from zero) of: +<literallayout class="monospaced"> + (K - first-keycode) * keysyms-per-keycode + N +</literallayout> +</para> +<para> +in keysyms. +The keysyms-per-keycode can be chosen arbitrarily by the client +to be large enough to hold all desired symbols. +A special KEYSYM value of +<keysym>NoSymbol</keysym> +should be used to fill in unused elements for individual keycodes. +It is legal for +<keysym>NoSymbol</keysym> +to appear in nontrailing positions of the effective list for a keycode. +</para> +<para> +This request generates a +<link linkend="events:MappingNotify"><emphasis role='bold'>MappingNotify</emphasis></link> +event. +</para> +<para> +There is no requirement that the server interpret this mapping; +it is merely stored for reading and writing by clients +(see <link linkend='Keyboards'>section 5</link>). +<!-- .sp --> +</para> + </section> + <section id="requests:GetKeyboardMapping"> + <title>GetKeyboardMapping</title> + <indexterm zone="requests:GetKeyboardMapping" significance="preferred"><primary>GetKeyboardMapping</primary></indexterm> + <indexterm zone="requests:GetKeyboardMapping"><primary>Keysym</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>first-keycode</emphasis>: KEYCODE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>count</emphasis>: CARD8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +keysyms-per-keycode: CARD8 + </entry> + </row> + <row> + <entry> +keysyms: LISTofKEYSYM +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the symbols for the specified number of keycodes, +starting with the specified keycode. +The first-keycode must be greater than or equal to +min-keycode as returned in the connection setup (or a +<emphasis role='bold'>Value</emphasis> +error results), and: +<literallayout class="monospaced"> + first-keycode + count - 1 +</literallayout> +</para> +<para> +must be less than or equal to max-keycode as returned in the connection setup +(or a +<emphasis role='bold'>Value</emphasis> +error results). +The number of elements in the keysyms list is: +<literallayout class="monospaced"> + count * keysyms-per-keycode +</literallayout> +</para> +<para> +and KEYSYM number N (counting from zero) for keycode K has an index +(counting from zero) of: +<literallayout class="monospaced"> + (K - first-keycode) * keysyms-per-keycode + N +</literallayout> +</para> +<para> +in keysyms. +The keysyms-per-keycode value is chosen arbitrarily by the server +to be large enough to report all requested symbols. +A special KEYSYM value of +<keysym>NoSymbol</keysym> +is used to fill in unused elements for individual keycodes. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeKeyboardControl"> + <title>ChangeKeyboardControl</title> + <indexterm zone="requests:ChangeKeyboardControl" significance="preferred"><primary>ChangeKeyboardControl</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>value-mask</emphasis>: BITMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-list</emphasis>: LISTofVALUE +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +Errors: +<emphasis role='bold'>Match</emphasis>, +<emphasis role='bold'>Value</emphasis> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +This request controls various aspects of the keyboard. +The value-mask and value-list specify which controls are to be changed. +The possible values are: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Control</entry> + <entry>Type</entry> + </row> + </thead> + <tbody> + <row> + <entry>key-click-percent</entry> + <entry>INT8</entry> + </row> + <row> + <entry>bell-percent</entry> + <entry>INT8</entry> + </row> + <row> + <entry>bell-pitch</entry> + <entry>INT16</entry> + </row> + <row> + <entry>bell-duration</entry> + <entry>INT16</entry> + </row> + <row> + <entry>led</entry> + <entry>CARD8</entry> + </row> + <row> + <entry>led-mode</entry> + <entry> +{ <emphasis role='bold'>On</emphasis>, +<emphasis role='bold'>Off</emphasis> } + </entry> + </row> + <row> + <entry>key </entry> + <entry>KEYCODE</entry> + </row> + <row> + <entry>auto-repeat-mode</entry> + <entry> +{ <emphasis role='bold'>On</emphasis>, +<emphasis role='bold'>Off</emphasis>, +<emphasis role='bold'>Default</emphasis> } + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +The key-click-percent sets the volume for key clicks between 0 (off) and +100 (loud) inclusive, if possible. +Setting to -1 restores the default. +Other negative values generate a +<emphasis role='bold'>Value</emphasis> +error. +</para> +<para> +The bell-percent sets the base volume for the bell between 0 (off) and 100 +(loud) inclusive, if possible. +Setting to -1 restores the default. +Other negative values generate a +<emphasis role='bold'>Value</emphasis> +error. +</para> +<para> +The bell-pitch sets the pitch (specified in Hz) of the bell, if possible. +Setting to -1 restores the default. +Other negative values generate a +<emphasis role='bold'>Value</emphasis> +error. +</para> +<para> +The bell-duration sets the duration of the bell (specified in milliseconds), +if possible. +Setting to -1 restores the default. +Other negative values generate a +<emphasis role='bold'>Value</emphasis> +error. +</para> +<para> +If both led-mode and led are specified, +then the state of that LED is changed, if possible. +If only led-mode is specified, +then the state of all LEDs are changed, if possible. +At most 32 LEDs, numbered from one, are supported. +No standard interpretation of LEDs is defined. +It is a +<emphasis role='bold'>Match</emphasis> +error if an led is specified without an led-mode. +</para> +<para> +If both auto-repeat-mode and key are specified, +then the auto-repeat mode of that key is changed, if possible. +If only auto-repeat-mode is specified, +then the global auto-repeat mode for the entire keyboard is changed, +if possible, without affecting the per-key settings. +It is a +<emphasis role='bold'>Match</emphasis> +error if a key is specified without an auto-repeat-mode. +Each key has an individual mode of whether or not it should auto-repeat +and a default setting for that mode. +In addition, there is a global mode of whether auto-repeat should be +enabled or not and a default setting for that mode. +When the global mode is +<emphasis role='bold'>On</emphasis>, +keys should obey their individual auto-repeat modes. +When the global mode is +<emphasis role='bold'>Off</emphasis>, +no keys should auto-repeat. +An auto-repeating key generates alternating +<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link> +and +<link linkend="events:KeyRelease"><emphasis role='bold'>KeyRelease</emphasis></link> +events. +When a key is used as a modifier, +it is desirable for the key not to auto-repeat, +regardless of the auto-repeat setting for that key. +</para> +<para> +A bell generator connected with the console but not directly on the +keyboard is treated as if it were part of the keyboard. +</para> +<para> +The order in which controls are verified and altered is server-dependent. +If an error is generated, +a subset of the controls may have been altered. +<!-- .sp --> +</para> + </section> + <section id="requests:GetKeyboardControl"> + <title>GetKeyboardControl</title> + <indexterm zone="requests:GetKeyboardControl" significance="preferred"><primary>GetKeyboardControl</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +key-click-percent: CARD8 + </entry> + </row> + <row> + <entry> +bell-percent: CARD8 + </entry> + </row> + <row> + <entry> +bell-pitch: CARD16 + </entry> + </row> + <row> + <entry> +bell-duration: CARD16 + </entry> + </row> + <row> + <entry> +led-mask: CARD32 + </entry> + </row> + <row> + <entry> +global-auto-repeat: +{ <emphasis role='bold'>On</emphasis>, +<emphasis role='bold'>Off</emphasis>} + </entry> + </row> + <row> + <entry> +auto-repeats: LISTofCARD8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current control values for the keyboard. +For the LEDs, +the least significant bit of led-mask corresponds to LED one, +and each one bit in led-mask indicates an LED that is lit. +The auto-repeats is a bit vector; +each one bit indicates that auto-repeat is enabled for the corresponding key. +The vector is represented as 32 bytes. +Byte N (from 0) contains the bits for keys 8N to 8N + 7, +with the least significant bit in the byte representing key 8N. +<!-- .sp --> +</para> + </section> + <section id="requests:Bell"> + <title>Bell</title> + <indexterm zone="requests:Bell" significance="preferred"><primary>Bell</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>percent</emphasis>: INT8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request rings the bell on the keyboard at a volume relative to the +base volume for the keyboard, if possible. +Percent can range from -100 to 100 inclusive (or a +<emphasis role='bold'>Value</emphasis> +error results). +The volume at which the bell is rung when percent is nonnegative is: +<literallayout class="monospaced"> + base - [(base * percent) / 100] + percent +</literallayout> +</para> +<para> +When percent is negative, it is: +<literallayout class="monospaced"> + base + [(base * percent) / 100] +</literallayout> +<!-- .sp --> +</para> + </section> + <section id="requests:SetPointerMapping"> + <title>SetPointerMapping</title> + <indexterm zone="requests:SetPointerMapping" significance="preferred"><primary>SetPointerMapping</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>map</emphasis>: LISTofCARD8 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +status: +{ <emphasis role='bold'>Success</emphasis>, +<emphasis role='bold'>Busy</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request sets the mapping of the pointer. +Elements of the list are indexed starting from one. +The length of the list must be the same as +<link linkend="requests:GetPointerMapping"><emphasis role='bold'>GetPointerMapping</emphasis></link> +would return (or a +<emphasis role='bold'>Value</emphasis> +error results). +The index is a core button number, +and the element of the list defines the effective number. +</para> +<para> +A zero element disables a button. +Elements are not restricted in value by the number of physical buttons, +but no two elements can have the same nonzero value (or a +<emphasis role='bold'>Value</emphasis> +error results). +</para> +<para> +If any of the buttons to be altered are logically in the down state, +the status reply is +<emphasis role='bold'>Busy</emphasis>, +and the mapping is not changed. +</para> +<para> +This request generates a +<link linkend="events:MappingNotify"><emphasis role='bold'>MappingNotify</emphasis></link> +event on a +<emphasis role='bold'>Success</emphasis> +status. +<!-- .sp --> +</para> + </section> + <section id="requests:GetPointerMapping"> + <title>GetPointerMapping</title> + <indexterm zone="requests:GetPointerMapping" significance="preferred"><primary>GetPointerMapping</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +map: LISTofCARD8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current mapping of the pointer. +Elements of the list are indexed starting from one. +The length of the list indicates the number of physical buttons. +</para> +<para> +The nominal mapping for a pointer is the identity mapping: map[i]=i. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangePointerControl"> + <title>ChangePointerControl</title> + <indexterm zone="requests:ChangePointerControl" significance="preferred"><primary>ChangePointerControl</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>do-acceleration</emphasis>, <emphasis remap='I'>do-threshold</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>acceleration-numerator</emphasis>, <emphasis remap='I'>acceleration-denominator</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>threshold</emphasis>: INT16 +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request defines how the pointer moves. +The acceleration is a multiplier for movement expressed as a fraction. +For example, +specifying 3/1 means the pointer moves three times as fast as normal. +The fraction can be rounded arbitrarily by the server. +Acceleration only takes effect if the pointer moves more than threshold +number of pixels at once and only applies to the amount beyond the threshold. +Setting a value to -1 restores the default. +Other negative values generate a +<emphasis role='bold'>Value</emphasis> +error, as does a zero value for acceleration-denominator. +<!-- .sp --> +</para> + </section> + <section id="requests:GetPointerControl"> + <title>GetPointerControl</title> + <indexterm zone="requests:GetPointerControl" significance="preferred"><primary>GetPointerControl</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +acceleration-numerator, acceleration-denominator: CARD16 + </entry> + </row> + <row> + <entry> +threshold: CARD16 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current acceleration and threshold for the pointer. +<!-- .sp --> +</para> + </section> + <section id="requests:SetScreenSaver"> + <title>SetScreenSaver</title> + <indexterm zone="requests:SetScreenSaver" significance="preferred"><primary>SetScreenSaver</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>timeout</emphasis>, <emphasis remap='I'>interval</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>prefer-blanking</emphasis>: +{ <emphasis role='bold'>Yes</emphasis>, +<emphasis role='bold'>No</emphasis>, +<emphasis role='bold'>Default</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>allow-exposures</emphasis>: +{ <emphasis role='bold'>Yes</emphasis>, +<emphasis role='bold'>No</emphasis>, +<emphasis role='bold'>Default</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +The timeout and interval are specified in seconds; +setting a value to -1 restores the default. +Other negative values generate a +<emphasis role='bold'>Value</emphasis> +error. +If the timeout value is zero, +screen-saver is disabled (but an activated screen-saver is not deactivated). +If the timeout value is nonzero, +screen-saver is enabled. +Once screen-saver is enabled, +if no input from the keyboard or pointer is generated for timeout seconds, +screen-saver is activated. +For each screen, +if blanking is preferred and the hardware supports video blanking, +the screen will simply go blank. +Otherwise, +if either exposures are allowed or the screen can be regenerated without +sending exposure events to clients, +the screen is changed in a server-dependent fashion to avoid phosphor burn. +Otherwise, +the state of the screens does not change, and screen-saver is not activated. +At the next keyboard or pointer input or at the next +<link linkend="requests:ForceScreenSaver"><emphasis role='bold'>ForceScreenSaver</emphasis></link> +with mode +<emphasis role='bold'>Reset</emphasis>, +screen-saver is deactivated, and all screen states are restored. +</para> +<para> +If the server-dependent screen-saver method is amenable to periodic change, +interval serves as a hint about how long the change period should be, +with zero hinting that no periodic change should be made. +Examples of ways to change the screen include scrambling the color map +periodically, moving an icon image about the screen periodically, or +tiling the screen with the root window background tile, +randomly reorigined periodically. +<!-- .sp --> +</para> + </section> + <section id="requests:GetScreenSaver"> + <title>GetScreenSaver</title> + <indexterm zone="requests:GetScreenSaver" significance="preferred"><primary>GetScreenSaver</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +timeout, interval: CARD16 + </entry> + </row> + <row> + <entry> +prefer-blanking: +{ <emphasis role='bold'>Yes</emphasis>, +<emphasis role='bold'>No</emphasis>} + </entry> + </row> + <row> + <entry> +allow-exposures: +{ <emphasis role='bold'>Yes</emphasis>, +<emphasis role='bold'>No</emphasis>} +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the current screen-saver control values. +<!-- .sp --> +</para> + </section> + <section id="requests:ForceScreenSaver"> + <title>ForceScreenSaver</title> + <indexterm zone="requests:ForceScreenSaver" significance="preferred"><primary>ForceScreenSaver</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Activate</emphasis>, +<emphasis role='bold'>Reset</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If the mode is +<emphasis role='bold'>Activate</emphasis> +and screen-saver is currently deactivated, +then screen-saver is activated (even if screen-saver has been disabled with +a timeout value of zero). +If the mode is +<emphasis role='bold'>Reset</emphasis> +and screen-saver is currently enabled, +then screen-saver is deactivated (if it was activated), +and the activation timer is reset to its initial state +as if device input had just been received. +<!-- .sp --> +</para> + </section> + <section id="requests:ChangeHosts"> + <title>ChangeHosts</title> + <indexterm zone="requests:ChangeHosts" significance="preferred"><primary>ChangeHosts</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Insert</emphasis>, +<emphasis role='bold'>Delete</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>host</emphasis>: HOST +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request adds or removes the specified host from the access control list. +<indexterm zone="requests:ChangeHosts"><primary>Access control list</primary></indexterm> +When the access control mechanism is enabled and a client attempts to +establish a connection to the server, +the host on which the client resides must be in the access control list, +or the client must have been granted permission by a server-dependent +method, or the server will refuse the connection. +</para> +<para> +The client must reside on the same host as the server and/or have been granted +permission by a server-dependent method to execute this request (or an +<emphasis role='bold'>Access</emphasis> +error results). +</para> +<para> +An initial access control list can usually be specified, +typically by naming a file that the server reads at startup and reset. +</para> +<para id="address_families"> +The following address families are defined. +<indexterm zone="address_families"><primary>Types</primary><secondary>HOST</secondary></indexterm> +A server is not required to support these families +and may support families not listed here. +Use of an unsupported family, an improper address format, +or an improper address length within a supported family results in a +<emphasis role='bold'>Value</emphasis> +error. +</para> +<para> +For the Internet family, +the address must be four bytes long. +The address bytes are in standard IP order; +the server performs no automatic swapping on the address bytes. +The Internet family supports IP version 4 addresses only. +</para> +<para> +For the InternetV6 family, the address must be sixteen bytes +long. The address bytes are in standard IP order; the +server performs no automatic swapping on the address bytes. +The InternetV6 family supports IP version 6 addresses only. +</para> +<para> +For the DECnet family, +the server performs no automatic swapping on the address bytes. +A Phase IV address is two bytes long: +the first byte contains the least significant eight bits of the node number, +and the second byte contains the most significant two bits of the node number in +the least significant two bits of the byte and the area in the most +significant six bits of the byte. +</para> +<para> +For the Chaos family, +the address must be two bytes long. +The host number is always the first byte in the address, +and the subnet number is always the second byte. +The server performs no automatic swapping on the address bytes. +</para> +<para> +For the ServerInterpreted family, the address may be of any +length up to 65535 bytes. The address consists of two strings +of ASCII characters, separated by a byte with a value of 0. +The first string represents the type of address, and the second +string contains the address value. Address types and the syntax +for their associated values will be registered via the X.Org Registry. +Implementors who wish to add implementation specific types may register +a unique prefix with the X.Org registry to prevent namespace +collisions. +</para> +<para> +Use of a host address in the ChangeHosts request is deprecated. It is +only useful when a host has a unique, constant address, a requirement +that is increasingly unmet as sites adopt dynamically assigned +addresses, network address translation gateways, IPv6 link local +addresses, and various other technologies. It also assumes all users of +a host share equivalent access rights, and as such has never been +suitable for many multi-user machine environments. Instead, more +secure forms of authentication, such as those based on shared secrets +or public key encryption, are recommended. +<!-- .sp --> +</para> + </section> + <section id="requests:ListHosts"> + <title>ListHosts</title> + <indexterm zone="requests:ListHosts" significance="preferred"><primary>ListHosts</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + ▶ + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +mode: +{ <emphasis role='bold'>Enabled</emphasis>, +<emphasis role='bold'>Disabled</emphasis>} + </entry> + </row> + <row> + <entry> +hosts: LISTofHOST +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request returns the hosts on the access control list +and whether use of the list at connection setup is currently +enabled or disabled. +</para> +<para> +Each HOST is padded to a multiple of four bytes. +<!-- .sp --> +</para> + </section> + <section id="requests:SetAccessControl"> + <title>SetAccessControl</title> + <indexterm zone="requests:SetAccessControl" significance="preferred"><primary>SetAccessControl</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Enable</emphasis>, +<emphasis role='bold'>Disable</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Access</emphasis>, +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request enables or disables the use of the access control list +at connection setups. +</para> +<para> +The client must reside on the same host as the server +and/or have been granted permission by a server-dependent method +to execute this request (or an +<emphasis role='bold'>Access</emphasis> +error results). +<!-- .sp --> +</para> + </section> + <section id="requests:SetCloseDownMode"> + <title>SetCloseDownMode</title> + <indexterm zone="requests:SetCloseDownMode" significance="preferred"><primary>SetCloseDownMode</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Destroy</emphasis>, +<emphasis role='bold'>RetainPermanent</emphasis>, +<emphasis role='bold'>RetainTemporary</emphasis>} +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This request defines what will happen to the client's resources +at connection close. +A connection starts in +<emphasis role='bold'>Destroy</emphasis> +mode. +The meaning of the close-down mode is described +in <link linkend='Connection_Close'>section 10</link>. +<!-- .sp --> +</para> + </section> + <section id="requests:KillClient"> + <title>KillClient</title> + <indexterm zone="requests:KillClient" significance="preferred"><primary>KillClient</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>resource</emphasis>: CARD32 or +<emphasis role='bold'>AllTemporary</emphasis> +<!-- .in -.2i --> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +Errors: +<emphasis role='bold'>Value</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If a valid resource is specified, +<link linkend="requests:KillClient"><emphasis role='bold'>KillClient</emphasis></link> +forces a close-down of the client that created the resource. +If the client has already terminated in either +<emphasis role='bold'>RetainPermanent</emphasis> +or +<emphasis role='bold'>RetainTemporary</emphasis> +mode, all of the client's resources are destroyed +(see <link linkend='Connection_Close'>section 10</link>). +If +<emphasis role='bold'>AllTemporary</emphasis> +is specified, +then the resources of all clients that have terminated in +<emphasis role='bold'>RetainTemporary</emphasis> +are destroyed. +<!-- .sp --> +</para> + </section> + <section id="requests:NoOperation"> + <title>NoOperation</title> + <indexterm zone="requests:NoOperation" significance="preferred"><primary>NoOperation</primary></indexterm> +<para> +This request has no arguments and no results, +but the request length field +allows the request to be any multiple of four bytes in length. +The bytes contained in the request are uninterpreted by the server. +</para> +<para> +This request can be used in its minimum four byte form as padding where +necessary by client libraries that find it convenient to force requests +to begin on 64-bit boundaries. +</para> + </section> +</chapter> + +<chapter id='Connection_Close'> +<title>Connection Close</title> + <indexterm zone="Connection_Close"><primary>Connection</primary><secondary>closing</secondary></indexterm> +<!-- .XS --> +<!-- \*(SN Connection Close --> +<!-- .XE --> +<para> +At connection close, +all event selections made by the client are discarded. +If the client has the pointer actively grabbed, an +<link linkend="requests:UngrabPointer"><emphasis role='bold'>UngrabPointer</emphasis></link> +is performed. +If the client has the keyboard actively grabbed, an +<link linkend="requests:UngrabKeyboard"><emphasis role='bold'>UngrabKeyboard</emphasis></link> +is performed. +All passive grabs by the client are released. +If the client has the server grabbed, an +<link linkend="requests:UngrabServer"><emphasis role='bold'>UngrabServer</emphasis></link> +is performed. +All selections (see +<link linkend="requests:SetSelectionOwner"><emphasis role='bold'>SetSelectionOwner</emphasis></link> +request) +owned by the client are disowned. +If close-down mode (see +<link linkend="requests:SetCloseDownMode"><emphasis role='bold'>SetCloseDownMode</emphasis></link> +request) is +<emphasis role='bold'>RetainPermanent</emphasis> +or +<emphasis role='bold'>RetainTemporary</emphasis>, +then all resources (including colormap entries) +allocated by the client are marked as permanent or temporary, +respectively (but this does not prevent other clients from explicitly +destroying them). +If the mode is +<emphasis role='bold'>Destroy</emphasis>, +all of the client's resources are destroyed. +</para> +<para> +When a client's resources are destroyed, +for each window in the client's save-set, +if the window is an inferior of a window created by the client, +the save-set window is reparented to the closest ancestor such that +the save-set window is not an inferior of a window created by the client. +If the save-set window is unmapped, a +<link linkend="requests:MapWindow"><emphasis role='bold'>MapWindow</emphasis></link> +request is performed on it (even if it was not an inferior +of a window created by the client). +The reparenting leaves unchanged the absolute coordinates +(with respect to the root window) of the upper-left outer corner of the +save-set window. +After save-set processing, +all windows created by the client are destroyed. +For each nonwindow resource created by the client, +the appropriate +<emphasis role='bold'>Free</emphasis> +request is performed. +All colors and colormap entries allocated by the client are freed. +</para> +<para> +A server goes through a cycle of having no connections and having some +connections. +At every transition to the state of having no connections +as a result of a connection closing with a +<emphasis role='bold'>Destroy</emphasis> +close-down mode, +the server resets its state as if it had just been started. +This starts by destroying all lingering resources from clients +that have terminated in +<emphasis role='bold'>RetainPermanent</emphasis> +or +<emphasis role='bold'>RetainTemporary</emphasis> +mode. +It additionally includes deleting all but the predefined atom identifiers, +deleting all properties on all root windows, resetting all device maps and +attributes (key click, bell volume, acceleration), resetting the access +control list, restoring the standard root tiles and cursors, restoring +the default font path, and restoring the input focus to state +<emphasis role='bold'>PointerRoot</emphasis>. +</para> +<para> +Note that closing a connection with a close-down mode of +<emphasis role='bold'>RetainPermanent</emphasis> +or +<emphasis role='bold'>RetainTemporary</emphasis> +will not cause the server to reset. +</para> +</chapter> +<!-- .NH 1 --> +<chapter id='Events'> +<title>Events</title> +<!-- .XS --> +<!-- \*(SN Events --> +<!-- .XE --> +<para> +<indexterm zone="Events"><primary>Event</primary></indexterm> +When a button press is processed with the pointer in some window W +and no active pointer grab is in progress, +the ancestors of W are searched from the root down, +looking for a passive grab to activate. +If no matching passive grab on the button exists, +then an active grab is started automatically for the client receiving the event, +and the last-pointer-grab time is set to the current server time. +The effect is essentially equivalent to a +<link linkend="requests:GrabButton"><emphasis role='bold'>GrabButton</emphasis></link> +with arguments: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Argument</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>event-window</entry> + <entry>Event window</entry> + </row> + <row> + <entry>event-mask</entry> + <entry> +Client's selected pointer events on the event window + </entry> + </row> + <row> + <entry>pointer-mode and keyboard-mode</entry> + <entry> +<emphasis role='bold'>Asynchronous</emphasis> + </entry> + </row> + <row> + <entry>owner-events</entry> + <entry> +<emphasis role='bold'>True</emphasis> +if the client has +<emphasis role='bold'>OwnerGrabButton</emphasis> +selected on the event window, otherwise +<emphasis role='bold'>False</emphasis> + </entry> + </row> + <row> + <entry>confine-to</entry> + <entry> +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry>cursor</entry> + <entry> +<emphasis role='bold'>None</emphasis> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + + + +<para> +The grab is terminated automatically when the logical state of the pointer +has all buttons released. +<link linkend="requests:UngrabPointer"><emphasis role='bold'>UngrabPointer</emphasis></link> +and +<link linkend="requests:ChangeActivePointerGrab"><emphasis role='bold'>ChangeActivePointerGrab</emphasis></link> +can both be used to modify the active grab. +<!-- .sp --> +</para> + + <section id="events:input"> + <title>Input Device events</title> + <indexterm zone="events:input" significance="preferred"><primary>Input device</primary><secondary>events</secondary></indexterm> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry id="events:KeyPress"> +<indexterm zone="events:KeyPress" significance="preferred"><primary>KeyPress</primary></indexterm> +<emphasis role='bold'>KeyPress</emphasis> + </entry> + </row> + <row> + <entry id="events:KeyRelease"> +<indexterm zone="events:KeyRelease" significance="preferred"><primary>KeyRelease</primary></indexterm> +<emphasis role='bold'>KeyRelease</emphasis> + </entry> + </row> + <row> + <entry id="events:ButtonPress"> +<indexterm zone="events:ButtonPress" significance="preferred"><primary>ButtonPress</primary></indexterm> +<emphasis role='bold'>ButtonPress</emphasis> + </entry> + </row> + <row> + <entry id="events:ButtonRelease"> +<indexterm zone="events:ButtonRelease" significance="preferred"><primary>ButtonRelease</primary></indexterm> +<emphasis role='bold'>ButtonRelease</emphasis> + </entry> + </row> + <row> + <entry id="events:MotionNotify"> +<indexterm zone="events:MotionNotify" significance="preferred"><primary>MotionNotify</primary></indexterm> +<emphasis role='bold'>MotionNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>root</emphasis>, <emphasis remap='I'>event</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>child</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>same-screen</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>root-x</emphasis>, <emphasis remap='I'>root-y</emphasis>, <emphasis remap='I'>event-x</emphasis>, <emphasis remap='I'>event-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>detail</emphasis>: <see below> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>state</emphasis>: SETofKEYBUTMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +These events are generated either when a key or button logically changes state +or when the pointer logically moves. +The generation of these logical changes may lag the physical changes +if device event processing is frozen. +Note that +<emphasis role='bold'>KeyPress</emphasis> +and +<emphasis role='bold'>KeyRelease</emphasis> +are generated for all keys, even those mapped to modifier bits. +<phrase id="events:input:source"> +The source of the event is the window the pointer is in. +</phrase> +<indexterm zone="events:input:source"><primary>Event</primary><secondary>source</secondary></indexterm> +The window the event is reported with respect to is called the event window. +The event window is found by starting with the source window and +looking up the hierarchy for the first window on which any client has selected +interest in the event (provided no intervening window prohibits event +generation by including the event type in its do-not-propagate-mask). +The actual window used for reporting can be modified by active grabs and, +in the case of keyboard events, can be modified by the focus window. +</para> +<para> +The root is the root window of the source window, +and root-x and root-y are the pointer coordinates relative to root's origin +at the time of the event. +Event is the event window. +If the event window is on the same screen as root, +then event-x and event-y are the pointer coordinates relative to the +event window's origin. +Otherwise, event-x and event-y are zero. +If the source window is an inferior of the event window, +then child is set to the child of the event window that is an +ancestor of (or is) the source window. +Otherwise, it is set to +<emphasis role='bold'>None</emphasis>. +The state component gives the logical state of the buttons and modifier keys +just before the event. +The detail component type varies with the event type: +</para> + +<informaltable frame='topbot'> + <?dbfo keep-together="always" ?> + <tgroup cols='2' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <colspec colname='c2' colwidth='2.0*'/> + <thead> + <row rowsep='1'> + <entry>Event</entry> + <entry>Component</entry> + </row> + </thead> + <tbody> + <row> + <entry> +<emphasis role='bold'>KeyPress</emphasis>, +<emphasis role='bold'>KeyRelease</emphasis> + </entry> + <entry>KEYCODE</entry> + </row> + <row> + <entry> +<emphasis role='bold'>ButtonPress</emphasis>, +<emphasis role='bold'>ButtonRelease</emphasis> + </entry> + <entry>BUTTON</entry> + </row> + <row> + <entry> +<emphasis role='bold'>MotionNotify</emphasis> + </entry> + <entry> +{ <emphasis role='bold'>Normal</emphasis> +<emphasis role='bold'>Hint</emphasis> } + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +<emphasis role='bold'>MotionNotify</emphasis> +events are only generated when the motion begins and ends in the window. +The granularity of motion events is not guaranteed, +but a client selecting for motion events is guaranteed to get at least one +event when the pointer moves and comes to rest. +Selecting +<emphasis role='bold'>PointerMotion</emphasis> +receives events independent of the state of the pointer buttons. +By selecting some subset of +<emphasis role='bold'>Button[1-5]Motion</emphasis> +instead, +<emphasis role='bold'>MotionNotify</emphasis> +events will only be received when one or more of the +specified buttons are pressed. +By selecting +<emphasis role='bold'>ButtonMotion</emphasis>, +<emphasis role='bold'>MotionNotify</emphasis> +events will be received only when at least one button is pressed. +The events are always of type +<emphasis role='bold'>MotionNotify</emphasis>, +independent of the selection. +If +<emphasis role='bold'>PointerMotionHint</emphasis> +is selected, +the server is free to send only one +<emphasis role='bold'>MotionNotify</emphasis> +event (with detail +<emphasis role='bold'>Hint</emphasis>) +to the client for the event window until +either the key or button state changes, +the pointer leaves the event window, +or the client issues a +<link linkend="requests:QueryPointer"><emphasis role='bold'>QueryPointer</emphasis></link> +or +<link linkend="requests:GetMotionEvents"><emphasis role='bold'>GetMotionEvents</emphasis></link> +request. +<!-- .sp --> +</para> + </section> + <section id="events:pointer_window"> + <title>Pointer Window events</title> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry id="events:EnterNotify"> +<indexterm zone="events:EnterNotify" significance="preferred"><primary>EnterNotify</primary></indexterm> +<emphasis role='bold'>EnterNotify</emphasis> + </entry> + </row> + <row> + <entry id="events:LeaveNotify"> +<indexterm zone="events:LeaveNotify" significance="preferred"><primary>LeaveNotify</primary></indexterm> +<emphasis role='bold'>LeaveNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>root</emphasis>, <emphasis remap='I'>event</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>child</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>same-screen</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>root-x</emphasis>, <emphasis remap='I'>root-y</emphasis>, <emphasis remap='I'>event-x</emphasis>, <emphasis remap='I'>event-y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Normal</emphasis>, +<emphasis role='bold'>Grab</emphasis>, +<emphasis role='bold'>Ungrab</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>detail</emphasis>: +{ <emphasis role='bold'>Ancestor</emphasis>, +<emphasis role='bold'>Virtual</emphasis>, +<emphasis role='bold'>Inferior</emphasis>, +<emphasis role='bold'>Nonlinear</emphasis>, +<emphasis role='bold'>NonlinearVirtual</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>focus</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>state</emphasis>: SETofKEYBUTMASK + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +If pointer motion or window hierarchy change causes the pointer to be +in a different window than before, +<emphasis role='bold'>EnterNotify</emphasis> +and +<emphasis role='bold'>LeaveNotify</emphasis> +events are generated instead of a +<link linkend="events:MotionNotify"><emphasis role='bold'>MotionNotify</emphasis></link> +event. +Only clients selecting +<emphasis role='bold'>EnterWindow</emphasis> +on a window receive +<emphasis role='bold'>EnterNotify</emphasis> +events, and only clients selecting +<emphasis role='bold'>LeaveWindow</emphasis> +receive +<emphasis role='bold'>LeaveNotify</emphasis> +events. +The pointer position reported in the event is always the final position, +not the initial position of the pointer. +The root is the root window for this position, +and root-x and root-y are the pointer coordinates relative to root's +origin at the time of the event. +Event is the event window. +If the event window is on the same screen as root, +then event-x and event-y are the pointer coordinates relative +to the event window's origin. +Otherwise, event-x and event-y are zero. +In a +<emphasis role='bold'>LeaveNotify</emphasis> +event, if a child of the event window contains the initial position of the +pointer, then the child component is set to that child. +Otherwise, it is +<emphasis role='bold'>None</emphasis>. +For an +<emphasis role='bold'>EnterNotify</emphasis> +event, if a child of the event window contains the final pointer position, +then the child component is set to that child. +Otherwise, it is +<emphasis role='bold'>None</emphasis>. +If the event window is the focus window or an inferior of the focus window, +then focus is +<emphasis role='bold'>True</emphasis>. +Otherwise, focus is +<emphasis role='bold'>False</emphasis>. +</para> +<para> +Normal pointer motion events have mode +<emphasis role='bold'>Normal</emphasis>. +Pseudo-motion events when a grab activates have mode +<emphasis role='bold'>Grab</emphasis>, +and pseudo-motion events when a grab deactivates have mode +<emphasis role='bold'>Ungrab</emphasis>. +</para> +<para> +All +<emphasis role='bold'>EnterNotify</emphasis> +and +<emphasis role='bold'>LeaveNotify</emphasis> +events caused by a hierarchy change are generated after any hierarchy event +caused by that change (that is, +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link>, +<link linkend="events:MapNotify"><emphasis role='bold'>MapNotify</emphasis></link>, +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link>, +<link linkend="events:GravityNotify"><emphasis role='bold'>GravityNotify</emphasis></link>, +<link linkend="events:CirculateNotify"><emphasis role='bold'>CirculateNotify</emphasis></link>), +but the ordering of +<emphasis role='bold'>EnterNotify</emphasis> +and +<emphasis role='bold'>LeaveNotify</emphasis> +events with respect to +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link>, +<link linkend="events:VisibilityNotify"><emphasis role='bold'>VisibilityNotify</emphasis></link>, +and +<link linkend="events:Expose"><emphasis role='bold'>Expose</emphasis></link> +events is not constrained. +</para> +<para> +Normal events are generated as follows: +</para> + +<para> +When the pointer moves from window A to window B and A is an inferior +of B: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>Ancestor</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>Virtual</emphasis> +is generated on each window between A and B exclusive (in that order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>Inferior</emphasis> +is generated on B. + </para> + </listitem> +</itemizedlist> + +<para> +When the pointer moves from window A to window B and B is an inferior +of A: +</para> + +<itemizedlist> + <listitem> + <para> +<!-- .IP bu 5 --> +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>Inferior</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>Virtual</emphasis> +is generated on each window between A and B exclusive (in that order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>Ancestor</emphasis> +is generated on B. + </para> + </listitem> +</itemizedlist> + +<para> +When the pointer moves from window A to window B and window C is +their least common ancestor: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window between A and C exclusive (in that order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window between C and B exclusive (in that order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on B. + </para> + </listitem> +</itemizedlist> + +<para> +When the pointer moves from window A to window B on different screens: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +If A is not a root window, +<emphasis role='bold'>LeaveNotify</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window above A up to and including its root (in order). + </para> + </listitem> + <listitem> + <para> +If B is not a root window, +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window from B's root down to but not including B +(in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on B. + </para> + </listitem> +</itemizedlist> + +<para> +When a pointer grab activates (but after any initial warp into a confine-to +window and before generating any actual +<link linkend="events:ButtonPress"><emphasis role='bold'>ButtonPress</emphasis></link> +event that activates the grab), +G is the grab-window for the grab, and P is the window the pointer is in: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +and +<emphasis role='bold'>LeaveNotify</emphasis> +events with mode +<emphasis role='bold'>Grab</emphasis> +are generated (as for +<emphasis role='bold'>Normal</emphasis> +above) as if the pointer were to suddenly warp from its current +position in P to some position in G. +However, the pointer does not warp, +and the pointer position is used as both the initial +and final positions for the events. + </para> + </listitem> +</itemizedlist> + +<para> +When a pointer grab deactivates (but after generating any actual +<link linkend="events:ButtonRelease"><emphasis role='bold'>ButtonRelease</emphasis></link> +event that deactivates the grab), G is the grab-window for +the grab, and P is the window the pointer is in: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>EnterNotify</emphasis> +and +<emphasis role='bold'>LeaveNotify</emphasis> +events with mode +<emphasis role='bold'>Ungrab</emphasis> +are generated (as for +<emphasis role='bold'>Normal</emphasis> +above) as if the pointer were to suddenly warp from +some position in G to its current position in P. +However, the pointer does not warp, +and the current pointer position is used as both the initial +and final positions for the events. + </para> + </listitem> +</itemizedlist> + + </section> + <section id="events:input_focus"> + <title>Input Focus events</title> + <indexterm zone="events:input_focus" significance="preferred"><primary>Input focus</primary><secondary>events</secondary></indexterm> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry id="events:FocusIn"> +<indexterm zone="events:FocusIn" significance="preferred"><primary>FocusIn</primary></indexterm> +<emphasis role='bold'>FocusIn</emphasis> + </entry> + </row> + <row> + <entry id="events:FocusOut"> +<indexterm zone="events:FocusOut" significance="preferred"><primary>FocusOut</primary></indexterm> +<emphasis role='bold'>FocusOut</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>mode</emphasis>: +{ <emphasis role='bold'>Normal</emphasis>, +<emphasis role='bold'>WhileGrabbed</emphasis>, +<emphasis role='bold'>Grab</emphasis>, +<emphasis role='bold'>Ungrab</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>detail</emphasis>: +{ <emphasis role='bold'>Ancestor</emphasis>, +<emphasis role='bold'>Virtual</emphasis>, +<emphasis role='bold'>Inferior</emphasis>, +<emphasis role='bold'>Nonlinear</emphasis>, +<emphasis role='bold'>NonlinearVirtual</emphasis>, +<emphasis role='bold'>Pointer</emphasis>, + </entry> + </row> + <row> + <entry> +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>None</emphasis> } +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +These events are generated when the input focus changes +and are reported to clients selecting +<emphasis role='bold'>FocusChange</emphasis> +on the window. +Events generated by +<link linkend="requests:SetInputFocus"><emphasis role='bold'>SetInputFocus</emphasis></link> +when the keyboard is not grabbed have mode +<emphasis role='bold'>Normal</emphasis>. +Events generated by +<emphasis role='bold'>SetInputFocus</emphasis> +when the keyboard is grabbed have mode +<emphasis role='bold'>WhileGrabbed</emphasis>. +Events generated when a keyboard grab activates have mode +<emphasis role='bold'>Grab</emphasis>, +and events generated when a keyboard grab deactivates have mode +<emphasis role='bold'>Ungrab</emphasis>. +</para> +<para> +All +<emphasis role='bold'>FocusOut</emphasis> +events caused by a window unmap are generated after any +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link> +event, but the ordering of +<emphasis role='bold'>FocusOut</emphasis> +with respect to generated +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link>, +<link linkend="events:LeaveNotify"><emphasis role='bold'>LeaveNotify</emphasis></link>, +<link linkend="events:VisibilityNotify"><emphasis role='bold'>VisibilityNotify</emphasis></link>, +and +<link linkend="events:Expose"><emphasis role='bold'>Expose</emphasis></link> +events is not constrained. +</para> +<para> +<emphasis role='bold'>Normal</emphasis> +and +<emphasis role='bold'>WhileGrabbed</emphasis> +events are generated as follows: +</para> +<para> +When the focus moves from window A to window B, A is an inferior of B, +and the pointer is in window P: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Ancestor</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Virtual</emphasis> +is generated on each window between A and B exclusive (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Inferior</emphasis> +is generated on B. + </para> + </listitem> + <listitem> + <para> +If P is an inferior of B +but P is not A or an inferior of A or an ancestor of A, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window below B down to and including P (in order). + </para> + </listitem> +</itemizedlist> + + +<para> +When the focus moves from window A to window B, B is an inferior of A, +and the pointer is in window P: +</para> + +<itemizedlist> + <listitem> + <para> +If P is an inferior of A +but P is not an inferior of B or an ancestor of B, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P up to but not including A (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Inferior</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Virtual</emphasis> +is generated on each window between A and B exclusive (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Ancestor</emphasis> +is generated on B. + </para> + </listitem> +</itemizedlist> + +<para> +When the focus moves from window A to window B, window C is their +least common ancestor, and the pointer is in window P: +</para> + +<itemizedlist> + <listitem> + <para> +If P is an inferior of A, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P up to but not including A (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window between A and C exclusive (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window between C and B exclusive (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on B. + </para> + </listitem> + <listitem> + <para> +If P is an inferior of B, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window below B down to and including P (in order). + </para> + </listitem> +</itemizedlist> + +<para> +When the focus moves from window A to window B on different screens +and the pointer is in window P: +</para> + + +<itemizedlist> + <listitem> + <para> +If P is an inferior of A, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P up to but not including A (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +If A is not a root window, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window above A up to and including its root (in order). + </para> + </listitem> + <listitem> + <para> +If B is not a root window, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window from B's root down to but not including B +(in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on B. + </para> + </listitem> + <listitem> + <para> +If P is an inferior of B, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window below B down to and including P (in order). + </para> + </listitem> +</itemizedlist> + +<para> +When the focus moves from window A to +<emphasis role='bold'>PointerRoot</emphasis> +(or +<emphasis role='bold'>None</emphasis>) +and the pointer is in window P: +</para> + + +<itemizedlist> + <listitem> + <para> +If P is an inferior of A, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P up to but not including A (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +If A is not a root window, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window above A up to and including its root (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>PointerRoot</emphasis> +(or +<emphasis role='bold'>None</emphasis>) +is generated on all root windows. + </para> + </listitem> + <listitem> + <para> +If the new focus is +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P's root down to and including P (in order). + </para> + </listitem> +</itemizedlist> + +<para> +When the focus moves from +<emphasis role='bold'>PointerRoot</emphasis> +(or +<emphasis role='bold'>None</emphasis>) +to window A and the pointer is in window P: +</para> + + +<itemizedlist> + <listitem> + <para> +If the old focus is +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P up to and including P's root (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>PointerRoot</emphasis> +(or +<emphasis role='bold'>None</emphasis>) +is generated on all root windows. + </para> + </listitem> + <listitem> + <para> +If A is not a root window, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>NonlinearVirtual</emphasis> +is generated on each window from A's root down to but not including A +(in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Nonlinear</emphasis> +is generated on A. + </para> + </listitem> + <listitem> + <para> +If P is an inferior of A, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window below A down to and including P (in order). + </para> + </listitem> +</itemizedlist> + +<para> +When the focus moves from +<emphasis role='bold'>PointerRoot</emphasis> +to +<emphasis role='bold'>None</emphasis> +(or vice versa) and the pointer is in window P: +</para> + +<itemizedlist> + <listitem> + <para> +If the old focus is +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P up to and including P's root (in order). + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusOut</emphasis> +with detail +<emphasis role='bold'>PointerRoot</emphasis> +(or +<emphasis role='bold'>None</emphasis>) +is generated on all root windows. + </para> + </listitem> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>None</emphasis> +(or +<emphasis role='bold'>PointerRoot</emphasis>) +is generated on all root windows. + </para> + </listitem> + <listitem> + <para> +If the new focus is +<emphasis role='bold'>PointerRoot</emphasis>, +<emphasis role='bold'>FocusIn</emphasis> +with detail +<emphasis role='bold'>Pointer</emphasis> +is generated on each window from P's root down to and including P (in order). + </para> + </listitem> +</itemizedlist> + + +<para> +When a keyboard grab activates (but before generating any actual +<emphasis role='bold'>KeyPress</emphasis> +event that activates the grab), G is the grab-window for the grab, +and F is the current focus: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +and +<emphasis role='bold'>FocusOut</emphasis> +events with mode +<emphasis role='bold'>Grab</emphasis> +are generated (as for +<emphasis role='bold'>Normal</emphasis> +above) as if the focus were to change from F to G. + </para> + </listitem> +</itemizedlist> + +<para> +When a keyboard grab deactivates (but after generating any actual +<emphasis role='bold'>KeyRelease</emphasis> +event that deactivates the grab), G is the grab-window for the grab, +and F is the current focus: +</para> + +<itemizedlist> + <listitem> + <para> +<emphasis role='bold'>FocusIn</emphasis> +and +<emphasis role='bold'>FocusOut</emphasis> +events with mode +<emphasis role='bold'>Ungrab</emphasis> +are generated (as for +<emphasis role='bold'>Normal</emphasis> +above) as if the focus were to change from G to F. + </para> + </listitem> +</itemizedlist> + + </section> + <section id="events:KeymapNotify"> + <title>KeymapNotify</title> + <indexterm zone="events:KeymapNotify" significance="preferred"><primary>KeymapNotify</primary></indexterm> + +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>KeymapNotify</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>keys</emphasis>: LISTofCARD8 + </entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para> +The value is a bit vector as described in +<link linkend="requests:QueryKeymap"><emphasis role='bold'>QueryKeymap</emphasis></link>. +This event is reported to clients selecting +<emphasis role='bold'>KeymapState</emphasis> +on a window and is generated immediately after every +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link> +and +<link linkend="events:FocusIn"><emphasis role='bold'>FocusIn</emphasis></link>. +<!-- .sp --> +</para> + </section> + <section id="events:Expose"> + <title>Expose</title> + <indexterm zone="events:Expose" significance="preferred"><primary>Expose</primary></indexterm> + <indexterm zone="events:Expose"><primary>Event</primary><secondary>Exposure</secondary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>Expose</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, +<emphasis remap='I'>y</emphasis>, +<emphasis remap='I'>width</emphasis>, +<emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>count</emphasis>: CARD16 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<para> +This event is reported to clients selecting +<emphasis role='bold'>Exposure</emphasis> +on the window. +It is generated when no valid contents are available for regions of a window, +and either the regions are visible, the regions are viewable +and the server is (perhaps newly) maintaining backing store on the window, +or the window is not viewable but the server is (perhaps newly) honoring +window's backing-store attribute of +<emphasis role='bold'>Always</emphasis> +or +<emphasis role='bold'>WhenMapped</emphasis>. +The regions are decomposed into an arbitrary set of rectangles, +and an +<emphasis role='bold'>Expose</emphasis> +event is generated for each rectangle. +</para> +<para> +For a given action causing exposure events, +the set of events for a given window are guaranteed to be reported contiguously. +If count is zero, +then no more +<emphasis role='bold'>Expose</emphasis> +events for this window follow. +If count is nonzero, +then at least that many more +<emphasis role='bold'>Expose</emphasis> +events for this window follow (and possibly more). +</para> +<para> +The x and y coordinates are relative to window's origin +and specify the upper-left corner of a rectangle. +The width and height specify the extent of the rectangle. +</para> +<para> +<emphasis role='bold'>Expose</emphasis> +events are never generated on +<emphasis role='bold'>InputOnly</emphasis> +windows. +</para> +<para> +All +<emphasis role='bold'>Expose</emphasis> +events caused by a hierarchy change are generated after any +hierarchy event caused by that change (for example, +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link>, +<link linkend="events:MapNotify"><emphasis role='bold'>MapNotify</emphasis></link>, +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link>, +<link linkend="events:GravityNotify"><emphasis role='bold'>GravityNotify</emphasis></link>, +<link linkend="events:CirculateNotify"><emphasis role='bold'>CirculateNotify</emphasis></link>). +All +<emphasis role='bold'>Expose</emphasis> +events on a given window are generated after any +<link linkend="events:VisibilityNotify"><emphasis role='bold'>VisibilityNotify</emphasis></link> +event on that window, +but it is not required that all +<emphasis role='bold'>Expose</emphasis> +events on all windows be generated after all +<emphasis role='bold'>Visibilitity</emphasis> +events on all windows. +The ordering of +<emphasis role='bold'>Expose</emphasis> +events with respect to +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link>, +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link>, +and +<link linkend="events:LeaveNotify"><emphasis role='bold'>LeaveNotify</emphasis></link> +events is not constrained. +<!-- .sp --> +</para> + </section> + <section id="events:GraphicsExposure"> + <title>GraphicsExposure</title> + <indexterm zone="events:GraphicsExposure" significance="preferred"><primary>GraphicsExposure</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>GraphicsExposure</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>, <emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>count</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>major-opcode</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>minor-opcode</emphasis>: CARD16 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to a client using a graphics context +with graphics-exposures selected +and is generated when a destination region could not be computed due +to an obscured or out-of-bounds source region. +All of the regions exposed by a given graphics request +are guaranteed to be reported contiguously. +If count is zero then no more +<emphasis role='bold'>GraphicsExposure</emphasis> +events for this window follow. +If count is nonzero, +then at least that many more +<emphasis role='bold'>GraphicsExposure</emphasis> +events for this window follow (and possibly more). +</para> +<para> +The x and y coordinates are relative to drawable's origin +and specify the upper-left corner of a rectangle. +The width and height specify the extent of the rectangle. +</para> +<para> +The major and minor opcodes identify the graphics request used. +For the core protocol, +major-opcode is always +<link linkend="requests:CopyArea"><emphasis role='bold'>CopyArea</emphasis></link> +or +<link linkend="requests:CopyPlane"><emphasis role='bold'>CopyPlane</emphasis></link>, +and minor-opcode is always zero. +<!-- .sp --> +</para> + </section> + <section id="events:NoExposure"> + <title>NoExposure</title> + <indexterm zone="events:NoExposure" significance="preferred"><primary>NoExposure</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>NoExposure</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>drawable</emphasis>: DRAWABLE + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>major-opcode</emphasis>: CARD8 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>minor-opcode:</emphasis> CARD16 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to a client using a graphics context +with graphics-exposures selected +and is generated when a graphics request +that might produce +<link linkend="events:GraphicsExposure"><emphasis role='bold'>GraphicsExposure</emphasis></link> +events does not produce any. +The drawable specifies the destination used for the graphics request. +</para> +<para> +The major and minor opcodes identify the graphics request used. +For the core protocol, +major-opcode is always +<link linkend="requests:CopyArea"><emphasis role='bold'>CopyArea</emphasis></link> +or +<link linkend="requests:CopyPlane"><emphasis role='bold'>CopyPlane</emphasis></link>, +and the minor-opcode is always zero. +<!-- .sp --> +</para> + </section> + <section id="events:VisibilityNotify"> + <title>VisibilityNotify</title> + <indexterm zone="events:VisibilityNotify" significance="preferred"><primary>VisibilityNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>VisibilityNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>state</emphasis>: +{ <emphasis role='bold'>Unobscured</emphasis>, +<emphasis role='bold'>PartiallyObscured</emphasis>, +<emphasis role='bold'>FullyObscured</emphasis>} +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>VisibilityChange</emphasis> +on the window. +In the following, +the state of the window is calculated ignoring all of the window's subwindows. +When a window changes state from partially or fully obscured or +not viewable to viewable and completely unobscured, +an event with +<emphasis role='bold'>Unobscured</emphasis> +is generated. +When a window changes state from viewable and completely unobscured, +from viewable and completely obscured, +or from not viewable, to viewable and partially obscured, +an event with +<emphasis role='bold'>PartiallyObscured</emphasis> +is generated. +When a window changes state from viewable and completely unobscured, +from viewable and partially obscured, +or from not viewable to viewable and fully obscured, +an event with +<emphasis role='bold'>FullyObscured</emphasis> +is generated. +</para> +<para> +<emphasis role='bold'>VisibilityNotify</emphasis> +events are never generated on +<emphasis role='bold'>InputOnly</emphasis> +windows. +</para> +<para> +All +<emphasis role='bold'>VisibilityNotify</emphasis> +events caused by a hierarchy change are generated after any hierarchy event +caused by that change (for example, +<link linkend="events:UnmapNotify"><emphasis role='bold'>UnmapNotify</emphasis></link>, +<link linkend="events:MapNotify"><emphasis role='bold'>MapNotify</emphasis></link>, +<link linkend="events:ConfigureNotify"><emphasis role='bold'>ConfigureNotify</emphasis></link>, +<link linkend="events:GravityNotify"><emphasis role='bold'>GravityNotify</emphasis></link>, +<link linkend="events:CirculateNotify"><emphasis role='bold'>CirculateNotify</emphasis></link>). +Any +<emphasis role='bold'>VisibilityNotify</emphasis> +event on a given window is generated before any +<link linkend="events:Expose"><emphasis role='bold'>Expose</emphasis></link> +events on that window, +but it is not required that all +<emphasis role='bold'>VisibilityNotify</emphasis> +events on all windows be generated before all +<emphasis role='bold'>Expose</emphasis> +events on all windows. +The ordering of +<emphasis role='bold'>VisibilityNotify</emphasis> +events with respect to +<link linkend="events:FocusOut"><emphasis role='bold'>FocusOut</emphasis></link>, +<link linkend="events:EnterNotify"><emphasis role='bold'>EnterNotify</emphasis></link>, +and +<link linkend="events:LeaveNotify"><emphasis role='bold'>LeaveNotify</emphasis></link> +events is not constrained. +<!-- .sp --> +</para> + </section> + <section id="events:CreateNotify"> + <title>CreateNotify</title> + <indexterm zone="events:CreateNotify" significance="preferred"><primary>CreateNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>CreateNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, <emphasis remap='I'>border-width</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>override-redirect</emphasis>: BOOL +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent +and is generated when the window is created. +The arguments are as in the +<link linkend="requests:CreateWindow"><emphasis role='bold'>CreateWindow</emphasis></link> +request. +<!-- .sp --> +</para> + </section> + <section id="events:DestroyNotify"> + <title>DestroyNotify</title> + <indexterm zone="events:DestroyNotify" significance="preferred"><primary>DestroyNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>DestroyNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window and to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent. +It is generated when the window is destroyed. +The event is the window on which the event was generated, +and the window is the window that is destroyed. +</para> +<para> +The ordering of the +<emphasis role='bold'>DestroyNotify</emphasis> +events is such that for any given window, +<emphasis role='bold'>DestroyNotify</emphasis> +is generated on all inferiors of the window +before being generated on the window itself. +The ordering among siblings and across subhierarchies is not +otherwise constrained. +<!-- .sp --> +</para> + </section> + <section id="events:UnmapNotify"> + <title>UnmapNotify</title> + <indexterm zone="events:UnmapNotify" significance="preferred"><primary>UnmapNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>UnmapNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>from-configure</emphasis>: BOOL +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window and to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent. +It is generated when the window changes state from mapped to unmapped. +The event is the window on which the event was generated, +and the window is the window that is unmapped. +The from-configure flag is +<emphasis role='bold'>True</emphasis> +if the event was generated as a result of the window's parent being resized +when the window itself had a win-gravity of +<emphasis role='bold'>Unmap</emphasis>. +<!-- .sp --> +</para> + </section> + <section id="events:MapNotify"> + <title>MapNotify</title> + <indexterm zone="events:MapNotify" significance="preferred"><primary>MapNotify</primary></indexterm> + <indexterm zone="events:MapNotify"><primary>Mapped window</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>MapNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>override-redirect</emphasis>: BOOL +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window and to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent. +It is generated when the window changes state from unmapped to mapped. +The event is the window on which the event was generated, +and the window is the window that is mapped. +The override-redirect flag is from the window's attribute. +<!-- .sp --> +</para> + </section> + <section id="events:MapRequest"> + <title>MapRequest</title> + <indexterm zone="events:MapRequest" significance="preferred"><primary>MapRequest</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>MapRequest</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to the client selecting +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent and is generated when a +<link linkend="requests:MapWindow"><emphasis role='bold'>MapWindow</emphasis></link> +request is issued on an unmapped window with an override-redirect attribute of +<emphasis role='bold'>False</emphasis>. +<!-- .sp --> +</para> + </section> + <section id="events:ReparentNotify"> + <title>ReparentNotify</title> + <indexterm zone="events:ReparentNotify" significance="preferred"><primary>ReparentNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>ReparentNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>, <emphasis remap='I'>parent</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>override-redirect</emphasis>: BOOL +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on either the old or the new parent and to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window. +It is generated when the window is reparented. +The event is the window on which the event was generated. +The window is the window that has been rerooted. +The parent specifies the new parent. +The x and y coordinates are relative to the new parent's origin +and specify the position of the upper-left outer corner of the window. +The override-redirect flag is from the window's attribute. +<!-- .sp --> +</para> + </section> + <section id="events:ConfigureNotify"> + <title>ConfigureNotify</title> + <indexterm zone="events:ConfigureNotify" significance="preferred"><primary>ConfigureNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>ConfigureNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, <emphasis remap='I'>border-width</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>above-sibling</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>override-redirect</emphasis>: BOOL +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window and to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent. +It is generated when a +<link linkend="requests:ConfigureWindow"><emphasis role='bold'>ConfigureWindow</emphasis></link> +request actually changes the state of the window. +The event is the window on which the event was generated, +and the window is the window that is changed. +The x and y coordinates are relative to the new parent's origin +and specify the position of the upper-left outer corner of the window. +The width and height specify the inside size, not including the border. +If above-sibling is +<emphasis role='bold'>None</emphasis>, +then the window is on the bottom of the stack with respect to siblings. +Otherwise, the window is immediately on top of the specified sibling. +The override-redirect flag is from the window's attribute. +<!-- .sp --> +</para> + </section> + <section id="events:GravityNotify"> + <title>GravityNotify</title> + <indexterm zone="events:GravityNotify" significance="preferred"><primary>GravityNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>GravityNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent and to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window. +It is generated when a window is moved because of a change in size +of the parent. +The event is the window on which the event was generated, +and the window is the window that is moved. +The x and y coordinates are relative to the new parent's origin +and specify the position of the upper-left outer corner of the window. +<!-- .sp --> +</para> + </section> + <section id="events:ResizeRequest"> + <title>ResizeRequest</title> + <indexterm zone="events:ResizeRequest" significance="preferred"><primary>ResizeRequest</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>ResizeRequest</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>: CARD16 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to the client selecting +<emphasis role='bold'>ResizeRedirect</emphasis> +on the window and is generated when a +<link linkend="requests:ConfigureWindow"><emphasis role='bold'>ConfigureWindow</emphasis></link> +request by some other client on the window attempts to change the size +of the window. +The width and height are the requested inside size, not including the border. +<!-- .sp --> +</para> + </section> + <section id="events:ConfigureRequest"> + <title>ConfigureRequest</title> + <indexterm zone="events:ConfigureRequest" significance="preferred"><primary>ConfigureRequest</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>ConfigureRequest</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>x</emphasis>, <emphasis remap='I'>y</emphasis>: INT16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>width</emphasis>, <emphasis remap='I'>height</emphasis>, <emphasis remap='I'>border-width</emphasis>: CARD16 + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>sibling</emphasis>: WINDOW or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>stack-mode</emphasis>: +{ <emphasis role='bold'>Above</emphasis>, +<emphasis role='bold'>Below</emphasis>, +<emphasis role='bold'>TopIf</emphasis>, +<emphasis role='bold'>BottomIf</emphasis>, +<emphasis role='bold'>Opposite</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>value-mask</emphasis>: BITMASK +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to the client selecting +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent and is generated when a +<link linkend="requests:ConfigureWindow"><emphasis role='bold'>ConfigureWindow</emphasis></link> +request is issued on the window by some other client. +The value-mask indicates which components were specified in the request. +The value-mask and the corresponding values are reported as given +in the request. +The remaining values are filled in from the current geometry of the window, +except in the case of sibling and stack-mode, +which are reported as +<emphasis role='bold'>None</emphasis> +and +<emphasis role='bold'>Above</emphasis> +(respectively) if not given in the request. +<!-- .sp --> +</para> + </section> + <section id="events:CirculateNotify"> + <title>CirculateNotify</title> + <indexterm zone="events:CirculateNotify" significance="preferred"><primary>CirculateNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>CirculateNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>event</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>place</emphasis>: +{ <emphasis role='bold'>Top</emphasis>, +<emphasis role='bold'>Bottom</emphasis>} +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>StructureNotify</emphasis> +on the window and to clients selecting +<emphasis role='bold'>SubstructureNotify</emphasis> +on the parent. +It is generated when the window is actually restacked from a +<link linkend="requests:CirculateWindow"><emphasis role='bold'>CirculateWindow</emphasis></link> +request. +The event is the window on which the event was generated, +and the window is the window that is restacked. +If place is +<emphasis role='bold'>Top</emphasis>, +the window is now on top of all siblings. +Otherwise, it is below all siblings. +<!-- .sp --> +</para> + </section> + <section id="events:CirculateRequest"> + <title>CirculateRequest</title> + <indexterm zone="events:CirculateRequest" significance="preferred"><primary>CirculateRequest</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>CirculateRequest</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>parent</emphasis>, <emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>place</emphasis>: +{ <emphasis role='bold'>Top</emphasis>, +<emphasis role='bold'>Bottom</emphasis>} +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to the client selecting +<emphasis role='bold'>SubstructureRedirect</emphasis> +on the parent and is generated when a +<link linkend="requests:CirculateWindow"><emphasis role='bold'>CirculateWindow</emphasis></link> +request is issued on the parent and a window actually needs to be restacked. +The window specifies the window to be restacked, +and the place specifies what the new position in the stacking order should be. +<!-- .sp --> +</para> + </section> + <section id="events:PropertyNotify"> + <title>PropertyNotify</title> + <indexterm zone="events:PropertyNotify" significance="preferred"><primary>PropertyNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>PropertyNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>atom</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>state</emphasis>: +{ <emphasis role='bold'>NewValue</emphasis>, +<emphasis role='bold'>Deleted</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>PropertyChange</emphasis> +on the window and is generated with state +<emphasis role='bold'>NewValue</emphasis> +when a property of the window is changed using +<link linkend="requests:ChangeProperty"><emphasis role='bold'>ChangeProperty</emphasis></link> +or +<link linkend="requests:RotateProperties"><emphasis role='bold'>RotateProperties</emphasis></link>, +even when adding zero-length data using +<emphasis role='bold'>ChangeProperty</emphasis> +and when replacing all or part of a property with identical data using +<emphasis role='bold'>ChangeProperty</emphasis> +or +<emphasis role='bold'>RotateProperties</emphasis>. +It is generated with state +<emphasis role='bold'>Deleted</emphasis> +when a property of the +window is deleted using request +<link linkend="requests:DeleteProperty"><emphasis role='bold'>DeleteProperty</emphasis></link> +or +<link linkend="requests:GetProperty"><emphasis role='bold'>GetProperty</emphasis></link>. +The timestamp indicates the server time when the property was changed. +<!-- .sp --> +</para> + </section> + <section id="events:SelectionClear"> + <title>SelectionClear</title> + <indexterm zone="events:SelectionClear" significance="preferred"><primary>SelectionClear</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>SelectionClear</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>owner</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>selection</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to the current owner of a selection +and is generated when a new owner is being defined by means of +<link linkend="requests:SetSelectionOwner"><emphasis role='bold'>SetSelectionOwner</emphasis></link>. +The timestamp is the last-change time recorded for the selection. +The owner argument is the window that was specified by the current owner in its +<emphasis role='bold'>SetSelectionOwner</emphasis> +request. +<!-- .sp --> +</para> + </section> + <section id="events:SelectionRequest"> + <title>SelectionRequest</title> + <indexterm zone="events:SelectionRequest" significance="preferred"><primary>SelectionRequest</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>SelectionRequest</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>owner</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>selection</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>target</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>property</emphasis>: ATOM or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>requestor</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to the owner of a selection +and is generated when a client issues a +<link linkend="requests:ConvertSelection"><emphasis role='bold'>ConvertSelection</emphasis></link> +request. +The owner argument is the window that was specified in the +<link linkend="requests:SetSelectionOwner"><emphasis role='bold'>SetSelectionOwner</emphasis></link> +request. +The remaining arguments are as in the +<emphasis role='bold'>ConvertSelection</emphasis> +request. +</para> +<para> +The owner should convert the selection based on the specified target type +and send a +<emphasis role='bold'>SelectionNotify</emphasis> +back to the requestor. +A complete specification for using selections is given in the X.Org +standard <citetitle>Inter-Client Communication Conventions Manual</citetitle>. +<!-- .sp --> +</para> + </section> + <section id="events:SelectionNotify"> + <title>SelectionNotify</title> + <indexterm zone="events:SelectionNotify" significance="preferred"><primary>SelectionNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>SelectionNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>requestor</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>selection</emphasis>, <emphasis remap='I'>target</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>property</emphasis>: ATOM or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>time</emphasis>: TIMESTAMP or +<emphasis role='bold'>CurrentTime</emphasis> +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is generated by the server in response to a +<link linkend="requests:ConvertSelection"><emphasis role='bold'>ConvertSelection</emphasis></link> +request when there is no owner for the selection. +When there is an owner, +it should be generated by the owner using +<link linkend="requests:SendEvent"><emphasis role='bold'>SendEvent</emphasis></link>. +The owner of a selection should send this event to a requestor either +when a selection has been converted and stored as a property +or when a selection conversion could not be performed (indicated with property +<emphasis role='bold'>None</emphasis>). +<!-- .sp --> +</para> + </section> + <section id="events:ColormapNotify"> + <title>ColormapNotify</title> + <indexterm zone="events:ColormapNotify" significance="preferred"><primary>ColormapNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>ColormapNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>colormap</emphasis>: COLORMAP or +<emphasis role='bold'>None</emphasis> + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>new</emphasis>: BOOL + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>state</emphasis>: +{ <emphasis role='bold'>Installed</emphasis>, +<emphasis role='bold'>Uninstalled</emphasis>} +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is reported to clients selecting +<emphasis role='bold'>ColormapChange</emphasis> +on the window. +It is generated with value +<emphasis role='bold'>True</emphasis> +for new when the colormap attribute of the window is changed +and is generated with value +<emphasis role='bold'>False</emphasis> +for new when the colormap of a window is installed or uninstalled. +In either case, +the state indicates whether the colormap is currently installed. +<!-- .sp --> +</para> + </section> + <section id="events:MappingNotify"> + <title>MappingNotify</title> + <indexterm zone="events:MappingNotify" significance="preferred"><primary>MappingNotify</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>MappingNotify</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>request</emphasis>: +{ <emphasis role='bold'>Modifier</emphasis>, +<emphasis role='bold'>Keyboard</emphasis>, +<emphasis role='bold'>Pointer</emphasis>} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>first-keycode</emphasis>, <emphasis remap='I'>count</emphasis>: CARD8 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is sent to all clients. +There is no mechanism to express disinterest in this event. +The detail indicates the kind of change that occurred: +<emphasis role='bold'>Modifiers</emphasis> +for a successful +<link linkend="requests:SetModifierMapping"><emphasis role='bold'>SetModifierMapping</emphasis></link>, +<emphasis role='bold'>Keyboard</emphasis> +for a successful +<link linkend="requests:ChangeKeyboardMapping"><emphasis role='bold'>ChangeKeyboardMapping</emphasis></link>, +and +<emphasis role='bold'>Pointer</emphasis> +for a successful +<link linkend="requests:SetPointerMapping"><emphasis role='bold'>SetPointerMapping</emphasis></link>. +If the detail is +<emphasis role='bold'>Keyboard</emphasis>, +then first-keycode and count indicate the range of altered keycodes. +<!-- .sp --> +</para> + </section> + <section id="events:ClientMessage"> + <title>ClientMessage</title> + <indexterm zone="events:ClientMessage" significance="preferred"><primary>ClientMessage</primary></indexterm> +<informaltable frame='none'> + <?dbfo keep-together="always" ?> + <tgroup cols='1' align='left' colsep='0' rowsep='0'> + <colspec colname='c1' colwidth='1.0*'/> + <tbody> + <row> + <entry> + <emphasis role='bold'>ClientMessage</emphasis> + </entry> + </row> + <row> + <entry> +<!-- .in +.2i --> +<emphasis remap='I'>window</emphasis>: WINDOW + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>type</emphasis>: ATOM + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>format</emphasis>: {8, 16, 32} + </entry> + </row> + <row> + <entry> +<emphasis remap='I'>data</emphasis>: LISTofINT8 or LISTofINT16 or LISTofINT32 +<!-- .in -.2i --> +<!-- .eM --> + </entry> + </row> + </tbody> + </tgroup> +</informaltable> +<!-- .eM --> +<para> +This event is only generated by clients using +<link linkend="requests:SendEvent"><emphasis role='bold'>SendEvent</emphasis></link>. +The type specifies how the data is to be interpreted by the receiving client; +the server places no interpretation on the type or the data. +The format specifies whether the data should be viewed as a list of 8-bit, +16-bit, or 32-bit quantities, so that the server can correctly +byte-swap, as necessary. +The data always consists of either 20 8-bit values or 10 16-bit values +or 5 32-bit values, although particular message types might not make use +of all of these values. +</para> + </section> +</chapter> +<chapter id='Flow_Control_and_Concurrency'> +<title>Flow Control and Concurrency</title> +<!-- .XS --> +<!-- \*(SN Flow Control and Concurrency --> +<!-- .XE --> +<para> +Whenever the server is writing to a given connection, +it is permissible for the server to stop reading from that connection +(but if the writing would block, it must continue to service other connections). +The server is not required to buffer more than a single request per connection +at one time. +For a given connection to the server, +a client can block while reading from the connection +but should undertake to read (events and errors) when writing would block. +Failure on the part of a client to obey this rule could result +in a deadlocked connection, +although deadlock is probably unlikely unless either +the transport layer has very little buffering or the client attempts to +send large numbers of requests without ever reading replies or checking for +errors and events. +</para> +<para> +Whether or not a server is implemented with internal concurrency, +the overall effect must be as if individual requests are executed to completion +in some serial order, +and requests from a given connection must be executed in delivery order +(that is, the total execution order is a shuffle of the individual streams). +The execution of a request includes validating all arguments, +collecting all data for any reply, +and generating and queueing all required events. +However, +it does not include the actual transmission of the reply and the events. +In addition, the effect of any other cause that can generate multiple events +(for example, activation of a grab or pointer motion) must effectively generate +and queue all required events indivisibly with respect to all other causes +and requests. +For a request from a given client, +any events destined for that client that are caused by executing the request +must be sent to the client before any reply or error is sent. +</para> +</chapter> +</part> diff --git a/specs/x11protocol.xml b/specs/x11protocol.xml new file mode 100644 index 0000000..87ac555 --- /dev/null +++ b/specs/x11protocol.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % defs SYSTEM "defs.ent"> %defs; +]> + + +<book id="x11protocol"> + +<bookinfo> + <title>X Window System Protocol</title> + <subtitle>X Consortium Standard</subtitle> + <author> + <firstname>Robert</firstname> + <othername>W.</othername> + <surname>Scheifler</surname> + <affiliation><orgname>X Consortium, Inc.</orgname></affiliation> + </author> + <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo> + <releaseinfo>Version 1.0</releaseinfo> + <copyright><year>1986</year><year>1987</year><year>1988</year><year>1994</year><year>2004</year> + <holder>The Open Group</holder> + </copyright> + +<legalnotice> + +<para> +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: +</para> +<para> +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. +</para> +<para> +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +</para> +<para> +Except as contained in this notice, the name of the Open Group shall not be +used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization from the Open Group. +</para> +<para>X Window System is a trademark of The Open Group.</para> +</legalnotice> +</bookinfo> + +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sect1-9.xml" + xpointer="xpointer(/part/*)"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="keysyms.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="encoding.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml"/> +<index id="index" /> +</book> + |