diff options
Diffstat (limited to 'libX11/specs/libX11/CH11.xml')
| -rw-r--r-- | libX11/specs/libX11/CH11.xml | 132 |
1 files changed, 55 insertions, 77 deletions
diff --git a/libX11/specs/libX11/CH11.xml b/libX11/specs/libX11/CH11.xml index 3352d7e71..f203f6f10 100644 --- a/libX11/specs/libX11/CH11.xml +++ b/libX11/specs/libX11/CH11.xml @@ -43,6 +43,7 @@ and <function>XChangeWindowAttributes</function>. Another way is to use <function>XSelectInput</function>. +</para> <indexterm significance="preferred"><primary>XSelectInput</primary></indexterm> <!-- .sM --> <funcsynopsis id='xselectinput'> @@ -87,7 +88,6 @@ Specifies the event mask. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -181,6 +181,7 @@ These functions differ in the additional tasks they might perform. <!-- .sp --> To flush the output buffer, use <function>XFlush</function>. +</para> <indexterm significance="preferred"><primary>XFlush</primary></indexterm> <!-- .sM --> <funcsynopsis id='xflush'> @@ -202,7 +203,6 @@ Specifies the connection to the X server. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -227,6 +227,7 @@ Events generated by the server may be enqueued into the library's event queue. To flush the output buffer and then wait until all requests have been processed, use <function>XSync</function>. +</para> <indexterm significance="preferred"><primary>XSync</primary></indexterm> <!-- .sM --> <funcsynopsis id='xsync'> @@ -261,7 +262,6 @@ discards all events on the event queue. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -311,6 +311,7 @@ in its network connection that is not yet read into the event queue. <!-- .sp --> To check the number of events in the event queue, use <function>XEventsQueued</function>. +</para> <indexterm significance="preferred"><primary>XEventsQueued</primary></indexterm> <!-- .sM --> <funcsynopsis id='xeventsqueued'> @@ -348,7 +349,6 @@ or </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -397,6 +397,7 @@ function. <!-- .sp --> To return the number of events that are pending, use <function>XPending</function>. +</para> <indexterm significance="preferred"><primary>XPending</primary></indexterm> <!-- .sM --> <funcsynopsis id='xpending'> @@ -418,7 +419,6 @@ Specifies the connection to the X server. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -471,6 +471,7 @@ predicate procedures that you provide <!-- .LP --> To get the next event and remove it from the queue, use <function>XNextEvent</function>. +</para> <indexterm significance="preferred"><primary>XNextEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xnextevent'> @@ -503,7 +504,6 @@ Returns the next event in the queue. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -521,6 +521,7 @@ flushes the output buffer and blocks until an event is received. <!-- .sp --> To peek at the event queue, use <function>XPeekEvent</function>. +</para> <indexterm significance="preferred"><primary>XPeekEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xpeekevent'> @@ -553,7 +554,6 @@ Returns a copy of the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -592,6 +592,7 @@ has first called <para> <!-- .LP --> The predicate procedure and its associated arguments are: +</para> <!-- .sM --> <funcsynopsis> <funcprototype> @@ -641,7 +642,6 @@ function. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -658,6 +658,7 @@ If it did not find a match, it must return To check the event queue for a matching event and, if found, remove the event from the queue, use <function>XIfEvent</function>. +</para> <indexterm significance="preferred"><primary>XIfEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xifevent'> @@ -713,7 +714,6 @@ Specifies the user-supplied argument that will be passed to the predicate proced </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -737,6 +737,7 @@ structure. <!-- .sp --> To check the event queue for a matching event without blocking, use <function>XCheckIfEvent</function>. +</para> <indexterm significance="preferred"><primary>XCheckIfEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xcheckifevent'> @@ -792,7 +793,6 @@ Specifies the user-supplied argument that will be passed to the predicate proced </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -816,6 +816,7 @@ All earlier events stored in the queue are not discarded. To check the event queue for a matching event without removing the event from the queue, use <function>XPeekIfEvent</function>. +</para> <indexterm significance="preferred"><primary>XPeekIfEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xpeekifevent'> @@ -871,7 +872,6 @@ Specifies the user-supplied argument that will be passed to the predicate proced </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -905,6 +905,7 @@ or event types, allowing you to process events out of order. <!-- .sp --> To remove the next event that matches both a window and an event mask, use <function>XWindowEvent</function>. +</para> <indexterm significance="preferred"><primary>XWindowEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xwindowevent'> @@ -960,7 +961,6 @@ Returns the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -990,6 +990,7 @@ This function is similar to 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'> @@ -1045,7 +1046,6 @@ Returns the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1072,6 +1072,7 @@ and the output buffer will have been flushed. <!-- .sp --> To remove the next event that matches an event mask, use <function>XMaskEvent</function>. +</para> <indexterm significance="preferred"><primary>XMaskEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xmaskevent'> @@ -1115,7 +1116,6 @@ Returns the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1143,6 +1143,7 @@ This function is similar to 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'> @@ -1186,7 +1187,6 @@ Returns the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1212,6 +1212,7 @@ and the output buffer will have been flushed. <!-- .sp --> To return and remove the next event in the queue that matches an event type, use <function>XCheckTypedEvent</function>. +</para> <indexterm significance="preferred"><primary>XCheckTypedEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xchecktypedevent'> @@ -1256,7 +1257,6 @@ Returns the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1283,6 +1283,7 @@ and the output buffer will have been flushed. To return and remove the next event in the queue that matches an event type and a window, use <function>XCheckTypedWindowEvent</function>. +</para> <indexterm significance="preferred"><primary>XCheckTypedWindowEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xchecktypedwindowevent'> @@ -1338,7 +1339,6 @@ Returns the matched event's associated structure. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1371,6 +1371,7 @@ and the output buffer will have been flushed. <!-- .LP --> To push an event back into the event queue, use <function>XPutBackEvent</function>. +</para> <indexterm significance="preferred"><primary>XPutBackEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xputbackevent'> @@ -1403,7 +1404,6 @@ Specifies the event. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1434,6 +1434,7 @@ to send a <symbol>SelectionNotify</symbol> event to a requestor when a selection has been converted and stored as a property. +</para> <indexterm significance="preferred"><primary>XSendEvent</primary></indexterm> <!-- .sM --> <funcsynopsis id='xsendevent'> @@ -1502,7 +1503,6 @@ Specifies the event that is to be sent. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1632,6 +1632,7 @@ However, this historical information is highly excessive for most applications. To determine the approximate maximum number of elements in the motion buffer, use <function>XDisplayMotionBufferSize</function>. +</para> <indexterm significance="preferred"><primary>XDisplayMotionBufferSize</primary></indexterm> <!-- .sM --> <funcsynopsis id='xdisplaymotionbuffersize'> @@ -1653,7 +1654,6 @@ Specifies the connection to the X server. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1670,6 +1670,7 @@ function makes this history available. <!-- .sp --> To get the motion history for a specified window and time, use <function>XGetMotionEvents</function>. +</para> <indexterm significance="preferred"><primary>XGetMotionEvents</primary></indexterm> <!-- .sM --> <funcsynopsis id='xgetmotionevents'> @@ -1738,7 +1739,6 @@ Returns the number of events from the motion history buffer. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1826,6 +1826,7 @@ all Xlib functions that generate protocol requests call what is known as an after function. <function>XSetAfterFunction</function> sets which function is to be called. +</para> <indexterm significance="preferred"><primary>XSetAfterFunction</primary></indexterm> <!-- .sM --> <funcsynopsis id='xsetafterfunction'> @@ -1858,7 +1859,6 @@ Specifies the procedure to be called. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1870,6 +1870,7 @@ returns the previous after function. <!-- .LP --> To enable or disable synchronization, use <function>XSynchronize</function>. +</para> <indexterm><primary>Debugging</primary><secondary>synchronous mode</secondary></indexterm> <indexterm significance="preferred"><primary>XSynchronize</primary></indexterm> <!-- .sM --> @@ -1904,7 +1905,6 @@ or disable synchronization. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -1947,6 +1947,7 @@ message and exit. <!-- .sp --> To set the error handler, use <function>XSetErrorHandler</function>. +</para> <indexterm significance="preferred"><primary>XSetErrorHandler</primary></indexterm> <!-- .sM --> <funcsynopsis id='xseterrorhandler'> @@ -1968,7 +1969,6 @@ Specifies the program's supplied error handler. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -2049,40 +2049,30 @@ chapter: <indexterm significance="preferred"><primary>BadFont</primary></indexterm> <indexterm significance="preferred"><primary>BadGC</primary></indexterm> <indexterm significance="preferred"><primary>BadIDChoice</primary></indexterm> -<informaltable> - <tgroup cols='2' align='center'> +<informaltable frame='none'> + <tgroup cols='2'> <colspec colname='c1'/> <colspec colname='c2'/> <thead> <row> - <entry>Error Code</entry> - <entry>Description</entry> + <entry align='left'>Error Code</entry> + <entry align='left'>Description</entry> </row> </thead> <tbody> <row> <entry><errorname id='BadAccess'>BadAccess</errorname></entry> - <entry>A client attempts to grab a key/button combination already grabbed - by another client.</entry> - </row> - <row> - <entry></entry> - <entry>A client attempts to free a colormap entry that it had not already allocated - or to free an entry in a colormap that was created with all entries writable.</entry> - </row> - <row> - <entry></entry> - <entry>A client attempts to store into a read-only or unallocated colormap entry.</entry> - </row> - <row> - <entry></entry> - <entry>A client attempts to modify the access control list from other than the local - (or otherwise authorized) host.</entry> - </row> - <row> - <entry></entry> - <entry>A client attempts to select an event type that another client - has already selected.</entry> + <entry> + <para>A client attempts to grab a key/button combination already grabbed + by another client.</para> + <para>A client attempts to free a colormap entry that it had not already allocated + or to free an entry in a colormap that was created with all entries writable.</para> + <para>A client attempts to store into a read-only or unallocated colormap entry.</para> + <para>A client attempts to modify the access control list from other than the local + (or otherwise authorized) host.</para> + <para>A client attempts to select an event type that another client + has already selected.</para> + </entry> </row> <row> <entry><errorname id='BadAlloc'>BadAlloc</errorname></entry> @@ -2144,34 +2134,22 @@ chapter: </row> <row> <entry><errorname id='BadLength'>BadLength</errorname></entry> - <entry>The length of a request is shorter or longer than that required to + <entry><para>The length of a request is shorter or longer than that required to contain the arguments. - This is an internal Xlib or server error.</entry> - </row> - <row> - <entry></entry> - <entry> - The length of a request exceeds the maximum length accepted by the server.</entry> + This is an internal Xlib or server error.</para> + <para>The length of a request exceeds the maximum length accepted by the server.</para> + </entry> </row> <row> <entry><errorname id='BadMatch'>BadMatch</errorname></entry> - <entry>In a graphics request, - the root and depth of the graphics context do not match those of the drawable.</entry> - </row> - <row> - <entry></entry> - <entry>An <symbol>InputOnly</symbol> window is used as a drawable.</entry> - </row> - <row> - <entry></entry> - <entry> - 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></entry> - <entry>An <symbol>InputOnly</symbol> - window lacks this attribute.</entry> + <entry><para>In a graphics request, + the root and depth of the graphics context do not match those of the drawable.</para> + <para>An <symbol>InputOnly</symbol> window is used as a drawable.</para> + <para>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.</para> + <para>An <symbol>InputOnly</symbol> + window lacks this attribute.</para> + </entry> </row> <row> <entry><errorname id='BadName'>BadName</errorname></entry> @@ -2236,6 +2214,7 @@ fixed alternatives. <!-- .LP --> To obtain textual descriptions of the specified error code, use <function>XGetErrorText</function>. +</para> <indexterm significance="preferred"><primary>XGetErrorText</primary></indexterm> <indexterm><primary>Debugging</primary><secondary>error message strings</secondary></indexterm> <!-- .sM --> @@ -2291,7 +2270,6 @@ Specifies the size of the buffer. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -2309,6 +2287,7 @@ and error strings. <!-- .sp --> To obtain error messages from the error database, use <function>XGetErrorDatabaseText</function>. +</para> <indexterm significance="preferred"><primary>XGetErrorDatabaseText</primary></indexterm> <!-- .sM --> <funcsynopsis id='xgeterrordatabasetext'> @@ -2384,7 +2363,6 @@ Specifies the size of the buffer. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -2454,6 +2432,7 @@ the default_string is returned to the buffer argument. <!-- .sp --> To report an error to the user when the requested display does not exist, use <function>XDisplayName</function>. +</para> <indexterm significance="preferred"><primary>XDisplayName</primary></indexterm> <!-- .sM --> <funcsynopsis id='xdisplayname'> @@ -2475,7 +2454,6 @@ Specifies the character string. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> @@ -2497,6 +2475,7 @@ program attempted to open when the initial connection attempt failed. <!-- .sp --> To handle fatal I/O errors, use <function>XSetIOErrorHandler</function>. +</para> <indexterm significance="preferred"><primary>XSetIOErrorHandler</primary></indexterm> <!-- .sM --> <funcsynopsis id='xsetioerrorhandler'> @@ -2518,7 +2497,6 @@ Specifies the program's supplied error handler. </listitem> </varlistentry> </variablelist> -</para> <para> <!-- .LP --> <!-- .eM --> |