fdo-mirrors/xorg-libx11
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/lib/libx11.git synced 2026-05-07 21:28:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

specs/libX11: Convert troff .IN macros to docbook <indexterm> tags

Browse source 
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2010-07-08 17:30:34 -07:00
parent a67d99ccbe
commit 0cd29bdb33
20 changed files with 1398 additions and 1397 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
specs/libX11/AppC.xml
View file

@ -43,7 +43,7 @@ The basic protocol requests for extensions are
and
<function>XListExtensions .</function>
</para>
<!-- .IN "XQueryExtension" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryExtension</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -128,7 +128,7 @@ the result is implementation-dependent.
Uppercase and lowercase matter;
the strings ``thing'', ``Thing'', and ``thinG''
are all considered different names.
<!-- .IN "XListExtensions" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListExtensions</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -170,7 +170,7 @@ function returns a list of all extensions supported by the server.
If the data returned by the server is in the Latin Portable Character Encoding,
then the returned strings are in the Host Portable Character Encoding.
Otherwise, the result is implementation-dependent.
<!-- .IN "XFreeExtensionList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeExtensionList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -237,7 +237,7 @@ and is defined in
</para>
<para>
<!-- .LP -->
<!-- .IN "XExtCodes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XExtCodes</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -253,7 +253,7 @@ typedef struct _XExtCodes { /* public to extension, cannot be changed */
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XInitExtension" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XInitExtension</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -319,7 +319,7 @@ This extension number is unique only to a single connection.
</para>
<para>
<!-- .LP -->
<!-- .IN "XAddExtension" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAddExtension</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -367,7 +367,7 @@ format, and the handling of errors.
<!-- .LP -->
All of these functions return the previous procedure defined for this
extension.
<!-- .IN "XESetCloseDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetCloseDisplay</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -435,7 +435,7 @@ with these arguments:
XExtCodes *<emphasis remap='I'>codes</emphasis>;
</literallayout>
<para>
<!-- .IN "XESetCreateGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetCreateGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -503,7 +503,7 @@ your procedure is called with these arguments:
XExtCodes *<emphasis remap='I'>codes</emphasis>;
</literallayout>
</para>
<!-- .IN "XESetCopyGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetCopyGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -636,7 +636,7 @@ your procedure is called with these arguments:
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XESetCreateFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetCreateFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -717,7 +717,7 @@ your procedure is called with these arguments:
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XESetFreeFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetFreeFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -829,7 +829,7 @@ union of structures.
There also is no way to guarantee that more than 24 elements or 96 characters
in the structure will be fully portable between machines.
<!-- .NE -->
<!-- .IN "XESetWireToEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetWireToEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -941,7 +941,7 @@ with the event and use the return value.
</para>
<para>
<!-- .LP -->
<!-- .IN "_XSetLastRequestRead" "" "@DEF@" -->
<indexterm significance="preferred"><primary>_XSetLastRequestRead</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -985,7 +985,7 @@ serial number in the event.
</para>
<para>
<!-- .LP -->
<!-- .IN "XESetEventToWire" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetEventToWire</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1079,7 +1079,7 @@ structure.
All other members then should be copied from the host format to the
<function>xEvent </function>
structure.
<!-- .IN "XESetWireToError" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetWireToError</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1176,7 +1176,7 @@ then the function should return
<function>False ;</function>
otherwise, it should return
<function>True .</function>
<!-- .IN "XESetError" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetError</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1268,7 +1268,7 @@ If your procedure returns nonzero,
the error is suppressed, and
<function>_XReply </function>
returns the value of ret_code.
<!-- .IN "XESetErrorString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetErrorString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1344,7 +1344,7 @@ The following is an example.
Your procedure is called with the error code for every error detected.
You should copy nbytes of a null-terminated string containing the
error message into buffer.
<!-- .IN "XESetPrintErrorValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetPrintErrorValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1428,7 +1428,7 @@ to obtain additional values set by using
<function>XESetWireToError .</function>
The underlying type of the fp argument is system dependent;
on a POSIX-compliant system, fp should be cast to type FILE*.
<!-- .IN "XESetFlushGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetFlushGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1480,7 +1480,7 @@ The procedure set by the
function has the same interface as the procedure set by the
<function>XESetCopyGC</function>
function, but is called when a GC cache needs to be updated in the server.
<!-- .IN "XESetBeforeFlush" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XESetBeforeFlush</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1581,7 +1581,7 @@ and is defined in
</para>
<para>
<!-- .LP -->
<!-- .IN "XExtData" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XExtData</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -1620,7 +1620,7 @@ union { Display *display;
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XEHeadOfExtensionList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XEHeadOfExtensionList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1658,7 +1658,7 @@ of types contained in
</para>
<para>
<!-- .LP -->
<!-- .IN "XAddToExtensionList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAddToExtensionList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1698,7 +1698,7 @@ The structure argument is a pointer to one of the data structures
enumerated above.
You must initialize ext_data-&gt;number with the extension number
before calling this function.
<!-- .IN "XFindOnExtensionList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFindOnExtensionList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1749,7 +1749,7 @@ The
<function>XAllocID </function>
macro, which allocates and returns a resource ID, is defined in
&lt;X11/Xlib.h&gt;.
<!-- .IN "XAllocID" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAllocID</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1784,7 +1784,7 @@ It returns a resource ID that you can use when creating new resources.
The
<function>XAllocIDs</function>
macro allocates and returns an array of resource ID.
<!-- .IN "XAllocIDs" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAllocIDs</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1861,7 +1861,7 @@ if any elements have changed.
The
<function>FlushGC</function>
macro is defined as follows:
<!-- .IN "FlushGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>FlushGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1911,7 +1911,7 @@ The
<function>_XFlushGCCache </function>
procedure
is defined as follows:
<!-- .IN "_XFlushGCCache" "" "@DEF@" -->
<indexterm significance="preferred"><primary>_XFlushGCCache</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2149,7 +2149,7 @@ which looks like:
</para>
<para>
<!-- .LP -->
<!-- .IN "xDoSomethingReq" "" "@DEF@" -->
<indexterm significance="preferred"><primary>xDoSomethingReq</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2187,7 +2187,7 @@ or
</para>
<para>
<!-- .LP -->
<!-- .IN "xResourceReq" "" "@DEF@" -->
<indexterm significance="preferred"><primary>xResourceReq</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2237,7 +2237,7 @@ also contains a reply structure typedef:
</para>
<para>
<!-- .LP -->
<!-- .IN "xDoSomethingReply" "" "@DEF@" -->
<indexterm significance="preferred"><primary>xDoSomethingReply</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2339,7 +2339,7 @@ call until all arguments to the call have been stored into the buffer.
The precise instructions needed for this locking depend upon the machine
architecture.
Two calls, which are generally implemented as macros, have been provided.
<!-- .IN "LockDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>LockDisplay</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2351,7 +2351,7 @@ Two calls, which are generally implemented as macros, have been provided.
</para>
<para>
<!-- .LP -->
<!-- .IN "UnlockDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>UnlockDisplay</primary></indexterm>
<funcsynopsis>
<funcprototype>
<funcdef><function> UnlockDisplay</function></funcdef>
@ -2590,7 +2590,7 @@ packet to arrive.
If any events arrive in the meantime,
<function>_XReply </function>
places them in the queue for later use.
<!-- .IN "_XReply" "" "@DEF@" -->
<indexterm significance="preferred"><primary>_XReply</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3075,7 +3075,7 @@ the general memory allocators may be too expensive to use
(particularly in output functions, which are performance critical).
The following function returns a scratch buffer for use within a
critical section:
<!-- .IN "_XAllocScratch" "" "@DEF@" -->
<indexterm significance="preferred"><primary>_XAllocScratch</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3132,7 +3132,7 @@ families of functions.
<!-- .sp -->
The following function returns a scratch buffer for use across
critical sections:
<!-- .IN "_XAllocTemp" "" "@DEF@" -->
<indexterm significance="preferred"><primary>_XAllocTemp</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3171,7 +3171,7 @@ Specifies the number of bytes required.
This storage can be used across calls that might permit another thread to
execute inside Xlib. The storage must be explicitly returned to Xlib.
The following function returns the storage:
<!-- .IN "_XFreeTemp" "" "@DEF@" -->
<indexterm significance="preferred"><primary>_XFreeTemp</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

78
specs/libX11/AppD.xml
View file

@ -53,7 +53,7 @@ This function has been superseded by
and sets all or portions of the
WM_NAME, WM_ICON_NAME, WM_HINTS, WM_COMMAND,
and WM_NORMAL_HINTS properties.
<!-- .IN "XSetStandardProperties" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetStandardProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -201,7 +201,7 @@ To set the size hints for a given window in its normal state, use
<function>XSetNormalHints .</function>
This function has been superseded by
<function>XSetWMNormalHints .</function>
<!-- .IN "XSetNormalHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -290,7 +290,7 @@ To return the size hints for a window in its normal state, use
<function>XGetNormalHints .</function>
This function has been superseded by
<function>XGetWMNormalHints .</function>
<!-- .IN "XGetNormalHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -361,7 +361,7 @@ To set the zoom hints for a window, use
<function>XSetZoomHints .</function>
This function is no longer supported by the
<emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>.
<!-- .IN "XSetZoomHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetZoomHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -431,7 +431,7 @@ To read the zoom hints for a window, use
<function>XGetZoomHints .</function>
This function is no longer supported by the
<emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>.
<!-- .IN "XGetZoomHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetZoomHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -498,7 +498,7 @@ To set the value of any property of type WM_SIZE_HINTS, use
<function>XSetSizeHints .</function>
This function has been superseded by
<function>XSetWMSizeHints .</function>
<!-- .IN "XSetSizeHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -585,7 +585,7 @@ To read the value of any property of type WM_SIZE_HINTS, use
<function>XGetSizeHints .</function>
This function has been superseded by
<function>XGetWMSizeHints .</function>
<!-- .IN "XGetSizeHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -678,7 +678,7 @@ structure associated with one of the described atoms, use
<function>XGetStandardColormap .</function>
This function has been superseded by
<function>XGetRGBColormap .</function>
<!-- .IN "XGetStandardColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetStandardColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -780,7 +780,7 @@ To set a standard colormap, use
<function>XSetStandardColormap .</function>
This function has been superseded by
<function>XSetRGBColormap .</function>
<!-- .IN "XSetStandardColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetStandardColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -862,8 +862,8 @@ and a default position, use
<function>XGeometry .</function>
This function has been superseded by
<function>XWMGeometry .</function>
<!-- .IN "Window" "determining location" -->
<!-- .IN "XGeometry" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>determining location</secondary></indexterm>
<indexterm significance="preferred"><primary>XGeometry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1067,7 +1067,7 @@ It is only useful in very simple applications.
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XGetDefault" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetDefault</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1148,7 +1148,7 @@ a resource file in the user's home directory is used.
On a POSIX-conformant system,
this file is
<function>"$HOME/.Xdefaults" .</function>
<!-- .IN "Files" "$HOME/.Xdefaults" -->
<indexterm><primary>Files</primary><secondary>$HOME/.Xdefaults</secondary></indexterm>
After loading these defaults,
<function>XGetDefault</function>
merges additional defaults specified by the XENVIRONMENT
@ -1191,10 +1191,10 @@ and have no server support.
That is, they call other Xlib functions, not the server directly.
Thus, if you just have straight lines to draw, using
<function>XDrawLines </function>
<!-- .IN "XDrawLines" -->
<indexterm><primary>XDrawLines</primary></indexterm>
or
<function>XDrawSegments </function>
<!-- .IN "XDrawSegments" -->
<indexterm><primary>XDrawSegments</primary></indexterm>
is much faster.
</para>
<para>
@ -1202,16 +1202,16 @@ is much faster.
The functions discussed here provide all the functionality of the
X Version 10 functions
<function>XDraw , </function>
<!-- .IN "X10 compatibility" "XDraw" -->
<indexterm ><primary>X10 compatibility</primary><secondary>XDraw</secondary></indexterm>
<function>XDrawFilled , </function>
<!-- .IN "X10 compatibility" "XDrawFilled" -->
<indexterm><primary>X10 compatibility</primary><secondary>XDrawFilled</secondary></indexterm>
<function>XDrawPatterned , </function>
<!-- .IN "X10 compatibility" "XDrawPatterned" -->
<indexterm ><primary>X10 compatibility</primary><secondary>XDrawPatterned</secondary></indexterm>
<function>XDrawDashed , </function>
<!-- .IN "X10 compatibility" "XDrawDashed" -->
<indexterm><primary>X10 compatibility</primary><secondary>XDrawDashed</secondary></indexterm>
and
<function>XDrawTiled . </function>
<!-- .IN "X10 compatibility" "XDrawTiled" -->
<indexterm><primary>X10 compatibility</primary><secondary>XDrawTiled</secondary></indexterm>
They are as compatible as possible given X Version 11's new line-drawing
functions.
One thing to note, however, is that
@ -1249,12 +1249,12 @@ set.
<!-- .sp -->
To achieve the effects of the X Version 10
<function>XDraw , </function>
<!-- .IN "X10 compatibility" "XDraw" -->
<indexterm ><primary>X10 compatibility</primary><secondary>XDraw</secondary></indexterm>
<function>XDrawDashed , </function>
<!-- .IN "X10 compatibility" "XDrawDashed" -->
<indexterm><primary>X10 compatibility</primary><secondary>XDrawDashed</secondary></indexterm>
and
<function>XDrawPatterned , </function>
<!-- .IN "X10 compatibility" "XDrawPatterned" -->
<indexterm ><primary>X10 compatibility</primary><secondary>XDrawPatterned</secondary></indexterm>
use
<function>XDraw . </function>
</para>
@ -1344,7 +1344,7 @@ is a structure with the following members:
</para>
<para>
<!-- .LP -->
<!-- .IN "Vertex" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Vertex</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 1.5i -->
@ -1371,11 +1371,11 @@ is one).
The flags, as defined in
<!-- .hN X11/X10.h , -->
are as follows:
<!-- .IN "VertexRelative" "" "@DEF@" -->
<!-- .IN "VertexDontDraw" "" "@DEF@" -->
<!-- .IN "VertexCurved" "" "@DEF@" -->
<!-- .IN "VertexStartClosed" "" "@DEF@" -->
<!-- .IN "VertexEndClosed" "" "@DEF@" -->
<indexterm significance="preferred"><primary>VertexRelative</primary></indexterm>
<indexterm significance="preferred"><primary>VertexDontDraw</primary></indexterm>
<indexterm significance="preferred"><primary>VertexCurved</primary></indexterm>
<indexterm significance="preferred"><primary>VertexStartClosed</primary></indexterm>
<indexterm significance="preferred"><primary>VertexEndClosed</primary></indexterm>
<!-- .sM -->
</para>
@ -1464,10 +1464,10 @@ tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list.
<!-- .sp -->
To achieve the effects of the X Version 10
<function>XDrawTiled </function>
<!-- .IN "X10 compatibility" "XDrawTiled" -->
<indexterm><primary>X10 compatibility</primary><secondary>XDrawTiled</secondary></indexterm>
and
<function>XDrawFilled , </function>
<!-- .IN "X10 compatibility" "XDrawFilled" -->
<indexterm><primary>X10 compatibility</primary><secondary>XDrawFilled</secondary></indexterm>
use
<function>XDrawFilled .</function>
</para>
@ -1566,9 +1566,9 @@ It is often necessary to associate arbitrary information with resource IDs.
Xlib provides the
<function>XAssocTable </function>
functions that you can use to make such an association.
<!-- .IN "Hash Lookup" -->
<!-- .IN "Window" "IDs" -->
<!-- .IN "Resource IDs" -->
<indexterm><primary>Hash Lookup</primary></indexterm>
<indexterm><primary>Window</primary><secondary>IDs</secondary></indexterm>
<indexterm><primary>Resource IDs</primary></indexterm>
Application programs often need to be able to easily refer to
their own data structures when an event arrives.
The
@ -1626,7 +1626,7 @@ To return a pointer to a new
<function>XAssocTable , </function>
use
<function>XCreateAssocTable .</function>
<!-- .IN "XCreateAssocTable" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateAssocTable</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -1672,7 +1672,7 @@ To create an entry in a given
<function>XAssocTable ,</function>
use
<function>XMakeAssoc .</function>
<!-- .IN "XMakeAssoc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMakeAssoc</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -1747,7 +1747,7 @@ To obtain data from a given
<function>XAssocTable ,</function>
use
<function>XLookUpAssoc .</function>
<!-- .IN "XLookUpAssoc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLookUpAssoc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1812,7 +1812,7 @@ To delete an entry from a given
<function>XAssocTable ,</function>
use
<function>XDeleteAssoc .</function>
<!-- .IN "XDeleteAssoc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDeleteAssoc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1876,7 +1876,7 @@ To free the memory associated with a given
use
<function>XDestroyAssocTable .</function>
</para>
<!-- .IN "XDestroyAssocTable" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyAssocTable</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

54
specs/libX11/CH01.xml
View file

@ -62,15 +62,15 @@ A set of screens for a single user with one keyboard and one pointer
</para>
<para>
<!-- .LP -->
<!-- .IN "Screen" -->
<indexterm><primary>Screen</primary></indexterm>
All the windows in an X server are arranged in strict hierarchies.
At the top of each hierarchy is a root window,
which covers each of the display screens.
Each root window is partially or completely covered by child windows.
All windows, except for root windows, have parents.
There is usually at least one window for each application program.
<!-- .IN "Child window" -->
<!-- .IN "Parent Window" -->
<indexterm><primary>Child window</primary></indexterm>
<indexterm><primary>Parent Window</primary></indexterm>
Child windows may in turn have their own children.
In this way,
an application program can create an arbitrarily deep tree
@ -83,7 +83,7 @@ A child window can be larger than its parent.
That is, part or all of
the child window can extend beyond the boundaries of the parent,
but all output to a window is clipped by its parent.
<!-- .IN "Stacking order" -->
<indexterm><primary>Stacking order</primary></indexterm>
If several children of a window have overlapping locations,
one of the children is considered to be on top of or raised over the
others, thus obscuring them.
@ -95,7 +95,7 @@ that are also ancestors of the first window.
</para>
<para>
<!-- .LP -->
<!-- .IN "Window" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Window</primary></indexterm>
A window has a border zero or more pixels in width, which can
be any pattern (pixmap) or solid color you like.
A window usually but not always has a background pattern,
@ -127,10 +127,10 @@ Programs must be prepared to regenerate the contents of windows on demand.
</para>
<para>
<!-- .LP -->
<!-- .IN "Pixmap" -->
<!-- .IN "Drawable" -->
<!-- .IN "Tile" -->
<!-- .IN "Bitmap" -->
<indexterm><primary>Pixmap</primary></indexterm>
<indexterm><primary>Drawable</primary></indexterm>
<indexterm><primary>Tile</primary></indexterm>
<indexterm><primary>Bitmap</primary></indexterm>
X also provides off-screen storage of graphics objects,
called pixmaps.
Single plane (depth 1) pixmaps are sometimes referred to as bitmaps.
@ -150,7 +150,7 @@ which will be called when the error is reported.
</para>
<para>
<!-- .LP -->
<!-- .IN "XSync" -->
<indexterm><primary>XSync</primary></indexterm>
If a client does not want a request to execute asynchronously,
it can follow the request with a call to
<function>XSync , </function>
@ -162,12 +162,12 @@ that returns a value from the server or waits for input.
</para>
<para>
<!-- .LP -->
<!-- .IN "Resource IDs" -->
<!-- .IN "Resource IDs" "Window" -->
<!-- .IN "Resource IDs" "Font" -->
<!-- .IN "Resource IDs" "Pixmap" -->
<!-- .IN "Resource IDs" "Cursor" -->
<!-- .IN "Resource IDs" "GContext" -->
<indexterm><primary>Resource IDs</primary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Window</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Font</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Pixmap</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Cursor</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>GContext</secondary></indexterm>
Many Xlib functions will return an integer resource ID,
which allows you to refer to objects stored on the X server.
These can be of type
@ -192,7 +192,7 @@ Xlib provides no support for sharing graphics contexts between applications.
</para>
<para>
<!-- .LP -->
<!-- .IN "Event" -->
<indexterm><primary>Event</primary></indexterm>
Client programs are informed of events.
Events may either be side effects of a request (for example, restacking windows
generates
@ -219,7 +219,7 @@ and
<function>ConfigureRequest</function>
events.
These events also arrive asynchronously, but the client may
<!-- .IN "XSync" -->
<indexterm><primary>XSync</primary></indexterm>
wish to explicitly wait for them by calling
<function>XSync</function>
after calling a function that can cause the server to generate events.
@ -238,10 +238,10 @@ an integer error indication.
If the function fails, it returns a zero.
If the function returns a status of zero,
it has not updated the return arguments.
<!-- .IN "Status" -->
<indexterm><primary>Status</primary></indexterm>
Because C does not provide multiple return values,
many functions must return their results by writing into client-passed storage.
<!-- .IN "Error" "handling" -->
<indexterm><primary>Error</primary><secondary>handling</secondary></indexterm>
By default, errors are handled either by a standard library function
or by one that you provide.
Functions that return pointers to strings return NULL pointers if
@ -295,7 +295,7 @@ This is the main header file for Xlib.
The majority of all Xlib symbols are declared by including this file.
This file also contains the preprocessor symbol
<function>XlibSpecificationRelease .</function>
<!-- .IN "XlibSpecificationRelease" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XlibSpecificationRelease</primary></indexterm>
This symbol is defined to have the 6 in this release of the standard.
(Release 5 of Xlib was the first release to have this symbol.)
</para>
@ -451,9 +451,9 @@ X10 compatibility functions, which are described in appendix D.
<para>
<!-- .LP -->
The following symbols are defined by Xlib and used throughout the manual:
<!-- .IN "Bool" "" "@DEF@" -->
<!-- .IN "True" "" "@DEF@" -->
<!-- .IN "False" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Bool</primary></indexterm>
<indexterm significance="preferred"><primary>True</primary></indexterm>
<indexterm significance="preferred"><primary>False</primary></indexterm>
</para>
<itemizedlist>
<listitem>
@ -464,14 +464,14 @@ and the Boolean values
<function>True</function>
and
<function>False .</function>
<!-- .IN "None" "" "@DEF@" -->
<indexterm significance="preferred"><primary>None</primary></indexterm>
</para>
</listitem>
<listitem>
<para>
<function>None</function>
is the universal null resource ID or atom.
<!-- .IN "XID" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XID</primary></indexterm>
</para>
</listitem>
<listitem>
@ -479,7 +479,7 @@ is the universal null resource ID or atom.
The type
<function>XID</function>
is used for generic resource IDs.
<!-- .IN "XPointer" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPointer</primary></indexterm>
</para>
</listitem>
<listitem>

258
specs/libX11/CH02.xml
View file

@ -61,7 +61,7 @@ Use internal connections
<!-- .LP -->
To open a connection to the X server that controls a display, use
<function>XOpenDisplay .</function>
<!-- .IN "XOpenDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XOpenDisplay</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -85,7 +85,7 @@ Specifies the hardware display name, which determines the display
and communications domain to be used.
On a POSIX-conformant system, if the display_name is NULL,
it defaults to the value of the DISPLAY environment variable.
<!-- .IN "Environment" "DISPLAY" -->
<indexterm><primary>Environment</primary><secondary>DISPLAY</secondary></indexterm>
</para>
</listitem>
</varlistentry>
@ -143,7 +143,7 @@ Specifies the number of the display server on that host machine.
You may optionally follow this display number with a period (.).
A single CPU can have more than one display.
Multiple displays are usually numbered starting with zero.
<!-- .IN "Screen" -->
<indexterm><primary>Screen</primary></indexterm>
</para>
</listitem>
</varlistentry>
@ -190,8 +190,8 @@ about that X server.
connects your application to the X server through TCP
or DECnet communications protocols,
or through some local inter-process communication protocol.
<!-- .IN "Protocol" "TCP" -->
<!-- .IN "Protocol" "DECnet" -->
<indexterm><primary>Protocol</primary><secondary>TCP</secondary></indexterm>
<indexterm><primary>Protocol</primary><secondary>DECnet</secondary></indexterm>
If the protocol is specified as "tcp", "inet", or "inet6", or
if no protocol is specified and the hostname is a host machine name and a single colon (:)
separates the hostname and display number,
@ -212,7 +212,7 @@ mechanisms.
</para>
<para>
<!-- .LP -->
<!-- .IN "Display" -->
<indexterm><primary>Display</primary></indexterm>
If successful,
<function>XOpenDisplay </function>
returns a pointer to a
@ -283,7 +283,7 @@ Screen information macros
</itemizedlist>
<para>
<!-- .LP -->
<!-- .IN "Display" "data structure" -->
<indexterm ><primary>Display</primary><secondary>data structure</secondary></indexterm>
All other members of the
<function>Display </function>
structure (that is, those for which no macros are defined) are private to Xlib
@ -332,8 +332,8 @@ and what data both can return.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "AllPlanes" "" "@DEF@" -->
<!-- .IN "XAllPlanes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>AllPlanes</primary></indexterm>
<indexterm significance="preferred"><primary>XAllPlanes</primary></indexterm>
Both return a value with all bits set to 1 suitable for use in a plane argument to
a procedure.
</para>
@ -388,8 +388,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "BlackPixel" "" "@DEF@" -->
<!-- .IN "XBlackPixel" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BlackPixel</primary></indexterm>
<indexterm significance="preferred"><primary>XBlackPixel</primary></indexterm>
Both return the black pixel value for the specified screen.
</para>
<para>
@ -433,8 +433,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "WhitePixel" "" "@DEF@" -->
<!-- .IN "XWhitePixel" "" "@DEF@" -->
<indexterm significance="preferred"><primary>WhitePixel</primary></indexterm>
<indexterm significance="preferred"><primary>XWhitePixel</primary></indexterm>
Both return the white pixel value for the specified screen.
</para>
<para>
@ -468,8 +468,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ConnectionNumber" "" "@DEF@" -->
<!-- .IN "XConnectionNumber" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ConnectionNumber</primary></indexterm>
<indexterm significance="preferred"><primary>XConnectionNumber</primary></indexterm>
Both return a connection number for the specified display.
On a POSIX-conformant system,
this is the file descriptor of the connection.
@ -515,8 +515,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultColormap" "" "@DEF@" -->
<!-- .IN "XDefaultColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultColormap</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultColormap</primary></indexterm>
Both return the default colormap ID for allocation on the specified screen.
Most routine allocations of color should be made out of this colormap.
</para>
@ -561,8 +561,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultDepth" "" "@DEF@" -->
<!-- .IN "XDefaultDepth" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultDepth</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultDepth</primary></indexterm>
Both return the depth (number of planes) of the default root window for the
specified screen.
Other depths may also be supported on this screen (see
@ -571,7 +571,7 @@ Other depths may also be supported on this screen (see
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XListDepths" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListDepths</primary></indexterm>
To determine the number of depths that are available on a given screen, use
<function>XListDepths .</function>
<!-- .sM -->
@ -677,8 +677,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultGC" "" "@DEF@" -->
<!-- .IN "XDefaultGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultGC</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultGC</primary></indexterm>
Both return the default graphics context for the root window of the
specified screen.
This GC is created for the convenience of simple applications
@ -719,8 +719,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultRootWindow" "" "@DEF@" -->
<!-- .IN "XDefaultRootWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultRootWindow</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultRootWindow</primary></indexterm>
Both return the root window for the default screen.
</para>
<para>
@ -753,8 +753,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultScreenOfDisplay" "" "@DEF@" -->
<!-- .IN "XDefaultScreenOfDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultScreenOfDisplay</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultScreenOfDisplay</primary></indexterm>
Both return a pointer to the default screen.
</para>
<para>
@ -798,8 +798,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ScreenOfDisplay" "" "@DEF@" -->
<!-- .IN "XScreenOfDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ScreenOfDisplay</primary></indexterm>
<indexterm significance="preferred"><primary>XScreenOfDisplay</primary></indexterm>
Both return a pointer to the indicated screen.
</para>
<para>
@ -832,8 +832,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultScreen" "" "@DEF@" -->
<!-- .IN "XDefaultScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultScreen</primary></indexterm>
Both return the default screen number referenced by the
<function>XOpenDisplay</function>
function.
@ -881,8 +881,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultVisual" "" "@DEF@" -->
<!-- .IN "XDefaultVisual" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultVisual</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultVisual</primary></indexterm>
Both return the default visual type for the specified screen.
For further information about visual types,
see section 3.1.
@ -928,8 +928,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayCells" "" "@DEF@" -->
<!-- .IN "XDisplayCells" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayCells</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayCells</primary></indexterm>
Both return the number of entries in the default colormap.
</para>
<para>
@ -973,8 +973,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayPlanes" "" "@DEF@" -->
<!-- .IN "XDisplayPlanes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayPlanes</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayPlanes</primary></indexterm>
Both return the depth of the root window of the specified screen.
For an explanation of depth,
see the glossary.
@ -1009,15 +1009,15 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayString" "" "@DEF@" -->
<!-- .IN "XDisplayString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayString</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayString</primary></indexterm>
Both return the string that was passed to
<function>XOpenDisplay</function>
when the current display was opened.
On POSIX-conformant systems,
if the passed string was NULL, these return the value of
the DISPLAY environment variable when the current display was opened.
<!-- .IN "POSIX System Call" "fork" -->
<indexterm><primary>POSIX System Call</primary><secondary>fork</secondary></indexterm>
These are useful to applications that invoke the
<function>fork</function>
system call and want to open a new connection to the same display from the
@ -1053,7 +1053,7 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XExtendedMaxRequestSize" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XExtendedMaxRequestSize</primary></indexterm>
The
<function>XExtendedMaxRequestSize</function>
function returns zero if the specified display does not support an
@ -1110,7 +1110,7 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XMaxRequestSize" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMaxRequestSize</primary></indexterm>
The
<function>XMaxRequestSize</function>
function returns the maximum request size (in 4-byte units) supported
@ -1159,8 +1159,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "LastKnownRequestProcessed" "" "@DEF@" -->
<!-- .IN "XLastKnownRequestProcessed" "" "@DEF@" -->
<indexterm significance="preferred"><primary>LastKnownRequestProcessed</primary></indexterm>
<indexterm significance="preferred"><primary>XLastKnownRequestProcessed</primary></indexterm>
Both extract the full serial number of the last request known by Xlib
to have been processed by the X server.
Xlib automatically sets this number when replies, events, and errors
@ -1196,8 +1196,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "NextRequest" "" "@DEF@" -->
<!-- .IN "XNextRequest" "" "@DEF@" -->
<indexterm significance="preferred"><primary>NextRequest</primary></indexterm>
<indexterm significance="preferred"><primary>XNextRequest</primary></indexterm>
Both extract the full serial number that is to be used for the next
request.
Serial numbers are maintained separately for each display connection.
@ -1232,8 +1232,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ProtocolVersion" "" "@DEF@" -->
<!-- .IN "XProtocolVersion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ProtocolVersion</primary></indexterm>
<indexterm significance="preferred"><primary>XProtocolVersion</primary></indexterm>
Both return the major version number (11) of the X protocol associated with
the connected display.
</para>
@ -1267,8 +1267,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ProtocolRevision" "" "@DEF@" -->
<!-- .IN "XProtocolRevision" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ProtocolRevision</primary></indexterm>
<indexterm significance="preferred"><primary>XProtocolRevision</primary></indexterm>
Both return the minor protocol revision number of the X server.
</para>
<para>
@ -1301,8 +1301,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "QLength" "" "@DEF@" -->
<!-- .IN "XQLength" "" "@DEF@" -->
<indexterm significance="preferred"><primary>QLength</primary></indexterm>
<indexterm significance="preferred"><primary>XQLength</primary></indexterm>
Both return the length of the event queue for the connected display.
Note that there may be more events that have not been read into
the queue yet (see
@ -1349,10 +1349,10 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "Window" "RootWindow" -->
<!-- .IN "RootWindow" "" "@DEF@" -->
<!-- .IN "Window" "XRootWindow" -->
<!-- .IN "XRootWindow" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>RootWindow</secondary></indexterm>
<indexterm significance="preferred"><primary>RootWindow</primary></indexterm>
<indexterm><primary>Window</primary><secondary>XRootWindow</secondary></indexterm>
<indexterm significance="preferred"><primary>XRootWindow</primary></indexterm>
Both return the root window.
These are useful with functions that need a drawable of a particular screen
and for creating top-level windows.
@ -1387,8 +1387,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ScreenCount" "" "@DEF@" -->
<!-- .IN "XScreenCount" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ScreenCount</primary></indexterm>
<indexterm significance="preferred"><primary>XScreenCount</primary></indexterm>
Both return the number of available screens.
</para>
<para>
@ -1421,8 +1421,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ServerVendor" "" "@DEF@" -->
<!-- .IN "XServerVendor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ServerVendor</primary></indexterm>
<indexterm significance="preferred"><primary>XServerVendor</primary></indexterm>
Both return a pointer to a null-terminated string that provides
some identification of the owner of the X server implementation.
If the data returned by the server is in the Latin Portable Character Encoding,
@ -1459,8 +1459,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "VendorRelease" "" "@DEF@" -->
<!-- .IN "XVendorRelease" "" "@DEF@" -->
<indexterm significance="preferred"><primary>VendorRelease</primary></indexterm>
<indexterm significance="preferred"><primary>XVendorRelease</primary></indexterm>
Both return a number related to a vendor's release of the X server.
</para>
</sect2>
@ -1504,7 +1504,7 @@ typedef struct {
<!-- .sp -->
To obtain the pixmap format information for a given display, use
<function>XListPixmapFormats .</function>
<!-- .IN "XListPixmapFormats" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListPixmapFormats</primary></indexterm>
<!-- .sM -->
</para>
<para>
@ -1595,8 +1595,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "ImageByteOrder" "" "@DEF@" -->
<!-- .IN "XImageByteOrder" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ImageByteOrder</primary></indexterm>
<indexterm significance="preferred"><primary>XImageByteOrder</primary></indexterm>
Both specify the required byte order for images for each scanline unit in
XY format (bitmap) or for each pixel value in
Z format.
@ -1635,8 +1635,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "BitmapUnit" "" "@DEF@" -->
<!-- .IN "XBitmapUnit" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BitmapUnit</primary></indexterm>
<indexterm significance="preferred"><primary>XBitmapUnit</primary></indexterm>
Both return the size of a bitmap's scanline unit in bits.
The scanline is calculated in multiples of this value.
</para>
@ -1670,8 +1670,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "BitmapBitOrder" "" "@DEF@" -->
<!-- .IN "XBitmapBitOrder" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BitmapBitOrder</primary></indexterm>
<indexterm significance="preferred"><primary>XBitmapBitOrder</primary></indexterm>
Within each bitmap unit, the left-most bit in the bitmap as displayed
on the screen is either the least significant or most significant bit in the
unit.
@ -1710,8 +1710,8 @@ Specifies the connection to the X server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "BitmapPad" "" "@DEF@" -->
<!-- .IN "XBitmapPad" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BitmapPad</primary></indexterm>
<indexterm significance="preferred"><primary>XBitmapPad</primary></indexterm>
Each scanline must be padded to a multiple of bits returned
by this macro or function.
</para>
@ -1756,8 +1756,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayHeight" "" "@DEF@" -->
<!-- .IN "XDisplayHeight" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayHeight</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayHeight</primary></indexterm>
Both return an integer that describes the height of the screen
in pixels.
</para>
@ -1802,8 +1802,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayHeightMM" "" "@DEF@" -->
<!-- .IN "XDisplayHeightMM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayHeightMM</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayHeightMM</primary></indexterm>
Both return the height of the specified screen in millimeters.
</para>
<para>
@ -1847,8 +1847,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayWidth" "" "@DEF@" -->
<!-- .IN "XDisplayWidth" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayWidth</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayWidth</primary></indexterm>
Both return the width of the screen in pixels.
</para>
<para>
@ -1892,8 +1892,8 @@ Specifies the appropriate screen number on the host server.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayWidthMM" "" "@DEF@" -->
<!-- .IN "XDisplayWidthMM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayWidthMM</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayWidthMM</primary></indexterm>
Both return the width of the specified screen in millimeters.
</para>
</sect2>
@ -1942,8 +1942,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "BlackPixelOfScreen" "" "@DEF@" -->
<!-- .IN "XBlackPixelOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BlackPixelOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XBlackPixelOfScreen</primary></indexterm>
Both return the black pixel value of the specified screen.
</para>
<para>
@ -1978,8 +1978,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "WhitePixelOfScreen" "" "@DEF@" -->
<!-- .IN "XWhitePixelOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>WhitePixelOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XWhitePixelOfScreen</primary></indexterm>
Both return the white pixel value of the specified screen.
</para>
<para>
@ -2014,8 +2014,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "CellsOfScreen" "" "@DEF@" -->
<!-- .IN "XCellsOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>CellsOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XCellsOfScreen</primary></indexterm>
Both return the number of colormap cells in the default colormap
of the specified screen.
</para>
@ -2051,8 +2051,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultColormapOfScreen" "" "@DEF@" -->
<!-- .IN "XDefaultColormapOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultColormapOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultColormapOfScreen</primary></indexterm>
Both return the default colormap of the specified screen.
</para>
<para>
@ -2087,8 +2087,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultDepthOfScreen" "" "@DEF@" -->
<!-- .IN "XDefaultDepthOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultDepthOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultDepthOfScreen</primary></indexterm>
Both return the depth of the root window.
</para>
<para>
@ -2123,8 +2123,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultGCOfScreen" "" "@DEF@" -->
<!-- .IN "XDefaultGCOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultGCOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultGCOfScreen</primary></indexterm>
Both return a default graphics context (GC) of the specified screen,
which has the same depth as the root window of the screen.
The GC must never be freed.
@ -2161,8 +2161,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DefaultVisualOfScreen" "" "@DEF@" -->
<!-- .IN "XDefaultVisualOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DefaultVisualOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XDefaultVisualOfScreen</primary></indexterm>
Both return the default visual of the specified screen.
For information on visual types,
see section 3.1.
@ -2199,8 +2199,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DoesBackingStore" "" "@DEF@" -->
<!-- .IN "XDoesBackingStore" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DoesBackingStore</primary></indexterm>
<indexterm significance="preferred"><primary>XDoesBackingStore</primary></indexterm>
Both return a value indicating whether the screen supports backing
stores.
The value returned can be one of
@ -2242,8 +2242,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DoesSaveUnders" "" "@DEF@" -->
<!-- .IN "XDoesSaveUnders" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DoesSaveUnders</primary></indexterm>
<indexterm significance="preferred"><primary>XDoesSaveUnders</primary></indexterm>
Both return a Boolean value indicating whether the
screen supports save unders.
If
@ -2285,15 +2285,15 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "DisplayOfScreen" "" "@DEF@" -->
<!-- .IN "XDisplayOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XDisplayOfScreen</primary></indexterm>
Both return the display of the specified screen.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .sM -->
<!-- .IN "XScreenNumberOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XScreenNumberOfScreen</primary></indexterm>
</para>
<para>
EventMaskOfScreen(<emphasis remap='I'>screen</emphasis>)
@ -2358,8 +2358,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "EventMaskOfScreen" "" "@DEF@" -->
<!-- .IN "XEventMaskOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>EventMaskOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XEventMaskOfScreen</primary></indexterm>
Both return the event mask of the root window for the specified screen
at connection setup time.
</para>
@ -2395,8 +2395,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "WidthOfScreen" "" "@DEF@" -->
<!-- .IN "XWidthOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>WidthOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XWidthOfScreen</primary></indexterm>
Both return the width of the specified screen in pixels.
</para>
<para>
@ -2431,8 +2431,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "HeightOfScreen" "" "@DEF@" -->
<!-- .IN "XHeightOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>HeightOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XHeightOfScreen</primary></indexterm>
Both return the height of the specified screen in pixels.
</para>
<para>
@ -2467,8 +2467,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "WidthMMOfScreen" "" "@DEF@" -->
<!-- .IN "XWidthMMOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>WidthMMOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XWidthMMOfScreen</primary></indexterm>
Both return the width of the specified screen in millimeters.
</para>
<para>
@ -2503,8 +2503,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "HeightMMOfScreen" "" "@DEF@" -->
<!-- .IN "XHeightMMOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>HeightMMOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XHeightMMOfScreen</primary></indexterm>
Both return the height of the specified screen in millimeters.
</para>
<para>
@ -2539,8 +2539,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "MaxCmapsOfScreen" "" "@DEF@" -->
<!-- .IN "XMaxCmapsOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>MaxCmapsOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XMaxCmapsOfScreen</primary></indexterm>
Both return the maximum number of installed colormaps supported
by the specified screen (see section 9.3).
</para>
@ -2576,8 +2576,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "MinCmapsOfScreen" "" "@DEF@" -->
<!-- .IN "XMinCmapsOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>MinCmapsOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XMinCmapsOfScreen</primary></indexterm>
Both return the minimum number of installed colormaps supported
by the specified screen (see section 9.3).
</para>
@ -2613,8 +2613,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "PlanesOfScreen" "" "@DEF@" -->
<!-- .IN "XPlanesOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>PlanesOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XPlanesOfScreen</primary></indexterm>
Both return the depth of the root window.
</para>
<para>
@ -2649,8 +2649,8 @@ structure.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "RootWindowOfScreen" "" "@DEF@" -->
<!-- .IN "XRootWindowOfScreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>RootWindowOfScreen</primary></indexterm>
<indexterm significance="preferred"><primary>XRootWindowOfScreen</primary></indexterm>
Both return the root window of the specified screen.
</para>
</sect2>
@ -2666,7 +2666,7 @@ To execute a
<function>NoOperation </function>
protocol request, use
<function>XNoOp .</function>
<!-- .IN "XNoOp" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNoOp</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -2704,7 +2704,7 @@ thereby exercising the connection.
<!-- .LP -->
To free in-memory data that was created by an Xlib function, use
<function>XFree .</function>
<!-- .IN "XFree" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFree</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -2747,7 +2747,7 @@ A NULL pointer cannot be passed to this function.
<!-- .LP -->
To close a display or disconnect from the X server, use
<function>XCloseDisplay .</function>
<!-- .IN "XCloseDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCloseDisplay</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -2801,8 +2801,8 @@ explicitly so that any pending errors are reported as
performs a final
<function>XSync</function>
operation.
<!-- .IN "Resource IDs" -->
<!-- .IN "XCloseDisplay" -->
<indexterm><primary>Resource IDs</primary></indexterm>
<indexterm><primary>XCloseDisplay</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -2818,7 +2818,7 @@ Xlib provides a function to permit the resources owned by a client
to survive after the client's connection is closed.
To change a client's close-down mode, use
<function>XSetCloseDownMode .</function>
<!-- .IN "XSetCloseDownMode" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetCloseDownMode</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -3070,7 +3070,7 @@ multiple threads to use Xlib concurrently.
<!-- .sp -->
To initialize support for concurrent threads, use
<function>XInitThreads .</function>
<!-- .IN "XInitThreads" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XInitThreads</primary></indexterm>
<!-- .sM -->
</para>
<para>Status XInitThreads();</para>
@ -3103,7 +3103,7 @@ It is recommended that single-threaded programs not call this function.
<!-- .sp -->
To lock a display across several Xlib calls, use
<function>XLockDisplay .</function>
<!-- .IN "XLockDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLockDisplay</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -3148,7 +3148,7 @@ for threads using
<!-- .sp -->
To unlock a display, use
<function>XUnlockDisplay .</function>
<!-- .IN "XUnlockDisplay" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnlockDisplay</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -3306,7 +3306,7 @@ thread has externally locked the display using
<!-- .sp -->
To stop tracking internal connections for a display, use
<function>XRemoveConnectionWatch .</function>
<!-- .IN "XRemoveConnectionWatch" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRemoveConnectionWatch</primary></indexterm>
<!-- .sM -->
</para>
<para>
@ -3368,7 +3368,7 @@ was initially registered.
<!-- .sp -->
To process input on an internal connection, use
<function>XProcessInternalConnection .</function>
<!-- .IN "XProcessInternalConnection" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XProcessInternalConnection</primary></indexterm>
<!-- .sM -->
</para>
<para>
@ -3423,7 +3423,7 @@ the effect is not defined.
<!-- .sp -->
To obtain all of the current internal connections for a display, use
<function>XInternalConnectionNumbers .</function>
<!-- .IN "XInternalConnectionNumbers" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XInternalConnectionNumbers</primary></indexterm>
<!-- .sM -->
</para>
<para>

126
specs/libX11/CH03.xml
View file

@ -6,7 +6,7 @@
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Visual Type" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Visual Type</primary></indexterm>
On some display hardware,
it may be possible to deal with color resources in more than one way.
For example, you may be able to deal with a screen of either 12-bit depth
@ -26,7 +26,7 @@ the default depth of the default root window, and the default visual type
<!-- .LP -->
Xlib uses an opaque
<function>Visual </function>
<!-- .IN "Visual" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Visual</primary></indexterm>
structure that contains information about the possible color mapping.
The visual utility functions (see section 16.7) use an
<function>XVisualInfo</function>
@ -35,12 +35,12 @@ The members of this structure pertinent to this discussion are class, red_mask,
green_mask, blue_mask, bits_per_rgb, and colormap_size.
The class member specifies one of the possible visual classes of the screen
and can be
<!-- .IN "Visual Classes" "StaticGray" -->
<!-- .IN "Visual Classes" "StaticColor" -->
<!-- .IN "Visual Classes" "TrueColor" -->
<!-- .IN "Visual Classes" "StaticColor" -->
<!-- .IN "Visual Classes" "GrayScale" -->
<!-- .IN "Visual Classes" "PseudoColor" -->
<indexterm><primary>Visual Classes</primary><secondary>StaticGray</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>StaticColor</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>TrueColor</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>StaticColor</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>GrayScale</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>PseudoColor</secondary></indexterm>
<function>StaticGray ,</function>
<function>StaticColor ,</function>
<function>TrueColor ,</function>
@ -171,7 +171,7 @@ To obtain the visual ID from a
<function>Visual ,</function>
use
<function>XVisualIDFromVisual .</function>
<!-- .IN "XVisualIDFromVisual" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XVisualIDFromVisual</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -208,8 +208,8 @@ function returns the visual ID for the specified visual type.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Window" -->
<!-- .IN "Window" "attributes" -->
<indexterm><primary>Window</primary></indexterm>
<indexterm><primary>Window</primary><secondary>attributes</secondary></indexterm>
All
<function>InputOutput</function>
windows have a border width of zero or more pixels, an optional background,
@ -297,14 +297,14 @@ windows as inferiors.
<!-- .LP -->
Windows have borders of a programmable width and pattern
as well as a background pattern or tile.
<!-- .IN "Tile" "pixmaps" -->
<indexterm><primary>Tile</primary><secondary>pixmaps</secondary></indexterm>
Pixel values can be used for solid colors.
<!-- .IN "Resource IDs" "freeing" -->
<!-- .IN "Freeing" "resources" -->
<indexterm><primary>Resource IDs</primary><secondary>freeing</secondary></indexterm>
<indexterm><primary>Freeing</primary><secondary>resources</secondary></indexterm>
The background and border pixmaps can be destroyed immediately after
creating the window if no further explicit references to them
are to be made.
<!-- .IN "Tile" "mode" -->
<indexterm ><primary>Tile</primary><secondary>mode</secondary></indexterm>
The pattern can either be relative to the parent
or absolute.
If
@ -317,13 +317,13 @@ When windows are first created,
they are not visible (not mapped) on the screen.
Any output to a window that is not visible on the screen
and that does not have backing store will be discarded.
<!-- .IN "Window" "mapping" -->
<indexterm><primary>Window</primary><secondary>mapping</secondary></indexterm>
An application may wish to create a window long before it is
mapped to the screen.
When a window is eventually mapped to the screen
(using
<function>XMapWindow ),</function>
<!-- .IN "XMapWindow" -->
<indexterm><primary>XMapWindow</primary></indexterm>
the X server generates an
<function>Expose </function>
event for the window if backing store has not been maintained.
@ -382,7 +382,7 @@ structure are:
#define CWCursor (1L&lt;&lt;14)
</literallayout>
<!-- .IN "XSetWindowAttributes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWindowAttributes</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
@ -933,7 +933,7 @@ However, regions obscured by inferior windows are not included.
<!-- .XS -->
<!-- (SN Save Under Flag -->
<!-- .XE -->
<!-- .IN "Save Unders" -->
<indexterm><primary>Save Unders</primary></indexterm>
<para>
<!-- .LP -->
Some server implementations may preserve contents of
@ -1214,7 +1214,7 @@ creates a window that inherits its attributes from its parent window.
</para>
<para>
<!-- .LP -->
<!-- .IN "Window" "InputOnly" -->
<indexterm><primary>Window</primary><secondary>InputOnly</secondary></indexterm>
The X server acts as if
<function>InputOnly </function>
windows do not exist for
@ -1236,7 +1236,7 @@ Extension packages can define other classes of windows.
<!-- .LP -->
To create an unmapped window and set its window attributes, use
<function>XCreateWindow .</function>
<!-- .IN "XCreateWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1475,8 +1475,8 @@ The new window initially uses the same cursor as
its parent.
A new cursor can be defined for the new window by calling
<function>XDefineCursor .</function>
<!-- .IN "Cursor" "Initial State" -->
<!-- .IN "XDefineCursor" -->
<indexterm><primary>Cursor</primary><secondary>Initial State</secondary></indexterm>
<indexterm><primary>XDefineCursor</primary></indexterm>
The window will not be visible on the screen unless it and all of its
ancestors are mapped and it is not obscured by any of its ancestors.
</para>
@ -1501,7 +1501,7 @@ To create an unmapped
<function>InputOutput</function>
subwindow of a given parent window, use
<function>XCreateSimpleWindow .</function>
<!-- .IN "XCreateSimpleWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateSimpleWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1671,7 +1671,7 @@ subwindows of a window.
<!-- .sp -->
To destroy a window and all of its subwindows, use
<function>XDestroyWindow .</function>
<!-- .IN "XDestroyWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1741,7 +1741,7 @@ error.
<!-- .sp -->
To destroy all subwindows of a specified window, use
<function>XDestroySubwindows .</function>
<!-- .IN "XDestroySubwindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroySubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1884,7 +1884,7 @@ event.
<!-- .sp -->
To map a given window, use
<function>XMapWindow .</function>
<!-- .IN "XMapWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMapWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1969,7 +1969,7 @@ Similar tiling and exposure take place for any newly viewable inferiors.
</para>
<para>
<!-- .LP -->
<!-- .IN "XMapWindow" -->
<indexterm><primary>XMapWindow</primary></indexterm>
If the window is an
<function>InputOutput </function>
window,
@ -2010,7 +2010,7 @@ error.
<!-- .sp -->
To map and raise a window, use
<function>XMapRaised .</function>
<!-- .IN "XMapRaised" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMapRaised</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2070,7 +2070,7 @@ errors.
<!-- .sp -->
To map all subwindows for a specified window, use
<function>XMapSubwindows .</function>
<!-- .IN "XMapSubwindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMapSubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2108,7 +2108,7 @@ Specifies the window.
<!-- .eM -->
The
<function>XMapSubwindows</function>
<!-- .IN "XMapSubwindows" -->
<indexterm><primary>XMapSubwindows</primary></indexterm>
function maps all subwindows for a specified window in top-to-bottom stacking
order.
The X server generates
@ -2140,7 +2140,7 @@ Xlib provides functions that you can use to unmap a window or all subwindows.
<!-- .sp -->
To unmap a window, use
<function>XUnmapWindow .</function>
<!-- .IN "XUnmapWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnmapWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2180,8 +2180,8 @@ The
<function>XUnmapWindow</function>
function unmaps the specified window and causes the X server to generate an
<function>UnmapNotify</function>
<!-- .IN "UnmapNotify Event" -->
<!-- .IN "XUnmapWindow" -->
<indexterm><primary>UnmapNotify Event</primary></indexterm>
<indexterm><primary>XUnmapWindow</primary></indexterm>
event.
If the specified window is already unmapped,
<function>XUnmapWindow </function>
@ -2207,7 +2207,7 @@ error.
<!-- .sp -->
To unmap all subwindows for a specified window, use
<function>XUnmapSubwindows .</function>
<!-- .IN "XUnmapSubwindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnmapSubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2252,7 +2252,7 @@ It causes the X server to generate an
event on each subwindow and
<function>Expose </function>
events on formerly obscured windows.
<!-- .IN "UnmapNotify Event" -->
<indexterm><primary>UnmapNotify Event</primary></indexterm>
Using this function is much more efficient than unmapping multiple windows
one at a time because the server needs to perform much of the work
only once, for all of the windows, rather than for each window.
@ -2302,7 +2302,7 @@ structure are:
#define CWStackMode (1&lt;&lt;6)
</literallayout>
<!-- .IN "XWindowChanges" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWindowChanges</primary></indexterm>
<literallayout class="monospaced">
/* Values */
@ -2512,7 +2512,7 @@ Attempts to configure a root window have no effect.
<!-- .sp -->
To configure a window's size, location, stacking, or border, use
<function>XConfigureWindow .</function>
<!-- .IN "XConfigureWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XConfigureWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2618,7 +2618,7 @@ errors.
<!-- .sp -->
To move a window without changing its size, use
<function>XMoveWindow .</function>
<!-- .IN "XMoveWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMoveWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2720,7 +2720,7 @@ error.
<!-- .sp -->
To change a window's size without changing the upper-left coordinate, use
<function>XResizeWindow .</function>
<!-- .IN "XResizeWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XResizeWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2823,7 +2823,7 @@ errors.
<!-- .sp -->
To change the size and location of a window, use
<function>XMoveResizeWindow .</function>
<!-- .IN "XMoveResizeWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMoveResizeWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2944,7 +2944,7 @@ errors.
<!-- .sp -->
To change the border width of a given window, use
<function>XSetWindowBorderWidth .</function>
<!-- .IN "XSetWindowBorderWidth" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWindowBorderWidth</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3021,7 +3021,7 @@ or restack windows.
<!-- .sp -->
To raise a window so that no sibling window obscures it, use
<function>XRaiseWindow .</function>
<!-- .IN "XRaiseWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRaiseWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3094,7 +3094,7 @@ error.
<!-- .sp -->
To lower a window so that it does not obscure any sibling windows, use
<function>XLowerWindow .</function>
<!-- .IN "XLowerWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLowerWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3168,7 +3168,7 @@ error.
<!-- .sp -->
To circulate a subwindow up or down, use
<function>XCirculateSubwindows .</function>
<!-- .IN "XCirculateSubwindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCirculateSubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3260,7 +3260,7 @@ errors.
To raise the lowest mapped child of a window that is partially or completely
occluded by another child, use
<function>XCirculateSubwindowsUp .</function>
<!-- .IN "XCirculateSubwindowsUp" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCirculateSubwindowsUp</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3322,7 +3322,7 @@ error.
To lower the highest mapped child of a window that partially or
completely occludes another child, use
<function>XCirculateSubwindowsDown .</function>
<!-- .IN "XCirculateSubwindowsDown" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCirculateSubwindowsDown</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3381,7 +3381,7 @@ error.
<!-- .sp -->
To restack a set of windows from top to bottom, use
<function>XRestackWindows .</function>
<!-- .IN "XRestackWindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRestackWindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3487,7 +3487,7 @@ window attribute, such as a window's background.
<!-- .sp -->
To change one or more attributes for a given window, use
<function>XChangeWindowAttributes .</function>
<!-- .IN "XChangeWindowAttributes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChangeWindowAttributes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3645,7 +3645,7 @@ errors.
<!-- .sp -->
To set the background of a window to a given pixel, use
<function>XSetWindowBackground .</function>
<!-- .IN "XSetWindowBackground" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWindowBackground</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3721,8 +3721,8 @@ errors.
<!-- .LP -->
To set the background of a window to a given pixmap, use
<function>XSetWindowBackgroundPixmap .</function>
<!-- .IN "Window" "background" -->
<!-- .IN "XSetWindowBackgroundPixmap" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>background</secondary></indexterm>
<indexterm significance="preferred"><primary>XSetWindowBackgroundPixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3772,8 +3772,8 @@ or
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "Resource IDs" "freeing" -->
<!-- .IN "Freeing" "resources" -->
<indexterm><primary>Resource IDs</primary><secondary>freeing</secondary></indexterm>
<indexterm><primary>Freeing</primary><secondary>resources</secondary></indexterm>
The
<function>XSetWindowBackgroundPixmap</function>
function sets the background pixmap of the window to the specified pixmap.
@ -3814,7 +3814,7 @@ do not change the current contents of the window.
<!-- .sp -->
To change and repaint a window's border to a given pixel, use
<function>XSetWindowBorder .</function>
<!-- .IN "XSetWindowBorder" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWindowBorder</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3884,7 +3884,7 @@ errors.
<!-- .sp -->
To change and repaint the border tile of a given window, use
<function>XSetWindowBorderPixmap .</function>
<!-- .IN "XSetWindowBorderPixmap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWindowBorderPixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3945,8 +3945,8 @@ If you attempt to perform this on an
window, a
<function>BadMatch</function>
error results.
<!-- .IN "Resource IDs" "freeing" -->
<!-- .IN "Freeing" "resources" -->
<indexterm><primary>Resource IDs</primary><secondary>freeing</secondary></indexterm>
<indexterm><primary>Freeing</primary><secondary>resources</secondary></indexterm>
</para>
<para>
<!-- .LP -->
@ -3963,7 +3963,7 @@ errors.
<!-- .sp -->
To set the colormap of a given window, use
<function>XSetWindowColormap .</function>
<!-- .IN "XSetWindowColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWindowColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4033,8 +4033,8 @@ errors.
<!-- .sp -->
To define which cursor will be used in a window, use
<function>XDefineCursor .</function>
<!-- .IN "Window" "defining the cursor" -->
<!-- .IN "XDefineCursor" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>defining the cursor</secondary></indexterm>
<indexterm significance="preferred"><primary>XDefineCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4102,8 +4102,8 @@ errors.
<!-- .sp -->
To undefine the cursor in a given window, use
<function>XUndefineCursor .</function>
<!-- .IN "Window" "undefining the cursor" -->
<!-- .IN "XUndefineCursor" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>undefining the cursor</secondary></indexterm>
<indexterm significance="preferred"><primary>XUndefineCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

80
specs/libX11/CH04.xml
View file

@ -33,9 +33,9 @@ exists.
To obtain the parent, a list of children, and number of children for
a given window, use
<function>XQueryTree .</function>
<!-- .IN "Child Window" -->
<!-- .IN "Parent Window" -->
<!-- .IN "XQueryTree" "" "@DEF@" -->
<indexterm><primary>Child Window</primary></indexterm>
<indexterm><primary>Parent Window</primary></indexterm>
<indexterm significance="preferred"><primary>XQueryTree</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -142,7 +142,7 @@ error.
<!-- .sp -->
To obtain the current attributes of a given window, use
<function>XGetWindowAttributes .</function>
<!-- .IN "XGetWindowAttributes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWindowAttributes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -200,7 +200,7 @@ structure.
</para>
<para>
<!-- .LP -->
<!-- .IN "XWindowAttributes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWindowAttributes</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -402,7 +402,7 @@ errors.
<!-- .sp -->
To obtain the current geometry of a given drawable, use
<function>XGetGeometry .</function>
<!-- .IN "XGetGeometry" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetGeometry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -563,7 +563,7 @@ asking the X server to perform these operations.
To translate a coordinate in one window to the coordinate
space of another window, use
<function>XTranslateCoordinates .</function>
<!-- .IN "XTranslateCoordinates" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTranslateCoordinates</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -697,7 +697,7 @@ error.
To obtain the screen coordinates of the pointer
or to determine the pointer coordinates relative to a specified window, use
<function>XQueryPointer .</function>
<!-- .IN "XQueryPointer" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryPointer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -868,7 +868,7 @@ error.
<!-- .LP -->
A property is a collection of named, typed data.
The window system has a set of predefined properties
<!-- .IN "Atom" "predefined" -->
<indexterm><primary>Atom</primary><secondary>predefined</secondary></indexterm>
(for example, the name of a window, size hints, and so on), and users can
define any other arbitrary information and associate it with windows.
Each property has a name,
@ -885,7 +885,7 @@ For efficiency reasons,
an atom is used rather than a character string.
<function>XInternAtom</function>
can be used to obtain the atom for property names.
<!-- .IN "Atom" -->
<indexterm><primary>Atom</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -903,7 +903,7 @@ see appendix C. <!-- xref -->
<!-- .NE -->
The type of a property is defined by an atom, which allows for
arbitrary extension in this type scheme.
<!-- .IN "Atom" -->
<indexterm><primary>Atom</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -1184,8 +1184,8 @@ see section 8.5. <!-- xref -->
<!-- .sp -->
To return an atom for a given name, use
<function>XInternAtom .</function>
<!-- .IN "Atom" "interning" -->
<!-- .IN "XInternAtom" "" "@DEF@" -->
<indexterm><primary>Atom</primary><secondary>interning</secondary></indexterm>
<indexterm significance="preferred"><primary>XInternAtom</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1266,8 +1266,8 @@ errors.
<!-- .sp -->
To return atoms for an array of names, use
<function>XInternAtoms .</function>
<!-- .IN "Atom" "interning" -->
<!-- .IN "XInternAtoms" "" "@DEF@" -->
<indexterm><primary>Atom</primary><secondary>interning</secondary></indexterm>
<indexterm significance="preferred"><primary>XInternAtoms</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1367,8 +1367,8 @@ errors.
<!-- .sp -->
To return a name for a given atom identifier, use
<function>XGetAtomName .</function>
<!-- .IN "Atom" "getting name" -->
<!-- .IN "XGetAtomName" "" "@DEF@" -->
<indexterm><primary>Atom</primary><secondary>getting name</secondary></indexterm>
<indexterm significance="preferred"><primary>XGetAtomName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1426,8 +1426,8 @@ error.
<!-- .sp -->
To return the names for an array of atom identifiers, use
<function>XGetAtomNames .</function>
<!-- .IN "Atom" "getting name" -->
<!-- .IN "XGetAtomNames" "" "@DEF@" -->
<indexterm><primary>Atom</primary><secondary>getting name</secondary></indexterm>
<indexterm significance="preferred"><primary>XGetAtomNames</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1540,11 +1540,11 @@ communication (see chapter 14). <!-- xref -->
<!-- .sp -->
To obtain the type, format, and value of a property of a given window, use
<function>XGetWindowProperty .</function>
<!-- .IN "Property" "getting" -->
<indexterm><primary>Property</primary><secondary>getting</secondary></indexterm>
</para>
<para>
<!-- .LP -->
<!-- .IN "XGetWindowProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWindowProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1823,8 +1823,8 @@ errors.
<!-- .sp -->
To obtain a given window's property list, use
<function>XListProperties .</function>
<!-- .IN "Property" "listing" -->
<!-- .IN "XListProperties" "" "@DEF@" -->
<indexterm><primary>Property</primary><secondary>listing</secondary></indexterm>
<indexterm significance="preferred"><primary>XListProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1891,13 +1891,13 @@ error.
<!-- .sp -->
To change a property of a given window, use
<function>XChangeProperty .</function>
<!-- .IN "Property" "changing" -->
<!-- .IN "Property" "appending" -->
<!-- .IN "Property" "prepending" -->
<!-- .IN "Property" "replacing" -->
<!-- .IN "Property" "format" -->
<!-- .IN "Property" "type" -->
<!-- .IN "XChangeProperty" "" "@DEF@" -->
<indexterm><primary>Property</primary><secondary>changing</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>appending</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>prepending</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>replacing</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>format</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>type</secondary></indexterm>
<indexterm significance="preferred"><primary>XChangeProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2098,7 +2098,7 @@ To rotate a window's property list, use
</para>
<para>
<!-- .LP -->
<!-- .IN "XRotateWindowProperties" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRotateWindowProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2211,8 +2211,8 @@ errors.
<!-- .sp -->
To delete a property on a given window, use
<function>XDeleteProperty .</function>
<!-- .IN "Property" "deleting" -->
<!-- .IN "XDeleteProperty" "" "@DEF@" -->
<indexterm><primary>Property</primary><secondary>deleting</secondary></indexterm>
<indexterm significance="preferred"><primary>XDeleteProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2285,7 +2285,7 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Selection" -->
<indexterm><primary>Selection</primary></indexterm>
Selections are one method used by applications to exchange data.
By using the property mechanism,
applications can exchange data of arbitrary types and can negotiate
@ -2334,8 +2334,8 @@ The protocol does not constrain the semantics.
<!-- .sp -->
To set the selection owner, use
<function>XSetSelectionOwner .</function>
<!-- .IN "Selection" "setting the owner" -->
<!-- .IN "XSetSelectionOwner" "" "@DEF@" -->
<indexterm><primary>Selection</primary><secondary>setting the owner</secondary></indexterm>
<indexterm significance="preferred"><primary>XSetSelectionOwner</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2457,8 +2457,8 @@ errors.
<!-- .sp -->
To return the selection owner, use
<function>XGetSelectionOwner .</function>
<!-- .IN "Selection" "getting the owner" -->
<!-- .IN "XGetSelectionOwner" "" "@DEF@" -->
<indexterm><primary>Selection</primary><secondary>getting the owner</secondary></indexterm>
<indexterm significance="preferred"><primary>XGetSelectionOwner</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2519,8 +2519,8 @@ error.
<!-- .sp -->
To request conversion of a selection, use
<function>XConvertSelection .</function>
<!-- .IN "Selection" "converting" -->
<!-- .IN "XConvertSelection" "" "@DEF@" -->
<indexterm><primary>Selection</primary><secondary>converting</secondary></indexterm>
<indexterm significance="preferred"><primary>XConvertSelection</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

20
specs/libX11/CH05.xml
View file

@ -19,7 +19,7 @@ A bitmap is a single bit-plane pixmap.
<!-- .sp -->
To create a pixmap of a given size, use
<function>XCreatePixmap .</function>
<!-- .IN "XCreatePixmap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreatePixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -131,7 +131,7 @@ errors.
<!-- .sp -->
To free all storage associated with a specified pixmap, use
<function>XFreePixmap .</function>
<!-- .IN "XFreePixmap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreePixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -206,7 +206,7 @@ The hotspot defines the point on the cursor that is reported
when a pointer event occurs.
There may be limitations imposed by the hardware on
cursors as to size and whether a mask is implemented.
<!-- .IN "XQueryBestCursor" -->
<indexterm><primary>XQueryBestCursor</primary></indexterm>
<function>XQueryBestCursor</function>
can be used to find out what sizes are possible.
There is a standard font for creating cursors, but
@ -223,7 +223,7 @@ To create a cursor from the standard cursor font, use
#include &lt;X11/cursorfont.h&gt;
</para>
<!-- .IN "XCreateFontCursor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateFontCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -290,7 +290,7 @@ errors.
<!-- .sp -->
To create a cursor from font glyphs, use
<function>XCreateGlyphCursor .</function>
<!-- .IN "XCreateGlyphCursor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateGlyphCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -429,7 +429,7 @@ errors.
To create a cursor from two bitmaps,
use
<function>XCreatePixmapCursor .</function>
<!-- .IN "XCreatePixmapCursor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreatePixmapCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -576,7 +576,7 @@ errors.
<!-- .sp -->
To determine useful cursor sizes, use
<function>XQueryBestCursor .</function>
<!-- .IN "XQueryBestCursor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryBestCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -664,7 +664,7 @@ The
<function>XQueryBestCursor</function>
function provides a way to find out what size cursors are actually
possible on the display.
<!-- .IN "Cursor" "limitations" -->
<indexterm ><primary>Cursor</primary><secondary>limitations</secondary></indexterm>
It returns the largest size that can be displayed.
Applications should be prepared to use smaller cursors on displays that
cannot support large ones.
@ -681,7 +681,7 @@ error.
<!-- .sp -->
To change the color of a given cursor, use
<function>XRecolorCursor .</function>
<!-- .IN "XRecolorCursor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRecolorCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -759,7 +759,7 @@ error.
<!-- .sp -->
To free (destroy) a given cursor, use
<function>XFreeCursor .</function>
<!-- .IN "XFreeCursor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

434
specs/libX11/CH06.xml
View file

@ -154,7 +154,7 @@ The
<function>DefaultVisual </function>
macro
returns the default visual type for the specified screen.
<!-- .IN "Color map" -->
<indexterm><primary>Color map</primary></indexterm>
Possible visual types are
<function>StaticGray , </function>
<function>GrayScale , </function>
@ -178,7 +178,7 @@ structure, which contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XColor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XColor</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -200,7 +200,7 @@ display hardware.
The server scales these values down to the range used by the hardware.
Black is represented by (0,0,0),
and white is represented by (65535,65535,65535).
<!-- .IN "Color" -->
<indexterm><primary>Color</primary></indexterm>
In some functions,
the flags member controls which of the red, green, and blue members is used
and can be the inclusive OR of zero or more of
@ -225,7 +225,7 @@ structure contains pixel
and color specification information (the spec member in the
<function>XcmsColor</function>
structure).
<!-- .IN "XcmsColor" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsColor</primary></indexterm>
<!-- .sM -->
</para>
<para>
@ -301,7 +301,7 @@ and
Data types that describe the color specification encoding for the various
color spaces are defined as follows:
<!-- .sM -->
<!-- .IN "XcmsRGB" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsRGB</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -316,7 +316,7 @@ typedef struct {
unsigned short blue; /* 0x0000 to 0xffff */
} XcmsRGB; /* RGB Device */
</literallayout>
<!-- .IN "XcmsRGBi" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsRGBi</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -329,7 +329,7 @@ typedef struct {
XcmsFloat blue; /* 0.0 to 1.0 */
} XcmsRGBi; /* RGB Intensity */
</literallayout>
<!-- .IN "XcmsCIEXYZ" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIEXYZ</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -342,7 +342,7 @@ typedef struct {
XcmsFloat Z;
} XcmsCIEXYZ; /* CIE XYZ */
</literallayout>
<!-- .IN "XcmsCIEuvY" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIEuvY</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -355,7 +355,7 @@ typedef struct {
XcmsFloat Y; /* 0.0 to 1.0 */
} XcmsCIEuvY; /* CIE u'v'Y */
</literallayout>
<!-- .IN "XcmsCIExyY" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIExyY</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -368,7 +368,7 @@ typedef struct {
XcmsFloat Y; /* 0.0 to 1.0 */
} XcmsCIExyY; /* CIE xyY */
</literallayout>
<!-- .IN "XcmsCIELab" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIELab</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -381,7 +381,7 @@ typedef struct {
XcmsFloat b_star;
} XcmsCIELab; /* CIE L*a*b* */
</literallayout>
<!-- .IN "XcmsCIELuv" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIELuv</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -394,7 +394,7 @@ typedef struct {
XcmsFloat v_star;
} XcmsCIELuv; /* CIE L*u*v* */
</literallayout>
<!-- .IN "XcmsTekHVC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsTekHVC</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -407,7 +407,7 @@ typedef struct {
XcmsFloat C; /* 0.0 to 100.0 */
} XcmsTekHVC; /* TekHVC */
</literallayout>
<!-- .IN "XcmsPad" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsPad</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -697,10 +697,10 @@ When Xlib converts device-independent color specifications
into device-dependent specifications and vice versa,
it uses knowledge about the color limitations of the screen hardware.
This information, typically called the device profile,
<!-- .IN "Device profile" -->
<indexterm><primary>Device profile</primary></indexterm>
is available in a Color Conversion Context (CCC).
<!-- .IN "Color Conversion Context" -->
<!-- .IN "CCC" -->
<indexterm><primary>Color Conversion Context</primary></indexterm>
<indexterm><primary>CCC</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -708,7 +708,7 @@ Because a specified color may be outside the color gamut of the target screen
and the white point associated with the color specification may differ
from the white point inherent to the screen,
Xlib applies gamut mapping when it encounters certain conditions:
<!-- .IN "White point" -->
<indexterm><primary>White point</primary></indexterm>
</para>
<itemizedlist>
<listitem>
@ -732,10 +732,10 @@ which in turn are used by the color space conversion routines.
Client data is also stored in the CCC for each callback.
The CCC also contains the white point the client assumes to be
associated with color specifications (that is, the Client White Point).
<!-- .IN "Client White Point" -->
<!-- .IN "Gamut compression" -->
<!-- .IN "Gamut handling" -->
<!-- .IN "White point adjustment" -->
<indexterm><primary>Client White Point</primary></indexterm>
<indexterm><primary>Gamut compression</primary></indexterm>
<indexterm><primary>Gamut handling</primary></indexterm>
<indexterm><primary>White point adjustment</primary></indexterm>
The client can specify the gamut handling callbacks and client data
as well as the Client White Point.
Xlib does not preclude the X client from performing other
@ -747,17 +747,17 @@ other than white adjustment and gamut compression.
<!-- .LP -->
Associated with each colormap is an initial CCC transparently generated by
Xlib.
<!-- .IN "Color Conversion Context" "creation" -->
<indexterm><primary>Color Conversion Context</primary><secondary>creation</secondary></indexterm>
Therefore,
when you specify a colormap as an argument to an Xlib function,
you are indirectly specifying a CCC.
<!-- .IN "CCC" "of colormap" -->
<!-- .IN "Color Conversion Context" "of colormap" -->
<indexterm><primary>CCC</primary><secondary>of colormap</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>of colormap</secondary></indexterm>
There is a default CCC associated with each screen.
Newly created CCCs inherit attributes from the default CCC,
so the default CCC attributes can be modified to affect new CCCs.
<!-- .IN "CCC" "default" -->
<!-- .IN "Color Conversion Context" "default" -->
<indexterm><primary>CCC</primary><secondary>default</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>default</secondary></indexterm>
</para>
<para>
<!-- .LP -->
@ -803,7 +803,7 @@ or in the CCC indirectly specified by means of the colormap argument.
<!-- .LP -->
To create a colormap for a screen, use
<function>XCreateColormap .</function></para>
<!-- .IN "XCreateColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -952,7 +952,7 @@ errors.
To create a new colormap when the allocation out of a previously
shared colormap has failed because of resource exhaustion, use
<function>XCopyColormapAndFree .</function>
<!-- .IN "XCopyColormapAndFree" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCopyColormapAndFree</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1028,7 +1028,7 @@ errors.
<!-- .sp -->
To destroy a colormap, use
<function>XFreeColormap .</function>
<!-- .IN "XFreeColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeColormap</primary></indexterm>
</para>
<!-- .sM -->
<funcsynopsis>
@ -1106,8 +1106,8 @@ error.
<!-- .sp -->
To map a color name to an RGB value, use
<function>XLookupColor .</function>
<!-- .IN "Color" "naming" -->
<!-- .IN "XLookupColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>naming</secondary></indexterm>
<indexterm significance="preferred"><primary>XLookupColor</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -1204,8 +1204,8 @@ error.
To map a color name to the exact RGB value, use
<function>XParseColor .</function>
</para>
<!-- .IN "Color" "naming" -->
<!-- .IN "XParseColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>naming</secondary></indexterm>
<indexterm significance="preferred"><primary>XParseColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1294,8 +1294,8 @@ error.
To map a color name to a value in an arbitrary color space, use
<function>XcmsLookupColor .</function>
</para>
<!-- .IN "Color" "naming" -->
<!-- .IN "XcmsLookupColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>naming</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsLookupColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1424,9 +1424,9 @@ There are two ways of allocating color cells:
explicitly as read-only entries, one pixel value at a time,
or read/write,
where you can allocate a number of color cells and planes simultaneously.
<!-- .IN "Read-only colormap cells" -->
<indexterm><primary>Read-only colormap cells</primary></indexterm>
A read-only cell has its RGB value set by the server.
<!-- .IN "Read/write colormap cells" -->
<indexterm><primary>Read/write colormap cells</primary></indexterm>
Read/write cells do not have defined colors initially;
functions described in the next section must be used to store values into them.
Although it is possible for any client to store values into a read/write
@ -1448,10 +1448,10 @@ times, the server counts each such allocation, not just the first one.
To allocate a read-only color cell with an RGB value, use
<function>XAllocColor .</function>
</para>
<!-- .IN "Allocation" "read-only colormap cells" -->
<!-- .IN "Read-only colormap cells" "allocating" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "XAllocColor" "" "@DEF@" -->
<indexterm><primary>Allocation</primary><secondary>read-only colormap cells</secondary></indexterm>
<indexterm><primary>Read-only colormap cells</primary><secondary>allocating</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm significance="preferred"><primary>XAllocColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1510,10 +1510,10 @@ The corresponding colormap cell is read-only.
In addition,
<function>XAllocColor</function>
returns nonzero if it succeeded or zero if it failed.
<!-- .IN "Color map" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "Allocation" "colormap" -->
<!-- .IN "read-only colormap cells" -->
<indexterm><primary>Color map</primary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm><primary>Allocation</primary><secondary>colormap</secondary></indexterm>
<indexterm><primary>read-only colormap cells</primary></indexterm>
Multiple clients that request the same effective RGB value can be assigned
the same read-only entry, thus allowing entries to be shared.
When the last client deallocates a shared cell, it is deallocated.
@ -1538,10 +1538,10 @@ delim %%
To allocate a read-only color cell with a color in arbitrary format, use
<function>XcmsAllocColor .</function>
</para>
<!-- .IN "Allocation" "read-only colormap cells" -->
<!-- .IN "Read-only colormap cells" "allocating" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "XcmsAllocColor" "" "@DEF@" -->
<indexterm><primary>Allocation</primary><secondary>read-only colormap cells</secondary></indexterm>
<indexterm><primary>Read-only colormap cells</primary><secondary>allocating</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsAllocColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1642,11 +1642,11 @@ To allocate a read-only color cell using a color name and return the closest
color supported by the hardware in RGB format, use
<function>XAllocNamedColor .</function>
</para>
<!-- .IN "Allocation" "read-only colormap cells" -->
<!-- .IN "Read-only colormap cells" "allocating" -->
<!-- .IN "Color" "naming" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "XAllocNamedColor" "" "@DEF@" -->
<indexterm><primary>Allocation</primary><secondary>read-only colormap cells</secondary></indexterm>
<indexterm><primary>Read-only colormap cells</primary><secondary>allocating</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>naming</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm significance="preferred"><primary>XAllocNamedColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1747,11 +1747,11 @@ To allocate a read-only color cell using a color name and return the closest
color supported by the hardware in an arbitrary format, use
<function>XcmsAllocNamedColor .</function>
</para>
<!-- .IN "Allocation" "read-only colormap cells" -->
<!-- .IN "Read-only colormap cells" "allocating" -->
<!-- .IN "Color" "naming" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "XcmsAllocNamedColor" "" "@DEF@" -->
<indexterm><primary>Allocation</primary><secondary>read-only colormap cells</secondary></indexterm>
<indexterm><primary>Read-only colormap cells</primary><secondary>allocating</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>naming</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsAllocNamedColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1897,10 +1897,10 @@ To allocate read/write color cell and color plane combinations for a
model, use
<function>XAllocColorCells .</function>
</para>
<!-- .IN "Read/write colormap cells" "allocating" -->
<!-- .IN "Allocation" "read/write colormap cells" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "XAllocColorCells" "" "@DEF@" -->
<indexterm><primary>Read/write colormap cells</primary><secondary>allocating</secondary></indexterm>
<indexterm><primary>Allocation</primary><secondary>read/write colormap cells</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm significance="preferred"><primary>XAllocColorCells</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2053,10 +2053,10 @@ To allocate read/write color resources for a
model, use
<function>XAllocColorPlanes .</function>
</para>
<!-- .IN "Read/write colormap planes" "allocating" -->
<!-- .IN "Allocation" "read/write colormap planes" -->
<!-- .IN "Color" "allocation" -->
<!-- .IN "XAllocColorPlanes" "" "@DEF@" -->
<indexterm><primary>Read/write colormap planes</primary><secondary>allocating</secondary></indexterm>
<indexterm><primary>Allocation</primary><secondary>read/write colormap planes</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>allocation</secondary></indexterm>
<indexterm significance="preferred"><primary>XAllocColorPlanes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2251,11 +2251,11 @@ errors.
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "Freeing" "colors" -->
<indexterm><primary>Freeing</primary><secondary>colors</secondary></indexterm>
To free colormap cells, use
<function>XFreeColors .</function>
<!-- .IN "XFreeColors" "" "@DEF@" -->
<!-- .IN "Color" "deallocation" -->
<indexterm significance="preferred"><primary>XFreeColors</primary></indexterm>
<indexterm><primary>Color</primary><secondary>deallocation</secondary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -2336,10 +2336,10 @@ The set of all pixels is produced by ORing together subsets of
the planes argument with the pixels.
The request frees all of these pixels that
were allocated by the client (using
<!-- .IN XAllocColor -->
<!-- .IN XAllocNamedColor -->
<!-- .IN XAllocColorCells -->
<!-- .IN XAllocColorPlanes -->
<indexterm><primary>XAllocColor</primary></indexterm>
<indexterm><primary>XAllocNamedColor</primary></indexterm>
<indexterm><primary>XAllocColorCells</primary></indexterm>
<indexterm><primary>XAllocColorPlanes</primary></indexterm>
<function>XAllocColor , </function>
<function>XAllocNamedColor ,</function>
<function>XAllocColorCells ,</function>
@ -2396,8 +2396,8 @@ errors.
To store an RGB value in a single colormap cell, use
<function>XStoreColor .</function>
</para>
<!-- .IN "Color" "storing" -->
<!-- .IN "XStoreColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>storing</secondary></indexterm>
<indexterm significance="preferred"><primary>XStoreColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2488,8 +2488,8 @@ errors.
To store multiple RGB values in multiple colormap cells, use
<function>XStoreColors .</function>
</para>
<!-- .IN "Color" "storing" -->
<!-- .IN "XStoreColors" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>storing</secondary></indexterm>
<indexterm significance="preferred"><primary>XStoreColors</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2594,8 +2594,8 @@ errors.
To store a color of arbitrary format in a single colormap cell, use
<function>XcmsStoreColor .</function>
</para>
<!-- .IN "Color" "storing" -->
<!-- .IN "XcmsStoreColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>storing</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsStoreColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2705,8 +2705,8 @@ errors.
To store multiple colors of arbitrary format in multiple colormap cells, use
<function>XcmsStoreColors .</function>
</para>
<!-- .IN "Color" "storing" -->
<!-- .IN "XcmsStoreColors" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>storing</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsStoreColors</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2849,9 +2849,9 @@ errors.
To store a color specified by name in a single colormap cell, use
<function>XStoreNamedColor .</function>
</para>
<!-- .IN "Color" "storing" -->
<!-- .IN "Color" "naming" -->
<!-- .IN "XStoreNamedColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>storing</secondary></indexterm>
<indexterm><primary>Color</primary><secondary>naming</secondary></indexterm>
<indexterm significance="preferred"><primary>XStoreNamedColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2980,8 +2980,8 @@ the one that gets reported is arbitrary.
To query the RGB value of a single colormap cell, use
<function>XQueryColor .</function>
</para>
<!-- .IN "Color" "querying" -->
<!-- .IN "XQueryColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>querying</secondary></indexterm>
<indexterm significance="preferred"><primary>XQueryColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3054,8 +3054,8 @@ errors.
To query the RGB values of multiple colormap cells, use
<function>XQueryColors .</function>
</para>
<!-- .IN "Color" "querying" -->
<!-- .IN "XQueryColors" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>querying</secondary></indexterm>
<indexterm significance="preferred"><primary>XQueryColors</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3144,8 +3144,8 @@ errors.
To query the color of a single colormap cell in an arbitrary format, use
<function>XcmsQueryColor .</function>
</para>
<!-- .IN "Color" "querying" -->
<!-- .IN "XcmsQueryColor" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>querying</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsQueryColor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3233,8 +3233,8 @@ errors.
To query the color of multiple colormap cells in an arbitrary format, use
<function>XcmsQueryColors .</function>
</para>
<!-- .IN "Color" "querying" -->
<!-- .IN "XcmsQueryColors" "" "@DEF@" -->
<indexterm><primary>Color</primary><secondary>querying</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsQueryColors</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3346,11 +3346,11 @@ and query Color Conversion Contexts (CCCs).
<!-- .LP -->
Associated with each colormap is an initial CCC transparently generated by
Xlib.
<!-- .IN "Color Conversion Context" "creation" -->
<indexterm><primary>Color Conversion Context</primary><secondary>creation</secondary></indexterm>
Therefore, when you specify a colormap as an argument to a function,
you are indirectly specifying a CCC.
<!-- .IN "CCC" "of colormap" -->
<!-- .IN "Color Conversion Context" "of colormap" -->
<indexterm><primary>CCC</primary><secondary>of colormap</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>of colormap</secondary></indexterm>
The CCC attributes that can be modified by the X client are:
</para>
<itemizedlist>
@ -3375,8 +3375,8 @@ White point adjustment procedure and client data
The initial values for these attributes are implementation specific.
The CCC attributes for subsequently created CCCs can be defined
by changing the CCC attributes of the default CCC.
<!-- .IN "CCC" "default" -->
<!-- .IN "Color Conversion Context" "default" -->
<indexterm><primary>CCC</primary><secondary>default</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>default</secondary></indexterm>
There is a default CCC associated with each screen.
</para>
<sect2 id="Getting_and_Setting_the_Color_Conversion_Context_of_a_Colormap">
@ -3390,10 +3390,10 @@ There is a default CCC associated with each screen.
To obtain the CCC associated with a colormap, use
<function>XcmsCCCOfColormap .</function>
</para>
<!-- .IN "XcmsCCCOfColormap" "" "@DEF@" -->
<!-- .IN "Colormap" "CCC of" -->
<!-- .IN "CCC" "of colormap" -->
<!-- .IN "Color Conversion Context" "of colormap" -->
<indexterm significance="preferred"><primary>XcmsCCCOfColormap</primary></indexterm>
<indexterm><primary>Colormap</primary><secondary>CCC of</secondary></indexterm>
<indexterm><primary>CCC</primary><secondary>of colormap</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>of colormap</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3445,10 +3445,10 @@ to color functions.
To change the CCC associated with a colormap, use
<function>XcmsSetCCCOfColormap .</function>
</para>
<!-- .IN "XcmsSetCCCOfColormap" "" "@DEF@" -->
<!-- .IN "Colormap" "CCC of" -->
<!-- .IN "CCC" "of colormap" -->
<!-- .IN "Color Conversion Context" "of colormap" -->
<indexterm significance="preferred"><primary>XcmsSetCCCOfColormap</primary></indexterm>
<indexterm><primary>Colormap</primary><secondary>CCC of</secondary></indexterm>
<indexterm><primary>CCC</primary><secondary>of colormap</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>of colormap</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3516,8 +3516,8 @@ creates a new CCC with each new colormap.
<!-- .LP -->
You can change the default CCC attributes for subsequently created CCCs
by changing the CCC attributes of the default CCC.
<!-- .IN "CCC" "default" -->
<!-- .IN "Color Conversion Context" "default" -->
<indexterm><primary>CCC</primary><secondary>default</secondary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>default</secondary></indexterm>
A default CCC is associated with each screen.
<!-- .sp -->
</para>
@ -3526,9 +3526,9 @@ A default CCC is associated with each screen.
To obtain the default CCC for a screen, use
<function>XcmsDefaultCCC .</function>
</para>
<!-- .IN "XcmsDefaultCCC" "" "@DEF@" -->
<!-- .IN "Color Conversion Context" "default" -->
<!-- .IN "CCC" "default" -->
<indexterm significance="preferred"><primary>XcmsDefaultCCC</primary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>default</secondary></indexterm>
<indexterm><primary>CCC</primary><secondary>default</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3588,8 +3588,8 @@ can return.
<!-- .sp -->
</para>
<!-- .LP -->
<!-- .IN "DisplayOfCCC" "" "@DEF@" -->
<!-- .IN "XcmsDisplayOfCCC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DisplayOfCCC</primary></indexterm>
<indexterm significance="preferred"><primary>XcmsDisplayOfCCC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3626,8 +3626,8 @@ Both return the display associated with the specified CCC.
</para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "VisualOfCCC" "" "@DEF@" -->
<!-- .IN "XcmsVisualOfCCC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>VisualOfCCC</primary></indexterm>
<indexterm significance="preferred"><primary>XcmsVisualOfCCC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3663,8 +3663,8 @@ Both return the visual associated with the specified CCC.
<!-- .sp -->
</para>
<!-- .LP -->
<!-- .IN "ScreenNumberOfCCC" "" "@DEF@" -->
<!-- .IN "XcmsScreenNumberOfCCC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ScreenNumberOfCCC</primary></indexterm>
<indexterm significance="preferred"><primary>XcmsScreenNumberOfCCC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3700,8 +3700,8 @@ Both return the number of the screen associated with the specified CCC.
<!-- .sp -->
</para>
<!-- .LP -->
<!-- .IN "ScreenWhitePointOfCCC" "" "@DEF@" -->
<!-- .IN "XcmsScreenWhitePointOfCCC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ScreenWhitePointOfCCC</primary></indexterm>
<indexterm significance="preferred"><primary>XcmsScreenWhitePointOfCCC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3736,8 +3736,8 @@ Both return the white point of the screen associated with the specified CCC.
<!-- .sp -->
</para>
<!-- .LP -->
<!-- .IN "ClientWhitePointOfCCC" "" "@DEF@" -->
<!-- .IN "XcmsClientWhitePointOfCCC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ClientWhitePointOfCCC</primary></indexterm>
<indexterm significance="preferred"><primary>XcmsClientWhitePointOfCCC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3783,8 +3783,8 @@ Both return the Client White Point of the specified CCC.
To set the Client White Point in the CCC, use
<function>XcmsSetWhitePoint .</function>
</para>
<!-- .IN "XcmsSetWhitePoint" "" "@DEF@" -->
<!-- .IN "Client White Point" "of Color Conversion Context" -->
<indexterm significance="preferred"><primary>XcmsSetWhitePoint</primary></indexterm>
<indexterm><primary>Client White Point</primary><secondary>of Color Conversion Context</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3852,10 +3852,10 @@ To set the gamut compression procedure and corresponding client data
in a specified CCC, use
<function>XcmsSetCompressionProc .</function>
</para>
<!-- .IN "XcmsSetCompressionProc" "" "@DEF@" -->
<!-- .IN "Gamut compression" "setting in Color Conversion Context" -->
<!-- .IN "Gamut compression" "procedure" -->
<!-- .IN "Gamut compression" "client data" -->
<indexterm significance="preferred"><primary>XcmsSetCompressionProc</primary></indexterm>
<indexterm><primary>Gamut compression</primary><secondary>setting in Color Conversion Context</secondary></indexterm>
<indexterm><primary>Gamut compression</primary><secondary>procedure</secondary></indexterm>
<indexterm><primary>Gamut compression</primary><secondary>client data</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3922,10 +3922,10 @@ To set the white point adjustment procedure and corresponding client data
in a specified CCC, use
<function>XcmsSetWhiteAdjustProc .</function>
</para>
<!-- .IN "XcmsSetWhiteAdjustProc" "" "@DEF@" -->
<!-- .IN "White point adjustment" "setting in Color Conversion Context" -->
<!-- .IN "White point adjustment" "procedure" -->
<!-- .IN "White point adjustment" "client data" -->
<indexterm significance="preferred"><primary>XcmsSetWhiteAdjustProc</primary></indexterm>
<indexterm><primary>White point adjustment</primary><secondary>setting in Color Conversion Context</secondary></indexterm>
<indexterm><primary>White point adjustment</primary><secondary>procedure</secondary></indexterm>
<indexterm><primary>White point adjustment</primary><secondary>client data</secondary></indexterm>
<funcsynopsis>
<funcprototype>
<funcdef>XcmsWhiteAdjustProc <function>XcmsSetWhiteAdjustProc</function></funcdef>
@ -3999,9 +3999,9 @@ Old CCCs that will not be used by the application should be freed using
To create a CCC, use
<function>XcmsCreateCCC .</function>
</para>
<!-- .IN "XcmsCreateCCC" "" "@DEF@" -->
<!-- .IN "Color Conversion Context" "creation" -->
<!-- .IN "CCC" "creation" -->
<indexterm significance="preferred"><primary>XcmsCreateCCC</primary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>creation</secondary></indexterm>
<indexterm><primary>CCC</primary><secondary>creation</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4126,9 +4126,9 @@ function creates a CCC for the specified display, screen, and visual.
To free a CCC, use
<function>XcmsFreeCCC .</function>
</para>
<!-- .IN "XcmsFreeCCC" "" "@DEF@" -->
<!-- .IN "Color Conversion Context" "freeing" -->
<!-- .IN "CCC" "freeing" -->
<indexterm significance="preferred"><primary>XcmsFreeCCC</primary></indexterm>
<indexterm><primary>Color Conversion Context</primary><secondary>freeing</secondary></indexterm>
<indexterm><primary>CCC</primary><secondary>freeing</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4173,9 +4173,9 @@ To convert an array of color specifications in arbitrary color formats
to a single destination format, use
<function>XcmsConvertColors .</function>
</para>
<!-- .IN "Color conversion" -->
<!-- .IN "Color" "conversion" -->
<!-- .IN "XcmsConvertColors" "" "@DEF@" -->
<indexterm><primary>Color conversion</primary></indexterm>
<indexterm><primary>Color</primary><secondary>conversion</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsConvertColors</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4319,7 +4319,7 @@ If required, the client data is obtained from the CCC.
The gamut compression callback interface must adhere to the
following:
</para>
<!-- .IN "XcmsCompressionProc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCompressionProc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4646,7 +4646,7 @@ No client data is necessary.
<!-- .LP -->
The white point adjustment procedure interface must adhere to the following:
</para>
<!-- .IN "XcmsWhiteAdjustProc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsWhiteAdjustProc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4937,7 +4937,7 @@ This section describes the gamut querying functions that Xlib provides.
These functions allow the client to query the boundary
of the screen's color gamut in terms of the CIE L*a*b*, CIE L*u*v*,
and TekHVC color spaces.
<!-- .IN "Gamut querying" -->
<indexterm><primary>Gamut querying</primary></indexterm>
Functions are also provided that allow you to query
the color specification of:
</para>
@ -4973,7 +4973,7 @@ Black (zero-intensity red, green, and blue)
The white point associated with color specifications passed to
and returned from these gamut querying
functions is assumed to be the Screen White Point.
<!-- .IN "Screen White Point" -->
<indexterm><primary>Screen White Point</primary></indexterm>
This is a reasonable assumption,
because the client is trying to query the screen's color gamut.
</para>
@ -5009,7 +5009,7 @@ To obtain the color specification for black
(zero-intensity red, green, and blue), use
<function>XcmsQueryBlack .</function>
</para>
<!-- .IN "XcmsQueryBlack" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsQueryBlack</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5075,7 +5075,7 @@ To obtain the color specification for blue
(full-intensity blue while red and green are zero), use
<function>XcmsQueryBlue .</function>
</para>
<!-- .IN "XcmsQueryBlue" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsQueryBlue</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5141,7 +5141,7 @@ To obtain the color specification for green
(full-intensity green while red and blue are zero), use
<function>XcmsQueryGreen .</function>
</para>
<!-- .IN "XcmsQueryGreen" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsQueryGreen</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5207,7 +5207,7 @@ To obtain the color specification for red
(full-intensity red while green and blue are zero), use
<function>XcmsQueryRed .</function>
</para>
<!-- .IN "XcmsQueryRed" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsQueryRed</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5273,7 +5273,7 @@ To obtain the color specification for white
(full-intensity red, green, and blue), use
<function>XcmsQueryWhite .</function>
</para>
<!-- .IN "XcmsQueryWhite" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsQueryWhite</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5347,10 +5347,10 @@ delim %%
</para>
<para>
<!-- .LP -->
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "Psychometric Chroma" -->
<!-- .IN "Psychometric Chroma" "maximum" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary><secondary>maximum</secondary></indexterm>
<literallayout class="monospaced">
%CIELab~Psychometric~Chroma ~=~ sqrt(a_star sup 2 ~+~ b_star sup 2 )%
@ -5361,7 +5361,7 @@ To obtain the CIE L*a*b* coordinates of maximum Psychometric Chroma
for a given Psychometric Hue Angle and CIE metric lightness (L*), use
<function>XcmsCIELabQueryMaxC .</function>
</para>
<!-- .IN "XcmsCIELabQueryMaxC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIELabQueryMaxC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5442,10 +5442,10 @@ To obtain the CIE L*a*b* coordinates of maximum CIE metric lightness (L*)
for a given Psychometric Hue Angle and Psychometric Chroma, use
<function>XcmsCIELabQueryMaxL .</function>
</para>
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "CIE metric lightness" "maximum" -->
<!-- .IN "XcmsCIELabQueryMaxL" "" "@DEF@" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsCIELabQueryMaxL</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5531,12 +5531,12 @@ To obtain the CIE L*a*b* coordinates of maximum Psychometric Chroma
for a given Psychometric Hue Angle, use
<function>XcmsCIELabQueryMaxLC .</function>
</para>
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "Psychometric Chroma" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "Psychometric Chroma" "maximum" -->
<!-- .IN "CIE metric lightness" "maximum" -->
<!-- .IN "XcmsCIELabQueryMaxLC" "" "@DEF@" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary><secondary>maximum</secondary></indexterm>
<indexterm><primary>CIE metric lightness</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsCIELabQueryMaxLC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5605,10 +5605,10 @@ To obtain the CIE L*a*b* coordinates of minimum CIE metric lightness (L*)
for a given Psychometric Hue Angle and Psychometric Chroma, use
<function>XcmsCIELabQueryMinL .</function>
</para>
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "CIE metric lightness" "minimum" -->
<!-- .IN "XcmsCIELabQueryMinL" "" "@DEF@" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary><secondary>minimum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsCIELabQueryMinL</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5701,10 +5701,10 @@ delim %%
</para>
<para>
<!-- .LP -->
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "Psychometric Chroma" -->
<!-- .IN "Psychometric Chroma" "maximum" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary><secondary>maximum</secondary></indexterm>
<literallayout class="monospaced">
%CIELuv~Psychometric~Chroma ~=~ sqrt(u_star sup 2 ~+~ v_star sup 2 )%
@ -5718,7 +5718,7 @@ To obtain the CIE L*u*v* coordinates of maximum Psychometric Chroma
for a given Psychometric Hue Angle and CIE metric lightness (L*), use
<function>XcmsCIELuvQueryMaxC .</function>
</para>
<!-- .IN "XcmsCIELuvQueryMaxC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsCIELuvQueryMaxC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5799,10 +5799,10 @@ To obtain the CIE L*u*v* coordinates of maximum CIE metric lightness (L*)
for a given Psychometric Hue Angle and Psychometric Chroma, use
<function>XcmsCIELuvQueryMaxL .</function>
</para>
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "CIE metric lightness" "maximum" -->
<!-- .IN "XcmsCIELuvQueryMaxL" "" "@DEF@" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsCIELuvQueryMaxL</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5888,12 +5888,12 @@ To obtain the CIE L*u*v* coordinates of maximum Psychometric Chroma
for a given Psychometric Hue Angle, use
<function>XcmsCIELuvQueryMaxLC .</function>
</para>
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "Psychometric Chroma" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "Psychometric Chroma" "maximum" -->
<!-- .IN "CIE metric lightness" "maximum" -->
<!-- .IN "XcmsCIELuvQueryMaxLC" "" "@DEF@" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>Psychometric Chroma</primary><secondary>maximum</secondary></indexterm>
<indexterm><primary>CIE metric lightness</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsCIELuvQueryMaxLC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5962,10 +5962,10 @@ To obtain the CIE L*u*v* coordinates of minimum CIE metric lightness (L*)
for a given Psychometric Hue Angle and Psychometric Chroma, use
<function>XcmsCIELuvQueryMinL .</function>
</para>
<!-- .IN "Psychometric Hue Angle" -->
<!-- .IN "CIE metric lightness" -->
<!-- .IN "CIE metric lightness" "minimum" -->
<!-- .IN "XcmsCIELuvQueryMinL" "" "@DEF@" -->
<indexterm><primary>Psychometric Hue Angle</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary></indexterm>
<indexterm><primary>CIE metric lightness</primary><secondary>minimum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsCIELuvQueryMinL</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6054,9 +6054,9 @@ is beyond maximum for the given hue angle.
To obtain the maximum Chroma for a given Hue and Value, use
<function>XcmsTekHVCQueryMaxC .</function>
</para>
<!-- .IN "Chroma" -->
<!-- .IN "Chroma" "maximum" -->
<!-- .IN "XcmsTekHVCQueryMaxC" "" "@DEF@" -->
<indexterm><primary>Chroma</primary></indexterm>
<indexterm><primary>Chroma</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsTekHVCQueryMaxC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6137,9 +6137,9 @@ and Value at which the maximum Chroma was found.
To obtain the maximum Value for a given Hue and Chroma, use
<function>XcmsTekHVCQueryMaxV .</function>
</para>
<!-- .IN "Value" -->
<!-- .IN "Value" "maximum" -->
<!-- .IN "XcmsTekHVCQueryMaxV" "" "@DEF@" -->
<indexterm><primary>Value</primary></indexterm>
<indexterm><primary>Value</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsTekHVCQueryMaxV</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6222,11 +6222,11 @@ To obtain the maximum Chroma and Value at which it is reached
for a specified Hue, use
<function>XcmsTekHVCQueryMaxVC .</function>
</para>
<!-- .IN "Chroma" -->
<!-- .IN "Value" -->
<!-- .IN "Chroma" "maximum" -->
<!-- .IN "Value" "maximum" -->
<!-- .IN "XcmsTekHVCQueryMaxVC" "" "@DEF@" -->
<indexterm><primary>Chroma</primary></indexterm>
<indexterm><primary>Value</primary></indexterm>
<indexterm><primary>Chroma</primary><secondary>maximum</secondary></indexterm>
<indexterm><primary>Value</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsTekHVCQueryMaxVC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6300,11 +6300,11 @@ contain maximum Values for a specified Hue and the
Chroma at which the maximum Values are reached, use
<function>XcmsTekHVCQueryMaxVSamples .</function>
</para>
<!-- .IN "Chroma" -->
<!-- .IN "Value" -->
<!-- .IN "Chroma" "maximum" -->
<!-- .IN "Value" "maximum" -->
<!-- .IN "XcmsTekHVCQueryMaxVSamples" "" "@DEF@" -->
<indexterm><primary>Chroma</primary></indexterm>
<indexterm><primary>Value</primary></indexterm>
<indexterm><primary>Chroma</primary><secondary>maximum</secondary></indexterm>
<indexterm><primary>Value</primary><secondary>maximum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsTekHVCQueryMaxVSamples</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6383,9 +6383,9 @@ space.
To obtain the minimum Value for a given Hue and Chroma, use
<function>XcmsTekHVCQueryMinV .</function>
</para>
<!-- .IN "Value" -->
<!-- .IN "Value" "minimum" -->
<!-- .IN "XcmsTekHVCQueryMinV" "" "@DEF@" -->
<indexterm><primary>Value</primary></indexterm>
<indexterm><primary>Value</primary><secondary>minimum</secondary></indexterm>
<indexterm significance="preferred"><primary>XcmsTekHVCQueryMinV</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6543,7 +6543,7 @@ thus bypassing conversion between CIE u*v*Y and CIE XYZ.
To add a device-independent color space, use
<function>XcmsAddColorSpace .</function>
</para>
<!-- .IN "XcmsAddColorSpace" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsAddColorSpace</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6611,7 +6611,7 @@ To obtain the format associated with the color space
associated with a specified color string prefix, use
<function>XcmsFormatOfPrefix .</function>
</para>
<!-- .IN "XcmsFormatOfPrefix" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsFormatOfPrefix</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6653,7 +6653,7 @@ To obtain the color string prefix associated with the color space
specified by a color format, use
<function>XcmsPrefixOfFormat .</function>
</para>
<!-- .IN "XcmsPrefixOfFormat" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsPrefixOfFormat</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6797,7 +6797,7 @@ The callback in the
structure for parsing a color string for the particular color space must
adhere to the following software interface specification:
</para>
<!-- .IN "XcmsParseStringProc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsParseStringProc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -7079,8 +7079,8 @@ The conversion functions provided by Xlib are:
<!-- .XS -->
<!-- (SN Function Sets -->
<!-- .XE -->
<!-- .IN "Function set" -->
<!-- .IN "Function set" "LINEAR_RGB" -->
<indexterm><primary>Function set</primary></indexterm>
<indexterm><primary>Function set</primary><secondary>LINEAR_RGB</secondary></indexterm>
<para>
<!-- .LP -->
Functions to convert between device-dependent color spaces
@ -7096,7 +7096,7 @@ The function set also contains a function that reads
color characterization data off root window properties.
It is this characterization data that will differ between devices within
a class of output devices.
<!-- .IN "Device Color Characterization" -->
<indexterm><primary>Device Color Characterization</primary></indexterm>
For details about how color characterization data is
stored in root window properties,
see the section on Device Color Characterization in the
@ -7119,7 +7119,7 @@ its corresponding data may be stored on different root window properties.
To add a function set, use
<function>XcmsAddFunctionSet .</function>
</para>
<!-- .IN "XcmsAddFunctionSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsAddFunctionSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -7248,7 +7248,7 @@ structure for a particular screen.
<!-- .LP -->
The screen initialization callback must adhere to the following software
interface specification:
<!-- .IN "XcmsScreenInitProc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XcmsScreenInitProc</primary></indexterm>
<!-- .sM -->
</para>
<funcsynopsis>
@ -7308,8 +7308,8 @@ screen's root window.
It then initializes the specified
<function>XcmsPerScrnInfo</function>
structure.
<!-- .IN "Device profile" -->
<!-- .IN "Color Characterization Data" -->
<indexterm><primary>Device profile</primary></indexterm>
<indexterm><primary>Color Characterization Data</primary></indexterm>
If successful, the procedure fills in the
<function>XcmsPerScrnInfo</function>
structure as follows:

70
specs/libX11/CH07.xml
View file

@ -257,9 +257,9 @@ to be useful in a window.
<para>
<!-- .LP -->
<!-- .IN "Display Functions" "" "@DEF@" -->
<!-- .IN "Source" "" "@DEF@" -->
<!-- .IN "Destination" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Display Functions</primary></indexterm>
<indexterm significance="preferred"><primary>Source</primary></indexterm>
<indexterm significance="preferred"><primary>Destination</primary></indexterm>
The function attributes of a GC are used when you update a section of
a drawable (the destination) with bits from somewhere else (the source).
The function in a GC defines how the new destination bits are to be
@ -377,10 +377,10 @@ are:
<para>
<!-- .LP -->
Many graphics operations depend on either pixel values or planes in a GC.
<!-- .IN "Pixel value" -->
<indexterm><primary>Pixel value</primary></indexterm>
The planes attribute is of type long, and it specifies which planes of the
destination are to be modified, one bit per plane.
<!-- .IN "Plane" "mask" -->
<indexterm><primary>Plane</primary><secondary>mask</secondary></indexterm>
A monochrome display has only one plane and
will be the least significant bit of the word.
As planes are added to the display hardware, they will occupy more
@ -956,8 +956,8 @@ requests (and any similar requests defined by extensions).
To create a new GC that is usable on a given screen with a
depth of drawable, use
<function>XCreateGC .</function>
<!-- .IN "Graphics context" "initializing" -->
<!-- .IN "XCreateGC" "" "@DEF@" -->
<indexterm><primary>Graphics context</primary><secondary>initializing</secondary></indexterm>
<indexterm significance="preferred"><primary>XCreateGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1045,7 +1045,7 @@ errors.
<!-- .sp -->
To copy components from a source GC to a destination GC, use
<function>XCopyGC .</function>
<!-- .IN "XCopyGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCopyGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1131,7 +1131,7 @@ errors.
<!-- .sp -->
To change the components in a given GC, use
<function>XChangeGC .</function>
<!-- .IN "XChangeGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChangeGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1227,7 +1227,7 @@ errors.
<!-- .sp -->
To obtain components of a given GC, use
<function>XGetGCValues .</function>
<!-- .IN "XGetGCValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetGCValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1339,7 +1339,7 @@ if the component has never been explicitly set by the client.
<!-- .sp -->
To free a given GC, use
<function>XFreeGC .</function>
<!-- .IN "XFreeGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1393,7 +1393,7 @@ To obtain the
<function>GContext </function>
resource ID for a given GC, use
<function>XGContextFromGC .</function>
<!-- .IN "XGContextFromGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGContextFromGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1429,7 +1429,7 @@ An example might be when a protocol extension uses the GC indirectly,
in such a way that the extension interface cannot know what GC will be used.
To force sending GC component changes, use
<function>XFlushGC .</function>
<!-- .IN "XFlushGC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFlushGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1523,7 +1523,7 @@ Arc mode, subwindow mode, and graphics exposure components
To set the foreground, background, plane mask, and function components
for a given GC, use
<function>XSetState .</function>
<!-- .IN "XSetState" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetState</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1616,7 +1616,7 @@ errors.
<!-- .sp -->
To set the foreground of a given GC, use
<function>XSetForeground .</function>
<!-- .IN "XSetForeground" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetForeground</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1675,7 +1675,7 @@ errors.
<!-- .sp -->
To set the background of a given GC, use
<function>XSetBackground .</function>
<!-- .IN "XSetBackground" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetBackground</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1734,7 +1734,7 @@ errors.
<!-- .sp -->
To set the display function in a given GC, use
<function>XSetFunction .</function>
<!-- .IN "XSetFunction" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetFunction</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1794,7 +1794,7 @@ errors.
<!-- .sp -->
To set the plane mask of a given GC, use
<function>XSetPlaneMask .</function>
<!-- .IN "XSetPlaneMask" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetPlaneMask</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1859,7 +1859,7 @@ errors.
<!-- .LP -->
To set the line drawing components of a given GC, use
<function>XSetLineAttributes .</function>
<!-- .IN "XSetLineAttributes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetLineAttributes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1968,7 +1968,7 @@ errors.
<!-- .sp -->
To set the dash-offset and dash-list for dashed line styles of a given GC, use
<function>XSetDashes .</function>
<!-- .IN "XSetDashes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetDashes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2097,7 +2097,7 @@ errors.
<!-- .LP -->
To set the fill-style of a given GC, use
<function>XSetFillStyle .</function>
<!-- .IN "XSetFillStyle" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetFillStyle</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2163,7 +2163,7 @@ errors.
<!-- .sp -->
To set the fill-rule of a given GC, use
<function>XSetFillRule .</function>
<!-- .IN "XSetFillRule" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetFillRule</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2243,7 +2243,7 @@ as well as to set the tile or stipple shape and the tile or stipple origin.
<!-- .sp -->
To obtain the best size of a tile, stipple, or cursor, use
<function>XQueryBestSize .</function>
<!-- .IN "XQueryBestSize" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryBestSize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2386,7 +2386,7 @@ errors.
<!-- .sp -->
To obtain the best fill tile shape, use
<function>XQueryBestTile .</function>
<!-- .IN "XQueryBestTile" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryBestTile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2492,7 +2492,7 @@ errors.
<!-- .sp -->
To obtain the best stipple shape, use
<function>XQueryBestStipple .</function>
<!-- .IN "XQueryBestStipple" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryBestStipple</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2598,7 +2598,7 @@ errors.
<!-- .sp -->
To set the fill tile of a given GC, use
<function>XSetTile .</function>
<!-- .IN "XSetTile" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetTile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2666,7 +2666,7 @@ errors.
<!-- .sp -->
To set the stipple of a given GC, use
<function>XSetStipple .</function>
<!-- .IN "XSetStipple" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetStipple</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2734,7 +2734,7 @@ errors.
<!-- .sp -->
To set the tile or stipple origin of a given GC, use
<function>XSetTSOrigin .</function>
<!-- .IN "XSetTSOrigin" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetTSOrigin</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2815,7 +2815,7 @@ errors.
<!-- .LP -->
To set the current font of a given GC, use
<function>XSetFont .</function>
<!-- .IN "XSetFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2886,7 +2886,7 @@ and the clip-mask or set the clip-mask to a list of rectangles.
<!-- .sp -->
To set the clip-origin of a given GC, use
<function>XSetClipOrigin .</function>
<!-- .IN "XSetClipOrigin" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetClipOrigin</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2961,7 +2961,7 @@ errors.
<!-- .sp -->
To set the clip-mask of a given GC to the specified pixmap, use
<function>XSetClipMask .</function>
<!-- .IN "XSetClipMask" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetClipMask</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3029,7 +3029,7 @@ errors.
<!-- .sp -->
To set the clip-mask of a given GC to the specified list of rectangles, use
<function>XSetClipRectangles .</function>
<!-- .IN "XSetClipRectangles" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetClipRectangles</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3203,7 +3203,7 @@ see section 16.5.
<!-- .LP -->
To set the arc mode of a given GC, use
<function>XSetArcMode .</function>
<!-- .IN "XSetArcMode" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetArcMode</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3267,7 +3267,7 @@ errors.
<!-- .sp -->
To set the subwindow mode of a given GC, use
<function>XSetSubwindowMode .</function>
<!-- .IN "XSetSubwindowMode" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetSubwindowMode</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3331,7 +3331,7 @@ errors.
<!-- .sp -->
To set the graphics-exposures flag of a given GC, use
<function>XSetGraphicsExposures .</function>
<!-- .IN "XSetGraphicsExposures" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetGraphicsExposures</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

210
specs/libX11/CH08.xml
View file

@ -36,9 +36,9 @@ which sets the pixmap to a known value.
<!-- .sp -->
To clear a rectangular area of a given window, use
<function>XClearArea .</function>
<!-- .IN "Areas" "clearing" -->
<!-- .IN "Clearing" "areas" -->
<!-- .IN "XClearArea" "" "@DEF@" -->
<indexterm><primary>Areas</primary><secondary>clearing</secondary></indexterm>
<indexterm><primary>Clearing</primary><secondary>areas</secondary></indexterm>
<indexterm significance="preferred"><primary>XClearArea</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -178,9 +178,9 @@ errors.
<!-- .sp -->
To clear the entire area in a given window, use
<function>XClearWindow .</function>
<!-- .IN "Window" "clearing" -->
<!-- .IN "Clearing" "windows" -->
<!-- .IN "XClearWindow" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>clearing</secondary></indexterm>
<indexterm><primary>Clearing</primary><secondary>windows</secondary></indexterm>
<indexterm significance="preferred"><primary>XClearWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -262,9 +262,9 @@ Xlib provides functions that you can use to copy an area or a bit plane.
To copy an area between drawables of the same
root and depth, use
<function>XCopyArea .</function>
<!-- .IN "Areas" "copying" -->
<!-- .IN "Copying" "areas" -->
<!-- .IN "XCopyArea" "" "@DEF@" -->
<indexterm><primary>Areas</primary><secondary>copying</secondary></indexterm>
<indexterm><primary>Copying</primary><secondary>areas</secondary></indexterm>
<indexterm significance="preferred"><primary>XCopyArea</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -457,9 +457,9 @@ errors.
<!-- .LP -->
To copy a single bit plane of a given drawable, use
<function>XCopyPlane .</function>
<!-- .IN "Plane" "copying" -->
<!-- .IN "Copying" "planes" -->
<!-- .IN "XCopyPlane" "" "@DEF@" -->
<indexterm><primary>Plane</primary><secondary>copying</secondary></indexterm>
<indexterm><primary>Copying</primary><secondary>planes</secondary></indexterm>
<indexterm significance="preferred"><primary>XCopyPlane</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -686,7 +686,7 @@ use these structures:
</para>
<para>
<!-- .LP -->
<!-- .IN "XSegment" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSegment</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i -->
@ -699,7 +699,7 @@ typedef struct {
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XPoint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPoint</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i -->
@ -712,7 +712,7 @@ typedef struct {
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XRectangle" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRectangle</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i -->
@ -726,7 +726,7 @@ typedef struct {
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "XArc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XArc</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -754,16 +754,16 @@ for these values.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Points" "drawing" -->
<!-- .IN "Drawing" "points" -->
<!-- .IN "XDrawPoints" -->
<!-- .IN "XDrawPoint" -->
<indexterm><primary>Points</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>points</secondary></indexterm>
<indexterm><primary>XDrawPoints</primary></indexterm>
<indexterm><primary>XDrawPoint</primary></indexterm>
</para>
<para>
<!-- .LP -->
To draw a single point in a given drawable, use
<function>XDrawPoint .</function>
<!-- .IN "XDrawPoint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawPoint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -835,7 +835,7 @@ Specify the x and y coordinates where you want the point drawn.
<!-- .sp -->
To draw multiple points in a given drawable, use
<function>XDrawPoints .</function>
<!-- .IN "XDrawPoints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawPoints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -964,19 +964,19 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Lines" "drawing" -->
<!-- .IN "Drawing" "lines" -->
<!-- .IN "XDrawLine" -->
<!-- .IN "XDrawLines" -->
<!-- .IN "Polygons" "drawing" -->
<!-- .IN "Drawing" "polygons" -->
<!-- .IN "XDrawSegments" -->
<indexterm><primary>Lines</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>lines</secondary></indexterm>
<indexterm><primary>XDrawLine</primary></indexterm>
<indexterm><primary>XDrawLines</primary></indexterm>
<indexterm><primary>Polygons</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>polygons</secondary></indexterm>
<indexterm><primary>XDrawSegments</primary></indexterm>
</para>
<para>
<!-- .LP -->
To draw a single line between two points in a given drawable, use
<function>XDrawLine .</function>
<!-- .IN "XDrawLine" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawLine</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1070,7 +1070,7 @@ Specify the points (x1, y1) and (x2, y2) to be connected.
<!-- .sp -->
To draw multiple lines in a given drawable, use
<function>XDrawLines .</function>
<!-- .IN "XDrawLines" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawLines</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1158,7 +1158,7 @@ or
To draw multiple, unconnected lines in a given drawable,
use
<function>XDrawSegments .</function>
<!-- .IN "XDrawSegments" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawSegments</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1319,16 +1319,16 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Rectangles" "drawing" -->
<!-- .IN "Drawing" "rectangles" -->
<!-- .IN "XDrawRectangle" -->
<!-- .IN "XDrawRectangles" -->
<indexterm><primary>Rectangles</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>rectangles</secondary></indexterm>
<indexterm><primary>XDrawRectangle</primary></indexterm>
<indexterm><primary>XDrawRectangles</primary></indexterm>
</para>
<para>
<!-- .LP -->
To draw the outline of a single rectangle in a given drawable, use
<function>XDrawRectangle .</function>
<!-- .IN "XDrawRectangle" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawRectangle</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1425,7 +1425,7 @@ Specify the width and height(Wh.
To draw the outline of multiple rectangles
in a given drawable, use
<function>XDrawRectangles .</function>
<!-- .IN "XDrawRectangles" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawRectangles</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1549,17 +1549,17 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Drawing" "arcs" -->
<!-- .IN "XDrawArc" -->
<!-- .IN "Arcs" "drawing" -->
<!-- .IN "XDrawArcs" -->
<indexterm><primary>Drawing</primary><secondary>arcs</secondary></indexterm>
<indexterm><primary>XDrawArc</primary></indexterm>
<indexterm><primary>Arcs</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>XDrawArcs</primary></indexterm>
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To draw a single arc in a given drawable, use
<function>XDrawArc .</function>
<!-- .IN "XDrawArc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawArc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1679,7 +1679,7 @@ arc, in units of degrees * 64.
<!-- .sp -->
To draw multiple arcs in a given drawable, use
<function>XDrawArcs .</function>
<!-- .IN "XDrawArcs" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawArcs</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1907,17 +1907,17 @@ A single arc or multiple arcs
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Filling" "rectangles" -->
<!-- .IN "XFillRectangle" -->
<!-- .IN "Rectangle" "filling" -->
<!-- .IN "XFillRectangles" -->
<indexterm><primary>Filling</primary><secondary>rectangles</secondary></indexterm>
<indexterm><primary>XFillRectangle</primary></indexterm>
<indexterm><primary>Rectangle</primary><secondary>filling</secondary></indexterm>
<indexterm><primary>XFillRectangles</primary></indexterm>
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To fill a single rectangular area in a given drawable, use
<function>XFillRectangle .</function>
<!-- .IN "XFillRectangle" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFillRectangle</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2014,7 +2014,7 @@ Specify the width and height(Wh.
<!-- .sp -->
To fill multiple rectangular areas in a given drawable, use
<function>XFillRectangles .</function>
<!-- .IN "XFillRectangles" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFillRectangles</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2147,9 +2147,9 @@ errors.
<!-- .sp -->
To fill a polygon area in a given drawable, use
<function>XFillPolygon .</function>
<!-- .IN "Polygons" "filling" -->
<!-- .IN "Filling" "polygon" -->
<!-- .IN "XFillPolygon" "" "@DEF@" -->
<indexterm><primary>Polygons</primary><secondary>filling</secondary></indexterm>
<indexterm><primary>Filling</primary><secondary>polygon</secondary></indexterm>
<indexterm significance="preferred"><primary>XFillPolygon</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2343,12 +2343,12 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XFillArc" -->
<!-- .IN "Arcs" "filling" -->
<!-- .IN "Filling" "arcs" -->
<indexterm><primary>XFillArc</primary></indexterm>
<indexterm><primary>Arcs</primary><secondary>filling</secondary></indexterm>
<indexterm><primary>Filling</primary><secondary>arcs</secondary></indexterm>
To fill a single arc in a given drawable, use
<function>XFillArc .</function>
<!-- .IN "XFillArc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFillArc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2468,7 +2468,7 @@ arc, in units of degrees * 64.
<!-- .sp -->
To fill multiple arcs in a given drawable, use
<function>XFillArcs .</function>
<!-- .IN "XFillArcs" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFillArcs</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2591,7 +2591,7 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Font" -->
<indexterm><primary>Font</primary></indexterm>
A font is a graphical description of a set of characters that are used to
increase efficiency whenever a set of small, similar sized patterns are
repeatedly used.
@ -2665,7 +2665,7 @@ structures contain:
</para>
<para>
<!-- .LP -->
<!-- .IN "XCharStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCharStruct</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
@ -2681,7 +2681,7 @@ typedef struct {
</para>
<para>
<!-- .LP -->
<!-- .IN "XFontProp" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFontProp</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 1i 3i -->
<!-- .ta .5i 1i 3i -->
@ -2693,7 +2693,7 @@ typedef struct {
</para>
<para>
<!-- .LP -->
<!-- .IN "XChar2b" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChar2b</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
@ -2705,7 +2705,7 @@ typedef struct { /* normal 16 bit characters are two bytes */
</para>
<para>
<!-- .LP -->
<!-- .IN "XFontStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFontStruct</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
@ -3003,9 +3003,9 @@ A basic set of font properties is specified in the X Consortium standard
<!-- .LP -->
Xlib provides functions that you can use to load fonts, get font information,
unload fonts, and free font information.
<!-- .IN "Fonts" "getting information" -->
<!-- .IN "Fonts" "unloading" -->
<!-- .IN "Fonts" "freeing font information" -->
<indexterm><primary>Fonts</primary><secondary>getting information</secondary></indexterm>
<indexterm><primary>Fonts</primary><secondary>unloading</secondary></indexterm>
<indexterm><primary>Fonts</primary><secondary>freeing font information</secondary></indexterm>
A few font functions use a
<function>GContext </function>
resource ID or a font ID interchangeably.
@ -3015,7 +3015,7 @@ resource ID or a font ID interchangeably.
<!-- .sp -->
To load a given font, use
<function>XLoadFont .</function>
<!-- .IN "XLoadFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLoadFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3091,7 +3091,7 @@ errors.
<!-- .sp -->
To return information about an available font, use
<function>XQueryFont .</function>
<!-- .IN "XQueryFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3157,7 +3157,7 @@ and
<function>XQueryFont</function>
in a single operation, use
<function>XLoadQueryFont .</function>
<!-- .IN "XLoadQueryFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLoadQueryFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3225,7 +3225,7 @@ or
<function>XLoadQueryFont ,</function>
use
<function>XFreeFont .</function>
<!-- .IN "XFreeFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3282,7 +3282,7 @@ error.
<!-- .sp -->
To return a given font property, use
<function>XGetFontProperty .</function>
<!-- .IN "XGetFontProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetFontProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3354,7 +3354,7 @@ To unload a font that was loaded by
<function>XLoadFont , </function>
use
<function>XUnloadFont .</function>
<!-- .IN "XUnloadFont" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnloadFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3419,7 +3419,7 @@ when querying a font type for a list of available sizes and so on.
<!-- .sp -->
To return a list of the available font names, use
<function>XListFonts .</function>
<!-- .IN "XListFonts" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListFonts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3506,7 +3506,7 @@ when finished with the result to free the memory.
<!-- .sp -->
To free a font name array, use
<function>XFreeFontNames .</function>
<!-- .IN "XFreeFontNames" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeFontNames</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3543,7 +3543,7 @@ or
<!-- .sp -->
To obtain the names and information about available fonts, use
<function>XListFontsWithInfo .</function>
<!-- .IN "XListFontsWithInfo" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListFontsWithInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3650,7 +3650,7 @@ the client should call
<!-- .sp -->
To free font structures and font names, use
<function>XFreeFontInfo .</function>
<!-- .IN "XFreeFontInfo" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeFontInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3723,8 +3723,8 @@ to close the font.
Xlib provides functions that you can use to compute the width,
the logical extents,
and the server information about 8-bit and 2-byte text strings.
<!-- .IN "XTextWidth" -->
<!-- .IN "XTextWidth16" -->
<indexterm><primary>XTextWidth</primary></indexterm>
<indexterm><primary>XTextWidth16</primary></indexterm>
The width is computed by adding the character widths of all the characters.
It does not matter if the font is an 8-bit or 2-byte font.
These functions return the sum of the character metrics in pixels.
@ -3734,7 +3734,7 @@ These functions return the sum of the character metrics in pixels.
<!-- .sp -->
To determine the width of an 8-bit character string, use
<function>XTextWidth .</function>
<!-- .IN "XTextWidth" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextWidth</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3784,7 +3784,7 @@ Specifies the character count in the specified string.
<!-- .sp -->
To determine the width of a 2-byte character string, use
<function>XTextWidth16 .</function>
<!-- .IN "XTextWidth16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextWidth16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3842,7 +3842,7 @@ Specifies the character count in the specified string.
<!-- .LP -->
To compute the bounding box of an 8-bit character string in a given font, use
<function>XTextExtents .</function>
<!-- .IN "XTextExtents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextExtents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3942,7 +3942,7 @@ structure.
<!-- .sp -->
To compute the bounding box of a 2-byte character string in a given font, use
<function>XTextExtents16 .</function>
<!-- .IN "XTextExtents16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextExtents16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4089,7 +4089,7 @@ undefined characters in the string are taken to have all zero metrics.
To query the server for the bounding box of an 8-bit character string in a
given font, use
<function>XQueryTextExtents .</function>
<!-- .IN "XQueryTextExtents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryTextExtents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4201,7 +4201,7 @@ structure.
To query the server for the bounding box of a 2-byte character string
in a given font, use
<function>XQueryTextExtents16 .</function>
<!-- .IN "XQueryTextExtents16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryTextExtents16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4405,7 +4405,7 @@ use the following structures:
</para>
<para>
<!-- .LP -->
<!-- .IN "XTextItem" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextItem</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4420,7 +4420,7 @@ typedef struct {
</para>
<para>
<!-- .LP -->
<!-- .IN "XTextItem16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextItem16</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
@ -4467,14 +4467,14 @@ structure.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Text" "drawing" -->
<!-- .IN "Drawing" "text items" -->
<indexterm><primary>Text</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>text items</secondary></indexterm>
</para>
<para>
<!-- .LP -->
To draw 8-bit characters in a given drawable, use
<function>XDrawText .</function>
<!-- .IN "XDrawText" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawText</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4570,7 +4570,7 @@ Specifies the number of text items in the array.
<!-- .sp -->
To draw 2-byte characters in a given drawable, use
<function>XDrawText16 .</function>
<!-- .IN "XDrawText16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawText16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4726,11 +4726,11 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Strings" "drawing" -->
<!-- .IN "Drawing" "strings" -->
<indexterm><primary>Strings</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>strings</secondary></indexterm>
To draw 8-bit characters in a given drawable, use
<function>XDrawString .</function>
<!-- .IN "XDrawString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4826,7 +4826,7 @@ Specifies the number of characters in the string argument.
<!-- .sp -->
To draw 2-byte characters in a given drawable, use
<function>XDrawString16 .</function>
<!-- .IN "XDrawString16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawString16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4956,21 +4956,21 @@ errors.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Image text" "drawing" -->
<!-- .IN "Drawing" "image text" -->
<indexterm><primary>Image text</primary><secondary>drawing</secondary></indexterm>
<indexterm><primary>Drawing</primary><secondary>image text</secondary></indexterm>
Some applications, in particular terminal emulators, need to
print image text in which both the foreground and background bits of
each character are painted.
This prevents annoying flicker on many displays.
<!-- .IN "XDrawImageString" -->
<!-- .IN "XDrawImageString16" -->
<indexterm><primary>XDrawImageString</primary></indexterm>
<indexterm><primary>XDrawImageString16</primary></indexterm>
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To draw 8-bit image text characters in a given drawable, use
<function>XDrawImageString .</function>
<!-- .IN "XDrawImageString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawImageString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5066,7 +5066,7 @@ Specifies the number of characters in the string argument.
<!-- .sp -->
To draw 2-byte image text characters in a given drawable, use
<function>XDrawImageString16 .</function>
<!-- .IN "XDrawImageString16" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDrawImageString16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5273,7 +5273,7 @@ which describes an image as it exists in the client's memory.
</para>
<para>
<!-- .LP -->
<!-- .IN "XImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XImage</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 1i 3i -->
@ -5311,7 +5311,7 @@ typedef struct _XImage {
<!-- .sp -->
To initialize the image manipulation routines of an image structure, use
<function>XInitImage .</function>
<!-- .IN "XInitImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XInitImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5369,7 +5369,7 @@ or inconsistency in the structure, in which case the image is not changed.
To combine an image with a rectangle of a drawable on the display,
use
<function>XPutImage .</function>
<!-- .IN "XPutImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPutImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5558,7 +5558,7 @@ To return the contents of a rectangle in a given drawable on the display,
use
<function>XGetImage .</function>
This function specifically supports rudimentary screen dumps.
<!-- .IN "XGetImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5745,7 +5745,7 @@ errors.
To copy the contents of a rectangle on the display
to a location within a preexisting image structure, use
<function>XGetSubImage .</function>
<!-- .IN "XGetSubImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetSubImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

72
specs/libX11/CH09.xml
View file

@ -29,7 +29,7 @@ programs. Xlib provides management functions to:
To change a window's parent to another window on the same screen, use
<function>XReparentWindow .</function>
There is no way to move a window between screens.
<!-- .IN "XReparentWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XReparentWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -213,7 +213,7 @@ when they are destroyed.
<!-- .sp -->
To add or remove a window from the client's save-set, use
<function>XChangeSaveSet .</function>
<!-- .IN "XChangeSaveSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChangeSaveSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -288,7 +288,7 @@ errors.
<!-- .sp -->
To add a window to the client's save-set, use
<function>XAddToSaveSet .</function>
<!-- .IN "XAddToSaveSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAddToSaveSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -347,7 +347,7 @@ errors.
<!-- .sp -->
To remove a window from the client's save-set, use
<function>XRemoveFromSaveSet .</function>
<!-- .IN "XRemoveFromSaveSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRemoveFromSaveSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -444,7 +444,7 @@ required list.
<!-- .sp -->
To install a colormap, use
<function>XInstallColormap .</function>
<!-- .IN "XInstallColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XInstallColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -517,7 +517,7 @@ error.
<!-- .sp -->
To uninstall a colormap, use
<function>XUninstallColormap .</function>
<!-- .IN "XUninstallColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUninstallColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -588,7 +588,7 @@ error.
<!-- .sp -->
To obtain a list of the currently installed colormaps for a given screen, use
<function>XListInstalledColormaps .</function>
<!-- .IN "XListInstalledColormaps" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListInstalledColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -670,7 +670,7 @@ search path for a server.
<!-- .sp -->
To set the font search path, use
<function>XSetFontPath .</function>
<!-- .IN "XSetFontPath" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetFontPath</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -748,7 +748,7 @@ error.
<!-- .sp -->
To get the current font search path, use
<function>XGetFontPath .</function>
<!-- .IN "XGetFontPath" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetFontPath</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -800,7 +800,7 @@ To free data returned by
<function>XGetFontPath ,</function>
use
<function>XFreeFontPath .</function>
<!-- .IN "XFreeFontPath" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeFontPath</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -845,8 +845,8 @@ connections by the window system server.
While the server is grabbed,
no processing of requests or close downs on any other connection will occur.
A client closing its connection automatically ungrabs the server.
<!-- .IN "Menus" -->
<!-- .IN "Window" "managers" -->
<indexterm><primary>Menus</primary></indexterm>
<indexterm><primary>Window</primary><secondary>managers</secondary></indexterm>
Although grabbing the server is highly discouraged, it is sometimes necessary.
</para>
<para>
@ -854,9 +854,9 @@ Although grabbing the server is highly discouraged, it is sometimes necessary.
<!-- .sp -->
To grab the server, use
<function>XGrabServer .</function>
<!-- .IN "Server" "grabbing" -->
<!-- .IN "Grabbing" "server" -->
<!-- .IN "XGrabServer" "" "@DEF@" -->
<indexterm><primary>Server</primary><secondary>grabbing</secondary></indexterm>
<indexterm><primary>Grabbing</primary><secondary>server</secondary></indexterm>
<indexterm significance="preferred"><primary>XGrabServer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -892,7 +892,7 @@ You should not grab the X server any more than is absolutely necessary.
<!-- .sp -->
To ungrab the server, use
<function>XUngrabServer .</function>
<!-- .IN "XUngrabServer" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUngrabServer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -934,7 +934,7 @@ Xlib provides a function to cause the connection to
a client to be closed and its resources to be destroyed.
To destroy a client, use
<function>XKillClient .</function>
<!-- .IN "XKillClient" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XKillClient</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1021,7 +1021,7 @@ or to obtain the current screen saver values.
<!-- .sp -->
To set the screen saver mode, use
<function>XSetScreenSaver .</function>
<!-- .IN "XSetScreenSaver" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1156,7 +1156,7 @@ error.
<!-- .sp -->
To force the screen saver on or off, use
<function>XForceScreenSaver .</function>
<!-- .IN "XForceScreenSaver" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XForceScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1222,7 +1222,7 @@ error.
<!-- .sp -->
To activate the screen saver, use
<function>XActivateScreenSaver .</function>
<!-- .IN "XActivateScreenSaver" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XActivateScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1250,7 +1250,7 @@ Specifies the connection to the X server.
<!-- .sp -->
To reset the screen saver, use
<function>XResetScreenSaver .</function>
<!-- .IN "XResetScreenSaver" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XResetScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1278,7 +1278,7 @@ Specifies the connection to the X server.
<!-- .sp -->
To get the current screen saver values, use
<function>XGetScreenSaver .</function>
<!-- .IN "XGetScreenSaver" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1379,8 +1379,8 @@ Change, enable, or disable access
</itemizedlist>
<para>
<!-- .LP -->
<!-- .IN "Access control list" -->
<!-- .IN "Authentication" -->
<indexterm><primary>Access control list</primary></indexterm>
<indexterm><primary>Authentication</primary></indexterm>
X does not provide any protection on a per-window basis.
If you find out the resource ID of a resource, you can manipulate it.
To provide some minimal level of protection, however,
@ -1393,7 +1393,7 @@ leaves host-level access control as the only common mechanism.
</para>
<para>
<!-- .LP -->
<!-- .IN "Default Protection" -->
<indexterm><primary>Default Protection</primary></indexterm>
The initial set of hosts allowed to open connections typically consists of:
</para>
<itemizedlist>
@ -1409,7 +1409,7 @@ On POSIX-conformant systems, each host listed in the
file.
The ? indicates the number of the
display.
<!-- .IN "Files" "/etc/X?.hosts" -->
<indexterm><primary>Files</primary><secondary>/etc/X?.hosts</secondary></indexterm>
This file should consist of host names separated by newlines.
DECnet nodes must terminate in :: to distinguish them from Internet hosts.
</para>
@ -1447,7 +1447,7 @@ structure, which contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XHostAddress" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XHostAddress</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -1499,7 +1499,7 @@ structure, which contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XServerInterpretedAddress" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XServerInterpretedAddress</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -1525,7 +1525,7 @@ specify the length in byte of the type and value strings.
<!-- .sp -->
To add a single host, use
<function>XAddHost .</function>
<!-- .IN "XAddHost" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAddHost</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1583,7 +1583,7 @@ errors.
<!-- .sp -->
To add multiple hosts at one time, use
<function>XAddHosts .</function>
<!-- .IN "XAddHosts" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAddHosts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1652,7 +1652,7 @@ errors.
<!-- .sp -->
To obtain a host list, use
<function>XListHosts .</function>
<!-- .IN "XListHosts" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XListHosts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1716,7 +1716,7 @@ this memory should be freed by calling
<!-- .sp -->
To remove a single host, use
<function>XRemoveHost .</function>
<!-- .IN "XRemoveHost" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRemoveHost</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1778,7 +1778,7 @@ errors.
<!-- .sp -->
To remove multiple hosts at one time, use
<function>XRemoveHosts .</function>
<!-- .IN "XRemoveHosts" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRemoveHosts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1869,7 +1869,7 @@ at connection setup.
<!-- .sp -->
To change access control, use
<function>XSetAccessControl .</function>
<!-- .IN "XSetAccessControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetAccessControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1928,7 +1928,7 @@ errors.
<!-- .sp -->
To enable access control, use
<function>XEnableAccessControl .</function>
<!-- .IN "XEnableAccessControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XEnableAccessControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1969,7 +1969,7 @@ error.
<!-- .sp -->
To disable access control, use
<function>XDisableAccessControl .</function>
<!-- .IN "XDisableAccessControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDisableAccessControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

210
specs/libX11/CH10.xml
View file

@ -31,10 +31,10 @@ Functions for handling events are dealt with in the next chapter.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Event" "types" -->
<indexterm><primary>Event</primary><secondary>types</secondary></indexterm>
An event is data generated asynchronously by the X server as a result of some
device activity or as side effects of a request sent by an Xlib function.
<!-- .IN "Event" -->
<indexterm><primary>Event</primary></indexterm>
Device-related events propagate from the source window to ancestor windows
until some client application has selected that event type
or until the event is explicitly discarded.
@ -50,8 +50,8 @@ do-not-propagate mask of the window's attributes.
However,
<function>MappingNotify</function>
events are always sent to all clients.
<!-- .IN "Input Control" -->
<!-- .IN "Output Control" -->
<indexterm><primary>Input Control</primary></indexterm>
<indexterm><primary>Output Control</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -60,7 +60,7 @@ For each event type,
a corresponding constant name is defined in
<!-- .hN X11/X.h , -->
which is used when referring to an event type.
<!-- .IN "Event" "categories" -->
<indexterm><primary>Event</primary><secondary>categories</secondary></indexterm>
The following table lists the event category
and its associated event type or types.
The processing associated with these events is discussed in section 10.5.
@ -176,7 +176,7 @@ All the event structures have the following common members:
</para>
<para>
<!-- .LP -->
<!-- .IN "XAnyEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAnyEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -232,7 +232,7 @@ union.
</para>
<para>
<!-- .LP -->
<!-- .IN "XEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XEvent</primary></indexterm>
<!-- .sM -->
</para>
<literallayout class="monospaced">
@ -308,7 +308,7 @@ is used to access any other information in the structure.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Event mask" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Event mask</primary></indexterm>
Clients select event reporting of most events relative to a window.
To do this, pass an event mask to an Xlib event-handling
function that takes an event_mask argument.
@ -495,7 +495,7 @@ For example, if you pass the event mask
the X server sends back only
<function>ButtonPress</function>
events.
<!-- .IN "CurrentTime" -->
<indexterm><primary>CurrentTime</primary></indexterm>
Most events contain a time member,
which is the time at which an event occurred.
</para>
@ -970,11 +970,11 @@ and
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ButtonPress" -->
<!-- .IN "Events" "ButtonRelease" -->
<!-- .IN "Events" "KeyPress" -->
<!-- .IN "Events" "KeyRelease" -->
<!-- .IN "Events" "MotionNotify" -->
<indexterm><primary>Events</primary><secondary>ButtonPress</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>ButtonRelease</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>KeyPress</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>KeyRelease</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>MotionNotify</secondary></indexterm>
This section discusses the processing that occurs for the
keyboard events
<function>KeyPress</function>
@ -990,8 +990,8 @@ see chapter 11.
</para>
<para>
<!-- .LP -->
<!-- .IN "KeyPress" "" "@DEF@" -->
<!-- .IN "KeyRelease" "" "@DEF@" -->
<indexterm significance="preferred"><primary>KeyPress</primary></indexterm>
<indexterm significance="preferred"><primary>KeyRelease</primary></indexterm>
The X server reports
<function>KeyPress</function>
or
@ -999,8 +999,8 @@ or
events to clients wanting information about keys that logically change state.
Note that these events are generated for all keys,
even those mapped to modifier bits.
<!-- .IN "ButtonPress" "" "@DEF@" -->
<!-- .IN "ButtonRelease" "" "@DEF@" -->
<indexterm significance="preferred"><primary>ButtonPress</primary></indexterm>
<indexterm significance="preferred"><primary>ButtonRelease</primary></indexterm>
The X server reports
<function>ButtonPress</function>
or
@ -1009,7 +1009,7 @@ events to clients wanting information about buttons that logically change state.
</para>
<para>
<!-- .LP -->
<!-- .IN "MotionNotify" "" "@DEF@" -->
<indexterm significance="preferred"><primary>MotionNotify</primary></indexterm>
The X server reports
<function>MotionNotify</function>
events to clients wanting information about when the pointer logically moves.
@ -1417,15 +1417,15 @@ follows:
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "EnterNotify" -->
<!-- .IN "Events" "LeaveNotify" -->
<indexterm><primary>Events</primary><secondary>EnterNotify</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>LeaveNotify</secondary></indexterm>
This section describes the processing that
occurs for the window crossing events
<function>EnterNotify</function>
and
<function>LeaveNotify .</function>
<!-- .IN "EnterNotify" "" "@DEF@" -->
<!-- .IN "LeaveNotify" "" "@DEF@" -->
<indexterm significance="preferred"><primary>EnterNotify</primary></indexterm>
<indexterm significance="preferred"><primary>LeaveNotify</primary></indexterm>
If a pointer motion or a window hierarchy change causes the
pointer to be in a different window than before, the X server reports
<function>EnterNotify</function>
@ -1487,9 +1487,9 @@ bits of the event-mask attribute of the window.
The structure for these event types contains:
</para>
<!-- .LP -->
<!-- .IN "XCrossingEvent" "" "@DEF@" -->
<!-- .IN "XEnterWindowEvent" "" "@DEF@" -->
<!-- .IN "XLeaveWindowEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCrossingEvent</primary></indexterm>
<indexterm significance="preferred"><primary>XEnterWindowEvent</primary></indexterm>
<indexterm significance="preferred"><primary>XLeaveWindowEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -1946,14 +1946,14 @@ initial and final positions for the events.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "FocusIn" -->
<!-- .IN "Events" "FocusOut" -->
<indexterm><primary>Events</primary><secondary>FocusIn</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>FocusOut</secondary></indexterm>
This section describes the processing that occurs for the input focus events
<function>FocusIn</function>
and
<function>FocusOut .</function>
<!-- .IN "FocusIn" "" "@DEF@" -->
<!-- .IN "FocusOut" "" "@DEF@" -->
<indexterm significance="preferred"><primary>FocusIn</primary></indexterm>
<indexterm significance="preferred"><primary>FocusOut</primary></indexterm>
The X server can report
<function>FocusIn</function>
or
@ -1982,9 +1982,9 @@ bit in the event-mask attribute of the window.
The structure for these event types contains:
</para>
<!-- .LP -->
<!-- .IN "XFocusChangeEvent" "" "@DEF@" -->
<!-- .IN "XFocusInEvent" "" "@DEF@" -->
<!-- .IN "XFocusOutEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFocusChangeEvent</primary></indexterm>
<indexterm significance="preferred"><primary>XFocusInEvent</primary></indexterm>
<indexterm significance="preferred"><primary>XFocusOutEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2643,8 +2643,8 @@ G to F.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "KeymapNotify" -->
<!-- .IN "KeymapNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>KeymapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>KeymapNotify</primary></indexterm>
The X server can report
<function>KeymapNotify</function>
events to clients that want information about changes in their keyboard state.
@ -2668,7 +2668,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XKeymapEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XKeymapEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2726,8 +2726,8 @@ A more sophisticated client application redraws only the exposed region.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "Expose" -->
<!-- .IN "Expose" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>Expose</secondary></indexterm>
<indexterm significance="preferred"><primary>Expose</primary></indexterm>
The X server can report
<function>Expose</function>
events to clients wanting information about when the contents of window regions
@ -2774,7 +2774,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XExposeEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XExposeEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2821,9 +2821,9 @@ on events with zero counts.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "GraphicsExpose" -->
<!-- .IN "Events" "NoExpose" -->
<!-- .IN "GraphicsExpose" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>GraphicsExpose</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>NoExpose</secondary></indexterm>
<indexterm significance="preferred"><primary>GraphicsExpose</primary></indexterm>
The X server can report
<function>GraphicsExpose</function>
events to clients wanting information about when a destination region could not
@ -2840,7 +2840,7 @@ drawable).
</para>
<para>
<!-- .LP -->
<!-- .IN "NoExpose" "" "@DEF@" -->
<indexterm significance="preferred"><primary>NoExpose</primary></indexterm>
The X server generates a
<function>NoExpose</function>
event whenever a graphics request that might
@ -2874,7 +2874,7 @@ The structures for these event types contain:
</para>
<para>
<!-- .LP -->
<!-- .IN "XGraphicsExposeEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGraphicsExposeEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -2895,7 +2895,7 @@ typedef struct {
</para>
<para>
<!-- .LP -->
<!-- .IN "XNoExposeEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNoExposeEvent</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
@ -3040,8 +3040,8 @@ events
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "CirculateNotify" -->
<!-- .IN "CirculateNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>CirculateNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>CirculateNotify</primary></indexterm>
The X server can report
<function>CirculateNotify</function>
events to clients wanting information about when a window changes
@ -3071,7 +3071,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XCirculateEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCirculateEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3117,8 +3117,8 @@ the window is now below all siblings.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ConfigureNotify" -->
<!-- .IN "ConfigureNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>ConfigureNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>ConfigureNotify</primary></indexterm>
The X server can report
<function>ConfigureNotify</function>
events to clients wanting information about actual changes to a window's
@ -3191,7 +3191,7 @@ bit in the event-mask attribute of the parent window
The structure for this event type contains:
</para>
<!-- .LP -->
<!-- .IN "XConfigureEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XConfigureEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3260,8 +3260,8 @@ is
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "CreateNotify" -->
<!-- .IN "CreateNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>CreateNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>CreateNotify</primary></indexterm>
The X server can report
<function>CreateNotify</function>
events to clients wanting information about creation of windows.
@ -3286,7 +3286,7 @@ The structure for the event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XCreateWindowEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateWindowEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3330,8 +3330,8 @@ if the override_redirect member is
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "DestroyNotify" -->
<!-- .IN "DestroyNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>DestroyNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>DestroyNotify</primary></indexterm>
The X server can report
<function>DestroyNotify</function>
events to clients wanting information about which windows are destroyed.
@ -3369,7 +3369,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XDestroyWindowEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyWindowEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3403,8 +3403,8 @@ The window member is set to the window that is destroyed.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "GravityNotify" -->
<!-- .IN "GravityNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>GravityNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>GravityNotify</primary></indexterm>
The X server can report
<function>GravityNotify</function>
events to clients wanting information about when a window is moved because of a
@ -3434,7 +3434,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XGravityEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGravityEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3473,8 +3473,8 @@ window.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "MapNotify" -->
<!-- .IN "MapNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>MapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>MapNotify</primary></indexterm>
The X server can report
<function>MapNotify</function>
events to clients wanting information about which windows are mapped.
@ -3503,7 +3503,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XMapEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMapEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3545,8 +3545,8 @@ which override structure control.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "MappingNotify" -->
<!-- .IN "MappingNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>MappingNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>MappingNotify</primary></indexterm>
The X server reports
<function>MappingNotify</function>
events to all clients.
@ -3580,7 +3580,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XMappingEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMappingEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3637,8 +3637,8 @@ you should call
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ReparentNotify" -->
<!-- .IN "ReparentNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>ReparentNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>ReparentNotify</primary></indexterm>
The X server can report
<function>ReparentNotify</function>
events to clients wanting information about changing a window's parent.
@ -3664,7 +3664,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XReparentEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XReparentEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3710,8 +3710,8 @@ if the override_redirect member is
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "UnmapNotify" -->
<!-- .IN "UnmapNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>UnmapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>UnmapNotify</primary></indexterm>
The X server can report
<function>UnmapNotify</function>
events to clients wanting information about which windows are unmapped.
@ -3735,7 +3735,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XUnmapEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnmapEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3776,8 +3776,8 @@ the window itself had a win_gravity of
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "VisibilityNotify" -->
<!-- .IN "VisibilityNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>VisibilityNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>VisibilityNotify</primary></indexterm>
The X server can report
<function>VisibilityNotify</function>
events to clients wanting any change in the visibility of the specified window.
@ -3831,7 +3831,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XVisibilityEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XVisibilityEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -3937,8 +3937,8 @@ events
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "CirculateRequest" -->
<!-- .IN "CirculateRequest" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>CirculateRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>CirculateRequest</primary></indexterm>
The X server can report
<function>CirculateRequest</function>
events to clients wanting information about
@ -3977,7 +3977,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XCirculateRequestEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCirculateRequestEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4018,8 +4018,8 @@ the subwindow should be below all siblings.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ConfigureRequest" -->
<!-- .IN "ConfigureRequest" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>ConfigureRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>ConfigureRequest</primary></indexterm>
The X server can report
<function>ConfigureRequest</function>
events to clients wanting information about when a different client initiates
@ -4068,7 +4068,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XConfigureRequestEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XConfigureRequestEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4115,8 +4115,8 @@ respectively, if they are not given in the request.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "MapRequest" -->
<!-- .IN "MapRequest" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>MapRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>MapRequest</primary></indexterm>
The X server can report
<function>MapRequest</function>
events to clients wanting information about a different client's desire
@ -4164,7 +4164,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XMapRequestEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMapRequestEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4193,8 +4193,8 @@ The window member is set to the window to be mapped.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ResizeRequest" -->
<!-- .IN "ResizeRequest" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>ResizeRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>ResizeRequest</primary></indexterm>
The X server can report
<function>ResizeRequest</function>
events to clients wanting information about another client's attempts to change the
@ -4221,7 +4221,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XResizeRequestEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XResizeRequestEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4253,8 +4253,8 @@ excluding the border.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ColormapNotify" -->
<!-- .IN "ColormapNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>ColormapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>ColormapNotify</primary></indexterm>
The X server can report
<function>ColormapNotify</function>
events to clients wanting information about when the colormap changes
@ -4297,7 +4297,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XColormapEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XColormapEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4392,8 +4392,8 @@ events
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "ClientMessage" -->
<!-- .IN "ClientMessage" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>ClientMessage</secondary></indexterm>
<indexterm significance="preferred"><primary>ClientMessage</primary></indexterm>
The X server generates
<function>ClientMessage</function>
events only when a client calls the function
@ -4405,7 +4405,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XClientMessageEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XClientMessageEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 1i 3i -->
@ -4448,8 +4448,8 @@ message_type, or data members.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "PropertyNotify" -->
<!-- .IN "PropertyNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>PropertyNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>PropertyNotify</primary></indexterm>
The X server can report
<function>PropertyNotify</function>
events to clients wanting information about property changes
@ -4469,7 +4469,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XPropertyEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPropertyEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4527,8 +4527,8 @@ or, if the delete argument is
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "SelectionClear" -->
<!-- .IN "SelectionClear" "" "@DEF@" -->
<indexterm ><primary>Events</primary><secondary>SelectionClear</secondary></indexterm>
<indexterm significance="preferred"><primary>SelectionClear</primary></indexterm>
The X server reports
<function>SelectionClear</function>
events to the client losing ownership of a selection.
@ -4542,7 +4542,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XSelectionClearEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSelectionClearEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4577,8 +4577,8 @@ call.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "SelectionRequest" -->
<!-- .IN "SelectionRequest" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>SelectionRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>SelectionRequest</primary></indexterm>
The X server reports
<function>SelectionRequest</function>
events to the owner of a selection.
@ -4593,7 +4593,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XSelectionRequestEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSelectionRequestEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -4649,8 +4649,8 @@ standard <emphasis remap='I'>Inter-Client Communication Conventions Manual</emph
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Events" "SelectionNotify" -->
<!-- .IN "SelectionNotify" "" "@DEF@" -->
<indexterm><primary>Events</primary><secondary>SelectionNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>SelectionNotify</primary></indexterm>
This event is generated by the X server in response to a
<function>ConvertSelection </function>
protocol request when there is no owner for the selection.
@ -4681,7 +4681,7 @@ The structure for this event type contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XSelectionEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSelectionEvent</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->

122
specs/libX11/CH11.xml
View file

@ -40,7 +40,7 @@ and
<function>XChangeWindowAttributes .</function>
Another way is to use
<function>XSelectInput . </function>
<!-- .IN "XSelectInput" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSelectInput</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -97,7 +97,7 @@ Events are reported relative to a window.
If a window is not interested in a device event, it usually propagates to
the closest ancestor that is interested,
unless the do_not_propagate mask prohibits it.
<!-- .IN "Event" "propagation" -->
<indexterm><primary>Event</primary><secondary>propagation</secondary></indexterm>
</para>
<para>
<!-- .LP -->
@ -178,7 +178,7 @@ These functions differ in the additional tasks they might perform.
<!-- .sp -->
To flush the output buffer, use
<function>XFlush .</function>
<!-- .IN "XFlush" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFlush</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -213,9 +213,9 @@ buffer is automatically flushed as needed by calls to
<function>XNextEvent ,</function>
and
<function>XWindowEvent .</function>
<!-- .IN "XPending" -->
<!-- .IN "XNextEvent" -->
<!-- .IN "XWindowEvent" -->
<indexterm><primary>XPending</primary></indexterm>
<indexterm><primary>XNextEvent</primary></indexterm>
<indexterm><primary>XWindowEvent</primary></indexterm>
Events generated by the server may be enqueued into the library's event queue.
</para>
<para>
@ -224,7 +224,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>
<!-- .IN "XSync" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSync</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -307,7 +307,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>
<!-- .IN "XEventsQueued" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XEventsQueued</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -393,7 +393,7 @@ function.
<!-- .sp -->
To return the number of events that are pending, use
<function>XPending .</function>
<!-- .IN "XPending" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPending</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -467,7 +467,7 @@ predicate procedures that you provide
<!-- .LP -->
To get the next event and remove it from the queue, use
<function>XNextEvent .</function>
<!-- .IN "XNextEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNextEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -517,7 +517,7 @@ flushes the output buffer and blocks until an event is received.
<!-- .sp -->
To peek at the event queue, use
<function>XPeekEvent .</function>
<!-- .IN "XPeekEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPeekEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -654,7 +654,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>
<!-- .IN "XIfEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIfEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -733,7 +733,7 @@ structure.
<!-- .sp -->
To check the event queue for a matching event without blocking, use
<function>XCheckIfEvent .</function>
<!-- .IN "XCheckIfEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCheckIfEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -812,7 +812,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>
<!-- .IN "XPeekIfEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPeekIfEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -901,7 +901,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>
<!-- .IN "XWindowEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWindowEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -980,13 +980,13 @@ flushes the output buffer and blocks until one is received.
To remove the next event that matches both a window and an event mask (if any),
use
<function>XCheckWindowEvent .</function>
<!-- .IN "XCheckWindowEvent" -->
<indexterm><primary>XCheckWindowEvent</primary></indexterm>
This function is similar to
<function>XWindowEvent </function>
except that it never blocks and it returns a
<function>Bool </function>
indicating if the event was returned.
<!-- .IN "XCheckWindowEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCheckWindowEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1068,7 +1068,7 @@ and the output buffer will have been flushed.
<!-- .sp -->
To remove the next event that matches an event mask, use
<function>XMaskEvent .</function>
<!-- .IN "XMaskEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMaskEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1139,7 +1139,7 @@ This function is similar to
except that it never blocks and it returns a
<function>Bool </function>
indicating if the event was returned.
<!-- .IN "XCheckMaskEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCheckMaskEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1208,7 +1208,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>
<!-- .IN "XCheckTypedEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCheckTypedEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1279,7 +1279,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>
<!-- .IN "XCheckTypedWindowEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCheckTypedWindowEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1367,7 +1367,7 @@ and the output buffer will have been flushed.
<!-- .LP -->
To push an event back into the event queue, use
<function>XPutBackEvent .</function>
<!-- .IN "XPutBackEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPutBackEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1422,7 +1422,7 @@ There is no limit to the number of times in succession that you can call
<!-- .LP -->
To send an event to a specified window, use
<function>XSendEvent .</function>
<!-- .IN "XSendEvent" -->
<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>
@ -1430,7 +1430,7 @@ to send a
<function>SelectionNotify</function>
event to a requestor when a selection has been converted
and stored as a property.
<!-- .IN "XSendEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSendEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1628,7 +1628,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>
<!-- .IN "XDisplayMotionBufferSize" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDisplayMotionBufferSize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1666,7 +1666,7 @@ function makes this history available.
<!-- .sp -->
To get the motion history for a specified window and time, use
<function>XGetMotionEvents .</function>
<!-- .IN "XGetMotionEvents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetMotionEvents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1756,7 +1756,7 @@ The return type for this function is a structure defined as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XTimeCoord" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTimeCoord</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i -->
@ -1808,7 +1808,7 @@ so that errors are reported as they occur.
The following function lets you disable or enable synchronous behavior.
Note that graphics may occur 30 or more times more slowly when
synchronization is enabled.
<!-- .IN "_Xdebug" -->
<indexterm><primary>_Xdebug</primary></indexterm>
On POSIX-conformant systems,
there is also a global variable
<function>_Xdebug </function>
@ -1822,7 +1822,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.
<!-- .IN "XSetAfterFunction" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetAfterFunction</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1866,8 +1866,8 @@ returns the previous after function.
<!-- .LP -->
To enable or disable synchronization, use
<function>XSynchronize .</function>
<!-- .IN "Debugging" "synchronous mode" -->
<!-- .IN "XSynchronize" "" "@DEF@" -->
<indexterm><primary>Debugging</primary><secondary>synchronous mode</secondary></indexterm>
<indexterm significance="preferred"><primary>XSynchronize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1925,8 +1925,8 @@ turns off synchronous behavior.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Debugging" "error handlers" -->
<!-- .IN "Error" "handlers" -->
<indexterm><primary>Debugging</primary><secondary>error handlers</secondary></indexterm>
<indexterm><primary>Error</primary><secondary>handlers</secondary></indexterm>
There are two default error handlers in Xlib:
one to handle typically fatal conditions (for example,
the connection to a display server dying because a machine crashed)
@ -1943,7 +1943,7 @@ message and exit.
<!-- .sp -->
To set the error handler, use
<function>XSetErrorHandler .</function>
<!-- .IN "XSetErrorHandler" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetErrorHandler</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1997,11 +1997,11 @@ The previous error handler is returned.
The
<function>XErrorEvent</function>
structure contains:
<!-- .IN "Debugging" "error event" -->
<indexterm><primary>Debugging</primary><secondary>error event</secondary></indexterm>
</para>
<para>
<!-- .LP -->
<!-- .IN "XErrorEvent" "" "@DEF" -->
<indexterm significance="preferred"><primary>XErrorEvent</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
<!-- .ta .5i 2.5i -->
@ -2018,7 +2018,7 @@ typedef struct {
</para>
<para>
<!-- .LP -->
<!-- .IN "Serial Number" -->
<indexterm><primary>Serial Number</primary></indexterm>
The serial member is the number of requests, starting from one,
sent over the network connection since it was opened.
It is the number that was the value of
@ -2032,19 +2032,19 @@ chapter:
</para>
<!-- .br -->
<!-- .ne 13 -->
<!-- .IN "Debugging" "error numbers" -->
<!-- .IN "Error" "codes" -->
<indexterm><primary>Debugging</primary><secondary>error numbers</secondary></indexterm>
<indexterm><primary>Error</primary><secondary>codes</secondary></indexterm>
<!-- .\".CP T 3 -->
<!-- .\"Error Codes -->
<!-- .IN "BadAccess" "" "@DEF@" -->
<!-- .IN "BadAlloc" "" "@DEF@" -->
<!-- .IN "BadAtom" "" "@DEF@" -->
<!-- .IN "BadColor" "" "@DEF@" -->
<!-- .IN "BadCursor" "" "@DEF@" -->
<!-- .IN "BadDrawable" "" "@DEF@" -->
<!-- .IN "BadFont" "" "@DEF@" -->
<!-- .IN "BadGC" "" "@DEF@" -->
<!-- .IN "BadIDChoice" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BadAccess</primary></indexterm>
<indexterm significance="preferred"><primary>BadAlloc</primary></indexterm>
<indexterm significance="preferred"><primary>BadAtom</primary></indexterm>
<indexterm significance="preferred"><primary>BadColor</primary></indexterm>
<indexterm significance="preferred"><primary>BadCursor</primary></indexterm>
<indexterm significance="preferred"><primary>BadDrawable</primary></indexterm>
<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'>
<colspec colname='c1'/>
@ -2199,14 +2199,14 @@ chapter:
</tgroup>
</informaltable>
<!-- .IN "BadImplementation" "" "@DEF@" -->
<!-- .IN "BadLength" "" "@DEF@" -->
<!-- .IN "BadMatch" "" "@DEF@" -->
<!-- .IN "BadName" "" "@DEF@" -->
<!-- .IN "BadPixmap" "" "@DEF@" -->
<!-- .IN "BadRequest" "" "@DEF@" -->
<!-- .IN "BadValue" "" "@DEF@" -->
<!-- .IN "BadWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>BadImplementation</primary></indexterm>
<indexterm significance="preferred"><primary>BadLength</primary></indexterm>
<indexterm significance="preferred"><primary>BadMatch</primary></indexterm>
<indexterm significance="preferred"><primary>BadName</primary></indexterm>
<indexterm significance="preferred"><primary>BadPixmap</primary></indexterm>
<indexterm significance="preferred"><primary>BadRequest</primary></indexterm>
<indexterm significance="preferred"><primary>BadValue</primary></indexterm>
<indexterm significance="preferred"><primary>BadWindow</primary></indexterm>
<!-- .NT Note -->
<note>
@ -2232,8 +2232,8 @@ fixed alternatives.
<!-- .LP -->
To obtain textual descriptions of the specified error code, use
<function>XGetErrorText .</function>
<!-- .IN "XGetErrorText" "" "@DEF@" -->
<!-- .IN "Debugging" "error message strings" -->
<indexterm significance="preferred"><primary>XGetErrorText</primary></indexterm>
<indexterm><primary>Debugging</primary><secondary>error message strings</secondary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2305,7 +2305,7 @@ and error strings.
<!-- .sp -->
To obtain error messages from the error database, use
<function>XGetErrorDatabaseText .</function>
<!-- .IN "XGetErrorDatabaseText" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetErrorDatabaseText</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2450,7 +2450,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>
<!-- .IN "XDisplayName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDisplayName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2493,7 +2493,7 @@ program attempted to open when the initial connection attempt failed.
<!-- .sp -->
To handle fatal I/O errors, use
<function>XSetIOErrorHandler .</function>
<!-- .IN "XSetIOErrorHandler" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetIOErrorHandler</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

122
specs/libX11/CH12.xml
View file

@ -56,7 +56,7 @@ may lag the physical state if device event processing is frozen.
</para>
<para>
<!-- .LP -->
<!-- .IN "Active grab" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Active grab</primary></indexterm>
There are two kinds of grabs:
active and passive.
An active grab occurs when a single client grabs the keyboard and/or pointer
@ -64,7 +64,7 @@ explicitly (see
<function>XGrabPointer</function>
and
<function>XGrabKeyboard ).</function>
<!-- .IN "Passive grab" -->
<indexterm><primary>Passive grab</primary></indexterm>
A passive grab occurs when clients grab a particular keyboard key
or pointer button in a window,
and the grab will activate when the key or button is actually pressed.
@ -85,8 +85,8 @@ For many operations,
there are functions that take a time argument.
The X server includes a timestamp in various events.
One special time, called
<!-- .IN "CurrentTime" "" "@DEF@" -->
<!-- .IN "Time" "" "@DEF@" -->
<indexterm significance="preferred"><primary>CurrentTime</primary></indexterm>
<indexterm significance="preferred"><primary>Time</primary></indexterm>
<function>CurrentTime ,</function>
represents the current server time.
The X server maintains the time when the input focus was last changed,
@ -152,9 +152,9 @@ and
<!-- .sp -->
To grab the pointer, use
<function>XGrabPointer .</function>
<!-- .IN "Grabbing" "pointer" -->
<!-- .IN "Pointer" "grabbing" -->
<!-- .IN "XGrabPointer" "" "@DEF@" -->
<indexterm><primary>Grabbing</primary><secondary>pointer</secondary></indexterm>
<indexterm><primary>Pointer</primary><secondary>grabbing</secondary></indexterm>
<indexterm significance="preferred"><primary>XGrabPointer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -418,9 +418,9 @@ errors.
<!-- .sp -->
To ungrab the pointer, use
<function>XUngrabPointer .</function>
<!-- .IN "Ungrabbing" "pointer" -->
<!-- .IN "Pointer" "ungrabbing" -->
<!-- .IN "XUngrabPointer" "" "@DEF@" -->
<indexterm><primary>Ungrabbing</primary><secondary>pointer</secondary></indexterm>
<indexterm><primary>Pointer</primary><secondary>ungrabbing</secondary></indexterm>
<indexterm significance="preferred"><primary>XUngrabPointer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -486,9 +486,9 @@ outside the boundaries of the root window.
<!-- .sp -->
To change an active pointer grab, use
<function>XChangeActivePointerGrab .</function>
<!-- .IN "Pointer" "grabbing" -->
<!-- .IN "Changing" "pointer grab" -->
<!-- .IN "XChangeActivePointerGrab" "" "@DEF@" -->
<indexterm><primary>Pointer</primary><secondary>grabbing</secondary></indexterm>
<indexterm ><primary>Changing</primary><secondary>pointer grab</secondary></indexterm>
<indexterm significance="preferred"><primary>XChangeActivePointerGrab</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -574,9 +574,9 @@ errors.
<!-- .sp -->
To grab a pointer button, use
<function>XGrabButton .</function>
<!-- .IN "Grabbing" "buttons" -->
<!-- .IN "Button" "grabbing" -->
<!-- .IN "XGrabButton" "" "@DEF@" -->
<indexterm><primary>Grabbing</primary><secondary>buttons</secondary></indexterm>
<indexterm><primary>Button</primary><secondary>grabbing</secondary></indexterm>
<indexterm significance="preferred"><primary>XGrabButton</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -818,9 +818,9 @@ errors.
<!-- .sp -->
To ungrab a pointer button, use
<function>XUngrabButton .</function>
<!-- .IN "Ungrabbing" "buttons" -->
<!-- .IN "Button" "ungrabbing" -->
<!-- .IN "XUngrabButton" "" "@DEF@" -->
<indexterm><primary>Ungrabbing</primary><secondary>buttons</secondary></indexterm>
<indexterm><primary>Button</primary><secondary>ungrabbing</secondary></indexterm>
<indexterm significance="preferred"><primary>XUngrabButton</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -939,9 +939,9 @@ and
<!-- .sp -->
To grab the keyboard, use
<function>XGrabKeyboard .</function>
<!-- .IN "Keyboard" "grabbing" -->
<!-- .IN "Grabbing" "keyboard" -->
<!-- .IN "XGrabKeyboard" "" "@DEF@" -->
<indexterm><primary>Keyboard</primary><secondary>grabbing</secondary></indexterm>
<indexterm><primary>Grabbing</primary><secondary>keyboard</secondary></indexterm>
<indexterm significance="preferred"><primary>XGrabKeyboard</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1127,9 +1127,9 @@ errors.
<!-- .sp -->
To ungrab the keyboard, use
<function>XUngrabKeyboard .</function>
<!-- .IN "Keyboard" "ungrabbing" -->
<!-- .IN "Ungrabbing" "keyboard" -->
<!-- .IN "XUngrabKeyboard" "" "@DEF@" -->
<indexterm><primary>Keyboard</primary><secondary>ungrabbing</secondary></indexterm>
<indexterm><primary>Ungrabbing</primary><secondary>keyboard</secondary></indexterm>
<indexterm significance="preferred"><primary>XUngrabKeyboard</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1194,9 +1194,9 @@ active keyboard grab becomes not viewable.
<!-- .sp -->
To passively grab a single key of the keyboard, use
<function>XGrabKey .</function>
<!-- .IN "Key" "grabbing" -->
<!-- .IN "Grabbing" "keys" -->
<!-- .IN "XGrabKey" "" "@DEF@" -->
<indexterm><primary>Key</primary><secondary>grabbing</secondary></indexterm>
<indexterm><primary>Grabbing</primary><secondary>keys</secondary></indexterm>
<indexterm significance="preferred"><primary>XGrabKey</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1398,9 +1398,9 @@ errors.
<!-- .sp -->
To ungrab a key, use
<function>XUngrabKey .</function>
<!-- .IN "Key" "ungrabbing" -->
<!-- .IN "Ungrabbing" "keys" -->
<!-- .IN "XUngrabKey" "" "@DEF@" -->
<indexterm><primary>Key</primary><secondary>ungrabbing</secondary></indexterm>
<indexterm><primary>Ungrabbing</primary><secondary>keys</secondary></indexterm>
<indexterm significance="preferred"><primary>XUngrabKey</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1501,7 +1501,7 @@ describes the mechanism for resuming event processing.
<!-- .sp -->
To allow further events to be processed when the device has been frozen, use
<function>XAllowEvents .</function>
<!-- .IN "XAllowEvents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAllowEvents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1756,7 +1756,7 @@ pointer to a new position under program control.
<!-- .sp -->
To move the pointer to an arbitrary point in a window, use
<function>XWarpPointer .</function>
<!-- .IN "XWarpPointer" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWarpPointer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1930,7 +1930,7 @@ for input focus policy.
<!-- .sp -->
To set the input focus, use
<function>XSetInputFocus .</function>
<!-- .IN "XSetInputFocus" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetInputFocus</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2104,7 +2104,7 @@ errors.
<!-- .sp -->
To obtain the current input focus, use
<function>XGetInputFocus .</function>
<!-- .IN "XGetInputFocus" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetInputFocus</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2178,10 +2178,10 @@ and obtain a bit vector for the keyboard.
</para>
<para>
<!-- .LP -->
<!-- .IN "Keyboard" "bell volume" -->
<!-- .IN "Keyboard" "keyclick volume" -->
<!-- .IN "Keyboard" "bit vector" -->
<!-- .IN "Mouse" "programming" -->
<indexterm><primary>Keyboard</primary><secondary>bell volume</secondary></indexterm>
<indexterm><primary>Keyboard</primary><secondary>keyclick volume</secondary></indexterm>
<indexterm><primary>Keyboard</primary><secondary>bit vector</secondary></indexterm>
<indexterm><primary>Mouse</primary><secondary>programming</secondary></indexterm>
This section discusses
the user-preference options of bell, key click,
pointer behavior, and so on.
@ -2319,7 +2319,7 @@ If an error is generated, a subset of the controls may have been altered.
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XChangeKeyboardControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChangeKeyboardControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2388,7 +2388,7 @@ errors.
<!-- .sp -->
To obtain the current control values for the keyboard, use
<function>XGetKeyboardControl .</function>
<!-- .IN "XGetKeyboardControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetKeyboardControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2434,8 +2434,8 @@ structure.
</para>
<para>
<!-- .LP -->
<!-- .IN "XGetKeyboardControl" -->
<!-- .IN "XKeyboardState" "" "@DEF@" -->
<indexterm><primary>XGetKeyboardControl</primary></indexterm>
<indexterm significance="preferred"><primary>XKeyboardState</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i -->
@ -2472,7 +2472,7 @@ with the least significant bit in the byte representing key 8N.
<!-- .sp -->
To turn on keyboard auto-repeat, use
<function>XAutoRepeatOn .</function>
<!-- .IN "XAutoRepeatOn" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAutoRepeatOn</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2506,7 +2506,7 @@ function turns on auto-repeat for the keyboard on the specified display.
<!-- .sp -->
To turn off keyboard auto-repeat, use
<function>XAutoRepeatOff .</function>
<!-- .IN "XAutoRepeatOff" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAutoRepeatOff</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2540,7 +2540,7 @@ function turns off auto-repeat for the keyboard on the specified display.
<!-- .sp -->
To ring the bell, use
<function>XBell .</function>
<!-- .IN "XBell" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XBell</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2624,7 +2624,7 @@ error.
<!-- .sp -->
To obtain a bit vector that describes the state of the keyboard, use
<function>XQueryKeymap .</function>
<!-- .IN "XQueryKeymap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XQueryKeymap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2680,7 +2680,7 @@ may lag the physical state if device event processing is frozen.
<!-- .sp -->
To set the mapping of the pointer buttons, use
<function>XSetPointerMapping .</function>
<!-- .IN "XSetPointerMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetPointerMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2768,7 +2768,7 @@ error.
<!-- .sp -->
To get the pointer mapping, use
<function>XGetPointerMapping .</function>
<!-- .IN "XGetPointerMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetPointerMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2831,7 +2831,7 @@ in map_return.
<!-- .sp -->
To control the pointer's interactive feel, use
<function>XChangePointerControl .</function>
<!-- .IN "XChangePointerControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChangePointerControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2944,7 +2944,7 @@ error.
<!-- .sp -->
To get the current pointer parameters, use
<function>XGetPointerControl .</function>
<!-- .IN "XGetPointerControl" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetPointerControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3213,7 +3213,7 @@ Rather, it merely stores it for reading and writing by clients.
<!-- .LP -->
To obtain the legal KeyCodes for a display, use
<function>XDisplayKeycodes .</function>
<!-- .IN "XDisplayKeycodes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDisplayKeycodes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3272,7 +3272,7 @@ Not all KeyCodes in this range are required to have corresponding keys.
<!-- .LP -->
To obtain the symbols for the specified KeyCodes, use
<function>XGetKeyboardMapping .</function>
<!-- .IN "XGetKeyboardMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetKeyboardMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3397,7 +3397,7 @@ error.
<!-- .sp -->
To change the keyboard mapping, use
<function>XChangeKeyboardMapping .</function>
<!-- .IN "XChangeKeyboardMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XChangeKeyboardMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3551,7 +3551,7 @@ data structure, which contains:
</para>
<para>
<!-- .LP -->
<!-- .IN "XModifierKeymap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XModifierKeymap</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -3569,7 +3569,7 @@ To create an
<function>XModifierKeymap</function>
structure, use
<function>XNewModifiermap .</function>
<!-- .IN "XNewModifiermap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNewModifiermap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3608,7 +3608,7 @@ To add a new entry to an
<function>XModifierKeymap</function>
structure, use
<function>XInsertModifiermapEntry .</function>
<!-- .IN "XInsertModifiermapEntry" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XInsertModifiermapEntry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3671,7 +3671,7 @@ To delete an entry from an
<function>XModifierKeymap</function>
structure, use
<function>XDeleteModifiermapEntry .</function>
<!-- .IN "XDeleteModifiermapEntry" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDeleteModifiermapEntry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3734,7 +3734,7 @@ To destroy an
<function>XModifierKeymap</function>
structure, use
<function>XFreeModifiermap .</function>
<!-- .IN "XFreeModifiermap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeModifiermap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3772,7 +3772,7 @@ structure.
<!-- .sp -->
To set the KeyCodes to be used as modifiers, use
<function>XSetModifierMapping .</function>
<!-- .IN "XSetModifierMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetModifierMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3886,7 +3886,7 @@ errors.
<!-- .sp -->
To obtain the KeyCodes used as modifiers, use
<function>XGetModifierMapping .</function>
<!-- .IN "XGetModifierMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetModifierMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

306
specs/libX11/CH13.xml
View file

@ -141,7 +141,7 @@ is selecting one of several styles of keyboard input method.
<!-- .sp -->
To configure Xlib locale modifiers for the current locale, use
<function>XSetLocaleModifiers .</function>
<!-- .IN "XSetLocaleModifiers" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetLocaleModifiers</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -540,7 +540,7 @@ A NULL identifies the end of a nested list.
<!-- .sp -->
To allocate a nested variable argument list dynamically, use
<function>XVaCreateNestedList .</function>
<!-- .IN "XVaCreateNestedList" "" @DEF@" -->
<indexterm significance="preferred"><primary>XVaCreateNestedList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -727,7 +727,7 @@ a broader, more generalized abstraction.
<!-- .LP -->
To open an output method, use
<function>XOpenOM .</function>
<!-- .IN "XOpenOM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XOpenOM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -845,7 +845,7 @@ returns NULL if no output method could be opened.
<!-- .sp -->
To close an output method, use
<function>XCloseOM .</function>
<!-- .IN "XCloseOM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCloseOM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -879,7 +879,7 @@ function closes the specified output method.
<!-- .sp -->
To set output method attributes, use
<function>XSetOMValues .</function>
<!-- .IN "XSetOMValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetOMValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -932,7 +932,7 @@ No standard arguments are currently defined by Xlib.
<!-- .sp -->
To query an output method, use
<function>XGetOMValues .</function>
<!-- .IN "XGetOMValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetOMValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -980,7 +980,7 @@ it returns the name of the first argument that could not be obtained.
<!-- .LP -->
To obtain the display associated with an output method, use
<function>XDisplayOfOM .</function>
<!-- .IN "XDisplayOfOM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDisplayOfOM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1014,7 +1014,7 @@ function returns the display associated with the specified output method.
<!-- .sp -->
To get the locale associated with an output method, use
<function>XLocaleOfOM .</function>
<!-- .IN "XLocaleOfOM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLocaleOfOM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1136,7 +1136,7 @@ The value of the argument is a pointer to a structure of type
The
<function>XOMCharSetList</function>
structure is defined as follows:
<!-- .IN "XOMCharSetList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XOMCharSetList</primary></indexterm>
<!-- .sM -->
</para>
<!-- .LP -->
@ -1350,7 +1350,7 @@ is defined as an upward compatible type of
<!-- .sp -->
To create an output context, use
<function>XCreateOC .</function>
<!-- .IN "XCreateOC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateOC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1436,7 +1436,7 @@ error.
<!-- .sp -->
To destroy an output context, use
<function>XDestroyOC .</function>
<!-- .IN "XDestroyOC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyOC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1470,7 +1470,7 @@ function destroys the specified output context.
<!-- .sp -->
To get the output method associated with an output context, use
<function>XOMOfOC .</function>
<!-- .IN "XOMOfOC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XOMOfOC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1517,7 +1517,7 @@ with a character string using the X Portable Character Set.
<!-- .sp -->
To set XOC values, use
<function>XSetOCValues .</function>
<!-- .IN "XSetOCValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetOCValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1594,7 +1594,7 @@ error.
<!-- .sp -->
To obtain XOC values, use
<function>XGetOCValues .</function>
<!-- .IN "XGetOCValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetOCValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2142,7 +2142,7 @@ so that the output context self indicates whether it was created by
<function>XCreateOC</function>
or
<function>XCreateFontSet .</function>
<!-- .IN "XCreateFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2472,7 +2472,7 @@ structures and full font names given an
<function>XFontSet ,</function>
use
<function>XFontsOfFontSet .</function>
<!-- .IN "XFontsOfFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFontsOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2581,7 +2581,7 @@ To obtain the base font name list and the selected font name list given an
<function>XFontSet ,</function>
use
<function>XBaseFontNameListOfFontSet .</function>
<!-- .IN "XBaseFontNameListOfFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XBaseFontNameListOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2643,7 +2643,7 @@ To obtain the locale name given an
<function>XFontSet ,</function>
use
<function>XLocaleOfFontSet .</function>
<!-- .IN "XLocaleOfFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLocaleOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2696,7 +2696,7 @@ also frees its associated
<function>XOM</function>
if the output context was created by
<function>XCreateFontSet .</function>
<!-- .IN "XFreeFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2800,7 +2800,7 @@ to obtain proper rendering.
<!-- .sp -->
To find out about direction-dependent rendering, use
<function>XDirectionalDependentDrawing .</function>
<!-- .IN "XDirectionalDependentDrawing" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDirectionalDependentDrawing</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2838,7 +2838,7 @@ otherwise, it returns
<!-- .sp -->
To find out about context-dependent rendering, use
<function>XContextualDrawing .</function>
<!-- .IN "XContextualDrawing" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XContextualDrawing</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2876,7 +2876,7 @@ otherwise, it returns
<!-- .sp -->
To find out about context-dependent or direction-dependent rendering, use
<function>XContextDependentDrawing .</function>
<!-- .IN "XContextDependentDrawing" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XContextDependentDrawing</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2925,7 +2925,7 @@ The maximum character extents for the fonts that are used by the text
drawing layers can be accessed by the
<function>XFontSetExtents</function>
structure:
<!-- .IN "XFontSetExtents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFontSetExtents</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -2990,7 +2990,7 @@ To obtain the maximum extents structure given an
<function>XFontSet ,</function>
use
<function>XExtentsOfFontSet .</function>
<!-- .IN "XExtentsOfFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XExtentsOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3042,8 +3042,8 @@ use
<function>XmbTextEscapement</function>
or
<function>XwcTextEscapement .</function>
<!-- .IN "XmbTextEscapement" "" "@DEF@" -->
<!-- .IN "XwcTextEscapement" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbTextEscapement</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextEscapement</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3134,8 +3134,8 @@ use
<function>XmbTextExtents</function>
or
<function>XwcTextExtents .</function>
<!-- .IN "XmbTextExtents" "" "@DEF@" -->
<!-- .IN "XwcTextExtents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbTextExtents</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextExtents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3294,8 +3294,8 @@ use
<function>XmbTextPerCharExtents</function>
or
<function>XwcTextPerCharExtents .</function>
<!-- .IN "XmbTextPerCharExtents" "" "@DEF@" -->
<!-- .IN "XwcTextPerCharExtents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbTextPerCharExtents</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextPerCharExtents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3541,7 +3541,7 @@ use the following structures:
</para>
<para>
<!-- .LP -->
<!-- .IN "XmbTextItem" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbTextItem</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -3556,7 +3556,7 @@ typedef struct {
</para>
<para>
<!-- .LP -->
<!-- .IN "XwcTextItem" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XwcTextItem</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
<!-- .ta .5i 2.5i -->
@ -3576,8 +3576,8 @@ To draw text using multiple font sets in a given drawable, use
<function>XmbDrawText</function>
or
<function>XwcDrawText .</function>
<!-- .IN "XmbDrawText" "" "@DEF@" -->
<!-- .IN "XwcDrawText" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbDrawText</primary></indexterm>
<indexterm significance="preferred"><primary>XwcDrawText</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3727,8 +3727,8 @@ To draw text using a single font set in a given drawable, use
<function>XmbDrawString</function>
or
<function>XwcDrawString .</function>
<!-- .IN "XmbDrawString" "" "@DEF@" -->
<!-- .IN "XwcDrawString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbDrawString</primary></indexterm>
<indexterm significance="preferred"><primary>XwcDrawString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3873,8 +3873,8 @@ To draw image text using a single font set in a given drawable, use
<function>XmbDrawImageString</function>
or
<function>XwcDrawImageString .</function>
<!-- .IN "XmbDrawImageString" "" "@DEF@" -->
<!-- .IN "XwcDrawImageString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbDrawImageString</primary></indexterm>
<indexterm significance="preferred"><primary>XwcDrawImageString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5180,7 +5180,7 @@ IM value.
<!-- .LP -->
To open a connection, use
<function>XOpenIM .</function>
<!-- .IN "XOpenIM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XOpenIM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5301,7 +5301,7 @@ returns NULL if no input method could be opened.
<!-- .sp -->
To close a connection, use
<function>XCloseIM .</function>
<!-- .IN "XCloseIM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCloseIM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5335,7 +5335,7 @@ function closes the specified input method.
<!-- .sp -->
To set input method attributes, use
<function>XSetIMValues .</function>
<!-- .IN "XSetIMValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetIMValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5388,7 +5388,7 @@ correctly.
<!-- .sp -->
To query an input method, use
<function>XGetIMValues .</function>
<!-- .IN "XGetIMValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetIMValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5451,7 +5451,7 @@ with the returned pointer.
<!-- .sp -->
To obtain the display associated with an input method, use
<function>XDisplayOfIM .</function>
<!-- .IN "XDisplayOfIM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDisplayOfIM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5485,7 +5485,7 @@ function returns the display associated with the specified input method.
<!-- .sp -->
To get the locale associated with an input method, use
<function>XLocaleOfIM .</function>
<!-- .IN "XLocaleOfIM" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLocaleOfIM</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5519,7 +5519,7 @@ function returns the locale associated with the specified input method.
<!-- .sp -->
To register an input method instantiate callback, use
<function>XRegisterIMInstantiateCallback .</function>
<!-- .IN "XRegisterIMInstantiateCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRegisterIMInstantiateCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5615,7 +5615,7 @@ The function returns
<para>
<!-- .LP -->
The generic prototype is as follows:
<!-- .IN "IMInstantiateCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IMInstantiateCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5664,7 +5664,7 @@ Not used for this callback and always passed as NULL.
<!-- .eM -->
To unregister an input method instantiation callback, use
<function>XUnregisterIMInstantiateCallback .</function>
<!-- .IN "XUnregisterIMInstantiateCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnregisterIMInstantiateCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5895,17 +5895,17 @@ structure is defined as follows:
</para>
<!-- .LP -->
<!-- .IN "XIMStyle" "" "@DEF@" -->
<!-- .IN "XIMPreeditArea" "" "@DEF@" -->
<!-- .IN "XIMPreeditCallbacks" "" "@DEF@" -->
<!-- .IN "XIMPreeditPosition" "" "@DEF@" -->
<!-- .IN "XIMPreeditNothing" "" "@DEF@" -->
<!-- .IN "XIMPreeditNone" "" "@DEF@" -->
<!-- .IN "XIMStatusArea" "" "@DEF@" -->
<!-- .IN "XIMStatusCallbacks" "" "@DEF@" -->
<!-- .IN "XIMStatusNothing" "" "@DEF@" -->
<!-- .IN "XIMStatusNone" "" "@DEF@" -->
<!-- .IN "XIMStyles" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMStyle</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditArea</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditCallbacks</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditPosition</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditNothing</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditNone</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusArea</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusCallbacks</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusNothing</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusNone</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStyles</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
typedef unsigned long XIMStyle;
@ -5954,11 +5954,11 @@ Only these combinations are supported by the input method.
The preedit category defines what type of support is provided
by the input method for preedit information.
</para>
<!-- .IN "XIMPreeditArea" "" "@DEF@" -->
<!-- .IN "XIMPreeditPosition" "" "@DEF@" -->
<!-- .IN "XIMPreeditCallbacks" "" "@DEF@" -->
<!-- .IN "XIMPreeditNothing" "" "@DEF@" -->
<!-- .IN "XIMPreeditNone" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMPreeditArea</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditPosition</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditCallbacks</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditNothing</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditNone</primary></indexterm>
<informaltable>
<tgroup cols='2' align='center'>
<colspec colname='c1'/>
@ -6013,10 +6013,10 @@ by the input method for preedit information.
The status category defines what type of support is provided
by the input method for status information.
</para>
<!-- .IN "XIMStatusArea" "" "@DEF@" -->
<!-- .IN "XIMStatusCallbacks" "" "@DEF@" -->
<!-- .IN "XIMStatusNothing" "" "@DEF@" -->
<!-- .IN "XIMStatusNone" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMStatusArea</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusCallbacks</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusNothing</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusNone</primary></indexterm>
<informaltable>
<tgroup cols='2' align='center'>
<colspec colname='c1'/>
@ -6104,7 +6104,7 @@ or
<para>
<!-- .LP -->
The generic prototype of this callback function is as follows:
<!-- .IN "DestroyCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DestroyCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6340,7 +6340,7 @@ they should be registered with the X Consortium.
<!-- .sp -->
To create an input context, use
<function>XCreateIC .</function>
<!-- .IN "XCreateIC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateIC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6433,7 +6433,7 @@ errors.
<!-- .sp -->
To destroy an input context, use
<function>XDestroyIC .</function>
<!-- .IN "XDestroyIC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyIC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6470,7 +6470,7 @@ use
<function>XSetICFocus</function>
and
<function>XUnsetICFocus .</function>
<!-- .IN "XSetICFocus" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetICFocus</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6511,7 +6511,7 @@ does not affect the focus window value.
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XUnsetICFocus" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnsetICFocus</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6559,8 +6559,8 @@ To reset the state of an input context to its initial state, use
<function>XmbResetIC</function>
or
<function>XwcResetIC .</function>
<!-- .IN "XmbResetIC" "" "@DEF@" -->
<!-- .IN "XwcResetIC" "" "@DE@" -->
<indexterm significance="preferred"><primary>XmbResetIC</primary></indexterm>
<indexterm significance="preferred"><primary>XwcResetIC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6635,7 +6635,7 @@ The client should free the returned string by calling
<!-- .sp -->
To get the input method associated with an input context, use
<function>XIMOfIC .</function>
<!-- .IN "XIMOfIC" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMOfIC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6680,7 +6680,7 @@ with a character string using the X Portable Character Set.
<!-- .sp -->
To set XIC values, use
<function>XSetICValues .</function>
<!-- .IN "XSetICValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetICValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -6763,7 +6763,7 @@ errors.
<!-- .sp -->
To obtain XIC values, use
<function>XGetICValues .</function>
<!-- .IN "XGetICValues" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetICValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -7377,7 +7377,7 @@ and cannot be changed.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNClientWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNClientWindow</primary></indexterm>
The
<function>XNClientWindow</function>
argument specifies to the input method the client window in
@ -7417,7 +7417,7 @@ error can be generated when this value is used by the input method.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNFocusWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNFocusWindow</primary></indexterm>
The
<function>XNFocusWindow</function>
argument specifies the focus window.
@ -7473,8 +7473,8 @@ the input method will use the client window as the default focus window.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNResourceName" "" "@DEF@" -->
<!-- .IN "XNResourceClass" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNResourceName</primary></indexterm>
<indexterm significance="preferred"><primary>XNResourceClass</primary></indexterm>
The
<function>XNResourceName</function>
and
@ -7499,7 +7499,7 @@ set as resources.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNGeometryCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNGeometryCallback</primary></indexterm>
The
<function>XNGeometryCallback</function>
argument is a structure of type
@ -7527,7 +7527,7 @@ events that it uses to initiate the change.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNFilterEvents" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNFilterEvents</primary></indexterm>
The
<function>XNFilterEvents</function>
argument returns the event mask that an input method needs
@ -7711,8 +7711,8 @@ are as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMInitialState" "" "@DEF@" -->
<!-- .IN "XINPreserveState" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMInitialState</primary></indexterm>
<indexterm significance="preferred"><primary>XINPreserveState</primary></indexterm>
<!-- .sM -->
</para>
<literallayout class="monospaced">
@ -7920,8 +7920,8 @@ If not specified, the default is
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNPreeditAttributes" "" "@DEF@" -->
<!-- .IN "XNStatusAttributes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNPreeditAttributes</primary></indexterm>
<indexterm significance="preferred"><primary>XNStatusAttributes</primary></indexterm>
The
<function>XNPreeditAttributes</function>
and
@ -7943,7 +7943,7 @@ The names to be used in these lists are described in the following sections.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNArea" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNArea</primary></indexterm>
The value of the
<function>XNArea</function>
argument must be a pointer to a structure of type
@ -8005,7 +8005,7 @@ the results are undefined.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNAreaNeeded" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNAreaNeeded</primary></indexterm>
When set, the
<function>XNAreaNeeded</function>
argument specifies the geometry suggested by the client for this area
@ -8042,7 +8042,7 @@ and has no other effect on the input method
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNSpotLocation" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNSpotLocation</primary></indexterm>
The
<function>XNSpotLocation</function>
argument specifies to the input method the coordinates of the spot
@ -8083,7 +8083,7 @@ should use to allocate colors, a colormap ID, or a standard colormap name.
</para>
<para>
<!-- .LP -->
<!-- .IN "XNColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNColormap</primary></indexterm>
The
<function>XNColormap</function>
argument is used to specify a colormap ID.
@ -8095,7 +8095,7 @@ error when it is used by the input method.
</para>
<para>
<!-- .LP -->
<!-- .IN "XNStdColormap" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNStdColormap</primary></indexterm>
The
<function>XNStdColormap</function>
argument is used to indicate the name of the standard colormap
@ -8121,8 +8121,8 @@ the client window colormap becomes the default.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNForeground" "" "@DEF@" -->
<!-- .IN "XNBackground" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNForeground</primary></indexterm>
<indexterm significance="preferred"><primary>XNBackground</primary></indexterm>
The
<function>XNForeground</function>
and
@ -8169,7 +8169,7 @@ the default is determined by the input method.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNFontSet" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNFontSet</primary></indexterm>
The
<function>XNFontSet</function>
argument specifies to the input method what font set is to be used.
@ -8209,7 +8209,7 @@ the default is determined by the input method.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XNCursor" "" "DEF@" -->
<indexterm significance="preferred"><primary>XNCursor</primary></indexterm>
The
<function>XNCursor</function>
argument specifies to the input method what cursor is to be used
@ -8246,9 +8246,9 @@ are as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMPreeditUnknown" "" "@DEV@" -->
<!-- .IN "XIMPreeditEnable" "" "@DEF@" -->
<!-- .IN "XIMPreeditDisable" "" "@DEV@" -->
<indexterm significance="preferred"><primary>XIMPreeditUnknown</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditEnable</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreeditDisable</primary></indexterm>
<!-- .sM -->
</para>
<!-- .LP -->
@ -8316,7 +8316,7 @@ The value of the
argument is a pointer to a structure of type
<function>XIMCallback .</function>
The generic prototype is as follows:
<!-- .IN "PreeditStateNotifyCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>PreeditStateNotifyCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -8369,7 +8369,7 @@ structure is defined as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMPreeditStateNotifyCallbackStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMPreeditStateNotifyCallbackStruct</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -8404,10 +8404,10 @@ A client that wants to support the input style
must provide a set of preedit callbacks to the input method.
The set of preedit callbacks is as follows:
</para>
<!-- .IN "XNPreeditStartCallback" "" "@DEF@" -->
<!-- .IN "XNPreeditDoneCallback" "" "@DEF@" -->
<!-- .IN "XNPreeditDrawCallback" "" "@DEF@" -->
<!-- .IN "XNPreeditCaretCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNPreeditStartCallback</primary></indexterm>
<indexterm significance="preferred"><primary>XNPreeditDoneCallback</primary></indexterm>
<indexterm significance="preferred"><primary>XNPreeditDrawCallback</primary></indexterm>
<indexterm significance="preferred"><primary>XNPreeditCaretCallback</primary></indexterm>
<informaltable>
<tgroup cols='2' align='center'>
<colspec colname='c1'/>
@ -8441,9 +8441,9 @@ must provide a set of status callbacks to the input method.
The set of status callbacks is as follows:
</para>
<!-- .IN "XNStatusStartCallback" "" "@DEF@" -->
<!-- .IN "XNStatusDoneCallback" "" "@DEF@" -->
<!-- .IN "XNStatusDrawCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XNStatusStartCallback</primary></indexterm>
<indexterm significance="preferred"><primary>XNStatusDoneCallback</primary></indexterm>
<indexterm significance="preferred"><primary>XNStatusDrawCallback</primary></indexterm>
<informaltable>
<tgroup cols='2' align='center'>
<colspec colname='c1'/>
@ -8469,8 +8469,8 @@ The set of status callbacks is as follows:
The value of any status or preedit argument is a pointer
to a structure of type
<function>XIMCallback .</function>
<!-- .IN "XIMProc" "" "@DEF@" -->
<!-- .IN "XIMCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMProc</primary></indexterm>
<indexterm significance="preferred"><primary>XIMCallback</primary></indexterm>
<!-- .sM -->
</para>
<para>
@ -8534,7 +8534,7 @@ terminate preedit, or update the status area.
<para>
<!-- .LP -->
All callback procedures follow the generic prototype:
<!-- .IN "CallbackPrototype" "" "@DEF@" -->
<indexterm significance="preferred"><primary>CallbackPrototype</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -8606,7 +8606,7 @@ and specific data structure associated with the different reasons.
The geometry callback is triggered by the input method
to indicate that it wants the client to negotiate geometry.
The generic prototype is as follows:
<!-- .IN "GeometryCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>GeometryCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -8667,7 +8667,7 @@ The destroy callback is triggered by the input method
when it stops service for any reason.
After the callback is invoked, the input context will be freed by Xlib.
The generic prototype is as follows:
<!-- .IN "DestroyCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>DestroyCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -8729,7 +8729,7 @@ to request the client to return the string to be converted. The
returned string may be either a multibyte or wide character string,
with an encoding matching the locale bound to the input context.
The callback prototype is as follows:
<!-- .IN "StringConversionCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>StringConversionCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -8803,7 +8803,7 @@ structure is defined as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMStringConversionCallbackStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMStringConversionCallbackStruct</primary></indexterm>
<!-- .sM -->
</para>
<!-- .LP -->
@ -8890,7 +8890,7 @@ or
<function>PreeditDoneCallback</function>
callback is triggered to let the toolkit do the setup
or the cleanup for the preedit region.
<!-- .IN "PreeditStartCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>PreeditStartCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -8944,7 +8944,7 @@ will return the maximum size of the preedit string.
A positive number indicates the maximum number of bytes allowed
in the preedit string,
and a value of -1 indicates there is no limit.
<!-- .IN "PreeditDoneCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>PreeditDoneCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9025,7 +9025,7 @@ That string is either a multibyte or wide character string,
whose encoding matches the locale bound to the input context.
The callback prototype
is as follows:
<!-- .IN "PreeditDrawCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>PreeditDrawCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9087,7 +9087,7 @@ structure is defined as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMPreeditDrawCallbackStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMPreeditDrawCallbackStruct</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -9195,7 +9195,7 @@ the first and second character.
</itemizedlist>
<para>
<!-- .LP -->
<!-- .IN "XIMText" "" @DEF@" -->
<indexterm significance="preferred"><primary>XIMText</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 1.5i 3i -->
@ -9333,15 +9333,15 @@ The valid mask names are as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMReverse" "" "@DEF@" -->
<!-- .IN "XIMUnderline" "" "@DEF@" -->
<!-- .IN "XIMHighlight" "" "@DEF@" -->
<!-- .IN "XIMPrimary" "" "@DEF@" -->
<!-- .IN "XIMSecondary" "" "@DEF@" -->
<!-- .IN "XIMTertiary" "" "@DEF@" -->
<!-- .IN "XIMVisibleToForward" "" "@DEF@" -->
<!-- .IN "XIMVisibleToBackward" "" "@DEF@" -->
<!-- .IN "XIMVisibleCenter" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMReverse</primary></indexterm>
<indexterm significance="preferred"><primary>XIMUnderline</primary></indexterm>
<indexterm significance="preferred"><primary>XIMHighlight</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPrimary</primary></indexterm>
<indexterm significance="preferred"><primary>XIMSecondary</primary></indexterm>
<indexterm significance="preferred"><primary>XIMTertiary</primary></indexterm>
<indexterm significance="preferred"><primary>XIMVisibleToForward</primary></indexterm>
<indexterm significance="preferred"><primary>XIMVisibleToBackward</primary></indexterm>
<indexterm significance="preferred"><primary>XIMVisibleCenter</primary></indexterm>
<!-- .sM -->
</para>
<literallayout class="monospaced">
@ -9411,7 +9411,7 @@ to move the text insertion point in the preedit area
Consequently, input method needs to indicate to the client that it
should move the text insertion point.
It then calls the PreeditCaretCallback.
<!-- .IN "PreeditCaretCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>PreeditCaretCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9472,7 +9472,7 @@ and return, in field position, the new offset value from the initial position.
The
<function>XIMPreeditCaretCallbackStruct</function>
structure is defined as follows:
<!-- .IN "XIMPreeditCaretCallbackStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMPreeditCaretCallbackStruct</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -9496,7 +9496,7 @@ structure is defined as follows:
</para>
<para>
<!-- .LP -->
<!-- .IN "XIMCaretStyle" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMCaretStyle</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -9514,7 +9514,7 @@ typedef enum {
The
<function>XIMCaretDirection</function>
structure is defined as follows:
<!-- .IN "XIMCaretDirection" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMCaretDirection</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -9538,12 +9538,12 @@ typedef enum {
<!-- .eM -->
These values are defined as follows:
</para>
<!-- .IN "XIMForwardChar" "" "@DEF@" -->
<!-- .IN "XIMBackwardChar" "" "@DEF@" -->
<!-- .IN "XIMForwardWord" "" "@DEF@" -->
<!-- .IN "XIMBackwardWord" "" "@DEF@" -->
<!-- .IN "XIMCaretUp" "" "@DEF@" -->
<!-- .IN "XIMCaretDown" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMForwardChar</primary></indexterm>
<indexterm significance="preferred"><primary>XIMBackwardChar</primary></indexterm>
<indexterm significance="preferred"><primary>XIMForwardWord</primary></indexterm>
<indexterm significance="preferred"><primary>XIMBackwardWord</primary></indexterm>
<indexterm significance="preferred"><primary>XIMCaretUp</primary></indexterm>
<indexterm significance="preferred"><primary>XIMCaretDown</primary></indexterm>
<informaltable>
<tgroup cols='2' align='center'>
<colspec colname='c1'/>
@ -9604,12 +9604,12 @@ These values are defined as follows:
</tgroup>
</informaltable>
<!-- .IN "XIMNextLine" "" "@DEF@" -->
<!-- .IN "XIMPreviousLine" "" "@DEF@" -->
<!-- .IN "XIMLineStart" "" "@DEF@" -->
<!-- .IN "XIMLineEnd" "" "@DEF@" -->
<!-- .IN "XIMAbsolutePosition" "" "@DEF@" -->
<!-- .IN "XIMDontChange" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMNextLine</primary></indexterm>
<indexterm significance="preferred"><primary>XIMPreviousLine</primary></indexterm>
<indexterm significance="preferred"><primary>XIMLineStart</primary></indexterm>
<indexterm significance="preferred"><primary>XIMLineEnd</primary></indexterm>
<indexterm significance="preferred"><primary>XIMAbsolutePosition</primary></indexterm>
<indexterm significance="preferred"><primary>XIMDontChange</primary></indexterm>
</sect3>
<sect3 id="Status_Callbacks">
<title>Status Callbacks</title>
@ -9627,7 +9627,7 @@ callbacks: StatusStartCallback, StatusDoneCallback, and StatusDrawCallback.
<!-- .sp -->
When the input context is created or gains focus,
the input method calls the StatusStartCallback callback.
<!-- .IN "StatusStartCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>StatusStartCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9684,7 +9684,7 @@ it will not be called again before StatusDoneCallback has been called.
<!-- .sp -->
When an input context
is destroyed or when it loses focus, the input method calls StatusDoneCallback.
<!-- .IN "StatusDoneCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>StatusDoneCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9739,7 +9739,7 @@ The callback may release any data allocated on
<!-- .sp -->
When an input context status has to be updated, the input method calls
StatusDrawCallback.
<!-- .IN "StatusDrawCallback" "" "@DEF@" -->
<indexterm significance="preferred"><primary>StatusDrawCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9796,8 +9796,8 @@ The
and
<function>XIMStatusDrawCallbackStruct</function>
structures are defined as follows:
<!-- .IN "XIMStatusDataType" "" "@DEF@" -->
<!-- .IN "XIMStatusDrawCallbackStruct" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIMStatusDataType</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusDrawCallbackStruct</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -9877,7 +9877,7 @@ Clients should discard filtered events.
<!-- .LP -->
To filter an event, use
<function>XFilterEvent .</function>
<!-- .IN "XFilterEvent" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFilterEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -9960,8 +9960,8 @@ use
<function>XmbLookupString</function>
or
<function>XwcLookupString .</function>
<!-- .IN "XmbLookupString" "" "@DEF@" -->
<!-- .IN "XwcLookupString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbLookupString</primary></indexterm>
<indexterm significance="preferred"><primary>XwcLookupString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

108
specs/libX11/CH14.xml
View file

@ -254,7 +254,7 @@ to manipulate your application's subwindows.
<!-- .LP -->
To request that a top-level window be iconified, use
<function>XIconifyWindow .</function>
<!-- .IN "XIconifyWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIconifyWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -328,7 +328,7 @@ otherwise, it returns a zero status.
<!-- .LP -->
To request that a top-level window be withdrawn, use
<function>XWithdrawWindow .</function>
<!-- .IN "XWithdrawWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWithdrawWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -402,7 +402,7 @@ error.
<!-- .LP -->
To request that a top-level window be reconfigured, use
<function>XReconfigureWMWindow .</function>
<!-- .IN "XReconfigureWMWindow" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XReconfigureWMWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -518,7 +518,7 @@ as well as its value.
The
<function>XTextProperty</function>
structure contains:
<!-- .IN "XTextProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextProperty</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -575,8 +575,8 @@ structure, use
<function>XmbTextListToTextProperty</function>
or
<function>XwcTextListToTextProperty .</function>
<!-- .IN "XmbTextListToTextProperty" "" "@DEF@" -->
<!-- .IN "XwcTextListToTextProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbTextListToTextProperty</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextListToTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -737,8 +737,8 @@ structure, use
<function>XmbTextPropertyToTextList</function>
or
<function>XwcTextPropertyToTextList .</function>
<!-- .IN "XmbTextPropertyToTextList" "" "@DEF@" -->
<!-- .IN "XwcTextPropertyToTextList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbTextPropertyToTextList</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextPropertyToTextList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -896,7 +896,7 @@ use
To free the in-memory data associated with the specified
wide character string list, use
<function>XwcFreeStringList .</function>
<!-- .IN "XwcFreeStringList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XwcFreeStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -980,7 +980,7 @@ To set the specified list of strings in the STRING encoding to a
<function>XTextProperty</function>
structure, use
<function>XStringListToTextProperty .</function>
<!-- .IN "XStringListToTextProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XStringListToTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1055,7 +1055,7 @@ To obtain a list of strings from a specified
<function>XTextProperty</function>
structure in the STRING encoding, use
<function>XTextPropertyToStringList .</function>
<!-- .IN "XTextPropertyToStringList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XTextPropertyToStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1128,7 +1128,7 @@ To free the storage for the list and its contents, use
<!-- .LP -->
To free the in-memory data associated with the specified string list, use
<function>XFreeStringList .</function>
<!-- .IN "XFreeStringList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFreeStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1185,7 +1185,7 @@ see sections 14.1.4, 14.1.5, 14.2.1, and 14.2.2, respectively.
<!-- .LP -->
To set one of a window's text properties, use
<function>XSetTextProperty .</function>
<!-- .IN "XSetTextProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1273,7 +1273,7 @@ errors.
<!-- .LP -->
To read one of a window's text properties, use
<function>XGetTextProperty .</function>
<!-- .IN "XGetTextProperty" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1389,7 +1389,7 @@ the WM_NAME property for a given window.
<!-- .LP -->
To set a window's WM_NAME property with the supplied convenience function, use
<function>XSetWMName .</function>
<!-- .IN "XSetWMName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1449,7 +1449,7 @@ to set the WM_NAME property.
<!-- .LP -->
To read a window's WM_NAME property with the supplied convenience function, use
<function>XGetWMName .</function>
<!-- .IN "XGetWMName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1521,8 +1521,8 @@ for window names that are encoded as STRING properties.
<!-- .LP -->
To assign a name to a window, use
<function>XStoreName .</function>
<!-- .IN "Window" "name" -->
<!-- .IN "XStoreName" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>name</secondary></indexterm>
<indexterm significance="preferred"><primary>XStoreName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1595,7 +1595,7 @@ errors.
<!-- .sp -->
To get the name of a window, use
<function>XFetchName .</function>
<!-- .IN "XFetchName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFetchName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1683,7 +1683,7 @@ the WM_ICON_NAME property for a given window.
To set a window's WM_ICON_NAME property,
use
<function>XSetWMIconName .</function>
<!-- .IN "XSetWMIconName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1744,7 +1744,7 @@ to set the WM_ICON_NAME property.
To read a window's WM_ICON_NAME property,
use
<function>XGetWMIconName .</function>
<!-- .IN "XGetWMIconName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1817,8 +1817,8 @@ for window names that are encoded as STRING properties.
<!-- .sp -->
To set the name to be displayed in a window's icon, use
<function>XSetIconName .</function>
<!-- .IN "Window" "icon name" -->
<!-- .IN "XSetIconName" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>icon name</secondary></indexterm>
<indexterm significance="preferred"><primary>XSetIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1880,7 +1880,7 @@ errors.
<!-- .sp -->
To get the name a window wants displayed in its icon, use
<function>XGetIconName .</function>
<!-- .IN "XGetIconName" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2115,7 +2115,7 @@ or the window to be withdrawn.
<!-- .sp -->
To set a window's WM_HINTS property, use
<function>XSetWMHints .</function>
<!-- .IN "XSetWMHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2184,7 +2184,7 @@ errors.
<!-- .sp -->
To read a window's WM_HINTS property, use
<function>XGetWMHints .</function>
<!-- .IN "XGetWMHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2378,7 +2378,7 @@ macro is highly discouraged.
<!-- .LP -->
To set a window's WM_NORMAL_HINTS property, use
<function>XSetWMNormalHints .</function>
<!-- .IN "XSetWMNormalHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2448,7 +2448,7 @@ errors.
<!-- .LP -->
To read a window's WM_NORMAL_HINTS property, use
<function>XGetWMNormalHints .</function>
<!-- .IN "XGetWMNormalHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2559,7 +2559,7 @@ error.
<!-- .LP -->
To set a window's WM_SIZE_HINTS property, use
<function>XSetWMSizeHints .</function>
<!-- .IN "XSetWMSizeHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2648,7 +2648,7 @@ errors.
<!-- .LP -->
To read a window's WM_SIZE_HINTS property, use
<function>XGetWMSizeHints .</function>
<!-- .IN "XGetWMSizeHints" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2797,7 +2797,7 @@ To allocate an
<function>XClassHint</function>
structure, use
<function>XAllocClassHint .</function>
<!-- .IN "XAllocClassHint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAllocClassHint</primary></indexterm>
<!-- .sM -->
</para>
<para>
@ -2832,7 +2832,7 @@ contains:
<para>
<!-- .LP -->
<!-- .sM -->
<!-- .IN "XClassHint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XClassHint</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i -->
<!-- .ta .5i -->
@ -2861,7 +2861,7 @@ resource database.
<!-- .sp -->
To set a window's WM_CLASS property, use
<function>XSetClassHint .</function>
<!-- .IN "XSetClassHint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetClassHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2930,7 +2930,7 @@ errors.
<!-- .sp -->
To read a window's WM_CLASS property, use
<function>XGetClassHint .</function>
<!-- .IN "XGetClassHint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetClassHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3016,7 +3016,7 @@ the WM_TRANSIENT_FOR property for a given window.
<!-- .sp -->
To set a window's WM_TRANSIENT_FOR property, use
<function>XSetTransientForHint .</function>
<!-- .IN "XSetTransientForHint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetTransientForHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3082,7 +3082,7 @@ errors.
<!-- .sp -->
To read a window's WM_TRANSIENT_FOR property, use
<function>XGetTransientForHint .</function>
<!-- .IN "XGetTransientForHint" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetTransientForHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3158,7 +3158,7 @@ the WM_PROTOCOLS property for a given window.
<!-- .sp -->
To set a window's WM_PROTOCOLS property, use
<function>XSetWMProtocols .</function>
<!-- .IN "XSetWMProtocols" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMProtocols</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3245,7 +3245,7 @@ errors.
<!-- .LP -->
To read a window's WM_PROTOCOLS property, use
<function>XGetWMProtocols .</function>
<!-- .IN "XGetWMProtocols" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMProtocols</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3344,7 +3344,7 @@ the WM_COLORMAP_WINDOWS property for a given window.
<!-- .LP -->
To set a window's WM_COLORMAP_WINDOWS property, use
<function>XSetWMColormapWindows .</function>
<!-- .IN "XSetWMColormapWindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMColormapWindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3431,7 +3431,7 @@ errors.
<!-- .LP -->
To read a window's WM_COLORMAP_WINDOWS property, use
<function>XGetWMColormapWindows .</function>
<!-- .IN "XGetWMColormapWindows" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMColormapWindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3526,7 +3526,7 @@ Xlib provides functions that you can use to set and read
the WM_ICON_SIZE property for a given window.
These functions use the
<function>XIconSize </function>
<!-- .IN "XIconSize" -->
<indexterm><primary>XIconSize</primary></indexterm>
structure, which is defined in the
<!-- .hN X11/Xutil.h -->
header file.
@ -3571,7 +3571,7 @@ structure contains:
<para>
<!-- .LP -->
<!-- .sM -->
<!-- .IN "XIconSize" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIconSize</primary></indexterm>
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
<!-- .ta .5i 2.5i -->
@ -3593,7 +3593,7 @@ sizes (minimum to maximum) that represent the supported icon sizes.
<!-- .sp -->
To set a window's WM_ICON_SIZE property, use
<function>XSetIconSizes .</function>
<!-- .IN "XSetIconSizes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetIconSizes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3669,7 +3669,7 @@ errors.
<!-- .sp -->
To read a window's WM_ICON_SIZE property, use
<function>XGetIconSizes .</function>
<!-- .IN "XGetIconSizes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetIconSizes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3766,7 +3766,7 @@ for internationalized text communication.
The standard window manager properties for a given window are
WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS,
WM_COMMAND, WM_CLIENT_MACHINE, and WM_LOCALE_NAME.
<!-- .IN "XmbSetWMProperties" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XmbSetWMProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3984,7 +3984,7 @@ with strings in client-specified encodings, use
The standard window manager properties for a given window are
WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS,
WM_COMMAND, and WM_CLIENT_MACHINE.
<!-- .IN "XSetWMProperties" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4210,7 +4210,7 @@ the WM_COMMAND property for a given window.
<!-- .LP -->
To set a window's WM_COMMAND property, use
<function>XSetCommand .</function>
<!-- .IN "XSetCommand" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetCommand</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4290,7 +4290,7 @@ errors.
<!-- .LP -->
To read a window's WM_COMMAND property, use
<function>XGetCommand .</function>
<!-- .IN "XGetCommand" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetCommand</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4381,7 +4381,7 @@ the WM_CLIENT_MACHINE property for a given window.
<!-- .LP -->
To set a window's WM_CLIENT_MACHINE property, use
<function>XSetWMClientMachine .</function>
<!-- .IN "XSetWMClientMachine" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetWMClientMachine</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4441,7 +4441,7 @@ to set the WM_CLIENT_MACHINE property.
<!-- .LP -->
To read a window's WM_CLIENT_MACHINE property, use
<function>XGetWMClientMachine .</function>
<!-- .IN "XGetWMClientMachine" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetWMClientMachine</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4764,8 +4764,8 @@ as well as how to manipulate standard colormaps.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Standard Colormaps" -->
<!-- .IN "Colormaps" "standard" -->
<indexterm><primary>Standard Colormaps</primary></indexterm>
<indexterm><primary>Colormaps</primary><secondary>standard</secondary></indexterm>
Several standard colormaps are available.
Each standard colormap is defined by a property,
and each such property is identified by an atom.
@ -4900,7 +4900,7 @@ To set an
<function>XStandardColormap</function>
structure, use
<function>XSetRGBColormaps .</function>
<!-- .IN "XSetRGBColormaps" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetRGBColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -5080,7 +5080,7 @@ To obtain the
<function>XStandardColormap </function>
structure associated with the specified property, use
<function>XGetRGBColormaps .</function>
<!-- .IN "XGetRGBColormaps" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetRGBColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

68
specs/libX11/CH15.xml
View file

@ -352,7 +352,7 @@ but its use is entirely local to your application.
To allocate a new quark, use
<function>XrmUniqueQuark .</function>
</para>
<!-- .IN "XrmUniqueQuark" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmUniqueQuark</primary></indexterm>
<!-- .sM -->
<para>XrmQuark XrmUniqueQuark()</para>
<!-- .FN -->
@ -410,8 +410,8 @@ or
#define XrmStringToRepresentation(string) XrmStringToQuark(string)
</literallayout>
<!-- .IN "XrmStringToQuark" "" "@DEF@" -->
<!-- .IN "XrmPermStringToQuark" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmStringToQuark</primary></indexterm>
<indexterm significance="preferred"><primary>XrmPermStringToQuark</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -469,7 +469,7 @@ To convert a quark to a string, use
#define XrmClassToString(class) XrmQuarkToString(name)
#define XrmRepresentationToString(type) XrmQuarkToString(type)
</literallayout>
<!-- .IN "XrmQuarkToString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmQuarkToString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -516,7 +516,7 @@ To convert a string with one or more components to a quark list, use
#define XrmStringToClassList(str,class) XrmStringToQuarkList((str), (class))
</literallayout>
<!-- .IN "XrmStringToQuarkList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmStringToQuarkList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -590,7 +590,7 @@ indicates that an asterisk separates the components.
To convert a string with one or more components to a binding list
and a quark list, use
<function>XrmStringToBindingQuarkList .</function>
<!-- .IN "XrmStringToBindingQuarkList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmStringToBindingQuarkList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -666,7 +666,7 @@ bindings: loose tight loose
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "XrmDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmDatabase</primary></indexterm>
A resource database is an opaque type,
<function>XrmDatabase .</function>
Each database value is stored in an
@ -683,7 +683,7 @@ structure is defined as:
</para>
<para>
<!-- .LP -->
<!-- .IN "XrmValue" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmValue</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 3i -->
@ -700,7 +700,7 @@ typedef struct {
<!-- .sp -->
To initialize the resource manager, use
<function>XrmInitialize .</function>
<!-- .IN "XrmInitialize" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmInitialize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -715,7 +715,7 @@ To initialize the resource manager, use
<!-- .eM -->
To retrieve a database from disk, use
<function>XrmGetFileDatabase .</function>
<!-- .IN "XrmGetFileDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmGetFileDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -759,7 +759,7 @@ returns NULL.
<!-- .sp -->
To store a copy of a database to disk, use
<function>XrmPutFileDatabase .</function>
<!-- .IN "XrmPutFileDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmPutFileDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -812,7 +812,7 @@ Entries with representation types other than ``String'' are ignored.
<!-- .sp -->
To obtain a pointer to the screen-independent resources of a display, use
<function>XResourceManagerString .</function>
<!-- .IN "XResourceManagerString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XResourceManagerString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -856,7 +856,7 @@ If no property exists, NULL is returned.
<!-- .sp -->
To obtain a pointer to the screen-specific resources of a screen, use
<function>XScreenResourceString .</function>
<!-- .IN "XScreenResourceString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XScreenResourceString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -900,7 +900,7 @@ The caller is responsible for freeing the returned string by using
<!-- .sp -->
To create a database from a string, use
<function>XrmGetStringDatabase .</function>
<!-- .IN "XrmGetStringDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmGetStringDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -945,7 +945,7 @@ and the database is created in the current locale.
<!-- .sp -->
To obtain the locale name of a database, use
<function>XrmLocaleOfDatabase .</function>
<!-- .IN "XrmLocaleOfDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmLocaleOfDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -985,7 +985,7 @@ it will not be modified by Xlib.
<!-- .sp -->
To destroy a resource database and free its allocated memory, use
<function>XrmDestroyDatabase .</function>
<!-- .IN "XrmDestroyDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmDestroyDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1019,7 +1019,7 @@ returns immediately.
<!-- .sp -->
To associate a resource database with a display, use
<function>XrmSetDatabase .</function>
<!-- .IN "XrmSetDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmSetDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1068,7 +1068,7 @@ once it is constructed.
<!-- .sp -->
To get the resource database associated with a display, use
<function>XrmGetDatabase .</function>
<!-- .IN "XrmGetDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmGetDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1108,7 +1108,7 @@ It returns NULL if a database has not yet been set.
<!-- .LP -->
To merge the contents of a resource file into a database, use
<function>XrmCombineFileDatabase .</function>
<!-- .IN "XrmCombineFileDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmCombineFileDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1182,7 +1182,7 @@ The locale of the target database is not modified.
<!-- .sp -->
To merge the contents of one database into another database, use
<function>XrmCombineDatabase .</function>
<!-- .IN "XrmCombineDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmCombineDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1252,7 +1252,7 @@ The locale of the target database is not modified.
To merge the contents of one database into another database with override
semantics, use
<function>XrmMergeDatabases .</function>
<!-- .IN "XrmMergeDatabases" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmMergeDatabases</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1312,7 +1312,7 @@ or
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XrmGetResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmGetResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1382,7 +1382,7 @@ Returns the value in the database.
<!-- .LP -->
<!-- .eM -->
<!-- .sp -->
<!-- .IN "XrmQGetResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmQGetResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1504,7 +1504,7 @@ of database levels that might match the first part of a name/class list.
<!-- .sp -->
To obtain a list of database levels, use
<function>XrmQGetSearchList .</function>
<!-- .IN "XrmQGetSearchList" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmQGetSearchList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1611,7 +1611,7 @@ only the common prefix should be specified in the name and class list to
<!-- .sp -->
To search resource database levels for a given resource, use
<function>XrmQGetSearchResource .</function>
<!-- .IN "XrmQGetSearchResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmQGetSearchResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1725,7 +1725,7 @@ This value is copied into the specified database.
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XrmPutResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmPutResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1803,7 +1803,7 @@ The value is stored in the database without modification.
<para>
<!-- .LP -->
<!-- .sp -->
<!-- .IN "XrmQPutResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmQPutResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1885,7 +1885,7 @@ The value is stored in the database without modification.
<!-- .sp -->
To add a resource that is specified as a string, use
<function>XrmPutStringResource .</function>
<!-- .IN "XrmPutStringResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmPutStringResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1952,7 +1952,7 @@ The value is stored in the database without modification.
<!-- .sp -->
To add a string resource using quarks as a specification, use
<function>XrmQPutStringResource .</function>
<!-- .IN "XrmQPutStringResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmQPutStringResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2030,7 +2030,7 @@ The value is stored in the database without modification.
To add a single resource entry that is specified as a string that contains
both a name and a value, use
<function>XrmPutLineResource .</function>
<!-- .IN "XrmPutLineResource" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmPutLineResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2092,7 +2092,7 @@ Note that comment lines are not stored.
<!-- .LP -->
To enumerate the entries of a database, use
<function>XrmEnumerateDatabase .</function>
<!-- .IN "XrmEnumerateDatabase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmEnumerateDatabase</primary></indexterm>
<!-- .sM -->
</para>
@ -2249,7 +2249,7 @@ and modify a resource database with selected entries from the command line.
</para>
<para>
<!-- .LP -->
<!-- .IN "XrmOptionKind" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmOptionKind</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -2283,7 +2283,7 @@ indicates that only the option itself is to be skipped.
</para>
<para>
<!-- .LP -->
<!-- .IN "XrmOptionDescRec" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmOptionDescRec</primary></indexterm>
<!-- .sM -->
<literallayout class="monospaced">
<!-- .TA .5i 2.5i -->
@ -2303,7 +2303,7 @@ typedef struct {
<!-- .sp -->
To load a resource database from a C command line, use
<function>XrmParseCommand .</function>
<!-- .IN "XrmParseCommand" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XrmParseCommand</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

116
specs/libX11/CH16.xml
View file

@ -95,7 +95,7 @@ use the functions described in section 12.7.
<!-- .sp -->
To obtain a KeySym for the KeyCode of an event, use
<function>XLookupKeysym .</function>
<!-- .IN "XLookupKeysym" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLookupKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -153,7 +153,7 @@ returns
<!-- .sp -->
To obtain a KeySym for a specific KeyCode, use
<function>XKeycodeToKeysym .</function>
<!-- .IN "XKeycodeToKeysym" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XKeycodeToKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -215,7 +215,7 @@ returns
<!-- .sp -->
To obtain a KeyCode for a key having a specific KeySym, use
<function>XKeysymToKeycode .</function>
<!-- .IN "XKeysymToKeycode" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XKeysymToKeycode</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -263,7 +263,7 @@ When this information is changed at the server, an Xlib function must
be called to refresh the cache.
To refresh the stored modifier and keymap information, use
<function>XRefreshKeyboardMapping .</function>
<!-- .IN "XRefreshKeyboardMapping" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRefreshKeyboardMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -305,7 +305,7 @@ The result is to update Xlib's knowledge of the keyboard.
<!-- .sp -->
To obtain the uppercase and lowercase forms of a KeySym, use
<function>XConvertCase .</function>
<!-- .IN "XConvertCase" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XConvertCase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -368,7 +368,7 @@ implementation-dependent.
KeySyms have string names as well as numeric codes.
To convert the name of the KeySym to the KeySym code, use
<function>XStringToKeysym .</function>
<!-- .IN "XStringToKeysym" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XStringToKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -415,7 +415,7 @@ returns
<!-- .sp -->
To convert a KeySym code to the name of the KeySym, use
<function>XKeysymToString .</function>
<!-- .IN "XKeysymToString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XKeysymToString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -477,7 +477,7 @@ Specifies the KeySym that is to be tested.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsCursorKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsCursorKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a cursor key.
@ -504,7 +504,7 @@ Specifies the KeySym that is to be tested.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsFunctionKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsFunctionKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a function key.
@ -531,7 +531,7 @@ Specifies the KeySym that is to be (Fn.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsKeypadKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsKeypadKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a standard keypad key.
@ -557,7 +557,7 @@ Specifies the KeySym that is to be (Fn.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsPrivateKeypadKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsPrivateKeypadKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a vendor-private keypad key.
@ -585,7 +585,7 @@ Specifies the KeySym that is to be (Fn.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsMiscFunctionKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsMiscFunctionKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a miscellaneous function key.
@ -611,7 +611,7 @@ Specifies the KeySym that is to be tested.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsModifierKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsModifierKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a modifier key.
@ -635,7 +635,7 @@ Specifies the KeySym that is to be tested.
<para>
<!-- .LP -->
<!-- .eM -->
<!-- .IN "IsPFKey" "" "@DEF@" -->
<indexterm significance="preferred"><primary>IsPFKey</primary></indexterm>
Returns
<function>True</function>
if the specified KeySym is a PF key.
@ -663,7 +663,7 @@ described in chapter 13 and does not depend on the current locale.
<!-- .sp -->
To map a key event to an ISO Latin-1 string, use
<function>XLookupString .</function>
<!-- .IN "XLookupString" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XLookupString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -785,7 +785,7 @@ To rebind the meaning of a KeySym for
<function>XLookupString ,</function>
use
<function>XRebindKeysym .</function>
<!-- .IN "XRebindKeysym" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRebindKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -890,7 +890,7 @@ Note that you can rebind a KeySym that may not exist.
<!-- .LP -->
To allocate some memory you will never give back, use
<function>Xpermalloc .</function>
<!-- .IN "Xpermalloc" "" "@DEF@" -->
<indexterm significance="preferred"><primary>Xpermalloc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -920,8 +920,8 @@ the standard operating system memory allocator.
<!-- .LP -->
To parse standard window geometry strings, use
<function>XParseGeometry .</function>
<!-- .IN "Window" "determining location" -->
<!-- .IN "XParseGeometry" "" "@DEF@" -->
<indexterm><primary>Window</primary><secondary>determining location</secondary></indexterm>
<indexterm significance="preferred"><primary>XParseGeometry</primary></indexterm>
</para>
<para>
<!-- .LP -->
@ -1055,7 +1055,7 @@ you should place the window at the requested position.
<!-- .LP -->
To construct a window's geometry information, use
<function>XWMGeometry .</function>
<!-- .IN "XWMGeometry" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWMGeometry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1291,7 +1291,7 @@ To create a new empty region, use
To generate a region from a polygon, use
<function>XPolygonRegion .</function>
</para>
<!-- .IN "XPolygonRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPolygonRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1354,7 +1354,7 @@ see
<!-- .sp -->
To set the clip-mask of a GC to a region, use
<function>XSetRegion .</function>
<!-- .IN "XSetRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSetRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1414,7 +1414,7 @@ the region can be destroyed.
<!-- .sp -->
To deallocate the storage associated with a specified region, use
<function>XDestroyRegion .</function>
<!-- .IN "XDestroyRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1450,7 +1450,7 @@ Specifies the region.
<!-- .LP -->
To move a region by a specified amount, use
<function>XOffsetRegion .</function>
<!-- .IN "XOffsetRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XOffsetRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1502,7 +1502,7 @@ which define the amount you want to (Dy the specified region.
<!-- .sp -->
To reduce a region by a specified amount, use
<function>XShrinkRegion .</function>
<!-- .IN "XShrinkRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XShrinkRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1565,7 +1565,7 @@ and negative values expand the region.
<!-- .sp -->
To generate the smallest rectangle enclosing a region, use
<function>XClipBox .</function>
<!-- .IN "XClipBox" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XClipBox</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1610,7 +1610,7 @@ function returns the smallest rectangle enclosing the specified region.
<!-- .LP -->
To compute the intersection of two regions, use
<function>XIntersectRegion .</function>
<!-- .IN "XIntersectRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XIntersectRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1659,7 +1659,7 @@ Returns the result of the computation.
<!-- .sp -->
To compute the union of two regions, use
<function>XUnionRegion .</function>
<!-- .IN "XUnionRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnionRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1708,7 +1708,7 @@ Returns the result of the computation.
<!-- .sp -->
To create a union of a source region and a rectangle, use
<function>XUnionRectWithRegion .</function>
<!-- .IN "XUnionRectWithRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XUnionRectWithRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1765,7 +1765,7 @@ and the specified source region.
<!-- .sp -->
To subtract two regions, use
<function>XSubtractRegion .</function>
<!-- .IN "XSubtractRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSubtractRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1821,7 +1821,7 @@ function subtracts srb from sra and stores the results in dr_return.
To calculate the difference between the union and intersection
of two regions, use
<function>XXorRegion .</function>
<!-- .IN "XXorRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XXorRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1878,7 +1878,7 @@ Returns the result of the computation.
<!-- .LP -->
To determine if the specified region is empty, use
<function>XEmptyRegion .</function>
<!-- .IN "XEmptyRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XEmptyRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1914,7 +1914,7 @@ if the region is empty.
<!-- .sp -->
To determine if two regions have the same offset, size, and shape, use
<function>XEqualRegion .</function>
<!-- .IN "XEqualRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XEqualRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -1966,7 +1966,7 @@ if the two regions have the same offset, size, and shape.
<!-- .LP -->
To determine if a specified point resides in a specified region, use
<function>XPointInRegion .</function>
<!-- .IN "XPointInRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPointInRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2025,7 +2025,7 @@ if the point (x, y) is contained in the region r.
<!-- .sp -->
To determine if a specified rectangle is inside a region, use
<function>XRectInRegion .</function>
<!-- .IN "XRectInRegion" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRectInRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2116,7 +2116,7 @@ if the rectangle is partially in the specified region.
<!-- .XE -->
<para>
<!-- .LP -->
<!-- .IN "Cut Buffers" -->
<indexterm><primary>Cut Buffers</primary></indexterm>
Xlib provides functions to manipulate cut buffers,
a very simple form of cut-and-paste inter-client communication.
Selections are a much more powerful and useful mechanism for
@ -2137,7 +2137,7 @@ and can be accessed as a ring or as explicit buffers (numbered 0 through 7).
<!-- .sp -->
To store data in cut buffer 0, use
<function>XStoreBytes .</function>
<!-- .IN "XStoreBytes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XStoreBytes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2202,7 +2202,7 @@ error.
<!-- .sp -->
To store data in a specified cut buffer, use
<function>XStoreBuffer .</function>
<!-- .IN "XStoreBuffer" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XStoreBuffer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2277,7 +2277,7 @@ error.
<!-- .sp -->
To return data from cut buffer 0, use
<function>XFetchBytes .</function>
<!-- .IN "XFetchBytes" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFetchBytes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2329,7 +2329,7 @@ The client must free this storage when finished with it by calling
<!-- .sp -->
To return data from a specified cut buffer, use
<function>XFetchBuffer .</function>
<!-- .IN "XFetchBuffer" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFetchBuffer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2388,7 +2388,7 @@ buffer is specified.
<!-- .sp -->
To rotate the cut buffers, use
<function>XRotateBuffers .</function>
<!-- .IN "XRotateBuffers" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XRotateBuffers</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2505,7 +2505,7 @@ typedef struct {
To obtain a list of visual information structures that match a specified
template, use
<function>XGetVisualInfo .</function>
<!-- .IN "XGetVisualInfo" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetVisualInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2580,7 +2580,7 @@ To free the data returned by this function, use
To obtain the visual information that matches the specified depth and
class of the screen, use
<function>XMatchVisualInfo .</function>
<!-- .IN "XMatchVisualInfo" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XMatchVisualInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2727,7 +2727,7 @@ To allocate an
<function>XImage </function>
structure and initialize it with image format values from a display, use
<function>XCreateImage .</function>
<!-- .IN "XCreateImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2907,7 +2907,7 @@ in the image object and are defined in
<!-- .sp -->
To obtain a pixel value in an image, use
<function>XGetPixel .</function>
<!-- .IN "XGetPixel" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XGetPixel</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -2968,7 +2968,7 @@ The image must contain the x and y coordinates.
<!-- .sp -->
To set a pixel value in an image, use
<function>XPutPixel .</function>
<!-- .IN "XPutPixel" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XPutPixel</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3040,7 +3040,7 @@ The image must contain the x and y coordinates.
<!-- .sp -->
To create a subimage, use
<function>XSubImage .</function>
<!-- .IN "XSubImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSubImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3126,7 +3126,7 @@ and subimage_height.
<!-- .sp -->
To increment each pixel in an image by a constant value, use
<function>XAddPixel .</function>
<!-- .IN "XAddPixel" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XAddPixel</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3175,7 +3175,7 @@ To deallocate the memory allocated in a previous call to
<function>XCreateImage ,</function>
use
<function>XDestroyImage .</function>
<!-- .IN "XDestroyImage" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDestroyImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3262,7 +3262,7 @@ The bitmap unit is 8.
<!-- .sp -->
To read a bitmap from a file and store it in a pixmap, use
<function>XReadBitmapFile .</function>
<!-- .IN "XReadBitmapFile" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XReadBitmapFile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3417,7 +3417,7 @@ errors.
<!-- .sp -->
To read a bitmap from a file and return it as data, use
<function>XReadBitmapFileData .</function>
<!-- .IN "XReadBitmapFileData" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XReadBitmapFileData</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3514,7 +3514,7 @@ The status and other return values are the same as for
<!-- .sp -->
To write out a bitmap from a pixmap to a file, use
<function>XWriteBitmapFile .</function>
<!-- .IN "XWriteBitmapFile" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XWriteBitmapFile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3641,7 +3641,7 @@ errors.
<!-- .sp -->
To create a pixmap and then store bitmap-format data into it, use
<function>XCreatePixmapFromBitmapData .</function>
<!-- .IN "XCreatePixmapFromBitmapData" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreatePixmapFromBitmapData</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3770,10 +3770,10 @@ errors.
<!-- .sp -->
To include a bitmap written out by
<function>XWriteBitmapFile </function>
<!-- .IN "XWriteBitmapFile" -->
<indexterm><primary>XWriteBitmapFile</primary></indexterm>
in a program directly, as opposed to reading it in every time at run time, use
<function>XCreateBitmapFromData .</function>
<!-- .IN "XCreateBitmapFromData" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XCreateBitmapFromData</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3916,7 +3916,7 @@ The symbols used are in
<!-- .sp -->
To save a data value that corresponds to a resource ID and context type, use
<function>XSaveContext .</function>
<!-- .IN "XSaveContext" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XSaveContext</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -3990,7 +3990,7 @@ Possible errors are
<!-- .sp -->
To get the data associated with a resource ID and type, use
<function>XFindContext .</function>
<!-- .IN "XFindContext" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XFindContext</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
@ -4063,7 +4063,7 @@ Possible errors are
<!-- .sp -->
To delete an entry for a given resource ID and type, use
<function>XDeleteContext .</function>
<!-- .IN "XDeleteContext" "" "@DEF@" -->
<indexterm significance="preferred"><primary>XDeleteContext</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>

266
specs/libX11/glossary.xml
View file

File diff suppressed because it is too large Load diff

1
specs/libX11/libX11.xml
View file

@ -144,5 +144,6 @@ It is provided "as is" without express or implied warranty.
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AppC.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AppD.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml"/>
<index />
</book>