fdo-mirrors/xorg-libx11
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/lib/libx11.git synced 2025-12-20 04:40:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

trim trailing whitespace from manpages

Browse source 
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
This commit is contained in:
Thomas E. Dickey 2019-07-30 04:52:25 -04:00
parent 4abf482d8e
commit 6f2cbcea5d
No known key found for this signature in database
GPG key ID: 702353E0F7E48EDB
185 changed files with 2087 additions and 2077 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
man/AllPlanes.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -49,34 +49,34 @@
.SH NAME
AllPlanes, BlackPixel, WhitePixel, ConnectionNumber, DefaultColormap, DefaultDepth, XListDepths, DefaultGC, DefaultRootWindow, DefaultScreenOfDisplay, DefaultScreen, DefaultVisual, DisplayCells, DisplayPlanes, DisplayString, XMaxRequestSize, XExtendedMaxRequestSize, LastKnownRequestProcessed, NextRequest, ProtocolVersion, ProtocolRevision, QLength, RootWindow, ScreenCount, ScreenOfDisplay, ServerVendor, VendorRelease \- Display macros and functions
.SH SYNTAX
unsigned long AllPlanes;
unsigned long AllPlanes;
.HP
unsigned long BlackPixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
.HP
unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
.HP
int ConnectionNumber\^(\^Display *\fIdisplay\fP\^);
int ConnectionNumber\^(\^Display *\fIdisplay\fP\^);
.HP
Colormap DefaultColormap\^(\^Display *\fIdisplay\fP\^,
\^int \fIscreen_number\fP\^);
\^int \fIscreen_number\fP\^);
.HP
int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
int *XListDepths\^(\^Display *\fIdisplay\fP, int \fIscreen_number\fP, int
\fIcount_return\fP\^);
\fIcount_return\fP\^);
.HP
GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^);
Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^);
.HP
Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^);
Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^);
.HP
int DefaultScreen\^(\^Display *\fIdisplay\fP\^);
int DefaultScreen\^(\^Display *\fIdisplay\fP\^);
.HP
Visual *DefaultVisual\^(\^Display *\fIdisplay\fP\^, \^int
\fIscreen_number\fP\^);
\fIscreen_number\fP\^);
.HP
int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
int DisplayPlanes\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
@ -86,22 +86,22 @@ long XMaxRequestSize(\^Display *\fIdisplay\fP\^)
.HP
long XExtendedMaxRequestSize(\^Display *\fIdisplay\fP\^)
.HP
unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^);
unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^);
.HP
unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^);
unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^);
.HP
int ProtocolVersion\^(\^Display *\fIdisplay\fP\^);
int ProtocolVersion\^(\^Display *\fIdisplay\fP\^);
.HP
int ProtocolRevision\^(\^Display *\fIdisplay\fP\^);
int ProtocolRevision\^(\^Display *\fIdisplay\fP\^);
.HP
int QLength\^(\^Display *\fIdisplay\fP\^);
int QLength\^(\^Display *\fIdisplay\fP\^);
.HP
Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
int ScreenCount\^(\^Display *\fIdisplay\fP\^);
int ScreenCount\^(\^Display *\fIdisplay\fP\^);
.HP
Screen *ScreenOfDisplay\^(\^Display *\fIdisplay\fP, int
\fIscreen_number\fP\^);
\fIscreen_number\fP\^);
.HP
char *ServerVendor\^(\^Display *\fIdisplay\fP\^)
.HP
@ -116,7 +116,7 @@ Returns the number of depths.
.SH DESCRIPTION
The
.B AllPlanes
macro returns a value with all bits set to 1 suitable for use in a plane
macro returns a value with all bits set to 1 suitable for use in a plane
argument to a procedure.
.LP
The
@ -142,7 +142,7 @@ specified screen.
.LP
The
.B XListDepths
function returns the array of depths
function returns the array of depths
that are available on the specified screen.
If the specified screen_number is valid and sufficient memory for the array
can be allocated,
@ -204,7 +204,7 @@ as necessary for the following functions:
.BR XDrawSegments ,
.BR XFillArcs ,
.BR XFillRectangles ,
and
and
.BR XPutImage .
.LP
The
@ -222,7 +222,8 @@ The Xlib functions
and
.B XSetRegion
will use the extended-length encoding as necessary, if supported
by the server. Use of the extended-length encoding in other Xlib
by the server.
Use of the extended-length encoding in other Xlib
functions (for example,
.BR XDrawPoints ,
.BR XDrawRectangles ,

10
man/BlackPixelOfScreen.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -91,7 +91,7 @@ int WidthOfScreen\^(\^Screen *\fIscreen\fP\^);
int WidthMMOfScreen\^(\^Screen *\fIscreen\fP\^);
.SH ARGUMENTS
.IP \fIscreen\fP 1i
Specifies the appropriate
Specifies the appropriate
.B Screen
structure.
.SH DESCRIPTION
@ -127,7 +127,7 @@ macro returns the default visual of the specified screen.
.LP
The
.B DoesBackingStore
macro returns
macro returns
.BR WhenMapped ,
.BR NotUseful ,
or
@ -162,12 +162,12 @@ macro returns the height of the specified screen in millimeters.
.LP
The
.B MaxCmapsOfScreen
macro returns the maximum number of installed colormaps supported
macro returns the maximum number of installed colormaps supported
by the specified screen.
.LP
The
.B MinCmapsOfScreen
macro returns the minimum number of installed colormaps supported
macro returns the minimum number of installed colormaps supported
by the specified screen.
.LP
The

25
man/Compose.man
View file

@ -46,8 +46,10 @@ file from the list in
.PP
Compose files can use an
.RB \*q include \*q
instruction. This allows local modifications to be made to existing compose
files without including all of the content directly. For example, the
instruction.
This allows local modifications to be made to existing compose
files without including all of the content directly.
For example, the
system's iso8859-1 compose file can be included with a line like this:
.RS 4
.BI "include \*q" %S/iso8859-1/Compose \*q
@ -74,12 +76,15 @@ by using:
.RS
.B "include \*q%L\*q"
.RE
and then rewrite only the few rules that you need to change. New
and then rewrite only the few rules that you need to change.
New
compose rules can be added, and previous ones replaced.
.SH FILE FORMAT
.\" Based on grammar description in modules/im/ximcp/imLcPrs.c
Compose files are plain text files, with a separate line for each compose
sequence. Comments begin with \fB#\fP characters. Each compose sequence
sequence.
Comments begin with \fB#\fP characters.
Each compose sequence
specifies one or more events and a resulting input sequence, with an optional
comment at the end of the line:
.RS
@ -97,7 +102,8 @@ it must match exactly.
MODIFIER may be one of Ctrl, Lock, Caps, Shift, Alt or Meta.
Each modifier may be preceded by a
.RB \*q "~" \*q
character to indicate that the modifier must not be present. If
character to indicate that the modifier must not be present.
If
.RB \*q "None" \*q
is specified, no modifier may be present.
.PP
@ -110,18 +116,21 @@ as input when the sequence of events is input:
Keysyms are specified without the \fBXK_\fP prefix.
.PP
Strings may be direct text encoded in the locale for which the compose file is
to be used, or an escaped octal or hexadecimal character code. Octal codes
to be used, or an escaped octal or hexadecimal character code.
Octal codes
are specified as \fB\*q\\123\*q\fP and hexadecimal codes as
\fB\*q\\x3a\*q\fP.
It is not necessary to specify in the right part of a rule a locale encoded
string in addition to the keysym name. If the string is omitted, Xlib
string in addition to the keysym name.
If the string is omitted, Xlib
figures it out from the keysym according to the current locale.
I.e., if a rule looks like:
.RS
\fB<dead_grave> <A> : \*q\\300\*q Agrave\fP
.RE
the result of the composition is always the letter with the "\\300"
code. But if the rule is:
code.
But if the rule is:
.RS
\fB<dead_grave> <A> : Agrave\fP
.RE

12
man/DisplayOfCCC.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,15 +50,15 @@
DisplayOfCCC, VisualOfCCC, ScreenNumberOfCCC, ScreenWhitePointOfCCC, ClientWhitePointOfCCC \- Color Conversion Context macros
.SH SYNTAX
.HP
Display *DisplayOfCCC\^(\^XcmsCCC \fIccc\fP\^);
Display *DisplayOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
Visual *VisualOfCCC\^(\^XcmsCCC \fIccc\fP\^);
Visual *VisualOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
int ScreenNumberOfCCC\^(\^XcmsCCC \fIccc\fP\^);
int ScreenNumberOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
XcmsColor *ScreenWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
XcmsColor *ScreenWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.SH ARGUMENTS
.IP \fIccc\fP 1i
Specifies the CCC.

4
man/ImageByteOrder.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -96,7 +96,7 @@ XY format (bitmap) or for each pixel value in Z format.
.LP
The
.B BitmapBitOrder
macro returns
macro returns
.B LSBFirst
or
.B MSBFirst

6
man/IsCursorKey.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -68,13 +68,13 @@ Specifies the KeySym that is to be tested.
.SH DESCRIPTION
The
.B IsCursorKey
macro returns
macro returns
.B True
if the specified KeySym is a cursor key.
.LP
The
.B IsFunctionKey
macro returns
macro returns
.B True
if the KeySym is a function key.
.LP

10
man/XAddConnectionWatch.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,18 +52,18 @@ XAddConnectionWatch, XRemoveConnectionWatch, XProcessInternalConnection, XIntern
.HP
typedef void (*XConnectionWatchProc)\^(\^Display *\fIdisplay\fP\^, XPointer
\fIclient_data\fP\^, int \fIfd\fP\^, Bool \fIopening\fP\^, XPointer
*\fIwatch_data\fP\^);
*\fIwatch_data\fP\^);
.HP
Status XAddConnectionWatch\^(\^Display *\fIdisplay\fP\^, XWatchProc
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
.HP
Status XRemoveConnectionWatch\^(\^Display *\fIdisplay\fP\^, XWatchProc
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
.HP
void XProcessInternalConnection\^(\^Display *\fIdisplay\fP\^, int \fIfd\fP\^);
.HP
Status XInternalConnectionNumbers\^(\^Display *\fIdisplay\fP\^, int
**\fIfd_return\fP\^, int *\fIcount_return\fP\^);
**\fIfd_return\fP\^, int *\fIcount_return\fP\^);
.SH ARGUMENTS
.IP \fIclient_data\fP 1i
Specifies the additional client data.

34
man/XAddHost.man
View file

@ -1,7 +1,7 @@
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
.\"
.\" All rights reserved.
.\"
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
@ -11,7 +11,7 @@
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\"
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
@ -21,12 +21,12 @@
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\"
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.\"
.\" X Window System is a trademark of The Open Group.
.\"
.\" Copyright 2004 Oracle and/or its affiliates. All rights reserved.
@ -65,7 +65,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -76,9 +76,9 @@
XAddHost, XAddHosts, XListHosts, XRemoveHost, XRemoveHosts, XSetAccessControl, XEnableAccessControl, XDisableAccessControl, XHostAddress, XServerInterpretedAddress \- control host access and host control structure
.SH SYNTAX
.HP
int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
.HP
int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP,
int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP,
int \fInum_hosts\fP\^);
.HP
XHostAddress *XListHosts\^(\^Display *\fIdisplay\fP, int *\fInhosts_return\fP,
@ -143,19 +143,19 @@ errors.
.LP
The
.B XListHosts
function returns the current access control list as well as whether the use
function returns the current access control list as well as whether the use
of the list at connection setup was enabled or disabled.
.B XListHosts
allows a program to find out what machines can make connections.
It also returns a pointer to a list of host structures that
were allocated by the function.
were allocated by the function.
When no longer needed,
this memory should be freed by calling
.BR XFree .
.LP
The
.B XRemoveHost
function removes the specified host from the access control list
function removes the specified host from the access control list
for that display.
The server must be on the same host as the client process, or a
.B BadAccess
@ -173,12 +173,12 @@ errors.
.LP
The
.B XRemoveHosts
function removes each specified host from the access control list for that
display.
function removes each specified host from the access control list for that
display.
The X server must be on the same host as the client process, or a
.B BadAccess
error results.
If you remove your machine from the access list,
If you remove your machine from the access list,
you can no longer connect to that server,
and this operation cannot be reversed unless you reset the server.
.LP
@ -191,7 +191,7 @@ errors.
.LP
The
.B XSetAccessControl
function either enables or disables the use of the access control list
function either enables or disables the use of the access control list
at each connection setup.
.LP
.B XSetAccessControl
@ -231,7 +231,7 @@ typedef struct {
} XHostAddress;
.EE
.LP
The family member specifies which protocol address family to use
The family member specifies which protocol address family to use
(for example, TCP/IP or DECnet) and can be
.BR FamilyInternet ,
.BR FamilyInternet6 ,
@ -242,8 +242,8 @@ or
The length member specifies the length of the address in bytes.
The address member specifies a pointer to the address.
.LP
For the ServerInterpreted family, the length is ignored and the address
member is a pointer to a
For the ServerInterpreted family, the length is ignored and the address
member is a pointer to a
.B XServerInterpretedAddress
structure which contains:
.LP

14
man/XAllocClassHint.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -63,7 +63,7 @@ Specifies the
.B XClassHint
structure that is to be used.
.IP \fIclass_hints_return\fP 1i
Returns the
Returns the
.B XClassHint
structure.
.IP \fIw\fP 1i
@ -77,7 +77,7 @@ structure.
Note that the pointer fields in the
.B XClassHint
structure are initially set to NULL.
If insufficient memory is available,
If insufficient memory is available,
.B XAllocClassHint
returns NULL.
To free the memory allocated to this structure,
@ -132,15 +132,15 @@ typedef struct {
char *res_class;
} XClassHint;
.LP
The res_name member contains the application name,
and the res_class member contains the application class.
The res_name member contains the application name,
and the res_class member contains the application class.
Note that the name set in this property may differ from the name set as WM_NAME.
That is, WM_NAME specifies what should be displayed in the title bar and,
therefore, can contain temporal information (for example, the name of
a file currently in an editor's buffer).
On the other hand,
On the other hand,
the name specified as part of WM_CLASS is the formal name of the application
that should be used when retrieving the application's resources from the
that should be used when retrieving the application's resources from the
resource database.
.SH DIAGNOSTICS
.TP 1i

88
man/XAllocColor.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -73,7 +73,7 @@ unsigned long *\fIgmask_return\fP\^, unsigned long *\fIbmask_return\fP\^);
int XFreeColors\^(\^Display *\fIdisplay\fP, Colormap \fIcolormap\fP\^, unsigned
long \fIpixels\fP\^[\^], int \fInpixels\fP\^, unsigned long \fIplanes\fP\^);
.IP \fIcolor_name\fP 1i
Specifies the color name string (for example, red) whose color
Specifies the color name string (for example, red) whose color
definition structure you want returned.
.IP \fIcolormap\fP 1i
Specifies the colormap.
@ -84,13 +84,13 @@ Specifies the connection to the X server.
.IP \fIexact_def_return\fP 1i
Returns the exact RGB values.
.IP \fIncolors\fP 1i
Specifies the number of pixel values that are to be returned in the
pixels_return array.
Specifies the number of pixel values that are to be returned in the
pixels_return array.
.IP \fInpixels\fP 1i
Specifies the number of pixels.
Specifies the number of pixels.
.IP \fInplanes\fP 1i
Specifies the number of plane masks that are to be returned in the plane masks
array.
Specifies the number of plane masks that are to be returned in the plane masks
array.
.IP \fInreds\fP 1i
.br
.ns
@ -101,11 +101,11 @@ array.
.br
.ns
Specify the number of red, green, and blue planes.
The value you pass must be nonnegative.
The value you pass must be nonnegative.
.IP \fIpixels\fP 1i
Specifies an array of pixel values.
Specifies an array of pixel values.
.IP \fIpixels_return\fP 1i
Returns an array of pixel values.
Returns an array of pixel values.
.IP \fIplane_mask_return\fP 1i
Returns an array of plane masks.
.\" *** JIM: NEED MORE INFO FOR THIS. ***
@ -161,7 +161,7 @@ It returns both the exact database definition and
the closest color supported by the screen.
The allocated color cell is read-only.
The pixel value is returned in screen_def_return.
If the color name is not in the Host Portable Character Encoding,
If the color name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Use of uppercase or lowercase does not matter.
If screen_def_return and exact_def_return
@ -186,7 +186,7 @@ The number of colors must be positive and the number of planes nonnegative,
or a
.B BadValue
error results.
If ncolors and nplanes are requested,
If ncolors and nplanes are requested,
then ncolors pixels
and nplane plane masks are returned.
No mask will have any bits set to 1 in common with
@ -195,23 +195,23 @@ By ORing together each pixel with zero or more masks,
ncolors * %2 sup nplanes% distinct pixels can be produced.
All of these are
allocated writable by the request.
For
For
.B GrayScale
or
or
.BR PseudoColor ,
each mask has exactly one bit set to 1.
For
each mask has exactly one bit set to 1.
For
.BR DirectColor ,
each has exactly three bits set to 1.
If contig is
If contig is
.B True
and if all masks are ORed
together, a single contiguous set of bits set to 1 will be formed for
together, a single contiguous set of bits set to 1 will be formed for
.B GrayScale
or
or
.B PseudoColor
and three contiguous sets of bits set to 1 (one within each
pixel subfield) for
pixel subfield) for
.BR DirectColor .
The RGB values of the allocated
entries are undefined.
@ -228,41 +228,41 @@ errors.
.EQ
delim %%
.EN
The specified ncolors must be positive;
The specified ncolors must be positive;
and nreds, ngreens, and nblues must be nonnegative,
or a
.B BadValue
error results.
If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested,
ncolors pixels are returned; and the masks have nreds, ngreens, and
If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested,
ncolors pixels are returned; and the masks have nreds, ngreens, and
nblues bits set to 1, respectively.
If contig is
If contig is
.BR True ,
each mask will have
a contiguous set of bits set to 1.
No mask will have any bits set to 1 in common with
any other mask or with any of the pixels.
For
For
.BR DirectColor ,
each mask
will lie within the corresponding pixel subfield.
By ORing together
subsets of masks with each pixel value,
ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced.
subsets of masks with each pixel value,
ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced.
All of these are allocated by the request.
However, in the
colormap, there are only ncolors * %2 sup nreds% independent red entries,
ncolors * %2 sup ngreens% independent green entries,
and ncolors * %2 sup nblues% independent blue entries.
This is true even for
colormap, there are only ncolors * %2 sup nreds% independent red entries,
ncolors * %2 sup ngreens% independent green entries,
and ncolors * %2 sup nblues% independent blue entries.
This is true even for
.BR PseudoColor .
When the colormap entry of a pixel
value is changed (using
value is changed (using
.BR XStoreColors ,
.BR XStoreColor ,
or
or
.BR XStoreNamedColor ),
the pixel is decomposed according to the masks,
the pixel is decomposed according to the masks,
and the corresponding independent entries are updated.
.B XAllocColorPlanes
returns nonzero if it succeeded or zero if it failed.
@ -279,11 +279,11 @@ The
function frees the cells represented by pixels whose values are in the
pixels array.
The planes argument should not have any bits set to 1 in common with any of the
pixels.
pixels.
The set of all pixels is produced by ORing together subsets of
the planes argument with the pixels.
The request frees all of these pixels that
were allocated by the client (using
were allocated by the client (using
.IN XAllocColor
.IN XAllocNamedColor
.IN XAllocColorCells
@ -291,10 +291,10 @@ were allocated by the client (using
.BR XAllocColor ,
.BR XAllocNamedColor ,
.BR XAllocColorCells ,
and
and
.BR XAllocColorPlanes ).
Note that freeing an
individual pixel obtained from
individual pixel obtained from
.B XAllocColorPlanes
may not actually allow
it to be reused until all of its related pixels are also freed.
@ -304,8 +304,8 @@ and if a client allocates the same read-only entry multiple times,
it must free the entry that many times before the entry is actually freed.
.LP
All specified pixels that are allocated by the client in the colormap are
freed, even if one or more pixels produce an error.
If a specified pixel is not a valid index into the colormap, a
freed, even if one or more pixels produce an error.
If a specified pixel is not a valid index into the colormap, a
.B BadValue
error results.
If a specified pixel is not allocated by the
@ -316,8 +316,8 @@ to
.BR XCreateColormap ),
a
.B BadAccess
error results.
If more than one pixel is in error,
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
.LP
.B XFreeColors
@ -346,8 +346,8 @@ Unless a specific range is specified for an argument, the full range defined
by the argument's type is accepted. Any argument defined as a set of
alternatives can generate this error.
.SH "SEE ALSO"
XCreateColormap(__libmansuffix__),
XCreateColormap(__libmansuffix__),
XQueryColor(__libmansuffix__),
XStoreColors(__libmansuffix__)
XStoreColors(__libmansuffix__)
.br
\fI\*(xL\fP

6
man/XAllocIconSize.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -78,7 +78,7 @@ structure.
Note that all fields in the
.B XIconSize
structure are initially set to zero.
If insufficient memory is available,
If insufficient memory is available,
.B XAllocIconSize
returns NULL.
To free the memory allocated to this structure,
@ -121,7 +121,7 @@ error.
\s-1WM_ICON_SIZES\s+1
The window manager may set this property on the root window to
specify the icon sizes it supports.
The C type of this property is
The C type of this property is
.BR XIconSize .
.SH STRUCTURES
The

76
man/XAllocSizeHints.man
View file

@ -40,11 +40,11 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates,
.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates,
.ds xC Inter-Client Communication Conventions Manual
'\" t
.TH XAllocSizeHints __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
@ -90,16 +90,16 @@ structure.
Note that all fields in the
.B XSizeHints
structure are initially set to zero.
If insufficient memory is available,
If insufficient memory is available,
.B XAllocSizeHints
returns NULL.
To free the memory allocated to this structure,
use
.BR XFree .
.LP
The
The
.B XSetWMNormalHints
function replaces the size hints for the WM_NORMAL_HINTS property
function replaces the size hints for the WM_NORMAL_HINTS property
on the specified window.
If the property does not already exist,
.B XSetWMNormalHints
@ -113,24 +113,24 @@ and
.B BadWindow
errors.
.LP
The
The
.B XGetWMNormalHints
function returns the size hints stored in the WM_NORMAL_HINTS property
function returns the size hints stored in the WM_NORMAL_HINTS property
on the specified window.
If the property is of type WM_SIZE_HINTS, is of format 32,
and is long enough to contain either an old (pre-ICCCM)
or new size hints structure,
and is long enough to contain either an old (pre-ICCCM)
or new size hints structure,
.B XGetWMNormalHints
sets the various fields of the
sets the various fields of the
.B XSizeHints
structure, sets the supplied_return argument to the list of fields
structure, sets the supplied_return argument to the list of fields
that were supplied by the user (whether or not they contained defined values),
and returns a nonzero status.
Otherwise, it returns a zero status.
.LP
If
If
.B XGetWMNormalHints
returns successfully and a pre-ICCCM size hints property is read,
returns successfully and a pre-ICCCM size hints property is read,
the supplied_return argument will contain the following bits:
.LP
.EX
@ -138,8 +138,8 @@ the supplied_return argument will contain the following bits:
PMaxSize|PResizeInc|PAspect)
.EE
.LP
If the property is large enough to contain the base size
and window gravity fields as well,
If the property is large enough to contain the base size
and window gravity fields as well,
the supplied_return argument will also contain the following bits:
.LP
.EX
@ -151,17 +151,17 @@ can generate a
PN BadWindow
error.
.LP
The
The
.B XSetWMSizeHints
function replaces the size hints for the specified property
function replaces the size hints for the specified property
on the named window.
If the specified property does not already exist,
.B XSetWMSizeHints
sets the size hints for the specified property
on the named window.
The property is stored with a type of WM_SIZE_HINTS and a format of 32.
To set a window's normal size hints,
you can use the
To set a window's normal size hints,
you can use the
.B XSetWMNormalHints
function.
.LP
@ -173,29 +173,29 @@ and
.B BadWindow
errors.
.LP
The
The
.B XGetWMSizeHints
function returns the size hints stored in the specified property
function returns the size hints stored in the specified property
on the named window.
If the property is of type WM_SIZE_HINTS, is of format 32,
and is long enough to contain either an old (pre-ICCCM)
or new size hints structure,
If the property is of type WM_SIZE_HINTS, is of format 32,
and is long enough to contain either an old (pre-ICCCM)
or new size hints structure,
.B XGetWMSizeHints
sets the various fields of the
sets the various fields of the
.B XSizeHints
structure, sets the supplied_return argument to the
list of fields that were supplied by the user
(whether or not they contained defined values),
list of fields that were supplied by the user
(whether or not they contained defined values),
and returns a nonzero status.
Otherwise, it returns a zero status.
To get a window's normal size hints,
you can use the
To get a window's normal size hints,
you can use the
.B XGetWMNormalHints
function.
.LP
If
If
.B XGetWMSizeHints
returns successfully and a pre-ICCCM size hints property is read,
returns successfully and a pre-ICCCM size hints property is read,
the supplied_return argument will contain the following bits:
.LP
.EX
@ -203,8 +203,8 @@ the supplied_return argument will contain the following bits:
PMaxSize|PResizeInc|PAspect)
.EE
.LP
If the property is large enough to contain the base size
and window gravity fields as well,
If the property is large enough to contain the base size
and window gravity fields as well,
the supplied_return argument will also contain the following bits:
.LP
.EX
@ -359,19 +359,19 @@ The max_width and max_height members specify the maximum window size.
The width_inc and height_inc members define an arithmetic progression of
sizes (minimum to maximum) into which the window prefers to be resized.
The min_aspect and max_aspect members are expressed
as ratios of x and y,
as ratios of x and y,
and they allow an application to specify the range of aspect
ratios it prefers.
The base_width and base_height members define the desired size of the window.
The window manager will interpret the position of the window
and its border width to position the point of the outer rectangle
The window manager will interpret the position of the window
and its border width to position the point of the outer rectangle
of the overall window specified by the win_gravity member.
The outer rectangle of the window includes any borders or decorations
supplied by the window manager.
In other words,
if the window manager decides to place the window where the client asked,
the position on the parent window's border named by the win_gravity
will be placed where the client window would have been placed
the position on the parent window's border named by the win_gravity
will be placed where the client window would have been placed
in the absence of a window manager.
.LP
Note that use of the

74
man/XAllocStandardColormap.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -87,16 +87,16 @@ structure.
Note that all fields in the
.B XStandardColormap
structure are initially set to zero.
If insufficient memory is available,
If insufficient memory is available,
.B XAllocStandardColormap
returns NULL.
To free the memory allocated to this structure,
use
.BR XFree .
.LP
The
The
.B XSetRGBColormaps
function replaces the RGB colormap definition in the specified property
function replaces the RGB colormap definition in the specified property
on the named window.
If the property does not already exist,
.B XSetRGBColormaps
@ -109,7 +109,7 @@ restriction that only RGB_DEFAULT_MAP contain more than one definition.
The
.B XSetRGBColormaps
function usually is only used by window or session managers.
To create a standard colormap,
To create a standard colormap,
follow this procedure:
.IP 1. 5
Open a new connection to the same server.
@ -128,11 +128,11 @@ Determine the color characteristics of the visual.
Allocate cells in the colormap (or create it with
.BR AllocAll ).
.IP \(bu 5
Call
Call
.B XStoreColors
to store appropriate color values in the colormap.
.IP \(bu 5
Fill in the descriptive members in the
Fill in the descriptive members in the
.B XStandardColormap
structure.
.IP \(bu 5
@ -153,23 +153,23 @@ and
.B BadWindow
errors.
.LP
The
The
.B XGetRGBColormaps
function returns the RGB colormap definitions stored
function returns the RGB colormap definitions stored
in the specified property on the named window.
If the property exists, is of type RGB_COLOR_MAP, is of format 32,
If the property exists, is of type RGB_COLOR_MAP, is of format 32,
and is long enough to contain a colormap definition,
.B XGetRGBColormaps
allocates and fills in space for the returned colormaps
and returns a nonzero status.
If the visualid is not present,
If the visualid is not present,
.B XGetRGBColormaps
assumes the default visual for the screen on which the window is located;
if the killid is not present,
assumes the default visual for the screen on which the window is located;
if the killid is not present,
.B None
is assumed, which indicates that the resources cannot be released.
Otherwise,
none of the fields are set, and
Otherwise,
none of the fields are set, and
.B XGetRGBColormaps
returns a zero status.
Note that it is the caller's responsibility to honor the ICCCM
@ -218,30 +218,30 @@ The colormap member is the colormap created by the
.B XCreateColormap
function.
The red_max, green_max, and blue_max members give the maximum
red, green, and blue values, respectively.
Each color coefficient ranges from zero to its max, inclusive.
red, green, and blue values, respectively.
Each color coefficient ranges from zero to its max, inclusive.
For example,
a common colormap allocation is 3/3/2 (3 planes for red, 3
planes for green, and 2 planes for blue).
This colormap would have red_max = 7, green_max = 7,
and blue_max = 3.
An alternate allocation that uses only 216 colors is red_max = 5,
planes for green, and 2 planes for blue).
This colormap would have red_max = 7, green_max = 7,
and blue_max = 3.
An alternate allocation that uses only 216 colors is red_max = 5,
green_max = 5, and blue_max = 5.
.LP
The red_mult, green_mult, and blue_mult members give the
scale factors used to compose a full pixel value.
scale factors used to compose a full pixel value.
(See the discussion of the base_pixel members for further information.)
For a 3/3/2 allocation, red_mult might be 32,
green_mult might be 4, and blue_mult might be 1.
For a 6-colors-each allocation, red_mult might be 36,
green_mult might be 4, and blue_mult might be 1.
For a 6-colors-each allocation, red_mult might be 36,
green_mult might be 6, and blue_mult might be 1.
.LP
The base_pixel member gives the base pixel value used to
compose a full pixel value.
Usually, the base_pixel is obtained from a call to the
compose a full pixel value.
Usually, the base_pixel is obtained from a call to the
.B XAllocColorPlanes
function.
Given integer red, green, and blue coefficients in their appropriate
function.
Given integer red, green, and blue coefficients in their appropriate
ranges, one then can compute a corresponding pixel value by
using the following expression:
.LP
@ -249,13 +249,13 @@ using the following expression:
(r * red_mult + g * green_mult + b * blue_mult + base_pixel) & 0xFFFFFFFF
.EE
.LP
For
For
.B GrayScale
colormaps,
only the colormap, red_max, red_mult,
and base_pixel members are defined.
The other members are ignored.
To compute a
colormaps,
only the colormap, red_max, red_mult,
and base_pixel members are defined.
The other members are ignored.
To compute a
.B GrayScale
pixel value, use the following expression:
.LP
@ -274,15 +274,15 @@ depending on the size of the integer type used to do the computation,
The visualid member gives the ID number of the visual from which the
colormap was created.
The killid member gives a resource ID that indicates whether
the cells held by this standard colormap are to be released
the cells held by this standard colormap are to be released
by freeing the colormap ID or by calling the
.B XKillClient
function on the indicated resource.
(Note that this method is necessary for allocating out of an existing colormap.)
.LP
The properties containing the
The properties containing the
.B XStandardColormap
information have
information have
the type RGB_COLOR_MAP.
.SH DIAGNOSTICS
.TP 1i

44
man/XAllocWMHints.man
View file

@ -40,11 +40,11 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates, Sebastopol, 1991.
.ds xL Xlib \- C Language X Interface, \fRO'Reilly and Associates, Sebastopol, 1991.
.ds xC Inter-Client Communication Conventions Manual
'\" t
.TH XAllocWMHints __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
@ -52,7 +52,7 @@
XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints \- allocate window manager hints structure and set or read a window's WM_HINTS property
.SH SYNTAX
.HP
XWMHints *XAllocWMHints\^(void\^);
XWMHints *XAllocWMHints\^(void\^);
.HP
int XSetWMHints\^(\^Display *\fIdisplay\fP, Window \fIw\fP, XWMHints *\fIwmhints\fP\^);
.HP
@ -63,7 +63,7 @@ Specifies the connection to the X server.
.IP \fIw\fP 1i
Specifies the window.
.IP \fIwmhints\fP 1i
Specifies the
Specifies the
.B XWMHints
structure to be used.
.SH DESCRIPTION
@ -75,7 +75,7 @@ structure.
Note that all fields in the
.B XWMHints
structure are initially set to zero.
If insufficient memory is available,
If insufficient memory is available,
.B XAllocWMHints
returns NULL.
To free the memory allocated to this structure,
@ -97,9 +97,9 @@ errors.
.LP
The
.B XGetWMHints
function reads the window manager hints and
returns NULL if no WM_HINTS property was set on the window
or returns a pointer to a
function reads the window manager hints and
returns NULL if no WM_HINTS property was set on the window
or returns a pointer to a
.B XWMHints
structure if it succeeds.
When finished with the data,
@ -114,7 +114,7 @@ error.
.TP 1i
\s-1WM_HINTS\s+1
Additional hints set by the client for use by the window manager.
The C type of this property is
The C type of this property is
.BR XWMHints .
.SH STRUCTURES
The
@ -212,33 +212,33 @@ typedef struct {
.LP
The input member is used to communicate to the window manager the input focus
model used by the application.
Applications that expect input but never explicitly set focus to any
of their subwindows (that is, use the push model of focus management),
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
driven focus, should set this member to
.BR True .
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
top-level window by a window manager should also set this member to
.BR True .
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
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
.BR False .
Applications that never expect any keyboard input also should set this member
to
to
.BR False .
.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
applications whose input member is
.BR True .
Push model window managers should
make sure that pull model applications do not break them
by resetting input focus to
make sure that pull model applications do not break them
by resetting input focus to
.B PointerRoot
when it is appropriate (for example, whenever an application whose
input member is
input member is
.B False
sets input focus to one of its subwindows).
.LP
@ -273,14 +273,14 @@ T} T{
T}
.TE
The icon_mask specifies which pixels of the icon_pixmap should be used as the
icon.
icon.
This allows for nonrectangular icons.
Both icon_pixmap and icon_mask must be bitmaps.
The icon_window lets an application provide a window for use as an icon
for window managers that support such use.
The window_group lets you specify that this window belongs to a group
of other windows.
For example, if a single application manipulates multiple
For example, if a single application manipulates multiple
top-level windows, this allows you to provide enough
information that a window manager can iconify all of the windows
rather than just the one window.

8
man/XAllowEvents.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,13 +51,13 @@ XAllowEvents \- release queued events
.SH SYNTAX
.HP
int XAllowEvents\^(\^Display *\fIdisplay\fP, int \fIevent_mode\fP\^,
Time \fItime\fP\^);
Time \fItime\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIevent_mode\fP 1i
Specifies the event mode.
You can pass
You can pass
.BR AsyncPointer ,
.BR SyncPointer ,
.BR AsyncKeyboard ,
@ -74,7 +74,7 @@ You can pass either a timestamp or
.SH DESCRIPTION
The
.B XAllowEvents
function releases some queued events if the client has caused a device
function releases some queued events if the client has caused a device
to freeze.
It has no effect if the specified time is earlier than the last-grab
time of the most recent active grab for the client or if the specified time

4
man/XAnyEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -49,7 +49,7 @@
.SH NAME
XAnyEvent, XEvent \- generic X event structures
.SH STRUCTURES
All the event structures declared in
All the event structures declared in
.Pn < X11/Xlib.h >
have the following common members:
.EX

16
man/XButtonEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -142,14 +142,14 @@ dispatchers.
These structures have the following common members:
window, root, subwindow, time, x, y, x_root, y_root, state, and same_screen.
The window member is set to the window on which the
event was generated and is referred to as the event window.
event was generated and is referred to as the event window.
As long as the conditions previously discussed are met,
this is the window used by the X server to report the event.
The root member is set to the source window's root window.
The x_root and y_root members are set to the pointer's coordinates
relative to the root window's origin at the time of the event.
.LP
The same_screen member is set to indicate whether the event
The same_screen member is set to indicate whether the event
window is on the same screen
as the root window and can be either
.B True
@ -162,21 +162,21 @@ If
.BR False ,
the event and root windows are not on the same screen.
.LP
If the source window is an inferior of the event window,
If the source window is an inferior of the event window,
the subwindow member of the structure is set to the child of the event window
that is the source window or the child of the event window that is
an ancestor of the source window.
Otherwise, the X server sets the subwindow member to
.BR None .
The time member is set to the time when the event was generated
The time member is set to the time when the event was generated
and is expressed in milliseconds.
.LP
If the event window is on the same screen as the root window,
If the event window is on the same screen as the root window,
the x and y members
are set to the coordinates relative to the event window's origin.
Otherwise, these members are set to zero.
.LP
The state member is set to indicate the logical state of the pointer buttons
The state member is set to indicate the logical state of the pointer buttons
and modifier keys just prior to the event,
which is the bitwise inclusive OR of one or more of the
button or modifier key masks:
@ -221,7 +221,7 @@ value.
For the
.B XPointerMovedEvent
structure, this member is called is_hint.
It can be set to
It can be set to
.B NotifyNormal
or
.BR NotifyHint .

48
man/XChangeKeyboardControl.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,18 +53,18 @@ XChangeKeyboardControl, XGetKeyboardControl, XAutoRepeatOn, XAutoRepeatOff, XBel
.SH SYNTAX
.HP
int XChangeKeyboardControl\^(\^Display *\fIdisplay\fP, unsigned long
\fIvalue_mask\fP\^, XKeyboardControl *\fIvalues\fP\^);
\fIvalue_mask\fP\^, XKeyboardControl *\fIvalues\fP\^);
.HP
int XGetKeyboardControl\^(\^Display *\fIdisplay\fP, XKeyboardState
*\fIvalues_return\fP\^);
*\fIvalues_return\fP\^);
.HP
int XAutoRepeatOn\^(\^Display *\fIdisplay\fP\^);
int XAutoRepeatOn\^(\^Display *\fIdisplay\fP\^);
.HP
int XAutoRepeatOff\^(\^Display *\fIdisplay\fP\^);
int XAutoRepeatOff\^(\^Display *\fIdisplay\fP\^);
.HP
int XBell\^(\^Display *\fIdisplay\fP, int \fIpercent\fP\^);
int XBell\^(\^Display *\fIdisplay\fP, int \fIpercent\fP\^);
.HP
int XQueryKeymap\^(\^Display *\fIdisplay\fP, char \fIkeys_return\fP[32]\^);
int XQueryKeymap\^(\^Display *\fIdisplay\fP, char \fIkeys_return\fP[32]\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -73,7 +73,7 @@ Returns an array of bytes that identifies which keys are pressed down.
Each bit represents one key of the keyboard.
.IP \fIpercent\fP 1i
Specifies the volume for the bell,
which can range from \-100 to 100 inclusive.
which can range from \-100 to 100 inclusive.
.IP \fIvalue_mask\fP 1i
Specifies which controls to change.
This mask is the bitwise inclusive OR of the valid control mask bits.
@ -140,11 +140,11 @@ error.
.LP
The
.B XQueryKeymap
function returns a bit vector for the logical state of the keyboard,
where each bit set to 1 indicates that the corresponding key is currently
function returns a bit vector for the logical state of the keyboard,
where each bit set to 1 indicates that the corresponding key is currently
pressed down.
The vector is represented as 32 bytes.
Byte N (from 0) contains the bits for keys 8N to 8N + 7
Byte N (from 0) contains the bits for keys 8N to 8N + 7
with the least significant bit in the byte representing key 8N.
.LP
Note that the logical state of a device (as seen by client applications)
@ -227,20 +227,20 @@ typedef struct {
int led;
int led_mode; /\&* LedModeOn, LedModeOff */
int key;
int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn,
int auto_repeat_mode; /\&* AutoRepeatModeOff, AutoRepeatModeOn,
AutoRepeatModeDefault */
} XKeyboardControl;
.EE
.LP
The key_click_percent member sets the volume for key clicks between 0 (off)
and 100 (loud) inclusive, if possible.
The key_click_percent member sets the volume for key clicks between 0 (off)
and 100 (loud) inclusive, if possible.
A setting of \-1 restores the default.
Other negative values generate a
.B BadValue
error.
.LP
The bell_percent sets the base volume for the bell between 0 (off) and 100
(loud) inclusive, if possible.
(loud) inclusive, if possible.
A setting of \-1 restores the default.
Other negative values generate a
.B BadValue
@ -251,27 +251,27 @@ Other negative values generate a
.B BadValue
error.
The bell_duration member sets the duration of the
bell specified in milliseconds, if possible.
bell specified in milliseconds, if possible.
A setting of \-1 restores the default.
Other negative values generate a
.B BadValue
error.
.LP
If both the led_mode and led members are specified,
the state of that LED is changed, if possible.
the state of that LED is changed, if possible.
The led_mode member can be set to
.B LedModeOn
or
.BR LedModeOff .
If only led_mode is specified, the state of
all LEDs are changed, if possible.
At most 32 LEDs numbered from one are supported.
all LEDs are changed, if possible.
At most 32 LEDs numbered from one are supported.
No standard interpretation of LEDs is defined.
If led is specified without led_mode, a
.B BadMatch
error results.
error results.
.LP
If both the auto_repeat_mode and key members are specified,
If both the auto_repeat_mode and key members are specified,
the auto_repeat_mode of that key is changed (according to
.BR AutoRepeatModeOn ,
.BR AutoRepeatModeOff ,
@ -319,7 +319,7 @@ typedef struct {
} XKeyboardState;
.EE
.LP
For the LEDs,
For the LEDs,
the least significant bit of led_mask corresponds to LED one,
and each bit set to 1 in led_mask indicates an LED that is lit.
The global_auto_repeat member can be set to
@ -327,9 +327,9 @@ The global_auto_repeat member can be set to
or
.BR AutoRepeatModeOff .
The auto_repeats member is a bit vector.
Each bit set to 1 indicates that auto-repeat is enabled
Each bit set to 1 indicates that auto-repeat is enabled
for the corresponding key.
The vector is represented as 32 bytes.
The vector is represented as 32 bytes.
Byte N (from 0) contains the bits for keys 8N to 8N + 7
with the least significant bit in the byte representing key 8N.
.SH DIAGNOSTICS

104
man/XChangeKeyboardMapping.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,29 +51,29 @@ XChangeKeyboardMapping, XGetKeyboardMapping, XDisplayKeycodes, XSetModifierMappi
.SH SYNTAX
.HP
int XChangeKeyboardMapping(\^Display *\fIdisplay\fP, int \fIfirst_keycode\fP,
int \fIkeysyms_per_keycode\fP, KeySym *\fIkeysyms\fP, int \fInum_codes\fP\^);
int \fIkeysyms_per_keycode\fP, KeySym *\fIkeysyms\fP, int \fInum_codes\fP\^);
.HP
KeySym *XGetKeyboardMapping(\^Display *\fIdisplay\fP, KeyCode
\fIfirst_keycode\fP, int \fIkeycode_count\fP, int
*\fIkeysyms_per_keycode_return\fP\^);
*\fIkeysyms_per_keycode_return\fP\^);
.HP
int XDisplayKeycodes\^(\^Display *\fIdisplay\fP\^, int
*\fImin_keycodes_return\fP\^, int *\fImax_keycodes_return\fP\^);
*\fImin_keycodes_return\fP\^, int *\fImax_keycodes_return\fP\^);
.HP
int XSetModifierMapping(\^Display *\fIdisplay\fP, XModifierKeymap
*\fImodmap\fP\^);
*\fImodmap\fP\^);
.HP
XModifierKeymap *XGetModifierMapping(\^Display *\fIdisplay\fP\^);
XModifierKeymap *XGetModifierMapping(\^Display *\fIdisplay\fP\^);
.HP
XModifierKeymap *XNewModifiermap(\^int \fImax_keys_per_mod\fP\^);
XModifierKeymap *XNewModifiermap(\^int \fImax_keys_per_mod\fP\^);
.HP
XModifierKeymap *XInsertModifiermapEntry\^(\^XModifierKeymap *\fImodmap\fP,
KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^);
KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^);
.HP
XModifierKeymap *XDeleteModifiermapEntry\^(\^XModifierKeymap *\fImodmap\fP,
KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^);
KeyCode \fIkeycode_entry\fP, int \fImodifier\fP\^);
.HP
int XFreeModifiermap(\^XModifierKeymap *\fImodmap\fP\^);
int XFreeModifiermap(\^XModifierKeymap *\fImodmap\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -82,7 +82,7 @@ Specifies the first KeyCode that is to be changed or returned.
.IP \fIkeycode_count\fP 1i
Specifies the number of KeyCodes that are to be returned.
.IP \fIkeycode_entry\fP 1i
Specifies the KeyCode.
Specifies the KeyCode.
.IP \fIkeysyms\fP 1i
Specifies an array of KeySyms.
.IP \fIkeysyms_per_keycode\fP 1i
@ -99,7 +99,7 @@ Returns the minimum number of KeyCodes.
.IP \fImodifier\fP 1i
Specifies the modifier.
.IP \fImodmap\fP 1i
Specifies the
Specifies the
.B XModifierKeymap
structure.
.IP \fInum_codes\fP 1i
@ -109,20 +109,20 @@ The
.B XChangeKeyboardMapping
function defines the symbols for the specified number of KeyCodes
starting with first_keycode.
The symbols for KeyCodes outside this range remain unchanged.
The symbols for KeyCodes outside this range remain unchanged.
The number of elements in keysyms must be:
.LP
.EX
num_codes * keysyms_per_keycode
.EE
.LP
The specified first_keycode must be greater than or equal to min_keycode
The specified first_keycode must be greater than or equal to min_keycode
returned by
.BR XDisplayKeycodes ,
or a
or a
.B BadValue
error results.
In addition, the following expression must be less than or equal to
In addition, the following expression must be less than or equal to
max_keycode as returned by
.BR XDisplayKeycodes ,
or a
@ -134,28 +134,28 @@ first_keycode + num_codes \- 1
.EE
.LP
KeySym number N, counting from zero, for KeyCode K has the following index
in keysyms, counting from zero:
in keysyms, counting from zero:
.LP
.EX
.EX
(K \- first_keycode) * keysyms_per_keycode + N
.EE
.LP
The specified keysyms_per_keycode can be chosen arbitrarily by the client
to be large enough to hold all desired symbols.
A special KeySym value of
to be large enough to hold all desired symbols.
A special KeySym value of
.B NoSymbol
should be used to fill in unused elements
for individual KeyCodes.
It is legal for
should be used to fill in unused elements
for individual KeyCodes.
It is legal for
.B NoSymbol
to appear in nontrailing positions
of the effective list for a KeyCode.
.B XChangeKeyboardMapping
generates a
generates a
.B MappingNotify
event.
.LP
There is no requirement that the X server interpret this mapping.
There is no requirement that the X server interpret this mapping.
It is merely stored for reading and writing by clients.
.LP
.B XChangeKeyboardMapping
@ -169,42 +169,42 @@ The
.B XGetKeyboardMapping
function returns the symbols for the specified number of KeyCodes
starting with first_keycode.
The value specified in first_keycode must be greater than
The value specified in first_keycode must be greater than
or equal to min_keycode as returned by
.BR XDisplayKeycodes ,
or a
.B BadValue
error results.
In addition, the following expression must be less than or equal
In addition, the following expression must be less than or equal
to max_keycode as returned by
.BR XDisplayKeycodes :
.LP
.EX
.EX
first_keycode + keycode_count \- 1
.EE
.LP
If this is not the case, a
If this is not the case, a
.B BadValue
error results.
error results.
The number of elements in the KeySyms list is:
.LP
.EX
.EX
keycode_count * keysyms_per_keycode_return
.EE
.LP
KeySym number N, counting from zero, for KeyCode K has the following index
in the list, counting from zero:
in the list, counting from zero:
.EX
(K \- first_code) * keysyms_per_code_return + N
.EE
.LP
The X server arbitrarily chooses the keysyms_per_keycode_return value
to be large enough to report all requested symbols.
A special KeySym value of
The X server arbitrarily chooses the keysyms_per_keycode_return value
to be large enough to report all requested symbols.
A special KeySym value of
.B NoSymbol
is used to fill in unused elements for
individual KeyCodes.
To free the storage returned by
To free the storage returned by
.BR XGetKeyboardMapping ,
use
.BR XFree .
@ -224,7 +224,7 @@ Not all KeyCodes in this range are required to have corresponding keys.
.LP
The
.B XSetModifierMapping
function specifies the KeyCodes of the keys (if any) that are to be used
function specifies the KeyCodes of the keys (if any) that are to be used
as modifiers.
If it succeeds,
the X server generates a
@ -240,10 +240,10 @@ structure, a
.B BadLength
error results.
.LP
The modifiermap member of the
The modifiermap member of the
.B XModifierKeymap
structure contains 8 sets of max_keypermod KeyCodes,
one for each modifier in the order
structure contains 8 sets of max_keypermod KeyCodes,
one for each modifier in the order
.BR Shift ,
.BR Lock ,
.BR Control ,
@ -251,30 +251,30 @@ one for each modifier in the order
.BR Mod2 ,
.BR Mod3 ,
.BR Mod4 ,
and
and
.BR Mod5 .
Only nonzero KeyCodes have meaning in each set,
Only nonzero KeyCodes have meaning in each set,
and zero KeyCodes are ignored.
In addition, all of the nonzero KeyCodes must be in the range specified by
min_keycode and max_keycode in the
In addition, all of the nonzero KeyCodes must be in the range specified by
min_keycode and max_keycode in the
.B Display
structure,
or a
or a
.B BadValue
error results.
.LP
An X server can impose restrictions on how modifiers can be changed,
An X server can impose restrictions on how modifiers can be changed,
for example,
if certain keys do not generate up transitions in hardware,
if auto-repeat cannot be disabled on certain keys,
or if multiple modifier keys are not supported.
If some such restriction is violated,
or if multiple modifier keys are not supported.
If some such restriction is violated,
the status reply is
.BR MappingFailed ,
and none of the modifiers are changed.
If the new KeyCodes specified for a modifier differ from those
currently defined and any (current or new) keys for that modifier are
in the logically down state,
in the logically down state,
.B XSetModifierMapping
returns
.BR MappingBusy ,
@ -283,7 +283,7 @@ and none of the modifiers is changed.
.B XSetModifierMapping
can generate
.B BadAlloc
and
and
.B BadValue
errors.
.LP
@ -294,7 +294,7 @@ function returns a pointer to a newly created
structure that contains the keys being used as modifiers.
The structure should be freed after use by calling
.BR XFreeModifiermap .
If only zero values appear in the set for any modifier,
If only zero values appear in the set for any modifier,
that modifier is disabled.
.LP
The
@ -346,6 +346,6 @@ alternatives can generate this error.
.SH "SEE ALSO"
XFree(__libmansuffix__),
XkbGetMap(__libmansuffix__),
XSetPointerMapping(__libmansuffix__)
XSetPointerMapping(__libmansuffix__)
.br
\fI\*(xL\fP

14
man/XChangePointerControl.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -47,7 +47,7 @@
.ds xC Inter-Client Communication Conventions Manual
.TH XChangePointerControl __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
XChangePointerControl, XGetPointerControl \- control pointer
XChangePointerControl, XGetPointerControl \- control pointer
.SH SYNTAX
.HP
int XChangePointerControl\^(\^Display *\fIdisplay\fP\^, Bool \fIdo_accel\fP\^,
@ -69,10 +69,10 @@ Returns the numerator for the acceleration multiplier.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIdo_accel\fP 1i
Specifies a Boolean value that controls whether the values for
Specifies a Boolean value that controls whether the values for
the accel_numerator or accel_denominator are used.
.IP \fIdo_threshold\fP 1i
Specifies a Boolean value that controls whether the value for the
Specifies a Boolean value that controls whether the value for the
threshold is used.
.IP \fIthreshold\fP 1i
Specifies the acceleration threshold.
@ -83,15 +83,15 @@ The
.B XChangePointerControl
function defines how the pointing device moves.
The acceleration, expressed as a fraction, is a
multiplier for movement.
multiplier for movement.
For example,
specifying 3/1 means the pointer moves three times as fast as normal.
The fraction may be rounded arbitrarily by the X server.
The fraction may be rounded arbitrarily by the X server.
Acceleration
only takes effect if the pointer moves more than threshold pixels at
once and only applies to the amount beyond the value in the threshold argument.
Setting a value to \-1 restores the default.
The values of the do_accel and do_threshold arguments must be
The values of the do_accel and do_threshold arguments must be
.B True
for the pointer values to be set,
or the parameters are unchanged.

4
man/XChangeSaveSet.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -69,7 +69,7 @@ Specifies the window that you want to add or delete from the client's save-set.
.SH DESCRIPTION
Depending on the specified mode,
.B XChangeSaveSet
either inserts or deletes the specified window from the client's save-set.
either inserts or deletes the specified window from the client's save-set.
The specified window must have been created by some other client,
or a
.B BadMatch

42
man/XChangeWindowAttributes.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -56,7 +56,7 @@ int XSetWindowBackground\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, unsigne
.HP
int XSetWindowBackgroundPixmap\^(\^Display *\fIdisplay\fP\^, Window
\fIw\fP\^, Pixmap \fIbackground_pixmap\fP\^);
.HP
.HP
int XSetWindowBorder\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, unsigned long \fIborder_pixel\fP\^);
.HP
int XSetWindowBorderPixmap\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Pixmap \fIborder_pixmap\fP\^);
@ -76,7 +76,7 @@ Specifies the background pixmap,
or
.BR None .
.IP \fIborder_pixel\fP 1i
Specifies the entry in the colormap.
Specifies the entry in the colormap.
.IP \fIborder_pixmap\fP 1i
Specifies the border pixmap or
.BR CopyFromParent .
@ -101,13 +101,13 @@ function uses the window attributes in the
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
To repaint the window and its background, use
.BR XClearWindow .
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
Changing the background of a root window to
.B None
or
or
.B ParentRelative
restores the default background pixmap.
Changing the border of a root window to
@ -115,41 +115,41 @@ Changing the border of a root window to
restores the default border pixmap.
Changing the win-gravity does not affect the current position of the
window.
Changing the backing-store of an obscured window to
Changing the backing-store of an obscured window to
.B WhenMapped
or
.BR Always ,
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
changing the contents of the existing map) generates a
changing the contents of the existing map) generates a
.B ColormapNotify
event.
Changing the colormap of a visible window may have no
immediate effect on the screen because the map may not be installed
(see
.BR XInstallColormap ).
Changing the cursor of a root window to
Changing the cursor of a root window to
.B None
restores the default
cursor.
Whenever possible, you are encouraged to share colormaps.
.LP
Multiple clients can select input on the same window.
Multiple clients can select input on the same window.
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
When an event is generated,
it is reported to all interested clients.
However, only one client at a time can select for
.BR SubstructureRedirectMask ,
.BR ResizeRedirectMask ,
and
.BR ButtonPressMask .
If a client attempts to select any of these event masks
and some other client has already selected one,
If a client attempts to select any of these event masks
and some other client has already selected one,
a
.B BadAccess
error results.
There is only one do-not-propagate-mask for a window,
There is only one do-not-propagate-mask for a window,
not one per client.
.LP
.B XChangeWindowAttributes
@ -170,7 +170,7 @@ function sets the background of the window to the specified pixel value.
Changing the background does not cause the window contents to be changed.
.B XSetWindowBackground
uses a pixmap of undefined size filled with the pixel value you passed.
If you try to change the background of an
If you try to change the background of an
.B InputOnly
window, a
.B BadMatch
@ -188,12 +188,12 @@ The
function sets the background pixmap of the window to the specified pixmap.
The background pixmap can immediately be freed if no further explicit
references to it are to be made.
If
If
.B ParentRelative
is specified,
is specified,
the background pixmap of the window's parent is used,
or on the root window, the default background is restored.
If you try to change the background of an
If you try to change the background of an
.B InputOnly
window, a
.B BadMatch
@ -209,7 +209,7 @@ can generate
and
.B BadWindow
errors.
.LP
.LP
The
.B XSetWindowBorder
function sets the border of the window to the pixel value you specify.

2
man/XCirculateEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface

2
man/XCirculateRequestEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface

26
man/XClearArea.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -69,12 +69,12 @@ Specifies the window.
.ns
.IP \fIheight\fP 1i
Specify the width and height, which are the dimensions of the rectangle.
.ds Xy
.ds Xy
.IP \fIx\fP 1i
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are relative to the origin of the window
Specify the x and y coordinates, which are relative to the origin of the window
and specify the upper-left corner of the rectangle.
.SH DESCRIPTION
The
@ -87,16 +87,16 @@ If width is zero, it
is replaced with the current width of the window minus x.
If height is
zero, it is replaced with the current height of the window minus y.
If the window has a defined background tile,
If the window has a defined background tile,
the rectangle clipped by any children is filled with this tile.
If the window has
background
background
.BR None ,
the contents of the window are not changed.
the contents of the window are not changed.
In either
case, if exposures is
case, if exposures is
.BR True ,
one or more
one or more
.B Expose
events are generated for regions of the rectangle that are either visible or are
being retained in a backing store.
@ -119,21 +119,21 @@ The
function clears the entire area in the specified window and is
equivalent to
.B XClearArea
(display, w, 0, 0, 0, 0,
(display, w, 0, 0, 0, 0,
.BR False ).
If the window has a defined background tile, the rectangle is tiled with a
plane-mask of all ones and
plane-mask of all ones and
.B GXcopy
function.
If the window has
background
background
.BR None ,
the contents of the window are not changed.
the contents of the window are not changed.
If you specify a window whose class is
.BR InputOnly ,
a
.B BadMatch
error results.
error results.
.LP
.B XClearWindow
can generate

6
man/XClientMessageEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -92,12 +92,12 @@ but expanded from the 16-bit least-significant bits to a full 32-bit value.
The window member is set to the window that is most useful to toolkit
dispatchers.
.LP
The message_type member is set to an atom that indicates how the data
The message_type member is set to an atom that indicates how the data
should be interpreted by the receiving client.
The format member is set to 8, 16, or 32 and specifies whether the data
should be viewed as a list of bytes, shorts, or longs.
The data member is a union that contains the members b, s, and l.
The b, s, and l members represent data of twenty 8-bit values,
The b, s, and l members represent data of twenty 8-bit values,
ten 16-bit values, and five 32-bit values.
Particular message types might not make use of all these values.
The X server places no interpretation on the values in the window,

12
man/XColormapEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -88,17 +88,17 @@ but expanded from the 16-bit least-significant bits to a full 32-bit value.
The window member is set to the window that is most useful to toolkit
dispatchers.
.LP
The window member is set to the window whose associated
The window member is set to the window whose associated
colormap is changed, installed, or uninstalled.
For a colormap that is changed, installed, or uninstalled,
the colormap member is set to the colormap associated with the window.
the colormap member is set to the colormap associated with the window.
For a colormap that is changed by a call to
.BR XFreeColormap ,
the colormap member is set to
.BR None .
The new member is set to indicate whether the colormap
The new member is set to indicate whether the colormap
for the specified window was changed or installed or uninstalled
and can be
and can be
.B True
or
.BR False .
@ -109,7 +109,7 @@ If it is
.BR False ,
the colormap was installed or uninstalled.
The state member is always set to indicate whether the colormap is installed or
uninstalled and can be
uninstalled and can be
.B ColormapInstalled
or
.BR ColormapUninstalled .

14
man/XConfigureEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -97,29 +97,29 @@ depending on whether
or
.B SubstructureNotify
was selected.
The window member is set to the window whose size, position,
The window member is set to the window whose size, position,
border, and/or stacking
order was changed.
.LP
The x and y members are set to the coordinates relative to the parent window's
The x and y members are set to the coordinates relative to the parent window's
origin and indicate the position of the upper-left outside corner of the window.
The width and height members are set to the inside size of the window,
The width and height members are set to the inside size of the window,
not including
the border.
The border_width member is set to the width of the window's border, in pixels.
.LP
The above member is set to the sibling window and is used
The above member is set to the sibling window and is used
for stacking operations.
If the X server sets this member to
.BR None ,
the window whose state was changed is on the bottom of the stack
with respect to sibling windows.
However, if this member is set to a sibling window,
However, if this member is set to a sibling window,
the window whose state was changed is placed on top of this sibling window.
.LP
The override_redirect member is set to the override-redirect attribute of the
window.
Window manager clients normally should ignore this window if the
Window manager clients normally should ignore this window if the
override_redirect member
is
.BR True .

4
man/XConfigureRequestEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -93,7 +93,7 @@ The window member is set to the window that is most useful to toolkit
dispatchers.
.LP
The parent member is set to the parent window.
The window member is set to the window whose size, position, border width,
The window member is set to the window whose size, position, border width,
and/or stacking order is to be reconfigured.
The value_mask member indicates which components were specified in the
.B ConfigureWindow

56
man/XConfigureWindow.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -60,10 +60,10 @@ int XResizeWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, unsigned
\fIwidth\fP\^, unsigned \fIheight\fP\^);
.HP
int XMoveResizeWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int
\fIx\fP\^, int \fIy\fP\^, unsigned \fIwidth\fP\^, unsigned \fIheight\fP\^);
\fIx\fP\^, int \fIy\fP\^, unsigned \fIwidth\fP\^, unsigned \fIheight\fP\^);
.HP
int XSetWindowBorderWidth\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
unsigned \fIwidth\fP\^);
unsigned \fIwidth\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -72,7 +72,7 @@ Specifies which values are to be set using information in
the values structure.
This mask is the bitwise inclusive OR of the valid configure window values bits.
.IP \fIvalues\fP 1i
Specifies the
Specifies the
.B XWindowChanges
structure.
.IP \fIw\fP 1i
@ -88,8 +88,8 @@ Specify the width and height, which are the interior dimensions of the window.
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which define the new location of the top-left pixel
of the window's border or the window itself if it has no border
Specify the x and y coordinates, which define the new location of the top-left pixel
of the window's border or the window itself if it has no border
or define the new position of the window relative to its parent.
.SH DESCRIPTION
The
@ -103,7 +103,7 @@ If a sibling is specified without a stack_mode or if the window
is not actually a sibling,
a
.B BadMatch
error results.
error results.
Note that the computations for
.BR BottomIf ,
.BR TopIf ,
@ -115,7 +115,7 @@ other arguments passed to
not its initial geometry.
Any backing store contents of the window, its
inferiors, and other newly visible windows are either discarded or
changed to reflect the current screen contents
changed to reflect the current screen contents
(depending on the implementation).
.LP
.B XConfigureWindow
@ -131,26 +131,26 @@ The
function moves the specified window to the specified x and y coordinates,
but it does not change the window's size, raise the window, or
change the mapping state of the window.
Moving a mapped window may or may not lose the window's contents
depending on if the window is obscured by nonchildren
Moving a mapped window may or may not lose the window's contents
depending on if the window is obscured by nonchildren
and if no backing store exists.
If the contents of the window are lost,
If the contents of the window are lost,
the X server generates
.B Expose
events.
Moving a mapped window generates
.B Expose
events on any formerly obscured windows.
events on any formerly obscured windows.
.LP
If the override-redirect flag of the window is
If the override-redirect flag of the window is
.B False
and some
other client has selected
other client has selected
.B SubstructureRedirectMask
on the parent, the X server generates a
.B ConfigureRequest
event, and no further processing is
performed.
performed.
Otherwise, the window is moved.
.LP
.B XMoveWindow
@ -167,19 +167,19 @@ the origin and does not restack the window.
Changing the size of a mapped window may lose its contents and generate
.B Expose
events.
If a mapped window is made smaller,
If a mapped window is made smaller,
changing its size generates
.B Expose
events on windows that the mapped window formerly obscured.
.LP
If the override-redirect flag of the window is
If the override-redirect flag of the window is
.B False
and some
other client has selected
other client has selected
.B SubstructureRedirectMask
on the parent, the X server generates a
.B ConfigureRequest
event, and no further processing is performed.
event, and no further processing is performed.
If either width or height is zero,
a
.B BadValue
@ -194,24 +194,24 @@ errors.
.LP
The
.B XMoveResizeWindow
function changes the size and location of the specified window
function changes the size and location of the specified window
without raising it.
Moving and resizing a mapped window may generate an
.B Expose
event on the window.
Depending on the new size and location parameters,
moving and resizing a window may generate
moving and resizing a window may generate
.B Expose
events on windows that the window formerly obscured.
events on windows that the window formerly obscured.
.LP
If the override-redirect flag of the window is
If the override-redirect flag of the window is
.B False
and some
other client has selected
other client has selected
.B SubstructureRedirectMask
on the parent, the X server generates a
.B ConfigureRequest
event, and no further processing is performed.
event, and no further processing is performed.
Otherwise, the window size and location are changed.
.LP
.B XMoveResizeWindow
@ -317,16 +317,16 @@ If you attempt to set the border-width attribute of an
.B InputOnly
window nonzero, a
.B BadMatch
error results.
error results.
.LP
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
The stack_mode member is used to set how the window is to be restacked
and can be set to
.BR Above ,
.BR Below ,
.BR TopIf ,
.BR BottomIf ,
or
or
.BR Opposite .
.SH DIAGNOSTICS
.TP 1i

40
man/XCopyArea.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -58,13 +58,13 @@ int \fIwidth\fP\^, unsigned \fIheight\fP\^, int \fIdest_x\fP\^, int
int XCopyPlane\^(\^Display *\fIdisplay\fP\^, Drawable \fIsrc\fP\^, Drawable
\fIdest\fP\^, GC \fIgc\fP\^, int \fIsrc_x\fP\^, int \fIsrc_y\fP\^, unsigned
\fIwidth\fP\^, int \fIheight\fP\^, int \fIdest_x\fP\^, int \fIdest_y\fP\^,
unsigned long \fIplane\fP\^);
unsigned long \fIplane\fP\^);
.SH ARGUMENTS
.IP \fIdest_x\fP 1i
.br
.ns
.IP \fIdest_y\fP 1i
Specify the x and y coordinates, which are relative to the origin of the destination rectangle and specify its upper-left corner.
Specify the x and y coordinates, which are relative to the origin of the destination rectangle and specify its upper-left corner.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
@ -76,24 +76,24 @@ You must set exactly one bit to 1.
.br
.ns
.IP \fIdest\fP 1i
Specify the source and destination rectangles to be combined.
Specify the source and destination rectangles to be combined.
.IP \fIsrc_x\fP 1i
.br
.ns
.IP \fIsrc_y\fP 1i
Specify the x and y coordinates,
Specify the x and y coordinates,
which are relative to the origin of the source rectangle
and specify its upper-left corner.
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
Specify the width and height, which are the dimensions
Specify the width and height, which are the dimensions
of both the source and destination rectangles.
.SH DESCRIPTION
The
.B XCopyArea
function combines the specified rectangle of src with the specified rectangle
function combines the specified rectangle of src with the specified rectangle
of dest.
The drawables must have the same root and depth,
or a
@ -101,13 +101,13 @@ or a
error results.
.LP
If regions of the source rectangle are obscured and have not been
retained in backing store
or if regions outside the boundaries of the source drawable are specified,
those regions are not copied.
Instead, the
retained in backing store
or if regions outside the boundaries of the source drawable are specified,
those regions are not copied.
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
visible or are retained in backing store.
If the destination is a window with a background other than
.BR None ,
corresponding regions
of the destination are tiled with that background
@ -115,12 +115,12 @@ of the destination are tiled with that background
.B GXcopy
function).
Regardless of tiling or whether the destination is a window or a pixmap,
if graphics-exposures is
if graphics-exposures is
.BR True ,
then
.B GraphicsExpose
events for all corresponding destination regions are generated.
If graphics-exposures is
If graphics-exposures is
.B True
but no
.B GraphicsExpose
@ -131,7 +131,7 @@ Note that by default graphics-exposures is
.B True
in new GCs.
.LP
This function uses these GC components: function, plane-mask,
This function uses these GC components: function, plane-mask,
subwindow-mode, graphics-exposures, clip-x-origin,
clip-y-origin, and clip-mask.
.LP
@ -156,17 +156,17 @@ is not less than %2 sup n%, where \fIn\fP is the depth of src, a
.B BadValue
error results.
.LP
Effectively,
Effectively,
.B XCopyPlane
forms a pixmap of the same depth as the rectangle of dest and with a
size specified by the source region.
size specified by the source region.
It uses the foreground/background pixels in the GC (foreground
everywhere the bit plane in src contains a bit set to 1,
background everywhere the bit plane in src contains a bit set to 0)
and the equivalent of a
and the equivalent of a
.B CopyArea
protocol request is performed with all the same exposure semantics.
This can also be thought of as using the specified region of the source
This can also be thought of as using the specified region of the source
bit plane as a stipple with a fill-style of
.B FillOpaqueStippled
for filling a rectangular area of the destination.

36
man/XCreateColormap.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -54,15 +54,15 @@ Colormap XCreateColormap\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
Visual *\fIvisual\fP\^, int \fIalloc\fP\^);
.HP
Colormap XCopyColormapAndFree\^(\^Display *\fIdisplay\fP\^, Colormap
\fIcolormap\fP\^);
\fIcolormap\fP\^);
.HP
int XFreeColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^);
int XFreeColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^);
.SH ARGUMENTS
.IP \fIalloc\fP 1i
Specifies the colormap entries to be allocated.
You can pass
You can pass
.B AllocNone
or
or
.BR AllocAll .
.IP \fIcolormap\fP 1i
Specifies the colormap that you want to create, copy, set, or destroy.
@ -70,7 +70,7 @@ Specifies the colormap that you want to create, copy, set, or destroy.
Specifies the connection to the X server.
.IP \fIvisual\fP 1i
Specifies a visual type supported on the screen.
If the visual type is not one supported by the screen,
If the visual type is not one supported by the screen,
a
.B BadMatch
error results.
@ -79,12 +79,12 @@ Specifies the window on whose screen you want to create a colormap.
.SH DESCRIPTION
The
.B XCreateColormap
function creates a colormap of the specified visual type for the screen
on which the specified window resides and returns the colormap ID
function creates a colormap of the specified visual type for the screen
on which the specified window resides and returns the colormap ID
associated with it.
Note that the specified window is only used to determine the screen.
.LP
The initial values of the colormap entries are undefined for the
The initial values of the colormap entries are undefined for the
visual classes
.BR GrayScale ,
.BR PseudoColor ,
@ -131,7 +131,7 @@ For
.BR DirectColor ,
the effect is as if an
.B XAllocColorPlanes
call returned a pixel value of zero and red_mask, green_mask,
call returned a pixel value of zero and red_mask, green_mask,
and blue_mask values containing the same bits as the corresponding
masks in the specified visual.
However, in all cases,
@ -152,13 +152,13 @@ The
function creates a colormap of the same visual type and for the same screen
as the specified colormap and returns the new colormap ID.
It also moves all of the client's existing allocation from the specified
colormap to the new colormap with their color values intact
and their read-only or writable characteristics intact and frees those entries
colormap to the new colormap with their color values intact
and their read-only or writable characteristics intact and frees those entries
in the specified colormap.
Color values in other entries in the new colormap are undefined.
If the specified colormap was created by the client with alloc set to
.BR AllocAll ,
the new colormap is also created with
the new colormap is also created with
.BR AllocAll ,
all color values for all entries are copied from the specified colormap,
and then all entries in the specified colormap are freed.
@ -182,7 +182,7 @@ errors.
.LP
The
.B XFreeColormap
function deletes the association between the colormap resource ID
function deletes the association between the colormap resource ID
and the colormap and frees the colormap storage.
However, this function has no effect on the default colormap for a screen.
If the specified colormap is an installed map for a screen,
@ -215,7 +215,7 @@ structure contains:
typedef struct {
unsigned long pixel; /\&* pixel value */
unsigned short red, green, blue; /\&* rgb values */
char flags; /\&* DoRed, DoGreen, DoBlue */
char flags; /\&* DoRed, DoGreen, DoBlue */
char pad;
} XColor;
.EE
@ -224,15 +224,15 @@ The red, green, and blue values are always in the range 0 to 65535
inclusive, independent of the number of bits actually used in the
display hardware.
The server scales these values down to the range used by the hardware.
Black is represented by (0,0,0),
Black is represented by (0,0,0),
and white is represented by (65535,65535,65535).
.IN "Color"
In some functions,
the flags member controls which of the red, green, and blue members is used
the flags member controls which of the red, green, and blue members is used
and can be the inclusive OR of zero or more of
.BR DoRed ,
.BR DoGreen ,
and
and
.BR DoBlue .
.SH DIAGNOSTICS
.TP 1i

36
man/XCreateFontCursor.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,7 +52,7 @@ XCreateFontCursor, XCreatePixmapCursor, XCreateGlyphCursor \- create cursors
\&#include <X11/cursorfont.h>
.HP
Cursor XCreateFontCursor\^(\^Display *\fIdisplay\fP\^, unsigned int
\fIshape\fP\^);
\fIshape\fP\^);
.HP
Cursor XCreatePixmapCursor\^(\^Display *\fIdisplay\fP\^, Pixmap
\fIsource\fP\^, Pixmap \fImask\fP\^, XColor *\fIforeground_color\fP\^, XColor
@ -61,19 +61,19 @@ Cursor XCreatePixmapCursor\^(\^Display *\fIdisplay\fP\^, Pixmap
Cursor XCreateGlyphCursor\^(\^Display *\fIdisplay\fP\^, Font
\fIsource_font\fP\^, Font \fImask_font\fP\^, unsigned int \fIsource_char\fP\^,
unsigned int \fImask_char\fP\^, XColor *\fIforeground_color\fP\^, XColor
*\fIbackground_color\fP\^);
*\fIbackground_color\fP\^);
.SH ARGUMENTS
.IP \fIbackground_color\fP 1i
Specifies the RGB values for the background of the source.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIforeground_color\fP 1i
Specifies the RGB values for the foreground of the source.
Specifies the RGB values for the foreground of the source.
.IP \fImask\fP 1i
Specifies the cursor's source bits to be displayed or
.BR None .
.IP \fImask_char\fP 1i
Specifies the glyph character for the mask.
Specifies the glyph character for the mask.
.IP \fImask_font\fP 1i
Specifies the font for the mask glyph or
.BR None .
@ -90,7 +90,7 @@ Specifies the font for the source glyph.
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which indicate the
Specify the x and y coordinates, which indicate the
hotspot relative to the source's origin.
.SH DESCRIPTION
X provides a set of standard cursor shapes in a special font named
@ -124,15 +124,15 @@ or
screen.
The foreground color is used for the pixels set to 1 in the
source, and the background color is used for the pixels set to 0.
Both source and mask, if specified, must have depth one (or a
Both source and mask, if specified, must have depth one (or a
.B BadMatch
error results) but can have any root.
The mask argument defines the shape of the cursor.
The pixels set to 1 in the mask define which source pixels are displayed,
and the pixels set to 0 define which pixels are ignored.
If no mask is given,
If no mask is given,
all pixels of the source are displayed.
The mask, if present, must be the same size as the pixmap defined by the
The mask, if present, must be the same size as the pixmap defined by the
source argument, or a
.B BadMatch
error results.
@ -160,31 +160,31 @@ The
.B XCreateGlyphCursor
function is similar to
.B XCreatePixmapCursor
except that the source and mask bitmaps are obtained from the specified
except that the source and mask bitmaps are obtained from the specified
font glyphs.
The source_char must be a defined glyph in source_font,
The source_char must be a defined glyph in source_font,
or a
.B BadValue
error results.
If mask_font is given,
If mask_font is given,
mask_char must be a defined glyph in mask_font,
or a
.B BadValue
error results.
The mask_font and character are optional.
The origins of the source_char and mask_char (if defined) glyphs are
positioned coincidently and define the hotspot.
The source_char and mask_char need not have the same bounding box metrics,
positioned coincidently and define the hotspot.
The source_char and mask_char need not have the same bounding box metrics,
and there is no restriction on the placement of the hotspot relative to the bounding
boxes.
boxes.
If no mask_char is given, all pixels of the source are displayed.
You can free the fonts immediately by calling
.B XFreeFont
if no further explicit references to them are to be made.
if no further explicit references to them are to be made.
.LP
For 2-byte matrix fonts,
For 2-byte matrix fonts,
the 16-bit value should be formed with the byte1
member in the most significant byte and the byte2 member in the
member in the most significant byte and the byte2 member in the
least significant byte.
.LP
.B XCreateGlyphCursor

56
man/XCreateFontSet.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -54,7 +54,7 @@ XFontSet XCreateFontSet\^(\^Display *\fIdisplay\fP\^, char
*\fIbase_font_name_list\fP\^, char ***\fImissing_charset_list_return\fP\^, int
*\fImissing_charset_count_return\fP\^, char **\fIdef_string_return\fP\^);
.HP
void XFreeFontSet\^(\^Display *\fIdisplay\fP\^, XFontSet \fIfont_set\fP\^);
void XFreeFontSet\^(\^Display *\fIdisplay\fP\^, XFontSet \fIfont_set\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -69,10 +69,10 @@ Returns the number of missing charsets.
.IP \fImissing_charset_list_return\fP 1i
Returns the missing charsets.
.SH DESCRIPTION
The
The
.B XCreateFontSet
function creates a font set for the specified display.
The font set is bound to the current locale when
The font set is bound to the current locale when
.B XCreateFontSet
is called.
The font set may be used in subsequent calls to obtain font
@ -82,7 +82,7 @@ The base_font_name_list argument is a list of base font names
that Xlib uses to load the fonts needed for the locale.
The base font names are a comma-separated list.
The string is null-terminated
and is assumed to be in the Host Portable Character Encoding;
and is assumed to be in the Host Portable Character Encoding;
otherwise, the result is implementation-dependent.
White space immediately on either side of a separating comma is ignored.
.LP
@ -103,17 +103,17 @@ If this action is successful in obtaining an XLFD name, the
function will return this XLFD name instead of the client-supplied name.
.LP
Xlib uses the following algorithm to select the fonts
that will be used to display text with the
that will be used to display text with the
.BR XFontSet .
.LP
For each font charset required by the locale,
the base font name list is searched for the first appearance of one
the base font name list is searched for the first appearance of one
of the following cases that names a set of fonts that exist at the server:
.IP \(bu 5
The first XLFD-conforming base font name that specifies the required
charset or a superset of the required charset in its
charset or a superset of the required charset in its
.B CharSetRegistry
and
and
.B CharSetEncoding
fields.
The implementation may use a base font name whose specified charset
@ -123,17 +123,17 @@ an ISO8859-1 font for an ASCII charset.
The first set of one or more XLFD-conforming base font names
that specify one or more charsets that can be remapped to support the
required charset.
The Xlib implementation may recognize various mappings
The Xlib implementation may recognize various mappings
from a required charset to one or more other charsets
and use the fonts for those charsets.
For example, JIS Roman is ASCII with tilde and backslash replaced
For example, JIS Roman is ASCII with tilde and backslash replaced
by yen and overbar;
Xlib may load an ISO8859-1 font to support this character set
if a JIS Roman font is not available.
.IP \(bu 5
The first XLFD-conforming font name or the first non-XLFD font name
for which an XLFD font name can be obtained, combined with the
required charset (replacing the
required charset (replacing the
.B CharSetRegistry
and
.B CharSetEncoding
@ -186,9 +186,9 @@ For example:
"-*-*-*-R-Normal--*-180-100-100-*-*"
.EE
.LP
If
If
.B XCreateFontSet
is unable to create the font set,
is unable to create the font set,
either because there is insufficient memory or because the current locale
is not supported,
.B XCreateFontSet
@ -213,12 +213,12 @@ may be able to remap a required charset.
.LP
If no font exists for any of the required charsets
or if the locale definition in Xlib requires that a font exist
for a particular charset and a font is not found for that charset,
for a particular charset and a font is not found for that charset,
.B XCreateFontSet
returns NULL.
Otherwise,
Otherwise,
.B XCreateFontSet
returns a valid
returns a valid
.B XFontSet
to font_set.
.LP
@ -229,24 +229,24 @@ drawable.
If def_string_return is non-NULL,
.B XCreateFontSet
returns a pointer to a string that represents the glyphs
that are drawn with this
that are drawn with this
.B XFontSet
when the charsets of the available fonts do not include all font glyphs
required to draw a codepoint.
The string does not necessarily consist of valid characters
The string does not necessarily consist of valid characters
in the current locale and is not necessarily drawn with
the fonts loaded for the font set,
but the client can draw and measure the default glyphs
by including this string in a string being drawn or measured with the
by including this string in a string being drawn or measured with the
.BR XFontSet .
.LP
If the string returned to def_string_return is the empty string ("\^"),
no glyphs are drawn, and the escapement is zero.
The returned string is null-terminated.
It is owned by Xlib and should not be modified or freed by the client.
It will be freed by a call to
It will be freed by a call to
.B XFreeFontSet
with the associated
with the associated
.BR XFontSet .
Until freed, its contents will not be modified by Xlib.
.LP
@ -254,23 +254,23 @@ The client is responsible for constructing an error message from the
missing charset and default string information and may choose to continue
operation in the case that some fonts did not exist.
.LP
The returned
The returned
.B XFontSet
and missing charset list should be freed with
and missing charset list should be freed with
.B XFreeFontSet
and
.BR XFreeStringList ,
respectively.
The client-supplied base_font_name_list may be freed
by the client after calling
The client-supplied base_font_name_list may be freed
by the client after calling
.BR XCreateFontSet .
.LP
The
.B XFreeFontSet
function frees the specified font set.
The associated base font name list, font name list,
The associated base font name list, font name list,
.B XFontStruct
list, and
list, and
.BR XFontSetExtents ,
if any, are freed.
.SH "SEE ALSO"

158
man/XCreateGC.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,23 +53,23 @@ XCreateGC, XCopyGC, XChangeGC, XGetGCValues, XFreeGC, XGContextFromGC, XGCValues
.SH SYNTAX
.HP
GC XCreateGC\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, unsigned long
\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^);
\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^);
.HP
int XCopyGC\^(\^Display *\fIdisplay\fP\^, GC \fIsrc\fP\^,
unsigned long \fIvaluemask\fP\^, GC \fIdest\fP\^);
unsigned long \fIvaluemask\fP\^, GC \fIdest\fP\^);
.HP
int XChangeGC\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long
\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^);
\fIvaluemask\fP\^, XGCValues *\^\fIvalues\fP\^);
.HP
Status XGetGCValues\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, unsigned long
\fIvaluemask\fP\^, XGCValues *\fIvalues_return\fP\^);
\fIvaluemask\fP\^, XGCValues *\fIvalues_return\fP\^);
.HP
int XFreeGC\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^);
int XFreeGC\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^);
.HP
GContext XGContextFromGC\^(\^GC \fIgc\fP\^);
GContext XGContextFromGC\^(\^GC \fIgc\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdest\fP 1i
Specifies the destination GC.
.IP \fIdisplay\fP 1i
@ -79,7 +79,7 @@ Specifies the GC.
.IP \fIsrc\fP 1i
Specifies the components of the source GC.
.IP \fIvaluemask\fP 1i
Specifies which components in the GC are to be set, copied, changed, or returned.
Specifies which components in the GC are to be set, copied, changed, or returned.
This argument is the bitwise inclusive OR of zero or more of the valid
GC component mask bits.
.IP \fIvalues\fP 1i
@ -133,13 +133,13 @@ The
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
The values and restrictions are the same as for
.BR XCreateGC .
Changing the clip-mask overrides any previous
Changing the clip-mask overrides any previous
.B XSetClipRectangles
request on the context.
request on the context.
Changing the dash-offset or dash-list
overrides any previous
overrides any previous
.B XSetDashes
request on the context.
The order in which components are verified and altered is server dependent.
@ -188,7 +188,7 @@ sets the requested components in values_return and returns a nonzero status.
Otherwise, it returns a zero status.
Note that the clip-mask and dash-list (represented by the
.B GCClipMask
and
and
.B GCDashList
bits, respectively, in the valuemask)
cannot be requested.
@ -365,17 +365,17 @@ typedef struct {
.EE
.LP
The function attributes of a GC are used when you update a section of
a drawable (the destination) with bits from somewhere else (the source).
a drawable (the destination) with bits from somewhere else (the source).
The function in a GC defines how the new destination bits are to be
computed from the source bits and the old destination bits.
.B GXcopy
is typically the most useful because it will work on a color display,
but special applications may use other functions,
particularly in concert with particular planes of a color display.
The 16 GC functions, defined in
The 16 GC functions, defined in
.hN X11/X.h ,
are:
.\" are listed in Table 5-1 along with the
.\" are listed in Table 5-1 along with the
.\"the associated hexadecimal code
.\" and operation.
.\".CP T 1
@ -515,16 +515,16 @@ will be the least significant bit of the word.
As planes are added to the display hardware, they will occupy more
significant bits in the plane mask.
.LP
In graphics operations, given a source and destination pixel,
In graphics operations, given a source and destination pixel,
the result is computed bitwise on corresponding bits of the pixels.
That is, a Boolean operation is performed in each bit plane.
That is, a Boolean operation is performed in each bit plane.
The plane_mask restricts the operation to a subset of planes.
A macro constant
.B AllPlanes
can be used to refer to all planes of the screen simultaneously.
The result is computed by the following:
.LP
.EX
.EX
((src FUNC dst) AND plane-mask) OR (dst AND (NOT plane-mask))
.EE
.LP
@ -554,28 +554,28 @@ If the center of the pixel is exactly on the bounding box,
it is part of the line if and only if the interior is immediately to its right
(x increasing direction).
Pixels with centers on a horizontal edge are a special case and are part of
the line if and only if the interior or the boundary is immediately below
the line if and only if the interior or the boundary is immediately below
(y increasing direction) and the interior or the boundary is immediately
to the right (x increasing direction).
.LP
Thin lines (zero line-width) are one-pixel-wide lines drawn using an
unspecified, device-dependent algorithm.
There are only two constraints on this algorithm.
There are only two constraints on this algorithm.
.IP 1. 5
If a line is drawn unclipped from [x1,y1] to [x2,y2] and
if another line is drawn unclipped from [x1+dx,y1+dy] to [x2+dx,y2+dy],
a point [x,y] is touched by drawing the first line
a point [x,y] is touched by drawing the first line
if and only if the point [x+dx,y+dy] is touched by drawing the second line.
.IP 2. 5
The effective set of points comprising a line cannot be affected by clipping.
That is, a point is touched in a clipped line if and only if the point
That is, a point is touched in a clipped line if and only if the point
lies inside the clipping region and the point would be touched
by the line when drawn unclipped.
.LP
A wide line drawn from [x1,y1] to [x2,y2] always draws the same pixels
as a wide line drawn from [x2,y2] to [x1,y1], not counting cap-style
A wide line drawn from [x1,y1] to [x2,y2] always draws the same pixels
as a wide line drawn from [x2,y2] to [x1,y1], not counting cap-style
and join-style.
It is recommended that this property be true for thin lines,
It is recommended that this property be true for thin lines,
but this is not required.
A line-width of zero may differ from a line-width of one in which pixels are
drawn.
@ -583,7 +583,7 @@ This permits the use of many manufacturers' line drawing hardware,
which may run many times faster than the more precisely specified
wide lines.
.LP
In general,
In general,
drawing a thin line will be faster than drawing a wide line of width one.
However, because of their different drawing algorithms,
thin lines may not mix well aesthetically with wide lines.
@ -602,8 +602,8 @@ T}
T{
.B LineDoubleDash
T} T{
The full path of the line is drawn,
but the even dashes are filled differently
The full path of the line is drawn,
but the even dashes are filled differently
from the odd dashes (see fill-style) with
.B CapButt
style used where even and odd dashes meet.
@ -613,11 +613,11 @@ T{
.B LineOnOffDash
T} T{
Only the even dashes are drawn,
and cap-style applies to
and cap-style applies to
all internal ends of the individual dashes,
except
except
.B CapNotLast
is treated as
is treated as
.BR CapButt .
T}
.TE
@ -629,7 +629,7 @@ lw(1.3i) lw(4.5i).
T{
.B CapNotLast
T} T{
This is equivalent to
This is equivalent to
.B CapButt
except that for a line-width of zero the final endpoint is not drawn.
T}
@ -646,7 +646,7 @@ T{
T} T{
The line has a circular arc with the diameter equal to the line-width,
centered on the endpoint.
(This is equivalent to
(This is equivalent to
.B CapButt
for line-width of zero).
T}
@ -654,9 +654,9 @@ T}
T{
.B CapProjecting
T} T{
The line is square at the end, but the path continues beyond the endpoint
The line is square at the end, but the path continues beyond the endpoint
for a distance equal to half the line-width.
(This is equivalent to
(This is equivalent to
.B CapButt
for line-width of zero).
T}
@ -678,7 +678,7 @@ T}
T{
.B JoinRound
T} T{
The corner is a circular arc with the diameter equal to the line-width,
The corner is a circular arc with the diameter equal to the line-width,
centered on the joinpoint.
T}
.sp 6p
@ -691,8 +691,8 @@ endpoint styles with the triangular notch filled.
T}
.TE
.LP
For a line with coincident endpoints (x1=x2, y1=y2),
when the cap-style is applied to both endpoints,
For a line with coincident endpoints (x1=x2, y1=y2),
when the cap-style is applied to both endpoints,
the semantics depends on the line-width and the cap-style:
.TS
lw(1.3i) lw(.5i) lw(4i).
@ -701,7 +701,7 @@ T{
T} T{
thin
T} T{
The results are device dependent,
The results are device dependent,
but the desired effect is that nothing is drawn.
T}
.sp 6p
@ -710,7 +710,7 @@ T{
T} T{
thin
T} T{
The results are device dependent,
The results are device dependent,
but the desired effect is that a single pixel is drawn.
T}
.sp 6p
@ -759,8 +759,8 @@ endpoint, and with the sides equal to the line-width.
T}
.TE
.LP
For a line with coincident endpoints (x1=x2, y1=y2),
when the join-style is applied at one or both endpoints,
For a line with coincident endpoints (x1=x2, y1=y2),
when the join-style is applied at one or both endpoints,
the effect is as if the line was removed from the overall path.
However, if the total path consists of or is reduced to a single point joined
with itself, the effect is the same as when the cap-style is applied at both
@ -780,12 +780,12 @@ or a
.B BadMatch
error results.
The stipple pixmap must have depth one and must have the same root as the
GC, or a
GC, or a
.B BadMatch
error results.
error results.
For stipple operations where the fill-style is
.B FillStippled
but not
but not
.BR FillOpaqueStippled ,
the stipple pattern is tiled in a
single plane and acts as an additional clip mask to be ANDed with the clip-mask.
@ -793,7 +793,7 @@ Although some sizes may be faster to use than others,
any size pixmap can be used for tiling or stippling.
.LP
The fill-style defines the contents of the source for line, text, and
fill requests.
fill requests.
For all text and fill requests (for example,
.BR XDrawText ,
.BR XDrawText16 ,
@ -801,17 +801,17 @@ For all text and fill requests (for example,
.BR XFillPolygon ,
and
.BR XFillArc );
for line requests
with line-style
for line requests
with line-style
.B LineSolid
(for example,
.BR XDrawLine ,
.BR XDrawSegments ,
.BR XDrawRectangle ,
.BR XDrawArc );
and for the even dashes for line requests with line-style
and for the even dashes for line requests with line-style
.B LineOnOffDash
or
or
.BR LineDoubleDash ,
the following apply:
.TS
@ -882,7 +882,7 @@ a destination and as a tile or stipple,
the results are undefined.
.LP
For optimum performance,
you should draw as much as possible with the same GC
you should draw as much as possible with the same GC
(without changing its components).
The costs of changing GC components relative to using different GCs
depend on the display hardware and the server implementation.
@ -891,17 +891,17 @@ cached in display hardware and that such hardware can only cache a small number
of GCs.
.LP
The dashes value is actually a simplified form of the
more general patterns that can be set with
more general patterns that can be set with
.BR XSetDashes .
Specifying a
value of N is equivalent to specifying the two-element list [N, N] in
value of N is equivalent to specifying the two-element list [N, N] in
.BR XSetDashes .
The value must be nonzero,
or a
.B BadValue
error results.
.LP
The clip-mask restricts writes to the destination drawable.
The clip-mask restricts writes to the destination drawable.
If the clip-mask is set to a pixmap,
it must have depth one and have the same root as the GC,
or a
@ -915,8 +915,8 @@ The clip-mask also can be set by calling the
or
.B XSetRegion
functions.
Only pixels where the clip-mask has a bit set to 1 are drawn.
Pixels are not drawn outside the area covered by the clip-mask
Only pixels where the clip-mask has a bit set to 1 are drawn.
Pixels are not drawn outside the area covered by the clip-mask
or where the clip-mask has a bit set to 0.
The clip-mask affects all graphics requests.
The clip-mask does not clip sources.
@ -927,27 +927,27 @@ You can set the subwindow-mode to
.B ClipByChildren
or
.BR IncludeInferiors .
For
For
.BR ClipByChildren ,
both source and destination windows are
additionally clipped by all viewable
additionally clipped by all viewable
.B InputOutput
children.
For
children.
For
.BR IncludeInferiors ,
neither source nor destination window is clipped by inferiors.
neither source nor destination window is clipped by inferiors.
This will result in including subwindow contents in the source
and drawing through subwindow boundaries of the destination.
The use of
The use of
.B IncludeInferiors
on a window of one depth with mapped
inferiors of differing depth is not illegal, but the semantics are
undefined by the core protocol.
.LP
The fill-rule defines what pixels are inside (drawn) for
paths given in
paths given in
.B XFillPolygon
requests and can be set to
requests and can be set to
.B EvenOddRule
or
.BR WindingRule .
@ -955,8 +955,8 @@ For
.BR EvenOddRule ,
a point is inside if
an infinite ray with the point as origin crosses the path an odd number
of times.
For
of times.
For
.BR WindingRule ,
a point is inside if an infinite ray with the
point as origin crosses an unequal number of clockwise and
@ -969,22 +969,22 @@ The case where a directed line segment is coincident with the ray is
uninteresting because you can simply choose a different ray that is not
coincident with a segment.
.LP
For both
For both
.B EvenOddRule
and
.BR WindingRule ,
a point is infinitely small,
and the path is an infinitely thin line.
a point is infinitely small,
and the path is an infinitely thin line.
A pixel is inside if the center point of the pixel is inside
and the center point is not on the boundary.
and the center point is not on the boundary.
If the center point is on the boundary,
the pixel is inside if and only if the polygon interior is immediately to
its right (x increasing direction).
Pixels with centers on a horizontal edge are a special case
and are inside if and only if the polygon interior is immediately below
its right (x increasing direction).
Pixels with centers on a horizontal edge are a special case
and are inside if and only if the polygon interior is immediately below
(y increasing direction).
.LP
The arc-mode controls filling in the
The arc-mode controls filling in the
.B XFillArcs
function and can be set to
.B ArcPieSlice
@ -997,12 +997,12 @@ For
.BR ArcChord ,
the arcs are chord filled.
.LP
The graphics-exposure flag controls
The graphics-exposure flag controls
.B GraphicsExpose
event generation
for
for
.B XCopyArea
and
and
.B XCopyPlane
requests (and any similar requests defined by extensions).
.SH DIAGNOSTICS

6
man/XCreateIC.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,9 +50,9 @@
XCreateIC, XDestroyIC, XIMOfIC \- create, destroy, and obtain the input method of an input context
.SH SYNTAX
.HP
XIC XCreateIC\^(\^XIM \fIim\fP\^, ...\^);
XIC XCreateIC\^(\^XIM \fIim\fP\^, ...\^);
.HP
void XDestroyIC\^(\^XIC \fIic\fP\^);
void XDestroyIC\^(\^XIC \fIic\fP\^);
.HP
XIM XIMOfIC\^(\^XIC \fIic\fP\^);
.SH ARGUMENTS

14
man/XCreateOC.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,15 +50,15 @@
XCreateOC, XDestroyOC, XSetOCValues, XGetOCValues, XOMOfOC \- create output contexts
.SH SYNTAX
.HP
XOC XCreateOC\^(\^XOM \fIom\fP\^);
XOC XCreateOC\^(\^XOM \fIom\fP\^);
.HP
void XDestroyOC\^(\^XOC \fIoc\fP\^);
void XDestroyOC\^(\^XOC \fIoc\fP\^);
.HP
char * XSetOCValues\^(\^XOC \fIoc\fP\^, ...);
char * XSetOCValues\^(\^XOC \fIoc\fP\^, ...);
.HP
char * XGetOCValues\^(\^XOC \fIoc\fP\^, ...);
char * XGetOCValues\^(\^XOC \fIoc\fP\^, ...);
.HP
XOM XOMOfOC\^(\^XOC \fIoc\fP\^);
XOM XOMOfOC\^(\^XOC \fIoc\fP\^);
.SH ARGUMENTS
.IP \fIoc\fP 1i
Specifies the output context.
@ -93,7 +93,7 @@ function destroys the specified output context.
.LP
The
.B XSetOCValues
function returns NULL if no error occurred;
function returns NULL if no error occurred;
otherwise,
it returns the name of the first argument that could not be set.
An argument might not be set for any of the following reasons:

12
man/XCreatePixmap.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,12 +52,12 @@ XCreatePixmap, XFreePixmap \- create or destroy pixmaps
.HP
Pixmap XCreatePixmap\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^,
unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int
\fIdepth\fP\^);
\fIdepth\fP\^);
.HP
int XFreePixmap\^(\^Display *\fIdisplay\fP\^, Pixmap \fIpixmap\fP\^);
int XFreePixmap\^(\^Display *\fIdisplay\fP\^, Pixmap \fIpixmap\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies which screen the pixmap is created on.
Specifies which screen the pixmap is created on.
.IP \fIdepth\fP 1i
Specifies the depth of the pixmap.
.IP \fIdisplay\fP 1i
@ -74,11 +74,11 @@ The
.B XCreatePixmap
function creates a pixmap of the width, height, and depth you specified
and returns a pixmap ID that identifies it.
It is valid to pass an
It is valid to pass an
.B InputOnly
window to the drawable argument.
The width and height arguments must be nonzero,
or a
or a
.B BadValue
error results.
The depth argument must be one of the depths supported by the screen

6
man/XCreateRegion.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,11 +50,11 @@
XCreateRegion, XSetRegion, XDestroyRegion \- create or destroy regions
.SH SYNTAX
.HP
Region XCreateRegion\^(void\^);
Region XCreateRegion\^(void\^);
.HP
int XSetRegion\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Region \fIr\fP\^);
.HP
int XDestroyRegion\^(\^Region \fIr\fP\^);
int XDestroyRegion\^(\^Region \fIr\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.

46
man/XCreateWindow.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,9 +52,9 @@
XCreateWindow, XCreateSimpleWindow, XSetWindowAttributes \- create windows and window attributes structure
.SH SYNTAX
.HP
Window XCreateWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, int \fIdepth\fP\^, unsigned int \fIclass\fP\^, Visual *\fIvisual\fP\^, unsigned long \fIvaluemask\fP\^, XSetWindowAttributes *\fIattributes\fP\^);
Window XCreateWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, int \fIdepth\fP\^, unsigned int \fIclass\fP\^, Visual *\fIvisual\fP\^, unsigned long \fIvaluemask\fP\^, XSetWindowAttributes *\fIattributes\fP\^);
.HP
Window XCreateSimpleWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, unsigned long \fIborder\fP\^, unsigned long \fIbackground\fP\^);
Window XCreateSimpleWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, unsigned long \fIborder\fP\^, unsigned long \fIbackground\fP\^);
.SH ARGUMENTS
.IP \fIattributes\fP 1i
Specifies the structure from which the values (as specified by the value mask)
@ -73,15 +73,15 @@ Specifies the created window's class.
You can pass
.BR InputOutput ,
.BR InputOnly ,
or
or
.BR CopyFromParent .
A class of
A class of
.B CopyFromParent
means the class
is taken from the parent.
.IP \fIdepth\fP 1i
Specifies the window's depth.
A depth of
A depth of
.B CopyFromParent
means the depth is taken from the parent.
.IP \fIdisplay\fP 1i
@ -96,32 +96,32 @@ If valuemask is zero,
the attributes are ignored and are not referenced.
.IP \fIvisual\fP 1i
Specifies the visual type.
A visual of
A visual of
.B CopyFromParent
means the visual type is taken from the
means the visual type is taken from the
parent.
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
Specify the width and height, which are the created window's inside dimensions
Specify the width and height, which are the created window's inside dimensions
and do not include the created window's borders.
.IP \fIx\fP 1i
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are the top-left outside
corner of the window's
Specify the x and y coordinates, which are the top-left outside
corner of the window's
borders and are relative to the inside of the parent window's borders.
.SH DESCRIPTION
The
.B XCreateWindow
function creates an unmapped subwindow for a specified parent window,
returns the window ID of the created window,
function creates an unmapped subwindow for a specified parent window,
returns the window ID of the created window,
and causes the X server to generate a
.B CreateNotify
event.
The created window is placed on top in the stacking order
The created window is placed on top in the stacking order
with respect to siblings.
.LP
The coordinate system has the X axis horizontal and the Y axis vertical
@ -130,7 +130,7 @@ Coordinates are integral,
in terms of pixels,
and coincide with pixel centers.
Each window and pixmap has its own coordinate system.
For a window,
For a window,
the origin is inside the border at the inside, upper-left corner.
.LP
The border_width for an
@ -145,7 +145,7 @@ or a
.B BadMatch
error results.
The depth need not be the same as the parent,
but the parent must not be a window of class
but the parent must not be a window of class
.BR InputOnly ,
or a
.B BadMatch
@ -167,11 +167,11 @@ The created window is not yet displayed (mapped) on the user's display.
To display the window, call
.BR XMapWindow .
The new window initially uses the same cursor as
its parent.
its parent.
A new cursor can be defined for the new window by calling
.BR XDefineCursor .
.IN "Cursor" "Initial State"
.IN "XDefineCursor"
.IN "XDefineCursor"
The window will not be visible on the screen unless it and all of its
ancestors are mapped and it is not obscured by any of its ancestors.
.LP
@ -195,7 +195,7 @@ subwindow for a specified parent window, returns the
window ID of the created window, and causes the X server to generate a
.B CreateNotify
event.
The created window is placed on top in the stacking order with respect to
The created window is placed on top in the stacking order with respect to
siblings.
Any part of the window that extends outside its parent window is clipped.
The border_width for an
@ -205,7 +205,7 @@ window must be zero, or a
error results.
.B XCreateSimpleWindow
inherits its depth, class, and visual from its parent.
All other window attributes, except background and border,
All other window attributes, except background and border,
have their default values.
.LP
.B XCreateSimpleWindow
@ -389,10 +389,10 @@ alternatives can generate this error.
A value for a Window argument does not name a defined Window.
.SH "SEE ALSO"
XChangeWindowAttributes(__libmansuffix__),
XConfigureWindow(__libmansuffix__),
XConfigureWindow(__libmansuffix__),
.EEfineCursor(__libmansuffix__),
.EEstroyWindow(__libmansuffix__),
XMapWindow(__libmansuffix__),
.EEstroyWindow(__libmansuffix__),
XMapWindow(__libmansuffix__),
XRaiseWindow(__libmansuffix__),
XUnmapWindow(__libmansuffix__)
.br

10
man/XCreateWindowEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -92,15 +92,15 @@ dispatchers.
.LP
The parent member is set to the created window's parent.
The window member specifies the created window.
The x and y members are set to the created window's coordinates relative
to the parent window's origin and indicate the position of the upper-left
The x and y members are set to the created window's coordinates relative
to the parent window's origin and indicate the position of the upper-left
outside corner of the created window.
The width and height members are set to the inside size of the created window
The width and height members are set to the inside size of the created window
(not including the border) and are always nonzero.
The border_width member is set to the width of the created window's border, in pixels.
The override_redirect member is set to the override-redirect attribute of the
window.
Window manager clients normally should ignore this window
Window manager clients normally should ignore this window
if the override_redirect member is
.BR True .
.SH "SEE ALSO"

22
man/XCrossingEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -70,7 +70,7 @@ typedef struct {
int mode; /\&* NotifyNormal, NotifyGrab, NotifyUngrab */
int detail;
/\&*
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyNonlinear,NotifyNonlinearVirtual
*/
Bool same_screen; /\&* same screen flag */
@ -107,10 +107,10 @@ The window member is set to the window on which the
.B EnterNotify
or
.B LeaveNotify
event was generated and is referred to as the event window.
This is the window used by the X server to report the event,
event was generated and is referred to as the event window.
This is the window used by the X server to report the event,
and is relative to the root
window on which the event occurred.
window on which the event occurred.
The root member is set to the root window of the screen
on which the event occurred.
.LP
@ -123,19 +123,19 @@ Otherwise, the X server sets the subwindow member to
.BR None .
For an
.B EnterNotify
event, if a child of the event window contains the final pointer position,
event, if a child of the event window contains the final pointer position,
the subwindow component is set to that child or
.BR None .
.LP
The time member is set to the time when the event was generated
and is expressed in milliseconds.
The x and y members are set to the coordinates of the pointer position in
The x and y members are set to the coordinates of the pointer position in
the event window.
This position is always the pointer's final position,
not its initial position.
If the event window is on the same
screen as the root window, x and y are the pointer coordinates
relative to the event window's origin.
relative to the event window's origin.
Otherwise, x and y are set to zero.
The x_root and y_root members are set to the pointer's coordinates relative to the
root window's origin at the time of the event.
@ -168,7 +168,7 @@ the event window is not the focus window or an inferior of the focus window.
The state member is set to indicate the state of the pointer buttons and
modifier keys just prior to the
event.
The X server can set this member to the bitwise inclusive OR of one
The X server can set this member to the bitwise inclusive OR of one
or more of the button or modifier key masks:
.BR Button1Mask ,
.BR Button2Mask ,
@ -184,10 +184,10 @@ or more of the button or modifier key masks:
.BR Mod4Mask ,
.BR Mod5Mask .
.LP
The mode member is set to indicate whether the events are normal events,
The mode member is set to indicate whether the events are normal events,
pseudo-motion events
when a grab activates, or pseudo-motion events when a grab deactivates.
The X server can set this member to
The X server can set this member to
.BR NotifyNormal ,
.BR NotifyGrab ,
or

4
man/XDefineCursor.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,7 +53,7 @@ XDefineCursor, XUndefineCursor \- define cursors
int XDefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Cursor
\fIcursor\fP\^);
.HP
int XUndefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
int XUndefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
.SH ARGUMENTS
.IP \fIcursor\fP 1i
Specifies the cursor that is to be displayed or

14
man/XDestroyWindow.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,9 +50,9 @@
XDestroyWindow, XDestroySubwindows \- destroy windows
.SH SYNTAX
.HP
int XDestroyWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
int XDestroyWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
.HP
int XDestroySubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
int XDestroySubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -77,7 +77,7 @@ the window itself.
The ordering among siblings and across subhierarchies is not otherwise
constrained.
If the window you specified is a root window, no windows are destroyed.
Destroying a mapped window will generate
Destroying a mapped window will generate
.B Expose
events on other windows that were obscured by the window being destroyed.
.LP
@ -88,7 +88,7 @@ error.
.LP
The
.B XDestroySubwindows
function destroys all inferior windows of the specified window,
function destroys all inferior windows of the specified window,
in bottom-to-top stacking order.
It causes the X server to generate a
.B DestroyNotify
@ -96,13 +96,13 @@ event for each window.
If any mapped
subwindows were actually destroyed,
.B XDestroySubwindows
causes the X server to generate
causes the X server to generate
.B Expose
events on the specified window.
This is much more efficient than deleting many windows
one at a time because much of the work need be performed only once for all
of the windows, rather than for each window.
The subwindows should never be referenced again.
The subwindows should never be referenced again.
.LP
.B XDestroySubwindows
can generate a

4
man/XDestroyWindowEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -89,7 +89,7 @@ dispatchers.
The event member is set either to the destroyed window or to its parent,
depending on whether
.B StructureNotify
or
or
.B SubstructureNotify
was selected.
The window member is set to the window that is destroyed.

72
man/XDrawArc.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -64,10 +64,10 @@ XDrawArc, XDrawArcs, XArc \- draw arcs and arc structure
.HP
int XDrawArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int
\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^);
\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^);
.HP
int XDrawArcs\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
XArc *\fIarcs\fP\^, int \fInarcs\fP\^);
XArc *\fIarcs\fP\^, int \fInarcs\fP\^);
.SH ARGUMENTS
.IP \fIangle1\fP 1i
Specifies the start of the arc relative to the three-o'clock position
@ -78,7 +78,7 @@ arc, in units of degrees * 64.
.IP \fIarcs\fP 1i
Specifies an array of arcs.
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
@ -94,41 +94,41 @@ Specify the width and height, which are the major and minor axes of the arc.
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are relative to the
origin of the drawable
Specify the x and y coordinates, which are relative to the
origin of the drawable
and specify the upper-left corner of the bounding rectangle.
.SH DESCRIPTION
.EQ
delim %%
.EN
.B XDrawArc
draws a single circular or elliptical arc, and
draws a single circular or elliptical arc, and
.B XDrawArcs
draws multiple circular or elliptical arcs.
Each arc is specified by a rectangle and two angles.
Each arc is specified by a rectangle and two angles.
The center of the circle or ellipse is the center of the
rectangle, and the major and minor axes are specified by the width and height.
Positive angles indicate counterclockwise motion,
and negative angles indicate clockwise motion.
If the magnitude of angle2 is greater than 360 degrees,
Positive angles indicate counterclockwise motion,
and negative angles indicate clockwise motion.
If the magnitude of angle2 is greater than 360 degrees,
.B XDrawArc
or
or
.B XDrawArcs
truncates it to 360 degrees.
.LP
For an arc specified as %[ ~x, ~y, ~width , ~height, ~angle1, ~angle2 ]%,
the origin of the major and minor axes is at
% [ x +^ {width over 2} , ~y +^ {height over 2} ]%,
and the infinitely thin path describing the entire circle or ellipse
intersects the horizontal axis at % [ x, ~y +^ {height over 2} ]% and
For an arc specified as %[ ~x, ~y, ~width , ~height, ~angle1, ~angle2 ]%,
the origin of the major and minor axes is at
% [ x +^ {width over 2} , ~y +^ {height over 2} ]%,
and the infinitely thin path describing the entire circle or ellipse
intersects the horizontal axis at % [ x, ~y +^ {height over 2} ]% and
% [ x +^ width , ~y +^ { height over 2 }] %
and intersects the vertical axis at % [ x +^ { width over 2 } , ~y ]% and
and intersects the vertical axis at % [ x +^ { width over 2 } , ~y ]% and
% [ x +^ { width over 2 }, ~y +^ height ]%.
These coordinates can be fractional
and so are not truncated to discrete coordinates.
The path should be defined by the ideal mathematical path.
For a wide line with line-width lw,
the bounding outlines for filling are given
The path should be defined by the ideal mathematical path.
For a wide line with line-width lw,
the bounding outlines for filling are given
by the two infinitely thin paths consisting of all points whose perpendicular
distance from the path of the circle/ellipse is equal to lw/2
(which may be a fractional value).
@ -160,37 +160,37 @@ l l.
%2 pi% for normal-angle in the range % [ {3 pi} over 2 , ~2 pi ]%
.TE
.LP
For any given arc,
.B XDrawArc
and
.B XDrawArcs
do not draw a pixel more than once.
If two arcs join correctly and if the line-width is greater than zero
and the arcs intersect,
For any given arc,
.B XDrawArc
and
.B XDrawArcs
do not draw a pixel more than once.
Otherwise,
If two arcs join correctly and if the line-width is greater than zero
and the arcs intersect,
.B XDrawArc
and
.B XDrawArcs
do not draw a pixel more than once.
Otherwise,
the intersecting pixels of intersecting arcs are drawn multiple times.
Specifying an arc with one endpoint and a clockwise extent draws the same pixels
as specifying the other endpoint and an equivalent counterclockwise extent,
except as it affects joins.
.LP
If the last point in one arc coincides with the first point in the following
arc, the two arcs will join correctly.
If the first point in the first arc coincides with the last point in the last
If the last point in one arc coincides with the first point in the following
arc, the two arcs will join correctly.
If the first point in the first arc coincides with the last point in the last
arc, the two arcs will join correctly.
By specifying one axis to be zero, a horizontal or vertical line can be
drawn.
Angles are computed based solely on the coordinate system and ignore the
aspect ratio.
.LP
Both functions use these GC components:
function, plane-mask, line-width, line-style, cap-style, join-style,
Both functions use these GC components:
function, plane-mask, line-width, line-style, cap-style, join-style,
fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
tile-stipple-y-origin, dash-offset, and dash-list.
.LP
.B XDrawArc

24
man/XDrawImageString.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,14 +52,14 @@ XDrawImageString, XDrawImageString16 \- draw image text
.HP
int XDrawImageString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char *\fIstring\fP\^, int
\fIlength\fP\^);
\fIlength\fP\^);
.HP
int XDrawImageString16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XChar2b *\fIstring\fP\^, int
\fIlength\fP\^);
\fIlength\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
@ -72,8 +72,8 @@ Specifies the character string.
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are relative to the
origin of the specified drawable
Specify the x and y coordinates, which are relative to the
origin of the specified drawable
and define the origin of the first character.
.SH DESCRIPTION
The
@ -81,7 +81,7 @@ The
function is similar to
.B XDrawImageString
except that it uses 2-byte or 16-bit characters.
Both functions also use both the foreground and background pixels
Both functions also use both the foreground and background pixels
of the GC in the destination.
.LP
The effect is first to fill a
@ -106,11 +106,11 @@ font-ascent + font-descent
.EE
.LP
The overall-width, font-ascent, and font-descent
are as would be returned by
are as would be returned by
.B XQueryTextExtents
using gc and string.
The function and fill-style defined in the GC are ignored for these functions.
The effective function is
The function and fill-style defined in the GC are ignored for these functions.
The effective function is
.BR GXcopy ,
and the effective fill-style is
.BR FillSolid .
@ -120,8 +120,8 @@ and used with
.BR XDrawImageString ,
each byte is used as a byte2 with a byte1 of zero.
.LP
Both functions use these GC components:
plane-mask, foreground, background, font, subwindow-mode, clip-x-origin,
Both functions use these GC components:
plane-mask, foreground, background, font, subwindow-mode, clip-x-origin,
clip-y-origin, and clip-mask.
.LP
.B XDrawImageString

42
man/XDrawLine.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,22 +51,22 @@ XDrawLine, XDrawLines, XDrawSegments, XSegment \- draw lines, polygons, and line
.SH SYNTAX
.HP
int XDrawLine\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
int \fIx1\fP\^, int \fIy1\fP\^, int \fIx2\fP\^, int \fIy2\fP\^);
.HP
int \fIx1\fP\^, int \fIy1\fP\^, int \fIx2\fP\^, int \fIy2\fP\^);
.HP
int XDrawLines\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^);
.HP
\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^);
.HP
int XDrawSegments\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, XSegment *\fIsegments\fP\^, int \fInsegments\fP\^);
\fIgc\fP\^, XSegment *\fIsegments\fP\^, int \fInsegments\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
Specifies the GC.
.IP \fImode\fP 1i
Specifies the coordinate mode.
Specifies the coordinate mode.
You can pass
.B CoordModeOrigin
or
@ -96,28 +96,28 @@ The
function uses the components of the specified GC to
draw a line between the specified set of points (x1, y1) and (x2, y2).
It does not perform joining at coincident endpoints.
For any given line,
For any given line,
.B XDrawLine
does not draw a pixel more than once.
If lines intersect, the intersecting pixels are drawn multiple times.
If lines intersect, the intersecting pixels are drawn multiple times.
.LP
The
.B XDrawLines
function uses the components of the specified GC to draw
npoints\-1 lines between each pair of points (point[i], point[i+1])
function uses the components of the specified GC to draw
npoints\-1 lines between each pair of points (point[i], point[i+1])
in the array of
.B XPoint
structures.
It draws the lines in the order listed in the array.
The lines join correctly at all intermediate points, and if the first and last
points coincide, the first and last lines also join correctly.
For any given line,
For any given line,
.B XDrawLines
does not draw a pixel more than once.
If thin (zero line-width) lines intersect,
If thin (zero line-width) lines intersect,
the intersecting pixels are drawn multiple times.
If wide lines intersect, the intersecting pixels are drawn only once, as though
the entire
the entire
.B PolyLine
protocol request were a single, filled shape.
.B CoordModeOrigin
@ -128,18 +128,18 @@ treats all coordinates after the first as relative to the previous point.
.LP
The
.B XDrawSegments
function draws multiple, unconnected lines.
For each segment,
function draws multiple, unconnected lines.
For each segment,
.B XDrawSegments
draws a
line between (x1, y1) and (x2, y2).
It draws the lines in the order listed in the array of
.B XSegment
structures and does not perform joining at coincident endpoints.
For any given line,
For any given line,
.B XDrawSegments
does not draw a pixel more than once.
If lines intersect, the intersecting pixels are drawn multiple times.
does not draw a pixel more than once.
If lines intersect, the intersecting pixels are drawn multiple times.
.LP
All three functions use these GC components:
function, plane-mask, line-width,
@ -149,7 +149,7 @@ The
.B XDrawLines
function also uses the join-style GC component.
All three functions also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
foreground, background, tile, stipple, tile-stipple-x-origin,
tile-stipple-y-origin, dash-offset, and dash-list.
.LP
.BR XDrawLine ,

14
man/XDrawPoint.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,19 +51,19 @@ XDrawPoint, XDrawPoints, XPoint \- draw points and points structure
.SH SYNTAX
.HP
int XDrawPoint\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^);
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^);
.HP
int XDrawPoints\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^);
\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fImode\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
Specifies the GC.
.IP \fImode\fP 1i
Specifies the coordinate mode.
Specifies the coordinate mode.
You can pass
.B CoordModeOrigin
or
@ -81,7 +81,7 @@ Specify the x and y coordinates where you want the point drawn.
The
.B XDrawPoint
function uses the foreground pixel and function components of the
GC to draw a single point into the specified drawable;
GC to draw a single point into the specified drawable;
.B XDrawPoints
draws multiple points this way.
.B CoordModeOrigin
@ -99,7 +99,7 @@ foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
can generate
.BR BadDrawable ,
.BR BadGC ,
and
and
.B BadMatch
errors.
.B XDrawPoints

22
man/XDrawRectangle.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,13 +52,13 @@ XDrawRectangle, XDrawRectangles, XRectangle \- draw rectangles and rectangles st
.HP
int XDrawRectangle\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned
int \fIheight\fP\^);
int \fIheight\fP\^);
.HP
int XDrawRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, XRectangle \fIrectangles\fP\^[\^]\^, int \fInrectangles\fP\^);
\fIgc\fP\^, XRectangle \fIrectangles\fP\^[\^]\^, int \fInrectangles\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
@ -83,25 +83,25 @@ The
and
.B XDrawRectangles
functions draw the outlines of the specified rectangle or rectangles as
if a five-point
if a five-point
.B PolyLine
protocol request were specified for each rectangle:
.IP
[x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]
.LP
For the specified rectangle or rectangles,
.LP
For the specified rectangle or rectangles,
these functions do not draw a pixel more than once.
.B XDrawRectangles
draws the rectangles in the order listed in the array.
If rectangles intersect,
the intersecting pixels are drawn multiple times.
.LP
Both functions use these GC components:
Both functions use these GC components:
function, plane-mask, line-width,
line-style, cap-style, join-style, fill-style,
line-style, cap-style, join-style, fill-style,
subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
tile-stipple-y-origin, dash-offset, and dash-list.
.LP
.B XDrawRectangle

20
man/XDrawString.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,14 +52,14 @@ XDrawString, XDrawString16 \- draw text characters
.HP
int XDrawString\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, char *\fIstring\fP\^, int
\fIlength\fP\^);
\fIlength\fP\^);
.HP
int XDrawString16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XChar2b *\fIstring\fP\^, int
\fIlength\fP\^);
\fIlength\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
@ -72,8 +72,8 @@ Specifies the character string.
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are relative to the
origin of the specified drawable
Specify the x and y coordinates, which are relative to the
origin of the specified drawable
and define the origin of the first character.
.SH DESCRIPTION
Each character image, as defined by the font in the GC, is treated as an
@ -84,11 +84,11 @@ and used with
.BR XDrawString16 ,
each byte is used as a byte2 with a byte1 of zero.
.LP
Both functions use these GC components:
function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin,
Both functions use these GC components:
function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin,
clip-y-origin, and clip-mask.
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
and tile-stipple-y-origin.
.LP
.B XDrawString

28
man/XDrawText.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,14 +51,14 @@ XDrawText, XDrawText16, XTextItem, XTextItem16 \- draw polytext text and text dr
.SH SYNTAX
.HP
int XDrawText\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
int \fIx\fP\^, int \fIy\fP\^, XTextItem *\fIitems\fP\^, int \fInitems\fP\^);
int \fIx\fP\^, int \fIy\fP\^, XTextItem *\fIitems\fP\^, int \fInitems\fP\^);
.HP
int XDrawText16\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, XTextItem16 *\fIitems\fP\^, int
\fInitems\fP\^);
\fInitems\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
@ -71,8 +71,8 @@ Specifies the number of text items in the array.
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are relative to the origin
of the specified drawable
Specify the x and y coordinates, which are relative to the origin
of the specified drawable
and define the origin of the first character.
.SH DESCRIPTION
The
@ -83,12 +83,12 @@ except that it uses 2-byte or 16-bit characters.
Both functions allow complex spacing and font shifts between counted strings.
.LP
Each text item is processed in turn.
A font member other than
A font member other than
.B None
in an item causes the font to be stored in the GC
and used for subsequent text.
and used for subsequent text.
A text element delta specifies an additional change
in the position along the x axis before the string is drawn.
in the position along the x axis before the string is drawn.
The delta is always added to the character origin
and is not dependent on any characteristics of the font.
Each character image, as defined by the font in the GC, is treated as an
@ -99,16 +99,16 @@ If a text item generates a
error, the previous text items may have been drawn.
.LP
For fonts defined with linear indexing rather than 2-byte matrix indexing,
each
each
.B XChar2b
structure is interpreted as a 16-bit number with byte1 as the
structure is interpreted as a 16-bit number with byte1 as the
most significant byte.
.LP
Both functions use these GC components:
function, plane-mask, fill-style, font, subwindow-mode,
function, plane-mask, fill-style, font, subwindow-mode,
clip-x-origin, clip-y-origin, and clip-mask.
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
and tile-stipple-y-origin.
.LP
.B XDrawText

18
man/XEmptyRegion.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,14 +50,14 @@
XEmptyRegion, XEqualRegion, XPointInRegion, XRectInRegion \- determine if regions are empty or equal
.SH SYNTAX
.HP
Bool XEmptyRegion\^(\^Region \fIr\fP\^);
Bool XEmptyRegion\^(\^Region \fIr\fP\^);
.HP
Bool XEqualRegion\^(\^Region \fIr1\fP\^, Region \fIr2\fP\^);
Bool XEqualRegion\^(\^Region \fIr1\fP\^, Region \fIr2\fP\^);
.HP
Bool XPointInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^);
Bool XPointInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^);
.HP
int XRectInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned
int \fIwidth\fP\^, unsigned int \fIheight\fP\^);
int \fIwidth\fP\^, unsigned int \fIheight\fP\^);
.SH ARGUMENTS
.IP \fIr\fP 1i
Specifies the region.
@ -66,18 +66,18 @@ Specifies the region.
.ns
.IP \fIr2\fP 1i
Specify the two regions.
.ds Wh
.ds Wh
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
Specify the width and height, which define the rectangle.
.ds Xy
.ds Xy
.IP \fIx\fP 1i
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which define the point
Specify the x and y coordinates, which define the point
or the coordinates of the upper-left corner of the rectangle.
.SH DESCRIPTION
The
@ -94,7 +94,7 @@ if the two regions have the same offset, size, and shape.
.LP
The
.B XPointInRegion
function returns
function returns
.B True
if the point (x, y) is contained in the region r.
.LP

14
man/XErrorEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -49,7 +49,7 @@
.SH NAME
XErrorEvent \- X error event structure
.SH STRUCTURES
The
The
.B XErrorEvent
structure contains:
.LP
@ -68,13 +68,13 @@ typedef struct {
When you receive this event,
the structure members are set as follows.
.LP
The serial member is the number of requests, starting from one,
sent over the network connection since it was opened.
It is the number that was the value of
The serial member is the number of requests, starting from one,
sent over the network connection since it was opened.
It is the number that was the value of
.B NextRequest
immediately before the failing call was made.
immediately before the failing call was made.
The request_code member is a protocol request
of the procedure that failed, as defined in
of the procedure that failed, as defined in
.hN X11/Xproto.h .
.SH "SEE ALSO"
AllPlanes(__libmansuffix__),

4
man/XExposeEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -98,7 +98,7 @@ events that are to follow.
If count is zero, no more
.B Expose
events follow for this window.
However, if count is nonzero, at least that number of
However, if count is nonzero, at least that number of
.B Expose
events (and possibly more) follow for this window.
Simple applications that do not want to optimize redisplay by distinguishing

10
man/XExtentsOfFontSet.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,7 +50,7 @@
XExtentsOfFontSet \- obtain the maximum extents structure for a font set
.SH SYNTAX
.HP
XFontSetExtents *XExtentsOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
XFontSetExtents *XExtentsOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
.SH ARGUMENTS
.IP \fIfont_set\fP 1i
Specifies the font set.
@ -62,13 +62,13 @@ function returns an
structure for the fonts used by the Xmb and Xwc layers
for the given font set.
.LP
The
The
.B XFontSetExtents
structure is owned by Xlib and should not be modified
or freed by the client.
It will be freed by a call to
It will be freed by a call to
.B XFreeFontSet
with the associated
with the associated
.BR XFontSet .
Until freed, its contents will not be modified by Xlib.
.SH "SEE ALSO"

98
man/XFillRectangle.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,21 +52,21 @@ XFillRectangle, XFillRectangles, XFillPolygon, XFillArc, XFillArcs \- fill recta
.HP
int XFillRectangle\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned
int \fIheight\fP\^);
int \fIheight\fP\^);
.HP
int XFillRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, XRectangle *\fIrectangles\fP\^, int \fInrectangles\fP\^);
\fIgc\fP\^, XRectangle *\fIrectangles\fP\^, int \fInrectangles\fP\^);
.HP
int XFillPolygon\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
\fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fIshape\fP\^,
int \fImode\fP\^);
.HP
int XFillArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
int XFillArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int
\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^);
\fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^);
.HP
int XFillArcs\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
XArc *\fIarcs\fP\^, int \fInarcs\fP\^);
XArc *\fIarcs\fP\^, int \fInarcs\fP\^);
.SH ARGUMENTS
.IP \fIangle1\fP 1i
Specifies the start of the arc relative to the three-o'clock position
@ -77,13 +77,13 @@ arc, in units of degrees * 64.
.IP \fIarcs\fP 1i
Specifies an array of arcs.
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIgc\fP 1i
Specifies the GC.
.IP \fImode\fP 1i
Specifies the coordinate mode.
Specifies the coordinate mode.
You can pass
.B CoordModeOrigin
or
@ -100,17 +100,17 @@ Specifies an array of points.
Specifies an array of rectangles.
.IP \fIshape\fP 1i
Specifies a shape that helps the server to improve performance.
You can pass
You can pass
.BR Complex ,
.BR Convex ,
or
or
.BR Nonconvex .
.ds Wh
.ds Wh
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
Specify the width and height, which are the dimensions of the
Specify the width and height, which are the dimensions of the
rectangle to be filled or the major and minor axes of the arc.
.IP \fIx\fP 1i
.br
@ -124,7 +124,7 @@ The
and
.B XFillRectangles
functions fill the specified rectangle or rectangles
as if a four-point
as if a four-point
.B FillPolygon
protocol request were specified for each rectangle:
.LP
@ -136,20 +136,20 @@ Each function uses the x and y coordinates,
width and height dimensions, and GC you specify.
.LP
.B XFillRectangles
fills the rectangles in the order listed in the array.
fills the rectangles in the order listed in the array.
For any given rectangle,
.B XFillRectangle
and
.B XFillRectangles
do not draw a pixel more than once.
do not draw a pixel more than once.
If rectangles intersect, the intersecting pixels are
drawn multiple times.
.LP
Both functions use these GC components:
function, plane-mask, fill-style, subwindow-mode,
Both functions use these GC components:
function, plane-mask, fill-style, subwindow-mode,
clip-x-origin, clip-y-origin, and clip-mask.
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
and tile-stipple-y-origin.
.LP
.B XFillRectangle
@ -175,12 +175,12 @@ and
.B CoordModePrevious
treats all coordinates after the first as relative to the previous point.
.LP
Depending on the specified shape, the following occurs:
Depending on the specified shape, the following occurs:
.IP \(bu 5
If shape is
.BR Complex ,
the path may self-intersect.
Note that contiguous coincident points in the path are not treated
the path may self-intersect.
Note that contiguous coincident points in the path are not treated
as self-intersection.
.IP \(bu 5
If shape is
@ -188,36 +188,36 @@ If shape is
for every pair of points inside the polygon,
the line segment connecting them does not intersect the path.
If known by the client,
specifying
specifying
.B Convex
can improve performance.
can improve performance.
If you specify
.B Convex
for a path that is not convex,
for a path that is not convex,
the graphics results are undefined.
.IP \(bu 5
If shape is
.BR Nonconvex ,
the path does not self-intersect, but the shape is not
wholly convex.
If known by the client,
specifying
wholly convex.
If known by the client,
specifying
.B Nonconvex
instead of
.B Complex
may improve performance.
may improve performance.
If you specify
.B Nonconvex
for a self-intersecting path, the graphics results are undefined.
.LP
The fill-rule of the GC controls the filling behavior of
The fill-rule of the GC controls the filling behavior of
self-intersecting polygons.
.LP
This function uses these GC components:
function, plane-mask, fill-style, fill-rule, subwindow-mode, clip-x-origin,
This function uses these GC components:
function, plane-mask, fill-style, fill-rule, subwindow-mode, clip-x-origin,
clip-y-origin, and clip-mask.
It also uses these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
It also uses these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
and tile-stipple-y-origin.
.LP
.B XFillPolygon
@ -229,35 +229,35 @@ and
.B BadValue
errors.
.LP
For each arc,
For each arc,
.B XFillArc
or
.B XFillArcs
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
described by the specified arc and, depending on the
arc-mode specified in the GC, one or two line segments.
For
.BR ArcChord ,
the single line segment joining the endpoints of the arc is used.
For
the single line segment joining the endpoints of the arc is used.
For
.BR ArcPieSlice ,
the two line segments joining the endpoints of the arc with the center
point are used.
point are used.
.B XFillArcs
fills the arcs in the order listed in the array.
For any given arc,
fills the arcs in the order listed in the array.
For any given arc,
.B XFillArc
and
.B XFillArcs
do not draw a pixel more than once.
If regions intersect,
do not draw a pixel more than once.
If regions intersect,
the intersecting pixels are drawn multiple times.
.LP
Both functions use these GC components:
function, plane-mask, fill-style, arc-mode, subwindow-mode, clip-x-origin,
Both functions use these GC components:
function, plane-mask, fill-style, arc-mode, subwindow-mode, clip-x-origin,
clip-y-origin, and clip-mask.
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
They also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin,
and tile-stipple-y-origin.
.LP
.B XFillArc

4
man/XFilterEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,7 +50,7 @@
XFilterEvent \- filter X events for an input method
.SH SYNTAX
.HP
Bool XFilterEvent\^(\^XEvent *\fIevent\fP\^, Window \fIw\fP\^);
Bool XFilterEvent\^(\^XEvent *\fIevent\fP\^, Window \fIw\fP\^);
.SH ARGUMENTS
.IP \fIevent\fP 1i
Specifies the event to filter.

36
man/XFlush.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,16 +50,16 @@
XFlush, XSync, XEventsQueued, XPending \- handle output buffer or event queue
.SH SYNTAX
.HP
int XFlush\^(\^Display *\fIdisplay\fP\^);
int XFlush\^(\^Display *\fIdisplay\fP\^);
.HP
int XSync\^(\^Display *\fIdisplay\fP\^, Bool \fIdiscard\fP\^);
int XSync\^(\^Display *\fIdisplay\fP\^, Bool \fIdiscard\fP\^);
.HP
int XEventsQueued\^(\^Display *\fIdisplay\fP\^, int \fImode\fP\^);
int XEventsQueued\^(\^Display *\fIdisplay\fP\^, int \fImode\fP\^);
.HP
int XPending\^(\^Display *\fIdisplay\fP\^);
int XPending\^(\^Display *\fIdisplay\fP\^);
.SH ARGUMENTS
.IP \fIdiscard\fP 1i
Specifies a Boolean value that indicates whether
Specifies a Boolean value that indicates whether
.B XSync
discards all events on the event queue.
.IP \fIdisplay\fP 1i
@ -96,14 +96,14 @@ Any errors generated must be handled by the error handler.
For each protocol error received by Xlib,
.B XSync
calls the client application's error handling routine (see section 11.8.2).
Any events generated by the server are enqueued into the library's
Any events generated by the server are enqueued into the library's
event queue.
.LP
Finally, if you passed
Finally, if you passed
.BR False ,
.B XSync
does not discard the events in the queue.
If you passed
If you passed
.BR True ,
.B XSync
discards all events in the queue,
@ -113,34 +113,34 @@ was called.
Client applications seldom need to call
.BR XSync .
.LP
If mode is
If mode is
.BR QueuedAlready ,
.B XEventsQueued
returns the number of events
already in the event queue (and never performs a system call).
If mode is
If mode is
.BR QueuedAfterFlush ,
.B XEventsQueued
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
If there are no events in the queue,
.B XEventsQueued
flushes the output buffer,
flushes the output buffer,
attempts to read more events out of the application's connection,
and returns the number read.
If mode is
If mode is
.BR QueuedAfterReading ,
.B XEventsQueued
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
.B XEventsQueued
attempts to read more events out of the application's connection
attempts to read more events out of the application's connection
without flushing the output buffer and returns the number read.
.LP
.B XEventsQueued
always returns immediately without I/O if there are events already in the
queue.
.B XEventsQueued
with mode
with mode
.B QueuedAfterFlush
is identical in behavior to
.BR XPending .

20
man/XFocusChangeEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -65,9 +65,9 @@ typedef struct {
int mode; /\&* NotifyNormal, NotifyGrab, NotifyUngrab */
int detail;
/\&*
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyNonlinear,NotifyNonlinearVirtual, NotifyPointer,
* NotifyPointerRoot, NotifyDetailNone
* NotifyPointerRoot, NotifyDetailNone
*/
} XFocusChangeEvent;
typedef XFocusChangeEvent XFocusInEvent;
@ -101,27 +101,27 @@ The window member is set to the window on which the
or
.B FocusOut
event was generated.
This is the window used by the X server to report the event.
The mode member is set to indicate whether the focus events
are normal focus events,
This is the window used by the X server to report the event.
The mode member is set to indicate whether the focus events
are normal focus events,
focus events while grabbed,
focus events
when a grab activates, or focus events when a grab deactivates.
The X server can set the mode member to
The X server can set the mode member to
.BR NotifyNormal ,
.BR NotifyWhileGrabbed ,
.BR NotifyGrab ,
or
.BR NotifyUngrab .
.LP
All
All
.B FocusOut
events caused by a window unmap are generated after any
.B UnmapNotify
event; however, the X protocol does not constrain the ordering of
event; however, the X protocol does not constrain the ordering of
.B FocusOut
events with respect to
generated
generated
.BR EnterNotify ,
.BR LeaveNotify ,
.BR VisibilityNotify ,

14
man/XFontSetExtents.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -60,33 +60,33 @@ typedef struct {
} XFontSetExtents;
.EE
.LP
The
The
.B XRectangle
structures used to return font set metrics are the usual Xlib screen-oriented
structures used to return font set metrics are the usual Xlib screen-oriented
rectangles
with x, y giving the upper left corner, and width and height always positive.
.LP
The max_ink_extent member gives the maximum extent, over all drawable characters, of
the rectangles that bound the character glyph image drawn in the
foreground color, relative to a constant origin.
See
See
.B XmbTextExtents
and
.B XwcTextExtents
for detailed semantics.
.LP
The max_logical_extent member gives the maximum extent,
over all drawable characters, of the rectangles
over all drawable characters, of the rectangles
that specify minimum spacing to other graphical features,
relative to a constant origin.
Other graphical features drawn by the client, for example,
a border surrounding the text, should not intersect this rectangle.
The max_logical_extent member should be used to compute minimum
The max_logical_extent member should be used to compute minimum
interline spacing and the minimum area that must be allowed
in a text field to draw a given number of arbitrary characters.
.LP
Due to context-dependent rendering,
appending a given character to a string may change
appending a given character to a string may change
the string's extent by an amount other than that character's
individual extent.
.SH "SEE ALSO"

44
man/XFontsOfFontSet.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,17 +51,17 @@ XFontsOfFontSet, XBaseFontNameListOfFontSet, XLocaleOfFontSet, XContextDependent
.SH SYNTAX
.HP
int XFontsOfFontSet\^(\^XFontSet \fIfont_set\fP\^, XFontStruct
***\fIfont_struct_list_return\fP\^, char ***\fIfont_name_list_return\fP\^);
***\fIfont_struct_list_return\fP\^, char ***\fIfont_name_list_return\fP\^);
.HP
char *XBaseFontNameListOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
char *XBaseFontNameListOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
.HP
char *XLocaleOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
char *XLocaleOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
.HP
Bool XContextDependentDrawing\^(\^XFontSet \fIfont_set\fP\^);
Bool XContextDependentDrawing\^(\^XFontSet \fIfont_set\fP\^);
.HP
Bool XContextualDrawing\^(\^XFontSet \fIfont_set\fP\^);
Bool XContextualDrawing\^(\^XFontSet \fIfont_set\fP\^);
.HP
Bool XDirectionalDependentDrawing\^(\^XFontSet \fIfont_set\fP\^);
Bool XDirectionalDependentDrawing\^(\^XFontSet \fIfont_set\fP\^);
.SH ARGUMENTS
.IP \fIfont_set\fP 1i
Specifies the font set.
@ -72,7 +72,7 @@ Returns the list of font structs.
.SH DESCRIPTION
The
.B XFontsOfFontSet
function returns a list of one or more
function returns a list of one or more
.B XFontStructs
and font names for the fonts used by the Xmb and Xwc layers
for the given font set.
@ -88,30 +88,30 @@ structures and font names is returned as the value of the function.
.LP
Because it is not guaranteed that a given character will be imaged using a
single font glyph,
there is no provision for mapping a character or default string
to the font properties, font ID, or direction hint for the font
there is no provision for mapping a character or default string
to the font properties, font ID, or direction hint for the font
for the character.
The client may access the
The client may access the
.B XFontStruct
list to obtain these values for all the fonts currently in use.
.LP
Xlib does not guarantee that fonts are loaded from the server
at the creation of an
at the creation of an
.BR XFontSet .
Xlib may choose to cache font data, loading it only as needed to draw text
Xlib may choose to cache font data, loading it only as needed to draw text
or compute text dimensions.
Therefore, existence of the per_char metrics in the
Therefore, existence of the per_char metrics in the
.B XFontStruct
structures in the
.B XFontStructSet
is undefined.
Also, note that all properties in the
Also, note that all properties in the
.B XFontStruct
structures are in the STRING encoding.
.LP
The
The
.B XFontStruct
and font name lists are owned by Xlib
and font name lists are owned by Xlib
and should not be modified or freed by the client.
They will be freed by a call to
.B XFreeFontSet
@ -122,7 +122,7 @@ Until freed, their contents will not be modified by Xlib.
The
.B XBaseFontNameListOfFontSet
function returns the original base font name list supplied
by the client when the
by the client when the
.B XFontSet
was created.
A null-terminated string containing a list of
@ -130,7 +130,7 @@ comma-separated font names is returned
as the value of the function.
White space may appear immediately on either side of separating commas.
.LP
If
If
.B XCreateFontSet
obtained an XLFD name from the font properties for the font specified
by a non-XLFD base name, the
@ -139,9 +139,9 @@ function will return the XLFD name instead of the non-XLFD base name.
.LP
The base font name list is owned by Xlib and should not be modified or
freed by the client.
It will be freed by a call to
It will be freed by a call to
.B XFreeFontSet
with the associated
with the associated
.BR XFontSet .
Until freed, its contents will not be modified by Xlib.
.LP
@ -156,7 +156,7 @@ The returned locale name string is owned by Xlib
and should not be modified or freed by the client.
It may be freed by a call to
.B XFreeFontSet
with the associated
with the associated
.BR XFontSet .
Until freed, it will not be modified by Xlib.
.LP

4
man/XFree.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -49,7 +49,7 @@
.SH NAME
XFree \- free client data
.SH SYNTAX
int XFree\^(\^void *\fIdata\fP\^);
int XFree\^(\^void *\fIdata\fP\^);
.SH ARGUMENTS
.IP \fIdata\fP 1i
Specifies the data that are to be freed.

10
man/XGetVisualInfo.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -54,12 +54,12 @@ XGetVisualInfo, XMatchVisualInfo, XVisualIDFromVisual, XVisualInfo \- obtain vis
.HP
XVisualInfo *XGetVisualInfo\^(\^Display *\fIdisplay\fP\^, long
\fIvinfo_mask\fP\^, XVisualInfo *\fIvinfo_template\fP\^, int
*\fInitems_return\fP\^);
*\fInitems_return\fP\^);
.HP
Status XMatchVisualInfo\^(\^Display *\fIdisplay\fP\^, int \fIscreen\fP\^, int
\fIdepth\fP\^, int \fIclass\fP\^, XVisualInfo *\fIvinfo_return\fP\^);
\fIdepth\fP\^, int \fIclass\fP\^, XVisualInfo *\fIvinfo_return\fP\^);
.HP
VisualID XVisualIDFromVisual\^(\^Visual *\^\fIvisual\fP\^);
VisualID XVisualIDFromVisual\^(\^Visual *\^\fIvisual\fP\^);
.SH ARGUMENTS
.IP \fIclass\fP 1i
Specifies the class of the screen.
@ -83,7 +83,7 @@ structures.
.SH DESCRIPTION
The
.B XGetVisualInfo
function returns a list of visual structures that have attributes
function returns a list of visual structures that have attributes
equal to the attributes specified by vinfo_template.
If no visual structures match the template using the specified vinfo_mask,
.B XGetVisualInfo

46
man/XGetWindowAttributes.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,24 +53,24 @@ XGetWindowAttributes, XGetGeometry, XWindowAttributes \- get current window attr
.SH SYNTAX
.HP
Status XGetWindowAttributes\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
XWindowAttributes *\fIwindow_attributes_return\fP\^);
XWindowAttributes *\fIwindow_attributes_return\fP\^);
.HP
Status XGetGeometry\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, Window
*\fIroot_return\fP\^, int *\fIx_return\fP\^, int *\fIy_return\fP\^, unsigned
int *\fIwidth_return\fP\^, unsigned int *\fIheight_return\fP\^, unsigned int
*\fIborder_width_return\fP\^, unsigned int *\fIdepth_return\fP\^);
*\fIborder_width_return\fP\^, unsigned int *\fIdepth_return\fP\^);
.SH ARGUMENTS
.IP \fIborder_width_return\fP 1i
Returns the border width in pixels.
Returns the border width in pixels.
.IP \fId\fP 1i
Specifies the drawable, which can be a window or a pixmap.
Specifies the drawable, which can be a window or a pixmap.
.IP \fIdepth_return\fP 1i
Returns the depth of the drawable (bits per pixel for the object).
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIroot_return\fP 1i
Returns the root window.
.ds Wi
.ds Wi
.IP \fIw\fP 1i
Specifies the window whose current attributes you want to obtain.
.IP \fIwidth_return\fP 1i
@ -87,7 +87,7 @@ structure.
.ns
.IP \fIy_return\fP 1i
Return the x and y coordinates that define the location of the drawable.
For a window,
For a window,
these coordinates specify the upper-left outer corner relative to
its parent's origin.
For pixmaps, these coordinates are always zero.
@ -149,10 +149,10 @@ typedef struct {
.LP
The x and y members are set to the upper-left outer
corner relative to the parent window's origin.
The width and height members are set to the inside size of the window,
The width and height members are set to the inside size of the window,
not including the border.
The border_width member is set to the window's border width in pixels.
The depth member is set to the depth of the window
The depth member is set to the depth of the window
(that is, bits per pixel for the object).
The visual member is a pointer to the screen's associated
.B Visual
@ -233,27 +233,27 @@ For additional information on gravity,
see section 3.3.
.LP
The backing_store member is set to indicate how the X server should maintain
the contents of a window
and can be
the contents of a window
and can be
.BR WhenMapped ,
.BR Always ,
or
.BR NotUseful .
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
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.
The backing_pixel member is set to indicate what values to use
The backing_pixel member is set to indicate what values to use
for planes not set in backing_planes.
.LP
The save_under member is set to
The save_under member is set to
.B True
or
.BR False .
The colormap member is set to the colormap for the specified window and can be
a colormap ID or
a colormap ID or
.BR None .
The map_installed member is set to indicate whether the colormap is
currently installed and can be
The map_installed member is set to indicate whether the colormap is
currently installed and can be
.B True
or
.BR False .
@ -265,22 +265,22 @@ or
.B IsUnviewable
is used if the window is mapped but some ancestor is unmapped.
.LP
The all_event_masks member is set to the bitwise inclusive OR of all event
The all_event_masks member is set to the bitwise inclusive OR of all event
masks selected on the window by all clients.
The your_event_mask member is set to the bitwise inclusive OR of all event
The your_event_mask member is set to the bitwise inclusive OR of all event
masks selected by the querying client.
The do_not_propagate_mask member is set to the bitwise inclusive OR of the
The do_not_propagate_mask member is set to the bitwise inclusive OR of the
set of events that should not propagate.
.LP
The override_redirect member is set to indicate whether this window overrides
structure control facilities and can be
structure control facilities and can be
.B True
or
.BR False .
Window manager clients should ignore the window if this member is
.BR True .
.LP
The screen member is set to a screen pointer that gives you a back pointer
The screen member is set to a screen pointer that gives you a back pointer
to the correct screen.
This makes it easier to obtain the screen information without
having to loop over the root window fields to see which field matches.

76
man/XGetWindowProperty.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -54,27 +54,27 @@ int XGetWindowProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom
\fIproperty\fP\^, long \fIlong_offset\fP\^, long \fIlong_length\fP\^, Bool
\fIdelete\fP\^, Atom \fIreq_type\fP\^, Atom *\fIactual_type_return\fP\^, int
*\fIactual_format_return\fP\^, unsigned long *\fInitems_return\fP\^, unsigned
long *\fIbytes_after_return\fP\^, unsigned char **\fIprop_return\fP\^);
long *\fIbytes_after_return\fP\^, unsigned char **\fIprop_return\fP\^);
.HP
Atom *XListProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int
*\fInum_prop_return\fP\^);
*\fInum_prop_return\fP\^);
.HP
int XChangeProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom
\fIproperty\fP\^, Atom \fItype\fP\^, int \fIformat\fP\^, int \fImode\fP\^,
unsigned char *\fIdata\fP\^, int \fInelements\fP\^);
unsigned char *\fIdata\fP\^, int \fInelements\fP\^);
.HP
int XRotateWindowProperties\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
Atom \fIproperties\fP\^[]\^, int \fInum_prop\fP\^, int \fInpositions\fP\^);
Atom \fIproperties\fP\^[]\^, int \fInum_prop\fP\^, int \fInpositions\fP\^);
.HP
int XDeleteProperty\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, Atom
\fIproperty\fP\^);
\fIproperty\fP\^);
.SH ARGUMENTS
.IP \fIactual_format_return\fP 1i
Returns the actual format of the property.
.IP \fIactual_type_return\fP 1i
Returns the atom identifier that defines the actual type of the property.
.IP \fIbytes_after_return\fP 1i
Returns the number of bytes remaining to be read in the property if
Returns the number of bytes remaining to be read in the property if
a partial read was performed.
.IP \fIdata\fP 1i
Specifies the property data.
@ -90,12 +90,12 @@ This information allows the X server to correctly perform
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
to
.BR XChangeProperty .
.IP \fIlong_length\fP 1i
Specifies the length in 32-bit multiples of the data to be retrieved.
.IP \fIlong_offset\fP 1i
Specifies the offset in the specified property (in 32-bit quantities)
Specifies the offset in the specified property (in 32-bit quantities)
where the data is to be retrieved.
.\" Changed name of this file to prop_mode.a on 1/13/87
.IP \fImode\fP 1i
@ -108,7 +108,7 @@ or
.IP \fInelements\fP 1i
Specifies the number of elements of the specified data format.
.IP \fInitems_return\fP 1i
Returns the actual number of 8-bit, 16-bit, or 32-bit items
Returns the actual number of 8-bit, 16-bit, or 32-bit items
stored in the prop_return data.
.IP \fInum_prop\fP 1i
Specifies the length of the properties array.
@ -134,7 +134,7 @@ Specifies the atom identifier associated with the property type or
.IP \fItype\fP 1i
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
passes it back to an application that later calls
.BR XGetWindowProperty .
.IP \fIw\fP 1i
Specifies the window whose property you want to obtain, change, rotate or delete.
@ -149,31 +149,31 @@ sets the return arguments as follows:
.IP \(bu 5
If the specified property does not exist for the specified window,
.B XGetWindowProperty
returns
returns
.B None
to actual_type_return and the value zero to
to actual_type_return and the value zero to
actual_format_return and bytes_after_return.
The nitems_return argument is empty.
In this case, the delete argument is ignored.
.IP \(bu 5
If the specified property exists
If the specified property exists
but its type does not match the specified type,
.B XGetWindowProperty
returns the actual property type to actual_type_return,
the actual property format (never zero) to actual_format_return,
returns the actual property type to actual_type_return,
the actual property format (never zero) to actual_format_return,
and the property length in bytes
(even if the actual_format_return is 16 or 32)
(even if the actual_format_return is 16 or 32)
to bytes_after_return.
It also ignores the delete argument.
The nitems_return argument is empty.
.IP \(bu 5
If the specified property exists and either you assign
If the specified property exists and either you assign
.B AnyPropertyType
to the req_type argument or the specified type matches the actual property type,
.B XGetWindowProperty
returns the actual property type to actual_type_return and the actual
property format (never zero) to actual_format_return.
It also returns a value to bytes_after_return and nitems_return, by
property format (never zero) to actual_format_return.
It also returns a value to bytes_after_return and nitems_return, by
defining the following
values:
.IP
@ -191,8 +191,8 @@ from zero), and its length in bytes is L.
If the value for long_offset causes L to be negative,
a
.B BadValue
error results.
The value of bytes_after_return is A,
error results.
The value of bytes_after_return is A,
giving the number of trailing unread bytes in the stored property.
.LP
If the returned format is 8, the returned data is represented as a
@ -206,17 +206,17 @@ If the returned format is 32, the returned data is represented as a
array and should be cast to that type to obtain the elements.
.LP
.B XGetWindowProperty
always allocates one extra byte in prop_return
(even if the property is zero length)
always allocates one extra byte in prop_return
(even if the property is zero length)
and sets it to zero so that simple properties consisting of characters
do not have to be copied into yet another string before use.
.LP
If delete is
If delete is
.B True
and bytes_after_return is zero,
and bytes_after_return is zero,
.B XGetWindowProperty
deletes the property
from the window and generates a
deletes the property
from the window and generates a
.B PropertyNotify
event on the window.
.LP
@ -237,7 +237,7 @@ errors.
.LP
The
.B XListProperties
function returns a pointer to an array of atom properties that are defined for
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
.BR XFree .
@ -272,7 +272,7 @@ The type and format must match the existing property value,
or a
.B BadMatch
error results.
If the property is undefined,
If the property is undefined,
it is treated as defined with the correct type and
format with zero-length data.
.LP
@ -290,7 +290,7 @@ The lifetime of a property is not tied to the storing client.
Properties remain until explicitly deleted, until the window is destroyed,
or until the server resets.
For a discussion of what happens when the connection to the X server is closed,
see section 2.6.
see section 2.6.
The maximum size of a property is server dependent and can vary dynamically
depending on the amount of memory the server has available.
(If there is insufficient space, a
@ -313,25 +313,25 @@ function allows you to rotate properties on a window and causes
the X server to generate
.B PropertyNotify
events.
If the property names in the properties array are viewed as being numbered
If the property names in the properties array are viewed as being numbered
starting from zero and if there are num_prop property names in the list,
then the value associated with property name I becomes the value associated
then the value associated with property name I becomes the value associated
with property name (I + npositions) mod N for all I from zero to N \- 1.
The effect is to rotate the states by npositions places around the virtual ring
of property names (right for positive npositions,
of property names (right for positive npositions,
left for negative npositions).
If npositions mod N is nonzero,
the X server generates a
.B PropertyNotify
event for each property in the order that they are listed in the array.
If an atom occurs more than once in the list or no property with that
If an atom occurs more than once in the list or no property with that
name is defined for the window,
a
a
.B BadMatch
error results.
If a
If a
.B BadAtom
or
or
.B BadMatch
error results,
no properties are changed.

2
man/XGetXCBConnection.man
View file

@ -26,7 +26,7 @@ XGetXCBConnection \- get the XCB connection for an Xlib Display
.HP
#include <X11/Xlib-xcb.h>
.HP
xcb_connection_t *XGetXCBConnection(Display *\fIdpy\fP);
xcb_connection_t *XGetXCBConnection(Display *\fIdpy\fP);
.SH ARGUMENTS
.IP \fIdpy\fP 1i
Specifies the connection to the X server.

40
man/XGrabButton.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -49,15 +49,15 @@
.SH NAME
XGrabButton, XUngrabButton \- grab pointer buttons
.SH SYNTAX
.HP
.HP
int XGrabButton\^(\^Display *\fIdisplay\fP\^, unsigned int \fIbutton\fP\^,
unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^, Bool
\fIowner_events\fP\^, unsigned int \fIevent_mask\fP\^, int
\fIpointer_mode\fP\^, \fIkeyboard_mode\fP\^, Window \fIconfine_to\fP\^, Cursor
\fIcursor\fP\^);
\fIcursor\fP\^);
.HP
int XUngrabButton\^(\^Display *\fIdisplay\fP\^, unsigned int \fIbutton\fP\^,
unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^);
unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^);
.SH ARGUMENTS
.IP \fIbutton\fP 1i
Specifies the pointer button that is to be grabbed or released or
@ -77,7 +77,7 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits.
Specifies the grab window.
.IP \fIkeyboard_mode\fP 1i
Specifies further processing of keyboard events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
@ -86,12 +86,12 @@ Specifies the set of keymasks or
.BR AnyModifier .
The mask is the bitwise inclusive OR of the valid keymask bits.
.IP \fIowner_events\fP 1i
Specifies a Boolean value that indicates whether the pointer
events are to be reported as usual or reported with respect to the grab window
Specifies a Boolean value that indicates whether the pointer
events are to be reported as usual or reported with respect to the grab window
if selected by the event mask.
.IP \fIpointer_mode\fP 1i
Specifies further processing of pointer events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
@ -125,7 +125,7 @@ The interpretation of the remaining arguments is as for
The active grab is terminated automatically when the logical state of the
pointer has all buttons released
(independent of the state of the logical modifier keys),
at which point a
at which point a
.B ButtonRelease
event is reported to the grabbing window.
.LP
@ -134,27 +134,27 @@ may lag the physical state if device event processing is frozen.
.LP
This request overrides all previous grabs by the same client on the same
button/key combinations on the same window.
A modifiers of
A modifiers of
.B AnyModifier
is equivalent to issuing the grab request for all
possible modifier combinations (including the combination of no modifiers).
It is not required that all modifiers specified have currently assigned
possible modifier combinations (including the combination of no modifiers).
It is not required that all modifiers specified have currently assigned
KeyCodes.
A button of
A button of
.B AnyButton
is equivalent to
issuing the request for all possible buttons.
Otherwise, it is not required that the specified button currently be assigned
to a physical button.
.LP
If some other client has already issued a
If some other client has already issued a
.B XGrabButton
with the same button/key combination on the same window, a
.B BadAccess
error results.
When using
When using
.B AnyModifier
or
or
.BR AnyButton ,
the request fails completely,
and a
@ -176,13 +176,13 @@ The
.B XUngrabButton
function releases the passive button/key combination on the specified window if
it was grabbed by this client.
A modifiers of
A modifiers of
.B AnyModifier
is
equivalent to issuing
the ungrab request for all possible modifier combinations, including
equivalent to issuing
the ungrab request for all possible modifier combinations, including
the combination of no modifiers.
A button of
A button of
.B AnyButton
is equivalent to issuing the
request for all possible buttons.

32
man/XGrabKey.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,10 +52,10 @@ XGrabKey, XUngrabKey \- grab keyboard keys
.HP
int XGrabKey\^(\^Display *\fIdisplay\fP\^, int \fIkeycode\fP\^, unsigned int
\fImodifiers\fP\^, Window \fIgrab_window\fP\^, Bool \fIowner_events\fP\^, int
\fIpointer_mode\fP\^, int \fIkeyboard_mode\fP\^);
\fIpointer_mode\fP\^, int \fIkeyboard_mode\fP\^);
.HP
int XUngrabKey\^(\^Display *\fIdisplay\fP\^, int \fIkeycode\fP\^, unsigned int
\fImodifiers\fP\^, Window \fIgrab_window\fP\^);
\fImodifiers\fP\^, Window \fIgrab_window\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -63,7 +63,7 @@ Specifies the connection to the X server.
Specifies the grab window.
.IP \fIkeyboard_mode\fP 1i
Specifies further processing of keyboard events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
@ -75,11 +75,11 @@ Specifies the set of keymasks or
.BR AnyModifier .
The mask is the bitwise inclusive OR of the valid keymask bits.
.IP \fIowner_events\fP 1i
Specifies a Boolean value that indicates whether the keyboard events
Specifies a Boolean value that indicates whether the keyboard events
are to be reported as usual.
.IP \fIpointer_mode\fP 1i
Specifies further processing of pointer events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
@ -108,49 +108,49 @@ or the grab_window is a descendant of the focus window and contains the pointer.
A passive grab on the same key combination does not exist
on any ancestor of grab_window.
.LP
The interpretation of the remaining arguments is as for
The interpretation of the remaining arguments is as for
.BR XGrabKeyboard .
The active grab is terminated automatically when the logical state of the
keyboard has the specified key released
(independent of the logical state of the modifier keys),
at which point a
at which point a
.B KeyRelease
event is reported to the grabbing window.
.LP
Note that the logical state of a device (as seen by client applications)
may lag the physical state if device event processing is frozen.
.LP
A modifiers argument of
A modifiers argument of
.B AnyModifier
is equivalent to issuing the request for all
possible modifier combinations (including the combination of no
modifiers).
modifiers).
It is not required that all modifiers specified have
currently assigned KeyCodes.
A keycode argument of
A keycode argument of
.B AnyKey
is equivalent to issuing
the request for all possible KeyCodes.
Otherwise, the specified keycode must be in
the range specified by min_keycode and max_keycode in the connection
setup,
setup,
or a
.B BadValue
error results.
.LP
If some other client has issued a
If some other client has issued a
.B XGrabKey
with the same key combination on the same window, a
with the same key combination on the same window, a
.B BadAccess
error results.
When using
.B AnyModifier
or
or
.BR AnyKey ,
the request fails completely,
and a
.B BadAccess
error results (no grabs are established)
error results (no grabs are established)
if there is a conflicting grab for any combination.
.LP
.B XGrabKey

56
man/XGrabKeyboard.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,9 +52,9 @@ XGrabKeyboard, XUngrabKeyboard \- grab the keyboard
.HP
int XGrabKeyboard\^(\^Display *\fIdisplay\fP\^, Window \fIgrab_window\fP\^,
Bool \fIowner_events\fP\^, int \fIpointer_mode\fP\^, int
\fIkeyboard_mode\fP\^, Time \fItime\fP\^);
\fIkeyboard_mode\fP\^, Time \fItime\fP\^);
.HP
int XUngrabKeyboard\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^);
int XUngrabKeyboard\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -62,16 +62,16 @@ Specifies the connection to the X server.
Specifies the grab window.
.IP \fIkeyboard_mode\fP 1i
Specifies further processing of keyboard events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
.IP \fIowner_events\fP 1i
Specifies a Boolean value that indicates whether the keyboard events
Specifies a Boolean value that indicates whether the keyboard events
are to be reported as usual.
.IP \fIpointer_mode\fP 1i
Specifies further processing of pointer events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
@ -91,51 +91,51 @@ Further key events are reported only to the
grabbing client.
.B XGrabKeyboard
overrides any active keyboard grab by this client.
If owner_events is
If owner_events is
.BR False ,
all generated key events are reported with
respect to grab_window.
If owner_events is
respect to grab_window.
If owner_events is
.B True
and if a generated
key event would normally be reported to this client, it is reported
normally; otherwise, the event is reported with respect to the
grab_window.
Both
grab_window.
Both
.B KeyPress
and
and
.B KeyRelease
events are always reported,
independent of any event selection made by the client.
.LP
If the keyboard_mode argument is
If the keyboard_mode argument is
.BR GrabModeAsync ,
keyboard event processing continues
as usual.
If the keyboard is currently frozen by this client,
as usual.
If the keyboard is currently frozen by this client,
then processing of keyboard events is resumed.
If the keyboard_mode argument is
.BR GrabModeSync ,
the state of the keyboard (as seen by client applications) appears to freeze,
and the X server generates no further keyboard events until the
grabbing client issues a releasing
grabbing client issues a releasing
.B XAllowEvents
call or until the keyboard grab is released.
Actual keyboard changes are not lost while the keyboard is frozen;
Actual keyboard changes are not lost while the keyboard is frozen;
they are simply queued in the server for later processing.
.LP
If pointer_mode is
If pointer_mode is
.BR GrabModeAsync ,
pointer event processing is unaffected
by activation of the grab.
If pointer_mode is
by activation of the grab.
If pointer_mode is
.BR GrabModeSync ,
the state of the pointer (as seen by client applications) appears to freeze,
and the X server generates no further pointer events
until the grabbing client issues a releasing
the state of the pointer (as seen by client applications) appears to freeze,
and the X server generates no further pointer events
until the grabbing client issues a releasing
.B XAllowEvents
call or until the keyboard grab is released.
Actual pointer changes are not lost while the pointer is frozen;
Actual pointer changes are not lost while the pointer is frozen;
they are simply queued in the server for later processing.
.LP
If the keyboard is actively grabbed by some other client,
@ -148,12 +148,12 @@ it fails and returns
If the keyboard is frozen by an active grab of another client,
it fails and returns
.BR GrabFrozen .
If the specified time is earlier than the last-keyboard-grab time
If the specified time is earlier than the last-keyboard-grab time
or later than the current X server time,
it fails and returns
.BR GrabInvalidTime .
Otherwise, the last-keyboard-grab time is set to the specified time
.Pn ( CurrentTime
.Pn ( CurrentTime
is replaced by the current X server time).
.LP
.B XGrabKeyboard
@ -177,10 +177,10 @@ if the specified time is earlier than
the last-keyboard-grab time or is later than the current X server time.
It also generates
.B FocusIn
and
and
.B FocusOut
events.
The X server automatically performs an
The X server automatically performs an
.B UngrabKeyboard
request if the event window for an
active keyboard grab becomes not viewable.

70
man/XGrabPointer.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,12 +53,12 @@ XGrabPointer, XUngrabPointer, XChangeActivePointerGrab \- grab the pointer
int XGrabPointer\^(\^Display *\fIdisplay\fP\^, Window \fIgrab_window\fP\^,
Bool \fIowner_events\fP\^, unsigned int \fIevent_mask\fP\^, int
\fIpointer_mode\fP\^, int \fIkeyboard_mode\fP\^, Window \fIconfine_to\fP\^,
Cursor \fIcursor\fP\^, Time \fItime\fP\^);
Cursor \fIcursor\fP\^, Time \fItime\fP\^);
.HP
int XUngrabPointer\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^);
int XUngrabPointer\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^);
.HP
int XChangeActivePointerGrab\^(\^Display *\fIdisplay\fP\^, unsigned int
\fIevent_mask\fP\^, Cursor \fIcursor\fP\^, Time \fItime\fP\^);
\fIevent_mask\fP\^, Cursor \fIcursor\fP\^, Time \fItime\fP\^);
.SH ARGUMENTS
.IP \fIconfine_to\fP 1i
Specifies the window to confine the pointer in or
@ -75,17 +75,17 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits.
Specifies the grab window.
.IP \fIkeyboard_mode\fP 1i
Specifies further processing of keyboard events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
.IP \fIowner_events\fP 1i
Specifies a Boolean value that indicates whether the pointer
events are to be reported as usual or reported with respect to the grab window
Specifies a Boolean value that indicates whether the pointer
events are to be reported as usual or reported with respect to the grab window
if selected by the event mask.
.IP \fIpointer_mode\fP 1i
Specifies further processing of pointer events.
You can pass
You can pass
.B GrabModeSync
or
.BR GrabModeAsync .
@ -102,53 +102,53 @@ if the grab was successful.
Further pointer events are reported only to the grabbing client.
.B XGrabPointer
overrides any active pointer grab by this client.
If owner_events is
If owner_events is
.BR False ,
all generated pointer events
are reported with respect to grab_window and are reported only if
selected by event_mask.
If owner_events is
If owner_events is
.B True
and if a generated
pointer event would normally be reported to this client,
it is reported as usual.
pointer event would normally be reported to this client,
it is reported as usual.
Otherwise, the event is reported with respect to the
grab_window and is reported only if selected by event_mask.
For either value of owner_events, unreported events are discarded.
.LP
If the pointer_mode is
If the pointer_mode is
.BR GrabModeAsync ,
pointer event processing continues as usual.
If the pointer is currently frozen by this client,
If the pointer is currently frozen by this client,
the processing of events for the pointer is resumed.
If the pointer_mode is
If the pointer_mode is
.BR GrabModeSync ,
the state of the pointer, as seen by
client applications,
appears to freeze, and the X server generates no further pointer events
until the grabbing client calls
until the grabbing client calls
.B XAllowEvents
or until the pointer grab is released.
Actual pointer changes are not lost while the pointer is frozen;
they are simply queued in the server for later processing.
.LP
If the keyboard_mode is
If the keyboard_mode is
.BR GrabModeAsync ,
keyboard event processing is unaffected by activation of the grab.
If the keyboard_mode is
If the keyboard_mode is
.BR GrabModeSync ,
the state of the keyboard, as seen by
client applications,
appears to freeze, and the X server generates no further keyboard events
until the grabbing client calls
until the grabbing client calls
.B XAllowEvents
or until the pointer grab is released.
Actual keyboard changes are not lost while the pointer is frozen;
they are simply queued in the server for later processing.
.LP
If a cursor is specified, it is displayed regardless of what
window the pointer is in.
If
window the pointer is in.
If
.B None
is specified,
the normal cursor for that window is displayed
@ -158,11 +158,11 @@ otherwise, the cursor for grab_window is displayed.
If a confine_to window is specified,
the pointer is restricted to stay contained in that window.
The confine_to window need have no relationship to the grab_window.
If the pointer is not initially in the confine_to window,
it is warped automatically to the closest edge
just before the grab activates and enter/leave events are generated as usual.
If the confine_to window is subsequently reconfigured,
the pointer is warped automatically, as necessary,
If the pointer is not initially in the confine_to window,
it is warped automatically to the closest edge
just before the grab activates and enter/leave events are generated as usual.
If the confine_to window is subsequently reconfigured,
the pointer is warped automatically, as necessary,
to keep it contained in the window.
.LP
The time argument allows you to avoid certain circumstances that come up
@ -170,10 +170,10 @@ if applications take a long time to respond or if there are long network
delays.
Consider a situation where you have two applications, both
of which normally grab the pointer when clicked on.
If both applications specify the timestamp from the event,
If both applications specify the timestamp from the event,
the second application may wake up faster and successfully grab the pointer
before the first application.
The first application then will get an indication that the other application
before the first application.
The first application then will get an indication that the other application
grabbed the pointer before its request was processed.
.LP
.B XGrabPointer
@ -195,11 +195,11 @@ it fails and returns
If the pointer is frozen by an active grab of another client,
it fails and returns
.BR GrabFrozen .
If the specified time is earlier than the last-pointer-grab time or later
If the specified time is earlier than the last-pointer-grab time or later
than the current X server time, it fails and returns
.BR GrabInvalidTime .
Otherwise, the last-pointer-grab time is set to the specified time
.Pn ( CurrentTime
.Pn ( CurrentTime
is replaced by the current X server time).
.LP
.B XGrabPointer
@ -221,14 +221,14 @@ or from a normal button press.
does not release the pointer if the specified
time is earlier than the last-pointer-grab time or is later than the
current X server time.
It also generates
It also generates
.B EnterNotify
and
and
.B LeaveNotify
events.
The X server performs an
The X server performs an
.B UngrabPointer
request automatically if the event window or confine_to window
request automatically if the event window or confine_to window
for an active pointer grab becomes not viewable
or if window reconfiguration causes the confine_to window to lie completely
outside the boundaries of the root window.

6
man/XGrabServer.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,7 +50,7 @@
XGrabServer, XUngrabServer \- grab the server
.SH SYNTAX
.HP
int XGrabServer\^(\^Display *\fIdisplay\fP\^);
int XGrabServer\^(\^Display *\fIdisplay\fP\^);
.HP
int XUngrabServer\^(\^Display *\fIdisplay\fP\^);
.SH ARGUMENTS
@ -59,7 +59,7 @@ Specifies the connection to the X server.
.SH DESCRIPTION
The
.B XGrabServer
function disables processing of requests and close downs on all other
function disables processing of requests and close downs on all other
connections than the one this request arrived on.
You should not grab the X server any more than is absolutely necessary.
.LP

16
man/XGraphicsExposeEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -105,7 +105,7 @@ The window member is set to the window that is most useful to toolkit
dispatchers.
.LP
Both structures have these common members: drawable, major_code, and minor_code.
The drawable member is set to the drawable of the destination region on
The drawable member is set to the drawable of the destination region on
which the graphics request was to be performed.
The major_code member is set to the graphics request initiated by the client
and can be either
@ -122,19 +122,19 @@ If it is
a call to
.B XCopyPlane
initiated the request.
These constants are defined in
These constants are defined in
.hN X11/Xproto.h .
The minor_code member,
like the major_code member,
like the major_code member,
indicates which graphics request was initiated by
the client.
the client.
However, the minor_code member is not defined by the core
X protocol and will be zero in these cases,
X protocol and will be zero in these cases,
although it may be used by an extension.
.LP
The
The
.B XGraphicsExposeEvent
structure has these additional members: x, y, width, height, and count.
structure has these additional members: x, y, width, height, and count.
The x and y members are set to the coordinates relative to the drawable's origin
and indicate the upper-left corner of the rectangle.
The width and height members are set to the size (extent) of the rectangle.

6
man/XGravityEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -94,9 +94,9 @@ or
.B SubstructureNotify
was selected.
The window member is set to the child window that was moved.
The x and y members are set to the coordinates relative to the
The x and y members are set to the coordinates relative to the
new parent window's origin
and indicate the position of the upper-left outside corner of the
and indicate the position of the upper-left outside corner of the
window.
.SH "SEE ALSO"
XAnyEvent(__libmansuffix__),

50
man/XIconifyWindow.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,14 +51,14 @@ XIconifyWindow, XWithdrawWindow, XReconfigureWMWindow \- manipulate top-level wi
.SH SYNTAX
.HP
Status XIconifyWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP, int
\fIscreen_number\fP\^);
\fIscreen_number\fP\^);
.HP
Status XWithdrawWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, int
\fIscreen_number\fP\^);
\fIscreen_number\fP\^);
.HP
Status XReconfigureWMWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
int \fIscreen_number\fP\^, unsigned int \fIvalue_mask\fP\^, XWindowChanges
*\fIvalues\fP);
*\fIvalues\fP);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -69,19 +69,19 @@ Specifies which values are to be set using information in
the values structure.
This mask is the bitwise inclusive OR of the valid configure window values bits.
.IP \fIvalues\fP 1i
Specifies the
Specifies the
.B XWindowChanges
structure.
.IP \fIw\fP 1i
Specifies the window.
.SH DESCRIPTION
The
The
.B XIconifyWindow
function sends a WM_CHANGE_STATE
function sends a WM_CHANGE_STATE
.B ClientMessage
event with a format of 32 and a first data element of
event with a format of 32 and a first data element of
.B IconicState
(as described in section 4.1.4 of the
(as described in section 4.1.4 of the
\fIInter-Client Communication Conventions Manual\fP)
and a window of w
to the root window of the specified screen
@ -89,27 +89,27 @@ with an event mask set to
.BR SubstructureNotifyMask |
.BR SubstructureRedirectMask .
Window managers may elect to receive this message and
if the window is in its normal state,
if the window is in its normal state,
may treat it as a request to change the window's state from normal to iconic.
If the WM_CHANGE_STATE property cannot be interned,
If the WM_CHANGE_STATE property cannot be interned,
.B XIconifyWindow
does not send a message and returns a zero status.
It returns a nonzero status if the client message is sent successfully;
otherwise, it returns a zero status.
.LP
The
The
.B XWithdrawWindow
function unmaps the specified window
and sends a synthetic
function unmaps the specified window
and sends a synthetic
.B UnmapNotify
event to the root window of the specified screen.
Window managers may elect to receive this message
Window managers may elect to receive this message
and may treat it as a request to change the window's state to withdrawn.
When a window is in the withdrawn state,
When a window is in the withdrawn state,
neither its normal nor its iconic representations is visible.
It returns a nonzero status if the
It returns a nonzero status if the
.B UnmapNotify
event is successfully sent;
event is successfully sent;
otherwise, it returns a zero status.
.LP
.B XWithdrawWindow
@ -117,19 +117,19 @@ can generate a
.B BadWindow
error.
.LP
The
The
.B XReconfigureWMWindow
function issues a
function issues a
.B ConfigureWindow
request on the specified top-level window.
If the stacking mode is changed and the request fails with a
If the stacking mode is changed and the request fails with a
.B BadMatch
error,
the error is trapped by Xlib and a synthetic
error,
the error is trapped by Xlib and a synthetic
.B ConfigureRequestEvent
containing the same configuration parameters is sent to the root
containing the same configuration parameters is sent to the root
of the specified window.
Window managers may elect to receive this event
Window managers may elect to receive this event
and treat it as a request to reconfigure the indicated window.
It returns a nonzero status if the request or event is successfully sent;
otherwise, it returns a zero status.

26
man/XIfEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,13 +51,13 @@ XIfEvent, XCheckIfEvent, XPeekIfEvent \- check the event queue with a predicate
.SH SYNTAX
.HP
int XIfEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^, Bool
(\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
(\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
.HP
Bool XCheckIfEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^,
Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
.HP
int XPeekIfEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^,
Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
Bool (\^*\fIpredicate\fP\^)\^(\^)\^, XPointer \fIarg\fP\^);
.SH ARGUMENTS
.IP \fIarg\fP 1i
Specifies the user-supplied argument that will be passed to the predicate procedure.
@ -72,14 +72,14 @@ if the next event in the queue matches what you want.
The
.B XIfEvent
function completes only when the specified predicate
procedure returns
procedure returns
.B True
for an event,
for an event,
which indicates an event in the queue matches.
.B XIfEvent
flushes the output buffer if it blocks waiting for additional events.
.B XIfEvent
removes the matching event from the queue
removes the matching event from the queue
and copies the structure into the client-supplied
.B XEvent
structure.
@ -88,7 +88,7 @@ When the predicate procedure finds a match,
.B XCheckIfEvent
copies the matched event into the client-supplied
.B XEvent
structure and returns
structure and returns
.BR True .
(This event is removed from the queue.)
If the predicate procedure finds no match,
@ -101,7 +101,7 @@ All earlier events stored in the queue are not discarded.
The
.B XPeekIfEvent
function returns only when the specified predicate
procedure returns
procedure returns
.B True
for an event.
After the predicate procedure finds a match,
@ -112,7 +112,7 @@ structure without removing the event from the queue.
.B XPeekIfEvent
flushes the output buffer if it blocks waiting for additional events.
.LP
Each of these functions requires you to pass a predicate procedure that
Each of these functions requires you to pass a predicate procedure that
determines if an event matches what you want.
Your predicate procedure must decide if the event is useful
without calling any Xlib functions.
@ -134,7 +134,7 @@ Specifies the
.B XEvent
structure.
.IP \fIarg\fP 1i
Specifies the argument passed in from the
Specifies the argument passed in from the
.BR XIfEvent ,
.BR XCheckIfEvent ,
or
@ -142,8 +142,8 @@ or
function.
.LP
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
event in the queue until it finds a match.
After finding a match, the predicate procedure must return
.BR True .
If it did not find a match, it must return
.BR False .

34
man/XInitImage.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,33 +50,33 @@
XInitImage, XCreateImage, XGetPixel, XPutPixel, XSubImage, XAddPixel, XDestroyImage \- image utilities
.SH SYNTAX
.HP
Status XInitImage\^(\^XImage *\fIimage\fP\^);
Status XInitImage\^(\^XImage *\fIimage\fP\^);
.HP
XImage *XCreateImage\^(\^Display *\fIdisplay\fP\^, Visual *\fIvisual\fP\^,
unsigned int \fIdepth\fP\^, int \fIformat\fP\^, int \fIoffset\fP\^, char
*\fIdata\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, int
\fIbitmap_pad\fP\^, int \fIbytes_per_line\fP\^);
\fIbitmap_pad\fP\^, int \fIbytes_per_line\fP\^);
.HP
unsigned long XGetPixel\^(\^XImage *\fIximage\fP\^, int \fIx\fP\^, int
\fIy\fP\^);
\fIy\fP\^);
.HP
int XPutPixel\^(\^XImage *\fIximage\fP\^, int \fIx\fP\^, int \fIy\fP\^,
unsigned long \fIpixel\fP\^);
unsigned long \fIpixel\fP\^);
.HP
XImage *XSubImage\^(\^XImage *\fIximage\fP\^, int \fIx\fP\^, int \fIy\fP\^,
unsigned int \fIsubimage_width\fP\^, unsigned int \fIsubimage_height\fP\^);
unsigned int \fIsubimage_width\fP\^, unsigned int \fIsubimage_height\fP\^);
.HP
int XAddPixel\^(\^XImage *\fIximage\fP\^, long \fIvalue\fP\^);
int XAddPixel\^(\^XImage *\fIximage\fP\^, long \fIvalue\fP\^);
.HP
int XDestroyImage\^(\^XImage *\^\fIximage\fP\^);
int XDestroyImage\^(\^XImage *\^\fIximage\fP\^);
.SH ARGUMENTS
.IP \fIbitmap_pad\fP 1i
Specifies the quantum of a scanline (8, 16, or 32).
In other words, the start of one scanline is separated in client memory from
the start of the next scanline by an integer multiple of this many bits.
In other words, the start of one scanline is separated in client memory from
the start of the next scanline by an integer multiple of this many bits.
.IP \fIbytes_per_line\fP 1i
Specifies the number of bytes in the client image between
the start of one scanline and the start of the next.
the start of one scanline and the start of the next.
.IP \fIdata\fP 1i
Specifies the image data.
.IP \fIdepth\fP 1i
@ -88,7 +88,7 @@ Specifies the format for the image.
You can pass
.BR XYBitmap ,
.BR XYPixmap ,
or
or
.BR ZPixmap .
.IP \fIheight\fP 1i
Specifies the height of the image, in pixels.
@ -146,15 +146,15 @@ function allocates the memory needed for an
structure for the
specified display but does not allocate space for the image itself.
Rather, it initializes the structure byte-order, bit-order, and bitmap-unit
values from the display and returns a pointer to the
values from the display and returns a pointer to the
.B XImage
structure.
The red, green, and blue mask values are defined for Z format images only
and are derived from the
and are derived from the
.B Visual
structure passed in.
Other values also are passed in.
The offset permits the rapid displaying of the image without requiring each
The offset permits the rapid displaying of the image without requiring each
scanline to be shifted into position.
If you pass a zero value in bytes_per_line,
Xlib assumes that the scanlines are contiguous
@ -165,9 +165,9 @@ Note that when the image is created using
.BR XGetImage ,
or
.BR XSubImage ,
the destroy procedure that the
the destroy procedure that the
.B XDestroyImage
function calls frees both the image structure
function calls frees both the image structure
and the data pointed to by the image structure.
.LP
The basic functions used to get a pixel, set a pixel, create a subimage,

6
man/XInitThreads.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,9 +52,9 @@ XInitThreads, XLockDisplay, XUnlockDisplay \- multi-threading support
.HP
Status XInitThreads\^(void);
.HP
void XLockDisplay\^(\^Display *\fIdisplay\fP\^);
void XLockDisplay\^(\^Display *\fIdisplay\fP\^);
.HP
void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^);
void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.

20
man/XInstallColormap.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,10 +53,10 @@ XInstallColormap, XUninstallColormap, XListInstalledColormaps \- control colorma
int XInstallColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^);
.HP
int XUninstallColormap\^(\^Display *\fIdisplay\fP\^, Colormap
\fIcolormap\fP\^);
\fIcolormap\fP\^);
.HP
Colormap *XListInstalledColormaps\^(\^Display *\fIdisplay\fP\^, Window
\fIw\fP\^, int *\fInum_return\fP\^);
\fIw\fP\^, int *\fInum_return\fP\^);
.SH ARGUMENTS
.IP \fIcolormap\fP 1i
Specifies the colormap.
@ -79,11 +79,11 @@ You associated the windows with this colormap when you created them by calling
or
.BR XSetWindowColormap .
.LP
If the specified colormap is not already an installed colormap,
If the specified colormap is not already an installed colormap,
the X server generates a
.B ColormapNotify
event on each window that has that colormap.
In addition, for every other colormap that is installed as
In addition, for every other colormap that is installed as
a result of a call to
.BR XInstallColormap ,
the X server generates a
@ -100,17 +100,17 @@ The
function removes the specified colormap from the required
list for its screen.
As a result,
the specified colormap might be uninstalled,
the specified colormap might be uninstalled,
and the X server might implicitly install or uninstall additional colormaps.
Which colormaps get installed or uninstalled is server dependent
except that the required list must remain installed.
.LP
If the specified colormap becomes uninstalled,
If the specified colormap becomes uninstalled,
the X server generates a
.B ColormapNotify
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
In addition, for every other colormap that is installed or uninstalled as a
result of a call to
.BR XUninstallColormap ,
the X server generates a
.B ColormapNotify
@ -123,7 +123,7 @@ error.
.LP
The
.B XListInstalledColormaps
function returns a list of the currently installed colormaps for the screen
function returns a list of the currently installed colormaps for the screen
of the specified window.
The order of the colormaps in the list is not significant
and is no explicit indication of the required list.

18
man/XInternAtom.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,15 +51,15 @@ XInternAtom, XInternAtoms, XGetAtomName, XGetAtomNames \- create or return atom
.SH SYNTAX
.HP
Atom XInternAtom\^(\^Display *\fIdisplay\fP\^, char *\fIatom_name\fP\^, Bool
\fIonly_if_exists\fP\^);
\fIonly_if_exists\fP\^);
.HP
Status XInternAtoms\^(\^Display *\fIdisplay\fP\^, char **\fInames\fP\^, int
\fIcount\fP\^, Bool \fIonly_if_exists\fP\^, Atom *\fIatoms_return\fP\^);
\fIcount\fP\^, Bool \fIonly_if_exists\fP\^, Atom *\fIatoms_return\fP\^);
.HP
char *XGetAtomName\^(\^Display *\fIdisplay\fP\^, Atom \fIatom\fP\^);
char *XGetAtomName\^(\^Display *\fIdisplay\fP\^, Atom \fIatom\fP\^);
.HP
Status XGetAtomNames\^(\^Display *\fIdisplay\fP\^, Atom *\fIatoms\fP\^, int
\fIcount\fP\^, char **\fInames_return\fP\^);
\fIcount\fP\^, char **\fInames_return\fP\^);
.SH ARGUMENTS
.IP \fIatom\fP 1i
Specifies the atom for the property name you want returned.
@ -84,18 +84,18 @@ The
.B XInternAtom
function returns the atom identifier associated with the specified atom_name
string.
If only_if_exists is
If only_if_exists is
.BR False ,
the atom is created if it does not exist.
Therefore,
.B XInternAtom
can return
.BR None .
If the atom name is not in the Host Portable Character Encoding,
If the atom name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Uppercase and lowercase matter;
the strings \*(lqthing\*(rq, \*(lqThing\*(rq, and \*(lqthinG\*(rq
all designate different atoms.
the strings \*(lqthing\*(rq, \*(lqThing\*(rq, and \*(lqthinG\*(rq
all designate different atoms.
The atom will remain defined even after the client's connection closes.
It will become undefined only when the last connection to
the X server closes.

16
man/XIntersectRegion.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,23 +51,23 @@ XIntersectRegion, XUnionRegion, XUnionRectWithRegion, XSubtractRegion, XXorRegio
.SH SYNTAX
.HP
int XIntersectRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
\fIdr_return\fP\^);
\fIdr_return\fP\^);
.HP
int XUnionRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
\fIdr_return\fP\^);
\fIdr_return\fP\^);
.HP
int XUnionRectWithRegion\^(\^XRectangle *\fIrectangle\fP\^, Region
\fIsrc_region\fP\^, Region \fIdest_region_return\fP\^);
\fIsrc_region\fP\^, Region \fIdest_region_return\fP\^);
.HP
int XSubtractRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
\fIdr_return\fP\^);
\fIdr_return\fP\^);
.HP
int XXorRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
\fIdr_return\fP\^);
\fIdr_return\fP\^);
.HP
int XOffsetRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^);
int XOffsetRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^);
.HP
int XShrinkRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^);
int XShrinkRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^);
.SH ARGUMENTS
.IP \fIdest_region_return\fP 1i
Returns the destination region.

8
man/XKeymapEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -62,7 +62,7 @@ typedef struct {
Display *display; /\&* Display the event was read from */
Window window;
char key_vector[32];
} XKeymapEvent;
} XKeymapEvent;
.EE
.LP
When you receive this event,
@ -89,10 +89,10 @@ dispatchers.
.LP
The window member is not used but is present to aid some toolkits.
The key_vector member is set to the bit vector of the keyboard.
Each bit set to 1 indicates that the corresponding key
Each bit set to 1 indicates that the corresponding key
is currently pressed.
The vector is represented as 32 bytes.
Byte N (from 0) contains the bits for keys 8N to 8N + 7
Byte N (from 0) contains the bits for keys 8N to 8N + 7
with the least significant bit in the byte representing key 8N.
.SH "SEE ALSO"
XAnyEvent(__libmansuffix__),

14
man/XListFonts.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,16 +51,16 @@ XListFonts, XFreeFontNames, XListFontsWithInfo, XFreeFontInfo \- obtain or free
.SH SYNTAX
.HP
char **XListFonts\^(\^Display *\^\fIdisplay\fP\^, char *\^\fIpattern\fP\^, int
\fImaxnames\fP\^, int *\^\fIactual_count_return\fP\^);
\fImaxnames\fP\^, int *\^\fIactual_count_return\fP\^);
.HP
int XFreeFontNames\^(\^char *\fIlist\fP\^[\^]\^);
int XFreeFontNames\^(\^char *\fIlist\fP\^[\^]\^);
.HP
char **XListFontsWithInfo\^(\^Display *\fIdisplay\fP\^, char *\fIpattern\fP\^,
int \fImaxnames\fP\^, int *\fIcount_return\fP\^, XFontStruct
**\fIinfo_return\fP\^);
**\fIinfo_return\fP\^);
.HP
int XFreeFontInfo(\^char **\fInames\fP\^, XFontStruct *\fIfree_info\fP, int
\fIactual_count\fP\^);
\fIactual_count\fP\^);
.SH ARGUMENTS
.IP \fIactual_count\fP 1i
Specifies the actual number of font names.
@ -84,12 +84,12 @@ Specifies the maximum number of names to be returned.
Specifies the list of font names.
.IP \fIpattern\fP 1i
Specifies the null-terminated pattern string that can contain wildcard
Specifies the null-terminated pattern string that can contain wildcard
characters.
.SH DESCRIPTION
The
.B XListFonts
function returns an array of available font names
function returns an array of available font names
(as controlled by the font search path; see
.BR XSetFontPath )
that match the string you passed to the pattern argument.

82
man/XLoadFont.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -60,19 +60,19 @@
XLoadFont, XQueryFont, XLoadQueryFont, XFreeFont, XGetFontProperty, XUnloadFont, XCharStruct, XFontProp, XChar2b, XFontStruct \- load or unload fonts and font metric structures
.SH SYNTAX
.HP
Font XLoadFont\^(\^Display *\fIdisplay\fP\^, char *\fIname\fP\^);
Font XLoadFont\^(\^Display *\fIdisplay\fP\^, char *\fIname\fP\^);
.HP
XFontStruct *XQueryFont\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^);
XFontStruct *XQueryFont\^(\^Display *\fIdisplay\fP\^, XID \fIfont_ID\fP\^);
.HP
XFontStruct *XLoadQueryFont\^(\^Display *\fIdisplay\fP\^, char
*\fIname\fP\^);
*\fIname\fP\^);
.HP
int XFreeFont\^(\^Display *\fIdisplay\fP\^, XFontStruct *\fIfont_struct\fP\^);
.HP
Bool XGetFontProperty\^(\^XFontStruct *\fIfont_struct\fP\^, Atom \fIatom\fP\^,
unsigned long *\fIvalue_return\fP\^);
unsigned long *\fIvalue_return\fP\^);
.HP
int XUnloadFont\^(\^Display *\fIdisplay\fP\^, Font \fIfont\fP\^);
int XUnloadFont\^(\^Display *\fIdisplay\fP\^, Font \fIfont\fP\^);
.SH ARGUMENTS
.IP \fIatom\fP 1i
Specifies the atom for the property name you want returned.
@ -81,7 +81,7 @@ Specifies the connection to the X server.
.IP \fIfont\fP 1i
Specifies the font.
.IP \fIfont_ID\fP 1i
Specifies the font ID or the
Specifies the font ID or the
.B GContext
ID.
.IP \fIfont_struct\fP 1i
@ -102,21 +102,21 @@ the result is implementation-dependent.
Use of uppercase or lowercase does not matter.
When the characters \*(lq?\*(rq and \*(lq\*(rq are used in a font name, a
pattern match is performed and any matching font is used.
In the pattern,
the \*(lq?\*(rq character will match any single character,
In the pattern,
the \*(lq?\*(rq character will match any single character,
and the \*(lq*\*(rq character will match any number of characters.
A structured format for font names is specified in the X Consortium standard
A structured format for font names is specified in the X Consortium standard
\fIX Logical Font Description Conventions\fP.
If
If
.B XLoadFont
was unsuccessful at loading the specified font,
a
was unsuccessful at loading the specified font,
a
.B BadName
error results.
Fonts are not associated with a particular screen
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
When the font is no longer needed, call
.BR XUnloadFont .
.LP
.B XLoadFont
@ -132,9 +132,9 @@ function returns a pointer to the
.B XFontStruct
structure, which contains information associated with the font.
You can query a font or the font stored in a GC.
The font ID stored in the
The font ID stored in the
.B XFontStruct
structure will be the
structure will be the
.B GContext
ID, and you need to be careful when using this ID in other functions
(see
@ -166,7 +166,7 @@ returns NULL.
.LP
The
.B XFreeFont
function deletes the association between the font resource ID and the specified
function deletes the association between the font resource ID and the specified
font and frees the
.B XFontStruct
structure.
@ -181,11 +181,11 @@ error.
Given the atom for that property,
the
.B XGetFontProperty
function returns the value of the specified font property.
function returns the value of the specified font property.
.B XGetFontProperty
also returns
also returns
.B False
if the property was not defined or
if the property was not defined or
.B True
if it was defined.
A set of predefined atoms exists for font properties,
@ -283,7 +283,7 @@ byte2 defines the range of defined columns of the font.
Single byte/character fonts have one row defined, and the byte2 range
specified in the structure defines a range of characters.
.LP
The bounding box of a character is defined by the
The bounding box of a character is defined by the
.B XCharStruct
of that character.
When characters are absent from a font,
@ -293,22 +293,22 @@ only the information in the
.B XFontStruct
min and max bounds are used.
.LP
The members of the
The members of the
.B XFontStruct
have the following semantics:
.IP \(bu 5
The direction member can be either
The direction member can be either
.B FontLeftToRight
or
or
.BR FontRightToLeft .
It is just a hint as to whether most
It is just a hint as to whether most
.B XCharStruct
elements
have a positive
.Pn ( FontLeftToRight )
or a negative
elements
have a positive
.Pn ( FontLeftToRight )
or a negative
.Pn ( FontRightToLeft )
character width
character width
metric.
The core protocol defines no support for vertical text.
.IP \(bu 5
@ -318,7 +318,7 @@ of the per_char array, and max_char_or_byte2 specifies the linear character
index of the last element.
.IP
If either min_byte1 or max_byte1 are nonzero, both
min_char_or_byte2 and max_char_or_byte2 are less than 256,
min_char_or_byte2 and max_char_or_byte2 are less than 256,
and the 2-byte character index values corresponding to the
per_char array element N (counting from 0) are:
.IP
@ -333,26 +333,26 @@ where:
\e\e = integer modulus
.EE
.IP \(bu 5
If the per_char pointer is NULL,
If the per_char pointer is NULL,
all glyphs between the first and last character indexes
inclusive have the same information,
as given by both min_bounds and max_bounds.
.IP \(bu 5
If all_chars_exist is
If all_chars_exist is
.BR True ,
all characters in the per_char array have nonzero bounding boxes.
.IP \(bu 5
The default_char member specifies the character that will be used when an
undefined or nonexistent character is printed.
undefined or nonexistent character is printed.
The default_char is a 16-bit character (not a 2-byte character).
For a font using 2-byte matrix format,
For a font using 2-byte matrix format,
the default_char has byte1 in the most-significant byte
and byte2 in the least significant byte.
If the default_char itself specifies an undefined or nonexistent character,
If the default_char itself specifies an undefined or nonexistent character,
no printing is performed for an undefined or nonexistent character.
.IP \(bu 5
The min_bounds and max_bounds members contain the most extreme values of
each individual
each individual
.B XCharStruct
component over all elements of this array
(and ignore nonexistent characters).
@ -383,16 +383,16 @@ baseline that is used for determining line spacing.
Specific characters may extend beyond this.
.IP \(bu 5
If the baseline is at Y-coordinate y,
the logical extent of the font is inclusive between the Y-coordinate
the logical extent of the font is inclusive between the Y-coordinate
values (y \- font.ascent) and (y + font.descent \- 1).
Typically,
the minimum interline spacing between rows of text is given
by ascent + descent.
.LP
For a character origin at [x,y],
the bounding box of a character (that is,
the bounding box of a character (that is,
the smallest rectangle that encloses the character's shape)
described in terms of
described in terms of
.B XCharStruct
components is a rectangle with its upper-left corner at:
.LP

16
man/XLookupKeysym.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,17 +50,17 @@
XLookupKeysym, XRefreshKeyboardMapping, XLookupString, XRebindKeysym \- handle keyboard input events in Latin-1
.SH SYNTAX
.HP
KeySym XLookupKeysym(\^XKeyEvent *\fIkey_event\fP\^, int \fIindex\fP\^);
KeySym XLookupKeysym(\^XKeyEvent *\fIkey_event\fP\^, int \fIindex\fP\^);
.HP
int XRefreshKeyboardMapping(\^XMappingEvent *\fIevent_map\fP\^);
int XRefreshKeyboardMapping(\^XMappingEvent *\fIevent_map\fP\^);
.HP
int XLookupString(\^XKeyEvent *\fIevent_struct\fP\^, char
*\fIbuffer_return\fP\^, int \fIbytes_buffer\fP\^, KeySym
*\fIkeysym_return\fP\^, XComposeStatus *\fIstatus_in_out\fP\^);
*\fIkeysym_return\fP\^, XComposeStatus *\fIstatus_in_out\fP\^);
.HP
int XRebindKeysym(\^Display *\fIdisplay\fP\^, KeySym \fIkeysym\fP\^, KeySym
\fIlist\fP\^[\^]\^, int \fImod_count\fP\^, unsigned char *\fIstring\fP\^, int
\fInum_bytes\fP\^);
\fInum_bytes\fP\^);
.SH ARGUMENTS
.IP \fIbuffer_return\fP 1i
Returns the translated characters.
@ -82,7 +82,7 @@ or
.IP \fIindex\fP 1i
Specifies the index into the KeySyms list for the event's KeyCode.
.IP \fIkey_event\fP 1i
Specifies the
Specifies the
.B KeyPress
or
.B KeyRelease
@ -96,11 +96,11 @@ Specifies the KeySyms to be used as modifiers.
.IP \fImod_count\fP 1i
Specifies the number of modifiers in the modifier list.
.IP \fIstatus_in_out\fP 1i
Specifies or returns the
Specifies or returns the
.B XComposeStatus
structure or NULL.
.IP \fIstring\fP 1i
Specifies the string that is copied and will be returned by
Specifies the string that is copied and will be returned by
.BR XLookupString .
.SH DESCRIPTION
The

12
man/XMapEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -96,7 +96,7 @@ was selected.
The window member is set to the window that was mapped.
The override_redirect member is set to the override-redirect attribute
of the window.
Window manager clients normally should ignore this window
Window manager clients normally should ignore this window
if the override-redirect attribute is
.BR True ,
because these events usually are generated from pop-ups,
@ -155,12 +155,12 @@ If it is
the keyboard mapping was changed.
If it is
.BR MappingPointer ,
the pointer button mapping was changed.
The first_keycode and count members are set only
the pointer button mapping was changed.
The first_keycode and count members are set only
if the request member was set to
.BR MappingKeyboard .
The number in first_keycode represents the first number in the range
of the altered mapping,
The number in first_keycode represents the first number in the range
of the altered mapping,
and count represents the number of keycodes altered.
.SH "SEE ALSO"
XAnyEvent(__libmansuffix__),

2
man/XMapRequestEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface

32
man/XMapWindow.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,11 +50,11 @@
XMapWindow, XMapRaised, XMapSubwindows \- map windows
.SH SYNTAX
.HP
int XMapWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
int XMapWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
.HP
int XMapRaised\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
int XMapRaised\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
.HP
int XMapSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
int XMapSubwindows\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -92,14 +92,14 @@ If the window becomes viewable and no earlier contents for it are remembered,
the X server tiles the window with its background.
If the window's background is undefined,
the existing screen contents are not
altered, and the X server generates zero or more
altered, and the X server generates zero or more
.B Expose
events.
If backing-store was maintained while the window was unmapped, no
If backing-store was maintained while the window was unmapped, no
.B Expose
events
are generated.
If backing-store will now be maintained,
If backing-store will now be maintained,
a full-window exposure is always generated.
Otherwise, only visible regions may be reported.
Similar tiling and exposure take place for any newly viewable inferiors.
@ -109,25 +109,25 @@ If the window is an
.B InputOutput
window,
.B XMapWindow
generates
generates
.B Expose
events on each
events on each
.B InputOutput
window that it causes to be displayed.
If the client maps and paints the window
and if the client begins processing events,
If the client maps and paints the window
and if the client begins processing events,
the window is painted twice.
To avoid this,
first ask for
first ask for
.B Expose
events and then map the window,
so the client processes input events as usual.
The event list will include
The event list will include
.B Expose
for each
window that has appeared on the screen.
window that has appeared on the screen.
The client's normal response to
an
an
.B Expose
event should be to repaint the window.
This method usually leads to simpler programs and to proper interaction
@ -155,7 +155,7 @@ error.
The
.B XMapSubwindows
.IN "XMapSubwindows"
function maps all subwindows for a specified window in top-to-bottom stacking
function maps all subwindows for a specified window in top-to-bottom stacking
order.
The X server generates
.B Expose

26
man/XNextEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,27 +50,27 @@
XNextEvent, XPeekEvent, XWindowEvent, XCheckWindowEvent, XMaskEvent, XCheckMaskEvent, XCheckTypedEvent, XCheckTypedWindowEvent \- select events by type
.SH SYNTAX
.HP
int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^);
int XNextEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^);
.HP
int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^);
int XPeekEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent_return\fP\^);
.HP
int XWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long
\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^);
\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^);
.HP
Bool XCheckWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, long
\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^);
\fIevent_mask\fP\^, XEvent *\fIevent_return\fP\^);
.HP
int XMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^, XEvent
*\fIevent_return\fP\^);
*\fIevent_return\fP\^);
.HP
Bool XCheckMaskEvent\^(\^Display *\fIdisplay\fP\^, long \fIevent_mask\fP\^,
XEvent *\fIevent_return\fP\^);
XEvent *\fIevent_return\fP\^);
.HP
Bool XCheckTypedEvent\^(\^Display *\fIdisplay\fP\^, int \fIevent_type\fP\^,
XEvent *\fIevent_return\fP\^);
XEvent *\fIevent_return\fP\^);
.HP
Bool XCheckTypedWindowEvent\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^,
int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^);
int \fIevent_type\fP\^, XEvent *\fIevent_return\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -123,7 +123,7 @@ flushes the output buffer and blocks until one is received.
.LP
The
.B XCheckWindowEvent
function searches the event queue and then the events available
function searches the event queue and then the events available
on the server connection for the first event that matches the specified window
and event mask.
If it finds a match,
@ -141,7 +141,7 @@ and the output buffer will have been flushed.
.LP
The
.B XMaskEvent
function searches the event queue for the events associated with the
function searches the event queue for the events associated with the
specified mask.
When it finds a match,
.B XMaskEvent
@ -172,7 +172,7 @@ and the output buffer will have been flushed.
.LP
The
.B XCheckTypedEvent
function searches the event queue and then any events available
function searches the event queue and then any events available
on the server connection for the first event that matches the specified type.
If it finds a match,
.B XCheckTypedEvent
@ -189,7 +189,7 @@ and the output buffer will have been flushed.
.LP
The
.B XCheckTypedWindowEvent
function searches the event queue and then any events available
function searches the event queue and then any events available
on the server connection for the first event that matches the specified
type and window.
If it finds a match,

6
man/XNoOp.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -49,14 +49,14 @@
.SH NAME
XNoOp \- No Operation
.SH SYNTAX
int XNoOp\^(\^Display *\fIdisplay\fP\^);
int XNoOp\^(\^Display *\fIdisplay\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.SH DESCRIPTION
The
.B XNoOp
function sends a
function sends a
.B NoOperation
protocol request to the X server,
thereby exercising the connection.

30
man/XOpenDisplay.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,28 +50,28 @@
XOpenDisplay, XCloseDisplay \- connect or disconnect to X server
.SH SYNTAX
.HP
Display *XOpenDisplay\^(\^char *\fIdisplay_name\fP\^);
Display *XOpenDisplay\^(\^char *\fIdisplay_name\fP\^);
.HP
int XCloseDisplay\^(Display *\fIdisplay\fP\^);
int XCloseDisplay\^(Display *\fIdisplay\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIdisplay_name\fP 1i
Specifies the hardware display name, which determines the display
and communications domain to be used.
On a POSIX-conformant system, if the display_name is NULL,
it defaults to the value of the DISPLAY environment variable.
On a POSIX-conformant system, if the display_name is NULL,
it defaults to the value of the DISPLAY environment variable.
.IN "Environment" "DISPLAY"
.SH DESCRIPTION
The
.B XOpenDisplay
function returns a
function returns a
.B Display
structure that serves as the
connection to the X server and that contains all the information
about that X server.
.B XOpenDisplay
connects your application to the X server through TCP
connects your application to the X server through TCP
or DECnet communications protocols,
or through some local inter-process communication protocol.
.IN "Protocol" "TCP"
@ -92,21 +92,21 @@ A particular Xlib implementation can support many more of these transport
mechanisms.
.LP
.IN "Display"
If successful,
If successful,
.B XOpenDisplay
returns a pointer to a
returns a pointer to a
.B Display
structure,
which is defined in
which is defined in
.hN X11/Xlib.h .
If
If
.B XOpenDisplay
does not succeed, it returns NULL.
After a successful call to
.BR XOpenDisplay ,
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
The screen number specified in the display_name argument is returned
by the
.B DefaultScreen
macro (or the
.B XDefaultScreen
@ -116,7 +116,7 @@ You can access elements of the
and
.B Screen
structures only by using the information macros or functions.
For information about using macros and functions to obtain information from
For information about using macros and functions to obtain information from
the
.B Display
structure,
@ -138,7 +138,7 @@ or other resources that the client has created
on this display, unless the close-down mode of the resource has been changed
(see
.BR XSetCloseDownMode ).
Therefore, these windows, resource IDs, and other resources should never be
Therefore, these windows, resource IDs, and other resources should never be
referenced again or an error will be generated.
Before exiting, you should call
.B XCloseDisplay

34
man/XOpenIM.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,25 +51,25 @@ XOpenIM, XCloseIM, XSetIMValues, XGetIMValues, XDisplayOfIM, XLocaleOfIM, XRegis
.SH SYNTAX
.HP
XIM XOpenIM\^(\^Display *\fIdisplay\fP\^, XrmDatabase \fIdb\fP\^, char
*\fIres_name\fP\^, char *\fIres_class\fP\^);
*\fIres_name\fP\^, char *\fIres_class\fP\^);
.HP
Status XCloseIM\^(\^XIM \fIim\fP\^);
Status XCloseIM\^(\^XIM \fIim\fP\^);
.HP
char *XSetIMValues\^(\^XIM \fIim\fP\^, ...);
char *XSetIMValues\^(\^XIM \fIim\fP\^, ...);
.HP
char *XGetIMValues\^(\^XIM \fIim\fP\^, ...);
char *XGetIMValues\^(\^XIM \fIim\fP\^, ...);
.HP
Display *XDisplayOfIM\^(\^XIM \fIim\fP\^);
Display *XDisplayOfIM\^(\^XIM \fIim\fP\^);
.HP
char *XLocaleOfIM\^(\^XIM \fIim\fP\^);
char *XLocaleOfIM\^(\^XIM \fIim\fP\^);
.HP
Bool XRegisterIMInstantiateCallback\^(\^Display *\fIdisplay\fP\^, XrmDatabase
\fIdb\fP\^, char *\fIres_name\fP\^, char *\fIres_class\fP\^, XIDProc
\fIcallback\fP\^, XPointer \fIclient_data\fP\^);
\fIcallback\fP\^, XPointer \fIclient_data\fP\^);
.HP
Bool XUnregisterIMInstantiateCallback\^(\^Display *\fIdisplay\fP\^,
XrmDatabase \fIdb\fP\^, char *\fIres_name\fP\^, char *\fIres_class\fP\^,
XIDProc \fIcallback\fP\^, XPointer \fIclient_data\fP\^);
XIDProc \fIcallback\fP\^, XPointer \fIclient_data\fP\^);
.LP
.SH ARGUMENTS
.IP \fIcallback\fP 1i
@ -91,7 +91,7 @@ Specifies the variable length argument list to set or get XIM values.
.SH DESCRIPTION
The
.B XOpenIM
function opens an input method,
function opens an input method,
matching the current locale and modifiers specification.
Current locale and modifiers are bound to the input method at opening time.
The locale associated with an input method cannot be changed dynamically.
@ -103,11 +103,11 @@ for any input context affiliated with a given input method
will be encoded in the locale current at the time the input method is opened.
.LP
The specific input method to which this call will be routed
is identified on the basis of the current locale.
is identified on the basis of the current locale.
.B XOpenIM
will identify a default input method corresponding to the
current locale.
That default can be modified using
That default can be modified using
.B XSetLocaleModifiers
for the input method modifier.
.LP
@ -118,8 +118,8 @@ up values that can be set as IC values in an input context.
If db is NULL,
no database is passed to the input method.
.LP
The res_name and res_class arguments specify the resource name
and class of the application.
The res_name and res_class arguments specify the resource name
and class of the application.
They are intended to be used as prefixes by the input method
when looking up resources that are common to all input contexts
that may be created for this input method.
@ -187,9 +187,9 @@ function registers a callback to be invoked whenever a new input method
becomes available for the specified display that matches the current
locale and modifiers.
.LP
The function returns
The function returns
.B True
if it succeeds; otherwise, it returns
if it succeeds; otherwise, it returns
.BR False .
.LP
The
@ -198,7 +198,7 @@ function removes an input method instantiation callback previously
registered.
The function returns
.B True
if it succeeds; otherwise, it returns
if it succeeds; otherwise, it returns
.BR False .
.SH "SEE ALSO"
XCreateIC(__libmansuffix__),

18
man/XOpenOM.man
View file

@ -52,17 +52,17 @@ XOpenOM, XCloseOM, XSetOMValues, XGetOMValues, XDisplayOfOM, XLocaleOfOM \- open
.SH SYNTAX
.HP
XOM XOpenOM\^(\^Display *\fIdisplay\fP\^, XrmDatabase \fIdb\fP\^, char
*\fIres_name\fP\^, char *\fIres_class\fP\^);
*\fIres_name\fP\^, char *\fIres_class\fP\^);
.HP
Status XCloseOM\^(\^XOM \fIom\fP\^);
Status XCloseOM\^(\^XOM \fIom\fP\^);
.HP
char *XSetOMValues\^(\^XOM \fIom\fP\^);
char *XSetOMValues\^(\^XOM \fIom\fP\^);
.HP
char *XGetOMValues\^(\^XOM \fIom\fP\^);
char *XGetOMValues\^(\^XOM \fIom\fP\^);
.HP
Display *XDisplayOfOM\^(\^XOM \fIom\fP\^);
Display *XDisplayOfOM\^(\^XOM \fIom\fP\^);
.HP
char *XLocaleOfOM\^(\^XOM \fIom\fP\^);
char *XLocaleOfOM\^(\^XOM \fIom\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -92,7 +92,7 @@ is identified on the basis of the current locale and modifiers.
.B XOpenOM
will identify a default output method corresponding to the
current locale.
That default can be modified using
That default can be modified using
.B XSetLocaleModifiers
to set the output method modifier.
.LP
@ -103,8 +103,8 @@ up values that can be set as OC values in an output context.
If db is NULL,
no database is passed to the output method.
.LP
The res_name and res_class arguments specify the resource name
and class of the application.
The res_name and res_class arguments specify the resource name
and class of the application.
They are intended to be used as prefixes by the output method
when looking up resources that are common to all output contexts
that may be created for this output method.

46
man/XParseGeometry.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,13 +52,13 @@ XParseGeometry, XWMGeometry \- parse window geometry
.HP
int XParseGeometry\^(\^char *\fIparsestring\fP\^, int *\fIx_return\fP\^, int
*\fIy_return\fP\^, unsigned int *\fIwidth_return\fP\^, unsigned int
*\fIheight_return\fP\^);
*\fIheight_return\fP\^);
.HP
int XWMGeometry\^(\^Display *\fIdisplay\fP\^, int \fIscreen\fP\^, char
*\fIuser_geom\fP\^, char *\fIdef_geom\fP\^, unsigned int \fIbwidth\fP\^,
XSizeHints *\fIhints\fP\^, int *\fIx_return\fP, int *\fIy_return\fP\^, int
*\fIwidth_return\fP\^, int *\fIheight_return\fP\^, int
*\fIgravity_return\fP\^);
*\fIgravity_return\fP\^);
.SH ARGUMENTS
.IP \fIposition\fP 1i
.br
@ -111,7 +111,7 @@ Specifically, this function lets you parse strings of the form:
.LP
.\" Start marker code here
.EX
[=][<\fIwidth\fP>{xX}<\fIheight\fP>][{+-}<\fIxoffset\fP>{+-}<\fIyoffset\fP>]
[=][<\fIwidth\fP>{xX}<\fIheight\fP>][{+-}<\fIxoffset\fP>{+-}<\fIyoffset\fP>]
.EE
.\" End marker code here
.LP
@ -125,8 +125,8 @@ the result is implementation-dependent.
The
.B XParseGeometry
function returns a bitmask that indicates which of the four values (width,
height, xoffset, and yoffset) were actually found in the string
and whether the x and y values are negative.
height, xoffset, and yoffset) were actually found in the string
and whether the x and y values are negative.
By convention, \-0 is not equal to +0, because the user needs to
be able to say \*(lqposition the window relative to the right or bottom edge.\*(rq
For each value found, the corresponding argument is updated.
@ -139,49 +139,49 @@ The bits are represented by
.BR XNegative ,
or
.B YNegative
and are defined in
and are defined in
.hN X11/Xutil.h .
They will be set whenever one of the values is defined
They will be set whenever one of the values is defined
or one of the signs is set.
.LP
If the function returns either the
If the function returns either the
.B XValue
or
or
.B YValue
flag,
you should place the window at the requested position.
.LP
The
The
.B XWMGeometry
function combines any geometry information (given in the format used by
function combines any geometry information (given in the format used by
.BR XParseGeometry )
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,
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
.Pn ( NorthWestGravity ,
.Pn ( NorthWestGravity ,
.BR NorthEastGravity ,
.BR SouthEastGravity ,
or
.BR SouthWestGravity )
that describe the window.
If the base size is not set in the
If the base size is not set in the
.B XSizeHints
structure,
structure,
the minimum size is used if set.
Otherwise, a base size of zero is assumed.
If no minimum size is set in the hints structure,
If no minimum size is set in the hints structure,
the base size is used.
A mask (in the form returned by
A mask (in the form returned by
.BR XParseGeometry )
that describes which values came from the user specification
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.
Note that these coordinates will have already been accounted for
Note that these coordinates will have already been accounted for
in the x_return and y_return values.
.LP
Note that invalid geometry specifications can cause a width or height
Note that invalid geometry specifications can cause a width or height
of zero to be returned.
The caller may pass the address of the hints win_gravity field
The caller may pass the address of the hints win_gravity field
as gravity_return to update the hints directly.
.SH "SEE ALSO"
XSetWMProperties(__libmansuffix__)

10
man/XPolygonRegion.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -51,18 +51,18 @@ XPolygonRegion, XClipBox \- generate regions
.SH SYNTAX
.HP
Region XPolygonRegion\^(\^XPoint \fIpoints\fP[]\^, int \fIn\fP\^, int
\fIfill_rule\fP\^);
\fIfill_rule\fP\^);
.HP
int XClipBox\^(\^Region \fIr\fP\^, XRectangle *\fIrect_return\fP\^);
int XClipBox\^(\^Region \fIr\fP\^, XRectangle *\fIrect_return\fP\^);
.SH ARGUMENTS
.IP \fIfill_rule\fP 1i
Specifies the fill-rule you want to set for the specified GC.
You can pass
You can pass
.B EvenOddRule
or
.BR WindingRule .
.IP \fIn\fP 1i
Specifies the number of points in the polygon.
Specifies the number of points in the polygon.
.IP \fIpoints\fP 1i
Specifies an array of points.
.IP \fIr\fP 1i

10
man/XPropertyEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -88,12 +88,12 @@ but expanded from the 16-bit least-significant bits to a full 32-bit value.
The window member is set to the window that is most useful to toolkit
dispatchers.
.LP
The window member is set to the window whose associated
The window member is set to the window whose associated
property was changed.
The atom member is set to the property's atom and indicates which
property was changed or desired.
The time member is set to the server time when the property was changed.
The state member is set to indicate whether the property was changed
The state member is set to indicate whether the property was changed
to a new value or deleted and can be
.B PropertyNewValue
or
@ -108,13 +108,13 @@ or
.BR XChangeProperty )
and when replacing all or part of a property with identical data using
.B XChangeProperty
or
or
.BR XRotateWindowProperties .
The state member is set to
.B PropertyDelete
when a property of the window is deleted using
.B XDeleteProperty
or, if the delete argument is
or, if the delete argument is
.BR True ,
.BR XGetWindowProperty .
.SH "SEE ALSO"

4
man/XPutBackEvent.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -50,7 +50,7 @@
XPutBackEvent \- put events back on the queue
.SH SYNTAX
.HP
XPutBackEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent\fP\^);
XPutBackEvent\^(\^Display *\fIdisplay\fP\^, XEvent *\fIevent\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.

84
man/XPutImage.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,30 +53,30 @@ XPutImage, XGetImage, XGetSubImage \- transfer images
int XPutImage\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
XImage *\fIimage\fP\^, int \fIsrc_x\fP\^, int \fIsrc_y\fP\^, int
\fIdest_x\fP\^, int \fIdest_y\fP\^, unsigned int \fIwidth\fP\^, unsigned int
\fIheight\fP\^);
\fIheight\fP\^);
.HP
XImage *XGetImage\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, int
\fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int
\fIheight\fP\^, unsigned long \fIplane_mask\fP\^, int \fIformat\fP\^);
\fIheight\fP\^, unsigned long \fIplane_mask\fP\^, int \fIformat\fP\^);
.HP
XImage *XGetSubImage\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, int
\fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int
\fIheight\fP\^, unsigned long \fIplane_mask\fP\^, int \fIformat\fP\^, XImage
*\fIdest_image\fP\^, int \fIdest_x\fP\^, \fIdest_y\fP\^);
*\fIdest_image\fP\^, int \fIdest_x\fP\^, \fIdest_y\fP\^);
.SH ARGUMENTS
.IP \fId\fP 1i
Specifies the drawable.
Specifies the drawable.
.IP \fIdest_image\fP 1i
Specifies the destination image.
.ds Dx
.ds Dx
.IP \fIdest_x\fP 1i
.br
.ns
.IP \fIdest_y\fP 1i
Specify the x and y coordinates, which are relative to the origin of the drawable
and are the coordinates of the subimage
or which are relative to the origin of the destination rectangle,
specify its upper-left corner, and determine where the subimage
Specify the x and y coordinates, which are relative to the origin of the drawable
and are the coordinates of the subimage
or which are relative to the origin of the destination rectangle,
specify its upper-left corner, and determine where the subimage
is placed in the destination image.
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -84,45 +84,45 @@ Specifies the connection to the X server.
Specifies the format for the image.
You can pass
.B XYPixmap
or
or
.BR ZPixmap .
.IP \fIgc\fP 1i
Specifies the GC.
.IP \fIimage\fP 1i
Specifies the image you want combined with the rectangle.
Specifies the image you want combined with the rectangle.
.IP \fIplane_mask\fP 1i
Specifies the plane mask.
.\" *** JIM: NEED MORE INFO FOR THIS. ***
.IP \fIsrc_x\fP 1i
Specifies the offset in X from the left edge of the image defined
by the
by the
.B XImage
structure.
.IP \fIsrc_y\fP 1i
Specifies the offset in Y from the top edge of the image defined
by the
by the
.B XImage
structure.
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
Specify the width and height of the subimage, which define
Specify the width and height of the subimage, which define
the dimensions of the rectangle.
.IP \fIx\fP 1i
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates, which are relative to the origin of the drawable
Specify the x and y coordinates, which are relative to the origin of the drawable
and define the upper-left corner of the rectangle.
.SH DESCRIPTION
The
.B XPutImage
function
combines an image with a rectangle of the specified drawable.
The section of the image defined by the src_x, src_y, width, and height
The section of the image defined by the src_x, src_y, width, and height
arguments is drawn on the specified part of the drawable.
If
If
.B XYBitmap
format is used, the depth of the image must be one,
or a
@ -130,9 +130,9 @@ or a
error results.
The foreground pixel in the GC defines the source for the one bits in the image,
and the background pixel defines the source for the zero bits.
For
For
.B XYPixmap
and
and
.BR ZPixmap ,
the depth of the image must match the depth of the drawable,
or a
@ -145,8 +145,8 @@ differ from what the server requires,
automatically makes the appropriate
conversions.
.LP
This function uses these GC components:
function, plane-mask, subwindow-mode, clip-x-origin, clip-y-origin,
This function uses these GC components:
function, plane-mask, subwindow-mode, clip-x-origin, clip-y-origin,
and clip-mask.
It also uses these GC mode-dependent components:
foreground and background.
@ -167,16 +167,16 @@ function returns a pointer to an
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
If the format argument is
.BR XYPixmap ,
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
If the format argument is
.BR ZPixmap ,
.B XGetImage
returns as zero the bits in all planes not
returns as zero the bits in all planes not
specified in the plane_mask argument.
The function performs no range checking on the values in plane_mask and ignores
extraneous bits.
@ -186,17 +186,17 @@ returns the depth of the image to the depth member of the
.B XImage
structure.
The depth of the image is as specified when the drawable was created,
except when getting a subset of the planes in
except when getting a subset of the planes in
.B XYPixmap
format, when the depth is given by the number of bits set to 1 in plane_mask.
.LP
If the drawable is a pixmap,
the given rectangle must be wholly contained within the pixmap,
If the drawable is a pixmap,
the given rectangle must be wholly contained within the pixmap,
or a
.B BadMatch
error results.
If the drawable is a window,
the window must be viewable,
If the drawable is a window,
the window must be viewable,
and it must be the case that if there were no inferiors or overlapping windows,
the specified rectangle of the window would be fully visible on the screen
and wholly contained within the outside edges of the window,
@ -207,7 +207,7 @@ Note that the borders of the window can be included and read with
this request.
If the window has backing-store, the backing-store contents are
returned for regions of the window that are obscured by noninferior
windows.
windows.
If the window does not have backing-store,
the returned contents of such obscured regions are undefined.
The returned contents of visible regions of inferiors
@ -225,17 +225,17 @@ and
.B BadValue
errors.
.LP
The
The
.B XGetSubImage
function updates dest_image with the specified subimage in the same manner as
function updates dest_image with the specified subimage in the same manner as
.BR XGetImage .
If the format argument is
If the format argument is
.BR XYPixmap ,
the image contains only the bit planes you passed to the plane_mask argument.
If the format argument is
If the format argument is
.BR ZPixmap ,
.B XGetSubImage
returns as zero the bits in all planes not
returns as zero the bits in all planes not
specified in the plane_mask argument.
The function performs no range checking on the values in plane_mask and ignores
extraneous bits.
@ -255,18 +255,18 @@ the given rectangle must be wholly contained within the pixmap,
or a
.B BadMatch
error results.
If the drawable is a window,
the window must be viewable,
If the drawable is a window,
the window must be viewable,
and it must be the case that if there were no inferiors or overlapping windows,
the specified rectangle of the window would be fully visible on the screen
and wholly contained within the outside edges of the window,
or a
.B BadMatch
error results.
If the window has backing-store,
then the backing-store contents are returned for regions of the window
that are obscured by noninferior windows.
If the window does not have backing-store,
If the window has backing-store,
then the backing-store contents are returned for regions of the window
that are obscured by noninferior windows.
If the window does not have backing-store,
the returned contents of such obscured regions are undefined.
The returned contents of visible regions of inferiors
of a different depth than the specified window's depth are also undefined.

34
man/XQueryBestSize.man
View file

@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -53,7 +53,7 @@ XQueryBestSize, XQueryBestTile, XQueryBestStipple \- determine efficient sizes
Status XQueryBestSize\^(\^Display *\fIdisplay\fP\^, int \fIclass\fP\^,
Drawable \fIwhich_screen\fP\^, unsigned int \fIwidth\fP, unsigned int
\fIheight\fP\^, unsigned int *\fIwidth_return\fP, unsigned int
*\fIheight_return\fP\^);
*\fIheight_return\fP\^);
.HP
Status XQueryBestTile\^(\^Display *\fIdisplay\fP\^, Drawable
\fIwhich_screen\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^,
@ -61,14 +61,14 @@ unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^);
.HP
Status XQueryBestStipple\^(\^Display *\fIdisplay\fP\^, Drawable
\fIwhich_screen\fP\^, unsigned int \fIwidth\fP, unsigned int \fIheight\fP\^,
unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^);
unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^);
.SH ARGUMENTS
.IP \fIclass\fP 1i
Specifies the class that you are interested in.
You can pass
You can pass
.BR TileShape ,
.BR CursorShape ,
or
or
.BR StippleShape .
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@ -83,35 +83,35 @@ Specifies any drawable on the screen.
.br
.ns
.IP \fIheight_return\fP 1i
Return the width and height of the object best supported
Return the width and height of the object best supported
by the display hardware.
.SH DESCRIPTION
The
.B XQueryBestSize
function returns the best or closest size to the specified size.
For
For
.BR CursorShape ,
this is the largest size that can be fully displayed on the screen specified by
which_screen.
For
For
.BR TileShape ,
this is the size that can be tiled fastest.
For
For
.BR StippleShape ,
this is the size that can be stippled fastest.
For
For
.BR CursorShape ,
the drawable indicates the desired screen.
For
For
.B TileShape
and
and
.BR StippleShape ,
the drawable indicates the screen and possibly the window class and depth.
An
An
.B InputOnly
window cannot be used as the drawable for
window cannot be used as the drawable for
.B TileShape
or
or
.BR StippleShape ,
or a
.B BadMatch
@ -130,9 +130,9 @@ The
function returns the best or closest size, that is, the size that can be
tiled fastest on the screen specified by which_screen.
The drawable indicates the screen and possibly the window class and depth.
If an
If an
.B InputOnly
window is used as the drawable, a
window is used as the drawable, a
.B BadMatch
error results.
.LP

28
man/XQueryColor.man
View file

@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
@ -52,22 +52,22 @@ XQueryColor, XQueryColors, XLookupColor, XParseColor \- obtain color values
.SH SYNTAX
.HP
int XQueryColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^, XColor
*\fIdef_in_out\fP\^);
*\fIdef_in_out\fP\^);
.HP
int XQueryColors\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
XColor \fIdefs_in_out\fP[\^]\^, int \fIncolors\fP\^);
XColor \fIdefs_in_out\fP[\^]\^, int \fIncolors\fP\^);
.HP
Status XLookupColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
char *\fIcolor_name\fP\^, XColor *\fIexact_def_return\fP\^, XColor
*\fIscreen_def_return\fP\^);
*\fIscreen_def_return\fP\^);
.HP
Status XParseColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
char *\fIspec\fP\^, XColor *\fIexact_def_return\fP\^);
char *\fIspec\fP\^, XColor *\fIexact_def_return\fP\^);
.SH ARGUMENTS
.IP \fIcolormap\fP 1i
Specifies the colormap.
.IP \fIcolor_name\fP 1i
Specifies the color name string (for example, red) whose color
Specifies the color name string (for example, red) whose color
definition structure you want returned.
.IP \fIdef_in_out\fP 1i
Specifies and returns the RGB values for the pixel specified in the structure.
@ -79,8 +79,8 @@ Specifies the connection to the X server.
.IP \fIexact_def_return\fP 1i
Returns the exact RGB values.
.IP \fIncolors\fP 1i
.\"Specifies the number of color definition structures.
Specifies the number of
.\"Specifies the number of color definition structures.
Specifies the number of
.B XColor
structures in the color definition array.
.IP \fIscreen_def_return\fP 1i
@ -132,9 +132,9 @@ The
function looks up the string name of a color with respect to the screen
associated with the specified colormap.
It returns both the exact color values and
the closest values provided by the screen
the closest values provided by the screen
with respect to the visual type of the specified colormap.
If the color name is not in the Host Portable Character Encoding,
If the color name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Use of uppercase or lowercase does not matter.
.B XLookupColor
@ -146,7 +146,7 @@ The
function looks up the string name of a color with respect to the screen
associated with the specified colormap.
It returns the exact color value.
If the color name is not in the Host Portable Character Encoding,
If the color name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Use of uppercase or lowercase does not matter.
.B XParseColor
@ -172,7 +172,7 @@ rgb:\fI<red>/<green>/<blue>\fP
.EE
.\" End marker code here
.LP
Note that \fIh\fP indicates the value scaled in 4 bits,
Note that \fIh\fP indicates the value scaled in 4 bits,
\fIhh\fP the value scaled in 8 bits,
\fIhhh\fP the value scaled in 12 bits,
and \fIhhhh\fP the value scaled in 16 bits, respectively.
@ -191,7 +191,7 @@ l l.
.TE
.LP
The R, G, and B represent single hexadecimal digits.
When fewer than 16 bits each are specified,
When fewer than 16 bits each are specified,
they represent the most significant bits of the value
(unlike the \*(lqrgb:\*(rq syntax, in which values are scaled).
For example, the string \*(lq#3a7\*(rq is the same as \*(lq#3000a0007000\*(rq.
@ -209,7 +209,7 @@ Note that red, green, and blue are floating-point values
between 0.0 and 1.0, inclusive.
The input format for these values is an optional sign,
a string of numbers possibly containing a decimal point,
and an optional exponent field containing an E or e
and an optional exponent field containing an E or e
followed by a possibly signed integer string.
.LP
The standard device-independent string specifications have

Some files were not shown because too many files have changed in this diff Show more