diff options
Diffstat (limited to 'libX11/specs/libX11/CH11.xml')
| -rw-r--r-- | libX11/specs/libX11/CH11.xml | 264 |
1 files changed, 132 insertions, 132 deletions
diff --git a/libX11/specs/libX11/CH11.xml b/libX11/specs/libX11/CH11.xml index f203f6f10..9795c3220 100644 --- a/libX11/specs/libX11/CH11.xml +++ b/libX11/specs/libX11/CH11.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<chapter id="event_handling_functions"> +<chapter id='Event_Handling_Functions'> <title>Event Handling Functions</title> <para> @@ -38,15 +38,15 @@ application. One way is to set the event_mask member of the <structname>XSetWindowAttributes</structname> structure when you call -<function>XCreateWindow</function> +<xref linkend='XCreateWindow' xrefstyle='select: title'/> and -<function>XChangeWindowAttributes</function>. +<xref linkend='XChangeWindowAttributes' xrefstyle='select: title'/>. Another way is to use -<function>XSelectInput</function>. +<xref linkend='XSelectInput' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XSelectInput</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xselectinput'> +<funcsynopsis id='XSelectInput'> <funcprototype> <funcdef><function>XSelectInput</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -92,7 +92,7 @@ Specifies the event mask. <!-- .LP --> <!-- .eM --> The -<function>XSelectInput</function> +<xref linkend='XSelectInput' xrefstyle='select: title'/> function requests that the X server report the events associated with the specified event mask. Initially, X will not report any of these events. @@ -156,7 +156,7 @@ The server reports the event to all interested clients. </para> <para> <!-- .LP --> -<function>XSelectInput</function> +<xref linkend='XSelectInput' xrefstyle='select: title'/> can generate a <errorname>BadWindow</errorname> error. @@ -180,11 +180,11 @@ These functions differ in the additional tasks they might perform. <!-- .LP --> <!-- .sp --> To flush the output buffer, use -<function>XFlush</function>. +<xref linkend='XFlush' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XFlush</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xflush'> +<funcsynopsis id='XFlush'> <funcprototype> <funcdef><function>XFlush</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -207,15 +207,15 @@ Specifies the connection to the X server. <!-- .LP --> <!-- .eM --> The -<function>XFlush</function> +<xref linkend='XFlush' xrefstyle='select: title'/> function flushes the output buffer. Most client applications need not use this function because the output buffer is automatically flushed as needed by calls to -<function>XPending</function>, -<function>XNextEvent</function>, +<xref linkend='XPending' xrefstyle='select: title'/>, +<xref linkend='XNextEvent' xrefstyle='select: title'/>, and -<function>XWindowEvent</function>. +<xref linkend='XWindowEvent' xrefstyle='select: title'/>. <indexterm><primary>XPending</primary></indexterm> <indexterm><primary>XNextEvent</primary></indexterm> <indexterm><primary>XWindowEvent</primary></indexterm> @@ -226,11 +226,11 @@ Events generated by the server may be enqueued into the library's event queue. <!-- .sp --> To flush the output buffer and then wait until all requests have been processed, use -<function>XSync</function>. +<xref linkend='XSync' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XSync</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xsync'> +<funcsynopsis id='XSync'> <funcprototype> <funcdef><function>XSync</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -256,7 +256,7 @@ Specifies the connection to the X server. <listitem> <para> Specifies a Boolean value that indicates whether -<function>XSync</function> +<xref linkend='XSync' xrefstyle='select: title'/> discards all events on the event queue. </para> </listitem> @@ -266,13 +266,13 @@ discards all events on the event queue. <!-- .LP --> <!-- .eM --> The -<function>XSync</function> +<xref linkend='XSync' xrefstyle='select: title'/> function flushes the output buffer and then waits until all requests have been received and processed by the X server. Any errors generated must be handled by the error handler. For each protocol error received by Xlib, -<function>XSync</function> +<xref linkend='XSync' xrefstyle='select: title'/> calls the client application's error handling routine (see <link linkend="Using_the_Default_Error_Handlers">section 11.8.2</link>). Any events generated by the server are enqueued into the library's @@ -282,17 +282,17 @@ event queue. <!-- .LP --> Finally, if you passed <symbol>False</symbol>, -<function>XSync</function> +<xref linkend='XSync' xrefstyle='select: title'/> does not discard the events in the queue. If you passed <symbol>True</symbol>, -<function>XSync</function> +<xref linkend='XSync' xrefstyle='select: title'/> discards all events in the queue, including those events that were on the queue before -<function>XSync</function> +<xref linkend='XSync' xrefstyle='select: title'/> was called. Client applications seldom need to call -<function>XSync</function>. +<xref linkend='XSync' xrefstyle='select: title'/>. </para> </sect1> <sect1 id="Event_Queue_Management"> @@ -310,11 +310,11 @@ in its network connection that is not yet read into the event queue. <!-- .LP --> <!-- .sp --> To check the number of events in the event queue, use -<function>XEventsQueued</function>. +<xref linkend='XEventsQueued' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XEventsQueued</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xeventsqueued'> +<funcsynopsis id='XEventsQueued'> <funcprototype> <funcdef>int <function>XEventsQueued</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -354,53 +354,53 @@ or <!-- .eM --> If mode is <symbol>QueuedAlready</symbol>, -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> returns the number of events already in the event queue (and never performs a system call). If mode is <symbol>QueuedAfterFlush</symbol>, -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> flushes the output buffer, attempts to read more events out of the application's connection, and returns the number read. If mode is <symbol>QueuedAfterReading</symbol>, -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> attempts to read more events out of the application's connection without flushing the output buffer and returns the number read. </para> <para> <!-- .LP --> -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> always returns immediately without I/O if there are events already in the queue. -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> with mode <symbol>QueuedAfterFlush</symbol> is identical in behavior to -<function>XPending</function>. -<function>XEventsQueued</function> +<xref linkend='XPending' xrefstyle='select: title'/>. +<xref linkend='XEventsQueued' xrefstyle='select: title'/> with mode <symbol>QueuedAlready</symbol> is identical to the -<function>XQLength</function> +<xref linkend='XQLength' xrefstyle='select: title'/> function. </para> <para> <!-- .LP --> <!-- .sp --> To return the number of events that are pending, use -<function>XPending</function>. +<xref linkend='XPending' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XPending</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xpending'> +<funcsynopsis id='XPending'> <funcprototype> <funcdef>int <function>XPending</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -423,12 +423,12 @@ Specifies the connection to the X server. <!-- .LP --> <!-- .eM --> The -<function>XPending</function> +<xref linkend='XPending' xrefstyle='select: title'/> function returns the number of events that have been received from the X server but have not been removed from the event queue. -<function>XPending</function> +<xref linkend='XPending' xrefstyle='select: title'/> is identical to -<function>XEventsQueued</function> +<xref linkend='XEventsQueued' xrefstyle='select: title'/> with the mode <symbol>QueuedAfterFlush</symbol> specified. @@ -470,11 +470,11 @@ predicate procedures that you provide <para> <!-- .LP --> To get the next event and remove it from the queue, use -<function>XNextEvent</function>. +<xref linkend='XNextEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XNextEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xnextevent'> +<funcsynopsis id='XNextEvent'> <funcprototype> <funcdef><function>XNextEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -508,23 +508,23 @@ Returns the next event in the queue. <!-- .LP --> <!-- .eM --> The -<function>XNextEvent</function> +<xref linkend='XNextEvent' xrefstyle='select: title'/> function copies the first event from the event queue into the specified <structname>XEvent</structname> structure and then removes it from the queue. If the event queue is empty, -<function>XNextEvent</function> +<xref linkend='XNextEvent' xrefstyle='select: title'/> flushes the output buffer and blocks until an event is received. </para> <para> <!-- .LP --> <!-- .sp --> To peek at the event queue, use -<function>XPeekEvent</function>. +<xref linkend='XPeekEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XPeekEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xpeekevent'> +<funcsynopsis id='XPeekEvent'> <funcprototype> <funcdef><function>XPeekEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -558,11 +558,11 @@ Returns a copy of the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XPeekEvent</function> +<xref linkend='XPeekEvent' xrefstyle='select: title'/> function returns the first event from the event queue, but it does not remove the event from the queue. If the queue is empty, -<function>XPeekEvent</function> +<xref linkend='XPeekEvent' xrefstyle='select: title'/> flushes the output buffer and blocks until an event is received. It then copies the event into the client-supplied <structname>XEvent</structname> @@ -633,10 +633,10 @@ structure. <listitem> <para> Specifies the argument passed in from the -<function>XIfEvent</function>, -<function>XCheckIfEvent</function>, +<xref linkend='XIfEvent' xrefstyle='select: title'/>, +<xref linkend='XCheckIfEvent' xrefstyle='select: title'/>, or -<function>XPeekIfEvent</function> +<xref linkend='XPeekIfEvent' xrefstyle='select: title'/> function. </para> </listitem> @@ -657,11 +657,11 @@ If it did not find a match, it must return <!-- .sp --> To check the event queue for a matching event and, if found, remove the event from the queue, use -<function>XIfEvent</function>. +<xref linkend='XIfEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XIfEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xifevent'> +<funcsynopsis id='XIfEvent'> <funcprototype> <funcdef><function>XIfEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -718,15 +718,15 @@ Specifies the user-supplied argument that will be passed to the predicate proced <!-- .LP --> <!-- .eM --> The -<function>XIfEvent</function> +<xref linkend='XIfEvent' xrefstyle='select: title'/> function completes only when the specified predicate procedure returns <symbol>True</symbol> for an event, which indicates an event in the queue matches. -<function>XIfEvent</function> +<xref linkend='XIfEvent' xrefstyle='select: title'/> flushes the output buffer if it blocks waiting for additional events. -<function>XIfEvent</function> +<xref linkend='XIfEvent' xrefstyle='select: title'/> removes the matching event from the queue and copies the structure into the client-supplied <structname>XEvent</structname> @@ -736,11 +736,11 @@ structure. <!-- .LP --> <!-- .sp --> To check the event queue for a matching event without blocking, use -<function>XCheckIfEvent</function>. +<xref linkend='XCheckIfEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XCheckIfEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xcheckifevent'> +<funcsynopsis id='XCheckIfEvent'> <funcprototype> <funcdef>Bool <function>XCheckIfEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -797,14 +797,14 @@ Specifies the user-supplied argument that will be passed to the predicate proced <!-- .LP --> <!-- .eM --> When the predicate procedure finds a match, -<function>XCheckIfEvent</function> +<xref linkend='XCheckIfEvent' xrefstyle='select: title'/> copies the matched event into the client-supplied <structname>XEvent</structname> structure and returns <symbol>True</symbol>. (This event is removed from the queue.) If the predicate procedure finds no match, -<function>XCheckIfEvent</function> +<xref linkend='XCheckIfEvent' xrefstyle='select: title'/> returns <symbol>False</symbol>, and the output buffer will have been flushed. @@ -815,11 +815,11 @@ All earlier events stored in the queue are not discarded. <!-- .sp --> To check the event queue for a matching event without removing the event from the queue, use -<function>XPeekIfEvent</function>. +<xref linkend='XPeekIfEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XPeekIfEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xpeekifevent'> +<funcsynopsis id='XPeekIfEvent'> <funcprototype> <funcdef><function>XPeekIfEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -876,17 +876,17 @@ Specifies the user-supplied argument that will be passed to the predicate proced <!-- .LP --> <!-- .eM --> The -<function>XPeekIfEvent</function> +<xref linkend='XPeekIfEvent' xrefstyle='select: title'/> function returns only when the specified predicate procedure returns <symbol>True</symbol> for an event. After the predicate procedure finds a match, -<function>XPeekIfEvent</function> +<xref linkend='XPeekIfEvent' xrefstyle='select: title'/> copies the matched event into the client-supplied <structname>XEvent</structname> structure without removing the event from the queue. -<function>XPeekIfEvent</function> +<xref linkend='XPeekIfEvent' xrefstyle='select: title'/> flushes the output buffer if it blocks waiting for additional events. </para> </sect2> @@ -904,11 +904,11 @@ or event types, allowing you to process events out of order. <!-- .LP --> <!-- .sp --> To remove the next event that matches both a window and an event mask, use -<function>XWindowEvent</function>. +<xref linkend='XWindowEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XWindowEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xwindowevent'> +<funcsynopsis id='XWindowEvent'> <funcprototype> <funcdef><function>XWindowEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -965,17 +965,17 @@ Returns the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XWindowEvent</function> +<xref linkend='XWindowEvent' xrefstyle='select: title'/> function searches the event queue for an event that matches both the specified window and event mask. When it finds a match, -<function>XWindowEvent</function> +<xref linkend='XWindowEvent' xrefstyle='select: title'/> removes that event from the queue and copies it into the specified <structname>XEvent</structname> structure. The other events stored in the queue are not discarded. If a matching event is not in the queue, -<function>XWindowEvent</function> +<xref linkend='XWindowEvent' xrefstyle='select: title'/> flushes the output buffer and blocks until one is received. </para> <para> @@ -983,17 +983,17 @@ flushes the output buffer and blocks until one is received. <!-- .sp --> To remove the next event that matches both a window and an event mask (if any), use -<function>XCheckWindowEvent</function>. +<xref linkend='XCheckWindowEvent' xrefstyle='select: title'/>. <indexterm><primary>XCheckWindowEvent</primary></indexterm> This function is similar to -<function>XWindowEvent</function> +<xref linkend='XWindowEvent' xrefstyle='select: title'/> except that it never blocks and it returns a <type>Bool</type> indicating if the event was returned. </para> <indexterm significance="preferred"><primary>XCheckWindowEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xcheckwindowevent'> +<funcsynopsis id='XCheckWindowEvent'> <funcprototype> <funcdef>Bool <function>XCheckWindowEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1050,19 +1050,19 @@ Returns the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XCheckWindowEvent</function> +<xref linkend='XCheckWindowEvent' xrefstyle='select: title'/> function searches the event queue and then the events available on the server connection for the first event that matches the specified window and event mask. If it finds a match, -<function>XCheckWindowEvent</function> +<xref linkend='XCheckWindowEvent' xrefstyle='select: title'/> removes that event, copies it into the specified <structname>XEvent</structname> structure, and returns <symbol>True</symbol>. The other events stored in the queue are not discarded. If the event you requested is not available, -<function>XCheckWindowEvent</function> +<xref linkend='XCheckWindowEvent' xrefstyle='select: title'/> returns <symbol>False</symbol>, and the output buffer will have been flushed. @@ -1071,11 +1071,11 @@ and the output buffer will have been flushed. <!-- .LP --> <!-- .sp --> To remove the next event that matches an event mask, use -<function>XMaskEvent</function>. +<xref linkend='XMaskEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XMaskEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xmaskevent'> +<funcsynopsis id='XMaskEvent'> <funcprototype> <funcdef><function>XMaskEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1120,33 +1120,33 @@ Returns the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XMaskEvent</function> +<xref linkend='XMaskEvent' xrefstyle='select: title'/> function searches the event queue for the events associated with the specified mask. When it finds a match, -<function>XMaskEvent</function> +<xref linkend='XMaskEvent' xrefstyle='select: title'/> removes that event and copies it into the specified <structname>XEvent</structname> structure. The other events stored in the queue are not discarded. If the event you requested is not in the queue, -<function>XMaskEvent</function> +<xref linkend='XMaskEvent' xrefstyle='select: title'/> flushes the output buffer and blocks until one is received. </para> <para> <!-- .LP --> <!-- .sp --> To return and remove the next event that matches an event mask (if any), use -<function>XCheckMaskEvent</function>. +<xref linkend='XCheckMaskEvent' xrefstyle='select: title'/>. This function is similar to -<function>XMaskEvent</function> +<xref linkend='XMaskEvent' xrefstyle='select: title'/> except that it never blocks and it returns a <type>Bool</type> indicating if the event was returned. </para> <indexterm significance="preferred"><primary>XCheckMaskEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xcheckmaskevent'> +<funcsynopsis id='XCheckMaskEvent'> <funcprototype> <funcdef>Bool <function>XCheckMaskEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1191,18 +1191,18 @@ Returns the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XCheckMaskEvent</function> +<xref linkend='XCheckMaskEvent' xrefstyle='select: title'/> function searches the event queue and then any events available on the server connection for the first event that matches the specified mask. If it finds a match, -<function>XCheckMaskEvent</function> +<xref linkend='XCheckMaskEvent' xrefstyle='select: title'/> removes that event, copies it into the specified <structname>XEvent</structname> structure, and returns <symbol>True</symbol>. The other events stored in the queue are not discarded. If the event you requested is not available, -<function>XCheckMaskEvent</function> +<xref linkend='XCheckMaskEvent' xrefstyle='select: title'/> returns <symbol>False</symbol>, and the output buffer will have been flushed. @@ -1211,11 +1211,11 @@ and the output buffer will have been flushed. <!-- .LP --> <!-- .sp --> To return and remove the next event in the queue that matches an event type, use -<function>XCheckTypedEvent</function>. +<xref linkend='XCheckTypedEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XCheckTypedEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xchecktypedevent'> +<funcsynopsis id='XCheckTypedEvent'> <funcprototype> <funcdef>Bool <function>XCheckTypedEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1261,18 +1261,18 @@ Returns the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XCheckTypedEvent</function> +<xref linkend='XCheckTypedEvent' xrefstyle='select: title'/> function searches the event queue and then any events available on the server connection for the first event that matches the specified type. If it finds a match, -<function>XCheckTypedEvent</function> +<xref linkend='XCheckTypedEvent' xrefstyle='select: title'/> removes that event, copies it into the specified <structname>XEvent</structname> structure, and returns <symbol>True</symbol>. The other events in the queue are not discarded. If the event is not available, -<function>XCheckTypedEvent</function> +<xref linkend='XCheckTypedEvent' xrefstyle='select: title'/> returns <symbol>False</symbol>, and the output buffer will have been flushed. @@ -1282,11 +1282,11 @@ and the output buffer will have been flushed. <!-- .sp --> To return and remove the next event in the queue that matches an event type and a window, use -<function>XCheckTypedWindowEvent</function>. +<xref linkend='XCheckTypedWindowEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XCheckTypedWindowEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xchecktypedwindowevent'> +<funcsynopsis id='XCheckTypedWindowEvent'> <funcprototype> <funcdef>Bool <function>XCheckTypedWindowEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1343,19 +1343,19 @@ Returns the matched event's associated structure. <!-- .LP --> <!-- .eM --> The -<function>XCheckTypedWindowEvent</function> +<xref linkend='XCheckTypedWindowEvent' xrefstyle='select: title'/> function searches the event queue and then any events available on the server connection for the first event that matches the specified type and window. If it finds a match, -<function>XCheckTypedWindowEvent</function> +<xref linkend='XCheckTypedWindowEvent' xrefstyle='select: title'/> removes the event from the queue, copies it into the specified <structname>XEvent</structname> structure, and returns <symbol>True</symbol>. The other events in the queue are not discarded. If the event is not available, -<function>XCheckTypedWindowEvent</function> +<xref linkend='XCheckTypedWindowEvent' xrefstyle='select: title'/> returns <symbol>False</symbol>, and the output buffer will have been flushed. @@ -1370,11 +1370,11 @@ and the output buffer will have been flushed. <para> <!-- .LP --> To push an event back into the event queue, use -<function>XPutBackEvent</function>. +<xref linkend='XPutBackEvent' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XPutBackEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xputbackevent'> +<funcsynopsis id='XPutBackEvent'> <funcprototype> <funcdef><function>XPutBackEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1408,13 +1408,13 @@ Specifies the event. <!-- .LP --> <!-- .eM --> The -<function>XPutBackEvent</function> +<xref linkend='XPutBackEvent' xrefstyle='select: title'/> function pushes an event back onto the head of the display's event queue by copying the event into the queue. This can be useful if you read an event and then decide that you would rather deal with it later. There is no limit to the number of times in succession that you can call -<function>XPutBackEvent</function>. +<xref linkend='XPutBackEvent' xrefstyle='select: title'/>. </para> </sect1> <sect1 id="Sending_Events_to_Other_Applications"> @@ -1425,11 +1425,11 @@ There is no limit to the number of times in succession that you can call <para> <!-- .LP --> To send an event to a specified window, use -<function>XSendEvent</function>. +<xref linkend='XSendEvent' xrefstyle='select: title'/>. <indexterm><primary>XSendEvent</primary></indexterm> This function is often used in selection processing. For example, the owner of a selection should use -<function>XSendEvent</function> +<xref linkend='XSendEvent' xrefstyle='select: title'/> to send a <symbol>SelectionNotify</symbol> event to a requestor when a selection has been converted @@ -1437,7 +1437,7 @@ and stored as a property. </para> <indexterm significance="preferred"><primary>XSendEvent</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xsendevent'> +<funcsynopsis id='XSendEvent'> <funcprototype> <funcdef>Status <function>XSendEvent</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1507,7 +1507,7 @@ Specifies the event that is to be sent. <!-- .LP --> <!-- .eM --> The -<function>XSendEvent</function> +<xref linkend='XSendEvent' xrefstyle='select: title'/> function identifies the destination window, determines which clients should receive the specified events, and ignores any active grabs. @@ -1537,7 +1537,7 @@ otherwise, the destination window is the focus window. <para> <!-- .LP --> To determine which clients should receive the specified events, -<function>XSendEvent</function> +<xref linkend='XSendEvent' xrefstyle='select: title'/> uses the propagate argument as follows: </para> <itemizedlist> @@ -1591,17 +1591,17 @@ otherwise unaltered and unchecked by the X server except to force send_event to in the forwarded event and to set the serial number in the event correctly; therefore these fields and the display field are ignored by -<function>XSendEvent</function>. +<xref linkend='XSendEvent' xrefstyle='select: title'/>. </para> <para> <!-- .LP --> -<function>XSendEvent</function> +<xref linkend='XSendEvent' xrefstyle='select: title'/> returns zero if the conversion to wire protocol format failed and returns nonzero otherwise. </para> <para> <!-- .LP --> -<function>XSendEvent</function> +<xref linkend='XSendEvent' xrefstyle='select: title'/> can generate <errorname>BadValue</errorname> and @@ -1635,7 +1635,7 @@ use </para> <indexterm significance="preferred"><primary>XDisplayMotionBufferSize</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xdisplaymotionbuffersize'> +<funcsynopsis id='XGetMotionEvents'> <funcprototype> <funcdef>unsigned <type>long</type></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1662,14 +1662,14 @@ and do so to a finer granularity than is reported by <symbol>MotionNotify</symbol> events. The -<function>XGetMotionEvents</function> +<xref linkend='XGetMotionEvents' xrefstyle='select: title'/> function makes this history available. </para> <para> <!-- .LP --> <!-- .sp --> To get the motion history for a specified window and time, use -<function>XGetMotionEvents</function>. +<xref linkend='XGetMotionEvents' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XGetMotionEvents</primary></indexterm> <!-- .sM --> @@ -1743,7 +1743,7 @@ Returns the number of events from the motion history buffer. <!-- .LP --> <!-- .eM --> The -<function>XGetMotionEvents</function> +<xref linkend='XGetMotionEvents' xrefstyle='select: title'/> function 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 the specified window (including its borders) at its present @@ -1752,7 +1752,7 @@ If the server does not support motion history, if the start time is later than the stop time, or if the start time is in the future, no events are returned; -<function>XGetMotionEvents</function> +<xref linkend='XGetMotionEvents' xrefstyle='select: title'/> returns NULL. If the stop time is in the future, it is equivalent to specifying <symbol>CurrentTime</symbol>. @@ -1779,11 +1779,11 @@ The x and y members are set to the coordinates of the pointer and are reported relative to the origin of the specified window. To free the data returned from this call, use -<function>XFree</function>. +<xref linkend='XFree' xrefstyle='select: title'/>. </para> <para> <!-- .LP --> -<function>XGetMotionEvents</function> +<xref linkend='XGetMotionEvents' xrefstyle='select: title'/> can generate a <errorname>BadWindow</errorname> error. @@ -1824,12 +1824,12 @@ synchronous library behavior. After completing their work, all Xlib functions that generate protocol requests call what is known as an after function. -<function>XSetAfterFunction</function> +<xref linkend='XSetAfterFunction' xrefstyle='select: title'/> sets which function is to be called. </para> <indexterm significance="preferred"><primary>XSetAfterFunction</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xsetafterfunction'> +<funcsynopsis id='XSetAfterFunction'> <funcprototype> <funcdef><type>int</type></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -1863,7 +1863,7 @@ Specifies the procedure to be called. <!-- .LP --> <!-- .eM --> The specified procedure is called with only a display pointer. -<function>XSetAfterFunction</function> +<xref linkend='XSetAfterFunction' xrefstyle='select: title'/> returns the previous after function. </para> <para> @@ -1946,11 +1946,11 @@ message and exit. <!-- .LP --> <!-- .sp --> To set the error handler, use -<function>XSetErrorHandler</function>. +<xref linkend='XSetErrorHandler' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XSetErrorHandler</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xseterrorhandler'> +<funcsynopsis id='XSetErrorHandler'> <funcprototype> <funcdef>int *<function>XSetErrorHandler</function></funcdef> <paramdef>int <parameter> *handler</parameter></paramdef> @@ -2213,12 +2213,12 @@ fixed alternatives. <para> <!-- .LP --> To obtain textual descriptions of the specified error code, use -<function>XGetErrorText</function>. +<xref linkend='XGetErrorText' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XGetErrorText</primary></indexterm> <indexterm><primary>Debugging</primary><secondary>error message strings</secondary></indexterm> <!-- .sM --> -<funcsynopsis id='xgeterrortext'> +<funcsynopsis id='XGetErrorText'> <funcprototype> <funcdef><function>XGetErrorText</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -2274,7 +2274,7 @@ Specifies the size of the buffer. <!-- .LP --> <!-- .eM --> The -<function>XGetErrorText</function> +<xref linkend='XGetErrorText' xrefstyle='select: title'/> function copies a null-terminated string describing the specified error code into the specified buffer. The returned text is in the encoding of the current locale. @@ -2286,11 +2286,11 @@ and error strings. <!-- .LP --> <!-- .sp --> To obtain error messages from the error database, use -<function>XGetErrorDatabaseText</function>. +<xref linkend='XGetErrorDatabaseText' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XGetErrorDatabaseText</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xgeterrordatabasetext'> +<funcsynopsis id='XGetErrorDatabaseText'> <funcprototype> <funcdef><function>XGetErrorDatabaseText</function></funcdef> <paramdef>Display<parameter> *display</parameter></paramdef> @@ -2367,7 +2367,7 @@ Specifies the size of the buffer. <!-- .LP --> <!-- .eM --> The -<function>XGetErrorDatabaseText</function> +<xref linkend='XGetErrorDatabaseText' xrefstyle='select: title'/> function returns a null-terminated message (or the default message) from the error message database. @@ -2431,11 +2431,11 @@ the default_string is returned to the buffer argument. <!-- .LP --> <!-- .sp --> To report an error to the user when the requested display does not exist, use -<function>XDisplayName</function>. +<xref linkend='XDisplayName' xrefstyle='select: title'/>. </para> <indexterm significance="preferred"><primary>XDisplayName</primary></indexterm> <!-- .sM --> -<funcsynopsis id='xdisplayname'> +<funcsynopsis id='XDisplayName'> <funcprototype> <funcdef>char *<function>XDisplayName</function></funcdef> <paramdef>char<parameter> *string</parameter></paramdef> @@ -2458,14 +2458,14 @@ Specifies the character string. <!-- .LP --> <!-- .eM --> The -<function>XDisplayName</function> +<xref linkend='XDisplayName' xrefstyle='select: title'/> function returns the name of the display that -<function>XOpenDisplay</function> +<xref linkend='XOpenDisplay' xrefstyle='select: title'/> would attempt to use. If a NULL string is specified, -<function>XDisplayName</function> +<xref linkend='XDisplayName' xrefstyle='select: title'/> looks in the environment for the display and returns the display name that -<function>XOpenDisplay</function> +<xref linkend='XOpenDisplay' xrefstyle='select: title'/> would attempt to use. This makes it easier to report to the user precisely which display the program attempted to open when the initial connection attempt failed. |