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

specs/libX11: Move punctuation outside of the <function> tags

Browse source 
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2010-07-08 20:56:41 -07:00
parent d66d2134df
commit 5527b4bc8c
19 changed files with 2116 additions and 2116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

148
specs/libX11/AppC.xml
View file

@ -41,7 +41,7 @@ Basic Protocol Support Routines
The basic protocol requests for extensions are
<function>XQueryExtension</function>
and
<function>XListExtensions .</function>
<function>XListExtensions</function>.
</para>
<indexterm significance="preferred"><primary>XQueryExtension</primary></indexterm>
<!-- .sM -->
@ -98,9 +98,9 @@ function determines if the named extension is present.
If the extension is not present,
<function>XQueryExtension</function>
returns
<function>False ;</function>
<function>False</function>;
otherwise, it returns
<function>True .</function>
<function>True</function>.
If the extension is present,
<function>XQueryExtension</function>
returns the major opcode for the extension to major_opcode_return;
@ -198,7 +198,7 @@ Specifies the list of extension names.
The
<function>XFreeExtensionList</function>
function frees the memory allocated by
<function>XListExtensions .</function>
<function>XListExtensions</function>.
<!-- .SH -->
Hooking into Xlib
</para>
@ -801,15 +801,15 @@ functions allow you to define new events to the library.
An
<function>XEvent</function>
structure always has a type code (type
<function>int )</function>
<function>int</function>)
as the first component.
This uniquely identifies what kind of event it is.
The second component is always the serial number (type
<function>unsigned</function>
<function>long )</function>
<function>long</function>)
of the last request processed by the server.
The third component is always a Boolean (type
<function>Bool )</function>
<function>Bool</function>)
indicating whether the event came from a
<function>SendEvent</function>
protocol request.
@ -880,9 +880,9 @@ The
<function>XESetWireToEvent</function>
function defines a procedure to be called when an event
needs to be converted from wire format
<function>( xEvent )</function>
(<function>xEvent</function>)
to host format
<function>( XEvent ).</function>
(<function>XEvent</function>).
The event number defines which protocol event number to install a
conversion procedure for.
<function>XESetWireToEvent</function>
@ -1036,9 +1036,9 @@ The
<function>XESetEventToWire</function>
function defines a procedure to be called when an event
needs to be converted from host format
<function>( XEvent ) </function>
(<function>XEvent</function>)
to wire format
<function>( xEvent )</function>
(<function>xEvent</function>)
form.
The event number defines which protocol event number to install a
conversion procedure for.
@ -1173,9 +1173,9 @@ If the error is to be completely ignored by Xlib
(for example, several protocol error structures will be combined into
one Xlib error),
then the function should return
<function>False ;</function>
<function>False</function>;
otherwise, it should return
<function>True .</function>
<function>True</function>.
<indexterm significance="preferred"><primary>XESetError</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1232,7 +1232,7 @@ case, and are typically programmed to be synchronous).
<para>
<!-- .LP -->
When Xlib detects a protocol error in
<function>_XReply , </function>
<function>_XReply</function>,
it calls your procedure with these arguments:
</para>
<para>
@ -1425,7 +1425,7 @@ The structure pointed at by ev is guaranteed to be as large as an
structure and so can be cast to a type larger than an
<function>XErrorEvent</function>
to obtain additional values set by using
<function>XESetWireToError .</function>
<function>XESetWireToError</function>.
The underlying type of the fp argument is system dependent;
on a <acronym>POSIX</acronym>-compliant system, fp should be cast to type FILE*.
<indexterm significance="preferred"><primary>XESetFlushGC</primary></indexterm>
@ -1562,13 +1562,13 @@ Hooks onto Xlib Data Structures
Various Xlib data structures have provisions for extension procedures
to chain extension supplied data onto a list.
These structures are
<function>GC , </function>
<function>Visual , </function>
<function>Screen , </function>
<function>ScreenFormat , </function>
<function>Display , </function>
<function>GC</function>,
<function>Visual</function>,
<function>Screen</function>,
<function>ScreenFormat</function>,
<function>Display</function>,
and
<function>XFontStruct .</function>
<function>XFontStruct</function>.
Because the list pointer is always the first member in the structure,
a single set of procedures can be used to manipulate the data
on these lists.
@ -1650,11 +1650,11 @@ The
function returns a pointer to the list of extension structures attached
to the specified object.
In concert with
<function>XAddToExtensionList ,</function>
<function>XAddToExtensionList</function>,
<function>XEHeadOfExtensionList</function>
allows an extension to attach arbitrary data to any of the structures
of types contained in
<function>XEDataObject .</function>
<function>XEDataObject</function>.
</para>
<para>
<!-- .LP -->
@ -1726,7 +1726,7 @@ Specifies the extension list.
<listitem>
<para>
Specifies the extension number from
<function>XInitExtension .</function>
<function>XInitExtension</function>.
</para>
</listitem>
</varlistentry>
@ -1958,7 +1958,7 @@ single calls to be transformed into poly requests.
This may dramatically improve performance of programs that are not
written using poly requests.
A pointer to an
<function>xReq ,</function>
<function>xReq</function>,
called last_req in the display structure, is the last request being processed.
By checking that the last request
type, drawable, gc, and other options are the same as the new one
@ -2174,16 +2174,16 @@ Instead, such requests use the
structure in
&lt;X11/Xproto.h&gt;.
This structure is used for any request whose single argument is a
<function>Window , </function>
<function>Pixmap ,</function>
<function>Drawable , </function>
<function>GContext , </function>
<function>Font , </function>
<function>Cursor , </function>
<function>Colormap , </function>
<function>Atom , </function>
<function>Window</function>,
<function>Pixmap</function>,
<function>Drawable</function>,
<function>GContext</function>,
<function>Font</function>,
<function>Cursor</function>,
<function>Colormap</function>,
<function>Atom</function>,
or
<function>VisualID .</function>
<function>VisualID</function>.
</para>
<para>
<!-- .LP -->
@ -2280,9 +2280,9 @@ The reply structure is longer than 32 bytes.
<para>
<!-- .LP -->
Only
<function>GetWindowAttributes , </function>
<function>QueryFont , </function>
<function>QueryKeymap , </function>
<function>GetWindowAttributes</function>,
<function>QueryFont</function>,
<function>QueryKeymap</function>,
and
<function>GetKeyboardControl </function>
have reply structures longer than 32 bytes in the core protocol.
@ -2383,11 +2383,11 @@ Sending the Protocol Request and Arguments
After the variable declarations,
a stub procedure should call one of four macros defined in
&lt;X11/Xlibint.h&gt;:
<function>GetReq , </function>
<function>GetReqExtra , </function>
<function>GetResReq , </function>
<function>GetReq</function>,
<function>GetReqExtra</function>,
<function>GetResReq</function>,
or
<function>GetEmptyReq . </function>
<function>GetEmptyReq</function>.
All of these macros take, as their first argument,
the name of the protocol request as declared in
&lt;X11/Xproto.h&gt;
@ -2404,7 +2404,7 @@ fills in its type and length field, and sets req to point to it.
<!-- .LP -->
If the protocol request has no arguments (for instance, X_GrabServer),
then use
<function>GetEmptyReq .</function>
<function>GetEmptyReq</function>.
</para>
<para>
<!-- .LP -->
@ -2413,13 +2413,13 @@ then use
GetEmptyReq (DoSomething, req);
</literallayout>
If the protocol request has a single 32-bit argument (such as a
<function>Pixmap , </function>
<function>Window , </function>
<function>Drawable , </function>
<function>Atom , </function>
<function>Pixmap</function>,
<function>Window</function>,
<function>Drawable</function>,
<function>Atom</function>,
and so on),
then use
<function>GetResReq . </function>
<function>GetResReq</function>.
The second argument to the macro is the 32-bit object.
<function>X_MapWindow </function>
is a good example.
@ -2431,17 +2431,17 @@ is a good example.
GetResReq (DoSomething, rid, req);
</literallayout>
The rid argument is the
<function>Pixmap , </function>
<function>Window , </function>
<function>Pixmap</function>,
<function>Window</function>,
or other resource ID.
</para>
<para>
<!-- .LP -->
If the protocol request takes any other argument list,
then call
<function>GetReq . </function>
<function>GetReq</function>.
After the
<function>GetReq , </function>
<function>GetReq</function>,
you need to set all the other fields in the request structure,
usually from arguments to the stub procedure.
</para>
@ -2458,7 +2458,7 @@ req-&gt;arg2 = arg2;
A few stub procedures (such as
<function>XCreateGC </function>
and
<function>XCreatePixmap ) </function>
<function>XCreatePixmap</function>)
return a resource ID to the caller but pass a resource ID as an argument
to the protocol request.
Such procedures use the macro
@ -2479,13 +2479,13 @@ data after the request.
Typically, these procedures (such as
<function>XMoveWindow </function>
and
<function>XSetBackground ) </function>
<function>XSetBackground</function>)
are special cases of more general functions like
<function>XMoveResizeWindow </function>
and
<function>XChangeGC . </function>
<function>XChangeGC</function>.
These procedures use
<function>GetReqExtra , </function>
<function>GetReqExtra</function>,
which is the same as
<function>GetReq</function>
except that it takes an additional argument (the number of
@ -2528,7 +2528,7 @@ If it does not fit, however,
the
<function>Data </function>
macro calls
<function>_XSend , </function>
<function>_XSend</function>,
which transmits first the contents of the buffer and then your data.
The
<function>Data </function>
@ -2548,8 +2548,8 @@ and the number of bytes to be sent.
<para>
<!-- .LP -->
<!-- .eM -->
<function>Data ,</function>
<function>Data16 ,</function>
<function>Data</function>,
<function>Data16</function>,
and
<function>Data32</function>
are macros that may use their last argument
@ -2571,7 +2571,7 @@ macro.
takes the same arguments, but because it sends your data immediately instead of
copying it into the output buffer (which would later be flushed
anyway by the following call on
<function>_XReply ), </function>
<function>_XReply</function>),
it is faster.
<!-- .SH -->
Replies
@ -2676,7 +2676,7 @@ A pointer to a reply structure (which must be cast to an
<listitem>
<para>
The number of additional 32-bit words (beyond
<function>sizeof( xReply ) </function>
<function>sizeof( xReply</function>)
= 32 bytes)
in the reply structure
</para>
@ -2695,11 +2695,11 @@ beyond those it was told to read
Because most reply structures are 32 bytes long,
the third argument is usually 0.
The only core protocol exceptions are the replies to
<function>GetWindowAttributes , </function>
<function>QueryFont , </function>
<function>QueryKeymap , </function>
<function>GetWindowAttributes</function>,
<function>QueryFont</function>,
<function>QueryKeymap</function>,
and
<function>GetKeyboardControl ,</function>
<function>GetKeyboardControl</function>,
which have longer replies.
</para>
<para>
@ -2752,7 +2752,7 @@ If there is variable-length data after the reply,
change the
<function>True </function>
to
<function>False , </function>
<function>False</function>,
and use the appropriate
<function>_XRead </function>
function to read the variable-length data.
@ -3041,9 +3041,9 @@ Synchronous Calling
<!-- .LP -->
Each procedure should have a call, just before returning to the user,
to a macro called
<function>SyncHandle .</function>
<function>SyncHandle</function>.
If synchronous mode is enabled (see
<function>XSynchronize ), </function>
<function>XSynchronize</function>),
the request is sent immediately.
The library, however, waits until any error the procedure could generate
at the server has been handled.
@ -3120,7 +3120,7 @@ or
<function>Data</function>
families of macros,
after any use of
<function>_XReply ,</function>
<function>_XReply</function>,
or after any use of the
<function>_XSend</function>
or
@ -3219,7 +3219,7 @@ Specifies the size of the buffer.
<!-- .LP -->
<!-- .eM -->
You must pass back the same pointer and size that were returned by
<function>_XAllocTemp .</function>
<function>_XAllocTemp</function>.
<!-- .SH -->
Portability Considerations
</para>
@ -3255,7 +3255,7 @@ in the protocol, be sure to declare it as
<function>unsigned</function>
<function>int</function>
and not as
<function>int .</function>
<function>int</function>.
(This, of course, does not apply to Booleans or enumerations.)
</para>
<para>
@ -3270,11 +3270,11 @@ declare it as an
and not as
<function>int</function>
or
<function>long .</function>
<function>long</function>.
This also goes for any internal variables that may
take on values larger than the maximum 16-bit
<function>unsigned</function>
<function>int .</function>
<function>int</function>.
</para>
<para>
<!-- .LP -->
@ -3310,7 +3310,7 @@ in
&lt;stdio.h&gt;
and is the number of file descriptors supported on the system)
of type
<function>XExtCodes .</function>
<function>XExtCodes</function>.
Make sure these are all initialized to NULL.
</para>
</listitem>
@ -3327,7 +3327,7 @@ Call your initialization procedure and pass to it the display pointer.
<listitem>
<para>
Once in your initialization procedure, call
<function>XInitExtension ;</function>
<function>XInitExtension</function>;
if it succeeds, store the pointer returned into this array.
Make sure to establish a close display handler to allow you to zero the entry.
Do whatever other initialization your extension requires.

114
specs/libX11/AppD.xml
View file

@ -47,7 +47,7 @@ Setting Standard Properties
<!-- .LP -->
To specify a minimum set of properties describing the simplest application,
use
<function>XSetStandardProperties .</function>
<function>XSetStandardProperties</function>.
This function has been superseded by
<function>XSetWMProperties</function>
and sets all or portions of the
@ -119,7 +119,7 @@ which should be a null-terminated string.
<listitem>
<para>
Specifies the bitmap that is to be used for the icon or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -167,7 +167,7 @@ should be used to give a window manager some information about
your program's preferences.
It should not be used by applications that need
to communicate more information than is possible with
<function>XSetStandardProperties .</function>
<function>XSetStandardProperties</function>.
(Typically, argv is the argv array of your main program.)
If the strings are not in the Host Portable Character Encoding,
the result is implementation-dependent.
@ -198,9 +198,9 @@ header file and use the WM_NORMAL_HINTS property.
<!-- .LP -->
<!-- .sp -->
To set the size hints for a given window in its normal state, use
<function>XSetNormalHints .</function>
<function>XSetNormalHints</function>.
This function has been superseded by
<function>XSetWMNormalHints .</function>
<function>XSetWMNormalHints</function>.
<indexterm significance="preferred"><primary>XSetNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -287,9 +287,9 @@ errors.
<!-- .LP -->
<!-- .sp -->
To return the size hints for a window in its normal state, use
<function>XGetNormalHints .</function>
<function>XGetNormalHints</function>.
This function has been superseded by
<function>XGetWMNormalHints .</function>
<function>XGetWMNormalHints</function>.
<indexterm significance="preferred"><primary>XGetNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -358,7 +358,7 @@ The next two functions set and read the WM_ZOOM_HINTS property.
<para>
<!-- .LP -->
To set the zoom hints for a window, use
<function>XSetZoomHints .</function>
<function>XSetZoomHints</function>.
This function is no longer supported by the
<emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>.
<indexterm significance="preferred"><primary>XSetZoomHints</primary></indexterm>
@ -428,7 +428,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read the zoom hints for a window, use
<function>XGetZoomHints .</function>
<function>XGetZoomHints</function>.
This function is no longer supported by the
<emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>.
<indexterm significance="preferred"><primary>XGetZoomHints</primary></indexterm>
@ -495,9 +495,9 @@ error.
<!-- .LP -->
<!-- .sp -->
To set the value of any property of type WM_SIZE_HINTS, use
<function>XSetSizeHints .</function>
<function>XSetSizeHints</function>.
This function has been superseded by
<function>XSetWMSizeHints .</function>
<function>XSetWMSizeHints</function>.
<indexterm significance="preferred"><primary>XSetSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -572,8 +572,8 @@ Thus, it may be useful if other properties of that type get defined.
<!-- .LP -->
<function>XSetSizeHints</function>
can generate
<function>BadAlloc ,</function>
<function>BadAtom ,</function>
<function>BadAlloc</function>,
<function>BadAtom</function>,
and
<function>BadWindow </function>
errors.
@ -582,9 +582,9 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read the value of any property of type WM_SIZE_HINTS, use
<function>XGetSizeHints .</function>
<function>XGetSizeHints</function>.
This function has been superseded by
<function>XGetWMSizeHints .</function>
<function>XGetWMSizeHints</function>.
<indexterm significance="preferred"><primary>XGetSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -651,7 +651,7 @@ structure for the named property and the specified window.
This is used by
<function>XGetNormalHints</function>
and
<function>XGetZoomHints .</function>
<function>XGetZoomHints</function>.
It also can be used to retrieve the value of any property of type
WM_SIZE_HINTS.
Thus, it may be useful if other properties of that type get defined.
@ -675,9 +675,9 @@ Getting and Setting an XStandardColormap Structure
To get the
<function>XStandardColormap </function>
structure associated with one of the described atoms, use
<function>XGetStandardColormap .</function>
<function>XGetStandardColormap</function>.
This function has been superseded by
<function>XGetRGBColormap .</function>
<function>XGetRGBColormap</function>.
<indexterm significance="preferred"><primary>XGetStandardColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -777,9 +777,9 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set a standard colormap, use
<function>XSetStandardColormap .</function>
<function>XSetStandardColormap</function>.
This function has been superseded by
<function>XSetRGBColormap .</function>
<function>XSetRGBColormap</function>.
<indexterm significance="preferred"><primary>XSetStandardColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -846,9 +846,9 @@ function usually is only used by window or session managers.
<!-- .LP -->
<function>XSetStandardColormap</function>
can generate
<function>BadAlloc ,</function>
<function>BadAtom ,</function>
<function>BadDrawable ,</function>
<function>BadAlloc</function>,
<function>BadAtom</function>,
<function>BadDrawable</function>,
and
<function>BadWindow </function>
errors.
@ -859,9 +859,9 @@ Parsing Window Geometry
<!-- .LP -->
To parse window geometry given a user-specified position
and a default position, use
<function>XGeometry .</function>
<function>XGeometry</function>.
This function has been superseded by
<function>XWMGeometry .</function>
<function>XWMGeometry</function>.
<indexterm><primary>Window</primary><secondary>determining location</secondary></indexterm>
<indexterm significance="preferred"><primary>XGeometry</primary></indexterm>
<!-- .sM -->
@ -1121,7 +1121,7 @@ function returns the value of the resource <emphasis remap='I'>prog</emphasis>.<
where <emphasis remap='I'>prog</emphasis> is the program argument with the directory prefix removed
and <emphasis remap='I'>option</emphasis> must be a single component.
Note that multilevel resources cannot be used with
<function>XGetDefault .</function>
<function>XGetDefault</function>.
The class "Program.Name" is always used for the resource lookup.
If the specified option name does not exist for this program,
<function>XGetDefault</function>
@ -1133,11 +1133,11 @@ are owned by Xlib and should not be modified or freed by the client.
<para>
<!-- .LP -->
If a database has been set with
<function>XrmSetDatabase , </function>
<function>XrmSetDatabase</function>,
that database is used for the lookup.
Otherwise, a database is created
and is set in the display (as if by calling
<function>XrmSetDatabase ).</function>
<function>XrmSetDatabase</function>).
The database is created in the current locale.
To create a database,
<function>XGetDefault</function>
@ -1147,7 +1147,7 @@ If no such property exists,
a resource file in the user's home directory is used.
On a <acronym>POSIX</acronym>-conformant system,
this file is
<function>"$HOME/.Xdefaults" .</function>
<function>"$HOME/.Xdefaults"</function>.
<indexterm><primary>Files</primary><secondary>$HOME/.Xdefaults</secondary></indexterm>
After loading these defaults,
<function>XGetDefault</function>
@ -1201,16 +1201,16 @@ is much faster.
<!-- .LP -->
The functions discussed here provide all the functionality of the
X Version 10 functions
<function>XDraw , </function>
<function>XDraw</function>,
<indexterm ><primary>X10 compatibility</primary><secondary>XDraw</secondary></indexterm>
<function>XDrawFilled , </function>
<function>XDrawFilled</function>,
<indexterm><primary>X10 compatibility</primary><secondary>XDrawFilled</secondary></indexterm>
<function>XDrawPatterned , </function>
<function>XDrawPatterned</function>,
<indexterm ><primary>X10 compatibility</primary><secondary>XDrawPatterned</secondary></indexterm>
<function>XDrawDashed , </function>
<function>XDrawDashed</function>,
<indexterm><primary>X10 compatibility</primary><secondary>XDrawDashed</secondary></indexterm>
and
<function>XDrawTiled . </function>
<function>XDrawTiled</function>.
<indexterm><primary>X10 compatibility</primary><secondary>XDrawTiled</secondary></indexterm>
They are as compatible as possible given X Version 11's new line-drawing
functions.
@ -1230,7 +1230,7 @@ Just how the graphics context you use is set up actually
determines whether you get dashes or not, and so on.
Lines are properly joined if they connect and include
the closing of a closed figure (see
<function>XDrawLines ).</function>
<function>XDrawLines</function>).
The functions discussed here fail (return zero) only if they run out of memory
or are passed a
<function>Vertex </function>
@ -1248,15 +1248,15 @@ set.
<!-- .LP -->
<!-- .sp -->
To achieve the effects of the X Version 10
<function>XDraw , </function>
<function>XDraw</function>,
<indexterm ><primary>X10 compatibility</primary><secondary>XDraw</secondary></indexterm>
<function>XDrawDashed , </function>
<function>XDrawDashed</function>,
<indexterm><primary>X10 compatibility</primary><secondary>XDrawDashed</secondary></indexterm>
and
<function>XDrawPatterned , </function>
<function>XDrawPatterned</function>,
<indexterm ><primary>X10 compatibility</primary><secondary>XDrawPatterned</secondary></indexterm>
use
<function>XDraw . </function>
<function>XDraw</function>.
</para>
<para>
@ -1466,10 +1466,10 @@ To achieve the effects of the X Version 10
<function>XDrawTiled </function>
<indexterm><primary>X10 compatibility</primary><secondary>XDrawTiled</secondary></indexterm>
and
<function>XDrawFilled , </function>
<function>XDrawFilled</function>,
<indexterm><primary>X10 compatibility</primary><secondary>XDrawFilled</secondary></indexterm>
use
<function>XDrawFilled .</function>
<function>XDrawFilled</function>.
</para>
<para>#include &lt;X11/X10.h&gt;</para>
@ -1575,9 +1575,9 @@ The
<function>XAssocTable</function>
system provides users of the X library with a method
for associating their own data structures with X resources
<function>( Pixmaps , </function>
<function>Fonts , </function>
<function>Windows , </function>
(<function>Pixmaps</function>,
<function>Fonts</function>,
<function>Windows</function>,
and so on).
</para>
<para>
@ -1623,9 +1623,9 @@ bucket.
<!-- .LP -->
<!-- .sp -->
To return a pointer to a new
<function>XAssocTable , </function>
<function>XAssocTable</function>,
use
<function>XCreateAssocTable .</function>
<function>XCreateAssocTable</function>.
<indexterm significance="preferred"><primary>XCreateAssocTable</primary></indexterm>
<!-- .sM -->
</para>
@ -1644,7 +1644,7 @@ use
<listitem>
<para>
Specifies the number of buckets in the hash system of
<function>XAssocTable .</function>
<function>XAssocTable</function>.
</para>
</listitem>
</varlistentry>
@ -1655,7 +1655,7 @@ Specifies the number of buckets in the hash system of
<!-- .eM -->
The size argument specifies the number of buckets in the
hash system of
<function>XAssocTable .</function>
<function>XAssocTable</function>.
For reasons of efficiency the number of buckets
should be a power of two.
Some size suggestions might be: use 32 buckets per 100 objects,
@ -1669,9 +1669,9 @@ a NULL pointer is returned.
<!-- .LP -->
<!-- .sp -->
To create an entry in a given
<function>XAssocTable ,</function>
<function>XAssocTable</function>,
use
<function>XMakeAssoc .</function>
<function>XMakeAssoc</function>.
<indexterm significance="preferred"><primary>XMakeAssoc</primary></indexterm>
<!-- .sM -->
</para>
@ -1744,9 +1744,9 @@ the highest XID.
<!-- .LP -->
<!-- .sp -->
To obtain data from a given
<function>XAssocTable ,</function>
<function>XAssocTable</function>,
use
<function>XLookUpAssoc .</function>
<function>XLookUpAssoc</function>.
<indexterm significance="preferred"><primary>XLookUpAssoc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1809,9 +1809,9 @@ it returns NULL.
<!-- .LP -->
<!-- .sp -->
To delete an entry from a given
<function>XAssocTable ,</function>
<function>XAssocTable</function>,
use
<function>XDeleteAssoc .</function>
<function>XDeleteAssoc</function>.
<indexterm significance="preferred"><primary>XDeleteAssoc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1866,15 +1866,15 @@ function deletes an association in an
keyed on its XID.
Redundant deletes (and deletes of nonexistent XIDs) are ignored.
Deleting associations in no way impairs the performance of an
<function>XAssocTable .</function>
<function>XAssocTable</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To free the memory associated with a given
<function>XAssocTable ,</function>
<function>XAssocTable</function>,
use
<function>XDestroyAssocTable .</function>
<function>XDestroyAssocTable</function>.
</para>
<indexterm significance="preferred"><primary>XDestroyAssocTable</primary></indexterm>
<!-- .sM -->

28
specs/libX11/CH01.xml
View file

@ -153,7 +153,7 @@ which will be called when the error is reported.
<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>
<function>XSync</function>,
which blocks until all previously buffered
asynchronous events have been sent and acted on.
As an important side effect,
@ -171,13 +171,13 @@ that returns a value from the server or waits for input.
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
<function>Window , </function>
<function>Font , </function>
<function>Pixmap , </function>
<function>Colormap ,</function>
<function>Cursor , </function>
<function>Window</function>,
<function>Font</function>,
<function>Pixmap</function>,
<function>Colormap</function>,
<function>Cursor</function>,
and
<function>GContext ,</function>
<function>GContext</function>,
as defined in the file
<!-- .hN X11/X.h . -->
These resources are created by requests and are destroyed
@ -209,10 +209,10 @@ arrive asynchronously from the server and are queued until they are
requested by an explicit call (for example,
<function>XNextEvent</function>
or
<function>XWindowEvent ).</function>
<function>XWindowEvent</function>).
In addition, some library
functions (for example,
<function>XRaiseWindow )</function>
<function>XRaiseWindow</function>)
generate
<function>Expose</function>
and
@ -233,7 +233,7 @@ after calling a function that can cause the server to generate events.
<para>
<!-- .LP -->
Some functions return
<function>Status , </function>
<function>Status</function>,
an integer error indication.
If the function fails, it returns a zero.
If the function returns a status of zero,
@ -294,7 +294,7 @@ The following include files are part of the Xlib standard:
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>
<function>XlibSpecificationRelease</function>.
<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.)
@ -377,7 +377,7 @@ prior to inclusion of the file to obtain the associated values.
The preprocessor symbols are <function>XK_MISCELLANY, XK_XKB_KEYS, XK_3270,
XK_LATIN1, XK_LATIN2, XK_LATIN3, XK_LATIN4, XK_KATAKANA, XK_ARABIC,
XK_CYRILLIC, XK_GREEK, XK_TECHNICAL, XK_SPECIAL, XK_PUBLISHING, XK_APL,
XK_HEBREW, XK_THAI, and XK_KOREAN.</function>
XK_HEBREW, XK_THAI, and XK_KOREAN</function>.
</para>
</listitem>
</varlistentry>
@ -463,7 +463,7 @@ Xlib defines the type
and the Boolean values
<function>True</function>
and
<function>False .</function>
<function>False</function>.
<indexterm significance="preferred"><primary>None</primary></indexterm>
</para>
</listitem>
@ -770,7 +770,7 @@ a..z A..Z 0..9 ._-
Global symbols are printed in
<function>this </function>
<function>special </function>
<function>font .</function>
<function>font</function>.
These can be either function names,
symbols defined in include files, or structure names.
When declared and defined,

156
specs/libX11/CH02.xml
View file

@ -60,7 +60,7 @@ Use internal connections
<para>
<!-- .LP -->
To open a connection to the X server that controls a display, use
<function>XOpenDisplay .</function>
<function>XOpenDisplay</function>.
<indexterm significance="preferred"><primary>XOpenDisplay</primary></indexterm>
</para>
<para>
@ -224,7 +224,7 @@ If
<function>XOpenDisplay </function>
does not succeed, it returns NULL.
After a successful call to
<function>XOpenDisplay ,</function>
<function>XOpenDisplay</function>,
all of the screens in the display can be used by the client.
The screen number specified in the display_name argument is returned
by the
@ -293,11 +293,11 @@ Applications must never directly modify or inspect these private members of the
structure.
<!-- .NT Note -->
The
<function>XDisplayWidth ,</function>
<function>XDisplayHeight ,</function>
<function>XDisplayCells ,</function>
<function>XDisplayPlanes ,</function>
<function>XDisplayWidthMM ,</function>
<function>XDisplayWidth</function>,
<function>XDisplayHeight</function>,
<function>XDisplayCells</function>,
<function>XDisplayPlanes</function>,
<function>XDisplayWidthMM</function>,
and
<function>XDisplayHeightMM</function>
functions in the next sections are misnamed.
@ -566,14 +566,14 @@ Specifies the appropriate screen number on the host server.
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
<function>XMatchVisualInfo ).</function>
<function>XMatchVisualInfo</function>).
</para>
<para>
<!-- .LP -->
<!-- .sp -->
<indexterm significance="preferred"><primary>XListDepths</primary></indexterm>
To determine the number of depths that are available on a given screen, use
<function>XListDepths .</function>
<function>XListDepths</function>.
<!-- .sM -->
</para>
<para>
@ -634,7 +634,7 @@ can be allocated,
sets count_return to the number of available depths.
Otherwise, it does not set count_return and returns NULL.
To release the memory allocated for the array of depths, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1061,22 +1061,22 @@ extended-length protocol encoding; otherwise,
it returns the maximum request size (in 4-byte units) supported
by the server using the extended-length encoding.
The Xlib functions
<function>XDrawLines ,</function>
<function>XDrawArcs ,</function>
<function>XFillPolygon ,</function>
<function>XChangeProperty ,</function>
<function>XSetClipRectangles ,</function>
<function>XDrawLines</function>,
<function>XDrawArcs</function>,
<function>XFillPolygon</function>,
<function>XChangeProperty</function>,
<function>XSetClipRectangles</function>,
and
<function>XSetRegion</function>
will use the extended-length encoding as necessary, if supported
by the server. Use of the extended-length encoding in other Xlib
functions (for example,
<function>XDrawPoints ,</function>
<function>XDrawRectangles ,</function>
<function>XDrawSegments ,</function>
<function>XFillArcs ,</function>
<function>XFillRectangles ,</function>
<function>XPutImage )</function>
<function>XDrawPoints</function>,
<function>XDrawRectangles</function>,
<function>XDrawSegments</function>,
<function>XFillArcs</function>,
<function>XFillRectangles</function>,
<function>XPutImage</function>)
is permitted but not required; an Xlib implementation may choose to
split the data across multiple smaller requests instead.
</para>
@ -1121,13 +1121,13 @@ The protocol guarantees the size to be no smaller than 4096 units
(16384 bytes).
Xlib automatically breaks data up into multiple protocol requests
as necessary for the following functions:
<function>XDrawPoints ,</function>
<function>XDrawRectangles ,</function>
<function>XDrawSegments ,</function>
<function>XFillArcs ,</function>
<function>XFillRectangles ,</function>
<function>XDrawPoints</function>,
<function>XDrawRectangles</function>,
<function>XDrawSegments</function>,
<function>XFillArcs</function>,
<function>XFillRectangles</function>,
and
<function>XPutImage .</function>
<function>XPutImage</function>.
</para>
<para>
<!-- .LP -->
@ -1306,7 +1306,7 @@ Specifies the connection to the X server.
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
<function>XEventsQueued ).</function>
<function>XEventsQueued</function>).
</para>
<para>
<!-- .LP -->
@ -1503,7 +1503,7 @@ typedef struct {
<!-- .eM -->
<!-- .sp -->
To obtain the pixmap format information for a given display, use
<function>XListPixmapFormats .</function>
<function>XListPixmapFormats</function>.
<indexterm significance="preferred"><primary>XListPixmapFormats</primary></indexterm>
<!-- .sM -->
</para>
@ -1556,7 +1556,7 @@ returns NULL.
To free the allocated storage for the
<function>XPixmapFormatValues</function>
structures, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1603,7 +1603,7 @@ Z format.
The macro or function can return either
<function>LSBFirst </function>
or
<function>MSBFirst .</function>
<function>MSBFirst</function>.
</para>
<para>
<!-- .LP -->
@ -1678,7 +1678,7 @@ unit.
This macro or function can return
<function>LSBFirst</function>
or
<function>MSBFirst .</function>
<function>MSBFirst</function>.
</para>
<para>
<!-- .LP -->
@ -2204,8 +2204,8 @@ structure.
Both return a value indicating whether the screen supports backing
stores.
The value returned can be one of
<function>WhenMapped ,</function>
<function>NotUseful ,</function>
<function>WhenMapped</function>,
<function>NotUseful</function>,
or
<function>Always </function>
(see section 3.2.4).
@ -2247,10 +2247,10 @@ structure.
Both return a Boolean value indicating whether the
screen supports save unders.
If
<function>True ,</function>
<function>True</function>,
the screen supports save unders.
If
<function>False ,</function>
<function>False</function>,
the screen does not support save unders (see section 3.2.5).
</para>
<para>
@ -2665,7 +2665,7 @@ Both return the root window of the specified screen.
To execute a
<function>NoOperation </function>
protocol request, use
<function>XNoOp .</function>
<function>XNoOp</function>.
<indexterm significance="preferred"><primary>XNoOp</primary></indexterm>
<!-- .sM -->
</para>
@ -2703,7 +2703,7 @@ thereby exercising the connection.
<para>
<!-- .LP -->
To free in-memory data that was created by an Xlib function, use
<function>XFree .</function>
<function>XFree</function>.
<indexterm significance="preferred"><primary>XFree</primary></indexterm>
<!-- .sM -->
</para>
@ -2746,7 +2746,7 @@ A NULL pointer cannot be passed to this function.
<para>
<!-- .LP -->
To close a display or disconnect from the X server, use
<function>XCloseDisplay .</function>
<function>XCloseDisplay</function>.
<indexterm significance="preferred"><primary>XCloseDisplay</primary></indexterm>
</para>
<para>
@ -2781,17 +2781,17 @@ The
function closes the connection to the X server for the display specified in the
<function>Display</function>
structure and destroys all windows, resource IDs
<function>( Window ,</function>
<function>Font ,</function>
<function>Pixmap ,</function>
<function>Colormap ,</function>
<function>Cursor ,</function>
(<function>Window</function>,
<function>Font</function>,
<function>Pixmap</function>,
<function>Colormap</function>,
<function>Cursor</function>,
and
<function>GContext ),</function>
<function>GContext</function>),
or other resources that the client has created
on this display, unless the close-down mode of the resource has been changed
(see
<function>XSetCloseDownMode ).</function>
<function>XSetCloseDownMode</function>).
Therefore, these windows, resource IDs, and other resources should never be
referenced again or an error will be generated.
Before exiting, you should call
@ -2817,7 +2817,7 @@ error.
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>
<function>XSetCloseDownMode</function>.
<indexterm significance="preferred"><primary>XSetCloseDownMode</primary></indexterm>
<!-- .sM -->
</para>
@ -2848,10 +2848,10 @@ Specifies the connection to the X server.
<para>
Specifies the client close-down mode.
You can pass
<function>DestroyAll , </function>
<function>RetainPermanent , </function>
<function>DestroyAll</function>,
<function>RetainPermanent</function>,
or
<function>RetainTemporary . </function>
<function>RetainTemporary</function>.
</para>
</listitem>
</varlistentry>
@ -2869,7 +2869,7 @@ For information on what happens to the client's resources when the
close_mode argument is
<function>RetainPermanent</function>
or
<function>RetainTemporary ,</function>
<function>RetainTemporary</function>,
see section 2.6.
</para>
<para>
@ -2898,7 +2898,7 @@ automatic operations:
<para>
It disowns all selections owned by the client
(see
<function>XSetSelectionOwner ).</function>
<function>XSetSelectionOwner</function>).
</para>
</listitem>
<listitem>
@ -2930,17 +2930,17 @@ by the client either as permanent or temporary,
depending on whether the close-down mode is
<function>RetainPermanent</function>
or
<function>RetainTemporary .</function>
<function>RetainTemporary</function>.
However, this does not prevent other client applications from explicitly
destroying the resources (see
<function>XSetCloseDownMode ).</function>
<function>XSetCloseDownMode</function>).
</para>
</listitem>
</itemizedlist>
<para>
<!-- .LP -->
When the close-down mode is
<function>DestroyAll ,</function>
<function>DestroyAll</function>,
the X server destroys all of a client's resources as follows:
</para>
<itemizedlist>
@ -2975,12 +2975,12 @@ It destroys all windows created by the client.
<para>
It performs the appropriate free request on each nonwindow resource created by
the client in the server (for example,
<function>Font , </function>
<function>Pixmap , </function>
<function>Cursor , </function>
<function>Colormap , </function>
<function>Font</function>,
<function>Pixmap</function>,
<function>Cursor</function>,
<function>Colormap</function>,
and
<function>GContext ).</function>
<function>GContext</function>).
</para>
</listitem>
<listitem>
@ -2996,7 +2996,7 @@ An X server goes through a cycle of having no connections and having some
connections.
When the last connection to the X server closes as a result of a connection
closing with the close_mode of
<function>DestroyAll ,</function>
<function>DestroyAll</function>,
the X server does the following:
</para>
<itemizedlist>
@ -3042,7 +3042,7 @@ It restores the default font path.
<listitem>
<para>
It restores the input focus to state
<function>PointerRoot .</function>
<function>PointerRoot</function>.
</para>
</listitem>
</itemizedlist>
@ -3052,7 +3052,7 @@ However, the X server does not reset if you close a connection with a close-down
mode set to
<function>RetainPermanent</function>
or
<function>RetainTemporary .</function>
<function>RetainTemporary</function>.
</para>
</sect1>
<sect1 id="Using_Xlib_with_Threads">
@ -3069,7 +3069,7 @@ multiple threads to use Xlib concurrently.
<!-- .LP -->
<!-- .sp -->
To initialize support for concurrent threads, use
<function>XInitThreads .</function>
<function>XInitThreads</function>.
<indexterm significance="preferred"><primary>XInitThreads</primary></indexterm>
<!-- .sM -->
</para>
@ -3102,7 +3102,7 @@ It is recommended that single-threaded programs not call this function.
<!-- .LP -->
<!-- .sp -->
To lock a display across several Xlib calls, use
<function>XLockDisplay .</function>
<function>XLockDisplay</function>.
<indexterm significance="preferred"><primary>XLockDisplay</primary></indexterm>
<!-- .sM -->
</para>
@ -3138,16 +3138,16 @@ Nested calls to
work correctly; the display will not actually be unlocked until
<function>XUnlockDisplay</function>
has been called the same number of times as
<function>XLockDisplay .</function>
<function>XLockDisplay</function>.
This function has no effect unless Xlib was successfully initialized
for threads using
<function>XInitThreads .</function>
<function>XInitThreads</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To unlock a display, use
<function>XUnlockDisplay .</function>
<function>XUnlockDisplay</function>.
<indexterm significance="preferred"><primary>XUnlockDisplay</primary></indexterm>
<!-- .sM -->
</para>
@ -3185,7 +3185,7 @@ must be called an equal number of times before the display is
actually unlocked.
This function has no effect unless Xlib was successfully initialized
for threads using
<function>XInitThreads .</function>
<function>XInitThreads</function>.
</para>
</sect1>
<sect1 id="Using_Internal_Connections">
@ -3208,7 +3208,7 @@ facilities.
<para>
<!-- .LP -->
To track internal connections for a display, use
<function>XAddConnectionWatch .</function>
<function>XAddConnectionWatch</function>.
</para>
<funcsynopsis>
<funcprototype>
@ -3272,11 +3272,11 @@ internal connection for the specified display. The procedure is passed the
display, the specified client_data, the file descriptor for the connection,
a Boolean indicating whether the connection is being opened or closed, and a
pointer to a location for private watch data. If opening is
<function>True ,</function>
<function>True</function>,
the procedure can store a pointer to private data in the location pointed
to by watch_data;
when the procedure is later called for this same connection and opening is
<function>False ,</function>
<function>False</function>,
the location pointed to by watch_data will hold this same private data pointer.
</para>
<para>
@ -3299,13 +3299,13 @@ If Xlib has been initialized for threads, the procedure is called with
the display locked and the result of a call by the procedure to any
Xlib function that locks the display is not defined unless the executing
thread has externally locked the display using
<function>XLockDisplay .</function>
<function>XLockDisplay</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To stop tracking internal connections for a display, use
<function>XRemoveConnectionWatch .</function>
<function>XRemoveConnectionWatch</function>.
<indexterm significance="preferred"><primary>XRemoveConnectionWatch</primary></indexterm>
<!-- .sM -->
</para>
@ -3367,7 +3367,7 @@ was initially registered.
<!-- .LP -->
<!-- .sp -->
To process input on an internal connection, use
<function>XProcessInternalConnection .</function>
<function>XProcessInternalConnection</function>.
<indexterm significance="preferred"><primary>XProcessInternalConnection</primary></indexterm>
<!-- .sM -->
</para>
@ -3414,7 +3414,7 @@ This function should be called for an internal connection only
after an operating system facility (for example,
<function>select</function>
or
<function>poll )</function>
<function>poll</function>)
has indicated that input is available; otherwise,
the effect is not defined.
</para>
@ -3422,7 +3422,7 @@ the effect is not defined.
<!-- .LP -->
<!-- .sp -->
To obtain all of the current internal connections for a display, use
<function>XInternalConnectionNumbers .</function>
<function>XInternalConnectionNumbers</function>.
<indexterm significance="preferred"><primary>XInternalConnectionNumbers</primary></indexterm>
<!-- .sM -->
</para>
@ -3480,7 +3480,7 @@ function returns a list of the file descriptors for all internal
connections currently open for the specified display.
When the allocated list is no longer needed,
free it by using
<function>XFree .</function>
<function>XFree</function>.
This functions returns a nonzero status if the list is successfully allocated;
otherwise, it returns zero.
</para>

268
specs/libX11/CH03.xml
View file

@ -41,13 +41,13 @@ and can be
<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>
<function>GrayScale ,</function>
<function>PseudoColor ,</function>
<function>StaticGray</function>,
<function>StaticColor</function>,
<function>TrueColor</function>,
<function>GrayScale</function>,
<function>PseudoColor</function>,
or
<function>DirectColor .</function>
<function>DirectColor</function>.
</para>
<para>
<!-- .LP -->
@ -89,7 +89,7 @@ the <acronym>RGB</acronym> values in the following ways:
<listitem>
<para>
For
<function>PseudoColor , </function>
<function>PseudoColor</function>,
a pixel value indexes a colormap to produce
independent <acronym>RGB</acronym> values, and the <acronym>RGB</acronym> values can be changed dynamically.
</para>
@ -107,7 +107,7 @@ same value for red, green, and blue in the colormaps.
<listitem>
<para>
For
<function>DirectColor ,</function>
<function>DirectColor</function>,
a pixel value is decomposed into separate <acronym>RGB</acronym> subfields, and each
subfield separately indexes the colormap for the corresponding value.
The <acronym>RGB</acronym> values can be changed dynamically.
@ -150,7 +150,7 @@ colormap can be thought of as monochrome.
The red_mask, green_mask, and blue_mask members are only defined for
<function>DirectColor</function>
and
<function>TrueColor . </function>
<function>TrueColor</function>.
Each has one contiguous set of bits with no
intersections.
The bits_per_rgb member specifies the log base 2 of the
@ -161,16 +161,16 @@ in a newly created colormap.
For
<function>DirectColor </function>
and
<function>TrueColor , </function>
<function>TrueColor</function>,
this is the size of an individual pixel subfield.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To obtain the visual ID from a
<function>Visual ,</function>
<function>Visual</function>,
use
<function>XVisualIDFromVisual .</function>
<function>XVisualIDFromVisual</function>.
<indexterm significance="preferred"><primary>XVisualIDFromVisual</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -308,7 +308,7 @@ are to be made.
The pattern can either be relative to the parent
or absolute.
If
<function>ParentRelative ,</function>
<function>ParentRelative</function>,
the parent's background is used.
</para>
<para>
@ -322,7 +322,7 @@ 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>
<function>XMapWindow</function>),
<indexterm><primary>XMapWindow</primary></indexterm>
the X server generates an
<function>Expose </function>
@ -350,7 +350,7 @@ set the appropriate member of the
structure and OR in the corresponding value bitmask in your subsequent calls to
<function>XCreateWindow</function>
and
<function>XChangeWindowAttributes ,</function>
<function>XChangeWindowAttributes</function>,
or use one of the other convenience functions that set the appropriate
attribute.
The symbols for the value mask bits and the
@ -553,7 +553,7 @@ a window's background in a single color.
You can set the background-pixmap to a pixmap,
<function>None </function>
(default), or
<function>ParentRelative .</function>
<function>ParentRelative</function>.
You can set the background-pixel of a window to any pixel value (no default).
If you specify a background-pixel,
it overrides either the default background-pixmap
@ -572,7 +572,7 @@ or a
<function>BadMatch</function>
error results.
If you set background-pixmap to
<function>None ,</function>
<function>None</function>,
the window has no defined background.
If you set the background-pixmap to
<function>ParentRelative :</function>
@ -591,9 +591,9 @@ error results.
<listitem>
<para>
If the parent window has a background-pixmap of
<function>None ,</function>
<function>None</function>,
the window also has a background-pixmap of
<function>None . </function>
<function>None</function>.
</para>
</listitem>
<listitem>
@ -608,7 +608,7 @@ background-pixmap is required.
The background tile origin always aligns with the parent window's
background tile origin.
If the background-pixmap is not
<function>ParentRelative ,</function>
<function>ParentRelative</function>,
the background tile origin is the child window's origin.
</para>
</listitem>
@ -630,9 +630,9 @@ When no valid contents are available for regions of a window
and either the regions are visible or the server is maintaining backing store,
the server automatically tiles the regions with the window's background
unless the window has a background of
<function>None .</function>
<function>None</function>.
If the background is
<function>None ,</function>
<function>None</function>,
the previous screen contents from other windows of the same depth as the window
are simply left in place as long as the contents come from the parent of the
window or an inferior of the parent.
@ -685,7 +685,7 @@ or a
<function>BadMatch</function>
error results.
If you set the border-pixmap to
<function>CopyFromParent ,</function>
<function>CopyFromParent</function>,
the parent window's border-pixmap is copied.
Subsequent changes to the parent window's border attribute do not affect
the child window.
@ -727,14 +727,14 @@ retained when an
<function>InputOutput</function>
window is resized.
The default value for the bit-gravity attribute is
<function>ForgetGravity .</function>
<function>ForgetGravity</function>.
The window gravity of a window allows you to define how the
<function>InputOutput</function>
or
<function>InputOnly</function>
window should be repositioned if its parent is resized.
The default value for the win-gravity attribute is
<function>NorthWestGravity .</function>
<function>NorthWestGravity</function>.
</para>
<para>
<!-- .LP -->
@ -885,9 +885,9 @@ with the contents of a window.
The backing-store attribute can be set to
<function>NotUseful </function>
(default),
<function>WhenMapped ,</function>
<function>WhenMapped</function>,
or
<function>Always .</function>
<function>Always</function>.
</para>
<para>
<!-- .LP -->
@ -955,7 +955,7 @@ or
<function>False </function>
(default).
If save-under is
<function>True , </function>
<function>True</function>,
the X server is advised that, when this window is mapped,
saving the contents of windows it obscures would be beneficial.
</para>
@ -1015,18 +1015,18 @@ or
window.
The do-not-propagate-mask is the bitwise inclusive OR of zero or more
of the following masks:
<function>KeyPress , </function>
<function>KeyRelease ,</function>
<function>ButtonPress , </function>
<function>ButtonRelease ,</function>
<function>PointerMotion ,</function>
<function>Button1Motion , </function>
<function>Button2Motion , </function>
<function>Button3Motion ,</function>
<function>Button4Motion , </function>
<function>Button5Motion , </function>
<function>KeyPress</function>,
<function>KeyRelease</function>,
<function>ButtonPress</function>,
<function>ButtonRelease</function>,
<function>PointerMotion</function>,
<function>Button1Motion</function>,
<function>Button2Motion</function>,
<function>Button3Motion</function>,
<function>Button4Motion</function>,
<function>Button5Motion</function>,
and
<function>ButtonMotion .</function>
<function>ButtonMotion</function>.
You can specify that all events are propagated by setting
<function>NoEventMask </function>
(default).
@ -1084,7 +1084,7 @@ error results.
X servers capable of supporting multiple
hardware colormaps can use this information,
and window managers can use it for calls to
<function>XInstallColormap .</function>
<function>XInstallColormap</function>.
You can set the colormap attribute to a colormap or to
<function>CopyFromParent</function>
(default).
@ -1092,14 +1092,14 @@ You can set the colormap attribute to a colormap or to
<para>
<!-- .LP -->
If you set the colormap to
<function>CopyFromParent ,</function>
<function>CopyFromParent</function>,
the parent window's colormap is copied and used by its child.
However, the child window must have the same visual type as the parent,
or a
<function>BadMatch </function>
error results.
The parent window must not have a colormap of
<function>None ,</function>
<function>None</function>,
or a
<function>BadMatch </function>
error results.
@ -1129,7 +1129,7 @@ You can set the cursor to a cursor or
<para>
<!-- .LP -->
If you set the cursor to
<function>None ,</function>
<function>None</function>,
the parent's cursor is used when the
pointer is in the
<function>InputOutput</function>
@ -1138,7 +1138,7 @@ or
window, and any change in the parent's cursor will cause an
immediate change in the displayed cursor.
By calling
<function>XFreeCursor ,</function>
<function>XFreeCursor</function>,
the cursor can be freed immediately as long as no further explicit reference
to it is made.
</para>
@ -1235,7 +1235,7 @@ Extension packages can define other classes of windows.
<para>
<!-- .LP -->
To create an unmapped window and set its window attributes, use
<function>XCreateWindow .</function>
<function>XCreateWindow</function>.
<indexterm significance="preferred"><primary>XCreateWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1356,10 +1356,10 @@ means the depth is taken from the parent.
<para>
Specifies the created window's class.
You can pass
<function>InputOutput , </function>
<function>InputOnly , </function>
<function>InputOutput</function>,
<function>InputOnly</function>,
or
<function>CopyFromParent .</function>
<function>CopyFromParent</function>.
A class of
<function>CopyFromParent</function>
means the class
@ -1442,14 +1442,14 @@ window must be zero, or a
<function>BadMatch</function>
error results.
For class
<function>InputOutput ,</function>
<function>InputOutput</function>,
the visual type and depth must be a combination supported for the screen,
or a
<function>BadMatch</function>
error results.
The depth need not be the same as the parent,
but the parent must not be a window of class
<function>InputOnly ,</function>
<function>InputOnly</function>,
or a
<function>BadMatch</function>
error results.
@ -1470,11 +1470,11 @@ error results.
<!-- .LP -->
The created window is not yet displayed (mapped) on the user's display.
To display the window, call
<function>XMapWindow .</function>
<function>XMapWindow</function>.
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>
<function>XDefineCursor</function>.
<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
@ -1484,12 +1484,12 @@ ancestors are mapped and it is not obscured by any of its ancestors.
<!-- .LP -->
<function>XCreateWindow</function>
can generate
<function>BadAlloc ,</function>
<function>BadColor ,</function>
<function>BadCursor ,</function>
<function>BadMatch ,</function>
<function>BadPixmap ,</function>
<function>BadValue ,</function>
<function>BadAlloc</function>,
<function>BadColor</function>,
<function>BadCursor</function>,
<function>BadMatch</function>,
<function>BadPixmap</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -1500,7 +1500,7 @@ errors.
To create an unmapped
<function>InputOutput</function>
subwindow of a given parent window, use
<function>XCreateSimpleWindow .</function>
<function>XCreateSimpleWindow</function>.
<indexterm significance="preferred"><primary>XCreateSimpleWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1648,9 +1648,9 @@ have their default values.
<!-- .LP -->
<function>XCreateSimpleWindow</function>
can generate
<function>BadAlloc ,</function>
<function>BadMatch ,</function>
<function>BadValue ,</function>
<function>BadAlloc</function>,
<function>BadMatch</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -1670,7 +1670,7 @@ subwindows of a window.
<!-- .LP -->
<!-- .sp -->
To destroy a window and all of its subwindows, use
<function>XDestroyWindow .</function>
<function>XDestroyWindow</function>.
<indexterm significance="preferred"><primary>XDestroyWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1740,7 +1740,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To destroy all subwindows of a specified window, use
<function>XDestroySubwindows .</function>
<function>XDestroySubwindows</function>.
<indexterm significance="preferred"><primary>XDestroySubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1867,7 +1867,7 @@ reparent the child into a frame first.
For further information,
see sections 3.2.8 and 10.10.
Only a single client at a time can select for
<function>SubstructureRedirectMask .</function>
<function>SubstructureRedirectMask</function>.
</para>
<para>
<!-- .LP -->
@ -1883,7 +1883,7 @@ event.
<!-- .LP -->
<!-- .sp -->
To map a given window, use
<function>XMapWindow .</function>
<function>XMapWindow</function>.
<indexterm significance="preferred"><primary>XMapWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2009,7 +2009,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To map and raise a window, use
<function>XMapRaised .</function>
<function>XMapRaised</function>.
<indexterm significance="preferred"><primary>XMapRaised</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2056,7 +2056,7 @@ subwindows that have had map requests.
However, it also raises the specified window to the top of the stack.
For additional information,
see
<function>XMapWindow .</function>
<function>XMapWindow</function>.
</para>
<para>
<!-- .LP -->
@ -2069,7 +2069,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To map all subwindows for a specified window, use
<function>XMapSubwindows .</function>
<function>XMapSubwindows</function>.
<indexterm significance="preferred"><primary>XMapSubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2139,7 +2139,7 @@ Xlib provides functions that you can use to unmap a window or all subwindows.
<!-- .LP -->
<!-- .sp -->
To unmap a window, use
<function>XUnmapWindow .</function>
<function>XUnmapWindow</function>.
<indexterm significance="preferred"><primary>XUnmapWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2206,7 +2206,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To unmap all subwindows for a specified window, use
<function>XUnmapSubwindows .</function>
<function>XUnmapSubwindows</function>.
<indexterm significance="preferred"><primary>XUnmapSubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2282,7 +2282,7 @@ To change one of these parameters,
set the appropriate member of the
<function>XWindowChanges</function>
structure and OR in the corresponding value mask in subsequent calls to
<function>XConfigureWindow .</function>
<function>XConfigureWindow</function>.
The symbols for the value mask bits and the
<function>XWindowChanges</function>
structure are:
@ -2343,12 +2343,12 @@ error results.
The sibling member is used to set the sibling window for stacking operations.
The stack_mode member is used to set how the window is to be restacked
and can be set to
<function>Above , </function>
<function>Below , </function>
<function>TopIf , </function>
<function>BottomIf ,</function>
<function>Above</function>,
<function>Below</function>,
<function>TopIf</function>,
<function>BottomIf</function>,
or
<function>Opposite .</function>
<function>Opposite</function>.
</para>
<para>
<!-- .LP -->
@ -2409,10 +2409,10 @@ and any regions where window contents are lost.
<para>
<!-- .LP -->
The restack check (specifically, the computation for
<function>BottomIf ,</function>
<function>TopIf ,</function>
<function>BottomIf</function>,
<function>TopIf</function>,
and
<function>Opposite )</function>
<function>Opposite</function>)
is performed with respect to the window's final size and position (as
controlled by the other arguments of the request), not its initial position.
If a sibling is specified without a stack_mode,
@ -2511,7 +2511,7 @@ Attempts to configure a root window have no effect.
<!-- .LP -->
<!-- .sp -->
To configure a window's size, location, stacking, or border, use
<function>XConfigureWindow .</function>
<function>XConfigureWindow</function>.
<indexterm significance="preferred"><primary>XConfigureWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2590,13 +2590,13 @@ a
<function>BadMatch</function>
error results.
Note that the computations for
<function>BottomIf ,</function>
<function>TopIf ,</function>
<function>BottomIf</function>,
<function>TopIf</function>,
and
<function>Opposite</function>
are performed with respect to the window's final geometry (as controlled by the
other arguments passed to
<function>XConfigureWindow ),</function>
<function>XConfigureWindow</function>),
not its initial geometry.
Any backing store contents of the window, its
inferiors, and other newly visible windows are either discarded or
@ -2607,8 +2607,8 @@ changed to reflect the current screen contents
<!-- .LP -->
<function>XConfigureWindow</function>
can generate
<function>BadMatch ,</function>
<function>BadValue ,</function>
<function>BadMatch</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -2617,7 +2617,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To move a window without changing its size, use
<function>XMoveWindow .</function>
<function>XMoveWindow</function>.
<indexterm significance="preferred"><primary>XMoveWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2719,7 +2719,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To change a window's size without changing the upper-left coordinate, use
<function>XResizeWindow .</function>
<function>XResizeWindow</function>.
<indexterm significance="preferred"><primary>XResizeWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2822,7 +2822,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To change the size and location of a window, use
<function>XMoveResizeWindow .</function>
<function>XMoveResizeWindow</function>.
<indexterm significance="preferred"><primary>XMoveResizeWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2943,7 +2943,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To change the border width of a given window, use
<function>XSetWindowBorderWidth .</function>
<function>XSetWindowBorderWidth</function>.
<indexterm significance="preferred"><primary>XSetWindowBorderWidth</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3020,7 +3020,7 @@ or restack windows.
<!-- .LP -->
<!-- .sp -->
To raise a window so that no sibling window obscures it, use
<function>XRaiseWindow .</function>
<function>XRaiseWindow</function>.
<indexterm significance="preferred"><primary>XRaiseWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3093,7 +3093,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To lower a window so that it does not obscure any sibling windows, use
<function>XLowerWindow .</function>
<function>XLowerWindow</function>.
<indexterm significance="preferred"><primary>XLowerWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3167,7 +3167,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To circulate a subwindow up or down, use
<function>XCirculateSubwindows .</function>
<function>XCirculateSubwindows</function>.
<indexterm significance="preferred"><primary>XCirculateSubwindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3211,7 +3211,7 @@ the window.
You can pass
<function>RaiseLowest</function>
or
<function>LowerHighest .</function>
<function>LowerHighest</function>.
</para>
</listitem>
</varlistentry>
@ -3225,12 +3225,12 @@ The
function circulates children of the specified window in the specified
direction.
If you specify
<function>RaiseLowest ,</function>
<function>RaiseLowest</function>,
<function>XCirculateSubwindows</function>
raises the lowest mapped child (if any) that is occluded
by another child to the top of the stack.
If you specify
<function>LowerHighest ,</function>
<function>LowerHighest</function>,
<function>XCirculateSubwindows</function>
lowers the highest mapped child (if any) that occludes another child
to the bottom of the stack.
@ -3259,7 +3259,7 @@ errors.
<!-- .sp -->
To raise the lowest mapped child of a window that is partially or completely
occluded by another child, use
<function>XCirculateSubwindowsUp .</function>
<function>XCirculateSubwindowsUp</function>.
<indexterm significance="preferred"><primary>XCirculateSubwindowsUp</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3321,7 +3321,7 @@ error.
<!-- .sp -->
To lower the highest mapped child of a window that partially or
completely occludes another child, use
<function>XCirculateSubwindowsDown .</function>
<function>XCirculateSubwindowsDown</function>.
<indexterm significance="preferred"><primary>XCirculateSubwindowsDown</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3380,7 +3380,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To restack a set of windows from top to bottom, use
<function>XRestackWindows .</function>
<function>XRestackWindows</function>.
<indexterm significance="preferred"><primary>XRestackWindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3486,7 +3486,7 @@ window attribute, such as a window's background.
<!-- .LP -->
<!-- .sp -->
To change one or more attributes for a given window, use
<function>XChangeWindowAttributes .</function>
<function>XChangeWindowAttributes</function>.
<indexterm significance="preferred"><primary>XChangeWindowAttributes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3533,7 +3533,7 @@ If valuemask is zero,
the attributes are ignored and are not referenced.
The values and restrictions are
the same as for
<function>XCreateWindow .</function>
<function>XCreateWindow</function>.
</para>
</listitem>
</varlistentry>
@ -3574,7 +3574,7 @@ structure to change the specified window attributes.
Changing the background does not cause the window contents to be
changed.
To repaint the window and its background, use
<function>XClearWindow .</function>
<function>XClearWindow</function>.
Setting the border or changing the background such that the
border tile origin changes causes the border to be repainted.
Changing the background of a root window to
@ -3590,7 +3590,7 @@ window.
Changing the backing-store of an obscured window to
<function>WhenMapped </function>
or
<function>Always , </function>
<function>Always</function>,
or changing the backing-planes, backing-pixel, or
save-under of a mapped window may have no immediate effect.
Changing the colormap of a window (that is, defining a new map, not
@ -3600,7 +3600,7 @@ event.
Changing the colormap of a visible window may have no
immediate effect on the screen because the map may not be installed
(see
<function>XInstallColormap ).</function>
<function>XInstallColormap</function>).
Changing the cursor of a root window to
<function>None </function>
restores the default
@ -3614,10 +3614,10 @@ Their event masks are maintained separately.
When an event is generated,
it is reported to all interested clients.
However, only one client at a time can select for
<function>SubstructureRedirectMask , </function>
<function>ResizeRedirectMask , </function>
<function>SubstructureRedirectMask</function>,
<function>ResizeRedirectMask</function>,
and
<function>ButtonPressMask .</function>
<function>ButtonPressMask</function>.
If a client attempts to select any of these event masks
and some other client has already selected one,
a
@ -3630,12 +3630,12 @@ not one per client.
<!-- .LP -->
<function>XChangeWindowAttributes</function>
can generate
<function>BadAccess ,</function>
<function>BadColor ,</function>
<function>BadCursor ,</function>
<function>BadMatch ,</function>
<function>BadPixmap ,</function>
<function>BadValue ,</function>
<function>BadAccess</function>,
<function>BadColor</function>,
<function>BadCursor</function>,
<function>BadMatch</function>,
<function>BadPixmap</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -3644,7 +3644,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the background of a window to a given pixel, use
<function>XSetWindowBackground .</function>
<function>XSetWindowBackground</function>.
<indexterm significance="preferred"><primary>XSetWindowBackground</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3720,7 +3720,7 @@ errors.
<para>
<!-- .LP -->
To set the background of a window to a given pixmap, use
<function>XSetWindowBackgroundPixmap .</function>
<function>XSetWindowBackgroundPixmap</function>.
<indexterm><primary>Window</primary><secondary>background</secondary></indexterm>
<indexterm significance="preferred"><primary>XSetWindowBackgroundPixmap</primary></indexterm>
<!-- .sM -->
@ -3761,9 +3761,9 @@ Specifies the window.
<listitem>
<para>
Specifies the background pixmap,
<function>ParentRelative ,</function>
<function>ParentRelative</function>,
or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -3790,15 +3790,15 @@ window, a
<function>BadMatch</function>
error results.
If the background is set to
<function>None ,</function>
<function>None</function>,
the window has no defined background.
</para>
<para>
<!-- .LP -->
<function>XSetWindowBackgroundPixmap</function>
can generate
<function>BadMatch ,</function>
<function>BadPixmap ,</function>
<function>BadMatch</function>,
<function>BadPixmap</function>,
and
<function>BadWindow </function>
errors.
@ -3813,7 +3813,7 @@ do not change the current contents of the window.
<!-- .LP -->
<!-- .sp -->
To change and repaint a window's border to a given pixel, use
<function>XSetWindowBorder .</function>
<function>XSetWindowBorder</function>.
<indexterm significance="preferred"><primary>XSetWindowBorder</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3883,7 +3883,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To change and repaint the border tile of a given window, use
<function>XSetWindowBorderPixmap .</function>
<function>XSetWindowBorderPixmap</function>.
<indexterm significance="preferred"><primary>XSetWindowBorderPixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3923,7 +3923,7 @@ Specifies the window.
<listitem>
<para>
Specifies the border pixmap or
<function>CopyFromParent .</function>
<function>CopyFromParent</function>.
</para>
</listitem>
</varlistentry>
@ -3938,7 +3938,7 @@ function sets the border pixmap of the window to the pixmap you specify.
The border pixmap can be freed immediately if no further explicit
references to it are to be made.
If you specify
<function>CopyFromParent ,</function>
<function>CopyFromParent</function>,
a copy of the parent window's border pixmap is used.
If you attempt to perform this on an
<function>InputOnly</function>
@ -3952,8 +3952,8 @@ error results.
<!-- .LP -->
<function>XSetWindowBorderPixmap</function>
can generate
<function>BadMatch ,</function>
<function>BadPixmap ,</function>
<function>BadMatch</function>,
<function>BadPixmap</function>,
and
<function>BadWindow </function>
errors.
@ -3962,7 +3962,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the colormap of a given window, use
<function>XSetWindowColormap .</function>
<function>XSetWindowColormap</function>.
<indexterm significance="preferred"><primary>XSetWindowColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4022,8 +4022,8 @@ error results.
<!-- .LP -->
<function>XSetWindowColormap</function>
can generate
<function>BadColor ,</function>
<function>BadMatch ,</function>
<function>BadColor</function>,
<function>BadMatch</function>,
and
<function>BadWindow </function>
errors.
@ -4032,7 +4032,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To define which cursor will be used in a window, use
<function>XDefineCursor .</function>
<function>XDefineCursor</function>.
<indexterm><primary>Window</primary><secondary>defining the cursor</secondary></indexterm>
<indexterm significance="preferred"><primary>XDefineCursor</primary></indexterm>
<!-- .sM -->
@ -4073,7 +4073,7 @@ Specifies the window.
<listitem>
<para>
Specifies the cursor that is to be displayed or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -4084,9 +4084,9 @@ Specifies the cursor that is to be displayed or
<!-- .eM -->
If a cursor is set, it will be used when the pointer is in the window.
If the cursor is
<function>None ,</function>
<function>None</function>,
it is equivalent to
<function>XUndefineCursor .</function>
<function>XUndefineCursor</function>.
</para>
<para>
<!-- .LP -->
@ -4101,7 +4101,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To undefine the cursor in a given window, use
<function>XUndefineCursor .</function>
<function>XUndefineCursor</function>.
<indexterm><primary>Window</primary><secondary>undefining the cursor</secondary></indexterm>
<indexterm significance="preferred"><primary>XUndefineCursor</primary></indexterm>
<!-- .sM -->

134
specs/libX11/CH04.xml
View file

@ -32,7 +32,7 @@ exists.
<!-- .sp -->
To obtain the parent, a list of children, and number of children for
a given window, use
<function>XQueryTree .</function>
<function>XQueryTree</function>.
<indexterm><primary>Child Window</primary></indexterm>
<indexterm><primary>Parent Window</primary></indexterm>
<indexterm significance="preferred"><primary>XQueryTree</primary></indexterm>
@ -128,7 +128,7 @@ The children are listed in current stacking order, from bottom-most
<function>XQueryTree</function>
returns zero if it fails and nonzero if it succeeds.
To free a non-NULL children list when it is no longer needed, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -141,7 +141,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To obtain the current attributes of a given window, use
<function>XGetWindowAttributes .</function>
<function>XGetWindowAttributes</function>.
<indexterm significance="preferred"><primary>XGetWindowAttributes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -247,7 +247,7 @@ The root member is set to the root window of the screen containing the window.
The class member is set to the window's class and can be either
<function>InputOutput</function>
or
<function>InputOnly .</function>
<function>InputOnly</function>.
</para>
<para>
<!-- .LP -->
@ -330,10 +330,10 @@ see section 3.2.3. <!-- xref -->
The backing_store member is set to indicate how the X server should maintain
the contents of a window
and can be
<function>WhenMapped ,</function>
<function>Always ,</function>
<function>WhenMapped</function>,
<function>Always</function>,
or
<function>NotUseful .</function>
<function>NotUseful</function>.
The backing_planes member is set to indicate (with bits set to 1) which bit
planes of the window hold dynamic data that must be preserved in backing_stores
and during save_unders.
@ -345,20 +345,20 @@ for planes not set in backing_planes.
The save_under member is set to
<function>True</function>
or
<function>False .</function>
<function>False</function>.
The colormap member is set to the colormap for the specified window and can be
a colormap ID or
<function>None .</function>
<function>None</function>.
The map_installed member is set to indicate whether the colormap is
currently installed and can be
<function>True</function>
or
<function>False .</function>
<function>False</function>.
The map_state member is set to indicate the state of the window and can be
<function>IsUnmapped ,</function>
<function>IsUnviewable ,</function>
<function>IsUnmapped</function>,
<function>IsUnviewable</function>,
or
<function>IsViewable .</function>
<function>IsViewable</function>.
<function>IsUnviewable</function>
is used if the window is mapped but some ancestor is unmapped.
</para>
@ -377,9 +377,9 @@ The override_redirect member is set to indicate whether this window overrides
structure control facilities and can be
<function>True</function>
or
<function>False .</function>
<function>False</function>.
Window manager clients should ignore the window if this member is
<function>True .</function>
<function>True</function>.
</para>
<para>
<!-- .LP -->
@ -401,7 +401,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To obtain the current geometry of a given drawable, use
<function>XGetGeometry .</function>
<function>XGetGeometry</function>.
<indexterm significance="preferred"><primary>XGetGeometry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -530,7 +530,7 @@ The geometry of the drawable includes the x and y coordinates, width and height,
border width, and depth.
These are described in the argument list.
It is legal to pass to this function a window whose class is
<function>InputOnly .</function>
<function>InputOnly</function>.
</para>
<para>
<!-- .LP -->
@ -562,7 +562,7 @@ asking the X server to perform these operations.
<!-- .sp -->
To translate a coordinate in one window to the coordinate
space of another window, use
<function>XTranslateCoordinates .</function>
<function>XTranslateCoordinates</function>.
<indexterm significance="preferred"><primary>XTranslateCoordinates</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -668,7 +668,7 @@ destination window.
If
<function>XTranslateCoordinates</function>
returns
<function>True ,</function>
<function>True</function>,
it takes the src_x and src_y coordinates relative
to the source window's origin and returns these coordinates to
dest_x_return and dest_y_return
@ -676,13 +676,13 @@ relative to the destination window's origin.
If
<function>XTranslateCoordinates</function>
returns
<function>False , </function>
<function>False</function>,
src_w and dest_w are on different screens,
and dest_x_return and dest_y_return are zero.
If the coordinates are contained in a mapped child of dest_w,
that child is returned to child_return.
Otherwise, child_return is set to
<function>None .</function>
<function>None</function>.
</para>
<para>
<!-- .LP -->
@ -696,7 +696,7 @@ error.
<!-- .sp -->
To obtain the screen coordinates of the pointer
or to determine the pointer coordinates relative to a specified window, use
<function>XQueryPointer .</function>
<function>XQueryPointer</function>.
<indexterm significance="preferred"><primary>XQueryPointer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -817,7 +817,7 @@ coordinates relative to the root window's origin.
If
<function>XQueryPointer</function>
returns
<function>False , </function>
<function>False</function>,
the pointer is not on the same screen as the specified window, and
<function>XQueryPointer</function>
returns
@ -826,7 +826,7 @@ to child_return and zero to win_x_return and win_y_return.
If
<function>XQueryPointer</function>
returns
<function>True , </function>
<function>True</function>,
the pointer coordinates returned to win_x_return and win_y_return
are relative to the origin of the specified window.
In this case,
@ -1183,7 +1183,7 @@ see section 8.5. <!-- xref -->
<!-- .LP -->
<!-- .sp -->
To return an atom for a given name, use
<function>XInternAtom .</function>
<function>XInternAtom</function>.
<indexterm><primary>Atom</primary><secondary>interning</secondary></indexterm>
<indexterm significance="preferred"><primary>XInternAtom</primary></indexterm>
<!-- .sM -->
@ -1237,12 +1237,12 @@ The
function returns the atom identifier associated with the specified atom_name
string.
If only_if_exists is
<function>False ,</function>
<function>False</function>,
the atom is created if it does not exist.
Therefore,
<function>XInternAtom</function>
can return
<function>None .</function>
<function>None</function>.
If the atom name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Uppercase and lowercase matter;
@ -1265,7 +1265,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To return atoms for an array of names, use
<function>XInternAtoms .</function>
<function>XInternAtoms</function>.
<indexterm><primary>Atom</primary><secondary>interning</secondary></indexterm>
<indexterm significance="preferred"><primary>XInternAtoms</primary></indexterm>
<!-- .sM -->
@ -1366,7 +1366,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To return a name for a given atom identifier, use
<function>XGetAtomName .</function>
<function>XGetAtomName</function>.
<indexterm><primary>Atom</primary><secondary>getting name</secondary></indexterm>
<indexterm significance="preferred"><primary>XGetAtomName</primary></indexterm>
<!-- .sM -->
@ -1412,7 +1412,7 @@ then the returned string is in the Host Portable Character Encoding.
Otherwise, the result is implementation-dependent.
To free the resulting string,
call
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1425,7 +1425,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To return the names for an array of atom identifiers, use
<function>XGetAtomNames .</function>
<function>XGetAtomNames</function>.
<indexterm><primary>Atom</primary><secondary>getting name</secondary></indexterm>
<indexterm significance="preferred"><primary>XGetAtomNames</primary></indexterm>
<!-- .sM -->
@ -1539,7 +1539,7 @@ communication (see chapter 14). <!-- xref -->
<!-- .LP -->
<!-- .sp -->
To obtain the type, format, and value of a property of a given window, use
<function>XGetWindowProperty .</function>
<function>XGetWindowProperty</function>.
<indexterm><primary>Property</primary><secondary>getting</secondary></indexterm>
</para>
<para>
@ -1634,7 +1634,7 @@ Specifies a Boolean value that determines whether the property is deleted.
<listitem>
<para>
Specifies the atom identifier associated with the property type or
<function>AnyPropertyType .</function>
<function>AnyPropertyType</function>.
</para>
</listitem>
</varlistentry>
@ -1806,14 +1806,14 @@ The function returns
if it executes successfully.
To free the resulting data,
use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
<function>XGetWindowProperty</function>
can generate
<function>BadAtom ,</function>
<function>BadValue ,</function>
<function>BadAtom</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -1822,7 +1822,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To obtain a given window's property list, use
<function>XListProperties .</function>
<function>XListProperties</function>.
<indexterm><primary>Property</primary><secondary>listing</secondary></indexterm>
<indexterm significance="preferred"><primary>XListProperties</primary></indexterm>
<!-- .sM -->
@ -1877,7 +1877,7 @@ The
function returns a pointer to an array of atom properties that are defined for
the specified window or returns NULL if no properties were found.
To free the memory allocated by this function, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1890,7 +1890,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To change a property of a given window, use
<function>XChangeProperty .</function>
<function>XChangeProperty</function>.
<indexterm><primary>Property</primary><secondary>changing</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>appending</secondary></indexterm>
<indexterm><primary>Property</primary><secondary>prepending</secondary></indexterm>
@ -1953,7 +1953,7 @@ Specifies the property name.
Specifies the type of the property.
The X server does not interpret the type but simply
passes it back to an application that later calls
<function>XGetWindowProperty .</function>
<function>XGetWindowProperty</function>.
</para>
</listitem>
</varlistentry>
@ -1971,7 +1971,7 @@ byte-swap operations as necessary.
If the format is 16-bit or 32-bit,
you must explicitly cast your data pointer to an (unsigned char *) in the call
to
<function>XChangeProperty .</function>
<function>XChangeProperty</function>.
<!-- .\" Changed name of this file to prop_mode.a on 1/13/87 -->
</para>
</listitem>
@ -1984,10 +1984,10 @@ to
<para>
Specifies the mode of the operation.
You can pass
<function>PropModeReplace ,</function>
<function>PropModePrepend ,</function>
<function>PropModeReplace</function>,
<function>PropModePrepend</function>,
or
<function>PropModeAppend .</function>
<function>PropModeAppend</function>.
</para>
</listitem>
</varlistentry>
@ -2029,7 +2029,7 @@ performs the following:
<listitem>
<para>
If mode is
<function>PropModeReplace ,</function>
<function>PropModeReplace</function>,
<function>XChangeProperty</function>
discards the previous property value and stores the new data.
</para>
@ -2039,7 +2039,7 @@ discards the previous property value and stores the new data.
If mode is
<function>PropModePrepend</function>
or
<function>PropModeAppend ,</function>
<function>PropModeAppend</function>,
<function>XChangeProperty</function>
inserts the specified data before the beginning of the existing data
or onto the end of the existing data, respectively.
@ -2082,10 +2082,10 @@ error results.)
<!-- .LP -->
<function>XChangeProperty</function>
can generate
<function>BadAlloc ,</function>
<function>BadAtom ,</function>
<function>BadMatch ,</function>
<function>BadValue ,</function>
<function>BadAlloc</function>,
<function>BadAtom</function>,
<function>BadMatch</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -2094,7 +2094,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To rotate a window's property list, use
<function>XRotateWindowProperties .</function>
<function>XRotateWindowProperties</function>.
</para>
<para>
<!-- .LP -->
@ -2200,8 +2200,8 @@ no properties are changed.
<!-- .LP -->
<function>XRotateWindowProperties</function>
can generate
<function>BadAtom ,</function>
<function>BadMatch ,</function>
<function>BadAtom</function>,
<function>BadMatch</function>,
and
<function>BadWindow </function>
errors.
@ -2210,7 +2210,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To delete a property on a given window, use
<function>XDeleteProperty .</function>
<function>XDeleteProperty</function>.
<indexterm><primary>Property</primary><secondary>deleting</secondary></indexterm>
<indexterm significance="preferred"><primary>XDeleteProperty</primary></indexterm>
<!-- .sM -->
@ -2333,7 +2333,7 @@ The protocol does not constrain the semantics.
<!-- .LP -->
<!-- .sp -->
To set the selection owner, use
<function>XSetSelectionOwner .</function>
<function>XSetSelectionOwner</function>.
<indexterm><primary>Selection</primary><secondary>setting the owner</secondary></indexterm>
<indexterm significance="preferred"><primary>XSetSelectionOwner</primary></indexterm>
<!-- .sM -->
@ -2376,7 +2376,7 @@ Specifies the selection atom.
<para>
Specifies the owner of the specified selection atom.
You can pass a window or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -2388,7 +2388,7 @@ You can pass a window or
<para>
Specifies the time.
You can pass either a timestamp or
<function>CurrentTime .</function>
<function>CurrentTime</function>.
</para>
</listitem>
</varlistentry>
@ -2408,7 +2408,7 @@ with
<function>CurrentTime</function>
replaced by the current server time.
If the owner window is specified as
<function>None ,</function>
<function>None</function>,
then the owner of the selection becomes
<function>None</function>
(that is, no owner).
@ -2418,11 +2418,11 @@ the request.
<para>
<!-- .LP -->
If the new owner (whether a client or
<function>None )</function>
<function>None</function>)
is not
the same as the current owner of the selection and the current
owner is not
<function>None ,</function>
<function>None</function>,
the current owner is sent a
<function>SelectionClear </function>
event.
@ -2432,7 +2432,7 @@ or if the owner window it has specified in the request is later
destroyed,
the owner of the selection automatically
reverts to
<function>None ,</function>
<function>None</function>,
but the last-change time is not affected.
The selection atom is uninterpreted by the X server.
<function>XGetSelectionOwner</function>
@ -2456,7 +2456,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To return the selection owner, use
<function>XGetSelectionOwner .</function>
<function>XGetSelectionOwner</function>.
<indexterm><primary>Selection</primary><secondary>getting the owner</secondary></indexterm>
<indexterm significance="preferred"><primary>XGetSelectionOwner</primary></indexterm>
<!-- .sM -->
@ -2501,7 +2501,7 @@ function
returns the window ID associated with the window that currently owns the
specified selection.
If no selection was specified, the function returns the constant
<function>None .</function>
<function>None</function>.
If
<function>None</function>
is returned,
@ -2518,7 +2518,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To request conversion of a selection, use
<function>XConvertSelection .</function>
<function>XConvertSelection</function>.
<indexterm><primary>Selection</primary><secondary>converting</secondary></indexterm>
<indexterm significance="preferred"><primary>XConvertSelection</primary></indexterm>
<!-- .sM -->
@ -2572,7 +2572,7 @@ Specifies the target atom.
<para>
Specifies the property name.
You also can pass
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -2594,7 +2594,7 @@ Specifies the requestor.
<para>
Specifies the time.
You can pass either a timestamp or
<function>CurrentTime .</function>
<function>CurrentTime</function>.
</para>
</listitem>
</varlistentry>
@ -2622,7 +2622,7 @@ selection exists, the X server generates a
<function>SelectionNotify</function>
event to the
requestor with property
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</itemizedlist>

30
specs/libX11/CH05.xml
View file

@ -18,7 +18,7 @@ A bitmap is a single bit-plane pixmap.
<!-- .LP -->
<!-- .sp -->
To create a pixmap of a given size, use
<function>XCreatePixmap .</function>
<function>XCreatePixmap</function>.
<indexterm significance="preferred"><primary>XCreatePixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -120,8 +120,8 @@ The initial contents of the pixmap are undefined.
<!-- .LP -->
<function>XCreatePixmap</function>
can generate
<function>BadAlloc ,</function>
<function>BadDrawable ,</function>
<function>BadAlloc</function>,
<function>BadDrawable</function>,
and
<function>BadValue </function>
errors.
@ -130,7 +130,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To free all storage associated with a specified pixmap, use
<function>XFreePixmap .</function>
<function>XFreePixmap</function>.
<indexterm significance="preferred"><primary>XFreePixmap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -217,7 +217,7 @@ from an arbitrary font or from bitmaps.
<!-- .LP -->
<!-- .sp -->
To create a cursor from the standard cursor font, use
<function>XCreateFontCursor .</function>
<function>XCreateFontCursor</function>.
</para>
<para>
#include &lt;X11/cursorfont.h&gt;
@ -272,7 +272,7 @@ to use.
The hotspot comes from the information stored in the cursor font.
The initial colors of a cursor are a black foreground and a white
background (see
<function>XRecolorCursor ).</function>
<function>XRecolorCursor</function>).
For further information about cursor shapes,
see appendix B.
</para>
@ -289,7 +289,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To create a cursor from font glyphs, use
<function>XCreateGlyphCursor .</function>
<function>XCreateGlyphCursor</function>.
<indexterm significance="preferred"><primary>XCreateGlyphCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -331,7 +331,7 @@ Specifies the font for the source glyph.
<listitem>
<para>
Specifies the font for the mask glyph or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -417,8 +417,8 @@ least significant byte.
<!-- .LP -->
<function>XCreateGlyphCursor</function>
can generate
<function>BadAlloc ,</function>
<function>BadFont ,</function>
<function>BadAlloc</function>,
<function>BadFont</function>,
and
<function>BadValue </function>
errors.
@ -428,7 +428,7 @@ errors.
<!-- .sp -->
To create a cursor from two bitmaps,
use
<function>XCreatePixmapCursor .</function>
<function>XCreatePixmapCursor</function>.
<indexterm significance="preferred"><primary>XCreatePixmapCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -472,7 +472,7 @@ Specifies the shape of the source cursor.
<listitem>
<para>
Specifies the cursor's source bits to be displayed or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -575,7 +575,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To determine useful cursor sizes, use
<function>XQueryBestCursor .</function>
<function>XQueryBestCursor</function>.
<indexterm significance="preferred"><primary>XQueryBestCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -680,7 +680,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To change the color of a given cursor, use
<function>XRecolorCursor .</function>
<function>XRecolorCursor</function>.
<indexterm significance="preferred"><primary>XRecolorCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -758,7 +758,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To free (destroy) a given cursor, use
<function>XFreeCursor .</function>
<function>XFreeCursor</function>.
<indexterm significance="preferred"><primary>XFreeCursor</primary></indexterm>
<!-- .sM -->
<funcsynopsis>

374
specs/libX11/CH06.xml
View file

File diff suppressed because it is too large Load diff

328
specs/libX11/CH07.xml
View file

@ -60,7 +60,7 @@ To set an attribute of a GC,
set the appropriate member of the
<function>XGCValues</function>
structure and OR in the corresponding value bitmask in your subsequent calls to
<function>XCreateGC .</function>
<function>XCreateGC</function>.
The symbols for the value mask bits and the
<function>XGCValues</function>
structure are:
@ -523,7 +523,7 @@ all internal ends of the individual dashes,
except
<function>CapNotLast</function>
is treated as
<function>CapButt . </function>
<function>CapButt</function>.
</para>
</listitem>
</varlistentry>
@ -647,13 +647,13 @@ the semantics depends on the line-width and the cap-style:
<entry><function>CapRound</function></entry>
<entry>thin</entry>
<entry>The results are the same as for
<function>CapButt /thin.</function></entry>
<function>CapButt /thin</function>.</entry>
</row>
<row>
<entry><function>CapProjecting</function></entry>
<entry>thin</entry>
<entry>The results are the same as for
<function>CapButt /thin.</function></entry>
<function>CapButt /thin</function>.</entry>
</row>
<row>
<entry><function>CapButt</function></entry>
@ -707,7 +707,7 @@ error results.
For stipple operations where the fill-style is
<function>FillStippled</function>
but not
<function>FillOpaqueStippled ,</function>
<function>FillOpaqueStippled</function>,
the stipple pattern is tiled in a
single plane and acts as an additional clip mask to be ANDed with the clip-mask.
Although some sizes may be faster to use than others,
@ -719,24 +719,24 @@ any size pixmap can be used for tiling or stippling.
The fill-style defines the contents of the source for line, text, and
fill requests.
For all text and fill requests (for example,
<function>XDrawText , </function>
<function>XDrawText16 ,</function>
<function>XFillRectangle , </function>
<function>XFillPolygon , </function>
<function>XDrawText</function>,
<function>XDrawText16</function>,
<function>XFillRectangle</function>,
<function>XFillPolygon</function>,
and
<function>XFillArc );</function>
<function>XFillArc</function>);
for line requests
with line-style
<function>LineSolid </function>
(for example,
<function>XDrawLine ,</function>
<function>XDrawSegments , </function>
<function>XDrawRectangle ,</function>
<function>XDrawArc );</function>
<function>XDrawLine</function>,
<function>XDrawSegments</function>,
<function>XDrawRectangle</function>,
<function>XDrawArc</function>);
and for the even dashes for line requests with line-style
<function>LineOnOffDash </function>
or
<function>LineDoubleDash ,</function>
<function>LineDoubleDash</function>,
the following apply:
</para>
@ -770,7 +770,7 @@ the following apply:
<para>
<!-- .LP -->
When drawing lines with line-style
<function>LineDoubleDash ,</function>
<function>LineDoubleDash</function>,
the odd dashes are controlled by the fill-style in the following manner:
</para>
@ -824,10 +824,10 @@ of GCs.
<!-- .LP -->
The dashes value is actually a simplified form of the
more general patterns that can be set with
<function>XSetDashes . </function>
<function>XSetDashes</function>.
Specifying a
value of N is equivalent to specifying the two-element list [N, N] in
<function>XSetDashes . </function>
<function>XSetDashes</function>.
The value must be nonzero,
or a
<function>BadValue</function>
@ -842,7 +842,7 @@ or a
<function>BadMatch </function>
error results.
If clip-mask is set to
<function>None ,</function>
<function>None</function>,
the pixels are always drawn regardless of the clip origin.
The clip-mask also can be set by calling the
<function>XSetClipRectangles</function>
@ -862,15 +862,15 @@ destination drawable is specified in a graphics request.
You can set the subwindow-mode to
<function>ClipByChildren</function>
or
<function>IncludeInferiors .</function>
<function>IncludeInferiors</function>.
For
<function>ClipByChildren , </function>
<function>ClipByChildren</function>,
both source and destination windows are
additionally clipped by all viewable
<function>InputOutput</function>
children.
For
<function>IncludeInferiors ,</function>
<function>IncludeInferiors</function>,
neither source nor destination window is clipped by inferiors.
This will result in including subwindow contents in the source
and drawing through subwindow boundaries of the destination.
@ -888,14 +888,14 @@ paths given in
requests and can be set to
<function>EvenOddRule </function>
or
<function>WindingRule .</function>
<function>WindingRule</function>.
For
<function>EvenOddRule ,</function>
<function>EvenOddRule</function>,
a point is inside if
an infinite ray with the point as origin crosses the path an odd number
of times.
For
<function>WindingRule , </function>
<function>WindingRule</function>,
a point is inside if an infinite ray with the
point as origin crosses an unequal number of clockwise and
counterclockwise directed path segments.
@ -912,7 +912,7 @@ coincident with a segment.
For both
<function>EvenOddRule</function>
and
<function>WindingRule ,</function>
<function>WindingRule</function>,
a point is infinitely small,
and the path is an infinitely thin line.
A pixel is inside if the center point of the pixel is inside
@ -931,12 +931,12 @@ The arc-mode controls filling in the
function and can be set to
<function>ArcPieSlice</function>
or
<function>ArcChord .</function>
<function>ArcChord</function>.
For
<function>ArcPieSlice ,</function>
<function>ArcPieSlice</function>,
the arcs are pie-slice filled.
For
<function>ArcChord ,</function>
<function>ArcChord</function>,
the arcs are chord filled.
</para>
<para>
@ -955,7 +955,7 @@ requests (and any similar requests defined by extensions).
<!-- .sp -->
To create a new GC that is usable on a given screen with a
depth of drawable, use
<function>XCreateGC .</function>
<function>XCreateGC</function>.
<indexterm><primary>Graphics context</primary><secondary>initializing</secondary></indexterm>
<indexterm significance="preferred"><primary>XCreateGC</primary></indexterm>
<!-- .sM -->
@ -1031,11 +1031,11 @@ error.
<!-- .LP -->
<function>XCreateGC</function>
can generate
<function>BadAlloc ,</function>
<function>BadDrawable ,</function>
<function>BadFont ,</function>
<function>BadMatch ,</function>
<function>BadPixmap ,</function>
<function>BadAlloc</function>,
<function>BadDrawable</function>,
<function>BadFont</function>,
<function>BadMatch</function>,
<function>BadPixmap</function>,
and
<function>BadValue </function>
errors.
@ -1044,7 +1044,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To copy components from a source GC to a destination GC, use
<function>XCopyGC .</function>
<function>XCopyGC</function>.
<indexterm significance="preferred"><primary>XCopyGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1114,14 +1114,14 @@ or a
<function>BadMatch</function>
error results.
The valuemask specifies which component to copy, as for
<function>XCreateGC .</function>
<function>XCreateGC</function>.
</para>
<para>
<!-- .LP -->
<function>XCopyGC</function>
can generate
<function>BadAlloc , </function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadMatch</function>
errors.
@ -1130,7 +1130,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To change the components in a given GC, use
<function>XChangeGC .</function>
<function>XChangeGC</function>.
<indexterm significance="preferred"><primary>XChangeGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1198,7 +1198,7 @@ function changes the components specified by valuemask for
the specified GC.
The values argument contains the values to be set.
The values and restrictions are the same as for
<function>XCreateGC .</function>
<function>XCreateGC</function>.
Changing the clip-mask overrides any previous
<function>XSetClipRectangles</function>
request on the context.
@ -1213,11 +1213,11 @@ If an error is generated, a subset of the components may have been altered.
<!-- .LP -->
<function>XChangeGC</function>
can generate
<function>BadAlloc ,</function>
<function>BadFont ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadPixmap ,</function>
<function>BadAlloc</function>,
<function>BadFont</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
<function>BadPixmap</function>,
and
<function>BadValue</function>
errors.
@ -1226,7 +1226,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To obtain components of a given GC, use
<function>XGetGCValues .</function>
<function>XGetGCValues</function>.
<indexterm significance="preferred"><primary>XGetGCValues</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1294,28 +1294,28 @@ The
<function>XGetGCValues</function>
function returns the components specified by valuemask for the specified GC.
If the valuemask contains a valid set of GC mask bits
<function>( GCFunction ,</function>
<function>GCPlaneMask ,</function>
<function>GCForeground ,</function>
<function>GCBackground ,</function>
<function>GCLineWidth ,</function>
<function>GCLineStyle ,</function>
<function>GCCapStyle ,</function>
<function>GCJoinStyle ,</function>
<function>GCFillStyle ,</function>
<function>GCFillRule ,</function>
<function>GCTile ,</function>
<function>GCStipple ,</function>
<function>GCTileStipXOrigin ,</function>
<function>GCTileStipYOrigin ,</function>
<function>GCFont ,</function>
<function>GCSubwindowMode ,</function>
<function>GCGraphicsExposures ,</function>
<function>GCClipXOrigin ,</function>
<function>GCCLipYOrigin ,</function>
<function>GCDashOffset ,</function>
(<function>GCFunction</function>,
<function>GCPlaneMask</function>,
<function>GCForeground</function>,
<function>GCBackground</function>,
<function>GCLineWidth</function>,
<function>GCLineStyle</function>,
<function>GCCapStyle</function>,
<function>GCJoinStyle</function>,
<function>GCFillStyle</function>,
<function>GCFillRule</function>,
<function>GCTile</function>,
<function>GCStipple</function>,
<function>GCTileStipXOrigin</function>,
<function>GCTileStipYOrigin</function>,
<function>GCFont</function>,
<function>GCSubwindowMode</function>,
<function>GCGraphicsExposures</function>,
<function>GCClipXOrigin</function>,
<function>GCCLipYOrigin</function>,
<function>GCDashOffset</function>,
or
<function>GCArcMode )</function>
<function>GCArcMode</function>)
and no error occurs,
<function>XGetGCValues</function>
sets the requested components in values_return and returns a nonzero status.
@ -1328,8 +1328,8 @@ bits, respectively, in the valuemask)
cannot be requested.
Also note that an invalid resource ID (with one or more of the three
most significant bits set to 1) will be returned for
<function>GCFont ,</function>
<function>GCTile ,</function>
<function>GCFont</function>,
<function>GCTile</function>,
and
<function>GCStipple</function>
if the component has never been explicitly set by the client.
@ -1338,7 +1338,7 @@ if the component has never been explicitly set by the client.
<!-- .LP -->
<!-- .sp -->
To free a given GC, use
<function>XFreeGC .</function>
<function>XFreeGC</function>.
<indexterm significance="preferred"><primary>XFreeGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1392,7 +1392,7 @@ error.
To obtain the
<function>GContext </function>
resource ID for a given GC, use
<function>XGContextFromGC .</function>
<function>XGContextFromGC</function>.
<indexterm significance="preferred"><primary>XGContextFromGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1428,7 +1428,7 @@ to explicitly force sending the changes to the server.
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>
<function>XFlushGC</function>.
<indexterm significance="preferred"><primary>XFlushGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1522,7 +1522,7 @@ Arc mode, subwindow mode, and graphics exposure components
<!-- .LP -->
To set the foreground, background, plane mask, and function components
for a given GC, use
<function>XSetState .</function>
<function>XSetState</function>.
<indexterm significance="preferred"><primary>XSetState</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1605,8 +1605,8 @@ Specifies the plane mask.
<!-- .eM -->
<function>XSetState</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -1615,7 +1615,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the foreground of a given GC, use
<function>XSetForeground .</function>
<function>XSetForeground</function>.
<indexterm significance="preferred"><primary>XSetForeground</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1674,7 +1674,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the background of a given GC, use
<function>XSetBackground .</function>
<function>XSetBackground</function>.
<indexterm significance="preferred"><primary>XSetBackground</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1733,7 +1733,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the display function in a given GC, use
<function>XSetFunction .</function>
<function>XSetFunction</function>.
<indexterm significance="preferred"><primary>XSetFunction</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1783,8 +1783,8 @@ Specifies the function you want to set for the specified GC.
<!-- .eM -->
<function>XSetFunction</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -1793,7 +1793,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the plane mask of a given GC, use
<function>XSetPlaneMask .</function>
<function>XSetPlaneMask</function>.
<indexterm significance="preferred"><primary>XSetPlaneMask</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1858,7 +1858,7 @@ errors.
<para>
<!-- .LP -->
To set the line drawing components of a given GC, use
<function>XSetLineAttributes .</function>
<function>XSetLineAttributes</function>.
<indexterm significance="preferred"><primary>XSetLineAttributes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1912,10 +1912,10 @@ Specifies the line-width you want to set for the specified GC.
<para>
Specifies the line-style you want to set for the specified GC.
You can pass
<function>LineSolid ,</function>
<function>LineOnOffDash ,</function>
<function>LineSolid</function>,
<function>LineOnOffDash</function>,
or
<function>LineDoubleDash .</function>
<function>LineDoubleDash</function>.
</para>
</listitem>
</varlistentry>
@ -1927,11 +1927,11 @@ or
<para>
Specifies the line-style and cap-style you want to set for the specified GC.
You can pass
<function>CapNotLast ,</function>
<function>CapButt ,</function>
<function>CapRound ,</function>
<function>CapNotLast</function>,
<function>CapButt</function>,
<function>CapRound</function>,
or
<function>CapProjecting .</function>
<function>CapProjecting</function>.
</para>
</listitem>
</varlistentry>
@ -1943,10 +1943,10 @@ or
<para>
Specifies the line join-style you want to set for the specified GC.
You can pass
<function>JoinMiter ,</function>
<function>JoinRound ,</function>
<function>JoinMiter</function>,
<function>JoinRound</function>,
or
<function>JoinBevel .</function>
<function>JoinBevel</function>.
</para>
</listitem>
</varlistentry>
@ -1957,8 +1957,8 @@ or
<!-- .eM -->
<function>XSetLineAttributes</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -1967,7 +1967,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the dash-offset and dash-list for dashed line styles of a given GC, use
<function>XSetDashes .</function>
<function>XSetDashes</function>.
<indexterm significance="preferred"><primary>XSetDashes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2081,8 +2081,8 @@ For all other lines, the major axis is the y axis.
<!-- .LP -->
<function>XSetDashes</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -2096,7 +2096,7 @@ errors.
<para>
<!-- .LP -->
To set the fill-style of a given GC, use
<function>XSetFillStyle .</function>
<function>XSetFillStyle</function>.
<indexterm significance="preferred"><primary>XSetFillStyle</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2137,11 +2137,11 @@ Specifies the GC.
<para>
Specifies the fill-style you want to set for the specified GC.
You can pass
<function>FillSolid ,</function>
<function>FillTiled ,</function>
<function>FillStippled ,</function>
<function>FillSolid</function>,
<function>FillTiled</function>,
<function>FillStippled</function>,
or
<function>FillOpaqueStippled .</function>
<function>FillOpaqueStippled</function>.
</para>
</listitem>
</varlistentry>
@ -2152,8 +2152,8 @@ or
<!-- .eM -->
<function>XSetFillStyle</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -2162,7 +2162,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the fill-rule of a given GC, use
<function>XSetFillRule .</function>
<function>XSetFillRule</function>.
<indexterm significance="preferred"><primary>XSetFillRule</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2205,7 +2205,7 @@ Specifies the fill-rule you want to set for the specified GC.
You can pass
<function>EvenOddRule</function>
or
<function>WindingRule .</function>
<function>WindingRule</function>.
</para>
</listitem>
</varlistentry>
@ -2216,8 +2216,8 @@ or
<!-- .eM -->
<function>XSetFillRule</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -2242,7 +2242,7 @@ as well as to set the tile or stipple shape and the tile or stipple origin.
<!-- .LP -->
<!-- .sp -->
To obtain the best size of a tile, stipple, or cursor, use
<function>XQueryBestSize .</function>
<function>XQueryBestSize</function>.
<indexterm significance="preferred"><primary>XQueryBestSize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2275,10 +2275,10 @@ Specifies the connection to the X server.
<para>
Specifies the class that you are interested in.
You can pass
<function>TileShape , </function>
<function>CursorShape , </function>
<function>TileShape</function>,
<function>CursorShape</function>,
or
<function>StippleShape .</function>
<function>StippleShape</function>.
</para>
</listitem>
</varlistentry>
@ -2344,29 +2344,29 @@ The
<function>XQueryBestSize</function>
function returns the best or closest size to the specified size.
For
<function>CursorShape ,</function>
<function>CursorShape</function>,
this is the largest size that can be fully displayed on the screen specified by
which_screen.
For
<function>TileShape ,</function>
<function>TileShape</function>,
this is the size that can be tiled fastest.
For
<function>StippleShape ,</function>
<function>StippleShape</function>,
this is the size that can be stippled fastest.
For
<function>CursorShape ,</function>
<function>CursorShape</function>,
the drawable indicates the desired screen.
For
<function>TileShape </function>
and
<function>StippleShape ,</function>
<function>StippleShape</function>,
the drawable indicates the screen and possibly the window class and depth.
An
<function>InputOnly </function>
window cannot be used as the drawable for
<function>TileShape</function>
or
<function>StippleShape ,</function>
<function>StippleShape</function>,
or a
<function>BadMatch </function>
error results.
@ -2375,8 +2375,8 @@ error results.
<!-- .LP -->
<function>XQueryBestSize</function>
can generate
<function>BadDrawable ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -2385,7 +2385,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To obtain the best fill tile shape, use
<function>XQueryBestTile .</function>
<function>XQueryBestTile</function>.
<indexterm significance="preferred"><primary>XQueryBestTile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2491,7 +2491,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To obtain the best stipple shape, use
<function>XQueryBestStipple .</function>
<function>XQueryBestStipple</function>.
<indexterm significance="preferred"><primary>XQueryBestStipple</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2597,7 +2597,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the fill tile of a given GC, use
<function>XSetTile .</function>
<function>XSetTile</function>.
<indexterm significance="preferred"><primary>XSetTile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2654,9 +2654,9 @@ error results.
<!-- .LP -->
<function>XSetTile</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadPixmap </function>
errors.
@ -2665,7 +2665,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the stipple of a given GC, use
<function>XSetStipple .</function>
<function>XSetStipple</function>.
<indexterm significance="preferred"><primary>XSetStipple</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2722,9 +2722,9 @@ error results.
<!-- .LP -->
<function>XSetStipple</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadPixmap </function>
errors.
@ -2733,7 +2733,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the tile or stipple origin of a given GC, use
<function>XSetTSOrigin .</function>
<function>XSetTSOrigin</function>.
<indexterm significance="preferred"><primary>XSetTSOrigin</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2814,7 +2814,7 @@ errors.
<para>
<!-- .LP -->
To set the current font of a given GC, use
<function>XSetFont .</function>
<function>XSetFont</function>.
<indexterm significance="preferred"><primary>XSetFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2864,8 +2864,8 @@ Specifies the font.
<!-- .eM -->
<function>XSetFont</function>
can generate
<function>BadAlloc ,</function>
<function>BadFont ,</function>
<function>BadAlloc</function>,
<function>BadFont</function>,
and
<function>BadGC </function>
errors.
@ -2885,7 +2885,7 @@ and the clip-mask or set the clip-mask to a list of rectangles.
<!-- .LP -->
<!-- .sp -->
To set the clip-origin of a given GC, use
<function>XSetClipOrigin .</function>
<function>XSetClipOrigin</function>.
<indexterm significance="preferred"><primary>XSetClipOrigin</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2960,7 +2960,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the clip-mask of a given GC to the specified pixmap, use
<function>XSetClipMask .</function>
<function>XSetClipMask</function>.
<indexterm significance="preferred"><primary>XSetClipMask</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3000,7 +3000,7 @@ Specifies the GC.
<listitem>
<para>
Specifies the pixmap or
<function>None .</function>
<function>None</function>.
</para>
</listitem>
</varlistentry>
@ -3010,16 +3010,16 @@ Specifies the pixmap or
<!-- .LP -->
<!-- .eM -->
If the clip-mask is set to
<function>None ,</function>
<function>None</function>,
the pixels are always drawn (regardless of the clip-origin).
</para>
<para>
<!-- .LP -->
<function>XSetClipMask</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadPixmap </function>
errors.
@ -3028,7 +3028,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the clip-mask of a given GC to the specified list of rectangles, use
<function>XSetClipRectangles .</function>
<function>XSetClipRectangles</function>.
<indexterm significance="preferred"><primary>XSetClipRectangles</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3113,11 +3113,11 @@ Specifies the number of rectangles.
<para>
Specifies the ordering relations on the rectangles.
You can pass
<function>Unsorted ,</function>
<function>YSorted ,</function>
<function>YXSorted ,</function>
<function>Unsorted</function>,
<function>YSorted</function>,
<function>YXSorted</function>,
or
<function>YXBanded .</function>
<function>YXBanded</function>.
</para>
</listitem>
</varlistentry>
@ -3142,10 +3142,10 @@ which effectively disables output.
This is the opposite of passing
<function>None</function>
as the clip-mask in
<function>XCreateGC ,</function>
<function>XChangeGC ,</function>
<function>XCreateGC</function>,
<function>XChangeGC</function>,
and
<function>XSetClipMask .</function>
<function>XSetClipMask</function>.
</para>
<para>
<!-- .LP -->
@ -3179,9 +3179,9 @@ scanline have an identical Y origins and Y extents.
<!-- .LP -->
<function>XSetClipRectangles</function>
can generate
<function>BadAlloc , </function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -3202,7 +3202,7 @@ see section 16.5.
<para>
<!-- .LP -->
To set the arc mode of a given GC, use
<function>XSetArcMode .</function>
<function>XSetArcMode</function>.
<indexterm significance="preferred"><primary>XSetArcMode</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3245,7 +3245,7 @@ Specifies the arc mode.
You can pass
<function>ArcChord</function>
or
<function>ArcPieSlice .</function>
<function>ArcPieSlice</function>.
</para>
</listitem>
</varlistentry>
@ -3256,8 +3256,8 @@ or
<!-- .eM -->
<function>XSetArcMode</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -3266,7 +3266,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the subwindow mode of a given GC, use
<function>XSetSubwindowMode .</function>
<function>XSetSubwindowMode</function>.
<indexterm significance="preferred"><primary>XSetSubwindowMode</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3309,7 +3309,7 @@ Specifies the subwindow mode.
You can pass
<function>ClipByChildren</function>
or
<function>IncludeInferiors .</function>
<function>IncludeInferiors</function>.
</para>
</listitem>
</varlistentry>
@ -3320,8 +3320,8 @@ or
<!-- .eM -->
<function>XSetSubwindowMode</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.
@ -3330,7 +3330,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To set the graphics-exposures flag of a given GC, use
<function>XSetGraphicsExposures .</function>
<function>XSetGraphicsExposures</function>.
<indexterm significance="preferred"><primary>XSetGraphicsExposures</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3388,8 +3388,8 @@ with this GC.
<!-- .eM -->
<function>XSetGraphicsExposures</function>
can generate
<function>BadAlloc ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadGC</function>,
and
<function>BadValue </function>
errors.

294
specs/libX11/CH08.xml
View file

@ -28,14 +28,14 @@ Because pixmaps do not have defined backgrounds,
they cannot be filled by using the functions described in this section.
Instead, to accomplish an analogous operation on a pixmap,
you should use
<function>XFillRectangle ,</function>
<function>XFillRectangle</function>,
which sets the pixmap to a known value.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To clear a rectangular area of a given window, use
<function>XClearArea .</function>
<function>XClearArea</function>.
<indexterm><primary>Areas</primary><secondary>clearing</secondary></indexterm>
<indexterm><primary>Clearing</primary><secondary>areas</secondary></indexterm>
<indexterm significance="preferred"><primary>XClearArea</primary></indexterm>
@ -139,7 +139,7 @@ The
function paints a rectangular area in the specified window according to the
specified dimensions with the window's background pixel or pixmap.
The subwindow-mode effectively is
<function>ClipByChildren . </function>
<function>ClipByChildren</function>.
If width is zero, it
is replaced with the current width of the window minus x.
If height is
@ -148,17 +148,17 @@ If the window has a defined background tile,
the rectangle clipped by any children is filled with this tile.
If the window has
background
<function>None , </function>
<function>None</function>,
the contents of the window are not changed.
In either
case, if exposures is
<function>True , </function>
<function>True</function>,
one or more
<function>Expose </function>
events are generated for regions of the rectangle that are either visible or are
being retained in a backing store.
If you specify a window whose class is
<function>InputOnly ,</function>
<function>InputOnly</function>,
a
<function>BadMatch</function>
error results.
@ -167,8 +167,8 @@ error results.
<!-- .LP -->
<function>XClearArea</function>
can generate
<function>BadMatch ,</function>
<function>BadValue ,</function>
<function>BadMatch</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -177,7 +177,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To clear the entire area in a given window, use
<function>XClearWindow .</function>
<function>XClearWindow</function>.
<indexterm><primary>Window</primary><secondary>clearing</secondary></indexterm>
<indexterm><primary>Clearing</primary><secondary>windows</secondary></indexterm>
<indexterm significance="preferred"><primary>XClearWindow</primary></indexterm>
@ -222,17 +222,17 @@ function clears the entire area in the specified window and is
equivalent to
<function>XClearArea</function>
(display, w, 0, 0, 0, 0,
<function>False ).</function>
<function>False</function>).
If the window has a defined background tile, the rectangle is tiled with a
plane-mask of all ones and
<function>GXcopy</function>
function.
If the window has
background
<function>None , </function>
<function>None</function>,
the contents of the window are not changed.
If you specify a window whose class is
<function>InputOnly ,</function>
<function>InputOnly</function>,
a
<function>BadMatch</function>
error results.
@ -261,7 +261,7 @@ Xlib provides functions that you can use to copy an area or a bit plane.
<!-- .sp -->
To copy an area between drawables of the same
root and depth, use
<function>XCopyArea .</function>
<function>XCopyArea</function>.
<indexterm><primary>Areas</primary><secondary>copying</secondary></indexterm>
<indexterm><primary>Copying</primary><secondary>areas</secondary></indexterm>
<indexterm significance="preferred"><primary>XCopyArea</primary></indexterm>
@ -413,7 +413,7 @@ Instead, the
following occurs on all corresponding destination regions that are either
visible or are retained in backing store.
If the destination is a window with a background other than
<function>None , </function>
<function>None</function>,
corresponding regions
of the destination are tiled with that background
(with plane-mask of all ones and
@ -421,7 +421,7 @@ of the destination are tiled with that background
function).
Regardless of tiling or whether the destination is a window or a pixmap,
if graphics-exposures is
<function>True ,</function>
<function>True</function>,
then
<function>GraphicsExpose</function>
events for all corresponding destination regions are generated.
@ -446,8 +446,8 @@ clip-y-origin, and clip-mask.
<!-- .LP -->
<function>XCopyArea</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -456,7 +456,7 @@ errors.
<para>
<!-- .LP -->
To copy a single bit plane of a given drawable, use
<function>XCopyPlane .</function>
<function>XCopyPlane</function>.
<indexterm><primary>Plane</primary><secondary>copying</secondary></indexterm>
<indexterm><primary>Copying</primary><secondary>planes</secondary></indexterm>
<indexterm significance="preferred"><primary>XCopyPlane</primary></indexterm>
@ -640,9 +640,9 @@ and clip-mask.
<!-- .LP -->
<function>XCopyPlane</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -762,7 +762,7 @@ for these values.
<para>
<!-- .LP -->
To draw a single point in a given drawable, use
<function>XDrawPoint .</function>
<function>XDrawPoint</function>.
<indexterm significance="preferred"><primary>XDrawPoint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -834,7 +834,7 @@ Specify the x and y coordinates where you want the point drawn.
<!-- .eM -->
<!-- .sp -->
To draw multiple points in a given drawable, use
<function>XDrawPoints .</function>
<function>XDrawPoints</function>.
<indexterm significance="preferred"><primary>XDrawPoints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -910,7 +910,7 @@ Specifies the coordinate mode.
You can pass
<function>CoordModeOrigin</function>
or
<function>CoordModePrevious .</function>
<function>CoordModePrevious</function>.
</para>
</listitem>
</varlistentry>
@ -942,16 +942,16 @@ foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
<!-- .LP -->
<function>XDrawPoint</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
<function>XDrawPoints</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -975,7 +975,7 @@ errors.
<para>
<!-- .LP -->
To draw a single line between two points in a given drawable, use
<function>XDrawLine .</function>
<function>XDrawLine</function>.
<indexterm significance="preferred"><primary>XDrawLine</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1069,7 +1069,7 @@ Specify the points (x1, y1) and (x2, y2) to be connected.
<!-- .eM -->
<!-- .sp -->
To draw multiple lines in a given drawable, use
<function>XDrawLines .</function>
<function>XDrawLines</function>.
<indexterm significance="preferred"><primary>XDrawLines</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1145,7 +1145,7 @@ Specifies the coordinate mode.
You can pass
<function>CoordModeOrigin</function>
or
<function>CoordModePrevious .</function>
<function>CoordModePrevious</function>.
</para>
</listitem>
</varlistentry>
@ -1157,7 +1157,7 @@ or
<!-- .sp -->
To draw multiple, unconnected lines in a given drawable,
use
<function>XDrawSegments .</function>
<function>XDrawSegments</function>.
<indexterm significance="preferred"><primary>XDrawSegments</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1296,13 +1296,13 @@ tile-stipple-y-origin, dash-offset, and dash-list.
</para>
<para>
<!-- .LP -->
<function>XDrawLine ,</function>
<function>XDrawLines ,</function>
<function>XDrawLine</function>,
<function>XDrawLines</function>,
and
<function>XDrawSegments</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -1327,7 +1327,7 @@ errors.
<para>
<!-- .LP -->
To draw the outline of a single rectangle in a given drawable, use
<function>XDrawRectangle .</function>
<function>XDrawRectangle</function>.
<indexterm significance="preferred"><primary>XDrawRectangle</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1424,7 +1424,7 @@ Specify the width and height(Wh.
<!-- .sp -->
To draw the outline of multiple rectangles
in a given drawable, use
<function>XDrawRectangles .</function>
<function>XDrawRectangles</function>.
<indexterm significance="preferred"><primary>XDrawRectangles</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1535,8 +1535,8 @@ tile-stipple-y-origin, dash-offset, and dash-list.
and
<function>XDrawRectangles</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -1558,7 +1558,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To draw a single arc in a given drawable, use
<function>XDrawArc .</function>
<function>XDrawArc</function>.
<indexterm significance="preferred"><primary>XDrawArc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1678,7 +1678,7 @@ arc, in units of degrees * 64.
<!-- .eM -->
<!-- .sp -->
To draw multiple arcs in a given drawable, use
<function>XDrawArcs .</function>
<function>XDrawArcs</function>.
<indexterm significance="preferred"><primary>XDrawArcs</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1866,8 +1866,8 @@ tile-stipple-y-origin, dash-offset, and dash-list.
and
<function>XDrawArcs</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -1916,7 +1916,7 @@ A single arc or multiple arcs
<!-- .LP -->
<!-- .sp -->
To fill a single rectangular area in a given drawable, use
<function>XFillRectangle .</function>
<function>XFillRectangle</function>.
<indexterm significance="preferred"><primary>XFillRectangle</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2013,7 +2013,7 @@ Specify the width and height(Wh.
<!-- .eM -->
<!-- .sp -->
To fill multiple rectangular areas in a given drawable, use
<function>XFillRectangles .</function>
<function>XFillRectangles</function>.
<indexterm significance="preferred"><primary>XFillRectangles</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2130,8 +2130,8 @@ and tile-stipple-y-origin.
and
<function>XFillRectangles</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -2146,7 +2146,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To fill a polygon area in a given drawable, use
<function>XFillPolygon .</function>
<function>XFillPolygon</function>.
<indexterm><primary>Polygons</primary><secondary>filling</secondary></indexterm>
<indexterm><primary>Filling</primary><secondary>polygon</secondary></indexterm>
<indexterm significance="preferred"><primary>XFillPolygon</primary></indexterm>
@ -2223,10 +2223,10 @@ Specifies the number of points in the array.
<para>
Specifies a shape that helps the server to improve performance.
You can pass
<function>Complex , </function>
<function>Convex , </function>
<function>Complex</function>,
<function>Convex</function>,
or
<function>Nonconvex .</function>
<function>Nonconvex</function>.
</para>
</listitem>
</varlistentry>
@ -2240,7 +2240,7 @@ Specifies the coordinate mode.
You can pass
<function>CoordModeOrigin</function>
or
<function>CoordModePrevious .</function>
<function>CoordModePrevious</function>.
</para>
</listitem>
</varlistentry>
@ -2270,7 +2270,7 @@ Depending on the specified shape, the following occurs:
<listitem>
<para>
If shape is
<function>Complex , </function>
<function>Complex</function>,
the path may self-intersect.
Note that contiguous coincident points in the path are not treated
as self-intersection.
@ -2279,7 +2279,7 @@ as self-intersection.
<listitem>
<para>
If shape is
<function>Convex , </function>
<function>Convex</function>,
for every pair of points inside the polygon,
the line segment connecting them does not intersect the path.
If known by the client,
@ -2295,7 +2295,7 @@ the graphics results are undefined.
<listitem>
<para>
If shape is
<function>Nonconvex , </function>
<function>Nonconvex</function>,
the path does not self-intersect, but the shape is not
wholly convex.
If known by the client,
@ -2328,9 +2328,9 @@ and tile-stipple-y-origin.
<!-- .LP -->
<function>XFillPolygon</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -2347,7 +2347,7 @@ errors.
<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>
<function>XFillArc</function>.
<indexterm significance="preferred"><primary>XFillArc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2467,7 +2467,7 @@ arc, in units of degrees * 64.
<!-- .eM -->
<!-- .sp -->
To fill multiple arcs in a given drawable, use
<function>XFillArcs .</function>
<function>XFillArcs</function>.
<indexterm significance="preferred"><primary>XFillArcs</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2545,10 +2545,10 @@ fills the region closed by the infinitely thin path
described by the specified arc and, depending on the
arc-mode specified in the GC, one or two line segments.
For
<function>ArcChord , </function>
<function>ArcChord</function>,
the single line segment joining the endpoints of the arc is used.
For
<function>ArcPieSlice ,</function>
<function>ArcPieSlice</function>,
the two line segments joining the endpoints of the arc with the center
point are used.
<function>XFillArcs</function>
@ -2576,8 +2576,8 @@ and tile-stipple-y-origin.
and
<function>XFillArcs</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -2657,8 +2657,8 @@ a pointer to an array of
structures for the
characters contained in the font.
The
<function>XFontStruct ,</function>
<function>XFontProp ,</function>
<function>XFontStruct</function>,
<function>XFontProp</function>,
and
<function>XCharStruct</function>
structures contain:
@ -2767,14 +2767,14 @@ have the following semantics:
The direction member can be either
<function>FontLeftToRight </function>
or
<function>FontRightToLeft . </function>
<function>FontRightToLeft</function>.
It is just a hint as to whether most
<function>XCharStruct </function>
elements
have a positive
<function>( FontLeftToRight ) </function>
(<function>FontLeftToRight</function>)
or a negative
<function>( FontRightToLeft )</function>
(<function>FontRightToLeft</function>)
character width
metric.
The core protocol defines no support for vertical text.
@ -2830,7 +2830,7 @@ as given by both min_bounds and max_bounds.
<listitem>
<para>
If all_chars_exist is
<function>True ,</function>
<function>True</function>,
all characters in the per_char array have nonzero bounding boxes.
</para>
</listitem>
@ -3014,7 +3014,7 @@ resource ID or a font ID interchangeably.
<!-- .LP -->
<!-- .sp -->
To load a given font, use
<function>XLoadFont .</function>
<function>XLoadFont</function>.
<indexterm significance="preferred"><primary>XLoadFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3075,7 +3075,7 @@ Fonts are not associated with a particular screen
and can be stored as a component
of any GC.
When the font is no longer needed, call
<function>XUnloadFont .</function>
<function>XUnloadFont</function>.
</para>
<para>
<!-- .LP -->
@ -3090,7 +3090,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To return information about an available font, use
<function>XQueryFont .</function>
<function>XQueryFont</function>.
<indexterm significance="preferred"><primary>XQueryFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3141,12 +3141,12 @@ structure will be the
<function>GContext </function>
ID, and you need to be careful when using this ID in other functions
(see
<function>XGContextFromGC ).</function>
<function>XGContextFromGC</function>).
If the font does not exist,
<function>XQueryFont</function>
returns NULL.
To free this data, use
<function>XFreeFontInfo .</function>
<function>XFreeFontInfo</function>.
</para>
<para>
<!-- .LP -->
@ -3156,7 +3156,7 @@ To perform a
and
<function>XQueryFont</function>
in a single operation, use
<function>XLoadQueryFont .</function>
<function>XLoadQueryFont</function>.
<indexterm significance="preferred"><primary>XLoadQueryFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3222,9 +3222,9 @@ To unload the font and free the storage used by the font structure
that was allocated by
<function>XQueryFont</function>
or
<function>XLoadQueryFont ,</function>
<function>XLoadQueryFont</function>,
use
<function>XFreeFont .</function>
<function>XFreeFont</function>.
<indexterm significance="preferred"><primary>XFreeFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3281,7 +3281,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To return a given font property, use
<function>XGetFontProperty .</function>
<function>XGetFontProperty</function>.
<indexterm significance="preferred"><primary>XGetFontProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3351,9 +3351,9 @@ it is likely that the predefined font properties will be present.
<!-- .LP -->
<!-- .sp -->
To unload a font that was loaded by
<function>XLoadFont , </function>
<function>XLoadFont</function>,
use
<function>XUnloadFont .</function>
<function>XUnloadFont</function>.
<indexterm significance="preferred"><primary>XUnloadFont</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3418,7 +3418,7 @@ when querying a font type for a list of available sizes and so on.
<!-- .LP -->
<!-- .sp -->
To return a list of the available font names, use
<function>XListFonts .</function>
<function>XListFonts</function>.
<indexterm significance="preferred"><primary>XListFonts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3482,7 +3482,7 @@ The
<function>XListFonts</function>
function returns an array of available font names
(as controlled by the font search path; see
<function>XSetFontPath )</function>
<function>XSetFontPath</function>)
that match the string you passed to the pattern argument.
The pattern string can contain any characters,
but each asterisk (*) is a wildcard for any number of characters,
@ -3505,7 +3505,7 @@ when finished with the result to free the memory.
<!-- .LP -->
<!-- .sp -->
To free a font name array, use
<function>XFreeFontNames .</function>
<function>XFreeFontNames</function>.
<indexterm significance="preferred"><primary>XFreeFontNames</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3536,13 +3536,13 @@ The
function frees the array and strings returned by
<function>XListFonts </function>
or
<function>XListFontsWithInfo .</function>
<function>XListFontsWithInfo</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain the names and information about available fonts, use
<function>XListFontsWithInfo .</function>
<function>XListFontsWithInfo</function>.
<indexterm significance="preferred"><primary>XListFontsWithInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3639,17 +3639,17 @@ returns NULL.
<!-- .LP -->
To free only the allocated name array,
the client should call
<function>XFreeFontNames .</function>
<function>XFreeFontNames</function>.
To free both the name array and the font information array
or to free just the font information array,
the client should call
<function>XFreeFontInfo .</function>
<function>XFreeFontInfo</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To free font structures and font names, use
<function>XFreeFontInfo .</function>
<function>XFreeFontInfo</function>.
<indexterm significance="preferred"><primary>XFreeFontInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3706,7 +3706,7 @@ function frees a font structure or an array of font structures
and optionally an array of font names.
If NULL is passed for names, no font names are freed.
If a font structure for an open font (returned by
<function>XLoadQueryFont )</function>
<function>XLoadQueryFont</function>)
is passed, the structure is freed,
but the font is not closed; use
<function>XUnloadFont</function>
@ -3733,7 +3733,7 @@ These functions return the sum of the character metrics in pixels.
<!-- .LP -->
<!-- .sp -->
To determine the width of an 8-bit character string, use
<function>XTextWidth .</function>
<function>XTextWidth</function>.
<indexterm significance="preferred"><primary>XTextWidth</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3783,7 +3783,7 @@ Specifies the character count in the specified string.
<!-- .eM -->
<!-- .sp -->
To determine the width of a 2-byte character string, use
<function>XTextWidth16 .</function>
<function>XTextWidth16</function>.
<indexterm significance="preferred"><primary>XTextWidth16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3841,7 +3841,7 @@ Specifies the character count in the specified string.
<para>
<!-- .LP -->
To compute the bounding box of an 8-bit character string in a given font, use
<function>XTextExtents .</function>
<function>XTextExtents</function>.
<indexterm significance="preferred"><primary>XTextExtents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3896,9 +3896,9 @@ Specifies the number of characters in the character string.
<listitem>
<para>
Returns the value of the direction hint
<function>( FontLeftToRight</function>
(<function>FontLeftToRight</function>
or
<function>FontRightToLeft ).</function>
<function>FontRightToLeft</function>).
</para>
</listitem>
</varlistentry>
@ -3941,7 +3941,7 @@ structure.
<!-- .eM -->
<!-- .sp -->
To compute the bounding box of a 2-byte character string in a given font, use
<function>XTextExtents16 .</function>
<function>XTextExtents16</function>.
<indexterm significance="preferred"><primary>XTextExtents16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3996,9 +3996,9 @@ Specifies the number of characters in the character string.
<listitem>
<para>
Returns the value of the direction hint
<function>( FontLeftToRight</function>
(<function>FontLeftToRight</function>
or
<function>FontRightToLeft ).</function>
<function>FontRightToLeft</function>).
</para>
</listitem>
</varlistentry>
@ -4048,7 +4048,7 @@ perform the size computation locally and, thereby,
avoid the round-trip overhead of
<function>XQueryTextExtents </function>
and
<function>XQueryTextExtents16 .</function>
<function>XQueryTextExtents16</function>.
Both functions return an
<function>XCharStruct</function>
structure, whose members are set to the values as follows.
@ -4088,7 +4088,7 @@ undefined characters in the string are taken to have all zero metrics.
<!-- .LP -->
To query the server for the bounding box of an 8-bit character string in a
given font, use
<function>XQueryTextExtents .</function>
<function>XQueryTextExtents</function>.
<indexterm significance="preferred"><primary>XQueryTextExtents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4154,9 +4154,9 @@ Specifies the number of characters in the character string.
<listitem>
<para>
Returns the value of the direction hint
<function>( FontLeftToRight</function>
(<function>FontLeftToRight</function>
or
<function>FontRightToLeft ).</function>
<function>FontRightToLeft</function>).
</para>
</listitem>
</varlistentry>
@ -4200,7 +4200,7 @@ structure.
<!-- .sp -->
To query the server for the bounding box of a 2-byte character string
in a given font, use
<function>XQueryTextExtents16 .</function>
<function>XQueryTextExtents16</function>.
<indexterm significance="preferred"><primary>XQueryTextExtents16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4266,9 +4266,9 @@ Specifies the number of characters in the character string.
<listitem>
<para>
Returns the value of the direction hint
<function>( FontLeftToRight</function>
(<function>FontLeftToRight</function>
or
<function>FontRightToLeft ).</function>
<function>FontRightToLeft</function>).
</para>
</listitem>
</varlistentry>
@ -4320,7 +4320,7 @@ These functions query the X server and, therefore, suffer the round-trip
overhead that is avoided by
<function>XTextExtents</function>
and
<function>XTextExtents16 .</function>
<function>XTextExtents16</function>.
Both functions return a
<function>XCharStruct </function>
structure, whose members are set to the values as follows.
@ -4436,7 +4436,7 @@ typedef struct {
<!-- .LP -->
<!-- .eM -->
If the font member is not
<function>None ,</function>
<function>None</function>,
the font is changed before printing and also is stored in the GC.
If an error was generated during text drawing,
the previous items may have been drawn.
@ -4446,7 +4446,7 @@ coordinates that you pass in the text drawing functions.
<para>
<!-- .LP -->
For example, consider the background rectangle drawn by
<function>XDrawImageString .</function>
<function>XDrawImageString</function>.
If you want the upper-left corner of the background rectangle
to be at pixel coordinate (x,y), pass the (x,y + ascent)
as the baseline origin coordinates to the text functions.
@ -4473,7 +4473,7 @@ structure.
<para>
<!-- .LP -->
To draw 8-bit characters in a given drawable, use
<function>XDrawText .</function>
<function>XDrawText</function>.
<indexterm significance="preferred"><primary>XDrawText</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4569,7 +4569,7 @@ Specifies the number of text items in the array.
<!-- .eM -->
<!-- .sp -->
To draw 2-byte characters in a given drawable, use
<function>XDrawText16 .</function>
<function>XDrawText16</function>.
<indexterm significance="preferred"><primary>XDrawText16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4711,9 +4711,9 @@ and tile-stipple-y-origin.
and
<function>XDrawText16</function>
can generate
<function>BadDrawable ,</function>
<function>BadFont ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadFont</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -4729,7 +4729,7 @@ errors.
<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>
<function>XDrawString</function>.
<indexterm significance="preferred"><primary>XDrawString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4825,7 +4825,7 @@ Specifies the number of characters in the string argument.
<!-- .eM -->
<!-- .sp -->
To draw 2-byte characters in a given drawable, use
<function>XDrawString16 .</function>
<function>XDrawString16</function>.
<indexterm significance="preferred"><primary>XDrawString16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4924,7 +4924,7 @@ additional mask for a fill operation on the drawable.
The drawable is modified only where the font character has a bit set to 1.
For fonts defined with 2-byte matrix indexing
and used with
<function>XDrawString16 ,</function>
<function>XDrawString16</function>,
each byte is used as a byte2 with a byte1 of zero.
</para>
<para>
@ -4942,8 +4942,8 @@ and tile-stipple-y-origin.
and
<function>XDrawString16</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -4969,7 +4969,7 @@ This prevents annoying flicker on many displays.
<!-- .LP -->
<!-- .sp -->
To draw 8-bit image text characters in a given drawable, use
<function>XDrawImageString .</function>
<function>XDrawImageString</function>.
<indexterm significance="preferred"><primary>XDrawImageString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -5065,7 +5065,7 @@ Specifies the number of characters in the string argument.
<!-- .eM -->
<!-- .sp -->
To draw 2-byte image text characters in a given drawable, use
<function>XDrawImageString16 .</function>
<function>XDrawImageString16</function>.
<indexterm significance="preferred"><primary>XDrawImageString16</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -5208,15 +5208,15 @@ are as would be returned by
using gc and string.
The function and fill-style defined in the GC are ignored for these functions.
The effective function is
<function>GXcopy ,</function>
<function>GXcopy</function>,
and the effective fill-style is
<function>FillSolid .</function>
<function>FillSolid</function>.
</para>
<para>
<!-- .LP -->
For fonts defined with 2-byte matrix indexing
and used with
<function>XDrawImageString ,</function>
<function>XDrawImageString</function>,
each byte is used as a byte2 with a byte1 of zero.
</para>
<para>
@ -5231,8 +5231,8 @@ clip-y-origin, and clip-mask.
and
<function>XDrawImageString16</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadMatch </function>
errors.
@ -5310,7 +5310,7 @@ typedef struct _XImage {
<!-- .eM -->
<!-- .sp -->
To initialize the image manipulation routines of an image structure, use
<function>XInitImage .</function>
<function>XInitImage</function>.
<indexterm significance="preferred"><primary>XInitImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -5368,7 +5368,7 @@ or inconsistency in the structure, in which case the image is not changed.
<!-- .sp -->
To combine an image with a rectangle of a drawable on the display,
use
<function>XPutImage .</function>
<function>XPutImage</function>.
<indexterm significance="preferred"><primary>XPutImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -5518,7 +5518,7 @@ and the background pixel defines the source for the zero bits.
For
<function>XYPixmap </function>
and
<function>ZPixmap , </function>
<function>ZPixmap</function>,
the depth of the image must match the depth of the drawable,
or a
<function>BadMatch</function>
@ -5544,9 +5544,9 @@ foreground and background.
<!-- .LP -->
<function>XPutImage</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -5556,7 +5556,7 @@ errors.
<!-- .sp -->
To return the contents of a rectangle in a given drawable on the display,
use
<function>XGetImage .</function>
<function>XGetImage</function>.
This function specifically supports rudimentary screen dumps.
<indexterm significance="preferred"><primary>XGetImage</primary></indexterm>
<!-- .sM -->
@ -5659,7 +5659,7 @@ Specifies the format for the image.
You can pass
<function>XYPixmap</function>
or
<function>ZPixmap .</function>
<function>ZPixmap</function>.
</para>
</listitem>
</varlistentry>
@ -5676,13 +5676,13 @@ structure.
This structure provides you with the contents of the specified rectangle of
the drawable in the format you specify.
If the format argument is
<function>XYPixmap ,</function>
<function>XYPixmap</function>,
the image contains only the bit planes you passed to the plane_mask argument.
If the plane_mask argument only requests a subset of the planes of the
display, the depth of the returned image will be the number of planes
requested.
If the format argument is
<function>ZPixmap ,</function>
<function>ZPixmap</function>,
<function>XGetImage</function>
returns as zero the bits in all planes not
specified in the plane_mask argument.
@ -5733,8 +5733,8 @@ returns NULL.
<!-- .LP -->
<function>XGetImage</function>
can generate
<function>BadDrawable ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.
@ -5744,7 +5744,7 @@ errors.
<!-- .LP -->
To copy the contents of a rectangle on the display
to a location within a preexisting image structure, use
<function>XGetSubImage .</function>
<function>XGetSubImage</function>.
<indexterm significance="preferred"><primary>XGetSubImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -5848,7 +5848,7 @@ Specifies the format for the image.
You can pass
<function>XYPixmap</function>
or
<function>ZPixmap .</function>
<function>ZPixmap</function>.
</para>
</listitem>
</varlistentry>
@ -5894,12 +5894,12 @@ Specify the x and y coordinates(Dx.
The
<function>XGetSubImage </function>
function updates dest_image with the specified subimage in the same manner as
<function>XGetImage . </function>
<function>XGetImage</function>.
If the format argument is
<function>XYPixmap ,</function>
<function>XYPixmap</function>,
the image contains only the bit planes you passed to the plane_mask argument.
If the format argument is
<function>ZPixmap ,</function>
<function>ZPixmap</function>,
<function>XGetSubImage</function>
returns as zero the bits in all planes not
specified in the plane_mask argument.
@ -5946,9 +5946,9 @@ returns NULL.
<!-- .LP -->
<function>XGetSubImage</function>
can generate
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadMatch ,</function>
<function>BadDrawable</function>,
<function>BadGC</function>,
<function>BadMatch</function>,
and
<function>BadValue </function>
errors.

130
specs/libX11/CH09.xml
View file

@ -27,7 +27,7 @@ programs. Xlib provides management functions to:
<para>
<!-- .LP -->
To change a window's parent to another window on the same screen, use
<function>XReparentWindow .</function>
<function>XReparentWindow</function>.
There is no way to move a window between screens.
<indexterm significance="preferred"><primary>XReparentWindow</primary></indexterm>
<!-- .sM -->
@ -119,7 +119,7 @@ The override_redirect member returned in this event is
set to the window's corresponding attribute.
Window manager clients usually should ignore this window if this member
is set to
<function>True .</function>
<function>True</function>.
Finally, if the specified window was originally mapped,
the X server automatically performs a
<function>MapWindow</function>
@ -156,7 +156,7 @@ specified window.
<listitem>
<para>
The new parent is
<function>InputOnly ,</function>
<function>InputOnly</function>,
and the window is not.
</para>
</listitem>
@ -212,7 +212,7 @@ when they are destroyed.
<!-- .LP -->
<!-- .sp -->
To add or remove a window from the client's save-set, use
<function>XChangeSaveSet .</function>
<function>XChangeSaveSet</function>.
<indexterm significance="preferred"><primary>XChangeSaveSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -256,7 +256,7 @@ Specifies the mode.
You can pass
<function>SetModeInsert </function>
or
<function>SetModeDelete .</function>
<function>SetModeDelete</function>.
</para>
</listitem>
</varlistentry>
@ -277,8 +277,8 @@ error results.
<!-- .LP -->
<function>XChangeSaveSet</function>
can generate
<function>BadMatch ,</function>
<function>BadValue ,</function>
<function>BadMatch</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -287,7 +287,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To add a window to the client's save-set, use
<function>XAddToSaveSet .</function>
<function>XAddToSaveSet</function>.
<indexterm significance="preferred"><primary>XAddToSaveSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -346,7 +346,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To remove a window from the client's save-set, use
<function>XRemoveFromSaveSet .</function>
<function>XRemoveFromSaveSet</function>.
<indexterm significance="preferred"><primary>XRemoveFromSaveSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -426,7 +426,7 @@ where M is the minimum number of installed colormaps specified for the screen
in the connection setup.
The required list is maintained as follows.
When a colormap is specified to
<function>XInstallColormap ,</function>
<function>XInstallColormap</function>,
it is added to the head of the list;
the list is truncated at the tail, if necessary, to keep its length to
at most M.
@ -443,7 +443,7 @@ required list.
<!-- .LP -->
<!-- .sp -->
To install a colormap, use
<function>XInstallColormap .</function>
<function>XInstallColormap</function>.
<indexterm significance="preferred"><primary>XInstallColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -486,11 +486,11 @@ function installs the specified colormap for its associated screen.
All windows associated with this colormap immediately display with
true colors.
You associated the windows with this colormap when you created them by calling
<function>XCreateWindow ,</function>
<function>XCreateSimpleWindow ,</function>
<function>XChangeWindowAttributes ,</function>
<function>XCreateWindow</function>,
<function>XCreateSimpleWindow</function>,
<function>XChangeWindowAttributes</function>,
or
<function>XSetWindowColormap .</function>
<function>XSetWindowColormap</function>.
</para>
<para>
<!-- .LP -->
@ -500,7 +500,7 @@ the X server generates a
event on each window that has that colormap.
In addition, for every other colormap that is installed as
a result of a call to
<function>XInstallColormap ,</function>
<function>XInstallColormap</function>,
the X server generates a
<function>ColormapNotify</function>
event on each window that has that colormap.
@ -516,7 +516,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To uninstall a colormap, use
<function>XUninstallColormap .</function>
<function>XUninstallColormap</function>.
<indexterm significance="preferred"><primary>XUninstallColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -571,7 +571,7 @@ the X server generates a
event on each window that has that colormap.
In addition, for every other colormap that is installed or uninstalled as a
result of a call to
<function>XUninstallColormap ,</function>
<function>XUninstallColormap</function>,
the X server generates a
<function>ColormapNotify</function>
event on each window that has that colormap.
@ -587,7 +587,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To obtain a list of the currently installed colormaps for a given screen, use
<function>XListInstalledColormaps .</function>
<function>XListInstalledColormaps</function>.
<indexterm significance="preferred"><primary>XListInstalledColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -644,7 +644,7 @@ The order of the colormaps in the list is not significant
and is no explicit indication of the required list.
When the allocated list is no longer needed,
free it by using
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -669,7 +669,7 @@ search path for a server.
<!-- .LP -->
<!-- .sp -->
To set the font search path, use
<function>XSetFontPath .</function>
<function>XSetFontPath</function>.
<indexterm significance="preferred"><primary>XSetFontPath</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -747,7 +747,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To get the current font search path, use
<function>XGetFontPath .</function>
<function>XGetFontPath</function>.
<indexterm significance="preferred"><primary>XGetFontPath</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -791,15 +791,15 @@ The contents of these strings are implementation-dependent
and are not intended to be interpreted by client applications.
When it is no longer needed,
the data in the font path should be freed by using
<function>XFreeFontPath .</function>
<function>XFreeFontPath</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To free data returned by
<function>XGetFontPath ,</function>
<function>XGetFontPath</function>,
use
<function>XFreeFontPath .</function>
<function>XFreeFontPath</function>.
<indexterm significance="preferred"><primary>XFreeFontPath</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -829,7 +829,7 @@ The
<function>XFreeFontPath</function>
function
frees the data allocated by
<function>XGetFontPath .</function>
<function>XGetFontPath</function>.
</para>
</sect1>
<sect1 id="Grabbing_the_Server_">
@ -853,7 +853,7 @@ Although grabbing the server is highly discouraged, it is sometimes necessary.
<!-- .LP -->
<!-- .sp -->
To grab the server, use
<function>XGrabServer .</function>
<function>XGrabServer</function>.
<indexterm><primary>Server</primary><secondary>grabbing</secondary></indexterm>
<indexterm><primary>Grabbing</primary><secondary>server</secondary></indexterm>
<indexterm significance="preferred"><primary>XGrabServer</primary></indexterm>
@ -891,7 +891,7 @@ You should not grab the X server any more than is absolutely necessary.
<!-- .LP -->
<!-- .sp -->
To ungrab the server, use
<function>XUngrabServer .</function>
<function>XUngrabServer</function>.
<indexterm significance="preferred"><primary>XUngrabServer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -933,7 +933,7 @@ You should avoid grabbing the X server as much as possible.
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>
<function>XKillClient</function>.
<indexterm significance="preferred"><primary>XKillClient</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -962,7 +962,7 @@ Specifies the connection to the X server.
<listitem>
<para>
Specifies any resource associated with the client that you want to destroy or
<function>AllTemporary .</function>
<function>AllTemporary</function>.
</para>
</listitem>
</varlistentry>
@ -991,7 +991,7 @@ is specified, the resources of all clients that have terminated in
are destroyed (see section 2.5).
This permits implementation of window manager facilities that aid debugging.
A client can set its close-down mode to
<function>RetainTemporary .</function>
<function>RetainTemporary</function>.
If the client then crashes,
its windows would not be destroyed.
The programmer can then inspect the application's window tree
@ -1020,7 +1020,7 @@ or to obtain the current screen saver values.
<!-- .LP -->
<!-- .sp -->
To set the screen saver mode, use
<function>XSetScreenSaver .</function>
<function>XSetScreenSaver</function>.
<indexterm significance="preferred"><primary>XSetScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1072,10 +1072,10 @@ Specifies the interval, in seconds, between screen saver alterations.
<para>
Specifies how to enable screen blanking.
You can pass
<function>DontPreferBlanking ,</function>
<function>PreferBlanking ,</function>
<function>DontPreferBlanking</function>,
<function>PreferBlanking</function>,
or
<function>DefaultBlanking .</function>
<function>DefaultBlanking</function>.
</para>
</listitem>
</varlistentry>
@ -1087,10 +1087,10 @@ or
<para>
Specifies the screen save control values.
You can pass
<function>DontAllowExposures ,</function>
<function>AllowExposures ,</function>
<function>DontAllowExposures</function>,
<function>AllowExposures</function>,
or
<function>DefaultExposures .</function>
<function>DefaultExposures</function>.
</para>
</listitem>
</varlistentry>
@ -1132,7 +1132,7 @@ and all screen states are restored at the next
keyboard or pointer input or at the next call to
<function>XForceScreenSaver</function>
with mode
<function>ScreenSaverReset . </function>
<function>ScreenSaverReset</function>.
</para>
<para>
<!-- .LP -->
@ -1155,7 +1155,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To force the screen saver on or off, use
<function>XForceScreenSaver .</function>
<function>XForceScreenSaver</function>.
<indexterm significance="preferred"><primary>XForceScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1187,7 +1187,7 @@ Specifies the mode that is to be applied.
You can pass
<function>ScreenSaverActive</function>
or
<function>ScreenSaverReset .</function>
<function>ScreenSaverReset</function>.
</para>
</listitem>
</varlistentry>
@ -1221,7 +1221,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To activate the screen saver, use
<function>XActivateScreenSaver .</function>
<function>XActivateScreenSaver</function>.
<indexterm significance="preferred"><primary>XActivateScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1249,7 +1249,7 @@ Specifies the connection to the X server.
<!-- .eM -->
<!-- .sp -->
To reset the screen saver, use
<function>XResetScreenSaver .</function>
<function>XResetScreenSaver</function>.
<indexterm significance="preferred"><primary>XResetScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1277,7 +1277,7 @@ Specifies the connection to the X server.
<!-- .eM -->
<!-- .sp -->
To get the current screen saver values, use
<function>XGetScreenSaver .</function>
<function>XGetScreenSaver</function>.
<indexterm significance="preferred"><primary>XGetScreenSaver</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1328,10 +1328,10 @@ Returns the interval between screen saver invocations.
<listitem>
<para>
Returns the current screen blanking preference
<function>( DontPreferBlanking ,</function>
<function>PreferBlanking ,</function>
(<function>DontPreferBlanking</function>,
<function>PreferBlanking</function>,
or
<function>DefaultBlanking ).</function>
<function>DefaultBlanking</function>).
</para>
</listitem>
</varlistentry>
@ -1342,10 +1342,10 @@ or
<listitem>
<para>
Returns the current screen save control value
<function>( DontAllowExposures ,</function>
<function>AllowExposures ,</function>
(<function>DontAllowExposures</function>,
<function>AllowExposures</function>,
or
<function>DefaultExposures ).</function>
<function>DefaultExposures</function>).
</para>
</listitem>
</varlistentry>
@ -1464,12 +1464,12 @@ typedef struct {
<!-- .eM -->
The family member specifies which protocol address family to use
(for example, <acronym>TCP</acronym>/<acronym>IP</acronym> or DECnet) and can be
<function>FamilyInternet ,</function>
<function>FamilyInternet6 ,</function>
<function>FamilyServerInterpreted ,</function>
<function>FamilyDECnet ,</function>
<function>FamilyInternet</function>,
<function>FamilyInternet6</function>,
<function>FamilyServerInterpreted</function>,
<function>FamilyDECnet</function>,
or
<function>FamilyChaos .</function>
<function>FamilyChaos</function>.
The length member specifies the length of the address in bytes.
The address member specifies a pointer to the address.
</para>
@ -1524,7 +1524,7 @@ specify the length in byte of the type and value strings.
<!-- .LP -->
<!-- .sp -->
To add a single host, use
<function>XAddHost .</function>
<function>XAddHost</function>.
<indexterm significance="preferred"><primary>XAddHost</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1582,7 +1582,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To add multiple hosts at one time, use
<function>XAddHosts .</function>
<function>XAddHosts</function>.
<indexterm significance="preferred"><primary>XAddHosts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1651,7 +1651,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To obtain a host list, use
<function>XListHosts .</function>
<function>XListHosts</function>.
<indexterm significance="preferred"><primary>XListHosts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1709,13 +1709,13 @@ It also returns a pointer to a list of host structures that
were allocated by the function.
When no longer needed,
this memory should be freed by calling
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To remove a single host, use
<function>XRemoveHost .</function>
<function>XRemoveHost</function>.
<indexterm significance="preferred"><primary>XRemoveHost</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1777,7 +1777,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To remove multiple hosts at one time, use
<function>XRemoveHosts .</function>
<function>XRemoveHosts</function>.
<indexterm significance="preferred"><primary>XRemoveHosts</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1868,7 +1868,7 @@ at connection setup.
<!-- .LP -->
<!-- .sp -->
To change access control, use
<function>XSetAccessControl .</function>
<function>XSetAccessControl</function>.
<indexterm significance="preferred"><primary>XSetAccessControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1900,7 +1900,7 @@ Specifies the mode.
You can pass
<function>EnableAccess</function>
or
<function>DisableAccess .</function>
<function>DisableAccess</function>.
</para>
</listitem>
</varlistentry>
@ -1927,7 +1927,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To enable access control, use
<function>XEnableAccessControl .</function>
<function>XEnableAccessControl</function>.
<indexterm significance="preferred"><primary>XEnableAccessControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1968,7 +1968,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To disable access control, use
<function>XDisableAccessControl .</function>
<function>XDisableAccessControl</function>.
<indexterm significance="preferred"><primary>XDisableAccessControl</primary></indexterm>
<!-- .sM -->
<funcsynopsis>

594
specs/libX11/CH10.xml
View file

File diff suppressed because it is too large Load diff

166
specs/libX11/CH11.xml
View file

@ -37,9 +37,9 @@ One way is to set the event_mask member of the
structure when you call
<function>XCreateWindow</function>
and
<function>XChangeWindowAttributes .</function>
<function>XChangeWindowAttributes</function>.
Another way is to use
<function>XSelectInput . </function>
<function>XSelectInput</function>.
<indexterm significance="preferred"><primary>XSelectInput</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -118,13 +118,13 @@ to all interested clients.
<listitem>
<para>
Only one client at a time can select
<function>CirculateRequest ,</function>
<function>ConfigureRequest ,</function>
<function>CirculateRequest</function>,
<function>ConfigureRequest</function>,
or
<function>MapRequest</function>
events, which are associated with
the event mask
<function>SubstructureRedirectMask . </function>
<function>SubstructureRedirectMask</function>.
</para>
</listitem>
<listitem>
@ -134,7 +134,7 @@ a
<function>ResizeRequest</function>
event, which is associated with
the event mask
<function>ResizeRedirectMask . </function>
<function>ResizeRedirectMask</function>.
</para>
</listitem>
<listitem>
@ -143,7 +143,7 @@ Only one client at a time can select a
<function>ButtonPress </function>
event, which is associated with
the event mask
<function>ButtonPressMask .</function>
<function>ButtonPressMask</function>.
</para>
</listitem>
</itemizedlist>
@ -177,7 +177,7 @@ These functions differ in the additional tasks they might perform.
<!-- .LP -->
<!-- .sp -->
To flush the output buffer, use
<function>XFlush .</function>
<function>XFlush</function>.
<indexterm significance="preferred"><primary>XFlush</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -209,10 +209,10 @@ function
flushes the output buffer.
Most client applications need not use this function because the output
buffer is automatically flushed as needed by calls to
<function>XPending ,</function>
<function>XNextEvent ,</function>
<function>XPending</function>,
<function>XNextEvent</function>,
and
<function>XWindowEvent .</function>
<function>XWindowEvent</function>.
<indexterm><primary>XPending</primary></indexterm>
<indexterm><primary>XNextEvent</primary></indexterm>
<indexterm><primary>XWindowEvent</primary></indexterm>
@ -223,7 +223,7 @@ Events generated by the server may be enqueued into the library's event queue.
<!-- .sp -->
To flush the output buffer and then wait until all requests have been processed,
use
<function>XSync .</function>
<function>XSync</function>.
<indexterm significance="preferred"><primary>XSync</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -277,18 +277,18 @@ event queue.
<para>
<!-- .LP -->
Finally, if you passed
<function>False ,</function>
<function>False</function>,
<function>XSync</function>
does not discard the events in the queue.
If you passed
<function>True ,</function>
<function>True</function>,
<function>XSync </function>
discards all events in the queue,
including those events that were on the queue before
<function>XSync</function>
was called.
Client applications seldom need to call
<function>XSync .</function>
<function>XSync</function>.
</para>
</sect1>
<sect1 id="Event_Queue_Management">
@ -306,7 +306,7 @@ in its network connection that is not yet read into the event queue.
<!-- .LP -->
<!-- .sp -->
To check the number of events in the event queue, use
<function>XEventsQueued .</function>
<function>XEventsQueued</function>.
<indexterm significance="preferred"><primary>XEventsQueued</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -336,10 +336,10 @@ Specifies the connection to the X server.
<para>
Specifies the mode.
You can pass
<function>QueuedAlready ,</function>
<function>QueuedAfterFlush ,</function>
<function>QueuedAlready</function>,
<function>QueuedAfterFlush</function>,
or
<function>QueuedAfterReading .</function>
<function>QueuedAfterReading</function>.
</para>
</listitem>
</varlistentry>
@ -349,12 +349,12 @@ or
<!-- .LP -->
<!-- .eM -->
If mode is
<function>QueuedAlready ,</function>
<function>QueuedAlready</function>,
<function>XEventsQueued </function>
returns the number of events
already in the event queue (and never performs a system call).
If mode is
<function>QueuedAfterFlush , </function>
<function>QueuedAfterFlush</function>,
<function>XEventsQueued</function>
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
@ -363,7 +363,7 @@ flushes the output buffer,
attempts to read more events out of the application's connection,
and returns the number read.
If mode is
<function>QueuedAfterReading , </function>
<function>QueuedAfterReading</function>,
<function>XEventsQueued</function>
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
@ -380,7 +380,7 @@ queue.
with mode
<function>QueuedAfterFlush</function>
is identical in behavior to
<function>XPending .</function>
<function>XPending</function>.
<function>XEventsQueued</function>
with mode
<function>QueuedAlready</function>
@ -392,7 +392,7 @@ function.
<!-- .LP -->
<!-- .sp -->
To return the number of events that are pending, use
<function>XPending .</function>
<function>XPending</function>.
<indexterm significance="preferred"><primary>XPending</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -466,7 +466,7 @@ predicate procedures that you provide
<para>
<!-- .LP -->
To get the next event and remove it from the queue, use
<function>XNextEvent .</function>
<function>XNextEvent</function>.
<indexterm significance="preferred"><primary>XNextEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -516,7 +516,7 @@ flushes the output buffer and blocks until an event is received.
<!-- .LP -->
<!-- .sp -->
To peek at the event queue, use
<function>XPeekEvent .</function>
<function>XPeekEvent</function>.
<indexterm significance="preferred"><primary>XPeekEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -583,7 +583,7 @@ If Xlib has been initialized for threads, the predicate is called with
the display locked and the result of a call by the predicate to any
Xlib function that locks the display is not defined unless the caller
has first called
<function>XLockDisplay .</function>
<function>XLockDisplay</function>.
</para>
<para>
<!-- .LP -->
@ -628,8 +628,8 @@ structure.
<listitem>
<para>
Specifies the argument passed in from the
<function>XIfEvent ,</function>
<function>XCheckIfEvent ,</function>
<function>XIfEvent</function>,
<function>XCheckIfEvent</function>,
or
<function>XPeekIfEvent </function>
function.
@ -644,16 +644,16 @@ function.
The predicate procedure is called once for each
event in the queue until it finds a match.
After finding a match, the predicate procedure must return
<function>True .</function>
<function>True</function>.
If it did not find a match, it must return
<function>False .</function>
<function>False</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To check the event queue for a matching event
and, if found, remove the event from the queue, use
<function>XIfEvent .</function>
<function>XIfEvent</function>.
<indexterm significance="preferred"><primary>XIfEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -732,7 +732,7 @@ structure.
<!-- .LP -->
<!-- .sp -->
To check the event queue for a matching event without blocking, use
<function>XCheckIfEvent .</function>
<function>XCheckIfEvent</function>.
<indexterm significance="preferred"><primary>XCheckIfEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -797,12 +797,12 @@ When the predicate procedure finds a match,
copies the matched event into the client-supplied
<function>XEvent</function>
structure and returns
<function>True .</function>
<function>True</function>.
(This event is removed from the queue.)
If the predicate procedure finds no match,
<function>XCheckIfEvent</function>
returns
<function>False ,</function>
<function>False</function>,
and the output buffer will have been flushed.
All earlier events stored in the queue are not discarded.
</para>
@ -811,7 +811,7 @@ All earlier events stored in the queue are not discarded.
<!-- .sp -->
To check the event queue for a matching event
without removing the event from the queue, use
<function>XPeekIfEvent .</function>
<function>XPeekIfEvent</function>.
<indexterm significance="preferred"><primary>XPeekIfEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -900,7 +900,7 @@ or event types, allowing you to process events out of order.
<!-- .LP -->
<!-- .sp -->
To remove the next event that matches both a window and an event mask, use
<function>XWindowEvent .</function>
<function>XWindowEvent</function>.
<indexterm significance="preferred"><primary>XWindowEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -979,7 +979,7 @@ flushes the output buffer and blocks until one is received.
<!-- .sp -->
To remove the next event that matches both a window and an event mask (if any),
use
<function>XCheckWindowEvent .</function>
<function>XCheckWindowEvent</function>.
<indexterm><primary>XCheckWindowEvent</primary></indexterm>
This function is similar to
<function>XWindowEvent </function>
@ -1055,19 +1055,19 @@ If it finds a match,
removes that event, copies it into the specified
<function>XEvent</function>
structure, and returns
<function>True .</function>
<function>True</function>.
The other events stored in the queue are not discarded.
If the event you requested is not available,
<function>XCheckWindowEvent</function>
returns
<function>False ,</function>
<function>False</function>,
and the output buffer will have been flushed.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To remove the next event that matches an event mask, use
<function>XMaskEvent .</function>
<function>XMaskEvent</function>.
<indexterm significance="preferred"><primary>XMaskEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1133,7 +1133,7 @@ flushes the output buffer and blocks until one is received.
<!-- .LP -->
<!-- .sp -->
To return and remove the next event that matches an event mask (if any), use
<function>XCheckMaskEvent .</function>
<function>XCheckMaskEvent</function>.
This function is similar to
<function>XMaskEvent </function>
except that it never blocks and it returns a
@ -1195,19 +1195,19 @@ If it finds a match,
removes that event, copies it into the specified
<function>XEvent</function>
structure, and returns
<function>True .</function>
<function>True</function>.
The other events stored in the queue are not discarded.
If the event you requested is not available,
<function>XCheckMaskEvent</function>
returns
<function>False ,</function>
<function>False</function>,
and the output buffer will have been flushed.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To return and remove the next event in the queue that matches an event type, use
<function>XCheckTypedEvent .</function>
<function>XCheckTypedEvent</function>.
<indexterm significance="preferred"><primary>XCheckTypedEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1265,12 +1265,12 @@ If it finds a match,
removes that event, copies it into the specified
<function>XEvent</function>
structure, and returns
<function>True .</function>
<function>True</function>.
The other events in the queue are not discarded.
If the event is not available,
<function>XCheckTypedEvent</function>
returns
<function>False ,</function>
<function>False</function>,
and the output buffer will have been flushed.
</para>
<para>
@ -1278,7 +1278,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
and a window, use
<function>XCheckTypedWindowEvent .</function>
<function>XCheckTypedWindowEvent</function>.
<indexterm significance="preferred"><primary>XCheckTypedWindowEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1348,12 +1348,12 @@ If it finds a match,
removes the event from the queue, copies it into the specified
<function>XEvent</function>
structure, and returns
<function>True .</function>
<function>True</function>.
The other events in the queue are not discarded.
If the event is not available,
<function>XCheckTypedWindowEvent</function>
returns
<function>False ,</function>
<function>False</function>,
and the output buffer will have been flushed.
</para>
</sect2>
@ -1366,7 +1366,7 @@ and the output buffer will have been flushed.
<para>
<!-- .LP -->
To push an event back into the event queue, use
<function>XPutBackEvent .</function>
<function>XPutBackEvent</function>.
<indexterm significance="preferred"><primary>XPutBackEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1410,7 +1410,7 @@ by copying the event into the queue.
This can be useful if you read an event and then decide that you
would rather deal with it later.
There is no limit to the number of times in succession that you can call
<function>XPutBackEvent .</function>
<function>XPutBackEvent</function>.
</para>
</sect1>
<sect1 id="Sending_Events_to_Other_Applications">
@ -1421,7 +1421,7 @@ There is no limit to the number of times in succession that you can call
<para>
<!-- .LP -->
To send an event to a specified window, use
<function>XSendEvent .</function>
<function>XSendEvent</function>.
<indexterm><primary>XSendEvent</primary></indexterm>
This function is often used in selection processing.
For example, the owner of a selection should use
@ -1461,9 +1461,9 @@ Specifies the connection to the X server.
<listitem>
<para>
Specifies the window the event is to be sent to, or
<function>PointerWindow ,</function>
<function>PointerWindow</function>,
or
<function>InputFocus .</function>
<function>InputFocus</function>.
</para>
</listitem>
</varlistentry>
@ -1516,7 +1516,7 @@ This function uses the w argument to identify the destination window as follows:
<listitem>
<para>
If w is
<function>PointerWindow ,</function>
<function>PointerWindow</function>,
the destination window is the window that contains the pointer.
</para>
</listitem>
@ -1548,7 +1548,7 @@ no event is sent.
<listitem>
<para>
If propagate is
<function>False ,</function>
<function>False</function>,
the event is sent to every client selecting on destination any of the event
types in the event_mask argument.
</para>
@ -1587,7 +1587,7 @@ otherwise unaltered and unchecked by the X server except to force send_event to
in the forwarded event and to set the serial number in the event correctly;
therefore these fields
and the display field are ignored by
<function>XSendEvent .</function>
<function>XSendEvent</function>.
</para>
<para>
<!-- .LP -->
@ -1627,7 +1627,7 @@ However, this historical information is highly excessive for most applications.
<!-- .sp -->
To determine the approximate maximum number of elements in the motion buffer,
use
<function>XDisplayMotionBufferSize .</function>
<function>XDisplayMotionBufferSize</function>.
<indexterm significance="preferred"><primary>XDisplayMotionBufferSize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1665,7 +1665,7 @@ function makes this history available.
<!-- .LP -->
<!-- .sp -->
To get the motion history for a specified window and time, use
<function>XGetMotionEvents .</function>
<function>XGetMotionEvents</function>.
<indexterm significance="preferred"><primary>XGetMotionEvents</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1719,7 +1719,7 @@ Specifies the window.
Specify the time interval in which the events are returned from the motion
history buffer.
You can pass a timestamp or
<function>CurrentTime .</function>
<function>CurrentTime</function>.
</para>
</listitem>
</varlistentry>
@ -1751,7 +1751,7 @@ no events are returned;
<function>XGetMotionEvents</function>
returns NULL.
If the stop time is in the future, it is equivalent to specifying
<function>CurrentTime .</function>
<function>CurrentTime</function>.
The return type for this function is a structure defined as follows:
</para>
<para>
@ -1775,7 +1775,7 @@ The x and y members are set to the coordinates of the pointer and
are reported relative to the origin
of the specified window.
To free the data returned from this call, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1865,7 +1865,7 @@ returns the previous after function.
<para>
<!-- .LP -->
To enable or disable synchronization, use
<function>XSynchronize .</function>
<function>XSynchronize</function>.
<indexterm><primary>Debugging</primary><secondary>synchronous mode</secondary></indexterm>
<indexterm significance="preferred"><primary>XSynchronize</primary></indexterm>
<!-- .sM -->
@ -1909,11 +1909,11 @@ The
function returns
the previous after function.
If onoff is
<function>True , </function>
<function>True</function>,
<function>XSynchronize</function>
turns on synchronous behavior.
If onoff is
<function>False ,</function>
<function>False</function>,
<function>XSynchronize </function>
turns off synchronous behavior.
</para>
@ -1942,7 +1942,7 @@ message and exit.
<!-- .LP -->
<!-- .sp -->
To set the error handler, use
<function>XSetErrorHandler .</function>
<function>XSetErrorHandler</function>.
<indexterm significance="preferred"><primary>XSetErrorHandler</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1973,8 +1973,8 @@ supplied error handler whenever an error is received.
It is not called on
<function>BadName</function>
errors from
<function>OpenFont ,</function>
<function>LookupColor ,</function>
<function>OpenFont</function>,
<function>LookupColor</function>,
or
<function>AllocNamedColor</function>
protocol requests or on
@ -2114,14 +2114,14 @@ chapter:
<row>
<entry><function>BadFont</function></entry>
<entry>A value for a font argument does not name a defined font (or, in some cases,
<function>GContext ).</function></entry>
<function>GContext</function>).</entry>
</row>
<row>
<entry><function>BadGC</function></entry>
<entry>A value for a
<function>GContext </function>
argument does not name a defined
<function>GContext .</function></entry>
<function>GContext</function>.</entry>
</row>
<row>
<entry><function>BadIDChoice</function></entry>
@ -2212,13 +2212,13 @@ chapter:
<note>
<para>
The
<function>BadAtom , </function>
<function>BadColor , </function>
<function>BadCursor , </function>
<function>BadDrawable , </function>
<function>BadFont , </function>
<function>BadGC , </function>
<function>BadPixmap , </function>
<function>BadAtom</function>,
<function>BadColor</function>,
<function>BadCursor</function>,
<function>BadDrawable</function>,
<function>BadFont</function>,
<function>BadGC</function>,
<function>BadPixmap</function>,
and
<function>BadWindow</function>
errors are also used when the argument type is extended by a set of
@ -2231,7 +2231,7 @@ fixed alternatives.
<para>
<!-- .LP -->
To obtain textual descriptions of the specified error code, use
<function>XGetErrorText .</function>
<function>XGetErrorText</function>.
<indexterm significance="preferred"><primary>XGetErrorText</primary></indexterm>
<indexterm><primary>Debugging</primary><secondary>error message strings</secondary></indexterm>
<!-- .sM -->
@ -2304,7 +2304,7 @@ and error strings.
<!-- .LP -->
<!-- .sp -->
To obtain error messages from the error database, use
<function>XGetErrorDatabaseText .</function>
<function>XGetErrorDatabaseText</function>.
<indexterm significance="preferred"><primary>XGetErrorDatabaseText</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2435,7 +2435,7 @@ For a core protocol request,
the major request protocol number is used for the message argument.
For an extension request,
the extension name (as given by
<function>InitExtension )</function>
<function>InitExtension</function>)
followed by a period (\.) and the minor request protocol number
is used for the message argument.
If no string is found in the error database,
@ -2449,7 +2449,7 @@ the default_string is returned to the buffer argument.
<!-- .LP -->
<!-- .sp -->
To report an error to the user when the requested display does not exist, use
<function>XDisplayName .</function>
<function>XDisplayName</function>.
<indexterm significance="preferred"><primary>XDisplayName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2492,7 +2492,7 @@ program attempted to open when the initial connection attempt failed.
<!-- .LP -->
<!-- .sp -->
To handle fatal I/O errors, use
<function>XSetIOErrorHandler .</function>
<function>XSetIOErrorHandler</function>.
<indexterm significance="preferred"><primary>XSetIOErrorHandler</primary></indexterm>
<!-- .sM -->
<funcsynopsis>

396
specs/libX11/CH12.xml
View file

File diff suppressed because it is too large Load diff

510
specs/libX11/CH13.xml
View file

File diff suppressed because it is too large Load diff

216
specs/libX11/CH14.xml
View file

@ -253,7 +253,7 @@ to manipulate your application's subwindows.
<para>
<!-- .LP -->
To request that a top-level window be iconified, use
<function>XIconifyWindow .</function>
<function>XIconifyWindow</function>.
<indexterm significance="preferred"><primary>XIconifyWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -313,7 +313,7 @@ and a window of w
to the root window of the specified screen
with an event mask set to
<function>SubstructureNotifyMask |</function>
<function>SubstructureRedirectMask .</function>
<function>SubstructureRedirectMask</function>.
Window managers may elect to receive this message and
if the window is in its normal state,
may treat it as a request to change the window's state from normal to iconic.
@ -327,7 +327,7 @@ otherwise, it returns a zero status.
<para>
<!-- .LP -->
To request that a top-level window be withdrawn, use
<function>XWithdrawWindow .</function>
<function>XWithdrawWindow</function>.
<indexterm significance="preferred"><primary>XWithdrawWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -401,7 +401,7 @@ error.
<para>
<!-- .LP -->
To request that a top-level window be reconfigured, use
<function>XReconfigureWMWindow .</function>
<function>XReconfigureWMWindow</function>.
<indexterm significance="preferred"><primary>XReconfigureWMWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -574,7 +574,7 @@ To convert a list of text strings to an
structure, use
<function>XmbTextListToTextProperty</function>
or
<function>XwcTextListToTextProperty .</function>
<function>XwcTextListToTextProperty</function>.
<indexterm significance="preferred"><primary>XmbTextListToTextProperty</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextListToTextProperty</primary></indexterm>
<!-- .sM -->
@ -697,19 +697,19 @@ else ``COMPOUND_TEXT''.
<!-- .LP -->
If insufficient memory is available for the new value string,
the functions return
<function>XNoMemory .</function>
<function>XNoMemory</function>.
If the current locale is not supported,
the functions return
<function>XLocaleNotSupported .</function>
<function>XLocaleNotSupported</function>.
In both of these error cases,
the functions do not set text_prop_return.
</para>
<para>
<!-- .LP -->
To determine if the functions are guaranteed not to return
<function>XLocaleNotSupported ,</function>
<function>XLocaleNotSupported</function>,
use
<function>XSupportsLocale .</function>
<function>XSupportsLocale</function>.
</para>
<para>
<!-- .LP -->
@ -718,7 +718,7 @@ the functions return the number of unconvertible characters.
Each unconvertible character is converted to an implementation-defined and
encoding-specific default string.
Otherwise, the functions return
<function>Success .</function>
<function>Success</function>.
Note that full convertibility to all styles except
<function>XStringStyle</function>
is guaranteed.
@ -726,7 +726,7 @@ is guaranteed.
<para>
<!-- .LP -->
To free the storage for the value field, use
<function>XFree .</function>
<function>XFree</function>.
<!-- .sp -->
</para>
<para>
@ -736,7 +736,7 @@ To obtain a list of text strings from an
structure, use
<function>XmbTextPropertyToTextList</function>
or
<function>XwcTextPropertyToTextList .</function>
<function>XwcTextPropertyToTextList</function>.
<indexterm significance="preferred"><primary>XmbTextPropertyToTextList</primary></indexterm>
<indexterm significance="preferred"><primary>XwcTextPropertyToTextList</primary></indexterm>
<!-- .sM -->
@ -833,14 +833,14 @@ If insufficient memory is available for the list and its elements,
and
<function>XwcTextPropertyToTextList</function>
return
<function>XNoMemory .</function>
<function>XNoMemory</function>.
If the current locale is not supported,
the functions return
<function>XLocaleNotSupported .</function>
<function>XLocaleNotSupported</function>.
Otherwise, if the encoding field of text_prop is not convertible
to the encoding of the current locale,
the functions return
<function>XConverterNotFound .</function>
<function>XConverterNotFound</function>.
For supported locales,
existence of a converter from COMPOUND_TEXT, STRING
or the encoding of the current locale is guaranteed if
@ -871,31 +871,31 @@ Each unconvertible character is converted to a string in the
current locale that is specific to the current locale.
To obtain the value of this string,
use
<function>XDefaultString .</function>
<function>XDefaultString</function>.
Otherwise,
<function>XmbTextPropertyToTextList</function>
and
<function>XwcTextPropertyToTextList</function>
return
<function>Success .</function>
<function>Success</function>.
</para>
<para>
<!-- .LP -->
To free the storage for the list and its contents returned by
<function>XmbTextPropertyToTextList ,</function>
<function>XmbTextPropertyToTextList</function>,
use
<function>XFreeStringList .</function>
<function>XFreeStringList</function>.
To free the storage for the list and its contents returned by
<function>XwcTextPropertyToTextList ,</function>
<function>XwcTextPropertyToTextList</function>,
use
<function>XwcFreeStringList .</function>
<function>XwcFreeStringList</function>.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To free the in-memory data associated with the specified
wide character string list, use
<function>XwcFreeStringList .</function>
<function>XwcFreeStringList</function>.
<indexterm significance="preferred"><primary>XwcFreeStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -924,7 +924,7 @@ Specifies the list of strings to be freed.
The
<function>XwcFreeStringList</function>
function frees memory allocated by
<function>XwcTextPropertyToTextList .</function>
<function>XwcTextPropertyToTextList</function>.
<!-- .sp -->
</para>
<para>
@ -941,7 +941,7 @@ The
<function>XDefaultString</function>
function returns the default string used by Xlib for text conversion
(for example, in
<function>XmbTextPropertyToTextList ).</function>
<function>XmbTextPropertyToTextList</function>).
The default string is the string in the current locale that is output
when an unconvertible character is found during text conversion.
If the string returned by
@ -959,7 +959,7 @@ is independent of the default string for text drawing;
see
<function>XCreateFontSet</function>
to obtain the default string for an
<function>XFontSet .</function>
<function>XFontSet</function>.
</para>
<para>
<!-- .LP -->
@ -979,7 +979,7 @@ Until freed, it will not be modified by Xlib.
To set the specified list of strings in the STRING encoding to a
<function>XTextProperty</function>
structure, use
<function>XStringListToTextProperty .</function>
<function>XStringListToTextProperty</function>.
<indexterm significance="preferred"><primary>XStringListToTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1046,7 +1046,7 @@ does not set any fields in the
structure and returns a zero status.
Otherwise, it returns a nonzero status.
To free the storage for the value field, use
<function>XFree .</function>
<function>XFree</function>.
<!-- .sp -->
</para>
<para>
@ -1054,7 +1054,7 @@ To free the storage for the value field, use
To obtain a list of strings from a specified
<function>XTextProperty</function>
structure in the STRING encoding, use
<function>XTextPropertyToStringList .</function>
<function>XTextPropertyToStringList</function>.
<indexterm significance="preferred"><primary>XTextPropertyToStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1121,13 +1121,13 @@ If insufficient memory is available for the list and its elements,
sets no return values and returns a zero status.
Otherwise, it returns a nonzero status.
To free the storage for the list and its contents, use
<function>XFreeStringList .</function>
<function>XFreeStringList</function>.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To free the in-memory data associated with the specified string list, use
<function>XFreeStringList .</function>
<function>XFreeStringList</function>.
<indexterm significance="preferred"><primary>XFreeStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1160,7 +1160,7 @@ function releases memory allocated by
and
<function>XTextPropertyToStringList</function>
and the missing charset list allocated by
<function>XCreateFontSet .</function>
<function>XCreateFontSet</function>.
</para>
</sect2>
<sect2 id="Setting_and_Reading_Text_Properties">
@ -1184,7 +1184,7 @@ see sections 14.1.4, 14.1.5, 14.2.1, and 14.2.2, respectively.
<para>
<!-- .LP -->
To set one of a window's text properties, use
<function>XSetTextProperty .</function>
<function>XSetTextProperty</function>.
<indexterm significance="preferred"><primary>XSetTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1261,9 +1261,9 @@ sets it for the specified window.
<!-- .LP -->
<function>XSetTextProperty</function>
can generate
<function>BadAlloc ,</function>
<function>BadAtom , </function>
<function>BadValue , </function>
<function>BadAlloc</function>,
<function>BadAtom</function>,
<function>BadValue</function>,
and
<function>BadWindow </function>
errors.
@ -1272,7 +1272,7 @@ errors.
<para>
<!-- .LP -->
To read one of a window's text properties, use
<function>XGetTextProperty .</function>
<function>XGetTextProperty</function>.
<indexterm significance="preferred"><primary>XGetTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1351,7 +1351,7 @@ If the specified property does not exist on the window,
<function>XGetTextProperty</function>
sets the value field to NULL,
the encoding field to
<function>None , </function>
<function>None</function>,
the format field to zero,
and the nitems field to zero.
</para>
@ -1388,7 +1388,7 @@ the WM_NAME property for a given window.
<para>
<!-- .LP -->
To set a window's WM_NAME property with the supplied convenience function, use
<function>XSetWMName .</function>
<function>XSetWMName</function>.
<indexterm significance="preferred"><primary>XSetWMName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1448,7 +1448,7 @@ to set the WM_NAME property.
<para>
<!-- .LP -->
To read a window's WM_NAME property with the supplied convenience function, use
<function>XGetWMName .</function>
<function>XGetWMName</function>.
<indexterm significance="preferred"><primary>XGetWMName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1511,7 +1511,7 @@ otherwise, it returns a zero status.
The following two functions have been superseded by
<function>XSetWMName</function>
and
<function>XGetWMName ,</function>
<function>XGetWMName</function>,
respectively.
You can use these additional convenience functions
for window names that are encoded as STRING properties.
@ -1520,7 +1520,7 @@ for window names that are encoded as STRING properties.
<para>
<!-- .LP -->
To assign a name to a window, use
<function>XStoreName .</function>
<function>XStoreName</function>.
<indexterm><primary>Window</primary><secondary>name</secondary></indexterm>
<indexterm significance="preferred"><primary>XStoreName</primary></indexterm>
<!-- .sM -->
@ -1594,7 +1594,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To get the name of a window, use
<function>XFetchName .</function>
<function>XFetchName</function>.
<indexterm significance="preferred"><primary>XFetchName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1657,7 +1657,7 @@ then the returned string is in the Host Portable Character Encoding.
Otherwise, the result is implementation-dependent.
When finished with it, a client must free
the window name string using
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1682,7 +1682,7 @@ the WM_ICON_NAME property for a given window.
<!-- .sp -->
To set a window's WM_ICON_NAME property,
use
<function>XSetWMIconName .</function>
<function>XSetWMIconName</function>.
<indexterm significance="preferred"><primary>XSetWMIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1743,7 +1743,7 @@ to set the WM_ICON_NAME property.
<!-- .LP -->
To read a window's WM_ICON_NAME property,
use
<function>XGetWMIconName .</function>
<function>XGetWMIconName</function>.
<indexterm significance="preferred"><primary>XGetWMIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1806,7 +1806,7 @@ otherwise, it returns a zero status.
The next two functions have been superseded by
<function>XSetWMIconName</function>
and
<function>XGetWMIconName ,</function>
<function>XGetWMIconName</function>,
respectively.
You can use these additional convenience functions
for window names that are encoded as STRING properties.
@ -1816,7 +1816,7 @@ for window names that are encoded as STRING properties.
<!-- .LP -->
<!-- .sp -->
To set the name to be displayed in a window's icon, use
<function>XSetIconName .</function>
<function>XSetIconName</function>.
<indexterm><primary>Window</primary><secondary>icon name</secondary></indexterm>
<indexterm significance="preferred"><primary>XSetIconName</primary></indexterm>
<!-- .sM -->
@ -1879,7 +1879,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To get the name a window wants displayed in its icon, use
<function>XGetIconName .</function>
<function>XGetIconName</function>.
<indexterm significance="preferred"><primary>XGetIconName</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1942,7 +1942,7 @@ then the returned string is in the Host Portable Character Encoding.
Otherwise, the result is implementation-dependent.
When finished with it, a client must free
the icon name string using
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -1973,7 +1973,7 @@ header file.
To allocate an
<function>XWMHints</function>
structure, use
<function>XAllocWMHints .</function>
<function>XAllocWMHints</function>.
</para>
<para>
@ -1996,7 +1996,7 @@ If insufficient memory is available,
returns NULL.
To free the memory allocated to this structure,
use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -2045,25 +2045,25 @@ Applications that expect input but never explicitly set focus to any
of their subwindows (that is, use the push model of focus management),
such as X Version 10 style applications that use real-estate
driven focus, should set this member to
<function>True . </function>
<function>True</function>.
Similarly, applications
that set input focus to their subwindows only when it is given to their
top-level window by a window manager should also set this member to
<function>True .</function>
<function>True</function>.
Applications that manage their own input focus by explicitly setting
focus to one of their subwindows whenever they want keyboard input
(that is, use the pull model of focus management) should set this member to
<function>False .</function>
<function>False</function>.
Applications that never expect any keyboard input also should set this member
to
<function>False .</function>
<function>False</function>.
</para>
<para>
<!-- .LP -->
Pull model window managers should make it possible for push model
applications to get input by setting input focus to the top-level windows of
applications whose input member is
<function>True . </function>
<function>True</function>.
Push model window managers should
make sure that pull model applications do not break them
by resetting input focus to
@ -2114,7 +2114,7 @@ or the window to be withdrawn.
<!-- .LP -->
<!-- .sp -->
To set a window's WM_HINTS property, use
<function>XSetWMHints .</function>
<function>XSetWMHints</function>.
<indexterm significance="preferred"><primary>XSetWMHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2183,7 +2183,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read a window's WM_HINTS property, use
<function>XGetWMHints .</function>
<function>XGetWMHints</function>.
<indexterm significance="preferred"><primary>XGetWMHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2229,7 +2229,7 @@ or returns a pointer to an
structure if it succeeds.
When finished with the data,
free the space used for it by calling
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -2272,7 +2272,7 @@ instances of the structure be used.
To allocate an
<function>XSizeHints</function>
structure, use
<function>XAllocSizeHints .</function>
<function>XAllocSizeHints</function>.
</para>
<para>
@ -2294,7 +2294,7 @@ If insufficient memory is available,
returns NULL.
To free the memory allocated to this structure,
use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -2377,7 +2377,7 @@ macro is highly discouraged.
<para>
<!-- .LP -->
To set a window's WM_NORMAL_HINTS property, use
<function>XSetWMNormalHints .</function>
<function>XSetWMNormalHints</function>.
<indexterm significance="preferred"><primary>XSetWMNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2447,7 +2447,7 @@ errors.
<para>
<!-- .LP -->
To read a window's WM_NORMAL_HINTS property, use
<function>XGetWMNormalHints .</function>
<function>XGetWMNormalHints</function>.
<indexterm significance="preferred"><primary>XGetWMNormalHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2558,7 +2558,7 @@ error.
<para>
<!-- .LP -->
To set a window's WM_SIZE_HINTS property, use
<function>XSetWMSizeHints .</function>
<function>XSetWMSizeHints</function>.
<indexterm significance="preferred"><primary>XSetWMSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2637,8 +2637,8 @@ function.
<!-- .LP -->
<function>XSetWMSizeHints</function>
can generate
<function>BadAlloc ,</function>
<function>BadAtom , </function>
<function>BadAlloc</function>,
<function>BadAtom</function>,
and
<function>BadWindow</function>
errors.
@ -2647,7 +2647,7 @@ errors.
<para>
<!-- .LP -->
To read a window's WM_SIZE_HINTS property, use
<function>XGetWMSizeHints .</function>
<function>XGetWMSizeHints</function>.
<indexterm significance="preferred"><primary>XGetWMSizeHints</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2796,7 +2796,7 @@ header file.
To allocate an
<function>XClassHint</function>
structure, use
<function>XAllocClassHint .</function>
<function>XAllocClassHint</function>.
<indexterm significance="preferred"><primary>XAllocClassHint</primary></indexterm>
<!-- .sM -->
</para>
@ -2821,7 +2821,7 @@ If insufficient memory is available,
returns NULL.
To free the memory allocated to this structure,
use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -2860,7 +2860,7 @@ resource database.
<!-- .LP -->
<!-- .sp -->
To set a window's WM_CLASS property, use
<function>XSetClassHint .</function>
<function>XSetClassHint</function>.
<indexterm significance="preferred"><primary>XSetClassHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2929,7 +2929,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read a window's WM_CLASS property, use
<function>XGetClassHint .</function>
<function>XGetClassHint</function>.
<indexterm significance="preferred"><primary>XGetClassHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3015,7 +3015,7 @@ the WM_TRANSIENT_FOR property for a given window.
<!-- .LP -->
<!-- .sp -->
To set a window's WM_TRANSIENT_FOR property, use
<function>XSetTransientForHint .</function>
<function>XSetTransientForHint</function>.
<indexterm significance="preferred"><primary>XSetTransientForHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3081,7 +3081,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read a window's WM_TRANSIENT_FOR property, use
<function>XGetTransientForHint .</function>
<function>XGetTransientForHint</function>.
<indexterm significance="preferred"><primary>XGetTransientForHint</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3157,7 +3157,7 @@ the WM_PROTOCOLS property for a given window.
<!-- .LP -->
<!-- .sp -->
To set a window's WM_PROTOCOLS property, use
<function>XSetWMProtocols .</function>
<function>XSetWMProtocols</function>.
<indexterm significance="preferred"><primary>XSetWMProtocols</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3244,7 +3244,7 @@ errors.
<para>
<!-- .LP -->
To read a window's WM_PROTOCOLS property, use
<function>XGetWMProtocols .</function>
<function>XGetWMProtocols</function>.
<indexterm significance="preferred"><primary>XGetWMProtocols</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3319,7 +3319,7 @@ and returns a nonzero status.
Otherwise, it sets neither of the return arguments
and returns a zero status.
To release the list of atoms, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -3343,7 +3343,7 @@ the WM_COLORMAP_WINDOWS property for a given window.
<para>
<!-- .LP -->
To set a window's WM_COLORMAP_WINDOWS property, use
<function>XSetWMColormapWindows .</function>
<function>XSetWMColormapWindows</function>.
<indexterm significance="preferred"><primary>XSetWMColormapWindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3430,7 +3430,7 @@ errors.
<para>
<!-- .LP -->
To read a window's WM_COLORMAP_WINDOWS property, use
<function>XGetWMColormapWindows .</function>
<function>XGetWMColormapWindows</function>.
<indexterm significance="preferred"><primary>XGetWMColormapWindows</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3505,7 +3505,7 @@ and returns a nonzero status.
Otherwise, it sets neither of the return arguments
and returns a zero status.
To release the list of window identifiers, use
<function>XFree . </function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -3537,7 +3537,7 @@ header file.
To allocate an
<function>XIconSize</function>
structure, use
<function>XAllocIconSize .</function>
<function>XAllocIconSize</function>.
</para>
<para>
@ -3560,7 +3560,7 @@ If insufficient memory is available,
returns NULL.
To free the memory allocated to this structure,
use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -3592,7 +3592,7 @@ sizes (minimum to maximum) that represent the supported icon sizes.
<!-- .LP -->
<!-- .sp -->
To set a window's WM_ICON_SIZE property, use
<function>XSetIconSizes .</function>
<function>XSetIconSizes</function>.
<indexterm significance="preferred"><primary>XSetIconSizes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3668,7 +3668,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read a window's WM_ICON_SIZE property, use
<function>XGetIconSizes .</function>
<function>XGetIconSizes</function>.
<indexterm significance="preferred"><primary>XGetIconSizes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3741,7 +3741,7 @@ should then use
to supply the window manager with an icon pixmap or window in one of the
supported sizes.
To free the data allocated in size_list_return, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -3912,12 +3912,12 @@ and the properties are created with type ``COMPOUND_TEXT''.
If the normal_hints argument is non-NULL,
<function>XmbSetWMProperties</function>
calls
<function>XSetWMNormalHints ,</function>
<function>XSetWMNormalHints</function>,
which sets the WM_NORMAL_HINTS property (see section 14.1.7).
If the wm_hints argument is non-NULL,
<function>XmbSetWMProperties</function>
calls
<function>XSetWMHints ,</function>
<function>XSetWMHints</function>,
which sets the WM_HINTS property (see section 14.1.6).
</para>
<para>
@ -3980,7 +3980,7 @@ errors.
<!-- .LP -->
To set a window's standard window manager properties
with strings in client-specified encodings, use
<function>XSetWMProperties .</function>
<function>XSetWMProperties</function>.
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.
@ -4115,17 +4115,17 @@ managers).
If the window_name argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetWMName ,</function>
<function>XSetWMName</function>,
which, in turn, sets the WM_NAME property (see section 14.1.4).
If the icon_name argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetWMIconName ,</function>
<function>XSetWMIconName</function>,
which sets the WM_ICON_NAME property (see section 14.1.5).
If the argv argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetCommand ,</function>
<function>XSetCommand</function>,
which sets the WM_COMMAND property (see section 14.2.1).
Note that an argc of zero is allowed to indicate a zero-length command.
Note also that the hostname of this machine is stored using
@ -4137,12 +4137,12 @@ Note also that the hostname of this machine is stored using
If the normal_hints argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetWMNormalHints ,</function>
<function>XSetWMNormalHints</function>,
which sets the WM_NORMAL_HINTS property (see section 14.1.7).
If the wm_hints argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetWMHints ,</function>
<function>XSetWMHints</function>,
which sets the WM_HINTS property (see section 14.1.6).
</para>
<para>
@ -4150,7 +4150,7 @@ which sets the WM_HINTS property (see section 14.1.6).
If the class_hints argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetClassHint ,</function>
<function>XSetClassHint</function>,
which sets the WM_CLASS property (see section 14.1.8).
If the res_name member in the
<function>XClassHint</function>
@ -4209,7 +4209,7 @@ the WM_COMMAND property for a given window.
<para>
<!-- .LP -->
To set a window's WM_COMMAND property, use
<function>XSetCommand .</function>
<function>XSetCommand</function>.
<indexterm significance="preferred"><primary>XSetCommand</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4289,7 +4289,7 @@ errors.
<para>
<!-- .LP -->
To read a window's WM_COMMAND property, use
<function>XGetCommand .</function>
<function>XGetCommand</function>.
<indexterm significance="preferred"><primary>XGetCommand</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4363,7 +4363,7 @@ 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.
To free the memory allocated to the string list, use
<function>XFreeStringList .</function>
<function>XFreeStringList</function>.
</para>
</sect2>
<sect2 id="Setting_and_Reading_the_WM_CLIENT_MACHINE_Property">
@ -4380,7 +4380,7 @@ the WM_CLIENT_MACHINE property for a given window.
<para>
<!-- .LP -->
To set a window's WM_CLIENT_MACHINE property, use
<function>XSetWMClientMachine .</function>
<function>XSetWMClientMachine</function>.
<indexterm significance="preferred"><primary>XSetWMClientMachine</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4440,7 +4440,7 @@ to set the WM_CLIENT_MACHINE property.
<para>
<!-- .LP -->
To read a window's WM_CLIENT_MACHINE property, use
<function>XGetWMClientMachine .</function>
<function>XGetWMClientMachine</function>.
<indexterm significance="preferred"><primary>XGetWMClientMachine</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4607,7 +4607,7 @@ Applications should use the standard colormaps if they already exist.
To allocate an
<function>XStandardColormap</function>
structure, use
<function>XAllocStandardColormap .</function>
<function>XAllocStandardColormap</function>.
</para>
<para>
@ -4629,7 +4629,7 @@ If insufficient memory is available,
returns NULL.
To free the memory allocated to this structure,
use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
@ -4813,7 +4813,7 @@ for text, borders, and so on.
<listitem>
<para>
This atom names a property. The value of the property is an
<function>XStandardColormap .</function>
<function>XStandardColormap</function>.
</para>
<para>
The property defines the best <acronym>RGB</acronym> colormap available on
@ -4843,7 +4843,7 @@ RGB_BEST_MAP is normally an 8/8/8 allocation.
<para>
These atoms name properties.
The value of each property is an
<function>XStandardColormap . </function>
<function>XStandardColormap</function>.
</para>
<para>
The properties define all-red, all-green, and all-blue
@ -4863,7 +4863,7 @@ and once with blue) and by multiply exposing a single frame in a camera.
<para>
This atom names a property.
The value of the property is an
<function>XStandardColormap .</function>
<function>XStandardColormap</function>.
</para>
<para>
The property describes the best
@ -4899,7 +4899,7 @@ structure.
To set an
<function>XStandardColormap</function>
structure, use
<function>XSetRGBColormaps .</function>
<function>XSetRGBColormaps</function>.
<indexterm significance="preferred"><primary>XSetRGBColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -5027,7 +5027,7 @@ Determine the color characteristics of the visual.
<listitem>
<para>
Allocate cells in the colormap (or create it with
<function>AllocAll ).</function>
<function>AllocAll</function>).
</para>
</listitem>
<listitem>
@ -5067,8 +5067,8 @@ Ungrab the server.
<!-- .LP -->
<function>XSetRGBColormaps</function>
can generate
<function>BadAlloc ,</function>
<function>BadAtom ,</function>
<function>BadAlloc</function>,
<function>BadAtom</function>,
and
<function>BadWindow</function>
errors.
@ -5079,7 +5079,7 @@ errors.
To obtain the
<function>XStandardColormap </function>
structure associated with the specified property, use
<function>XGetRGBColormaps .</function>
<function>XGetRGBColormaps</function>.
<indexterm significance="preferred"><primary>XGetRGBColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>

130
specs/libX11/CH15.xml
View file

@ -337,7 +337,7 @@ in many of the resource manager functions.
Simple comparisons can be performed rather than string comparisons.
The shorthand name for a string is called a quark and is the
type
<function>XrmQuark .</function>
<function>XrmQuark</function>.
On some occasions,
you may want to allocate a quark that has no string equivalent.
</para>
@ -350,7 +350,7 @@ but its use is entirely local to your application.
<!-- .LP -->
<!-- .sp -->
To allocate a new quark, use
<function>XrmUniqueQuark .</function>
<function>XrmUniqueQuark</function>.
</para>
<indexterm significance="preferred"><primary>XrmUniqueQuark</primary></indexterm>
<!-- .sM -->
@ -368,7 +368,7 @@ is known to the resource manager.
<!-- .LP -->
<!-- .sp -->
Each name, class, and representation type is typedef'd as an
<function>XrmQuark .</function>
<function>XrmQuark</function>.
</para>
<para>
<!-- .LP -->
@ -402,7 +402,7 @@ typedef XrmQuarkList XrmClassList;
To convert a string to a quark, use
<function>XrmStringToQuark</function>
or
<function>XrmPermStringToQuark .</function>
<function>XrmPermStringToQuark</function>.
</para>
<literallayout class="monospaced">
#define XrmStringToName(string) XrmStringToQuark(string)
@ -444,11 +444,11 @@ The string argument to
need not be permanently allocated storage.
<function>XrmPermStringToQuark</function>
is just like
<function>XrmStringToQuark ,</function>
<function>XrmStringToQuark</function>,
except that Xlib is permitted to assume the string argument is permanently
allocated,
and, hence, that it can be used as the value to be returned by
<function>XrmQuarkToString .</function>
<function>XrmQuarkToString</function>.
</para>
<para>
<!-- .LP -->
@ -461,7 +461,7 @@ all future calls will return the same value (identical address).
<!-- .LP -->
<!-- .sp -->
To convert a quark to a string, use
<function>XrmQuarkToString .</function>
<function>XrmQuarkToString</function>.
</para>
<literallayout class="monospaced">
@ -508,7 +508,7 @@ all future calls will return the same value (identical address).
<!-- .LP -->
<!-- .sp -->
To convert a string with one or more components to a quark list, use
<function>XrmStringToQuarkList .</function>
<function>XrmStringToQuarkList</function>.
</para>
<literallayout class="monospaced">
@ -546,7 +546,7 @@ Specifies the string for which a quark(Ql is to be allocated.
<para>
Returns the list of quarks.
The caller must allocate sufficient space for the quarks list before calling
<function>XrmStringToQuarkList .</function>
<function>XrmStringToQuarkList</function>.
</para>
</listitem>
</varlistentry>
@ -589,7 +589,7 @@ indicates that an asterisk separates the components.
<!-- .sp -->
To convert a string with one or more components to a binding list
and a quark list, use
<function>XrmStringToBindingQuarkList .</function>
<function>XrmStringToBindingQuarkList</function>.
<indexterm significance="preferred"><primary>XrmStringToBindingQuarkList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -621,7 +621,7 @@ Specifies the string for which a quark(Ql is to be allocated.
<para>
Returns the binding list.
The caller must allocate sufficient space for the binding list before calling
<function>XrmStringToBindingQuarkList .</function>
<function>XrmStringToBindingQuarkList</function>.
</para>
</listitem>
</varlistentry>
@ -633,7 +633,7 @@ The caller must allocate sufficient space for the binding list before calling
<para>
Returns the list of quarks.
The caller must allocate sufficient space for the quarks list before calling
<function>XrmStringToBindingQuarkList .</function>
<function>XrmStringToBindingQuarkList</function>.
</para>
</listitem>
</varlistentry>
@ -668,7 +668,7 @@ bindings: loose tight loose
<!-- .LP -->
<indexterm significance="preferred"><primary>XrmDatabase</primary></indexterm>
A resource database is an opaque type,
<function>XrmDatabase .</function>
<function>XrmDatabase</function>.
Each database value is stored in an
<function>XrmValue </function>
structure.
@ -699,7 +699,7 @@ typedef struct {
<!-- .eM -->
<!-- .sp -->
To initialize the resource manager, use
<function>XrmInitialize .</function>
<function>XrmInitialize</function>.
<indexterm significance="preferred"><primary>XrmInitialize</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -714,7 +714,7 @@ To initialize the resource manager, use
<!-- .LP -->
<!-- .eM -->
To retrieve a database from disk, use
<function>XrmGetFileDatabase .</function>
<function>XrmGetFileDatabase</function>.
<indexterm significance="preferred"><primary>XrmGetFileDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -758,7 +758,7 @@ returns NULL.
<!-- .LP -->
<!-- .sp -->
To store a copy of a database to disk, use
<function>XrmPutFileDatabase .</function>
<function>XrmPutFileDatabase</function>.
<indexterm significance="preferred"><primary>XrmPutFileDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -811,7 +811,7 @@ Entries with representation types other than ``String'' are ignored.
<!-- .LP -->
<!-- .sp -->
To obtain a pointer to the screen-independent resources of a display, use
<function>XResourceManagerString .</function>
<function>XResourceManagerString</function>.
<indexterm significance="preferred"><primary>XResourceManagerString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -841,21 +841,21 @@ The
<function>XResourceManagerString</function>
function returns the RESOURCE_MANAGER property from the server's root
window of screen zero, which was returned when the connection was opened using
<function>XOpenDisplay .</function>
<function>XOpenDisplay</function>.
The property is converted from type STRING to the current locale.
The conversion is identical to that produced by
<function>XmbTextPropertyToTextList</function>
for a single element STRING property.
The returned string is owned by Xlib and should not be freed by the client.
The property value must be in a format that is acceptable to
<function>XrmGetStringDatabase .</function>
<function>XrmGetStringDatabase</function>.
If no property exists, NULL is returned.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain a pointer to the screen-specific resources of a screen, use
<function>XScreenResourceString .</function>
<function>XScreenResourceString</function>.
<indexterm significance="preferred"><primary>XScreenResourceString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -890,16 +890,16 @@ The conversion is identical to that produced by
<function>XmbTextPropertyToTextList</function>
for a single element STRING property.
The property value must be in a format that is acceptable to
<function>XrmGetStringDatabase .</function>
<function>XrmGetStringDatabase</function>.
If no property exists, NULL is returned.
The caller is responsible for freeing the returned string by using
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To create a database from a string, use
<function>XrmGetStringDatabase .</function>
<function>XrmGetStringDatabase</function>.
<indexterm significance="preferred"><primary>XrmGetStringDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -944,7 +944,7 @@ and the database is created in the current locale.
<!-- .LP -->
<!-- .sp -->
To obtain the locale name of a database, use
<function>XrmLocaleOfDatabase .</function>
<function>XrmLocaleOfDatabase</function>.
<indexterm significance="preferred"><primary>XrmLocaleOfDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -984,7 +984,7 @@ it will not be modified by Xlib.
<!-- .LP -->
<!-- .sp -->
To destroy a resource database and free its allocated memory, use
<function>XrmDestroyDatabase .</function>
<function>XrmDestroyDatabase</function>.
<indexterm significance="preferred"><primary>XrmDestroyDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1018,7 +1018,7 @@ returns immediately.
<!-- .LP -->
<!-- .sp -->
To associate a resource database with a display, use
<function>XrmSetDatabase .</function>
<function>XrmSetDatabase</function>.
<indexterm significance="preferred"><primary>XrmSetDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1067,7 +1067,7 @@ once it is constructed.
<!-- .LP -->
<!-- .sp -->
To get the resource database associated with a display, use
<function>XrmGetDatabase .</function>
<function>XrmGetDatabase</function>.
<indexterm significance="preferred"><primary>XrmGetDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1107,7 +1107,7 @@ It returns NULL if a database has not yet been set.
<para>
<!-- .LP -->
To merge the contents of a resource file into a database, use
<function>XrmCombineFileDatabase .</function>
<function>XrmCombineFileDatabase</function>.
<indexterm significance="preferred"><primary>XrmCombineFileDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1163,7 +1163,7 @@ If the same specifier is used for an entry in both the file and
the database,
the entry in the file will replace the entry in the database
if override is
<function>True ;</function>
<function>True</function>;
otherwise, the entry in the file is discarded.
The file is parsed in the current locale.
If the file cannot be read,
@ -1181,7 +1181,7 @@ The locale of the target database is not modified.
<!-- .LP -->
<!-- .sp -->
To merge the contents of one database into another database, use
<function>XrmCombineDatabase .</function>
<function>XrmCombineDatabase</function>.
<indexterm significance="preferred"><primary>XrmCombineDatabase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1235,7 +1235,7 @@ function merges the contents of one database into another.
If the same specifier is used for an entry in both databases,
the entry in the source_db will replace the entry in the target_db
if override is
<function>True ;</function>
<function>True</function>;
otherwise, the entry in source_db is discarded.
If target_db contains NULL,
<function>XrmCombineDatabase</function>
@ -1251,7 +1251,7 @@ The locale of the target database is not modified.
<!-- .sp -->
To merge the contents of one database into another database with override
semantics, use
<function>XrmMergeDatabases .</function>
<function>XrmMergeDatabases</function>.
<indexterm significance="preferred"><primary>XrmMergeDatabases</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1293,7 +1293,7 @@ Calling the
function is equivalent to calling the
<function>XrmCombineDatabase</function>
function with an override argument of
<function>True .</function>
<function>True</function>.
</para>
</sect1>
<sect1 id="Looking_Up_Resources">
@ -1304,10 +1304,10 @@ function with an override argument of
<para>
<!-- .LP -->
To retrieve a resource from a resource database, use
<function>XrmGetResource ,</function>
<function>XrmQGetResource ,</function>
<function>XrmGetResource</function>,
<function>XrmQGetResource</function>,
or
<function>XrmQGetSearchResource .</function>
<function>XrmQGetSearchResource</function>.
</para>
<para>
<!-- .LP -->
@ -1465,10 +1465,10 @@ therefore, you must not modify the data.
<para>
<!-- .LP -->
The database only frees or overwrites entries on
<function>XrmPutResource , </function>
<function>XrmQPutResource ,</function>
<function>XrmPutResource</function>,
<function>XrmQPutResource</function>,
or
<function>XrmMergeDatabases .</function>
<function>XrmMergeDatabases</function>.
A client that is not storing new values into the database or
is not merging the database should be safe using the address passed
back at any time until it exits.
@ -1477,9 +1477,9 @@ If a resource was found, both
and
<function>XrmQGetResource </function>
return
<function>True ;</function>
<function>True</function>;
otherwise, they return
<function>False .</function>
<function>False</function>.
</para>
<para>
<!-- .LP -->
@ -1503,7 +1503,7 @@ of database levels that might match the first part of a name/class list.
<!-- .LP -->
<!-- .sp -->
To obtain a list of database levels, use
<function>XrmQGetSearchList .</function>
<function>XrmQGetSearchList</function>.
<indexterm significance="preferred"><primary>XrmQGetSearchList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1556,7 +1556,7 @@ Specifies a list of resource classes.
<para>
Returns a search list for further use.
The caller must allocate sufficient space for the list before calling
<function>XrmQGetSearchList .</function>
<function>XrmQGetSearchList</function>.
</para>
</listitem>
</varlistentry>
@ -1586,9 +1586,9 @@ for determining precedence.
If list_return was large enough for the search list,
<function>XrmQGetSearchList</function>
returns
<function>True ;</function>
<function>True</function>;
otherwise, it returns
<function>False .</function>
<function>False</function>.
</para>
<para>
<!-- .LP -->
@ -1604,13 +1604,13 @@ When using
<function>XrmQGetSearchList </function>
followed by multiple probes for resources with a common name and class prefix,
only the common prefix should be specified in the name and class list to
<function>XrmQGetSearchList .</function>
<function>XrmQGetSearchList</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To search resource database levels for a given resource, use
<function>XrmQGetSearchResource .</function>
<function>XrmQGetSearchResource</function>.
<indexterm significance="preferred"><primary>XrmQGetSearchResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1632,7 +1632,7 @@ To search resource database levels for a given resource, use
<listitem>
<para>
Specifies the search list returned by
<function>XrmQGetSearchList .</function>
<function>XrmQGetSearchList</function>.
</para>
</listitem>
</varlistentry>
@ -1691,7 +1691,7 @@ returns
<function>True </function>
if the resource was found;
otherwise, it returns
<function>False .</function>
<function>False</function>.
</para>
<para>
<!-- .LP -->
@ -1717,7 +1717,7 @@ with the fully qualified name and class.
To store resources into the database, use
<function>XrmPutResource </function>
or
<function>XrmQPutResource .</function>
<function>XrmQPutResource</function>.
Both functions take a partial resource specification, a
representation type, and a value.
This value is copied into the specified database.
@ -1884,7 +1884,7 @@ The value is stored in the database without modification.
<!-- .LP -->
<!-- .sp -->
To add a resource that is specified as a string, use
<function>XrmPutStringResource .</function>
<function>XrmPutStringResource</function>.
<indexterm significance="preferred"><primary>XrmPutStringResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1941,7 +1941,7 @@ adds a resource with the specified value to the specified database.
is a convenience function that first calls
<function>XrmStringToBindingQuarkList</function>
on the specifier and then calls
<function>XrmQPutResource ,</function>
<function>XrmQPutResource</function>,
using a ``String'' representation type.
If the specifier is not in the Host Portable Character Encoding,
the result is implementation-dependent.
@ -1951,7 +1951,7 @@ The value is stored in the database without modification.
<!-- .LP -->
<!-- .sp -->
To add a string resource using quarks as a specification, use
<function>XrmQPutStringResource .</function>
<function>XrmQPutStringResource</function>.
<indexterm significance="preferred"><primary>XrmQPutStringResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2020,7 +2020,7 @@ for the value string (by calling
<function>strlen</function>
to compute the size) and
then calls
<function>XrmQPutResource ,</function>
<function>XrmQPutResource</function>,
using a ``String'' representation type.
The value is stored in the database without modification.
</para>
@ -2029,7 +2029,7 @@ The value is stored in the database without modification.
<!-- .sp -->
To add a single resource entry that is specified as a string that contains
both a name and a value, use
<function>XrmPutLineResource .</function>
<function>XrmPutLineResource</function>.
<indexterm significance="preferred"><primary>XrmPutLineResource</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2091,7 +2091,7 @@ Note that comment lines are not stored.
<para>
<!-- .LP -->
To enumerate the entries of a database, use
<function>XrmEnumerateDatabase .</function>
<function>XrmEnumerateDatabase</function>.
<indexterm significance="preferred"><primary>XrmEnumerateDatabase</primary></indexterm>
<!-- .sM -->
</para>
@ -2185,20 +2185,20 @@ function calls the specified procedure for each resource in the database
that would match some completion of the given name/class resource prefix.
The order in which resources are found is implementation-dependent.
If mode is
<function>XrmEnumOneLevel ,</function>
<function>XrmEnumOneLevel</function>,
a resource must match the given name/class prefix with
just a single name and class appended. If mode is
<function>XrmEnumAllLevels ,</function>
<function>XrmEnumAllLevels</function>,
the resource must match the given name/class prefix with one or more names and
classes appended.
If the procedure returns
<function>True ,</function>
<function>True</function>,
the enumeration terminates and the function returns
<function>True . </function>
<function>True</function>.
If the procedure always returns
<function>False ,</function>
<function>False</function>,
all matching resources are enumerated and the function returns
<function>False .</function>
<function>False</function>.
</para>
<para>
<!-- .LP -->
@ -2223,7 +2223,7 @@ The procedure is called with the following arguments:
<para>
<!-- .LP -->
The bindings and quarks lists are terminated by
<function>NULLQUARK .</function>
<function>NULLQUARK</function>.
Note that pointers
to the database and type are passed, but these values should not be modified.
</para>
@ -2302,7 +2302,7 @@ typedef struct {
<!-- .eM -->
<!-- .sp -->
To load a resource database from a C command line, use
<function>XrmParseCommand .</function>
<function>XrmParseCommand</function>.
<indexterm significance="preferred"><primary>XrmParseCommand</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2404,7 +2404,7 @@ in the order they occur in argv.
The table entries contain information on the option string,
the option name, the style of option,
and a value to provide if the option kind is
<function>XrmoptionNoArg .</function>
<function>XrmoptionNoArg</function>.
The option names are compared byte-for-byte to arguments in argv,
independent of any locale.
The resource values given in the table are stored in the resource database

208
specs/libX11/CH16.xml
View file

@ -94,7 +94,7 @@ use the functions described in section 12.7.
<!-- .LP -->
<!-- .sp -->
To obtain a KeySym for the KeyCode of an event, use
<function>XLookupKeysym .</function>
<function>XLookupKeysym</function>.
<indexterm significance="preferred"><primary>XLookupKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -146,13 +146,13 @@ structure.
If no KeySym is defined for the KeyCode of the event,
<function>XLookupKeysym</function>
returns
<function>NoSymbol .</function>
<function>NoSymbol</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain a KeySym for a specific KeyCode, use
<function>XKeycodeToKeysym .</function>
<function>XKeycodeToKeysym</function>.
<indexterm significance="preferred"><primary>XKeycodeToKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -208,13 +208,13 @@ the element of the KeyCode vector.
If no symbol is defined,
<function>XKeycodeToKeysym</function>
returns
<function>NoSymbol .</function>
<function>NoSymbol</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain a KeyCode for a key having a specific KeySym, use
<function>XKeysymToKeycode .</function>
<function>XKeysymToKeycode</function>.
<indexterm significance="preferred"><primary>XKeysymToKeycode</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -262,7 +262,7 @@ The mapping between KeyCodes and KeySyms is cached internal to Xlib.
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>
<function>XRefreshKeyboardMapping</function>.
<indexterm significance="preferred"><primary>XRefreshKeyboardMapping</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -304,7 +304,7 @@ The result is to update Xlib's knowledge of the keyboard.
<!-- .LP -->
<!-- .sp -->
To obtain the uppercase and lowercase forms of a KeySym, use
<function>XConvertCase .</function>
<function>XConvertCase</function>.
<indexterm significance="preferred"><primary>XConvertCase</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -367,7 +367,7 @@ implementation-dependent.
<!-- .sp -->
KeySyms have string names as well as numeric codes.
To convert the name of the KeySym to the KeySym code, use
<function>XStringToKeysym .</function>
<function>XStringToKeysym</function>.
<indexterm significance="preferred"><primary>XStringToKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -408,13 +408,13 @@ the result is implementation-dependent.
If the specified string does not match a valid KeySym,
<function>XStringToKeysym</function>
returns
<function>NoSymbol .</function>
<function>NoSymbol</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To convert a KeySym code to the name of the KeySym, use
<function>XKeysymToString .</function>
<function>XKeysymToString</function>.
<indexterm significance="preferred"><primary>XKeysymToString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -662,7 +662,7 @@ described in chapter 13 and does not depend on the current locale.
<!-- .LP -->
<!-- .sp -->
To map a key event to an ISO Latin-1 string, use
<function>XLookupString .</function>
<function>XLookupString</function>.
<indexterm significance="preferred"><primary>XLookupString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -687,7 +687,7 @@ Specifies the key event structure to be used.
You can pass
<function>XKeyPressedEvent</function>
or
<function>XKeyReleasedEvent .</function>
<function>XKeyReleasedEvent</function>.
</para>
</listitem>
</varlistentry>
@ -743,11 +743,11 @@ The
<function>XLookupString</function>
function translates a key event to a KeySym and a string.
The KeySym is obtained by using the standard interpretation of the
<function>Shift ,</function>
<function>Lock ,</function>
<function>Shift</function>,
<function>Lock</function>,
group, and numlock modifiers as defined in the X Protocol specification.
If the KeySym has been rebound (see
<function>XRebindKeysym ),</function>
<function>XRebindKeysym</function>),
the bound string will be stored in the buffer.
Otherwise, the KeySym is mapped, if possible, to an ISO Latin-1 character
or (if the Control modifier is on) to an ASCII control character,
@ -782,9 +782,9 @@ to keep this information up-to-date.
<!-- .LP -->
<!-- .sp -->
To rebind the meaning of a KeySym for
<function>XLookupString ,</function>
<function>XLookupString</function>,
use
<function>XRebindKeysym .</function>
<function>XRebindKeysym</function>.
<indexterm significance="preferred"><primary>XRebindKeysym</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -848,7 +848,7 @@ Specifies the number of modifiers in the modifier list.
<listitem>
<para>
Specifies the string that is copied and will be returned by
<function>XLookupString .</function>
<function>XLookupString</function>.
</para>
</listitem>
</varlistentry>
@ -889,7 +889,7 @@ Note that you can rebind a KeySym that may not exist.
<para>
<!-- .LP -->
To allocate some memory you will never give back, use
<function>Xpermalloc .</function>
<function>Xpermalloc</function>.
<indexterm significance="preferred"><primary>Xpermalloc</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -919,7 +919,7 @@ the standard operating system memory allocator.
<para>
<!-- .LP -->
To parse standard window geometry strings, use
<function>XParseGeometry .</function>
<function>XParseGeometry</function>.
<indexterm><primary>Window</primary><secondary>determining location</secondary></indexterm>
<indexterm significance="preferred"><primary>XParseGeometry</primary></indexterm>
</para>
@ -1029,11 +1029,11 @@ be able to say ``position the window relative to the right or bottom edge.''
For each value found, the corresponding argument is updated.
For each value not found, the argument is left unchanged.
The bits are represented by
<function>XValue , </function>
<function>YValue , </function>
<function>WidthValue , </function>
<function>HeightValue ,</function>
<function>XNegative , </function>
<function>XValue</function>,
<function>YValue</function>,
<function>WidthValue</function>,
<function>HeightValue</function>,
<function>XNegative</function>,
or
<function>YNegative</function>
and are defined in
@ -1054,7 +1054,7 @@ you should place the window at the requested position.
<para>
<!-- .LP -->
To construct a window's geometry information, use
<function>XWMGeometry .</function>
<function>XWMGeometry</function>.
<indexterm significance="preferred"><primary>XWMGeometry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1194,15 +1194,15 @@ Returns the window gravity.
The
<function>XWMGeometry </function>
function combines any geometry information (given in the format used by
<function>XParseGeometry )</function>
<function>XParseGeometry</function>)
specified by the user and by the calling program with size hints
(usually the ones to be stored in WM_NORMAL_HINTS) and returns the position,
size, and gravity
<function>( NorthWestGravity , </function>
<function>NorthEastGravity , </function>
<function>SouthEastGravity ,</function>
(<function>NorthWestGravity</function>,
<function>NorthEastGravity</function>,
<function>SouthEastGravity</function>,
or
<function>SouthWestGravity ) </function>
<function>SouthWestGravity</function>)
that describe the window.
If the base size is not set in the
<function>XSizeHints</function>
@ -1212,7 +1212,7 @@ Otherwise, a base size of zero is assumed.
If no minimum size is set in the hints structure,
the base size is used.
A mask (in the form returned by
<function>XParseGeometry ) </function>
<function>XParseGeometry</function>)
that describes which values came from the user specification
and whether or not the position coordinates are relative
to the right and bottom edges is returned.
@ -1280,7 +1280,7 @@ Locate a point or rectangle in a region
<para>
<!-- .LP -->
To create a new empty region, use
<function>XCreateRegion .</function>
<function>XCreateRegion</function>.
</para>
<para>Region XCreateRegion()</para>
@ -1289,7 +1289,7 @@ To create a new empty region, use
<!-- .eM -->
<!-- .sp -->
To generate a region from a polygon, use
<function>XPolygonRegion .</function>
<function>XPolygonRegion</function>.
</para>
<indexterm significance="preferred"><primary>XPolygonRegion</primary></indexterm>
<!-- .sM -->
@ -1333,7 +1333,7 @@ Specifies the fill-rule you want to set for the specified GC.
You can pass
<function>EvenOddRule</function>
or
<function>WindingRule .</function>
<function>WindingRule</function>.
</para>
</listitem>
</varlistentry>
@ -1347,13 +1347,13 @@ The
function returns a region for the polygon defined by the points array.
For an explanation of fill_rule,
see
<function>XCreateGC .</function>
<function>XCreateGC</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To set the clip-mask of a GC to a region, use
<function>XSetRegion .</function>
<function>XSetRegion</function>.
<indexterm significance="preferred"><primary>XSetRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1413,7 +1413,7 @@ the region can be destroyed.
<!-- .LP -->
<!-- .sp -->
To deallocate the storage associated with a specified region, use
<function>XDestroyRegion .</function>
<function>XDestroyRegion</function>.
<indexterm significance="preferred"><primary>XDestroyRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1449,7 +1449,7 @@ Specifies the region.
<para>
<!-- .LP -->
To move a region by a specified amount, use
<function>XOffsetRegion .</function>
<function>XOffsetRegion</function>.
<indexterm significance="preferred"><primary>XOffsetRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1501,7 +1501,7 @@ which define the amount you want to (Dy the specified region.
<!-- .eM -->
<!-- .sp -->
To reduce a region by a specified amount, use
<function>XShrinkRegion .</function>
<function>XShrinkRegion</function>.
<indexterm significance="preferred"><primary>XShrinkRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1564,7 +1564,7 @@ and negative values expand the region.
<!-- .LP -->
<!-- .sp -->
To generate the smallest rectangle enclosing a region, use
<function>XClipBox .</function>
<function>XClipBox</function>.
<indexterm significance="preferred"><primary>XClipBox</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1609,7 +1609,7 @@ function returns the smallest rectangle enclosing the specified region.
<para>
<!-- .LP -->
To compute the intersection of two regions, use
<function>XIntersectRegion .</function>
<function>XIntersectRegion</function>.
<indexterm significance="preferred"><primary>XIntersectRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1658,7 +1658,7 @@ Returns the result of the computation.
<!-- .eM -->
<!-- .sp -->
To compute the union of two regions, use
<function>XUnionRegion .</function>
<function>XUnionRegion</function>.
<indexterm significance="preferred"><primary>XUnionRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1707,7 +1707,7 @@ Returns the result of the computation.
<!-- .eM -->
<!-- .sp -->
To create a union of a source region and a rectangle, use
<function>XUnionRectWithRegion .</function>
<function>XUnionRectWithRegion</function>.
<indexterm significance="preferred"><primary>XUnionRectWithRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1764,7 +1764,7 @@ and the specified source region.
<!-- .LP -->
<!-- .sp -->
To subtract two regions, use
<function>XSubtractRegion .</function>
<function>XSubtractRegion</function>.
<indexterm significance="preferred"><primary>XSubtractRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1820,7 +1820,7 @@ function subtracts srb from sra and stores the results in dr_return.
<!-- .sp -->
To calculate the difference between the union and intersection
of two regions, use
<function>XXorRegion .</function>
<function>XXorRegion</function>.
<indexterm significance="preferred"><primary>XXorRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1877,7 +1877,7 @@ Returns the result of the computation.
<para>
<!-- .LP -->
To determine if the specified region is empty, use
<function>XEmptyRegion .</function>
<function>XEmptyRegion</function>.
<indexterm significance="preferred"><primary>XEmptyRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1913,7 +1913,7 @@ if the region is empty.
<!-- .LP -->
<!-- .sp -->
To determine if two regions have the same offset, size, and shape, use
<function>XEqualRegion .</function>
<function>XEqualRegion</function>.
<indexterm significance="preferred"><primary>XEqualRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -1965,7 +1965,7 @@ if the two regions have the same offset, size, and shape.
<para>
<!-- .LP -->
To determine if a specified point resides in a specified region, use
<function>XPointInRegion .</function>
<function>XPointInRegion</function>.
<indexterm significance="preferred"><primary>XPointInRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2024,7 +2024,7 @@ if the point (x, y) is contained in the region r.
<!-- .LP -->
<!-- .sp -->
To determine if a specified rectangle is inside a region, use
<function>XRectInRegion .</function>
<function>XRectInRegion</function>.
<indexterm significance="preferred"><primary>XRectInRegion</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2136,7 +2136,7 @@ and can be accessed as a ring or as explicit buffers (numbered 0 through 7).
<!-- .LP -->
<!-- .sp -->
To store data in cut buffer 0, use
<function>XStoreBytes .</function>
<function>XStoreBytes</function>.
<indexterm significance="preferred"><primary>XStoreBytes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2188,7 +2188,7 @@ The data can have embedded null characters
and need not be null-terminated.
The cut buffer's contents can be retrieved later by
any client calling
<function>XFetchBytes .</function>
<function>XFetchBytes</function>.
</para>
<para>
<!-- .LP -->
@ -2201,7 +2201,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To store data in a specified cut buffer, use
<function>XStoreBuffer .</function>
<function>XStoreBuffer</function>.
<indexterm significance="preferred"><primary>XStoreBuffer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2276,7 +2276,7 @@ error.
<!-- .LP -->
<!-- .sp -->
To return data from cut buffer 0, use
<function>XFetchBytes .</function>
<function>XFetchBytes</function>.
<indexterm significance="preferred"><primary>XFetchBytes</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2322,13 +2322,13 @@ Otherwise, the function
returns NULL and sets nbytes to 0.
The appropriate amount of storage is allocated and the pointer returned.
The client must free this storage when finished with it by calling
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To return data from a specified cut buffer, use
<function>XFetchBuffer .</function>
<function>XFetchBuffer</function>.
<indexterm significance="preferred"><primary>XFetchBuffer</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2387,7 +2387,7 @@ buffer is specified.
<!-- .LP -->
<!-- .sp -->
To rotate the cut buffers, use
<function>XRotateBuffers .</function>
<function>XRotateBuffers</function>.
<indexterm significance="preferred"><primary>XRotateBuffers</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2504,7 +2504,7 @@ typedef struct {
<!-- .eM -->
To obtain a list of visual information structures that match a specified
template, use
<function>XGetVisualInfo .</function>
<function>XGetVisualInfo</function>.
<indexterm significance="preferred"><primary>XGetVisualInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2572,14 +2572,14 @@ If no visual structures match the template using the specified vinfo_mask,
<function>XGetVisualInfo</function>
returns a NULL.
To free the data returned by this function, use
<function>XFree .</function>
<function>XFree</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain the visual information that matches the specified depth and
class of the screen, use
<function>XMatchVisualInfo .</function>
<function>XMatchVisualInfo</function>.
<indexterm significance="preferred"><primary>XMatchVisualInfo</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2691,7 +2691,7 @@ images.
The basic operations for getting and putting images are
<function>XGetImage</function>
and
<function>XPutImage .</function>
<function>XPutImage</function>.
</para>
<para>
<!-- .LP -->
@ -2726,7 +2726,7 @@ see section 8.7.
To allocate an
<function>XImage </function>
structure and initialize it with image format values from a display, use
<function>XCreateImage .</function>
<function>XCreateImage</function>.
<indexterm significance="preferred"><primary>XCreateImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2786,10 +2786,10 @@ Specifies the depth of the image.
<para>
Specifies the format for the image.
You can pass
<function>XYBitmap ,</function>
<function>XYPixmap ,</function>
<function>XYBitmap</function>,
<function>XYPixmap</function>,
or
<function>ZPixmap .</function>
<function>ZPixmap</function>.
</para>
</listitem>
</varlistentry>
@ -2885,10 +2885,10 @@ in memory and calculates the value of bytes_per_line itself.
<para>
<!-- .LP -->
Note that when the image is created using
<function>XCreateImage ,</function>
<function>XGetImage ,</function>
<function>XCreateImage</function>,
<function>XGetImage</function>,
or
<function>XSubImage ,</function>
<function>XSubImage</function>,
the destroy procedure that the
<function>XDestroyImage</function>
function calls frees both the image structure
@ -2906,7 +2906,7 @@ in the image object and are defined in
<!-- .LP -->
<!-- .sp -->
To obtain a pixel value in an image, use
<function>XGetPixel .</function>
<function>XGetPixel</function>.
<indexterm significance="preferred"><primary>XGetPixel</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -2967,7 +2967,7 @@ The image must contain the x and y coordinates.
<!-- .LP -->
<!-- .sp -->
To set a pixel value in an image, use
<function>XPutPixel .</function>
<function>XPutPixel</function>.
<indexterm significance="preferred"><primary>XPutPixel</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3039,7 +3039,7 @@ The image must contain the x and y coordinates.
<!-- .LP -->
<!-- .sp -->
To create a subimage, use
<function>XSubImage .</function>
<function>XSubImage</function>.
<indexterm significance="preferred"><primary>XSubImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3125,7 +3125,7 @@ and subimage_height.
<!-- .LP -->
<!-- .sp -->
To increment each pixel in an image by a constant value, use
<function>XAddPixel .</function>
<function>XAddPixel</function>.
<indexterm significance="preferred"><primary>XAddPixel</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3172,9 +3172,9 @@ color resources and need to manipulate the image to that form.
<!-- .LP -->
<!-- .sp -->
To deallocate the memory allocated in a previous call to
<function>XCreateImage ,</function>
<function>XCreateImage</function>,
use
<function>XDestroyImage .</function>
<function>XDestroyImage</function>.
<indexterm significance="preferred"><primary>XDestroyImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3209,10 +3209,10 @@ structure.
<para>
<!-- .LP -->
Note that when the image is created using
<function>XCreateImage ,</function>
<function>XGetImage ,</function>
<function>XCreateImage</function>,
<function>XGetImage</function>,
or
<function>XSubImage ,</function>
<function>XSubImage</function>,
the destroy procedure that this macro calls
frees both the image structure and the data pointed to by the image structure.
</para>
@ -3261,7 +3261,7 @@ The bitmap unit is 8.
<!-- .LP -->
<!-- .sp -->
To read a bitmap from a file and store it in a pixmap, use
<function>XReadBitmapFile .</function>
<function>XReadBitmapFile</function>.
<indexterm significance="preferred"><primary>XReadBitmapFile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3375,16 +3375,16 @@ is implementation-dependent.
If the file cannot be opened,
<function>XReadBitmapFile </function>
returns
<function>BitmapOpenFailed . </function>
<function>BitmapOpenFailed</function>.
If the file can be opened but does not contain valid bitmap data,
it returns
<function>BitmapFileInvalid . </function>
<function>BitmapFileInvalid</function>.
If insufficient working storage is allocated,
it returns
<function>BitmapNoMemory . </function>
<function>BitmapNoMemory</function>.
If the file is readable and valid,
it returns
<function>BitmapSuccess .</function>
<function>BitmapSuccess</function>.
</para>
<para>
<!-- .LP -->
@ -3406,8 +3406,8 @@ otherwise, it returns \-1,\-1.
<!-- .LP -->
<function>XReadBitmapFile</function>
can generate
<function>BadAlloc ,</function>
<function>BadDrawable ,</function>
<function>BadAlloc</function>,
<function>BadDrawable</function>,
and
<function>BadGC</function>
errors.
@ -3416,7 +3416,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To read a bitmap from a file and return it as data, use
<function>XReadBitmapFileData .</function>
<function>XReadBitmapFileData</function>.
<indexterm significance="preferred"><primary>XReadBitmapFileData</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3501,19 +3501,19 @@ Return the hotspot coordinates.
The
<function>XReadBitmapFileData</function>
function reads in a file containing a bitmap, in the same manner as
<function>XReadBitmapFile ,</function>
<function>XReadBitmapFile</function>,
but returns the data directly rather than creating a pixmap in the server.
The bitmap data is returned in data_return; the client must free this
storage when finished with it by calling
<function>XFree .</function>
<function>XFree</function>.
The status and other return values are the same as for
<function>XReadBitmapFile .</function>
<function>XReadBitmapFile</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To write out a bitmap from a pixmap to a file, use
<function>XWriteBitmapFile .</function>
<function>XWriteBitmapFile</function>.
<indexterm significance="preferred"><primary>XWriteBitmapFile</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3615,14 +3615,14 @@ by deleting the directory prefix.
The file is written in the encoding of the current locale.
If the file cannot be opened for writing,
it returns
<function>BitmapOpenFailed . </function>
<function>BitmapOpenFailed</function>.
If insufficient memory is allocated,
<function>XWriteBitmapFile</function>
returns
<function>BitmapNoMemory ;</function>
<function>BitmapNoMemory</function>;
otherwise, on no error,
it returns
<function>BitmapSuccess .</function>
<function>BitmapSuccess</function>.
If x_hot and y_hot are not \-1, \-1,
<function>XWriteBitmapFile</function>
writes them out as the hotspot coordinates for the bitmap.
@ -3640,7 +3640,7 @@ errors.
<!-- .LP -->
<!-- .sp -->
To create a pixmap and then store bitmap-format data into it, use
<function>XCreatePixmapFromBitmapData .</function>
<function>XCreatePixmapFromBitmapData</function>.
<indexterm significance="preferred"><primary>XCreatePixmapFromBitmapData</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3758,9 +3758,9 @@ error results.
<!-- .LP -->
<function>XCreatePixmapFromBitmapData</function>
can generate
<function>BadAlloc ,</function>
<function>BadDrawable ,</function>
<function>BadGC ,</function>
<function>BadAlloc</function>,
<function>BadDrawable</function>,
<function>BadGC</function>,
and
<function>BadValue</function>
errors.
@ -3772,7 +3772,7 @@ To include a bitmap written out by
<function>XWriteBitmapFile </function>
<indexterm><primary>XWriteBitmapFile</primary></indexterm>
in a program directly, as opposed to reading it in every time at run time, use
<function>XCreateBitmapFromData .</function>
<function>XCreateBitmapFromData</function>.
<indexterm significance="preferred"><primary>XCreateBitmapFromData</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3846,7 +3846,7 @@ Specify the width and height.
The
<function>XCreateBitmapFromData</function>
function allows you to include in your C program (using
<function>#include )</function>
<function>#include</function>)
a bitmap file that was written out by
<function>XWriteBitmapFile</function>
(X version 11 format only) without reading in the bitmap file.
@ -3866,7 +3866,7 @@ bitmap = XCreateBitmapFromData(display, window, gray_bits, gray_width, gray_heig
If insufficient working storage was allocated,
<function>XCreateBitmapFromData</function>
returns
<function>None .</function>
<function>None</function>.
It is your responsibility to free the
bitmap using
<function>XFreePixmap</function>
@ -3915,7 +3915,7 @@ The symbols used are in
<!-- .LP -->
<!-- .sp -->
To save a data value that corresponds to a resource ID and context type, use
<function>XSaveContext .</function>
<function>XSaveContext</function>.
<indexterm significance="preferred"><primary>XSaveContext</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -3989,7 +3989,7 @@ Possible errors are
<!-- .LP -->
<!-- .sp -->
To get the data associated with a resource ID and type, use
<function>XFindContext .</function>
<function>XFindContext</function>.
<indexterm significance="preferred"><primary>XFindContext</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4062,7 +4062,7 @@ Possible errors are
<!-- .LP -->
<!-- .sp -->
To delete an entry for a given resource ID and type, use
<function>XDeleteContext .</function>
<function>XDeleteContext</function>.
<indexterm significance="preferred"><primary>XDeleteContext</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@ -4126,9 +4126,9 @@ does not free the data whose address was saved.
To create a unique context type that may be used in subsequent calls to
<function>XSaveContext </function>
and
<function>XFindContext ,</function>
<function>XFindContext</function>,
use
<function>XUniqueContext .</function>
<function>XUniqueContext</function>.
</para>
<para>XContext XuniqueContext()</para>

8
specs/libX11/glossary.xml
View file

@ -91,13 +91,13 @@ fields of an <acronym>XLFD</acronym> name identify the charset of the font.
A base font name may be a full <acronym>XLFD</acronym> name, with all fourteen '-' delimiters,
or an abbreviated <acronym>XLFD</acronym> name containing only the first 12 fields of an <acronym>XLFD</acronym> name,
up to but not including
<function>CharSetRegistry ,</function>
<function>CharSetRegistry</function>,
with or without the thirteenth '-', or a non-<acronym>XLFD</acronym> name.
Any <acronym>XLFD</acronym> fields may contain wild cards.
</para>
<para>
When creating an
<function>XFontSet ,</function>
<function>XFontSet</function>,
Xlib accepts from the client a list of one or more base font names
which select one or more font families.
They are combined with charset names obtained from the encoding of the locale
@ -741,7 +741,7 @@ See <function>Bit gravity</function> and <function>Window gravity</function>.
<para>
<function>GrayScale </function>
can be viewed as a degenerate case of
<function>PseudoColor , </function>
<function>PseudoColor</function>,
in which the red, green, and blue values in any given colormap entry
are equal and thus, produce shades of gray.
The gray values can be changed dynamically.
@ -1683,7 +1683,7 @@ always interprets timestamps from clients by treating half
of the timestamp space as being earlier in time than T
and half of the timestamp space as being later in time than T.
One timestamp value, represented by the constant
<function>CurrentTime ,</function>
<function>CurrentTime</function>,
is never generated by the server.
This value is reserved for use in requests to represent the current server time.
<!-- .KE -->