ACC SHELL
XXlliibb -- CC LLaanngguuaaggee XX IInntteerrffaaccee
XX WWiinnddooww SSyysstteemm SSttaannddaarrdd
XX VVeerrssiioonn 1111,, RReelleeaassee 77
lliibbXX1111 11..33..22
James Gettys
Cambridge Research Laboratory
Digital Equipment Corporation
Robert W. Scheifler
Laboratory for Computer Science
Massachusetts Institute of Technology
_w_i_t_h _c_o_n_t_r_i_b_u_t_i_o_n_s _f_r_o_m
Chuck Adams, Tektronix, Inc.
Vania Joloboff, Open Software Foundation
Hideki Hiura, Sun Microsystems, Inc.
Bill McMahon, Hewlett-Packard Company
Ron Newman, Massachusetts Institute of Technology
Al Tabayoyon, Tektronix, Inc.
Glenn Widener, Tektronix, Inc.
Shigeru Yamada, Fujitsu OSSI
The X Window System is a trademark of The Open Group.
TekHVC is a trademark of Tektronix, Inc.
Copyright © 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994,
1996, 2002 The Open Group
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documenta-
tion files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the
Software.
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 PUR-
POSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSOR-
TIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of The Open
Group shall not be used in advertising or otherwise to pro-
mote the sale, use or other dealings in this Software with-
out prior written authorization from The Open Group.
Copyright © 1985, 1986, 1987, 1988, 1989, 1990, 1991 by Dig-
ital Equipment Corporation
Portions Copyright © 1990, 1991 by Tektronix, Inc.
Permission to use, copy, modify and distribute this documen-
tation for any purpose and without fee is hereby granted,
provided that the above copyright notice appears in all
copies and that both that copyright notice and this permis-
sion notice appear in all copies, and that the names of Dig-
ital and Tektronix not be used in in advertising or public-
ity pertaining to this documentation without specific, writ-
ten prior permission. Digital and Tektronix makes no repre-
sentations about the suitability of this documentation for
any purpose. It is provided ``as is'' without express or
implied warranty.
AAcckknnoowwlleeddggmmeennttss
The design and implementation of the first 10 versions of X
were primarily the work of three individuals: Robert Schei-
fler of the MIT Laboratory for Computer Science and Jim Get-
tys of Digital Equipment Corporation and Ron Newman of MIT,
both at MIT Project Athena. X version 11, however, is the
result of the efforts of dozens of individuals at almost as
many locations and organizations. At the risk of offending
some of the players by exclusion, we would like to acknowl-
edge some of the people who deserve special credit and
recognition for their work on Xlib. Our apologies to anyone
inadvertently overlooked.
RReelleeaassee 11
Our thanks does to Ron Newman (MIT Project Athena), who con-
tributed substantially to the design and implementation of
the Version 11 Xlib interface.
Our thanks also goes to Ralph Swick (Project Athena and Dig-
ital) who kept it all together for us during the early
releases. He handled literally thousands of requests from
people everywhere and saved the sanity of at least one of
us. His calm good cheer was a foundation on which we could
build.
Our thanks also goes to Todd Brunhoff (Tektronix) who was
``loaned'' to Project Athena at exactly the right moment to
provide very capable and much-needed assistance during the
alpha and beta releases. He was responsible for the suc-
cessful integration of sources from multiple sites; we would
not have had a release without him.
Our thanks also goes to Al Mento and Al Wojtas of Digital's
ULTRIX Documentation Group. With good humor and cheer, they
took a rough draft and made it an infinitely better and more
useful document. The work they have done will help many
everywhere. We also would like to thank Hal Murray (Digital
SRC) and Peter George (Digital VMS) who contributed much by
proofreading the early drafts of this document.
Our thanks also goes to Jeff Dike (Digital UEG), Tom Benson,
Jackie Granfield, and Vince Orgovan (Digital VMS) who helped
with the library utilities implementation; to Hania Gajewska
(Digital UEG-WSL) who, along with Ellis Cohen (CMU and
Siemens), was instrumental in the semantic design of the
window manager properties; and to Dave Rosenthal (Sun
Microsystems) who also contributed to the protocol and pro-
vided the sample generic color frame buffer device-dependent
code.
The alpha and beta test participants deserve special recog-
nition and thanks as well. It is significant that the bug
reports (and many fixes) during alpha and beta test came
almost exclusively from just a few of the alpha testers,
mostly hardware vendors working on product implementations
of X. The continued public contribution of vendors and uni-
versities is certainly to the benefit of the entire X commu-
nity.
Our special thanks must go to Sam Fuller, Vice-President of
Corporate Research at Digital, who has remained committed to
the widest public availability of X and who made it possible
to greatly supplement MIT's resources with the Digital staff
in order to make version 11 a reality. Many of the people
mentioned here are part of the Western Software Laboratory
(Digital UEG-WSL) of the ULTRIX Engineering group and work
for Smokey Wallace, who has been vital to the project's suc-
cess. Others not mentioned here worked on the toolkit and
are acknowledged in the X Toolkit documentation.
Of course, we must particularly thank Paul Asente, formerly
of Stanford University and now of Digital UEG-WSL, who wrote
W, the predecessor to X, and Brian Reid, formerly of Stan-
ford University and now of Digital WRL, who had much to do
with W's design.
Finally, our thanks goes to MIT, Digital Equipment Corpora-
tion, and IBM for providing the environment where it could
happen.
RReelleeaassee 44
Our thanks go to Jim Fulton (MIT X Consortium) for designing
and specifying the new Xlib functions for Inter-Client Com-
munication Conventions (ICCCM) support.
We also thank Al Mento of Digital for his continued effort
in maintaining this document and Jim Fulton and Donna Con-
verse (MIT X Consortium) for their much-appreciated efforts
in reviewing the changes.
RReelleeaassee 55
The principal authors of the Input Method facilities are
Vania Joloboff (Open Software Foundation) and Bill McMahon
(Hewlett-Packard). The principal author of the rest of the
internationalization facilities is Glenn Widener (Tek-
tronix). Our thanks to them for keeping their sense of
humor through a long and sometimes difficult design process.
Although the words and much of the design are due to them,
many others have contributed substantially to the design and
implementation. Tom McFarland (HP) and Frank Rojas (IBM)
deserve particular recognition for their contributions.
Other contributors were: Tim Anderson (Motorola), Alka Bad-
shah (OSF), Gabe Beged-Dov (HP), Chih-Chung Ko (III), Vera
Cheng (III), Michael Collins (Digital), Walt Daniels (IBM),
Noritoshi Demizu (OMRON), Keisuke Fukui (Fujitsu), Hitoshoi
Fukumoto (Nihon Sun), Tim Greenwood (Digital), John Harvey
(IBM), Hideki Hiura (Sun), Fred Horman (AT&T), Norikazu
Kaiya (Fujitsu), Yuji Kamata (IBM), Yutaka Kataoka (Waseda
University), Ranee Khubchandani (Sun), Akira Kon (NEC),
Hiroshi Kuribayashi (OMRON), Teruhiko Kurosaka (Sun), Seiji
Kuwari (OMRON), Sandra Martin (OSF), Narita Masahiko
(Fujitsu), Masato Morisaki (NTT), Nelson Ng (Sun), Takashi
Nishimura (NTT America), Makato Nishino (IBM), Akira Ohsone
(Nihon Sun), Chris Peterson (MIT), Sam Shteingart (AT&T),
Manish Sheth (AT&T), Muneiyoshi Suzuki (NTT), Cori Mehring
(Digital), Shoji Sugiyama (IBM), and Eiji Tosa (IBM).
We are deeply indebted to Tatsuya Kato (NTT), Hiroshi Kurib-
ayashi (OMRON), Seiji Kuwari (OMRON), Muneiyoshi Suzuki
(NTT), and Li Yuhong (OMRON) for producing one of the first
complete sample implementation of the internationalization
facilities, and Hiromu Inukai (Nihon Sun), Takashi Fujiwara
(Fujitsu), Hideki Hiura (Sun), Yasuhiro Kawai (Oki Tech-
nosystems Laboratory), Kazunori Nishihara (Fuji Xerox),
Masaki Takeuchi (Sony), Katsuhisa Yano (Toshiba), Makoto
Wakamatsu (Sony Corporation) for producing the another com-
plete sample implementation of the internationalization
facilities.
The principal authors (design and implementation) of the
Xcms color management facilities are Al Tabayoyon (Tek-
tronix) and Chuck Adams (Tektronix). Joann Taylor (Tek-
tronix), Bob Toole (Tektronix), and Keith Packard (MIT X
Consortium) also contributed significantly to the design.
Others who contributed are: Harold Boll (Kodak), Ken Bron-
stein (HP), Nancy Cam (SGI), Donna Converse (MIT X Consor-
tium), Elias Israel (ISC), Deron Johnson (Sun), Jim King
(Adobe), Ricardo Motta (HP), Chuck Peek (IBM), Wil Plouffe
(IBM), Dave Sternlicht (MIT X Consortium), Kumar Talluri
(AT&T), and Richard Verberg (IBM).
We also once again thank Al Mento of Digital for his work in
formatting and reformatting text for this manual, and for
producing man pages. Thanks also to Clive Feather (IXI) for
proof-reading and finding a number of small errors.
RReelleeaassee 66
Stephen Gildea (X Consortium) authored the threads support.
Ovais Ashraf (Sun) and Greg Olsen (Sun) contributed substan-
tially by testing the facilities and reporting bugs in a
timely fashion.
The principal authors of the internationalization facili-
ties, including Input and Output Methods, are Hideki Hiura
(SunSoft) and Shigeru Yamada (Fujitsu OSSI). Although the
words and much of the design are due to them, many others
have contributed substantially to the design and implementa-
tion. They are: Takashi Fujiwara (Fujitsu), Yoshio Horiuchi
(IBM), Makoto Inada (Digital), Hiromu Inukai (Nihon Sun-
Soft), Song JaeKyung (KAIST), Franky Ling (Digital), Tom
McFarland (HP), Hiroyuki Miyamoto (Digital), Masahiko Narita
(Fujitsu), Frank Rojas (IBM), Hidetoshi Tajima (HP), Masaki
Takeuchi (Sony), Makoto Wakamatsu (Sony), Masaki Wakao
(IBM), Katsuhisa Yano(Toshiba) and Jinsoo Yoon (KAIST).
The principal producers of the sample implementation of the
internationalization facilities are: Jeffrey Bloomfield
(Fujitsu OSSI), Takashi Fujiwara (Fujitsu), Hideki Hiura
(SunSoft), Yoshio Horiuchi (IBM), Makoto Inada (Digital),
Hiromu Inukai (Nihon SunSoft), Song JaeKyung (KAIST), Riki
Kawaguchi (Fujitsu), Franky Ling (Digital), Hiroyuki
Miyamoto (Digital), Hidetoshi Tajima (HP), Toshimitsu Tera-
zono (Fujitsu), Makoto Wakamatsu (Sony), Masaki Wakao (IBM),
Shigeru Yamada (Fujitsu OSSI) and Katsuhisa Yano (Toshiba).
The coordinators of the integration, testing, and release of
this implementation of the internationalization facilities
are Nobuyuki Tanaka (Sony) and Makoto Wakamatsu (Sony).
Others who have contributed to the architectural design or
testing of the sample implementation of the international-
ization facilities are: Hector Chan (Digital), Michael Kung
(IBM), Joseph Kwok (Digital), Hiroyuki Machida (Sony), Nel-
son Ng (SunSoft), Frank Rojas (IBM), Yoshiyuki Segawa
(Fujitsu OSSI), Makiko Shimamura (Fujitsu), Shoji Sugiyama
(IBM), Lining Sun (SGI), Masaki Takeuchi (Sony), Jinsoo Yoon
(KAIST) and Akiyasu Zen (HP).
Jim Gettys
Cambridge Research Laboratory
Digital Equipment Corporation
Robert W. Scheifler
Laboratory for Computer Science
Massachusetts Institute of Technology
CChhaapptteerr 11
IInnttrroodduuccttiioonn ttoo XXlliibb
The X Window System is a network-transparent window system
that was designed at MIT. X display servers run on comput-
ers with either monochrome or color bitmap display hardware.
The server distributes user input to and accepts output
requests from various client programs located either on the
same machine or elsewhere in the network. Xlib is a C sub-
routine library that application programs (clients) use to
interface with the window system by means of a stream con-
nection. Although a client usually runs on the same machine
as the X server it is talking to, this need not be the case.
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e is a reference guide to the
low-level C language interface to the X Window System proto-
col. It is neither a tutorial nor a user's guide to pro-
gramming the X Window System. Rather, it provides a
detailed description of each function in the library as well
as a discussion of the related background information. _X_l_i_b
_- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e assumes a basic understanding of a
graphics window system and of the C programming language.
Other higher-level abstractions (for example, those provided
by the toolkits for X) are built on top of the Xlib library.
For further information about these higher-level libraries,
see the appropriate toolkit documentation. The _X _W_i_n_d_o_w
_S_y_s_t_e_m _P_r_o_t_o_c_o_l provides the definitive word on the behavior
of X. Although additional information appears here, the
protocol document is the ruling document.
To provide an introduction to X programming, this chapter
discusses:
· Overview of the X Window System
· Errors
· Standard header files
· Generic values and types
· Naming and argument conventions within Xlib
· Programming considerations
· Character sets and encodings
· Formatting conventions
11
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
11..11.. OOvveerrvviieeww ooff tthhee XX WWiinnddooww SSyysstteemm
Some of the terms used in this book are unique to X, and
other terms that are common to other window systems have
different meanings in X. You may find it helpful to refer
to the glossary, which is located at the end of the book.
The X Window System supports one or more screens containing
overlapping windows or subwindows. A screen is a physical
monitor and hardware that can be color, grayscale, or
monochrome. There can be multiple screens for each display
or workstation. A single X server can provide display ser-
vices for any number of screens. A set of screens for a
single user with one keyboard and one pointer (usually a
mouse) is called a display.
All the windows in an X server are arranged in strict hier-
archies. At the top of each hierarchy is a root window,
which covers each of the display screens. Each root window
is partially or completely covered by child windows. All
windows, except for root windows, have parents. There is
usually at least one window for each application program.
Child windows may in turn have their own children. In this
way, an application program can create an arbitrarily deep
tree on each screen. X provides graphics, text, and raster
operations for windows.
A child window can be larger than its parent. That is, part
or all of the child window can extend beyond the boundaries
of the parent, but all output to a window is clipped by its
parent. If several children of a window have overlapping
locations, one of the children is considered to be on top of
or raised over the others, thus obscuring them. Output to
areas covered by other windows is suppressed by the window
system unless the window has backing store. If a window is
obscured by a second window, the second window obscures only
those ancestors of the second window that are also ancestors
of the first window.
A window has a border zero or more pixels in width, which
can be any pattern (pixmap) or solid color you like. A win-
dow usually but not always has a background pattern, which
will be repainted by the window system when uncovered.
Child windows obscure their parents, and graphic operations
in the parent window usually are clipped by the children.
Each window and pixmap has its own coordinate system. The
coordinate system has the X axis horizontal and the Y axis
vertical with the origin [0, 0] at the upper-left corner.
Coordinates are integral, in terms of pixels, and coincide
with pixel centers. For a window, the origin is inside the
border at the inside, upper-left corner.
22
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
X does not guarantee to preserve the contents of windows.
When part or all of a window is hidden and then brought back
onto the screen, its contents may be lost. The server then
sends the client program an _E_x_p_o_s_e event to notify it that
part or all of the window needs to be repainted. Programs
must be prepared to regenerate the contents of windows on
demand.
X also provides off-screen storage of graphics objects,
called pixmaps. Single plane (depth 1) pixmaps are some-
times referred to as bitmaps. Pixmaps can be used in most
graphics functions interchangeably with windows and are used
in various graphics operations to define patterns or tiles.
Windows and pixmaps together are referred to as drawables.
Most of the functions in Xlib just add requests to an output
buffer. These requests later execute asynchronously on the
X server. Functions that return values of information
stored in the server do not return (that is, they block)
until an explicit reply is received or an error occurs. You
can provide an error handler, which will be called when the
error is reported.
If a client does not want a request to execute asyn-
chronously, it can follow the request with a call to _X_S_y_n_c,
which blocks until all previously buffered asynchronous
events have been sent and acted on. As an important side
effect, the output buffer in Xlib is always flushed by a
call to any function that returns a value from the server or
waits for input.
Many Xlib functions will return an integer resource ID,
which allows you to refer to objects stored on the X server.
These can be of type _W_i_n_d_o_w, _F_o_n_t, _P_i_x_m_a_p, _C_o_l_o_r_m_a_p, _C_u_r_s_o_r,
and _G_C_o_n_t_e_x_t, as defined in the file <_X_1_1_/_X_._h>. These
resources are created by requests and are destroyed (or
freed) by requests or when connections are closed. Most of
these resources are potentially sharable between applica-
tions, and in fact, windows are manipulated explicitly by
window manager programs. Fonts and cursors are shared auto-
matically across multiple screens. Fonts are loaded and
unloaded as needed and are shared by multiple clients.
Fonts are often cached in the server. Xlib provides no sup-
port for sharing graphics contexts between applications.
Client programs are informed of events. Events may either
be side effects of a request (for example, restacking win-
dows generates _E_x_p_o_s_e events) or completely asynchronous
(for example, from the keyboard). A client program asks to
be informed of events. Because other applications can send
events to your application, programs must be prepared to
handle (or ignore) events of all types.
33
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Input events (for example, a key pressed or the pointer
moved) arrive asynchronously from the server and are queued
until they are requested by an explicit call (for example,
_X_N_e_x_t_E_v_e_n_t or _X_W_i_n_d_o_w_E_v_e_n_t). In addition, some library
functions (for example, _X_R_a_i_s_e_W_i_n_d_o_w) generate _E_x_p_o_s_e and
_C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t events. These events also arrive asyn-
chronously, but the client may wish to explicitly wait for
them by calling _X_S_y_n_c after calling a function that can
cause the server to generate events.
11..22.. EErrrroorrss
Some functions return _S_t_a_t_u_s, an integer error indication.
If the function fails, it returns a zero. If the function
returns a status of zero, it has not updated the return
arguments. Because C does not provide multiple return val-
ues, many functions must return their results by writing
into client-passed storage. By default, errors are handled
either by a standard library function or by one that you
provide. Functions that return pointers to strings return
NULL pointers if the string does not exist.
The X server reports protocol errors at the time that it
detects them. If more than one error could be generated for
a given request, the server can report any of them.
Because Xlib usually does not transmit requests to the
server immediately (that is, it buffers them), errors can be
reported much later than they actually occur. For debugging
purposes, however, Xlib provides a mechanism for forcing
synchronous behavior (see section 11.8.1). When synchro-
nization is enabled, errors are reported as they are gener-
ated.
When Xlib detects an error, it calls an error handler, which
your program can provide. If you do not provide an error
handler, the error is printed, and your program terminates.
11..33.. SSttaannddaarrdd HHeeaaddeerr FFiilleess
The following include files are part of the Xlib standard:
· <_X_1_1_/_X_l_i_b_._h>
This is the main header file for Xlib. The majority of
all Xlib symbols are declared by including this file.
This file also contains the preprocessor symbol _X_l_i_b_-
_S_p_e_c_i_f_i_c_a_t_i_o_n_R_e_l_e_a_s_e. This symbol is defined to have
the 6 in this release of the standard. (Release 5 of
Xlib was the first release to have this symbol.)
· <_X_1_1_/_X_._h>
44
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This file declares types and constants for the X proto-
col that are to be used by applications. It is
included automatically from <_X_1_1_/_X_l_i_b_._h>, so applica-
tion code should never need to reference this file
directly.
· <_X_1_1_/_X_c_m_s_._h>
This file contains symbols for much of the color man-
agement facilities described in chapter 6. All func-
tions, types, and symbols with the prefix ``Xcms'',
plus the Color Conversion Contexts macros, are declared
in this file. <_X_1_1_/_X_l_i_b_._h> must be included before
including this file.
· <_X_1_1_/_X_u_t_i_l_._h>
This file declares various functions, types, and sym-
bols used for inter-client communication and applica-
tion utility functions, which are described in chapters
14 and 16. <_X_1_1_/_X_l_i_b_._h> must be included before
including this file.
· <_X_1_1_/_X_r_e_s_o_u_r_c_e_._h>
This file declares all functions, types, and symbols
for the resource manager facilities, which are
described in chapter 15. <_X_1_1_/_X_l_i_b_._h> must be included
before including this file.
· <_X_1_1_/_X_a_t_o_m_._h>
This file declares all predefined atoms, which are sym-
bols with the prefix ``XA_''.
· <_X_1_1_/_c_u_r_s_o_r_f_o_n_t_._h>
This file declares the cursor symbols for the standard
cursor font, which are listed in appendix B. All cur-
sor symbols have the prefix ``XC_''.
· <_X_1_1_/_k_e_y_s_y_m_d_e_f_._h>
This file declares all standard KeySym values, which
are symbols with the prefix ``XK_''. The KeySyms are
arranged in groups, and a preprocessor symbol controls
inclusion of each group. The preprocessor symbol must
be defined prior to inclusion of the file to obtain the
associated values. The preprocessor symbols are
XK_MISCELLANY, XK_XKB_KEYS, XK_3270, XK_LATIN1,
XK_LATIN2, XK_LATIN3, XK_LATIN4, XK_KATAKANA, XK_ARA-
BIC, XK_CYRILLIC, XK_GREEK, XK_TECHNICAL, XK_SPECIAL,
XK_PUBLISHING, XK_APL, XK_HEBREW, XK_THAI, and
XK_KOREAN.
55
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· <_X_1_1_/_k_e_y_s_y_m_._h>
This file defines the preprocessor symbols XK_MISCEL-
LANY, XK_XKB_KEYS, XK_LATIN1, XK_LATIN2, XK_LATIN3,
XK_LATIN4, and XK_GREEK and then includes
<_X_1_1_/_k_e_y_s_y_m_d_e_f_._h>.
· <_X_1_1_/_X_l_i_b_i_n_t_._h>
This file declares all the functions, types, and sym-
bols used for extensions, which are described in
appendix C. This file automatically includes
<_X_1_1_/_X_l_i_b_._h>.
· <_X_1_1_/_X_p_r_o_t_o_._h>
This file declares types and symbols for the basic X
protocol, for use in implementing extensions. It is
included automatically from <_X_1_1_/_X_l_i_b_i_n_t_._h>, so appli-
cation and extension code should never need to refer-
ence this file directly.
· <_X_1_1_/_X_p_r_o_t_o_s_t_r_._h>
This file declares types and symbols for the basic X
protocol, for use in implementing extensions. It is
included automatically from <_X_1_1_/_X_p_r_o_t_o_._h>, so applica-
tion and extension code should never need to reference
this file directly.
· <_X_1_1_/_X_1_0_._h>
This file declares all the functions, types, and sym-
bols used for the X10 compatibility functions, which
are described in appendix D.
11..44.. GGeenneerriicc VVaalluueess aanndd TTyyppeess
The following symbols are defined by Xlib and used through-
out the manual:
· Xlib defines the type _B_o_o_l and the Boolean values _T_r_u_e
and _F_a_l_s_e.
· _N_o_n_e is the universal null resource ID or atom.
· The type _X_I_D is used for generic resource IDs.
· The type _X_P_o_i_n_t_e_r is defined to be char* and is used as
a generic opaque pointer to data.
66
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
11..55.. NNaammiinngg aanndd AArrgguummeenntt CCoonnvveennttiioonnss wwiitthhiinn XXlliibb
Xlib follows a number of conventions for the naming and syn-
tax of the functions. Given that you remember what informa-
tion the function requires, these conventions are intended
to make the syntax of the functions more predictable.
The major naming conventions are:
· To differentiate the X symbols from the other symbols,
the library uses mixed case for external symbols. It
leaves lowercase for variables and all uppercase for
user macros, as per existing convention.
· All Xlib functions begin with a capital X.
· The beginnings of all function names and symbols are
capitalized.
· All user-visible data structures begin with a capital
X. More generally, anything that a user might derefer-
ence begins with a capital X.
· Macros and other symbols do not begin with a capital X.
To distinguish them from all user symbols, each word in
the macro is capitalized.
· All elements of or variables in a data structure are
in lowercase. Compound words, where needed, are con-
structed with underscores (_).
· The display argument, where used, is always first in
the argument list.
· All resource objects, where used, occur at the begin-
ning of the argument list immediately after the display
argument.
· When a graphics context is present together with
another type of resource (most commonly, a drawable),
the graphics context occurs in the argument list after
the other resource. Drawables outrank all other
resources.
· Source arguments always precede the destination argu-
ments in the argument list.
· The x argument always precedes the y argument in the
argument list.
· The width argument always precedes the height argument
in the argument list.
77
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Where the x, y, width, and height arguments are used
together, the x and y arguments always precede the
width and height arguments.
· Where a mask is accompanied with a structure, the mask
always precedes the pointer to the structure in the
argument list.
11..66.. PPrrooggrraammmmiinngg CCoonnssiiddeerraattiioonnss
The major programming considerations are:
· Coordinates and sizes in X are actually 16-bit quanti-
ties. This decision was made to minimize the bandwidth
required for a given level of performance. Coordinates
usually are declared as an _i_n_t in the interface. Val-
ues larger than 16 bits are truncated silently. Sizes
(width and height) are declared as unsigned quantities.
· Keyboards are the greatest variable between different
manufacturers' workstations. If you want your program
to be portable, you should be particularly conservative
here.
· Many display systems have limited amounts of off-screen
memory. If you can, you should minimize use of pixmaps
and backing store.
· The user should have control of his screen real estate.
Therefore, you should write your applications to react
to window management rather than presume control of the
entire screen. What you do inside of your top-level
window, however, is up to your application. For fur-
ther information, see chapter 14 and the _I_n_t_e_r_-_C_l_i_e_n_t
_C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l.
11..77.. CChhaarraacctteerr SSeettss aanndd EEnnccooddiinnggss
Some of the Xlib functions make reference to specific char-
acter sets and character encodings. The following are the
most common:
· X Portable Character Set
A basic set of 97 characters, which are assumed to
exist in all locales supported by Xlib. This set con-
tains the following characters:
a..z A..Z 0..9 !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ <space>,
<tab>, and <newline>
88
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This set is the left/lower half of the graphic charac-
ter set of ISO8859-1 plus space, tab, and newline. It
is also the set of graphic characters in 7-bit ASCII
plus the same three control characters. The actual
encoding of these characters on the host is system
dependent.
· Host Portable Character Encoding
The encoding of the X Portable Character Set on the
host. The encoding itself is not defined by this stan-
dard, but the encoding must be the same in all locales
supported by Xlib on the host. If a string is said to
be in the Host Portable Character Encoding, then it
only contains characters from the X Portable Character
Set, in the host encoding.
· Latin-1
The coded character set defined by the ISO8859-1 stan-
dard.
· Latin Portable Character Encoding
The encoding of the X Portable Character Set using the
Latin-1 codepoints plus ASCII control characters. If a
string is said to be in the Latin Portable Character
Encoding, then it only contains characters from the X
Portable Character Set, not all of Latin-1.
· STRING Encoding
Latin-1, plus tab and newline.
· POSIX Portable Filename Character Set
The set of 65 characters, which can be used in naming
files on a POSIX-compliant host, that are correctly
processed in all locales. The set is:
a..z A..Z 0..9 ._-
11..88.. FFoorrmmaattttiinngg CCoonnvveennttiioonnss
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e uses the following conven-
tions:
· Global symbols are printed in _t_h_i_s _s_p_e_c_i_a_l _f_o_n_t. These
can be either function names, symbols defined in
include files, or structure names. When declared and
defined, function arguments are printed in _i_t_a_l_i_c_s. In
the explanatory text that follows, they usually are
99
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
printed in regular type.
· Each function is introduced by a general discussion
that distinguishes it from other functions. The func-
tion declaration itself follows, and each argument is
specifically explained. Although ANSI C function pro-
totype syntax is not used, Xlib header files normally
declare functions using function prototypes in ANSI C
environments. General discussion of the function, if
any is required, follows the arguments. Where applica-
ble, the last paragraph of the explanation lists the
possible Xlib error codes that the function can gener-
ate. For a complete discussion of the Xlib error
codes, see section 11.8.2.
· To eliminate any ambiguity between those arguments that
you pass and those that a function returns to you, the
explanations for all arguments that you pass start with
the word _s_p_e_c_i_f_i_e_s or, in the case of multiple argu-
ments, the word _s_p_e_c_i_f_y. The explanations for all
arguments that are returned to you start with the word
_r_e_t_u_r_n_s or, in the case of multiple arguments, the word
_r_e_t_u_r_n. The explanations for all arguments that you
can pass and are returned start with the words _s_p_e_c_i_-
_f_i_e_s _a_n_d _r_e_t_u_r_n_s.
· Any pointer to a structure that is used to return a
value is designated as such by the ___r_e_t_u_r_n suffix as
part of its name. All other pointers passed to these
functions are used for reading only. A few arguments
use pointers to structures that are used for both input
and output and are indicated by using the ___i_n___o_u_t suf-
fix.
1100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 22
DDiissppllaayy FFuunnccttiioonnss
Before your program can use a display, you must establish a
connection to the X server. Once you have established a
connection, you then can use the Xlib macros and functions
discussed in this chapter to return information about the
display. This chapter discusses how to:
· Open (connect to) the display
· Obtain information about the display, image formats, or
screens
· Generate a _N_o_O_p_e_r_a_t_i_o_n protocol request
· Free client-created data
· Close (disconnect from) a display
· Use X Server connection close operations
· Use Xlib with threads
· Use internal connections
22..11.. OOppeenniinngg tthhee DDiissppllaayy
To open a connection to the X server that controls a dis-
play, use _X_O_p_e_n_D_i_s_p_l_a_y.
__
││
Display *XOpenDisplay(_d_i_s_p_l_a_y___n_a_m_e)
char *_d_i_s_p_l_a_y___n_a_m_e;
_d_i_s_p_l_a_y___n_a_m_e
Specifies the hardware display name, which deter-
mines the display and communications domain to be
used. On a POSIX-conformant system, if the dis-
play_name is NULL, it defaults to the value of the
DISPLAY environment variable.
││__
The encoding and interpretation of the display name are
implementation-dependent. Strings in the Host Portable
Character Encoding are supported; support for other charac-
ters is implementation-dependent. On POSIX-conformant
1111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
systems, the display name or DISPLAY environment variable
can be a string in the format:
__
││
_p_r_o_t_o_c_o_l/_h_o_s_t_n_a_m_e:_n_u_m_b_e_r._s_c_r_e_e_n___n_u_m_b_e_r
_p_r_o_t_o_c_o_l Specifies a protocol family or an alias for a pro-
tocol family. Supported protocol families are
implementation dependent. The protocol entry is
optional. If protocol is not specified, the /
separating protocol and hostname must also not be
specified.
_h_o_s_t_n_a_m_e Specifies the name of the host machine on which
the display is physically attached. You follow
the hostname with either a single colon (:) or a
double colon (::).
_n_u_m_b_e_r Specifies the number of the display server on that
host machine. You may optionally follow this dis-
play number with a period (.). A single CPU can
have more than one display. Multiple displays are
usually numbered starting with zero.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the screen to be used on that server.
Multiple screens can be controlled by a single X
server. The screen_number sets an internal vari-
able that can be accessed by using the _D_e_f_a_u_l_t_-
_S_c_r_e_e_n macro or the _X_D_e_f_a_u_l_t_S_c_r_e_e_n function if you
are using languages other than C (see section
2.2.1).
││__
For example, the following would specify screen 1 of display
0 on the machine named ``dual-headed'':
dual-headed:0.1
The _X_O_p_e_n_D_i_s_p_l_a_y function returns a _D_i_s_p_l_a_y structure that
serves as the connection to the X server and that contains
all the information about that X server. _X_O_p_e_n_D_i_s_p_l_a_y con-
nects your application to the X server through TCP or DECnet
communications protocols, or through some local inter-pro-
cess communication protocol. If the protocol is specified
as "tcp", "inet", or "inet6", or if no protocol is specified
and the hostname is a host machine name and a single colon
(:) separates the hostname and display number, _X_O_p_e_n_D_i_s_p_l_a_y
connects using TCP streams. (If the protocol is specified
as "inet", TCP over IPv4 is used. If the protocol is
1122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
specified as "inet6", TCP over IPv6 is used. Otherwise, the
implementation determines which IP version is used.) If the
hostname and protocol are both not specified, Xlib uses
whatever it believes is the fastest transport. If the host-
name is a host machine name and a double colon (::) sepa-
rates the hostname and display number, _X_O_p_e_n_D_i_s_p_l_a_y connects
using DECnet. A single X server can support any or all of
these transport mechanisms simultaneously. A particular
Xlib implementation can support many more of these transport
mechanisms.
If successful, _X_O_p_e_n_D_i_s_p_l_a_y returns a pointer to a _D_i_s_p_l_a_y
structure, which is defined in <_X_1_1_/_X_l_i_b_._h>. If _X_O_p_e_n_D_i_s_-
_p_l_a_y does not succeed, it returns NULL. After a successful
call to _X_O_p_e_n_D_i_s_p_l_a_y, 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 _D_e_f_a_u_l_t_S_c_r_e_e_n macro
(or the _X_D_e_f_a_u_l_t_S_c_r_e_e_n function). You can access elements
of the _D_i_s_p_l_a_y and _S_c_r_e_e_n structures only by using the
information macros or functions. For information about
using macros and functions to obtain information from the
_D_i_s_p_l_a_y structure, see section 2.2.1.
X servers may implement various types of access control
mechanisms (see section 9.8).
22..22.. OObbttaaiinniinngg IInnffoorrmmaattiioonn aabboouutt tthhee DDiissppllaayy,, IImmaaggee FFoorr--
mmaattss,, oorr SSccrreeeennss
The Xlib library provides a number of useful macros and cor-
responding functions that return data from the _D_i_s_p_l_a_y
structure. The macros are used for C programming, and their
corresponding function equivalents are for other language
bindings. This section discusses the:
· Display macros
· Image format functions and macros
· Screen information macros
All other members of the _D_i_s_p_l_a_y structure (that is, those
for which no macros are defined) are private to Xlib and
must not be used. Applications must never directly modify
or inspect these private members of the _D_i_s_p_l_a_y structure.
Note
The _X_D_i_s_p_l_a_y_W_i_d_t_h, _X_D_i_s_p_l_a_y_H_e_i_g_h_t, _X_D_i_s_p_l_a_y_C_e_l_l_s,
_X_D_i_s_p_l_a_y_P_l_a_n_e_s, _X_D_i_s_p_l_a_y_W_i_d_t_h_M_M, and _X_D_i_s_p_l_a_y_-
_H_e_i_g_h_t_M_M functions in the next sections are mis-
named. These functions really should be named
Screen_w_h_a_t_e_v_e_r and XScreen_w_h_a_t_e_v_e_r, not Display-
_w_h_a_t_e_v_e_r or XDisplay_w_h_a_t_e_v_e_r. Our apologies for
1133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the resulting confusion.
22..22..11.. DDiissppllaayy MMaaccrrooss
Applications should not directly modify any part of the _D_i_s_-
_p_l_a_y and _S_c_r_e_e_n structures. The members should be consid-
ered read-only, although they may change as the result of
other operations on the display.
The following lists the C language macros, their correspond-
ing function equivalents that are for other language bind-
ings, and what data both can return.
__
││
AllPlanes
unsigned long XAllPlanes()
││__
Both return a value with all bits set to 1 suitable for use
in a plane argument to a procedure.
Both _B_l_a_c_k_P_i_x_e_l and _W_h_i_t_e_P_i_x_e_l can be used in implementing a
monochrome application. These pixel values are for perma-
nently allocated entries in the default colormap. The
actual RGB (red, green, and blue) values are settable on
some screens and, in any case, may not actually be black or
white. The names are intended to convey the expected rela-
tive intensity of the colors.
__
││
BlackPixel(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
unsigned long XBlackPixel(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the black pixel value for the specified screen.
1144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
WhitePixel(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
unsigned long XWhitePixel(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the white pixel value for the specified screen.
__
││
ConnectionNumber(_d_i_s_p_l_a_y)
int XConnectionNumber(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return a connection number for the specified display.
On a POSIX-conformant system, this is the file descriptor of
the connection.
__
││
DefaultColormap(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Colormap XDefaultColormap(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the default colormap ID for allocation on the
specified screen. Most routine allocations of color should
be made out of this colormap.
1155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
DefaultDepth(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDefaultDepth(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the depth (number of planes) of the default root
window for the specified screen. Other depths may also be
supported on this screen (see _X_M_a_t_c_h_V_i_s_u_a_l_I_n_f_o).
To determine the number of depths that are available on a
given screen, use _X_L_i_s_t_D_e_p_t_h_s.
__
││
int *XListDepths(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of depths.
││__
The _X_L_i_s_t_D_e_p_t_h_s 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, _X_L_i_s_t_D_e_p_t_h_s sets count_return to the num-
ber of available depths. Otherwise, it does not set
count_return and returns NULL. To release the memory allo-
cated for the array of depths, use _X_F_r_e_e.
1166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
DefaultGC(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
GC XDefaultGC(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the default graphics context for the root window
of the specified screen. This GC is created for the conve-
nience of simple applications and contains the default GC
components with the foreground and background pixel values
initialized to the black and white pixels for the screen,
respectively. You can modify its contents freely because it
is not used in any Xlib function. This GC should never be
freed.
__
││
DefaultRootWindow(_d_i_s_p_l_a_y)
Window XDefaultRootWindow(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the root window for the default screen.
__
││
DefaultScreenOfDisplay(_d_i_s_p_l_a_y)
Screen *XDefaultScreenOfDisplay(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return a pointer to the default screen.
1177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
ScreenOfDisplay(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Screen *XScreenOfDisplay(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return a pointer to the indicated screen.
__
││
DefaultScreen(_d_i_s_p_l_a_y)
int XDefaultScreen(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the default screen number referenced by the
_X_O_p_e_n_D_i_s_p_l_a_y function. This macro or function should be
used to retrieve the screen number in applications that will
use only a single screen.
__
││
DefaultVisual(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Visual *XDefaultVisual(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the default visual type for the specified
screen. For further information about visual types, see
section 3.1.
1188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
DisplayCells(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDisplayCells(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the number of entries in the default colormap.
__
││
DisplayPlanes(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDisplayPlanes(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the depth of the root window of the specified
screen. For an explanation of depth, see the glossary.
__
││
DisplayString(_d_i_s_p_l_a_y)
char *XDisplayString(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the string that was passed to _X_O_p_e_n_D_i_s_p_l_a_y when
the current display was opened. On POSIX-conformant sys-
tems, if the passed string was NULL, these return the value
of the DISPLAY environment variable when the current display
was opened. These are useful to applications that invoke
1199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the _f_o_r_k system call and want to open a new connection to
the same display from the child process as well as for
printing error messages.
__
││
long XExtendedMaxRequestSize(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_E_x_t_e_n_d_e_d_M_a_x_R_e_q_u_e_s_t_S_i_z_e function returns zero if the
specified display does not support an extended-length proto-
col encoding; otherwise, it returns the maximum request size
(in 4-byte units) supported by the server using the
extended-length encoding. The Xlib functions _X_D_r_a_w_L_i_n_e_s,
_X_D_r_a_w_A_r_c_s, _X_F_i_l_l_P_o_l_y_g_o_n, _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y, _X_S_e_t_C_l_i_p_R_e_c_t_a_n_-
_g_l_e_s, and _X_S_e_t_R_e_g_i_o_n will use the extended-length encoding
as necessary, if supported by the server. Use of the
extended-length encoding in other Xlib functions (for exam-
ple, _X_D_r_a_w_P_o_i_n_t_s, _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s, _X_D_r_a_w_S_e_g_m_e_n_t_s, _X_F_i_l_l_A_r_c_s,
_X_F_i_l_l_R_e_c_t_a_n_g_l_e_s, _X_P_u_t_I_m_a_g_e) is permitted but not required;
an Xlib implementation may choose to split the data across
multiple smaller requests instead.
__
││
long XMaxRequestSize(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_M_a_x_R_e_q_u_e_s_t_S_i_z_e function returns the maximum request
size (in 4-byte units) supported by the server without using
an extended-length protocol encoding. Single protocol
requests to the server can be no larger than this size
unless an extended-length protocol encoding is supported by
the server. The protocol guarantees the size to be no
smaller than 4096 units (16384 bytes). Xlib automatically
breaks data up into multiple protocol requests as necessary
for the following functions: _X_D_r_a_w_P_o_i_n_t_s, _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s,
_X_D_r_a_w_S_e_g_m_e_n_t_s, _X_F_i_l_l_A_r_c_s, _X_F_i_l_l_R_e_c_t_a_n_g_l_e_s, and _X_P_u_t_I_m_a_g_e.
2200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
LastKnownRequestProcessed(_d_i_s_p_l_a_y)
unsigned long XLastKnownRequestProcessed(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both extract the full serial number of the last request
known by Xlib to have been processed by the X server. Xlib
automatically sets this number when replies, events, and
errors are received.
__
││
NextRequest(_d_i_s_p_l_a_y)
unsigned long XNextRequest(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both extract the full serial number that is to be used for
the next request. Serial numbers are maintained separately
for each display connection.
__
││
ProtocolVersion(_d_i_s_p_l_a_y)
int XProtocolVersion(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the major version number (11) of the X protocol
associated with the connected display.
2211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
ProtocolRevision(_d_i_s_p_l_a_y)
int XProtocolRevision(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the minor protocol revision number of the X
server.
__
││
QLength(_d_i_s_p_l_a_y)
int XQLength(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the length of the event queue for the connected
display. Note that there may be more events that have not
been read into the queue yet (see _X_E_v_e_n_t_s_Q_u_e_u_e_d).
__
││
RootWindow(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Window XRootWindow(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the root window. These are useful with func-
tions that need a drawable of a particular screen and for
creating top-level windows.
2222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
ScreenCount(_d_i_s_p_l_a_y)
int XScreenCount(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the number of available screens.
__
││
ServerVendor(_d_i_s_p_l_a_y)
char *XServerVendor(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return a pointer to a null-terminated string that pro-
vides some identification of the owner of the X server
implementation. If the data returned by the server is in
the Latin Portable Character Encoding, then the string is in
the Host Portable Character Encoding. Otherwise, the con-
tents of the string are implementation-dependent.
__
││
VendorRelease(_d_i_s_p_l_a_y)
int XVendorRelease(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return a number related to a vendor's release of the X
server.
22..22..22.. IImmaaggee FFoorrmmaatt FFuunnccttiioonnss aanndd MMaaccrrooss
Applications are required to present data to the X server in
a format that the server demands. To help simplify applica-
tions, most of the work required to convert the data is pro-
vided by Xlib (see sections 8.7 and 16.8).
2233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The _X_P_i_x_m_a_p_F_o_r_m_a_t_V_a_l_u_e_s structure provides an interface to
the pixmap format information that is returned at the time
of a connection setup. It contains:
__
││
typedef struct {
int depth;
int bits_per_pixel;
int scanline_pad;
} XPixmapFormatValues;
││__
To obtain the pixmap format information for a given display,
use _X_L_i_s_t_P_i_x_m_a_p_F_o_r_m_a_t_s.
__
││
XPixmapFormatValues *XListPixmapFormats(_d_i_s_p_l_a_y, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of pixmap formats that are sup-
ported by the display.
││__
The _X_L_i_s_t_P_i_x_m_a_p_F_o_r_m_a_t_s function returns an array of _X_P_i_x_m_a_p_-
_F_o_r_m_a_t_V_a_l_u_e_s structures that describe the types of Z format
images supported by the specified display. If insufficient
memory is available, _X_L_i_s_t_P_i_x_m_a_p_F_o_r_m_a_t_s returns NULL. To
free the allocated storage for the _X_P_i_x_m_a_p_F_o_r_m_a_t_V_a_l_u_e_s
structures, use _X_F_r_e_e.
The following lists the C language macros, their correspond-
ing function equivalents that are for other language bind-
ings, and what data they both return for the specified
server and screen. These are often used by toolkits as well
as by simple applications.
2244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
ImageByteOrder(_d_i_s_p_l_a_y)
int XImageByteOrder(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both specify the required byte order for images for each
scanline unit in XY format (bitmap) or for each pixel value
in Z format. The macro or function can return either _L_S_B_-
_F_i_r_s_t or _M_S_B_F_i_r_s_t.
__
││
BitmapUnit(_d_i_s_p_l_a_y)
int XBitmapUnit(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Both return the size of a bitmap's scanline unit in bits.
The scanline is calculated in multiples of this value.
__
││
BitmapBitOrder(_d_i_s_p_l_a_y)
int XBitmapBitOrder(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Within each bitmap unit, the left-most bit in the bitmap as
displayed on the screen is either the least significant or
most significant bit in the unit. This macro or function
can return _L_S_B_F_i_r_s_t or _M_S_B_F_i_r_s_t.
2255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
BitmapPad(_d_i_s_p_l_a_y)
int XBitmapPad(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
Each scanline must be padded to a multiple of bits returned
by this macro or function.
__
││
DisplayHeight(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDisplayHeight(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return an integer that describes the height of the
screen in pixels.
__
││
DisplayHeightMM(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDisplayHeightMM(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the height of the specified screen in millime-
ters.
2266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
DisplayWidth(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDisplayWidth(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the width of the screen in pixels.
__
││
DisplayWidthMM(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
int XDisplayWidthMM(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
Both return the width of the specified screen in millime-
ters.
22..22..33.. SSccrreeeenn IInnffoorrmmaattiioonn MMaaccrrooss
The following lists the C language macros, their correspond-
ing function equivalents that are for other language bind-
ings, and what data they both can return. These macros or
functions all take a pointer to the appropriate screen
structure.
2277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
BlackPixelOfScreen(_s_c_r_e_e_n)
unsigned long XBlackPixelOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the black pixel value of the specified screen.
__
││
WhitePixelOfScreen(_s_c_r_e_e_n)
unsigned long XWhitePixelOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the white pixel value of the specified screen.
__
││
CellsOfScreen(_s_c_r_e_e_n)
int XCellsOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the number of colormap cells in the default col-
ormap of the specified screen.
__
││
DefaultColormapOfScreen(_s_c_r_e_e_n)
Colormap XDefaultColormapOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the default colormap of the specified screen.
2288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
DefaultDepthOfScreen(_s_c_r_e_e_n)
int XDefaultDepthOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the depth of the root window.
__
││
DefaultGCOfScreen(_s_c_r_e_e_n)
GC XDefaultGCOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return a default graphics context (GC) of the specified
screen, which has the same depth as the root window of the
screen. The GC must never be freed.
__
││
DefaultVisualOfScreen(_s_c_r_e_e_n)
Visual *XDefaultVisualOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the default visual of the specified screen. For
information on visual types, see section 3.1.
2299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
DoesBackingStore(_s_c_r_e_e_n)
int XDoesBackingStore(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return a value indicating whether the screen supports
backing stores. The value returned can be one of _W_h_e_n_-
_M_a_p_p_e_d, _N_o_t_U_s_e_f_u_l, or _A_l_w_a_y_s (see section 3.2.4).
__
││
DoesSaveUnders(_s_c_r_e_e_n)
Bool XDoesSaveUnders(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return a Boolean value indicating whether the screen
supports save unders. If _T_r_u_e, the screen supports save
unders. If _F_a_l_s_e, the screen does not support save unders
(see section 3.2.5).
__
││
DisplayOfScreen(_s_c_r_e_e_n)
Display *XDisplayOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the display of the specified screen.
3300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XScreenNumberOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
The _X_S_c_r_e_e_n_N_u_m_b_e_r_O_f_S_c_r_e_e_n function returns the screen index
number of the specified screen.
__
││
EventMaskOfScreen(_s_c_r_e_e_n)
long XEventMaskOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the event mask of the root window for the speci-
fied screen at connection setup time.
__
││
WidthOfScreen(_s_c_r_e_e_n)
int XWidthOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the width of the specified screen in pixels.
__
││
HeightOfScreen(_s_c_r_e_e_n)
int XHeightOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the height of the specified screen in pixels.
3311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
WidthMMOfScreen(_s_c_r_e_e_n)
int XWidthMMOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the width of the specified screen in millime-
ters.
__
││
HeightMMOfScreen(_s_c_r_e_e_n)
int XHeightMMOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the height of the specified screen in millime-
ters.
__
││
MaxCmapsOfScreen(_s_c_r_e_e_n)
int XMaxCmapsOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the maximum number of installed colormaps sup-
ported by the specified screen (see section 9.3).
3322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
MinCmapsOfScreen(_s_c_r_e_e_n)
int XMinCmapsOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the minimum number of installed colormaps sup-
ported by the specified screen (see section 9.3).
__
││
PlanesOfScreen(_s_c_r_e_e_n)
int XPlanesOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the depth of the root window.
__
││
RootWindowOfScreen(_s_c_r_e_e_n)
Window XRootWindowOfScreen(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the appropriate _S_c_r_e_e_n structure.
││__
Both return the root window of the specified screen.
22..33.. GGeenneerraattiinngg aa NNooOOppeerraattiioonn PPrroottooccooll RReeqquueesstt
To execute a _N_o_O_p_e_r_a_t_i_o_n protocol request, use _X_N_o_O_p.
__
││
XNoOp(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_N_o_O_p function sends a _N_o_O_p_e_r_a_t_i_o_n protocol request to
3333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the X server, thereby exercising the connection.
22..44.. FFrreeeeiinngg CClliieenntt--CCrreeaatteedd DDaattaa
To free in-memory data that was created by an Xlib function,
use _X_F_r_e_e.
__
││
XFree(_d_a_t_a)
void *_d_a_t_a;
_d_a_t_a Specifies the data that is to be freed.
││__
The _X_F_r_e_e function is a general-purpose Xlib routine that
frees the specified data. You must use it to free any
objects that were allocated by Xlib, unless an alternate
function is explicitly specified for the object. A NULL
pointer cannot be passed to this function.
22..55.. CClloossiinngg tthhee DDiissppllaayy
To close a display or disconnect from the X server, use
_X_C_l_o_s_e_D_i_s_p_l_a_y.
__
││
XCloseDisplay(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_C_l_o_s_e_D_i_s_p_l_a_y function closes the connection to the X
server for the display specified in the _D_i_s_p_l_a_y structure
and destroys all windows, resource IDs (_W_i_n_d_o_w, _F_o_n_t,
_P_i_x_m_a_p, _C_o_l_o_r_m_a_p, _C_u_r_s_o_r, and _G_C_o_n_t_e_x_t), or other resources
that the client has created on this display, unless the
close-down mode of the resource has been changed (see _X_S_e_t_-
_C_l_o_s_e_D_o_w_n_M_o_d_e). Therefore, these windows, resource IDs, and
other resources should never be referenced again or an error
will be generated. Before exiting, you should call
_X_C_l_o_s_e_D_i_s_p_l_a_y explicitly so that any pending errors are
reported as _X_C_l_o_s_e_D_i_s_p_l_a_y performs a final _X_S_y_n_c operation.
_X_C_l_o_s_e_D_i_s_p_l_a_y can generate a _B_a_d_G_C error.
Xlib provides a function to permit the resources owned by a
client to survive after the client's connection is closed.
To change a client's close-down mode, use _X_S_e_t_C_l_o_s_e_D_o_w_n_M_o_d_e.
3344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetCloseDownMode(_d_i_s_p_l_a_y, _c_l_o_s_e___m_o_d_e)
Display *_d_i_s_p_l_a_y;
int _c_l_o_s_e___m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_l_o_s_e___m_o_d_e
Specifies the client close-down mode. You can
pass _D_e_s_t_r_o_y_A_l_l, _R_e_t_a_i_n_P_e_r_m_a_n_e_n_t, or _R_e_t_a_i_n_T_e_m_p_o_-
_r_a_r_y.
││__
The _X_S_e_t_C_l_o_s_e_D_o_w_n_M_o_d_e defines what will happen to the
client's resources at connection close. A connection starts
in _D_e_s_t_r_o_y_A_l_l mode. For information on what happens to the
client's resources when the close_mode argument is _R_e_t_a_i_n_-
_P_e_r_m_a_n_e_n_t or _R_e_t_a_i_n_T_e_m_p_o_r_a_r_y, see section 2.6.
_X_S_e_t_C_l_o_s_e_D_o_w_n_M_o_d_e can generate a _B_a_d_V_a_l_u_e error.
22..66.. UUssiinngg XX SSeerrvveerr CCoonnnneeccttiioonn CClloossee OOppeerraattiioonnss
When the X server's connection to a client is closed either
by an explicit call to _X_C_l_o_s_e_D_i_s_p_l_a_y or by a process that
exits, the X server performs the following automatic opera-
tions:
· It disowns all selections owned by the client (see
_X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r).
· It performs an _X_U_n_g_r_a_b_P_o_i_n_t_e_r and _X_U_n_g_r_a_b_K_e_y_b_o_a_r_d if
the client has actively grabbed the pointer or the key-
board.
· It performs an _X_U_n_g_r_a_b_S_e_r_v_e_r if the client has grabbed
the server.
· It releases all passive grabs made by the client.
· It marks all resources (including colormap entries)
allocated by the client either as permanent or tempo-
rary, depending on whether the close-down mode is
_R_e_t_a_i_n_P_e_r_m_a_n_e_n_t or _R_e_t_a_i_n_T_e_m_p_o_r_a_r_y. However, this does
not prevent other client applications from explicitly
destroying the resources (see _X_S_e_t_C_l_o_s_e_D_o_w_n_M_o_d_e).
When the close-down mode is _D_e_s_t_r_o_y_A_l_l, the X server
destroys all of a client's resources as follows:
· It examines each window in the client's save-set to
determine if it is an inferior (subwindow) of a window
created by the client. (The save-set is a list of
3355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
other clients' windows that are referred to as save-set
windows.) If so, the X server reparents the save-set
window to the closest ancestor so that the save-set
window is not an inferior of a window created by the
client. The reparenting leaves unchanged the absolute
coordinates (with respect to the root window) of the
upper-left outer corner of the save-set window.
· It performs a _M_a_p_W_i_n_d_o_w request on the save-set window
if the save-set window is unmapped. The X server does
this even if the save-set window was not an inferior of
a window created by the client.
· It destroys all windows created by the client.
· It performs the appropriate free request on each non-
window resource created by the client in the server
(for example, _F_o_n_t, _P_i_x_m_a_p, _C_u_r_s_o_r, _C_o_l_o_r_m_a_p, and _G_C_o_n_-
_t_e_x_t).
· It frees all colors and colormap entries allocated by a
client application.
Additional processing occurs when the last connection to the
X server closes. An X server goes through a cycle of having
no connections and having some connections. When the last
connection to the X server closes as a result of a connec-
tion closing with the close_mode of _D_e_s_t_r_o_y_A_l_l, the X server
does the following:
· It resets its state as if it had just been started.
The X server begins by destroying all lingering
resources from clients that have terminated in _R_e_t_a_i_n_-
_P_e_r_m_a_n_e_n_t or _R_e_t_a_i_n_T_e_m_p_o_r_a_r_y mode.
· It deletes all but the predefined atom identifiers.
· It deletes all properties on all root windows (see sec-
tion 4.3).
· It resets all device maps and attributes (for example,
key click, bell volume, and acceleration) as well as
the access control list.
· It restores the standard root tiles and cursors.
· It restores the default font path.
· It restores the input focus to state _P_o_i_n_t_e_r_R_o_o_t.
However, the X server does not reset if you close a connec-
tion with a close-down mode set to _R_e_t_a_i_n_P_e_r_m_a_n_e_n_t or
_R_e_t_a_i_n_T_e_m_p_o_r_a_r_y.
3366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
22..77.. UUssiinngg XXlliibb wwiitthh TThhrreeaaddss
On systems that have threads, support may be provided to
permit multiple threads to use Xlib concurrently.
To initialize support for concurrent threads, use _X_I_n_i_t_-
_T_h_r_e_a_d_s.
__
││
Status XInitThreads();
││__
The _X_I_n_i_t_T_h_r_e_a_d_s function initializes Xlib support for con-
current threads. This function must be the first Xlib func-
tion a multi-threaded program calls, and it must complete
before any other Xlib call is made. This function returns a
nonzero status if initialization was successful; otherwise,
it returns zero. On systems that do not support threads,
this function always returns zero.
It is only necessary to call this function if multiple
threads might use Xlib concurrently. If all calls to Xlib
functions are protected by some other access mechanism (for
example, a mutual exclusion lock in a toolkit or through
explicit client programming), Xlib thread initialization is
not required. It is recommended that single-threaded pro-
grams not call this function.
To lock a display across several Xlib calls, use _X_L_o_c_k_D_i_s_-
_p_l_a_y.
__
││
void XLockDisplay(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_L_o_c_k_D_i_s_p_l_a_y function locks out all other threads from
using the specified display. Other threads attempting to
use the display will block until the display is unlocked by
this thread. Nested calls to _X_L_o_c_k_D_i_s_p_l_a_y work correctly;
the display will not actually be unlocked until _X_U_n_l_o_c_k_D_i_s_-
_p_l_a_y has been called the same number of times as _X_L_o_c_k_D_i_s_-
_p_l_a_y. This function has no effect unless Xlib was success-
fully initialized for threads using _X_I_n_i_t_T_h_r_e_a_d_s.
To unlock a display, use _X_U_n_l_o_c_k_D_i_s_p_l_a_y.
3377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XUnlockDisplay(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_U_n_l_o_c_k_D_i_s_p_l_a_y function allows other threads to use the
specified display again. Any threads that have blocked on
the display are allowed to continue. Nested locking works
correctly; if _X_L_o_c_k_D_i_s_p_l_a_y has been called multiple times by
a thread, then _X_U_n_l_o_c_k_D_i_s_p_l_a_y must be called an equal number
of times before the display is actually unlocked. This
function has no effect unless Xlib was successfully initial-
ized for threads using _X_I_n_i_t_T_h_r_e_a_d_s.
22..88.. UUssiinngg IInntteerrnnaall CCoonnnneeccttiioonnss
In addition to the connection to the X server, an Xlib
implementation may require connections to other kinds of
servers (for example, to input method servers as described
in chapter 13). Toolkits and clients that use multiple dis-
plays, or that use displays in combination with other
inputs, need to obtain these additional connections to cor-
rectly block until input is available and need to process
that input when it is available. Simple clients that use a
single display and block for input in an Xlib event function
do not need to use these facilities.
To track internal connections for a display, use _X_A_d_d_C_o_n_n_e_c_-
_t_i_o_n_W_a_t_c_h.
3388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef void (*XConnectionWatchProc)(_d_i_s_p_l_a_y, _c_l_i_e_n_t___d_a_t_a, _f_d, _o_p_e_n_i_n_g, _w_a_t_c_h___d_a_t_a)
Display *_d_i_s_p_l_a_y;
XPointer _c_l_i_e_n_t___d_a_t_a;
int _f_d;
Bool _o_p_e_n_i_n_g;
XPointer *_w_a_t_c_h___d_a_t_a;
Status XAddConnectionWatch(_d_i_s_p_l_a_y, _p_r_o_c_e_d_u_r_e, _c_l_i_e_n_t___d_a_t_a)
Display *_d_i_s_p_l_a_y;
XWatchProc _p_r_o_c_e_d_u_r_e;
XPointer _c_l_i_e_n_t___d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_r_o_c_e_d_u_r_e Specifies the procedure to be called.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
││__
The _X_A_d_d_C_o_n_n_e_c_t_i_o_n_W_a_t_c_h function registers a procedure to be
called each time Xlib opens or closes an internal connection
for the specified display. The procedure is passed the dis-
play, the specified client_data, the file descriptor for the
connection, a Boolean indicating whether the connection is
being opened or closed, and a pointer to a location for pri-
vate watch data. If opening is _T_r_u_e, the procedure can
store a pointer to private data in the location pointed to
by watch_data; when the procedure is later called for this
same connection and opening is _F_a_l_s_e, the location pointed
to by watch_data will hold this same private data pointer.
This function can be called at any time after a display is
opened. If internal connections already exist, the regis-
tered procedure will immediately be called for each of them,
before _X_A_d_d_C_o_n_n_e_c_t_i_o_n_W_a_t_c_h returns. _X_A_d_d_C_o_n_n_e_c_t_i_o_n_W_a_t_c_h
returns a nonzero status if the procedure is successfully
registered; otherwise, it returns zero.
The registered procedure should not call any Xlib functions.
If the procedure directly or indirectly causes the state of
internal connections or watch procedures to change, the
result is not defined. If Xlib has been initialized for
threads, the procedure is called with the display locked and
the result of a call by the procedure to any Xlib function
that locks the display is not defined unless the executing
thread has externally locked the display using _X_L_o_c_k_D_i_s_p_l_a_y.
To stop tracking internal connections for a display, use
_X_R_e_m_o_v_e_C_o_n_n_e_c_t_i_o_n_W_a_t_c_h.
3399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XRemoveConnectionWatch(_d_i_s_p_l_a_y, _p_r_o_c_e_d_u_r_e, _c_l_i_e_n_t___d_a_t_a)
Display *_d_i_s_p_l_a_y;
XWatchProc _p_r_o_c_e_d_u_r_e;
XPointer _c_l_i_e_n_t___d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_r_o_c_e_d_u_r_e Specifies the procedure to be called.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
││__
The _X_R_e_m_o_v_e_C_o_n_n_e_c_t_i_o_n_W_a_t_c_h function removes a previously
registered connection watch procedure. The client_data must
match the client_data used when the procedure was initially
registered.
To process input on an internal connection, use _X_P_r_o_c_e_s_s_I_n_-
_t_e_r_n_a_l_C_o_n_n_e_c_t_i_o_n.
__
││
void XProcessInternalConnection(_d_i_s_p_l_a_y, _f_d)
Display *_d_i_s_p_l_a_y;
int _f_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_d Specifies the file descriptor.
││__
The _X_P_r_o_c_e_s_s_I_n_t_e_r_n_a_l_C_o_n_n_e_c_t_i_o_n function processes input
available on an internal connection. This function should
be called for an internal connection only after an operating
system facility (for example, _s_e_l_e_c_t or _p_o_l_l) has indicated
that input is available; otherwise, the effect is not
defined.
To obtain all of the current internal connections for a dis-
play, use _X_I_n_t_e_r_n_a_l_C_o_n_n_e_c_t_i_o_n_N_u_m_b_e_r_s.
4400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XInternalConnectionNumbers(_d_i_s_p_l_a_y, _f_d___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int **_f_d___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_d___r_e_t_u_r_n Returns the file descriptors.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of file descriptors.
││__
The _X_I_n_t_e_r_n_a_l_C_o_n_n_e_c_t_i_o_n_N_u_m_b_e_r_s function returns a list of
the file descriptors for all internal connections currently
open for the specified display. When the allocated list is
no longer needed, free it by using _X_F_r_e_e. This functions
returns a nonzero status if the list is successfully allo-
cated; otherwise, it returns zero.
4411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 33
WWiinnddooww FFuunnccttiioonnss
In the X Window System, a window is a rectangular area on
the screen that lets you view graphic output. Client appli-
cations can display overlapping and nested windows on one or
more screens that are driven by X servers on one or more
machines. Clients who want to create windows must first
connect their program to the X server by calling _X_O_p_e_n_D_i_s_-
_p_l_a_y. This chapter begins with a discussion of visual types
and window attributes. The chapter continues with a discus-
sion of the Xlib functions you can use to:
· Create windows
· Destroy windows
· Map windows
· Unmap windows
· Configure windows
· Change window stacking order
· Change window attributes
This chapter also identifies the window actions that may
generate events.
Note that it is vital that your application conform to the
established conventions for communicating with window man-
agers for it to work well with the various window managers
in use (see section 14.1). Toolkits generally adhere to
these conventions for you, relieving you of the burden.
Toolkits also often supersede many functions in this chapter
with versions of their own. For more information, refer to
the documentation for the toolkit that you are using.
33..11.. VViissuuaall TTyyppeess
On some display hardware, it may be possible to deal with
color resources in more than one way. For example, you may
be able to deal with a screen of either 12-bit depth with
arbitrary mapping of pixel to color (pseudo-color) or 24-bit
depth with 8 bits of the pixel dedicated to each of red,
green, and blue. These different ways of dealing with the
visual aspects of the screen are called visuals. For each
screen of the display, there may be a list of valid visual
4422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
types supported at different depths of the screen. Because
default windows and visual types are defined for each
screen, most simple applications need not deal with this
complexity. Xlib provides macros and functions that return
the default root window, the default depth of the default
root window, and the default visual type (see sections 2.2.1
and 16.7).
Xlib uses an opaque _V_i_s_u_a_l structure that contains informa-
tion about the possible color mapping. The visual utility
functions (see section 16.7) use an _X_V_i_s_u_a_l_I_n_f_o structure to
return this information to an application. The members of
this structure pertinent to this discussion are class,
red_mask, green_mask, blue_mask, bits_per_rgb, and col-
ormap_size. The class member specifies one of the possible
visual classes of the screen and can be _S_t_a_t_i_c_G_r_a_y, _S_t_a_t_i_c_-
_C_o_l_o_r, _T_r_u_e_C_o_l_o_r, _G_r_a_y_S_c_a_l_e, _P_s_e_u_d_o_C_o_l_o_r, or _D_i_r_e_c_t_C_o_l_o_r.
The following concepts may serve to make the explanation of
visual types clearer. The screen can be color or grayscale,
can have a colormap that is writable or read-only, and can
also have a colormap whose indices are decomposed into sepa-
rate RGB pieces, provided one is not on a grayscale screen.
This leads to the following diagram:
Color Gray-scale
R/O R/W R/O R/W
+-------------+--------+--------+--------+-------+
|Undecomposed | Static | Pseudo | Static | Gray |
| Colormap | Color | Color | Gray | Scale |
+-------------+--------+--------+--------+-------+
| Decomposed | True | Direct |
| Colormap | Color | Color |
+-------------+--------+--------+
Conceptually, as each pixel is read out of video memory for
display on the screen, it goes through a look-up stage by
indexing into a colormap. Colormaps can be manipulated
arbitrarily on some hardware, in limited ways on other hard-
ware, and not at all on other hardware. The visual types
affect the colormap and the RGB values in the following
ways:
· For _P_s_e_u_d_o_C_o_l_o_r, a pixel value indexes a colormap to
produce independent RGB values, and the RGB values can
be changed dynamically.
· _G_r_a_y_S_c_a_l_e is treated the same way as _P_s_e_u_d_o_C_o_l_o_r except
that the primary that drives the screen is undefined.
4433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Thus, the client should always store the same value for
red, green, and blue in the colormaps.
· For _D_i_r_e_c_t_C_o_l_o_r, a pixel value is decomposed into sepa-
rate RGB subfields, and each subfield separately
indexes the colormap for the corresponding value. The
RGB values can be changed dynamically.
· _T_r_u_e_C_o_l_o_r is treated the same way as _D_i_r_e_c_t_C_o_l_o_r except
that the colormap has predefined, read-only RGB values.
These RGB values are server dependent but provide lin-
ear or near-linear ramps in each primary.
· _S_t_a_t_i_c_C_o_l_o_r is treated the same way as _P_s_e_u_d_o_C_o_l_o_r
except that the colormap has predefined, read-only,
server-dependent RGB values.
· _S_t_a_t_i_c_G_r_a_y is treated the same way as _S_t_a_t_i_c_C_o_l_o_r
except that the RGB values are equal for any single
pixel value, thus resulting in shades of gray. _S_t_a_t_-
_i_c_G_r_a_y with a two-entry colormap can be thought of as
monochrome.
The red_mask, green_mask, and blue_mask members are only
defined for _D_i_r_e_c_t_C_o_l_o_r and _T_r_u_e_C_o_l_o_r. Each has one con-
tiguous set of bits with no intersections. The bits_per_rgb
member specifies the log base 2 of the number of distinct
color values (individually) of red, green, and blue. Actual
RGB values are unsigned 16-bit numbers. The colormap_size
member defines the number of available colormap entries in a
newly created colormap. For _D_i_r_e_c_t_C_o_l_o_r and _T_r_u_e_C_o_l_o_r, this
is the size of an individual pixel subfield.
To obtain the visual ID from a _V_i_s_u_a_l, use _X_V_i_s_u_a_l_I_D_F_r_o_m_V_i_-
_s_u_a_l.
__
││
VisualID XVisualIDFromVisual(_v_i_s_u_a_l)
Visual *_v_i_s_u_a_l;
_v_i_s_u_a_l Specifies the visual type.
││__
The _X_V_i_s_u_a_l_I_D_F_r_o_m_V_i_s_u_a_l function returns the visual ID for
the specified visual type.
33..22.. WWiinnddooww AAttttrriibbuutteess
All _I_n_p_u_t_O_u_t_p_u_t windows have a border width of zero or more
pixels, an optional background, an event suppression mask
(which suppresses propagation of events from children), and
a property list (see section 4.3). The window border and
4444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
background can be a solid color or a pattern, called a tile.
All windows except the root have a parent and are clipped by
their parent. If a window is stacked on top of another win-
dow, it obscures that other window for the purpose of input.
If a window has a background (almost all do), it obscures
the other window for purposes of output. Attempts to output
to the obscured area do nothing, and no input events (for
example, pointer motion) are generated for the obscured
area.
Windows also have associated property lists (see section
4.3).
Both _I_n_p_u_t_O_u_t_p_u_t and _I_n_p_u_t_O_n_l_y windows have the following
common attributes, which are the only attributes of an _I_n_p_u_-
_t_O_n_l_y window:
· win-gravity
· event-mask
· do-not-propagate-mask
· override-redirect
· cursor
If you specify any other attributes for an _I_n_p_u_t_O_n_l_y window,
a _B_a_d_M_a_t_c_h error results.
_I_n_p_u_t_O_n_l_y windows are used for controlling input events in
situations where _I_n_p_u_t_O_u_t_p_u_t windows are unnecessary. _I_n_p_u_-
_t_O_n_l_y windows are invisible; can only be used to control
such things as cursors, input event generation, and grab-
bing; and cannot be used in any graphics requests. Note
that _I_n_p_u_t_O_n_l_y windows cannot have _I_n_p_u_t_O_u_t_p_u_t windows as
inferiors.
Windows have borders of a programmable width and pattern as
well as a background pattern or tile. Pixel values can be
used for solid colors. The background and border pixmaps
can be destroyed immediately after creating the window if no
further explicit references to them are to be made. The
pattern can either be relative to the parent or absolute.
If _P_a_r_e_n_t_R_e_l_a_t_i_v_e, the parent's background is used.
When windows are first created, they are not visible (not
mapped) on the screen. Any output to a window that is not
visible on the screen and that does not have backing store
will be discarded. An application may wish to create a win-
dow long before it is mapped to the screen. When a window
is eventually mapped to the screen (using _X_M_a_p_W_i_n_d_o_w), the X
server generates an _E_x_p_o_s_e event for the window if backing
store has not been maintained.
4455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
A window manager can override your choice of size, border
width, and position for a top-level window. Your program
must be prepared to use the actual size and position of the
top window. It is not acceptable for a client application
to resize itself unless in direct response to a human com-
mand to do so. Instead, either your program should use the
space given to it, or if the space is too small for any use-
ful work, your program might ask the user to resize the win-
dow. The border of your top-level window is considered fair
game for window managers.
To set an attribute of a window, set the appropriate member
of the _X_S_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s structure and OR in the corre-
sponding value bitmask in your subsequent calls to _X_C_r_e_-
_a_t_e_W_i_n_d_o_w and _X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s, or use one of the
other convenience functions that set the appropriate
attribute. The symbols for the value mask bits and the
_X_S_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s structure are:
4466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
/* Window attribute value mask bits */
#define _C_W_B_a_c_k_P_i_x_m_a_p (1L<<0)
#define _C_W_B_a_c_k_P_i_x_e_l (1L<<1)
#define _C_W_B_o_r_d_e_r_P_i_x_m_a_p (1L<<2)
#define _C_W_B_o_r_d_e_r_P_i_x_e_l (1L<<3)
#define _C_W_B_i_t_G_r_a_v_i_t_y (1L<<4)
#define _C_W_W_i_n_G_r_a_v_i_t_y (1L<<5)
#define _C_W_B_a_c_k_i_n_g_S_t_o_r_e (1L<<6)
#define _C_W_B_a_c_k_i_n_g_P_l_a_n_e_s (1L<<7)
#define _C_W_B_a_c_k_i_n_g_P_i_x_e_l (1L<<8)
#define _C_W_O_v_e_r_r_i_d_e_R_e_d_i_r_e_c_t (1L<<9)
#define _C_W_S_a_v_e_U_n_d_e_r (1L<<10)
#define _C_W_E_v_e_n_t_M_a_s_k (1L<<11)
#define _C_W_D_o_n_t_P_r_o_p_a_g_a_t_e (1L<<12)
#define _C_W_C_o_l_o_r_m_a_p (1L<<13)
#define _C_W_C_u_r_s_o_r (1L<<14)
/* Values */
typedef struct {
Pixmap background_pixmap;/* background, None, or ParentRelative */
unsigned long background_pixel;/* background pixel */
Pixmap border_pixmap; /* border of the window or CopyFromParent */
unsigned long border_pixel;/* border pixel value */
int bit_gravity; /* one of bit gravity values */
int win_gravity; /* one of the window gravity values */
int backing_store; /* NotUseful, WhenMapped, Always */
unsigned long backing_planes;/* planes to be preserved if possible */
unsigned long backing_pixel;/* value to use in restoring planes */
Bool save_under; /* should bits under be saved? (popups) */
long event_mask; /* set of events that should be saved */
long do_not_propagate_mask;/* set of events that should not propagate */
Bool override_redirect; /* boolean value for override_redirect */
Colormap colormap; /* color map to be associated with window */
Cursor cursor; /* cursor to be displayed (or None) */
} XSetWindowAttributes;
││__
The following lists the defaults for each window attribute
and indicates whether the attribute is applicable to
_I_n_p_u_t_O_u_t_p_u_t and _I_n_p_u_t_O_n_l_y windows:
-------------------------------------------------------------
AAttttrriibbuuttee DDeeffaauulltt _I_n_p_u_t_O_u_t_- _I_n_p_u_-
_p_u_t _t_O_n_l_y
-------------------------------------------------------------
background-pixmap _N_o_n_e Yes No
background-pixel Undefined Yes No
4477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------------
AAttttrriibbuuttee DDeeffaauulltt _I_n_p_u_t_O_u_t_- _I_n_p_u_-
_p_u_t _t_O_n_l_y
-------------------------------------------------------------
border-pixmap _C_o_p_y_F_r_o_m_P_a_r_- Yes No
_e_n_t
border-pixel Undefined Yes No
bit-gravity _F_o_r_g_e_t_G_r_a_v_i_t_y Yes No
win-gravity _N_o_r_t_h_W_e_s_t_- Yes Yes
_G_r_a_v_i_t_y
backing-store _N_o_t_U_s_e_f_u_l Yes No
backing-planes All ones Yes No
backing-pixel zero Yes No
save-under _F_a_l_s_e Yes No
event-mask empty set Yes Yes
do-not-propagate-mask empty set Yes Yes
override-redirect _F_a_l_s_e Yes Yes
colormap _C_o_p_y_F_r_o_m_P_a_r_- Yes No
_e_n_t
cursor _N_o_n_e Yes Yes
-------------------------------------------------------------
33..22..11.. BBaacckkggrroouunndd AAttttrriibbuuttee
Only _I_n_p_u_t_O_u_t_p_u_t windows can have a background. You can set
the background of an _I_n_p_u_t_O_u_t_p_u_t window by using a pixel or
a pixmap.
The background-pixmap attribute of a window specifies the
pixmap to be used for a window's background. This pixmap
can be of any size, although some sizes may be faster than
others. The background-pixel attribute of a window speci-
fies a pixel value used to paint a window's background in a
single color.
You can set the background-pixmap to a pixmap, _N_o_n_e
(default), or _P_a_r_e_n_t_R_e_l_a_t_i_v_e. You can set the background-
pixel of a window to any pixel value (no default). If you
specify a background-pixel, it overrides either the default
background-pixmap or any value you may have set in the back-
ground-pixmap. A pixmap of an undefined size that is filled
with the background-pixel is used for the background. Range
checking is not performed on the background pixel; it simply
is truncated to the appropriate number of bits.
If you set the background-pixmap, it overrides the default.
The background-pixmap and the window must have the same
depth, or a _B_a_d_M_a_t_c_h error results. If you set background-
pixmap to _N_o_n_e, the window has no defined background. If
you set the background-pixmap to _P_a_r_e_n_t_R_e_l_a_t_i_v_e:
· The parent window's background-pixmap is used. The
child window, however, must have the same depth as its
4488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
parent, or a _B_a_d_M_a_t_c_h error results.
· If the parent window has a background-pixmap of _N_o_n_e,
the window also has a background-pixmap of _N_o_n_e.
· A copy of the parent window's background-pixmap is not
made. The parent's background-pixmap is examined each
time the child window's background-pixmap is required.
· The background tile origin always aligns with the par-
ent window's background tile origin. If the back-
ground-pixmap is not _P_a_r_e_n_t_R_e_l_a_t_i_v_e, the background
tile origin is the child window's origin.
Setting a new background, whether by setting background-
pixmap or background-pixel, overrides any previous back-
ground. The background-pixmap can be freed immediately if
no further explicit reference is made to it (the X server
will keep a copy to use when needed). If you later draw
into the pixmap used for the background, what happens is
undefined because the X implementation is free to make a
copy of the pixmap or to use the same pixmap.
When no valid contents are available for regions of a window
and either the regions are visible or the server is main-
taining backing store, the server automatically tiles the
regions with the window's background unless the window has a
background of _N_o_n_e. If the background is _N_o_n_e, the previous
screen contents from other windows of the same depth as the
window are simply left in place as long as the contents come
from the parent of the window or an inferior of the parent.
Otherwise, the initial contents of the exposed regions are
undefined. _E_x_p_o_s_e events are then generated for the
regions, even if the background-pixmap is _N_o_n_e (see section
10.9).
33..22..22.. BBoorrddeerr AAttttrriibbuuttee
Only _I_n_p_u_t_O_u_t_p_u_t windows can have a border. You can set the
border of an _I_n_p_u_t_O_u_t_p_u_t window by using a pixel or a
pixmap.
The border-pixmap attribute of a window specifies the pixmap
to be used for a window's border. The border-pixel
attribute of a window specifies a pixmap of undefined size
filled with that pixel be used for a window's border. Range
checking is not performed on the background pixel; it simply
is truncated to the appropriate number of bits. The border
tile origin is always the same as the background tile ori-
gin.
You can also set the border-pixmap to a pixmap of any size
(some may be faster than others) or to _C_o_p_y_F_r_o_m_P_a_r_e_n_t
(default). You can set the border-pixel to any pixel value
4499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
(no default).
If you set a border-pixmap, it overrides the default. The
border-pixmap and the window must have the same depth, or a
_B_a_d_M_a_t_c_h error results. If you set the border-pixmap to
_C_o_p_y_F_r_o_m_P_a_r_e_n_t, the parent window's border-pixmap is copied.
Subsequent changes to the parent window's border attribute
do not affect the child window. However, the child window
must have the same depth as the parent window, or a _B_a_d_M_a_t_c_h
error results.
The border-pixmap can be freed immediately if no further
explicit reference is made to it. If you later draw into
the pixmap used for the border, what happens is undefined
because the X implementation is free either to make a copy
of the pixmap or to use the same pixmap. If you specify a
border-pixel, it overrides either the default border-pixmap
or any value you may have set in the border-pixmap. All
pixels in the window's border will be set to the border-
pixel. Setting a new border, whether by setting border-
pixel or by setting border-pixmap, overrides any previous
border.
Output to a window is always clipped to the inside of the
window. Therefore, graphics operations never affect the
window border.
33..22..33.. GGrraavviittyy AAttttrriibbuutteess
The bit gravity of a window defines which region of the win-
dow should be retained when an _I_n_p_u_t_O_u_t_p_u_t window is
resized. The default value for the bit-gravity attribute is
_F_o_r_g_e_t_G_r_a_v_i_t_y. The window gravity of a window allows you to
define how the _I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y window should be
repositioned if its parent is resized. The default value
for the win-gravity attribute is _N_o_r_t_h_W_e_s_t_G_r_a_v_i_t_y.
If the inside width or height of a window is not changed and
if the window is moved or its border is changed, then the
contents of the window are not lost but move with the win-
dow. Changing the inside width or height of the window
causes its contents to be moved or lost (depending on the
bit-gravity of the window) and causes children to be recon-
figured (depending on their win-gravity). For a change of
width and height, the (x, y) pairs are defined:
----------------------------------------
GGrraavviittyy DDiirreeccttiioonn CCoooorrddiinnaatteess
----------------------------------------
_N_o_r_t_h_W_e_s_t_G_r_a_v_i_t_y (0, 0)
_N_o_r_t_h_G_r_a_v_i_t_y (Width/2, 0)
_N_o_r_t_h_E_a_s_t_G_r_a_v_i_t_y (Width, 0)
5500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_W_e_s_t_G_r_a_v_i_t_y (0, Height/2)
_C_e_n_t_e_r_G_r_a_v_i_t_y (Width/2, Height/2)
_E_a_s_t_G_r_a_v_i_t_y (Width, Height/2)
_S_o_u_t_h_W_e_s_t_G_r_a_v_i_t_y (0, Height)
_S_o_u_t_h_G_r_a_v_i_t_y (Width/2, Height)
_S_o_u_t_h_E_a_s_t_G_r_a_v_i_t_y (Width, Height)
----------------------------------------
When a window with one of these bit-gravity values is
resized, the corresponding pair defines the change in posi-
tion of each pixel in the window. When a window with one of
these win-gravities has its parent window resized, the cor-
responding pair defines the change in position of the window
within the parent. When a window is so repositioned, a
_G_r_a_v_i_t_y_N_o_t_i_f_y event is generated (see section 10.10.5).
A bit-gravity of _S_t_a_t_i_c_G_r_a_v_i_t_y indicates that the contents
or origin should not move relative to the origin of the root
window. If the change in size of the window is coupled with
a change in position (x, y), then for bit-gravity the change
in position of each pixel is (-x, -y), and for win-gravity
the change in position of a child when its parent is so
resized is (-x, -y). Note that _S_t_a_t_i_c_G_r_a_v_i_t_y still only
takes effect when the width or height of the window is
changed, not when the window is moved.
A bit-gravity of _F_o_r_g_e_t_G_r_a_v_i_t_y indicates that the window's
contents are always discarded after a size change, even if a
backing store or save under has been requested. The window
is tiled with its background and zero or more _E_x_p_o_s_e events
are generated. If no background is defined, the existing
screen contents are not altered. Some X servers may also
ignore the specified bit-gravity and always generate _E_x_p_o_s_e
events.
The contents and borders of inferiors are not affected by
their parent's bit-gravity. A server is permitted to ignore
the specified bit-gravity and use _F_o_r_g_e_t instead.
A win-gravity of _U_n_m_a_p_G_r_a_v_i_t_y is like _N_o_r_t_h_W_e_s_t_G_r_a_v_i_t_y (the
window is not moved), except the child is also unmapped when
the parent is resized, and an _U_n_m_a_p_N_o_t_i_f_y event is gener-
ated.
33..22..44.. BBaacckkiinngg SSttoorree AAttttrriibbuuttee
Some implementations of the X server may choose to maintain
the contents of _I_n_p_u_t_O_u_t_p_u_t windows. If the X server main-
tains the contents of a window, the off-screen saved pixels
are known as backing store. The backing store advises the X
server on what to do with the contents of a window. The
backing-store attribute can be set to _N_o_t_U_s_e_f_u_l (default),
_W_h_e_n_M_a_p_p_e_d, or _A_l_w_a_y_s.
5511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
A backing-store attribute of _N_o_t_U_s_e_f_u_l advises the X server
that maintaining contents is unnecessary, although some X
implementations may still choose to maintain contents and,
therefore, not generate _E_x_p_o_s_e events. A backing-store
attribute of _W_h_e_n_M_a_p_p_e_d advises the X server that maintain-
ing contents of obscured regions when the window is mapped
would be beneficial. In this case, the server may generate
an _E_x_p_o_s_e event when the window is created. A backing-store
attribute of _A_l_w_a_y_s advises the X server that maintaining
contents even when the window is unmapped would be benefi-
cial. Even if the window is larger than its parent, this is
a request to the X server to maintain complete contents, not
just the region within the parent window boundaries. While
the X server maintains the window's contents, _E_x_p_o_s_e events
normally are not generated, but the X server may stop main-
taining contents at any time.
When the contents of obscured regions of a window are being
maintained, regions obscured by noninferior windows are
included in the destination of graphics requests (and
source, when the window is the source). However, regions
obscured by inferior windows are not included.
33..22..55.. SSaavvee UUnnddeerr FFllaagg
Some server implementations may preserve contents of
_I_n_p_u_t_O_u_t_p_u_t windows under other _I_n_p_u_t_O_u_t_p_u_t windows. This
is not the same as preserving the contents of a window for
you. You may get better visual appeal if transient windows
(for example, pop-up menus) request that the system preserve
the screen contents under them, so the temporarily obscured
applications do not have to repaint.
You can set the save-under flag to _T_r_u_e or _F_a_l_s_e (default).
If save-under is _T_r_u_e, the X server is advised that, when
this window is mapped, saving the contents of windows it
obscures would be beneficial.
33..22..66.. BBaacckkiinngg PPllaanneess aanndd BBaacckkiinngg PPiixxeell AAttttrriibbuutteess
You can set backing planes to indicate (with bits set to 1)
which bit planes of an _I_n_p_u_t_O_u_t_p_u_t window hold dynamic data
that must be preserved in backing store and during save
unders. The default value for the backing-planes attribute
is all bits set to 1. You can set backing pixel to specify
what bits to use in planes not covered by backing planes.
The default value for the backing-pixel attribute is all
bits set to 0. The X server is free to save only the speci-
fied bit planes in the backing store or the save under and
is free to regenerate the remaining planes with the speci-
fied pixel value. Any extraneous bits in these values (that
is, those bits beyond the specified depth of the window) may
be simply ignored. If you request backing store or save
unders, you should use these members to minimize the amount
5522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
of off-screen memory required to store your window.
33..22..77.. EEvveenntt MMaasskk aanndd DDoo NNoott PPrrooppaaggaattee MMaasskk AAttttrriibbuutteess
The event mask defines which events the client is interested
in for this _I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y window (or, for some
event types, inferiors of this window). The event mask is
the bitwise inclusive OR of zero or more of the valid event
mask bits. You can specify that no maskable events are
reported by setting _N_o_E_v_e_n_t_M_a_s_k (default).
The do-not-propagate-mask attribute defines which events
should not be propagated to ancestor windows when no client
has the event type selected in this _I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y
window. The do-not-propagate-mask is the bitwise inclusive
OR of zero or more of the following masks: _K_e_y_P_r_e_s_s, _K_e_y_R_e_-
_l_e_a_s_e, _B_u_t_t_o_n_P_r_e_s_s, _B_u_t_t_o_n_R_e_l_e_a_s_e, _P_o_i_n_t_e_r_M_o_t_i_o_n, _B_u_t_-
_t_o_n_1_M_o_t_i_o_n, _B_u_t_t_o_n_2_M_o_t_i_o_n, _B_u_t_t_o_n_3_M_o_t_i_o_n, _B_u_t_t_o_n_4_M_o_t_i_o_n,
_B_u_t_t_o_n_5_M_o_t_i_o_n, and _B_u_t_t_o_n_M_o_t_i_o_n. You can specify that all
events are propagated by setting _N_o_E_v_e_n_t_M_a_s_k (default).
33..22..88.. OOvveerrrriiddee RReeddiirreecctt FFllaagg
To control window placement or to add decoration, a window
manager often needs to intercept (redirect) any map or con-
figure request. Pop-up windows, however, often need to be
mapped without a window manager getting in the way. To con-
trol whether an _I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y window is to ignore
these structure control facilities, use the override-redi-
rect flag.
The override-redirect flag specifies whether map and config-
ure requests on this window should override a _S_u_b_s_t_r_u_c_t_u_r_-
_e_R_e_d_i_r_e_c_t_M_a_s_k on the parent. You can set the override-redi-
rect flag to _T_r_u_e or _F_a_l_s_e (default). Window managers use
this information to avoid tampering with pop-up windows (see
also chapter 14).
33..22..99.. CCoolloorrmmaapp AAttttrriibbuuttee
The colormap attribute specifies which colormap best
reflects the true colors of the _I_n_p_u_t_O_u_t_p_u_t window. The
colormap must have the same visual type as the window, or a
_B_a_d_M_a_t_c_h error results. X servers capable of supporting
multiple hardware colormaps can use this information, and
window managers can use it for calls to _X_I_n_s_t_a_l_l_C_o_l_o_r_m_a_p.
You can set the colormap attribute to a colormap or to _C_o_p_y_-
_F_r_o_m_P_a_r_e_n_t (default).
If you set the colormap to _C_o_p_y_F_r_o_m_P_a_r_e_n_t, the parent win-
dow's colormap is copied and used by its child. However,
the child window must have the same visual type as the par-
ent, or a _B_a_d_M_a_t_c_h error results. The parent window must
not have a colormap of _N_o_n_e, or a _B_a_d_M_a_t_c_h error results.
5533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The colormap is copied by sharing the colormap object
between the child and parent, not by making a complete copy
of the colormap contents. Subsequent changes to the parent
window's colormap attribute do not affect the child window.
33..22..1100.. CCuurrssoorr AAttttrriibbuuttee
The cursor attribute specifies which cursor is to be used
when the pointer is in the _I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y window.
You can set the cursor to a cursor or _N_o_n_e (default).
If you set the cursor to _N_o_n_e, the parent's cursor is used
when the pointer is in the _I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y window,
and any change in the parent's cursor will cause an immedi-
ate change in the displayed cursor. By calling _X_F_r_e_e_C_u_r_s_o_r,
the cursor can be freed immediately as long as no further
explicit reference to it is made.
33..33.. CCrreeaattiinngg WWiinnddoowwss
Xlib provides basic ways for creating windows, and toolkits
often supply higher-level functions specifically for creat-
ing and placing top-level windows, which are discussed in
the appropriate toolkit documentation. If you do not use a
toolkit, however, you must provide some standard information
or hints for the window manager by using the Xlib inter-
client communication functions (see chapter 14).
If you use Xlib to create your own top-level windows (direct
children of the root window), you must observe the following
rules so that all applications interact reasonably across
the different styles of window management:
· You must never fight with the window manager for the
size or placement of your top-level window.
· You must be able to deal with whatever size window you
get, even if this means that your application just
prints a message like ``Please make me bigger'' in its
window.
· You should only attempt to resize or move top-level
windows in direct response to a user request. If a
request to change the size of a top-level window fails,
you must be prepared to live with what you get. You
are free to resize or move the children of top-level
windows as necessary. (Toolkits often have facilities
for automatic relayout.)
· If you do not use a toolkit that automatically sets
standard window properties, you should set these prop-
erties for top-level windows before mapping them.
5544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
For further information, see chapter 14 and the _I_n_t_e_r_-_C_l_i_e_n_t
_C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l.
_X_C_r_e_a_t_e_W_i_n_d_o_w is the more general function that allows you
to set specific window attributes when you create a window.
_X_C_r_e_a_t_e_S_i_m_p_l_e_W_i_n_d_o_w creates a window that inherits its
attributes from its parent window.
The X server acts as if _I_n_p_u_t_O_n_l_y windows do not exist for
the purposes of graphics requests, exposure processing, and
_V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y events. An _I_n_p_u_t_O_n_l_y window cannot be used
as a drawable (that is, as a source or destination for
graphics requests). _I_n_p_u_t_O_n_l_y and _I_n_p_u_t_O_u_t_p_u_t windows act
identically in other respects (properties, grabs, input con-
trol, and so on). Extension packages can define other
classes of windows.
To create an unmapped window and set its window attributes,
use _X_C_r_e_a_t_e_W_i_n_d_o_w.
5555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Window XCreateWindow(_d_i_s_p_l_a_y, _p_a_r_e_n_t, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _b_o_r_d_e_r___w_i_d_t_h, _d_e_p_t_h,
_c_l_a_s_s, _v_i_s_u_a_l, _v_a_l_u_e_m_a_s_k, _a_t_t_r_i_b_u_t_e_s)
Display *_d_i_s_p_l_a_y;
Window _p_a_r_e_n_t;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int _b_o_r_d_e_r___w_i_d_t_h;
int _d_e_p_t_h;
unsigned int _c_l_a_s_s;
Visual *_v_i_s_u_a_l;
unsigned long _v_a_l_u_e_m_a_s_k;
XSetWindowAttributes *_a_t_t_r_i_b_u_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_a_r_e_n_t Specifies the parent window.
_x
_y Specify the x and y coordinates, which are the
top-left outside corner of the created window's
borders and are relative to the inside of the par-
ent window's borders.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the cre-
ated window's inside dimensions and do not include
the created window's borders. The dimensions must
be nonzero, or a _B_a_d_V_a_l_u_e error results.
_b_o_r_d_e_r___w_i_d_t_h
Specifies the width of the created window's border
in pixels.
_d_e_p_t_h Specifies the window's depth. A depth of _C_o_p_y_-
_F_r_o_m_P_a_r_e_n_t means the depth is taken from the par-
ent.
_c_l_a_s_s Specifies the created window's class. You can
pass _I_n_p_u_t_O_u_t_p_u_t, _I_n_p_u_t_O_n_l_y, or _C_o_p_y_F_r_o_m_P_a_r_e_n_t. A
class of _C_o_p_y_F_r_o_m_P_a_r_e_n_t means the class is taken
from the parent.
_v_i_s_u_a_l Specifies the visual type. A visual of _C_o_p_y_-
_F_r_o_m_P_a_r_e_n_t means the visual type is taken from the
parent.
_v_a_l_u_e_m_a_s_k Specifies which window attributes are defined in
the attributes argument. This mask is the bitwise
inclusive OR of the valid attribute mask bits. If
valuemask is zero, the attributes are ignored and
are not referenced.
5566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_a_t_t_r_i_b_u_t_e_s
Specifies the structure from which the values (as
specified by the value mask) are to be taken. The
value mask should have the appropriate bits set to
indicate which attributes have been set in the
structure.
││__
The _X_C_r_e_a_t_e_W_i_n_d_o_w function creates an unmapped subwindow for
a specified parent window, returns the window ID of the cre-
ated window, and causes the X server to generate a _C_r_e_a_t_e_N_o_-
_t_i_f_y event. The created window is placed on top in the
stacking order with respect to siblings.
The coordinate system has the X axis horizontal and the Y
axis vertical with the origin [0, 0] at the upper-left cor-
ner. Coordinates are integral, in terms of pixels, and
coincide with pixel centers. Each window and pixmap has its
own coordinate system. For a window, the origin is inside
the border at the inside, upper-left corner.
The border_width for an _I_n_p_u_t_O_n_l_y window must be zero, or a
_B_a_d_M_a_t_c_h error results. For class _I_n_p_u_t_O_u_t_p_u_t, the visual
type and depth must be a combination supported for the
screen, or a _B_a_d_M_a_t_c_h error results. The depth need not be
the same as the parent, but the parent must not be a window
of class _I_n_p_u_t_O_n_l_y, or a _B_a_d_M_a_t_c_h error results. For an
_I_n_p_u_t_O_n_l_y window, the depth must be zero, and the visual
must be one supported by the screen. If either condition is
not met, a _B_a_d_M_a_t_c_h error results. The parent window, how-
ever, may have any depth and class. If you specify any
invalid window attribute for a window, a _B_a_d_M_a_t_c_h error
results.
The created window is not yet displayed (mapped) on the
user's display. To display the window, call _X_M_a_p_W_i_n_d_o_w.
The new window initially uses the same cursor as its parent.
A new cursor can be defined for the new window by calling
_X_D_e_f_i_n_e_C_u_r_s_o_r. 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.
_X_C_r_e_a_t_e_W_i_n_d_o_w can generate _B_a_d_A_l_l_o_c, _B_a_d_C_o_l_o_r, _B_a_d_C_u_r_s_o_r,
_B_a_d_M_a_t_c_h, _B_a_d_P_i_x_m_a_p, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w errors.
To create an unmapped _I_n_p_u_t_O_u_t_p_u_t subwindow of a given par-
ent window, use _X_C_r_e_a_t_e_S_i_m_p_l_e_W_i_n_d_o_w.
5577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Window XCreateSimpleWindow(_d_i_s_p_l_a_y, _p_a_r_e_n_t, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _b_o_r_d_e_r___w_i_d_t_h,
_b_o_r_d_e_r, _b_a_c_k_g_r_o_u_n_d)
Display *_d_i_s_p_l_a_y;
Window _p_a_r_e_n_t;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int _b_o_r_d_e_r___w_i_d_t_h;
unsigned long _b_o_r_d_e_r;
unsigned long _b_a_c_k_g_r_o_u_n_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_a_r_e_n_t Specifies the parent window.
_x
_y Specify the x and y coordinates, which are the
top-left outside corner of the new window's bor-
ders and are relative to the inside of the parent
window's borders.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the cre-
ated window's inside dimensions and do not include
the created window's borders. The dimensions must
be nonzero, or a _B_a_d_V_a_l_u_e error results.
_b_o_r_d_e_r___w_i_d_t_h
Specifies the width of the created window's border
in pixels.
_b_o_r_d_e_r Specifies the border pixel value of the window.
_b_a_c_k_g_r_o_u_n_d
Specifies the background pixel value of the win-
dow.
││__
The _X_C_r_e_a_t_e_S_i_m_p_l_e_W_i_n_d_o_w function creates an unmapped
_I_n_p_u_t_O_u_t_p_u_t subwindow for a specified parent window, returns
the window ID of the created window, and causes the X server
to generate a _C_r_e_a_t_e_N_o_t_i_f_y event. The created window is
placed on top in the stacking order with respect to sib-
lings. Any part of the window that extends outside its par-
ent window is clipped. The border_width for an _I_n_p_u_t_O_n_l_y
window must be zero, or a _B_a_d_M_a_t_c_h error results. _X_C_r_e_a_t_e_S_-
_i_m_p_l_e_W_i_n_d_o_w inherits its depth, class, and visual from its
parent. All other window attributes, except background and
border, have their default values.
_X_C_r_e_a_t_e_S_i_m_p_l_e_W_i_n_d_o_w can generate _B_a_d_A_l_l_o_c, _B_a_d_M_a_t_c_h, _B_a_d_-
_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w errors.
5588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
33..44.. DDeessttrrooyyiinngg WWiinnddoowwss
Xlib provides functions that you can use to destroy a window
or destroy all subwindows of a window.
To destroy a window and all of its subwindows, use _X_D_e_s_t_r_o_y_-
_W_i_n_d_o_w.
__
││
XDestroyWindow(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_D_e_s_t_r_o_y_W_i_n_d_o_w function destroys the specified window as
well as all of its subwindows and causes the X server to
generate a _D_e_s_t_r_o_y_N_o_t_i_f_y event for each window. The window
should never be referenced again. If the window specified
by the w argument is mapped, it is unmapped automatically.
The ordering of the _D_e_s_t_r_o_y_N_o_t_i_f_y events is such that for
any given window being destroyed, _D_e_s_t_r_o_y_N_o_t_i_f_y is generated
on any inferiors of the window before being generated on the
window itself. The ordering among siblings and across sub-
hierarchies is not otherwise constrained. If the window you
specified is a root window, no windows are destroyed.
Destroying a mapped window will generate _E_x_p_o_s_e events on
other windows that were obscured by the window being
destroyed.
_X_D_e_s_t_r_o_y_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
To destroy all subwindows of a specified window, use _X_D_e_-
_s_t_r_o_y_S_u_b_w_i_n_d_o_w_s.
__
││
XDestroySubwindows(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_D_e_s_t_r_o_y_S_u_b_w_i_n_d_o_w_s function destroys all inferior win-
dows of the specified window, in bottom-to-top stacking
5599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
order. It causes the X server to generate a _D_e_s_t_r_o_y_N_o_t_i_f_y
event for each window. If any mapped subwindows were actu-
ally destroyed, _X_D_e_s_t_r_o_y_S_u_b_w_i_n_d_o_w_s causes the X server to
generate _E_x_p_o_s_e 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.
_X_D_e_s_t_r_o_y_S_u_b_w_i_n_d_o_w_s can generate a _B_a_d_W_i_n_d_o_w error.
33..55.. MMaappppiinngg WWiinnddoowwss
A window is considered mapped if an _X_M_a_p_W_i_n_d_o_w call has been
made on it. It may not be visible on the screen for one of
the following reasons:
· It is obscured by another opaque window.
· One of its ancestors is not mapped.
· It is entirely clipped by an ancestor.
_E_x_p_o_s_e events are generated for the window when part or all
of it becomes visible on the screen. A client receives the
_E_x_p_o_s_e events only if it has asked for them. Windows retain
their position in the stacking order when they are unmapped.
A window manager may want to control the placement of sub-
windows. If _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k has been selected by a
window manager on a parent window (usually a root window), a
map request initiated by other clients on a child window is
not performed, and the window manager is sent a _M_a_p_R_e_q_u_e_s_t
event. However, if the override-redirect flag on the child
had been set to _T_r_u_e (usually only on pop-up menus), the map
request is performed.
A tiling window manager might decide to reposition and
resize other clients' windows and then decide to map the
window to its final location. A window manager that wants
to provide decoration might reparent the child into a frame
first. For further information, see sections 3.2.8 and
10.10. Only a single client at a time can select for _S_u_b_-
_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k.
Similarly, a single client can select for _R_e_s_i_z_e_R_e_d_i_r_e_c_t_M_a_s_k
on a parent window. Then, any attempt to resize the window
by another client is suppressed, and the client receives a
_R_e_s_i_z_e_R_e_q_u_e_s_t event.
To map a given window, use _X_M_a_p_W_i_n_d_o_w.
6600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XMapWindow(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_M_a_p_W_i_n_d_o_w function maps the window and all of its sub-
windows that have had map requests. Mapping a window that
has an unmapped ancestor does not display the window but
marks it as eligible for display when the ancestor becomes
mapped. Such a window is called unviewable. When all its
ancestors are mapped, the window becomes viewable and will
be visible on the screen if it is not obscured by another
window. This function has no effect if the window is
already mapped.
If the override-redirect of the window is _F_a_l_s_e and if some
other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on the
parent window, then the X server generates a _M_a_p_R_e_q_u_e_s_t
event, and the _X_M_a_p_W_i_n_d_o_w function does not map the window.
Otherwise, the window is mapped, and the X server generates
a _M_a_p_N_o_t_i_f_y event.
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 _E_x_p_o_s_e events. If backing-store was
maintained while the window was unmapped, no _E_x_p_o_s_e events
are generated. If backing-store will now be maintained, a
full-window exposure is always generated. Otherwise, only
visible regions may be reported. Similar tiling and expo-
sure take place for any newly viewable inferiors.
If the window is an _I_n_p_u_t_O_u_t_p_u_t window, _X_M_a_p_W_i_n_d_o_w generates
_E_x_p_o_s_e events on each _I_n_p_u_t_O_u_t_p_u_t window that it causes to
be displayed. 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 _E_x_p_o_s_e events
and then map the window, so the client processes input
events as usual. The event list will include _E_x_p_o_s_e for
each window that has appeared on the screen. The client's
normal response to an _E_x_p_o_s_e event should be to repaint the
window. This method usually leads to simpler programs and
to proper interaction with window managers.
_X_M_a_p_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
6611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To map and raise a window, use _X_M_a_p_R_a_i_s_e_d.
__
││
XMapRaised(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_M_a_p_R_a_i_s_e_d function essentially is similar to _X_M_a_p_W_i_n_d_o_w
in that it maps the window and all of its subwindows that
have had map requests. However, it also raises the speci-
fied window to the top of the stack. For additional infor-
mation, see _X_M_a_p_W_i_n_d_o_w.
_X_M_a_p_R_a_i_s_e_d can generate multiple _B_a_d_W_i_n_d_o_w errors.
To map all subwindows for a specified window, use _X_M_a_p_S_u_b_-
_w_i_n_d_o_w_s.
__
││
XMapSubwindows(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_M_a_p_S_u_b_w_i_n_d_o_w_s function maps all subwindows for a speci-
fied window in top-to-bottom stacking order. The X server
generates _E_x_p_o_s_e events on each newly displayed window.
This may be much more efficient than mapping many windows
one at a time because the server needs to perform much of
the work only once, for all of the windows, rather than for
each window.
_X_M_a_p_S_u_b_w_i_n_d_o_w_s can generate a _B_a_d_W_i_n_d_o_w error.
33..66.. UUnnmmaappppiinngg WWiinnddoowwss
Xlib provides functions that you can use to unmap a window
or all subwindows.
To unmap a window, use _X_U_n_m_a_p_W_i_n_d_o_w.
6622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XUnmapWindow(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_U_n_m_a_p_W_i_n_d_o_w function unmaps the specified window and
causes the X server to generate an _U_n_m_a_p_N_o_t_i_f_y event. If
the specified window is already unmapped, _X_U_n_m_a_p_W_i_n_d_o_w has
no effect. Normal exposure processing on formerly obscured
windows is performed. Any child window will no longer be
visible until another map call is made on the parent. In
other words, the subwindows are still mapped but are not
visible until the parent is mapped. Unmapping a window will
generate _E_x_p_o_s_e events on windows that were formerly
obscured by it.
_X_U_n_m_a_p_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
To unmap all subwindows for a specified window, use _X_U_n_m_a_p_-
_S_u_b_w_i_n_d_o_w_s.
__
││
XUnmapSubwindows(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_U_n_m_a_p_S_u_b_w_i_n_d_o_w_s function unmaps all subwindows for the
specified window in bottom-to-top stacking order. It causes
the X server to generate an _U_n_m_a_p_N_o_t_i_f_y event on each sub-
window and _E_x_p_o_s_e events on formerly obscured windows.
Using this function is much more efficient than unmapping
multiple windows one at a time because the server needs to
perform much of the work only once, for all of the windows,
rather than for each window.
_X_U_n_m_a_p_S_u_b_w_i_n_d_o_w_s can generate a _B_a_d_W_i_n_d_o_w error.
33..77.. CCoonnffiigguurriinngg WWiinnddoowwss
6633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Xlib provides functions that you can use to move a window,
resize a window, move and resize a window, or change a win-
dow's border width. To change one of these parameters, set
the appropriate member of the _X_W_i_n_d_o_w_C_h_a_n_g_e_s structure and
OR in the corresponding value mask in subsequent calls to
_X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w. The symbols for the value mask bits and
the _X_W_i_n_d_o_w_C_h_a_n_g_e_s structure are:
__
││
/* Configure window value mask bits */
#define _C_W_X (1<<0)
#define _C_W_Y (1<<1)
#define _C_W_W_i_d_t_h (1<<2)
#define _C_W_H_e_i_g_h_t (1<<3)
#define _C_W_B_o_r_d_e_r_W_i_d_t_h (1<<4)
#define _C_W_S_i_b_l_i_n_g (1<<5)
#define _C_W_S_t_a_c_k_M_o_d_e (1<<6)
/* Values */
typedef struct {
int x, y;
int width, height;
int border_width;
Window sibling;
int stack_mode;
} XWindowChanges;
││__
The x and y members are used to set the window's x and y
coordinates, which are relative to the parent's origin and
indicate the position of the upper-left outer corner of the
window. The width and height members are used to set the
inside size of the window, not including the border, and
must be nonzero, or a _B_a_d_V_a_l_u_e error results. Attempts to
configure a root window have no effect.
The border_width member is used to set the width of the bor-
der in pixels. Note that setting just the border width
leaves the outer-left corner of the window in a fixed posi-
tion but moves the absolute position of the window's origin.
If you attempt to set the border-width attribute of an _I_n_p_u_-
_t_O_n_l_y window nonzero, a _B_a_d_M_a_t_c_h error results.
The sibling member is used to set the sibling window for
stacking operations. The stack_mode member is used to set
how the window is to be restacked and can be set to _A_b_o_v_e,
_B_e_l_o_w, _T_o_p_I_f, _B_o_t_t_o_m_I_f, or _O_p_p_o_s_i_t_e.
If the override-redirect flag of the window is _F_a_l_s_e and if
some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on
6644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the parent, the X server generates a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t event,
and no further processing is performed. Otherwise, if some
other client has selected _R_e_s_i_z_e_R_e_d_i_r_e_c_t_M_a_s_k on the window
and the inside width or height of the window is being
changed, a _R_e_s_i_z_e_R_e_q_u_e_s_t event is generated, and the current
inside width and height are used instead. Note that the
override-redirect flag of the window has no effect on _R_e_s_i_z_-
_e_R_e_d_i_r_e_c_t_M_a_s_k and that _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on the par-
ent has precedence over _R_e_s_i_z_e_R_e_d_i_r_e_c_t_M_a_s_k on the window.
When the geometry of the window is changed as specified, the
window is restacked among siblings, and a _C_o_n_f_i_g_u_r_e_N_o_t_i_f_y
event is generated if the state of the window actually
changes. _G_r_a_v_i_t_y_N_o_t_i_f_y events are generated after _C_o_n_f_i_g_-
_u_r_e_N_o_t_i_f_y events. If the inside width or height of the win-
dow has actually changed, children of the window are
affected as specified.
If a window's size actually changes, the window's subwindows
move according to their window gravity. Depending on the
window's bit gravity, the contents of the window also may be
moved (see section 3.2.3).
If regions of the window were obscured but now are not,
exposure processing is performed on these formerly obscured
windows, including the window itself and its inferiors. As
a result of increasing the width or height, exposure pro-
cessing is also performed on any new regions of the window
and any regions where window contents are lost.
The restack check (specifically, the computation for _B_o_t_-
_t_o_m_I_f, _T_o_p_I_f, and _O_p_p_o_s_i_t_e) is performed with respect to the
window's final size and position (as controlled by the other
arguments of the request), not its initial position. If a
sibling is specified without a stack_mode, a _B_a_d_M_a_t_c_h error
results.
If a sibling and a stack_mode are specified, the window is
restacked as follows:
_A_b_o_v_e The window is placed just above the sibling.
_B_e_l_o_w The window is placed just below the sibling.
_T_o_p_I_f If the sibling occludes the window, the window is
placed at the top of the stack.
_B_o_t_t_o_m_I_f If the window occludes the sibling, the window is
placed at the bottom of the stack.
_O_p_p_o_s_i_t_e If the sibling occludes the window, the window is
placed at the top of the stack. If the window
occludes the sibling, the window is placed at the
bottom of the stack.
If a stack_mode is specified but no sibling is specified,
the window is restacked as follows:
6655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_A_b_o_v_e The window is placed at the top of the stack.
_B_e_l_o_w The window is placed at the bottom of the stack.
_T_o_p_I_f If any sibling occludes the window, the window is
placed at the top of the stack.
_B_o_t_t_o_m_I_f If the window occludes any sibling, the window is
placed at the bottom of the stack.
_O_p_p_o_s_i_t_e If any sibling occludes the window, the window is
placed at the top of the stack. If the window
occludes any sibling, the window is placed at the
bottom of the stack.
Attempts to configure a root window have no effect.
To configure a window's size, location, stacking, or border,
use _X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w.
__
││
XConfigureWindow(_d_i_s_p_l_a_y, _w, _v_a_l_u_e___m_a_s_k, _v_a_l_u_e_s)
Display *_d_i_s_p_l_a_y;
Window _w;
unsigned int _v_a_l_u_e___m_a_s_k;
XWindowChanges *_v_a_l_u_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window to be reconfigured.
_v_a_l_u_e___m_a_s_k
Specifies which values are to be set using infor-
mation in the values structure. This mask is the
bitwise inclusive OR of the valid configure window
values bits.
_v_a_l_u_e_s Specifies the _X_W_i_n_d_o_w_C_h_a_n_g_e_s structure.
││__
The _X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w function uses the values specified in
the _X_W_i_n_d_o_w_C_h_a_n_g_e_s structure to reconfigure a window's size,
position, border, and stacking order. Values not specified
are taken from the existing geometry of the window.
If a sibling is specified without a stack_mode or if the
window is not actually a sibling, a _B_a_d_M_a_t_c_h error results.
Note that the computations for _B_o_t_t_o_m_I_f, _T_o_p_I_f, and _O_p_p_o_s_i_t_e
are performed with respect to the window's final geometry
(as controlled by the other arguments passed to _X_C_o_n_f_i_g_-
_u_r_e_W_i_n_d_o_w), not its initial geometry. Any backing store
contents of the window, its inferiors, and other newly visi-
ble windows are either discarded or changed to reflect the
current screen contents (depending on the implementation).
6666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w can generate _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e, and _B_a_d_-
_W_i_n_d_o_w errors.
To move a window without changing its size, use _X_M_o_v_e_W_i_n_d_o_w.
__
││
XMoveWindow(_d_i_s_p_l_a_y, _w, _x, _y)
Display *_d_i_s_p_l_a_y;
Window _w;
int _x, _y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window to be moved.
_x
_y 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.
││__
The _X_M_o_v_e_W_i_n_d_o_w 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 and if no backing store exists. If the con-
tents of the window are lost, the X server generates _E_x_p_o_s_e
events. Moving a mapped window generates _E_x_p_o_s_e events on
any formerly obscured windows.
If the override-redirect flag of the window is _F_a_l_s_e and
some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on
the parent, the X server generates a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t event,
and no further processing is performed. Otherwise, the win-
dow is moved.
_X_M_o_v_e_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
To change a window's size without changing the upper-left
coordinate, use _X_R_e_s_i_z_e_W_i_n_d_o_w.
6677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XResizeWindow(_d_i_s_p_l_a_y, _w, _w_i_d_t_h, _h_e_i_g_h_t)
Display *_d_i_s_p_l_a_y;
Window _w;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the inte-
rior dimensions of the window after the call com-
pletes.
││__
The _X_R_e_s_i_z_e_W_i_n_d_o_w function changes the inside dimensions of
the specified window, not including its borders. This func-
tion does not change the window's upper-left coordinate or
the origin and does not restack the window. Changing the
size of a mapped window may lose its contents and generate
_E_x_p_o_s_e events. If a mapped window is made smaller, changing
its size generates _E_x_p_o_s_e events on windows that the mapped
window formerly obscured.
If the override-redirect flag of the window is _F_a_l_s_e and
some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on
the parent, the X server generates a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t event,
and no further processing is performed. If either width or
height is zero, a _B_a_d_V_a_l_u_e error results.
_X_R_e_s_i_z_e_W_i_n_d_o_w can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
To change the size and location of a window, use _X_M_o_v_e_R_e_-
_s_i_z_e_W_i_n_d_o_w.
6688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XMoveResizeWindow(_d_i_s_p_l_a_y, _w, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t)
Display *_d_i_s_p_l_a_y;
Window _w;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window to be reconfigured.
_x
_y Specify the x and y coordinates, which define the
new position of the window relative to its parent.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which define the
interior size of the window.
││__
The _X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w function changes the size and location
of the specified window without raising it. Moving and
resizing a mapped window may generate an _E_x_p_o_s_e event on the
window. Depending on the new size and location parameters,
moving and resizing a window may generate _E_x_p_o_s_e events on
windows that the window formerly obscured.
If the override-redirect flag of the window is _F_a_l_s_e and
some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on
the parent, the X server generates a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t event,
and no further processing is performed. Otherwise, the win-
dow size and location are changed.
_X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w
errors.
To change the border width of a given window, use _X_S_e_t_W_i_n_-
_d_o_w_B_o_r_d_e_r_W_i_d_t_h.
6699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetWindowBorderWidth(_d_i_s_p_l_a_y, _w, _w_i_d_t_h)
Display *_d_i_s_p_l_a_y;
Window _w;
unsigned int _w_i_d_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_d_t_h Specifies the width of the window border.
││__
The _X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r_W_i_d_t_h function sets the specified win-
dow's border width to the specified width.
_X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r_W_i_d_t_h can generate a _B_a_d_W_i_n_d_o_w error.
33..88.. CChhaannggiinngg WWiinnddooww SSttaacckkiinngg OOrrddeerr
Xlib provides functions that you can use to raise, lower,
circulate, or restack windows.
To raise a window so that no sibling window obscures it, use
_X_R_a_i_s_e_W_i_n_d_o_w.
__
││
XRaiseWindow(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_R_a_i_s_e_W_i_n_d_o_w function raises the specified window to the
top of the stack so that no sibling window obscures it. If
the windows are regarded as overlapping sheets of paper
stacked on a desk, then raising a window is analogous to
moving the sheet to the top of the stack but leaving its x
and y location on the desk constant. Raising a mapped win-
dow may generate _E_x_p_o_s_e events for the window and any mapped
subwindows that were formerly obscured.
If the override-redirect attribute of the window is _F_a_l_s_e
and some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k
on the parent, the X server generates a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t
event, and no processing is performed. Otherwise, the win-
dow is raised.
7700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_R_a_i_s_e_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
To lower a window so that it does not obscure any sibling
windows, use _X_L_o_w_e_r_W_i_n_d_o_w.
__
││
XLowerWindow(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_L_o_w_e_r_W_i_n_d_o_w function lowers the specified window to the
bottom of the stack so that it does not obscure any sibling
windows. If the windows are regarded as overlapping sheets
of paper stacked on a desk, then lowering a window is analo-
gous to moving the sheet to the bottom of the stack but
leaving its x and y location on the desk constant. Lowering
a mapped window will generate _E_x_p_o_s_e events on any windows
it formerly obscured.
If the override-redirect attribute of the window is _F_a_l_s_e
and some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k
on the parent, the X server generates a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t
event, and no processing is performed. Otherwise, the win-
dow is lowered to the bottom of the stack.
_X_L_o_w_e_r_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
To circulate a subwindow up or down, use _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_-
_d_o_w_s.
7711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XCirculateSubwindows(_d_i_s_p_l_a_y, _w, _d_i_r_e_c_t_i_o_n)
Display *_d_i_s_p_l_a_y;
Window _w;
int _d_i_r_e_c_t_i_o_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_d_i_r_e_c_t_i_o_n Specifies the direction (up or down) that you want
to circulate the window. You can pass _R_a_i_s_e_L_o_w_e_s_t
or _L_o_w_e_r_H_i_g_h_e_s_t.
││__
The _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s function circulates children of the
specified window in the specified direction. If you specify
_R_a_i_s_e_L_o_w_e_s_t, _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s raises the lowest mapped
child (if any) that is occluded by another child to the top
of the stack. If you specify _L_o_w_e_r_H_i_g_h_e_s_t, _X_C_i_r_c_u_l_a_t_e_S_u_b_-
_w_i_n_d_o_w_s lowers the highest mapped child (if any) that
occludes another child to the bottom of the stack. Exposure
processing is then performed on formerly obscured windows.
If some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k
on the window, the X server generates a _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t
event, and no further processing is performed. If a child
is actually restacked, the X server generates a _C_i_r_c_u_l_a_t_e_N_o_-
_t_i_f_y event.
_X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w
errors.
To raise the lowest mapped child of a window that is par-
tially or completely occluded by another child, use _X_C_i_r_c_u_-
_l_a_t_e_S_u_b_w_i_n_d_o_w_s_U_p.
__
││
XCirculateSubwindowsUp(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_U_p function raises the lowest mapped
child of the specified window that is partially or com-
pletely occluded by another child. Completely unobscured
children are not affected. This is a convenience function
equivalent to _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s with _R_a_i_s_e_L_o_w_e_s_t
7722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
specified.
_X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_U_p can generate a _B_a_d_W_i_n_d_o_w error.
To lower the highest mapped child of a window that partially
or completely occludes another child, use _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_-
_d_o_w_s_D_o_w_n.
__
││
XCirculateSubwindowsDown(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_D_o_w_n function lowers the highest
mapped child of the specified window that partially or com-
pletely occludes another child. Completely unobscured chil-
dren are not affected. This is a convenience function
equivalent to _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s with _L_o_w_e_r_H_i_g_h_e_s_t speci-
fied.
_X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_D_o_w_n can generate a _B_a_d_W_i_n_d_o_w error.
To restack a set of windows from top to bottom, use
_X_R_e_s_t_a_c_k_W_i_n_d_o_w_s.
__
││
XRestackWindows(_d_i_s_p_l_a_y, _w_i_n_d_o_w_s, _n_w_i_n_d_o_w_s);
Display *_d_i_s_p_l_a_y;
Window _w_i_n_d_o_w_s[];
int _n_w_i_n_d_o_w_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w_i_n_d_o_w_s Specifies an array containing the windows to be
restacked.
_n_w_i_n_d_o_w_s Specifies the number of windows to be restacked.
││__
The _X_R_e_s_t_a_c_k_W_i_n_d_o_w_s function restacks the windows in the
order specified, from top to bottom. The stacking order of
the first window in the windows array is unaffected, but the
other windows in the array are stacked underneath the first
window, in the order of the array. The stacking order of
the other windows is not affected. For each window in the
7733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
window array that is not a child of the specified window, a
_B_a_d_M_a_t_c_h error results.
If the override-redirect attribute of a window is _F_a_l_s_e and
some other client has selected _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on
the parent, the X server generates _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t events
for each window whose override-redirect flag is not set, and
no further processing is performed. Otherwise, the windows
will be restacked in top-to-bottom order.
_X_R_e_s_t_a_c_k_W_i_n_d_o_w_s can generate a _B_a_d_W_i_n_d_o_w error.
33..99.. CChhaannggiinngg WWiinnddooww AAttttrriibbuutteess
Xlib provides functions that you can use to set window
attributes. _X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s is the more general
function that allows you to set one or more window
attributes provided by the _X_S_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s structure.
The other functions described in this section allow you to
set one specific window attribute, such as a window's back-
ground.
To change one or more attributes for a given window, use
_X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s.
7744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XChangeWindowAttributes(_d_i_s_p_l_a_y, _w, _v_a_l_u_e_m_a_s_k, _a_t_t_r_i_b_u_t_e_s)
Display *_d_i_s_p_l_a_y;
Window _w;
unsigned long _v_a_l_u_e_m_a_s_k;
XSetWindowAttributes *_a_t_t_r_i_b_u_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_v_a_l_u_e_m_a_s_k Specifies which window attributes are defined in
the attributes argument. This mask is the bitwise
inclusive OR of the valid attribute mask bits. If
valuemask is zero, the attributes are ignored and
are not referenced. The values and restrictions
are the same as for _X_C_r_e_a_t_e_W_i_n_d_o_w.
_a_t_t_r_i_b_u_t_e_s
Specifies the structure from which the values (as
specified by the value mask) are to be taken. The
value mask should have the appropriate bits set to
indicate which attributes have been set in the
structure (see section 3.2).
││__
Depending on the valuemask, the _X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s
function uses the window attributes in the _X_S_e_t_W_i_n_d_o_w_A_t_-
_t_r_i_b_u_t_e_s structure to change the specified window
attributes. Changing the background does not cause the win-
dow contents to be changed. To repaint the window and its
background, use _X_C_l_e_a_r_W_i_n_d_o_w. Setting the border or chang-
ing the background such that the border tile origin changes
causes the border to be repainted. Changing the background
of a root window to _N_o_n_e or _P_a_r_e_n_t_R_e_l_a_t_i_v_e restores the
default background pixmap. Changing the border of a root
window to _C_o_p_y_F_r_o_m_P_a_r_e_n_t restores the default border pixmap.
Changing the win-gravity does not affect the current posi-
tion of the window. Changing the backing-store of an
obscured window to _W_h_e_n_M_a_p_p_e_d or _A_l_w_a_y_s, 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 _C_o_l_o_r_m_a_p_N_o_t_i_f_y
event. Changing the colormap of a visible window may have
no immediate effect on the screen because the map may not be
installed (see _X_I_n_s_t_a_l_l_C_o_l_o_r_m_a_p). Changing the cursor of a
root window to _N_o_n_e restores the default cursor. Whenever
possible, you are encouraged to share colormaps.
Multiple clients can select input on the same window. Their
event masks are maintained separately. When an event is
7755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
generated, it is reported to all interested clients. How-
ever, only one client at a time can select for _S_u_b_s_t_r_u_c_t_u_r_-
_e_R_e_d_i_r_e_c_t_M_a_s_k, _R_e_s_i_z_e_R_e_d_i_r_e_c_t_M_a_s_k, and _B_u_t_t_o_n_P_r_e_s_s_M_a_s_k. If
a client attempts to select any of these event masks and
some other client has already selected one, a _B_a_d_A_c_c_e_s_s
error results. There is only one do-not-propagate-mask for
a window, not one per client.
_X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r,
_B_a_d_C_u_r_s_o_r, _B_a_d_M_a_t_c_h, _B_a_d_P_i_x_m_a_p, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
errors.
To set the background of a window to a given pixel, use
_X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d.
__
││
XSetWindowBackground(_d_i_s_p_l_a_y, _w, _b_a_c_k_g_r_o_u_n_d___p_i_x_e_l)
Display *_d_i_s_p_l_a_y;
Window _w;
unsigned long _b_a_c_k_g_r_o_u_n_d___p_i_x_e_l;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_b_a_c_k_g_r_o_u_n_d___p_i_x_e_l
Specifies the pixel that is to be used for the
background.
││__
The _X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d function sets the background of the
window to the specified pixel value. Changing the back-
ground does not cause the window contents to be changed.
_X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d uses a pixmap of undefined size filled
with the pixel value you passed. If you try to change the
background of an _I_n_p_u_t_O_n_l_y window, a _B_a_d_M_a_t_c_h error results.
_X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w
errors.
To set the background of a window to a given pixmap, use
_X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d_P_i_x_m_a_p.
7766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetWindowBackgroundPixmap(_d_i_s_p_l_a_y, _w, _b_a_c_k_g_r_o_u_n_d___p_i_x_m_a_p)
Display *_d_i_s_p_l_a_y;
Window _w;
Pixmap _b_a_c_k_g_r_o_u_n_d___p_i_x_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_b_a_c_k_g_r_o_u_n_d___p_i_x_m_a_p
Specifies the background pixmap, _P_a_r_e_n_t_R_e_l_a_t_i_v_e,
or _N_o_n_e.
││__
The _X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d_P_i_x_m_a_p function sets the background
pixmap of the window to the specified pixmap. The back-
ground pixmap can immediately be freed if no further
explicit references to it are to be made. If _P_a_r_e_n_t_R_e_l_a_t_i_v_e
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 _I_n_p_u_-
_t_O_n_l_y window, a _B_a_d_M_a_t_c_h error results. If the background
is set to _N_o_n_e, the window has no defined background.
_X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d_P_i_x_m_a_p can generate _B_a_d_M_a_t_c_h, _B_a_d_P_i_x_m_a_p,
and _B_a_d_W_i_n_d_o_w errors.
Note
_X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d and _X_S_e_t_W_i_n_d_o_w_B_a_c_k_g_r_o_u_n_d_-
_P_i_x_m_a_p do not change the current contents of the
window.
To change and repaint a window's border to a given pixel,
use _X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r.
7777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetWindowBorder(_d_i_s_p_l_a_y, _w, _b_o_r_d_e_r___p_i_x_e_l)
Display *_d_i_s_p_l_a_y;
Window _w;
unsigned long _b_o_r_d_e_r___p_i_x_e_l;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_b_o_r_d_e_r___p_i_x_e_l
Specifies the entry in the colormap.
││__
The _X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r function sets the border of the window
to the pixel value you specify. If you attempt to perform
this on an _I_n_p_u_t_O_n_l_y window, a _B_a_d_M_a_t_c_h error results.
_X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w errors.
To change and repaint the border tile of a given window, use
_X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r_P_i_x_m_a_p.
__
││
XSetWindowBorderPixmap(_d_i_s_p_l_a_y, _w, _b_o_r_d_e_r___p_i_x_m_a_p)
Display *_d_i_s_p_l_a_y;
Window _w;
Pixmap _b_o_r_d_e_r___p_i_x_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_b_o_r_d_e_r___p_i_x_m_a_p
Specifies the border pixmap or _C_o_p_y_F_r_o_m_P_a_r_e_n_t.
││__
The _X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r_P_i_x_m_a_p function sets the border pixmap
of the window to the pixmap you specify. The border pixmap
can be freed immediately if no further explicit references
to it are to be made. If you specify _C_o_p_y_F_r_o_m_P_a_r_e_n_t, a copy
of the parent window's border pixmap is used. If you
attempt to perform this on an _I_n_p_u_t_O_n_l_y window, a _B_a_d_M_a_t_c_h
error results.
_X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r_P_i_x_m_a_p can generate _B_a_d_M_a_t_c_h, _B_a_d_P_i_x_m_a_p, and
_B_a_d_W_i_n_d_o_w errors.
To set the colormap of a given window, use _X_S_e_t_W_i_n_d_o_w_C_o_l_-
_o_r_m_a_p.
7788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetWindowColormap(_d_i_s_p_l_a_y, _w, _c_o_l_o_r_m_a_p)
Display *_d_i_s_p_l_a_y;
Window _w;
Colormap _c_o_l_o_r_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_o_l_o_r_m_a_p Specifies the colormap.
││__
The _X_S_e_t_W_i_n_d_o_w_C_o_l_o_r_m_a_p function sets the specified colormap
of the specified window. The colormap must have the same
visual type as the window, or a _B_a_d_M_a_t_c_h error results.
_X_S_e_t_W_i_n_d_o_w_C_o_l_o_r_m_a_p can generate _B_a_d_C_o_l_o_r, _B_a_d_M_a_t_c_h, and _B_a_d_-
_W_i_n_d_o_w errors.
To define which cursor will be used in a window, use _X_D_e_-
_f_i_n_e_C_u_r_s_o_r.
__
││
XDefineCursor(_d_i_s_p_l_a_y, _w, _c_u_r_s_o_r)
Display *_d_i_s_p_l_a_y;
Window _w;
Cursor _c_u_r_s_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_u_r_s_o_r Specifies the cursor that is to be displayed or
_N_o_n_e.
││__
If a cursor is set, it will be used when the pointer is in
the window. If the cursor is _N_o_n_e, it is equivalent to _X_U_n_-
_d_e_f_i_n_e_C_u_r_s_o_r.
_X_D_e_f_i_n_e_C_u_r_s_o_r can generate _B_a_d_C_u_r_s_o_r and _B_a_d_W_i_n_d_o_w errors.
To undefine the cursor in a given window, use _X_U_n_d_e_f_i_n_e_C_u_r_-
_s_o_r.
7799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XUndefineCursor(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_U_n_d_e_f_i_n_e_C_u_r_s_o_r function undoes the effect of a previous
_X_D_e_f_i_n_e_C_u_r_s_o_r for this window. When the pointer is in the
window, the parent's cursor will now be used. On the root
window, the default cursor is restored.
_X_U_n_d_e_f_i_n_e_C_u_r_s_o_r can generate a _B_a_d_W_i_n_d_o_w error.
8800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 44
WWiinnddooww IInnffoorrmmaattiioonn FFuunnccttiioonnss
After you connect the display to the X server and create a
window, you can use the Xlib window information functions
to:
· Obtain information about a window
· Translate screen coordinates
· Manipulate property lists
· Obtain and change window properties
· Manipulate selections
44..11.. OObbttaaiinniinngg WWiinnddooww IInnffoorrmmaattiioonn
Xlib provides functions that you can use to obtain informa-
tion about the window tree, the window's current attributes,
the window's current geometry, or the current pointer coor-
dinates. Because they are most frequently used by window
managers, these functions all return a status to indicate
whether the window still exists.
To obtain the parent, a list of children, and number of
children for a given window, use _X_Q_u_e_r_y_T_r_e_e.
8811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XQueryTree(_d_i_s_p_l_a_y, _w, _r_o_o_t___r_e_t_u_r_n, _p_a_r_e_n_t___r_e_t_u_r_n, _c_h_i_l_d_r_e_n___r_e_t_u_r_n, _n_c_h_i_l_d_r_e_n___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Window *_r_o_o_t___r_e_t_u_r_n;
Window *_p_a_r_e_n_t___r_e_t_u_r_n;
Window **_c_h_i_l_d_r_e_n___r_e_t_u_r_n;
unsigned int *_n_c_h_i_l_d_r_e_n___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose list of children, root,
parent, and number of children you want to obtain.
_r_o_o_t___r_e_t_u_r_n
Returns the root window.
_p_a_r_e_n_t___r_e_t_u_r_n
Returns the parent window.
_c_h_i_l_d_r_e_n___r_e_t_u_r_n
Returns the list of children.
_n_c_h_i_l_d_r_e_n___r_e_t_u_r_n
Returns the number of children.
││__
The _X_Q_u_e_r_y_T_r_e_e function returns the root ID, the parent win-
dow ID, a pointer to the list of children windows (NULL when
there are no children), and the number of children in the
list for the specified window. The children are listed in
current stacking order, from bottom-most (first) to top-most
(last). _X_Q_u_e_r_y_T_r_e_e returns zero if it fails and nonzero if
it succeeds. To free a non-NULL children list when it is no
longer needed, use _X_F_r_e_e.
_X_Q_u_e_r_y_T_r_e_e can generate a _B_a_d_W_i_n_d_o_w error.
To obtain the current attributes of a given window, use
_X_G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s.
8822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetWindowAttributes(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___a_t_t_r_i_b_u_t_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XWindowAttributes *_w_i_n_d_o_w___a_t_t_r_i_b_u_t_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose current attributes you
want to obtain.
_w_i_n_d_o_w___a_t_t_r_i_b_u_t_e_s___r_e_t_u_r_n
Returns the specified window's attributes in the
_X_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s structure.
││__
The _X_G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s function returns the current
attributes for the specified window to an _X_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s
structure.
__
││
typedef struct {
int x, y; /* location of window */
int width, height; /* width and height of window */
int border_width; /* border width of window */
int depth; /* depth of window */
Visual *visual; /* the associated visual structure */
Window root; /* root of screen containing window */
int class; /* InputOutput, InputOnly*/
int bit_gravity; /* one of the bit gravity values */
int win_gravity; /* one of the window gravity values */
int backing_store; /* NotUseful, WhenMapped, Always */
unsigned long backing_planes;/* planes to be preserved if possible */
unsigned long backing_pixel;/* value to be used when restoring planes */
Bool save_under; /* boolean, should bits under be saved? */
Colormap colormap; /* color map to be associated with window */
Bool map_installed; /* boolean, is color map currently installed*/
int map_state; /* IsUnmapped, IsUnviewable, IsViewable */
long all_event_masks; /* set of events all people have interest in*/
long your_event_mask; /* my event mask */
long do_not_propagate_mask;/* set of events that should not propagate */
Bool override_redirect; /* boolean value for override-redirect */
Screen *screen; /* back pointer to correct screen */
} XWindowAttributes;
││__
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, not
including the border. The border_width member is set to the
window's border width in pixels. The depth member is set to
8833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the depth of the window (that is, bits per pixel for the
object). The visual member is a pointer to the screen's
associated _V_i_s_u_a_l structure. The root member is set to the
root window of the screen containing the window. The class
member is set to the window's class and can be either
_I_n_p_u_t_O_u_t_p_u_t or _I_n_p_u_t_O_n_l_y.
The bit_gravity member is set to the window's bit gravity
and can be one of the following:
_F_o_r_g_e_t_G_r_a_v_i_t_y _E_a_s_t_G_r_a_v_i_t_y
_N_o_r_t_h_W_e_s_t_G_r_a_v_- _S_o_u_t_h_W_e_s_t_G_r_a_v_-
_i_t_y _i_t_y
_N_o_r_t_h_G_r_a_v_i_t_y _S_o_u_t_h_G_r_a_v_i_t_y
_N_o_r_t_h_E_a_s_t_G_r_a_v_- _S_o_u_t_h_E_a_s_t_G_r_a_v_-
_i_t_y _i_t_y
_W_e_s_t_G_r_a_v_i_t_y _S_t_a_t_i_c_G_r_a_v_i_t_y
_C_e_n_t_e_r_G_r_a_v_i_t_y
The win_gravity member is set to the window's window gravity
and can be one of the following:
_U_n_m_a_p_G_r_a_v_i_t_y _E_a_s_t_G_r_a_v_i_t_y
_N_o_r_t_h_W_e_s_t_G_r_a_v_- _S_o_u_t_h_W_e_s_t_G_r_a_v_-
_i_t_y _i_t_y
_N_o_r_t_h_G_r_a_v_i_t_y _S_o_u_t_h_G_r_a_v_i_t_y
_N_o_r_t_h_E_a_s_t_G_r_a_v_- _S_o_u_t_h_E_a_s_t_G_r_a_v_-
_i_t_y _i_t_y
_W_e_s_t_G_r_a_v_i_t_y _S_t_a_t_i_c_G_r_a_v_i_t_y
_C_e_n_t_e_r_G_r_a_v_i_t_y
For additional information on gravity, see section 3.2.3.
The backing_store member is set to indicate how the X server
should maintain the contents of a window and can be _W_h_e_n_-
_M_a_p_p_e_d, _A_l_w_a_y_s, or _N_o_t_U_s_e_f_u_l. 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 back-
ing_stores and during save_unders. The backing_pixel member
is set to indicate what values to use for planes not set in
backing_planes.
The save_under member is set to _T_r_u_e or _F_a_l_s_e. The colormap
member is set to the colormap for the specified window and
can be a colormap ID or _N_o_n_e. The map_installed member is
set to indicate whether the colormap is currently installed
and can be _T_r_u_e or _F_a_l_s_e. The map_state member is set to
indicate the state of the window and can be _I_s_U_n_m_a_p_p_e_d,
_I_s_U_n_v_i_e_w_a_b_l_e, or _I_s_V_i_e_w_a_b_l_e. _I_s_U_n_v_i_e_w_a_b_l_e is used if the
window is mapped but some ancestor is unmapped.
8844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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 masks selected by the querying client. The
do_not_propagate_mask member is set to the bitwise inclusive
OR of the set of events that should not propagate.
The override_redirect member is set to indicate whether this
window overrides structure control facilities and can be
_T_r_u_e or _F_a_l_s_e. Window manager clients should ignore the
window if this member is _T_r_u_e.
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.
_X_G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s can generate _B_a_d_D_r_a_w_a_b_l_e and _B_a_d_W_i_n_d_o_w
errors.
To obtain the current geometry of a given drawable, use
_X_G_e_t_G_e_o_m_e_t_r_y.
8855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetGeometry(_d_i_s_p_l_a_y, _d, _r_o_o_t___r_e_t_u_r_n, _x___r_e_t_u_r_n, _y___r_e_t_u_r_n, _w_i_d_t_h___r_e_t_u_r_n,
_h_e_i_g_h_t___r_e_t_u_r_n, _b_o_r_d_e_r___w_i_d_t_h___r_e_t_u_r_n, _d_e_p_t_h___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Drawable _d;
Window *_r_o_o_t___r_e_t_u_r_n;
int *_x___r_e_t_u_r_n, *_y___r_e_t_u_r_n;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
unsigned int *_b_o_r_d_e_r___w_i_d_t_h___r_e_t_u_r_n;
unsigned int *_d_e_p_t_h___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable, which can be a window or a
pixmap.
_r_o_o_t___r_e_t_u_r_n
Returns the root window.
_x___r_e_t_u_r_n
_y___r_e_t_u_r_n Return the x and y coordinates that define the
location of the drawable. For a window, these
coordinates specify the upper-left outer corner
relative to its parent's origin. For pixmaps,
these coordinates are always zero.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the drawable's dimensions (width and
height). For a window, these dimensions specify
the inside size, not including the border.
_b_o_r_d_e_r___w_i_d_t_h___r_e_t_u_r_n
Returns the border width in pixels. If the draw-
able is a pixmap, it returns zero.
_d_e_p_t_h___r_e_t_u_r_n
Returns the depth of the drawable (bits per pixel
for the object).
││__
The _X_G_e_t_G_e_o_m_e_t_r_y function returns the root window and the
current geometry of the drawable. The geometry of the draw-
able includes the x and y coordinates, width and height,
border width, and depth. These are described in the argu-
ment list. It is legal to pass to this function a window
whose class is _I_n_p_u_t_O_n_l_y.
_X_G_e_t_G_e_o_m_e_t_r_y can generate a _B_a_d_D_r_a_w_a_b_l_e error.
8866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
44..22.. TTrraannssllaattiinngg SSccrreeeenn CCoooorrddiinnaatteess
Applications sometimes need to perform a coordinate trans-
formation from the coordinate space of one window to another
window or need to determine which window the pointing device
is in. _X_T_r_a_n_s_l_a_t_e_C_o_o_r_d_i_n_a_t_e_s and _X_Q_u_e_r_y_P_o_i_n_t_e_r fulfill
these needs (and avoid any race conditions) by asking the X
server to perform these operations.
To translate a coordinate in one window to the coordinate
space of another window, use _X_T_r_a_n_s_l_a_t_e_C_o_o_r_d_i_n_a_t_e_s.
__
││
Bool XTranslateCoordinates(_d_i_s_p_l_a_y, _s_r_c___w, _d_e_s_t___w, _s_r_c___x, _s_r_c___y, _d_e_s_t___x___r_e_t_u_r_n,
_d_e_s_t___y___r_e_t_u_r_n, _c_h_i_l_d___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _s_r_c___w, _d_e_s_t___w;
int _s_r_c___x, _s_r_c___y;
int *_d_e_s_t___x___r_e_t_u_r_n, *_d_e_s_t___y___r_e_t_u_r_n;
Window *_c_h_i_l_d___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_r_c___w Specifies the source window.
_d_e_s_t___w Specifies the destination window.
_s_r_c___x
_s_r_c___y Specify the x and y coordinates within the source
window.
_d_e_s_t___x___r_e_t_u_r_n
_d_e_s_t___y___r_e_t_u_r_n
Return the x and y coordinates within the destina-
tion window.
_c_h_i_l_d___r_e_t_u_r_n
Returns the child if the coordinates are contained
in a mapped child of the destination window.
││__
If _X_T_r_a_n_s_l_a_t_e_C_o_o_r_d_i_n_a_t_e_s returns _T_r_u_e, it takes the src_x
and src_y coordinates relative to the source window's origin
and returns these coordinates to dest_x_return and
dest_y_return relative to the destination window's origin.
If _X_T_r_a_n_s_l_a_t_e_C_o_o_r_d_i_n_a_t_e_s returns _F_a_l_s_e, src_w and dest_w are
on different screens, and dest_x_return and dest_y_return
are zero. If the coordinates are contained in a mapped
child of dest_w, that child is returned to child_return.
Otherwise, child_return is set to _N_o_n_e.
8877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_T_r_a_n_s_l_a_t_e_C_o_o_r_d_i_n_a_t_e_s can generate a _B_a_d_W_i_n_d_o_w error.
To obtain the screen coordinates of the pointer or to deter-
mine the pointer coordinates relative to a specified window,
use _X_Q_u_e_r_y_P_o_i_n_t_e_r.
__
││
Bool XQueryPointer(_d_i_s_p_l_a_y, _w, _r_o_o_t___r_e_t_u_r_n, _c_h_i_l_d___r_e_t_u_r_n, _r_o_o_t___x___r_e_t_u_r_n, _r_o_o_t___y___r_e_t_u_r_n,
_w_i_n___x___r_e_t_u_r_n, _w_i_n___y___r_e_t_u_r_n, _m_a_s_k___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Window *_r_o_o_t___r_e_t_u_r_n, *_c_h_i_l_d___r_e_t_u_r_n;
int *_r_o_o_t___x___r_e_t_u_r_n, *_r_o_o_t___y___r_e_t_u_r_n;
int *_w_i_n___x___r_e_t_u_r_n, *_w_i_n___y___r_e_t_u_r_n;
unsigned int *_m_a_s_k___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_r_o_o_t___r_e_t_u_r_n
Returns the root window that the pointer is in.
_c_h_i_l_d___r_e_t_u_r_n
Returns the child window that the pointer is
located in, if any.
_r_o_o_t___x___r_e_t_u_r_n
_r_o_o_t___y___r_e_t_u_r_n
Return the pointer coordinates relative to the
root window's origin.
_w_i_n___x___r_e_t_u_r_n
_w_i_n___y___r_e_t_u_r_n
Return the pointer coordinates relative to the
specified window.
_m_a_s_k___r_e_t_u_r_n
Returns the current state of the modifier keys and
pointer buttons.
││__
The _X_Q_u_e_r_y_P_o_i_n_t_e_r function returns the root window the
pointer is logically on and the pointer coordinates relative
to the root window's origin. If _X_Q_u_e_r_y_P_o_i_n_t_e_r returns
_F_a_l_s_e, the pointer is not on the same screen as the speci-
fied window, and _X_Q_u_e_r_y_P_o_i_n_t_e_r returns _N_o_n_e to child_return
and zero to win_x_return and win_y_return. If _X_Q_u_e_r_y_P_o_i_n_t_e_r
returns _T_r_u_e, the pointer coordinates returned to
win_x_return and win_y_return are relative to the origin of
the specified window. In this case, _X_Q_u_e_r_y_P_o_i_n_t_e_r returns
the child that contains the pointer, if any, or else _N_o_n_e to
8888
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
child_return.
_X_Q_u_e_r_y_P_o_i_n_t_e_r returns the current logical state of the key-
board buttons and the modifier keys in mask_return. It sets
mask_return to the bitwise inclusive OR of one or more of
the button or modifier key bitmasks to match the current
state of the mouse buttons and the modifier keys.
Note that the logical state of a device (as seen through
Xlib) may lag the physical state if device event processing
is frozen (see section 12.1).
_X_Q_u_e_r_y_P_o_i_n_t_e_r can generate a _B_a_d_W_i_n_d_o_w error.
44..33.. PPrrooppeerrttiieess aanndd AAttoommss
A property is a collection of named, typed data. The window
system has a set of predefined properties (for example, the
name of a window, size hints, and so on), and users can
define any other arbitrary information and associate it with
windows. Each property has a name, which is an ISO Latin-1
string. For each named property, a unique identifier (atom)
is associated with it. A property also has a type, for
example, string or integer. These types are also indicated
using atoms, so arbitrary new types can be defined. Data of
only one type may be associated with a single property name.
Clients can store and retrieve properties associated with
windows. For efficiency reasons, an atom is used rather
than a character string. _X_I_n_t_e_r_n_A_t_o_m can be used to obtain
the atom for property names.
A property is also stored in one of several possible for-
mats. The X server can store the information as 8-bit quan-
tities, 16-bit quantities, or 32-bit quantities. This per-
mits the X server to present the data in the byte order that
the client expects.
Note
If you define further properties of complex type,
you must encode and decode them yourself. These
functions must be carefully written if they are to
be portable. For further information about how to
write a library extension, see appendix C.
The type of a property is defined by an atom, which allows
for arbitrary extension in this type scheme.
Certain property names are predefined in the server for com-
monly used functions. The atoms for these properties are
defined in <_X_1_1_/_X_a_t_o_m_._h>. To avoid name clashes with user
symbols, the _#_d_e_f_i_n_e name for each atom has the XA_ prefix.
For an explanation of the functions that let you get and set
much of the information stored in these predefined
8899
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
properties, see chapter 14.
The core protocol imposes no semantics on these property
names, but semantics are specified in other X Consortium
standards, such as the _I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_-
_t_i_o_n_s _M_a_n_u_a_l and the _X _L_o_g_i_c_a_l _F_o_n_t _D_e_s_c_r_i_p_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s.
You can use properties to communicate other information
between applications. The functions described in this sec-
tion let you define new properties and get the unique atom
IDs in your applications.
Although any particular atom can have some client interpre-
tation within each of the name spaces, atoms occur in five
distinct name spaces within the protocol:
· Selections
· Property names
· Property types
· Font properties
· Type of a _C_l_i_e_n_t_M_e_s_s_a_g_e event (none are built into the
X server)
The built-in selection property names are:
PRIMARY
SECONDARY
The built-in property names are:
CUT_BUFFER0 RESOURCE_MANAGER
CUT_BUFFER1 WM_CLASS
CUT_BUFFER2 WM_CLIENT_MACHINE
CUT_BUFFER3 WM_COLORMAP_WINDOWS
CUT_BUFFER4 WM_COMMAND
CUT_BUFFER5 WM_HINTS
CUT_BUFFER6 WM_ICON_NAME
CUT_BUFFER7 WM_ICON_SIZE
RGB_BEST_MAP WM_NAME
RGB_BLUE_MAP WM_NORMAL_HINTS
RGB_DEFAULT_MAP WM_PROTOCOLS
RGB_GRAY_MAP WM_STATE
RGB_GREEN_MAP WM_TRANSIENT_FOR
RGB_RED_MAP WM_ZOOM_HINTS
9900
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The built-in property types are:
ARC POINT
ATOM RGB_COLOR_MAP
BITMAP RECTANGLE
CARDINAL STRING
COLORMAP VISUALID
CURSOR WINDOW
DRAWABLE WM_HINTS
FONT WM_SIZE_HINTS
INTEGER
PIXMAP
The built-in font property names are:
MIN_SPACE STRIKEOUT_DESCENT
NORM_SPACE STRIKEOUT_ASCENT
MAX_SPACE ITALIC_ANGLE
END_SPACE X_HEIGHT
SUPERSCRIPT_X QUAD_WIDTH
SUPERSCRIPT_Y WEIGHT
SUBSCRIPT_X POINT_SIZE
SUBSCRIPT_Y RESOLUTION
UNDERLINE_POSITION COPYRIGHT
UNDERLINE_THICKNESS NOTICE
FONT_NAME FAMILY_NAME
FULL_NAME CAP_HEIGHT
For further information about font properties, see section
8.5.
To return an atom for a given name, use _X_I_n_t_e_r_n_A_t_o_m.
9911
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Atom XInternAtom(_d_i_s_p_l_a_y, _a_t_o_m___n_a_m_e, _o_n_l_y___i_f___e_x_i_s_t_s)
Display *_d_i_s_p_l_a_y;
char *_a_t_o_m___n_a_m_e;
Bool _o_n_l_y___i_f___e_x_i_s_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_a_t_o_m___n_a_m_e Specifies the name associated with the atom you
want returned.
_o_n_l_y___i_f___e_x_i_s_t_s
Specifies a Boolean value that indicates whether
the atom must be created.
││__
The _X_I_n_t_e_r_n_A_t_o_m function returns the atom identifier associ-
ated with the specified atom_name string. If only_if_exists
is _F_a_l_s_e, the atom is created if it does not exist. There-
fore, _X_I_n_t_e_r_n_A_t_o_m can return _N_o_n_e. If the atom name is not
in the Host Portable Character Encoding, the result is
implementation-dependent. Uppercase and lowercase matter;
the strings ``thing'', ``Thing'', and ``thinG'' all desig-
nate different atoms. The atom will remain defined even
after the client's connection closes. It will become unde-
fined only when the last connection to the X server closes.
_X_I_n_t_e_r_n_A_t_o_m can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
To return atoms for an array of names, use _X_I_n_t_e_r_n_A_t_o_m_s.
9922
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XInternAtoms(_d_i_s_p_l_a_y, _n_a_m_e_s, _c_o_u_n_t, _o_n_l_y___i_f___e_x_i_s_t_s, _a_t_o_m_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char **_n_a_m_e_s;
int _c_o_u_n_t;
Bool _o_n_l_y___i_f___e_x_i_s_t_s;
Atom *_a_t_o_m_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_a_m_e_s Specifies the array of atom names.
_c_o_u_n_t Specifies the number of atom names in the array.
_o_n_l_y___i_f___e_x_i_s_t_s
Specifies a Boolean value that indicates whether
the atom must be created.
_a_t_o_m_s___r_e_t_u_r_n
Returns the atoms.
││__
The _X_I_n_t_e_r_n_A_t_o_m_s function returns the atom identifiers asso-
ciated with the specified names. The atoms are stored in
the atoms_return array supplied by the caller. Calling this
function is equivalent to calling _X_I_n_t_e_r_n_A_t_o_m for each of
the names in turn with the specified value of
only_if_exists, but this function minimizes the number of
round-trip protocol exchanges between the client and the X
server.
This function returns a nonzero status if atoms are returned
for all of the names; otherwise, it returns zero.
_X_I_n_t_e_r_n_A_t_o_m_s can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
To return a name for a given atom identifier, use _X_G_e_t_A_t_o_m_-
_N_a_m_e.
__
││
char *XGetAtomName(_d_i_s_p_l_a_y, _a_t_o_m)
Display *_d_i_s_p_l_a_y;
Atom _a_t_o_m;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_a_t_o_m Specifies the atom for the property name you want
returned.
││__
The _X_G_e_t_A_t_o_m_N_a_m_e function returns the name associated with
9933
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the specified atom. If the data returned by the server is
in the Latin Portable Character Encoding, then the returned
string is in the Host Portable Character Encoding. Other-
wise, the result is implementation-dependent. To free the
resulting string, call _X_F_r_e_e.
_X_G_e_t_A_t_o_m_N_a_m_e can generate a _B_a_d_A_t_o_m error.
To return the names for an array of atom identifiers, use
_X_G_e_t_A_t_o_m_N_a_m_e_s.
__
││
Status XGetAtomNames(_d_i_s_p_l_a_y, _a_t_o_m_s, _c_o_u_n_t, _n_a_m_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Atom *_a_t_o_m_s;
int _c_o_u_n_t;
char **_n_a_m_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_a_t_o_m_s Specifies the array of atoms.
_c_o_u_n_t Specifies the number of atoms in the array.
_n_a_m_e_s___r_e_t_u_r_n
Returns the atom names.
││__
The _X_G_e_t_A_t_o_m_N_a_m_e_s function returns the names associated with
the specified atoms. The names are stored in the
names_return array supplied by the caller. Calling this
function is equivalent to calling _X_G_e_t_A_t_o_m_N_a_m_e for each of
the atoms in turn, but this function minimizes the number of
round-trip protocol exchanges between the client and the X
server.
This function returns a nonzero status if names are returned
for all of the atoms; otherwise, it returns zero.
_X_G_e_t_A_t_o_m_N_a_m_e_s can generate a _B_a_d_A_t_o_m error.
44..44.. OObbttaaiinniinngg aanndd CChhaannggiinngg WWiinnddooww PPrrooppeerrttiieess
You can attach a property list to every window. Each prop-
erty has a name, a type, and a value (see section 4.3). The
value is an array of 8-bit, 16-bit, or 32-bit quantities,
whose interpretation is left to the clients. The type _c_h_a_r
is used to represent 8-bit quantities, the type _s_h_o_r_t is
used to represent 16-bit quantities, and the type _l_o_n_g is
used to represent 32-bit quantities.
9944
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Xlib provides functions that you can use to obtain, change,
update, or interchange window properties. In addition, Xlib
provides other utility functions for inter-client communica-
tion (see chapter 14).
To obtain the type, format, and value of a property of a
given window, use _X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y.
9955
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XGetWindowProperty(_d_i_s_p_l_a_y, _w, _p_r_o_p_e_r_t_y, _l_o_n_g___o_f_f_s_e_t, _l_o_n_g___l_e_n_g_t_h, _d_e_l_e_t_e, _r_e_q___t_y_p_e,
_a_c_t_u_a_l___t_y_p_e___r_e_t_u_r_n, _a_c_t_u_a_l___f_o_r_m_a_t___r_e_t_u_r_n, _n_i_t_e_m_s___r_e_t_u_r_n, _b_y_t_e_s___a_f_t_e_r___r_e_t_u_r_n,
_p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Atom _p_r_o_p_e_r_t_y;
long _l_o_n_g___o_f_f_s_e_t, _l_o_n_g___l_e_n_g_t_h;
Bool _d_e_l_e_t_e;
Atom _r_e_q___t_y_p_e;
Atom *_a_c_t_u_a_l___t_y_p_e___r_e_t_u_r_n;
int *_a_c_t_u_a_l___f_o_r_m_a_t___r_e_t_u_r_n;
unsigned long *_n_i_t_e_m_s___r_e_t_u_r_n;
unsigned long *_b_y_t_e_s___a_f_t_e_r___r_e_t_u_r_n;
unsigned char **_p_r_o_p___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose property you want to
obtain.
_p_r_o_p_e_r_t_y Specifies the property name.
_l_o_n_g___o_f_f_s_e_t
Specifies the offset in the specified property (in
32-bit quantities) where the data is to be
retrieved.
_l_o_n_g___l_e_n_g_t_h
Specifies the length in 32-bit multiples of the
data to be retrieved.
_d_e_l_e_t_e Specifies a Boolean value that determines whether
the property is deleted.
_r_e_q___t_y_p_e Specifies the atom identifier associated with the
property type or _A_n_y_P_r_o_p_e_r_t_y_T_y_p_e.
_a_c_t_u_a_l___t_y_p_e___r_e_t_u_r_n
Returns the atom identifier that defines the
actual type of the property.
_a_c_t_u_a_l___f_o_r_m_a_t___r_e_t_u_r_n
Returns the actual format of the property.
_n_i_t_e_m_s___r_e_t_u_r_n
Returns the actual number of 8-bit, 16-bit, or
32-bit items stored in the prop_return data.
_b_y_t_e_s___a_f_t_e_r___r_e_t_u_r_n
Returns the number of bytes remaining to be read
in the property if a partial read was performed.
9966
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_p_r_o_p___r_e_t_u_r_n
Returns the data in the specified format.
││__
The _X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y function returns the actual type of
the property; the actual format of the property; the number
of 8-bit, 16-bit, or 32-bit items transferred; the number of
bytes remaining to be read in the property; and a pointer to
the data actually returned. _X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y sets the
return arguments as follows:
· If the specified property does not exist for the speci-
fied window, _X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y returns _N_o_n_e to
actual_type_return and the value zero to actual_for-
mat_return and bytes_after_return. The nitems_return
argument is empty. In this case, the delete argument
is ignored.
· If the specified property exists but its type does not
match the specified type, _X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y returns
the actual property type to actual_type_return, the
actual property format (never zero) to actual_for-
mat_return, and the property length in bytes (even if
the actual_format_return is 16 or 32) to
bytes_after_return. It also ignores the delete argu-
ment. The nitems_return argument is empty.
· If the specified property exists and either you assign
_A_n_y_P_r_o_p_e_r_t_y_T_y_p_e to the req_type argument or the speci-
fied type matches the actual property type, _X_G_e_t_W_i_n_d_o_w_-
_P_r_o_p_e_r_t_y 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
defining the following values:
N = actual length of the stored property in bytes
(even if the format is 16 or 32)
I = 4 * long_offset
T = N - I
L = MINIMUM(T, 4 * long_length)
A = N - (I + L)
The returned value starts at byte index I in the prop-
erty (indexing from zero), and its length in bytes is
L. If the value for long_offset causes L to be nega-
tive, a _B_a_d_V_a_l_u_e error results. The value of
bytes_after_return is A, giving the number of trailing
unread bytes in the stored property.
If the returned format is 8, the returned data is repre-
sented as a _c_h_a_r array. If the returned format is 16, the
returned data is represented as a _s_h_o_r_t array and should be
cast to that type to obtain the elements. If the returned
9977
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
format is 32, the returned data is represented as a _l_o_n_g
array and should be cast to that type to obtain the ele-
ments.
_X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y 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 charac-
ters do not have to be copied into yet another string before
use.
If delete is _T_r_u_e and bytes_after_return is zero, _X_G_e_t_W_i_n_-
_d_o_w_P_r_o_p_e_r_t_y deletes the property from the window and gener-
ates a _P_r_o_p_e_r_t_y_N_o_t_i_f_y event on the window.
The function returns _S_u_c_c_e_s_s if it executes successfully.
To free the resulting data, use _X_F_r_e_e.
_X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y can generate _B_a_d_A_t_o_m, _B_a_d_V_a_l_u_e, and _B_a_d_-
_W_i_n_d_o_w errors.
To obtain a given window's property list, use _X_L_i_s_t_P_r_o_p_e_r_-
_t_i_e_s.
__
││
Atom *XListProperties(_d_i_s_p_l_a_y, _w, _n_u_m___p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
int *_n_u_m___p_r_o_p___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose property list you want
to obtain.
_n_u_m___p_r_o_p___r_e_t_u_r_n
Returns the length of the properties array.
││__
The _X_L_i_s_t_P_r_o_p_e_r_t_i_e_s 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 _X_F_r_e_e.
_X_L_i_s_t_P_r_o_p_e_r_t_i_e_s can generate a _B_a_d_W_i_n_d_o_w error.
To change a property of a given window, use _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y.
9988
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XChangeProperty(_d_i_s_p_l_a_y, _w, _p_r_o_p_e_r_t_y, _t_y_p_e, _f_o_r_m_a_t, _m_o_d_e, _d_a_t_a, _n_e_l_e_m_e_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
Atom _p_r_o_p_e_r_t_y, _t_y_p_e;
int _f_o_r_m_a_t;
int _m_o_d_e;
unsigned char *_d_a_t_a;
int _n_e_l_e_m_e_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose property you want to
change.
_p_r_o_p_e_r_t_y Specifies the property name.
_t_y_p_e 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 _X_G_e_t_W_i_n_-
_d_o_w_P_r_o_p_e_r_t_y.
_f_o_r_m_a_t Specifies whether the data should be viewed as a
list of 8-bit, 16-bit, or 32-bit quantities. Pos-
sible values are 8, 16, and 32. 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
_X_C_h_a_n_g_e_P_r_o_p_e_r_t_y.
_m_o_d_e Specifies the mode of the operation. You can pass
_P_r_o_p_M_o_d_e_R_e_p_l_a_c_e, _P_r_o_p_M_o_d_e_P_r_e_p_e_n_d, or _P_r_o_p_M_o_d_e_A_p_-
_p_e_n_d.
_d_a_t_a Specifies the property data.
_n_e_l_e_m_e_n_t_s Specifies the number of elements of the specified
data format.
││__
The _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y function alters the property for the
specified window and causes the X server to generate a _P_r_o_p_-
_e_r_t_y_N_o_t_i_f_y event on that window. _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y performs
the following:
· If mode is _P_r_o_p_M_o_d_e_R_e_p_l_a_c_e, _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y discards
the previous property value and stores the new data.
· If mode is _P_r_o_p_M_o_d_e_P_r_e_p_e_n_d or _P_r_o_p_M_o_d_e_A_p_p_e_n_d, _X_C_h_a_n_g_e_-
_P_r_o_p_e_r_t_y inserts the specified data before the begin-
ning of the existing data or onto the end of the exist-
ing data, respectively. The type and format must match
9999
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the existing property value, or a _B_a_d_M_a_t_c_h error
results. If the property is undefined, it is treated
as defined with the correct type and format with zero-
length data.
If the specified format is 8, the property data must be a
_c_h_a_r array. If the specified format is 16, the property
data must be a _s_h_o_r_t array. If the specified format is 32,
the property data must be a _l_o_n_g array.
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. 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 _B_a_d_A_l_l_o_c error results.)
_X_C_h_a_n_g_e_P_r_o_p_e_r_t_y can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, _B_a_d_M_a_t_c_h,
_B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w errors.
To rotate a window's property list, use _X_R_o_t_a_t_e_W_i_n_d_o_w_P_r_o_p_e_r_-
_t_i_e_s.
__
││
XRotateWindowProperties(_d_i_s_p_l_a_y, _w, _p_r_o_p_e_r_t_i_e_s, _n_u_m___p_r_o_p, _n_p_o_s_i_t_i_o_n_s)
Display *_d_i_s_p_l_a_y;
Window _w;
Atom _p_r_o_p_e_r_t_i_e_s[];
int _n_u_m___p_r_o_p;
int _n_p_o_s_i_t_i_o_n_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_p_r_o_p_e_r_t_i_e_s
Specifies the array of properties that are to be
rotated.
_n_u_m___p_r_o_p Specifies the length of the properties array.
_n_p_o_s_i_t_i_o_n_s
Specifies the rotation amount.
││__
The _X_R_o_t_a_t_e_W_i_n_d_o_w_P_r_o_p_e_r_t_i_e_s function allows you to rotate
properties on a window and causes the X server to generate
_P_r_o_p_e_r_t_y_N_o_t_i_f_y events. If the property names in the proper-
ties array are viewed as being numbered starting from zero
110000
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
and if there are num_prop property names in the list, 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, left for negative nposi-
tions). If npositions mod N is nonzero, the X server gener-
ates a _P_r_o_p_e_r_t_y_N_o_t_i_f_y 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 name is
defined for the window, a _B_a_d_M_a_t_c_h error results. If a
_B_a_d_A_t_o_m or _B_a_d_M_a_t_c_h error results, no properties are
changed.
_X_R_o_t_a_t_e_W_i_n_d_o_w_P_r_o_p_e_r_t_i_e_s can generate _B_a_d_A_t_o_m, _B_a_d_M_a_t_c_h, and
_B_a_d_W_i_n_d_o_w errors.
To delete a property on a given window, use _X_D_e_l_e_t_e_P_r_o_p_e_r_t_y.
__
││
XDeleteProperty(_d_i_s_p_l_a_y, _w, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose property you want to
delete.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_D_e_l_e_t_e_P_r_o_p_e_r_t_y function deletes the specified property
only if the property was defined on the specified window and
causes the X server to generate a _P_r_o_p_e_r_t_y_N_o_t_i_f_y event on
the window unless the property does not exist.
_X_D_e_l_e_t_e_P_r_o_p_e_r_t_y can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
44..55.. SSeelleeccttiioonnss
Selections are one method used by applications to exchange
data. By using the property mechanism, applications can
exchange data of arbitrary types and can negotiate the type
of the data. A selection can be thought of as an indirect
property with a dynamic type. That is, rather than having
the property stored in the X server, the property is main-
tained by some client (the owner). A selection is global in
nature (considered to belong to the user but be maintained
by clients) rather than being private to a particular window
subhierarchy or a particular set of clients.
110011
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Xlib provides functions that you can use to set, get, or
request conversion of selections. This allows applications
to implement the notion of current selection, which requires
that notification be sent to applications when they no
longer own the selection. Applications that support selec-
tion often highlight the current selection and so must be
informed when another application has acquired the selection
so that they can unhighlight the selection.
When a client asks for the contents of a selection, it spec-
ifies a selection target type. This target type can be used
to control the transmitted representation of the contents.
For example, if the selection is ``the last thing the user
clicked on'' and that is currently an image, then the target
type might specify whether the contents of the image should
be sent in XY format or Z format.
The target type can also be used to control the class of
contents transmitted, for example, asking for the ``looks''
(fonts, line spacing, indentation, and so forth) of a para-
graph selection, not the text of the paragraph. The target
type can also be used for other purposes. The protocol does
not constrain the semantics.
To set the selection owner, use _X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r.
__
││
XSetSelectionOwner(_d_i_s_p_l_a_y, _s_e_l_e_c_t_i_o_n, _o_w_n_e_r, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Atom _s_e_l_e_c_t_i_o_n;
Window _o_w_n_e_r;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_e_l_e_c_t_i_o_n Specifies the selection atom.
_o_w_n_e_r Specifies the owner of the specified selection
atom. You can pass a window or _N_o_n_e.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r function changes the owner and last-
change time for the specified selection and has no effect if
the specified time is earlier than the current last-change
time of the specified selection or is later than the current
X server time. Otherwise, the last-change time is set to
the specified time, with _C_u_r_r_e_n_t_T_i_m_e replaced by the current
server time. If the owner window is specified as _N_o_n_e, then
the owner of the selection becomes _N_o_n_e (that is, no owner).
110022
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Otherwise, the owner of the selection becomes the client
executing the request.
If the new owner (whether a client or _N_o_n_e) is not the same
as the current owner of the selection and the current owner
is not _N_o_n_e, the current owner is sent a _S_e_l_e_c_t_i_o_n_C_l_e_a_r
event. If the client that is the owner of a selection is
later terminated (that is, its connection is closed) or if
the owner window it has specified in the request is later
destroyed, the owner of the selection automatically reverts
to _N_o_n_e, but the last-change time is not affected. The
selection atom is uninterpreted by the X server. _X_G_e_t_S_e_l_e_c_-
_t_i_o_n_O_w_n_e_r returns the owner window, which is reported in
_S_e_l_e_c_t_i_o_n_R_e_q_u_e_s_t and _S_e_l_e_c_t_i_o_n_C_l_e_a_r events. Selections are
global to the X server.
_X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w
errors.
To return the selection owner, use _X_G_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r.
__
││
Window XGetSelectionOwner(_d_i_s_p_l_a_y, _s_e_l_e_c_t_i_o_n)
Display *_d_i_s_p_l_a_y;
Atom _s_e_l_e_c_t_i_o_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_e_l_e_c_t_i_o_n Specifies the selection atom whose owner you want
returned.
││__
The _X_G_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r function returns the window ID asso-
ciated with the window that currently owns the specified
selection. If no selection was specified, the function
returns the constant _N_o_n_e. If _N_o_n_e is returned, there is no
owner for the selection.
_X_G_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r can generate a _B_a_d_A_t_o_m error.
To request conversion of a selection, use _X_C_o_n_v_e_r_t_S_e_l_e_c_t_i_o_n.
110033
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XConvertSelection(_d_i_s_p_l_a_y, _s_e_l_e_c_t_i_o_n, _t_a_r_g_e_t, _p_r_o_p_e_r_t_y, _r_e_q_u_e_s_t_o_r, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Atom _s_e_l_e_c_t_i_o_n, _t_a_r_g_e_t;
Atom _p_r_o_p_e_r_t_y;
Window _r_e_q_u_e_s_t_o_r;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_e_l_e_c_t_i_o_n Specifies the selection atom.
_t_a_r_g_e_t Specifies the target atom.
_p_r_o_p_e_r_t_y Specifies the property name. You also can pass
_N_o_n_e.
_r_e_q_u_e_s_t_o_r Specifies the requestor.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
_X_C_o_n_v_e_r_t_S_e_l_e_c_t_i_o_n requests that the specified selection be
converted to the specified target type:
· If the specified selection has an owner, the X server
sends a _S_e_l_e_c_t_i_o_n_R_e_q_u_e_s_t event to that owner.
· If no owner for the specified selection exists, the X
server generates a _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y event to the
requestor with property _N_o_n_e.
The arguments are passed on unchanged in either of the
events. There are two predefined selection atoms: PRIMARY
and SECONDARY.
_X_C_o_n_v_e_r_t_S_e_l_e_c_t_i_o_n can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
110044
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 55
PPiixxmmaapp aanndd CCuurrssoorr FFuunnccttiioonnss
Once you have connected to an X server, you can use the Xlib
functions to:
· Create and free pixmaps
· Create, recolor, and free cursors
55..11.. CCrreeaattiinngg aanndd FFrreeeeiinngg PPiixxmmaappss
Pixmaps can only be used on the screen on which they were
created. Pixmaps are off-screen resources that are used for
various operations, such as defining cursors as tiling pat-
terns or as the source for certain raster operations. Most
graphics requests can operate either on a window or on a
pixmap. A bitmap is a single bit-plane pixmap.
To create a pixmap of a given size, use _X_C_r_e_a_t_e_P_i_x_m_a_p.
__
││
Pixmap XCreatePixmap(_d_i_s_p_l_a_y, _d, _w_i_d_t_h, _h_e_i_g_h_t, _d_e_p_t_h)
Display *_d_i_s_p_l_a_y;
Drawable _d;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int _d_e_p_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies which screen the pixmap is created on.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which define the
dimensions of the pixmap.
_d_e_p_t_h Specifies the depth of the pixmap.
││__
The _X_C_r_e_a_t_e_P_i_x_m_a_p 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 _I_n_p_u_t_O_n_l_y window to
the drawable argument. The width and height arguments must
be nonzero, or a _B_a_d_V_a_l_u_e error results. The depth argument
must be one of the depths supported by the screen of the
specified drawable, or a _B_a_d_V_a_l_u_e error results.
110055
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The server uses the specified drawable to determine on which
screen to create the pixmap. The pixmap can be used only on
this screen and only with other drawables of the same depth
(see _X_C_o_p_y_P_l_a_n_e for an exception to this rule). The initial
contents of the pixmap are undefined.
_X_C_r_e_a_t_e_P_i_x_m_a_p can generate _B_a_d_A_l_l_o_c, _B_a_d_D_r_a_w_a_b_l_e, and _B_a_d_-
_V_a_l_u_e errors.
To free all storage associated with a specified pixmap, use
_X_F_r_e_e_P_i_x_m_a_p.
__
││
XFreePixmap(_d_i_s_p_l_a_y, _p_i_x_m_a_p)
Display *_d_i_s_p_l_a_y;
Pixmap _p_i_x_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_i_x_m_a_p Specifies the pixmap.
││__
The _X_F_r_e_e_P_i_x_m_a_p function first deletes the association
between the pixmap ID and the pixmap. Then, the X server
frees the pixmap storage when there are no references to it.
The pixmap should never be referenced again.
_X_F_r_e_e_P_i_x_m_a_p can generate a _B_a_d_P_i_x_m_a_p error.
55..22.. CCrreeaattiinngg,, RReeccoolloorriinngg,, aanndd FFrreeeeiinngg CCuurrssoorrss
Each window can have a different cursor defined for it.
Whenever the pointer is in a visible window, it is set to
the cursor defined for that window. If no cursor was
defined for that window, the cursor is the one defined for
the parent window.
From X's perspective, a cursor consists of a cursor source,
mask, colors, and a hotspot. The mask pixmap determines the
shape of the cursor and must be a depth of one. The source
pixmap must have a depth of one, and the colors determine
the colors of the source. The hotspot defines the point on
the cursor that is reported when a pointer event occurs.
There may be limitations imposed by the hardware on cursors
as to size and whether a mask is implemented.
_X_Q_u_e_r_y_B_e_s_t_C_u_r_s_o_r can be used to find out what sizes are pos-
sible. There is a standard font for creating cursors, but
Xlib provides functions that you can use to create cursors
from an arbitrary font or from bitmaps.
To create a cursor from the standard cursor font, use
110066
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_C_r_e_a_t_e_F_o_n_t_C_u_r_s_o_r.
__
││
#include <X11/cursorfont.h>
Cursor XCreateFontCursor(_d_i_s_p_l_a_y, _s_h_a_p_e)
Display *_d_i_s_p_l_a_y;
unsigned int _s_h_a_p_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_h_a_p_e Specifies the shape of the cursor.
││__
X provides a set of standard cursor shapes in a special font
named cursor. Applications are encouraged to use this
interface for their cursors because the font can be cus-
tomized for the individual display type. The shape argument
specifies which glyph of the standard fonts to use.
The hotspot comes from the information stored in the cursor
font. The initial colors of a cursor are a black foreground
and a white background (see _X_R_e_c_o_l_o_r_C_u_r_s_o_r). For further
information about cursor shapes, see appendix B.
_X_C_r_e_a_t_e_F_o_n_t_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
To create a cursor from font glyphs, use _X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r.
110077
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Cursor XCreateGlyphCursor(_d_i_s_p_l_a_y, _s_o_u_r_c_e___f_o_n_t, _m_a_s_k___f_o_n_t, _s_o_u_r_c_e___c_h_a_r, _m_a_s_k___c_h_a_r,
_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r, _b_a_c_k_g_r_o_u_n_d___c_o_l_o_r)
Display *_d_i_s_p_l_a_y;
Font _s_o_u_r_c_e___f_o_n_t, _m_a_s_k___f_o_n_t;
unsigned int _s_o_u_r_c_e___c_h_a_r, _m_a_s_k___c_h_a_r;
XColor *_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r;
XColor *_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_o_u_r_c_e___f_o_n_t
Specifies the font for the source glyph.
_m_a_s_k___f_o_n_t Specifies the font for the mask glyph or _N_o_n_e.
_s_o_u_r_c_e___c_h_a_r
Specifies the character glyph for the source.
_m_a_s_k___c_h_a_r Specifies the glyph character for the mask.
_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r
Specifies the RGB values for the foreground of the
source.
_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r
Specifies the RGB values for the background of the
source.
││__
The _X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r function is similar to _X_C_r_e_-
_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r 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, or a _B_a_d_V_a_l_u_e error
results. If mask_font is given, mask_char must be a defined
glyph in mask_font, or a _B_a_d_V_a_l_u_e 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, and
there is no restriction on the placement of the hotspot rel-
ative to the bounding boxes. If no mask_char is given, all
pixels of the source are displayed. You can free the fonts
immediately by calling _X_F_r_e_e_F_o_n_t if no further explicit ref-
erences to them are to be made.
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 least significant byte.
_X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c, _B_a_d_F_o_n_t, and _B_a_d_-
_V_a_l_u_e errors.
110088
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To create a cursor from two bitmaps, use _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_-
_s_o_r.
__
││
Cursor XCreatePixmapCursor(_d_i_s_p_l_a_y, _s_o_u_r_c_e, _m_a_s_k, _f_o_r_e_g_r_o_u_n_d___c_o_l_o_r, _b_a_c_k_g_r_o_u_n_d___c_o_l_o_r, _x, _y)
Display *_d_i_s_p_l_a_y;
Pixmap _s_o_u_r_c_e;
Pixmap _m_a_s_k;
XColor *_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r;
XColor *_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r;
unsigned int _x, _y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_o_u_r_c_e Specifies the shape of the source cursor.
_m_a_s_k Specifies the cursor's source bits to be displayed
or _N_o_n_e.
_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r
Specifies the RGB values for the foreground of the
source.
_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r
Specifies the RGB values for the background of the
source.
_x
_y Specify the x and y coordinates, which indicate
the hotspot relative to the source's origin.
││__
The _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r function creates a cursor and
returns the cursor ID associated with it. The foreground
and background RGB values must be specified using fore-
ground_color and background_color, even if the X server only
has a _S_t_a_t_i_c_G_r_a_y or _G_r_a_y_S_c_a_l_e screen. The foreground color
is used for the pixels set to 1 in the source, and the back-
ground color is used for the pixels set to 0. Both source
and mask, if specified, must have depth one (or a _B_a_d_M_a_t_c_h
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 pix-
els set to 0 define which pixels are ignored. 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
source argument, or a _B_a_d_M_a_t_c_h error results. The hotspot
must be a point within the source, or a _B_a_d_M_a_t_c_h error
results.
The components of the cursor can be transformed arbitrarily
to meet display limitations. The pixmaps can be freed imme-
diately if no further explicit references to them are to be
110099
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
made. Subsequent drawing in the source or mask pixmap has
an undefined effect on the cursor. The X server might or
might not make a copy of the pixmap.
_X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c and _B_a_d_P_i_x_m_a_p
errors.
To determine useful cursor sizes, use _X_Q_u_e_r_y_B_e_s_t_C_u_r_s_o_r.
__
││
Status XQueryBestCursor(_d_i_s_p_l_a_y, _d, _w_i_d_t_h, _h_e_i_g_h_t, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Drawable _d;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable, which indicates the
screen.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height of the cursor that
you want the size information for.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the best width and height that is closest
to the specified width and height.
││__
Some displays allow larger cursors than other displays. The
_X_Q_u_e_r_y_B_e_s_t_C_u_r_s_o_r function provides a way to find out what
size cursors are actually possible on the display. It
returns the largest size that can be displayed. Applica-
tions should be prepared to use smaller cursors on displays
that cannot support large ones.
_X_Q_u_e_r_y_B_e_s_t_C_u_r_s_o_r can generate a _B_a_d_D_r_a_w_a_b_l_e error.
To change the color of a given cursor, use _X_R_e_c_o_l_o_r_C_u_r_s_o_r.
111100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XRecolorCursor(_d_i_s_p_l_a_y, _c_u_r_s_o_r, _f_o_r_e_g_r_o_u_n_d___c_o_l_o_r, _b_a_c_k_g_r_o_u_n_d___c_o_l_o_r)
Display *_d_i_s_p_l_a_y;
Cursor _c_u_r_s_o_r;
XColor *_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r, *_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_u_r_s_o_r Specifies the cursor.
_f_o_r_e_g_r_o_u_n_d___c_o_l_o_r
Specifies the RGB values for the foreground of the
source.
_b_a_c_k_g_r_o_u_n_d___c_o_l_o_r
Specifies the RGB values for the background of the
source.
││__
The _X_R_e_c_o_l_o_r_C_u_r_s_o_r function changes the color of the speci-
fied cursor, and if the cursor is being displayed on a
screen, the change is visible immediately. The pixel mem-
bers of the _X_C_o_l_o_r structures are ignored; only the RGB val-
ues are used.
_X_R_e_c_o_l_o_r_C_u_r_s_o_r can generate a _B_a_d_C_u_r_s_o_r error.
To free (destroy) a given cursor, use _X_F_r_e_e_C_u_r_s_o_r.
__
││
XFreeCursor(_d_i_s_p_l_a_y, _c_u_r_s_o_r)
Display *_d_i_s_p_l_a_y;
Cursor _c_u_r_s_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_u_r_s_o_r Specifies the cursor.
││__
The _X_F_r_e_e_C_u_r_s_o_r function deletes the association between the
cursor resource ID and the specified cursor. The cursor
storage is freed when no other resource references it. The
specified cursor ID should not be referred to again.
_X_F_r_e_e_C_u_r_s_o_r can generate a _B_a_d_C_u_r_s_o_r error.
111111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 66
CCoolloorr MMaannaaggeemmeenntt FFuunnccttiioonnss
Each X window always has an associated colormap that pro-
vides a level of indirection between pixel values and colors
displayed on the screen. Xlib provides functions that you
can use to manipulate a colormap. The X protocol defines
colors using values in the RGB color space. The RGB color
space is device dependent; rendering an RGB value on differ-
ing output devices typically results in different colors.
Xlib also provides a means for clients to specify color
using device-independent color spaces for consistent results
across devices. Xlib supports device-independent color
spaces derivable from the CIE XYZ color space. This
includes the CIE XYZ, xyY, L*u*v*, and L*a*b* color spaces
as well as the TekHVC color space.
This chapter discusses how to:
· Create, copy, and destroy a colormap
· Specify colors by name or value
· Allocate, modify, and free color cells
· Read entries in a colormap
· Convert between color spaces
· Control aspects of color conversion
· Query the color gamut of a screen
· Add new color spaces
All functions, types, and symbols in this chapter with the
prefix ``Xcms'' are defined in <_X_1_1_/_X_c_m_s_._h>. The remaining
functions and types are defined in <_X_1_1_/_X_l_i_b_._h>.
Functions in this chapter manipulate the representation of
color on the screen. For each possible value that a pixel
can take in a window, there is a color cell in the colormap.
For example, if a window is 4 bits deep, pixel values 0
through 15 are defined. A colormap is a collection of color
cells. A color cell consists of a triple of red, green, and
blue (RGB) values. The hardware imposes limits on the num-
ber of significant bits in these values. As each pixel is
read out of display memory, the pixel is looked up in a col-
ormap. The RGB value of the cell determines what color is
111122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
displayed on the screen. On a grayscale display with a
black-and-white monitor, the values are combined to deter-
mine the brightness on the screen.
Typically, an application allocates color cells or sets of
color cells to obtain the desired colors. The client can
allocate read-only cells. In which case, the pixel values
for these colors can be shared among multiple applications,
and the RGB value of the cell cannot be changed. If the
client allocates read/write cells, they are exclusively
owned by the client, and the color associated with the pixel
value can be changed at will. Cells must be allocated (and,
if read/write, initialized with an RGB value) by a client to
obtain desired colors. The use of pixel value for an unal-
located cell results in an undefined color.
Because colormaps are associated with windows, X supports
displays with multiple colormaps and, indeed, different
types of colormaps. If there are insufficient colormap
resources in the display, some windows will display in their
true colors, and others will display with incorrect colors.
A window manager usually controls which windows are dis-
played in their true colors if more than one colormap is
required for the color resources the applications are using.
At any time, there is a set of installed colormaps for a
screen. Windows using one of the installed colormaps dis-
play with true colors, and windows using other colormaps
generally display with incorrect colors. You can control
the set of installed colormaps by using _X_I_n_s_t_a_l_l_C_o_l_o_r_m_a_p and
_X_U_n_i_n_s_t_a_l_l_C_o_l_o_r_m_a_p.
Colormaps are local to a particular screen. Screens always
have a default colormap, and programs typically allocate
cells out of this colormap. Generally, you should not write
applications that monopolize color resources. Although some
hardware supports multiple colormaps installed at one time,
many of the hardware displays built today support only a
single installed colormap, so the primitives are written to
encourage sharing of colormap entries between applications.
The _D_e_f_a_u_l_t_C_o_l_o_r_m_a_p macro returns the default colormap. The
_D_e_f_a_u_l_t_V_i_s_u_a_l macro returns the default visual type for the
specified screen. Possible visual types are _S_t_a_t_i_c_G_r_a_y,
_G_r_a_y_S_c_a_l_e, _S_t_a_t_i_c_C_o_l_o_r, _P_s_e_u_d_o_C_o_l_o_r, _T_r_u_e_C_o_l_o_r, or _D_i_r_e_c_t_-
_C_o_l_o_r (see section 3.1).
66..11.. CCoolloorr SSttrruuccttuurreess
Functions that operate only on RGB color space values use an
_X_C_o_l_o_r structure, which contains:
111133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
unsigned long pixel;/* pixel value */
unsigned short red, green, blue;/* rgb values */
char flags; /* DoRed, DoGreen, DoBlue */
char pad;
} XColor;
││__
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 val-
ues down to the range used by the hardware. Black is repre-
sented by (0,0,0), and white is represented by
(65535,65535,65535). In some functions, the flags member
controls which of the red, green, and blue members is used
and can be the inclusive OR of zero or more of _D_o_R_e_d,
_D_o_G_r_e_e_n, and _D_o_B_l_u_e.
Functions that operate on all color space values use an _X_c_m_-
_s_C_o_l_o_r structure. This structure contains a union of sub-
structures, each supporting color specification encoding for
a particular color space. Like the _X_C_o_l_o_r structure, the
_X_c_m_s_C_o_l_o_r structure contains pixel and color specification
information (the spec member in the _X_c_m_s_C_o_l_o_r structure).
__
││
typedef unsigned long XcmsColorFormat;/* Color Specification Format */
typedef struct {
union {
XcmsRGB RGB;
XcmsRGBi RGBi;
XcmsCIEXYZ CIEXYZ;
XcmsCIEuvY CIEuvY;
XcmsCIExyY CIExyY;
XcmsCIELab CIELab;
XcmsCIELuv CIELuv;
XcmsTekHVC TekHVC;
XcmsPad Pad;
} spec;
unsigned long pixel;
XcmsColorFormat format;
} XcmsColor; /* Xcms Color Structure */
││__
Because the color specification can be encoded for the vari-
ous color spaces, encoding for the spec member is identified
by the format member, which is of type _X_c_m_s_C_o_l_o_r_F_o_r_m_a_t. The
following macros define standard formats.
111144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
#define _X_c_m_s_U_n_d_e_f_i_n_e_d_- 0x00000000
_F_o_r_m_a_t
#define _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t 0x00000001 /* CIE XYZ */
#define _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t 0x00000002 /* CIE u'v'Y */
#define _X_c_m_s_C_I_E_x_y_Y_F_o_r_m_a_t 0x00000003 /* CIE xyY */
#define _X_c_m_s_C_I_E_L_a_b_F_o_r_m_a_t 0x00000004 /* CIE L*a*b*
*/
#define _X_c_m_s_C_I_E_L_u_v_F_o_r_m_a_t 0x00000005 /* CIE L*u*v*
*/
#define _X_c_m_s_T_e_k_H_V_C_F_o_r_m_a_t 0x00000006 /* TekHVC */
#define _X_c_m_s_R_G_B_F_o_r_m_a_t 0x80000000 /* RGB Device
*/
#define _X_c_m_s_R_G_B_i_F_o_r_m_a_t 0x80000001 /* RGB Inten-
sity */
││__
Formats for device-independent color spaces are distinguish-
able from those for device-dependent spaces by the 32nd bit.
If this bit is set, it indicates that the color specifica-
tion is in a device-dependent form; otherwise, it is in a
device-independent form. If the 31st bit is set, this indi-
cates that the color space has been added to Xlib at run
time (see section 6.12.4). The format value for a color
space added at run time may be different each time the pro-
gram is executed. If references to such a color space must
be made outside the client (for example, storing a color
specification in a file), then reference should be made by
color space string prefix (see _X_c_m_s_F_o_r_m_a_t_O_f_P_r_e_f_i_x and _X_c_m_-
_s_P_r_e_f_i_x_O_f_F_o_r_m_a_t).
Data types that describe the color specification encoding
for the various color spaces are defined as follows:
111155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef double XcmsFloat;
typedef struct {
unsigned short red; /* 0x0000 to 0xffff */
unsigned short green;/* 0x0000 to 0xffff */
unsigned short blue;/* 0x0000 to 0xffff */
} XcmsRGB; /* RGB Device */
typedef struct {
XcmsFloat red; /* 0.0 to 1.0 */
XcmsFloat green; /* 0.0 to 1.0 */
XcmsFloat blue; /* 0.0 to 1.0 */
} XcmsRGBi; /* RGB Intensity */
typedef struct {
XcmsFloat X;
XcmsFloat Y; /* 0.0 to 1.0 */
XcmsFloat Z;
} XcmsCIEXYZ; /* CIE XYZ */
typedef struct {
XcmsFloat u_prime; /* 0.0 to ~0.6 */
XcmsFloat v_prime; /* 0.0 to ~0.6 */
XcmsFloat Y; /* 0.0 to 1.0 */
} XcmsCIEuvY; /* CIE u'v'Y */
typedef struct {
XcmsFloat x; /* 0.0 to ~.75 */
XcmsFloat y; /* 0.0 to ~.85 */
XcmsFloat Y; /* 0.0 to 1.0 */
} XcmsCIExyY; /* CIE xyY */
typedef struct {
XcmsFloat L_star; /* 0.0 to 100.0 */
XcmsFloat a_star;
XcmsFloat b_star;
} XcmsCIELab; /* CIE L*a*b* */
typedef struct {
XcmsFloat L_star; /* 0.0 to 100.0 */
111166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
XcmsFloat u_star;
XcmsFloat v_star;
} XcmsCIELuv; /* CIE L*u*v* */
typedef struct {
XcmsFloat H; /* 0.0 to 360.0 */
XcmsFloat V; /* 0.0 to 100.0 */
XcmsFloat C; /* 0.0 to 100.0 */
} XcmsTekHVC; /* TekHVC */
typedef struct {
XcmsFloat pad0;
XcmsFloat pad1;
XcmsFloat pad2;
XcmsFloat pad3;
} XcmsPad; /* four doubles */
││__
The device-dependent formats provided allow color specifica-
tion in:
· RGB Intensity (_X_c_m_s_R_G_B_i)
Red, green, and blue linear intensity values, floating-
point values from 0.0 to 1.0, where 1.0 indicates full
intensity, 0.5 half intensity, and so on.
· RGB Device (_X_c_m_s_R_G_B)
Red, green, and blue values appropriate for the speci-
fied output device. _X_c_m_s_R_G_B values are of type
unsigned short, scaled from 0 to 65535 inclusive, and
are interchangeable with the red, green, and blue val-
ues in an _X_C_o_l_o_r structure.
It is important to note that RGB Intensity values are not
gamma corrected values. In contrast, RGB Device values gen-
erated as a result of converting color specifications are
always gamma corrected, and RGB Device values acquired as a
result of querying a colormap or passed in by the client are
assumed by Xlib to be gamma corrected. The term _R_G_B _v_a_l_u_e
in this manual always refers to an RGB Device value.
66..22.. CCoolloorr SSttrriinnggss
Xlib provides a mechanism for using string names for colors.
A color string may either contain an abstract color name or
a numerical color specification. Color strings are case-
insensitive.
111177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Color strings are used in the following functions:
· _X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r
· _X_c_m_s_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r
· _X_L_o_o_k_u_p_C_o_l_o_r
· _X_c_m_s_L_o_o_k_u_p_C_o_l_o_r
· _X_P_a_r_s_e_C_o_l_o_r
· _X_S_t_o_r_e_N_a_m_e_d_C_o_l_o_r
Xlib supports the use of abstract color names, for example,
red or blue. A value for this abstract name is obtained by
searching one or more color name databases. Xlib first
searches zero or more client-side databases; the number,
location, and content of these databases is implementation-
dependent and might depend on the current locale. If the
name is not found, Xlib then looks for the color in the X
server's database. If the color name is not in the Host
Portable Character Encoding, the result is implementation-
dependent.
A numerical color specification consists of a color space
name and a set of values in the following syntax:
__
││
_<_c_o_l_o_r___s_p_a_c_e___n_a_m_e_>:_<_v_a_l_u_e_>_/_._._._/_<_v_a_l_u_e_>
││__
The following are examples of valid color strings.
"CIEXYZ:0.3227/0.28133/0.2493"
"RGBi:1.0/0.0/0.0"
"rgb:00/ff/00"
"CIELuv:50.0/0.0/0.0"
The syntax and semantics of numerical specifications are
given for each standard color space in the following sec-
tions.
66..22..11.. RRGGBB DDeevviiccee SSttrriinngg SSppeecciiffiiccaattiioonn
An RGB Device specification is identified by the prefix
``rgb:'' and conforms to the following syntax:
rgb:_<_r_e_d_>_/_<_g_r_e_e_n_>_/_<_b_l_u_e_>
111188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_<_r_e_d_>, _<_g_r_e_e_n_>, _<_b_l_u_e_> := _h | _h_h | _h_h_h | _h_h_h_h
_h := single hexadecimal digits (case insignificant)
Note that _h indicates the value scaled in 4 bits, _h_h the
value scaled in 8 bits, _h_h_h the value scaled in 12 bits, and
_h_h_h_h the value scaled in 16 bits, respectively.
Typical examples are the strings ``rgb:ea/75/52'' and
``rgb:ccc/320/320'', but mixed numbers of hexadecimal digit
strings (``rgb:ff/a5/0'' and ``rgb:ccc/32/0'') are also
allowed.
For backward compatibility, an older syntax for RGB Device
is supported, but its continued use is not encouraged. The
syntax is an initial sharp sign character followed by a
numeric specification, in one of the following formats:
#RGB (4 bits each)
#RRGGBB (8 bits each)
#RRRGGGBBB (12 bits each)
#RRRRGGGGBBBB (16 bits each)
The R, G, and B represent single hexadecimal digits. When
fewer than 16 bits each are specified, they represent the
most significant bits of the value (unlike the ``rgb:'' syn-
tax, in which values are scaled). For example, the string
``#3a7'' is the same as ``#3000a0007000''.
66..22..22.. RRGGBB IInntteennssiittyy SSttrriinngg SSppeecciiffiiccaattiioonn
An RGB intensity specification is identified by the prefix
``rgbi:'' and conforms to the following syntax:
rgbi:_<_r_e_d_>_/_<_g_r_e_e_n_>_/_<_b_l_u_e_>
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 followed by a possibly signed integer
string.
66..22..33.. DDeevviiccee--IInnddeeppeennddeenntt SSttrriinngg SSppeecciiffiiccaattiioonnss
The standard device-independent string specifications have
the following syntax:
CIEXYZ:_<_X_>_/_<_Y_>_/_<_Z_>
111199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CIEuvY:_<_u_>_/_<_v_>_/_<_Y_>
CIExyY:_<_x_>_/_<_y_>_/_<_Y_>
CIELab:_<_L_>_/_<_a_>_/_<_b_>
CIELuv:_<_L_>_/_<_u_>_/_<_v_>
TekHVC:_<_H_>_/_<_V_>_/_<_C_>
All of the values (C, H, V, X, Y, Z, a, b, u, v, y, x) are
floating-point values. The syntax for these values is an
optional plus or minus sign, a string of digits possibly
containing a decimal point, and an optional exponent field
consisting of an ``E'' or ``e'' followed by an optional plus
or minus followed by a string of digits.
66..33.. CCoolloorr CCoonnvveerrssiioonn CCoonntteexxttss aanndd GGaammuutt MMaappppiinngg
When Xlib converts device-independent color specifications
into device-dependent specifications and vice versa, it uses
knowledge about the color limitations of the screen hard-
ware. This information, typically called the device pro-
file, is available in a Color Conversion Context (CCC).
Because a specified color may be outside the color gamut of
the target screen and the white point associated with the
color specification may differ from the white point inherent
to the screen, Xlib applies gamut mapping when it encounters
certain conditions:
· Gamut compression occurs when conversion of device-
independent color specifications to device-dependent
color specifications results in a color out of the tar-
get screen's gamut.
· White adjustment occurs when the inherent white point
of the screen differs from the white point assumed by
the client.
Gamut handling methods are stored as callbacks in the CCC,
which in turn are used by the color space conversion rou-
tines. Client data is also stored in the CCC for each call-
back. The CCC also contains the white point the client
assumes to be associated with color specifications (that is,
the Client White Point). The client can specify the gamut
handling callbacks and client data as well as the Client
White Point. Xlib does not preclude the X client from per-
forming other forms of gamut handling (for example, gamut
expansion); however, Xlib does not provide direct support
for gamut handling other than white adjustment and gamut
compression.
Associated with each colormap is an initial CCC transpar-
ently generated by Xlib. Therefore, when you specify a col-
ormap as an argument to an Xlib function, you are indirectly
specifying a CCC. There is a default CCC associated with
112200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
each screen. Newly created CCCs inherit attributes from the
default CCC, so the default CCC attributes can be modified
to affect new CCCs.
Xcms functions in which gamut mapping can occur return _S_t_a_-
_t_u_s and have specific status values defined for them, as
follows:
· _X_c_m_s_F_a_i_l_u_r_e indicates that the function failed.
· _X_c_m_s_S_u_c_c_e_s_s indicates that the function succeeded. In
addition, if the function performed any color conver-
sion, the colors did not need to be compressed.
· _X_c_m_s_S_u_c_c_e_s_s_W_i_t_h_C_o_m_p_r_e_s_s_i_o_n indicates the function per-
formed color conversion and at least one of the colors
needed to be compressed. The gamut compression method
is determined by the gamut compression procedure in the
CCC that is specified directly as a function argument
or in the CCC indirectly specified by means of the col-
ormap argument.
66..44.. CCrreeaattiinngg,, CCooppyyiinngg,, aanndd DDeessttrrooyyiinngg CCoolloorrmmaappss
To create a colormap for a screen, use _X_C_r_e_a_t_e_C_o_l_o_r_m_a_p.
__
││
Colormap XCreateColormap(_d_i_s_p_l_a_y, _w, _v_i_s_u_a_l, _a_l_l_o_c)
Display *_d_i_s_p_l_a_y;
Window _w;
Visual *_v_i_s_u_a_l;
int _a_l_l_o_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window on whose screen you want to
create a colormap.
_v_i_s_u_a_l Specifies a visual type supported on the screen.
If the visual type is not one supported by the
screen, a _B_a_d_M_a_t_c_h error results.
_a_l_l_o_c Specifies the colormap entries to be allocated.
You can pass _A_l_l_o_c_N_o_n_e or _A_l_l_o_c_A_l_l.
││__
The _X_C_r_e_a_t_e_C_o_l_o_r_m_a_p function creates a colormap of the spec-
ified visual type for the screen on which the specified win-
dow resides and returns the colormap ID associated with it.
Note that the specified window is only used to determine the
screen.
112211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The initial values of the colormap entries are undefined for
the visual classes _G_r_a_y_S_c_a_l_e, _P_s_e_u_d_o_C_o_l_o_r, and _D_i_r_e_c_t_C_o_l_o_r.
For _S_t_a_t_i_c_G_r_a_y, _S_t_a_t_i_c_C_o_l_o_r, and _T_r_u_e_C_o_l_o_r, the entries have
defined values, but those values are specific to the visual
and are not defined by X. For _S_t_a_t_i_c_G_r_a_y, _S_t_a_t_i_c_C_o_l_o_r, and
_T_r_u_e_C_o_l_o_r, alloc must be _A_l_l_o_c_N_o_n_e, or a _B_a_d_M_a_t_c_h error
results. For the other visual classes, if alloc is _A_l_l_o_c_-
_N_o_n_e, the colormap initially has no allocated entries, and
clients can allocate them. For information about the visual
types, see section 3.1.
If alloc is _A_l_l_o_c_A_l_l, the entire colormap is allocated
writable. The initial values of all allocated entries are
undefined. For _G_r_a_y_S_c_a_l_e and _P_s_e_u_d_o_C_o_l_o_r, the effect is as
if an _X_A_l_l_o_c_C_o_l_o_r_C_e_l_l_s call returned all pixel values from
zero to N - 1, where N is the colormap entries value in the
specified visual. For _D_i_r_e_c_t_C_o_l_o_r, the effect is as if an
_X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s 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, none of these entries can be
freed by using _X_F_r_e_e_C_o_l_o_r_s.
_X_C_r_e_a_t_e_C_o_l_o_r_m_a_p can generate _B_a_d_A_l_l_o_c, _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e,
and _B_a_d_W_i_n_d_o_w errors.
To create a new colormap when the allocation out of a previ-
ously shared colormap has failed because of resource exhaus-
tion, use _X_C_o_p_y_C_o_l_o_r_m_a_p_A_n_d_F_r_e_e.
__
││
Colormap XCopyColormapAndFree(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
││__
The _X_C_o_p_y_C_o_l_o_r_m_a_p_A_n_d_F_r_e_e 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 col-
ormap 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 _A_l_l_o_c_A_l_l, the new colormap is also created with _A_l_l_o_c_A_l_l,
all color values for all entries are copied from the speci-
fied colormap, and then all entries in the specified
112222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
colormap are freed. If the specified colormap was not cre-
ated by the client with _A_l_l_o_c_A_l_l, the allocations to be
moved are all those pixels and planes that have been allo-
cated by the client using _X_A_l_l_o_c_C_o_l_o_r, _X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r,
_X_A_l_l_o_c_C_o_l_o_r_C_e_l_l_s, or _X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s and that have not
been freed since they were allocated.
_X_C_o_p_y_C_o_l_o_r_m_a_p_A_n_d_F_r_e_e can generate _B_a_d_A_l_l_o_c and _B_a_d_C_o_l_o_r
errors.
To destroy a colormap, use _X_F_r_e_e_C_o_l_o_r_m_a_p.
__
││
XFreeColormap(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap that you want to destroy.
││__
The _X_F_r_e_e_C_o_l_o_r_m_a_p function deletes the association between
the colormap resource ID and the colormap and frees the col-
ormap 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, it is uninstalled (see _X_U_n_i_n_-
_s_t_a_l_l_C_o_l_o_r_m_a_p). If the specified colormap is defined as the
colormap for a window (by _X_C_r_e_a_t_e_W_i_n_d_o_w, _X_S_e_t_W_i_n_d_o_w_C_o_l_o_r_m_a_p,
or _X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s), _X_F_r_e_e_C_o_l_o_r_m_a_p changes the col-
ormap associated with the window to _N_o_n_e and generates a
_C_o_l_o_r_m_a_p_N_o_t_i_f_y event. X does not define the colors dis-
played for a window with a colormap of _N_o_n_e.
_X_F_r_e_e_C_o_l_o_r_m_a_p can generate a _B_a_d_C_o_l_o_r error.
66..55.. MMaappppiinngg CCoolloorr NNaammeess ttoo VVaalluueess
To map a color name to an RGB value, use _X_L_o_o_k_u_p_C_o_l_o_r.
112233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XLookupColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r___n_a_m_e, _e_x_a_c_t___d_e_f___r_e_t_u_r_n, _s_c_r_e_e_n___d_e_f___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
char *_c_o_l_o_r___n_a_m_e;
XColor *_e_x_a_c_t___d_e_f___r_e_t_u_r_n, *_s_c_r_e_e_n___d_e_f___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r___n_a_m_e
Specifies the color name string (for example, red)
whose color definition structure you want
returned.
_e_x_a_c_t___d_e_f___r_e_t_u_r_n
Returns the exact RGB values.
_s_c_r_e_e_n___d_e_f___r_e_t_u_r_n
Returns the closest RGB values provided by the
hardware.
││__
The _X_L_o_o_k_u_p_C_o_l_o_r function looks up the string name of a
color with respect to the screen associated with the speci-
fied colormap. It returns both the exact color values and
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, the
result is implementation-dependent. Use of uppercase or
lowercase does not matter. _X_L_o_o_k_u_p_C_o_l_o_r returns nonzero if
the name is resolved; otherwise, it returns zero.
_X_L_o_o_k_u_p_C_o_l_o_r can generate a _B_a_d_C_o_l_o_r error.
To map a color name to the exact RGB value, use _X_P_a_r_s_e_C_o_l_o_r.
112244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XParseColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _s_p_e_c, _e_x_a_c_t___d_e_f___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
char *_s_p_e_c;
XColor *_e_x_a_c_t___d_e_f___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_s_p_e_c Specifies the color name string; case is ignored.
_e_x_a_c_t___d_e_f___r_e_t_u_r_n
Returns the exact color value for later use and
sets the _D_o_R_e_d, _D_o_G_r_e_e_n, and _D_o_B_l_u_e flags.
││__
The _X_P_a_r_s_e_C_o_l_o_r 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, the
result is implementation-dependent. Use of uppercase or
lowercase does not matter. _X_P_a_r_s_e_C_o_l_o_r returns nonzero if
the name is resolved; otherwise, it returns zero.
_X_P_a_r_s_e_C_o_l_o_r can generate a _B_a_d_C_o_l_o_r error.
To map a color name to a value in an arbitrary color space,
use _X_c_m_s_L_o_o_k_u_p_C_o_l_o_r.
112255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsLookupColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r___s_t_r_i_n_g, _c_o_l_o_r___e_x_a_c_t___r_e_t_u_r_n, _c_o_l_o_r___s_c_r_e_e_n___r_e_t_u_r_n,
_r_e_s_u_l_t___f_o_r_m_a_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
char *_c_o_l_o_r___s_t_r_i_n_g;
XcmsColor *_c_o_l_o_r___e_x_a_c_t___r_e_t_u_r_n, *_c_o_l_o_r___s_c_r_e_e_n___r_e_t_u_r_n;
XcmsColorFormat _r_e_s_u_l_t___f_o_r_m_a_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r___s_t_r_i_n_g
Specifies the color string.
_c_o_l_o_r___e_x_a_c_t___r_e_t_u_r_n
Returns the color specification parsed from the
color string or parsed from the corresponding
string found in a color-name database.
_c_o_l_o_r___s_c_r_e_e_n___r_e_t_u_r_n
Returns the color that can be reproduced on the
screen.
_r_e_s_u_l_t___f_o_r_m_a_t
Specifies the color format for the returned color
specifications (color_screen_return and
color_exact_return arguments). If the format is
_X_c_m_s_U_n_d_e_f_i_n_e_d_F_o_r_m_a_t and the color string contains
a numerical color specification, the specification
is returned in the format used in that numerical
color specification. If the format is _X_c_m_s_U_n_d_e_-
_f_i_n_e_d_F_o_r_m_a_t and the color string contains a color
name, the specification is returned in the format
used to store the color in the database.
││__
The _X_c_m_s_L_o_o_k_u_p_C_o_l_o_r function looks up the string name of a
color with respect to the screen associated with the speci-
fied colormap. It returns both the exact color values and
the closest values provided by the screen with respect to
the visual type of the specified colormap. The values are
returned in the format specified by result_format. 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. _X_c_m_s_L_o_o_k_u_p_C_o_l_o_r returns _X_c_m_s_S_u_c_-
_c_e_s_s or _X_c_m_s_S_u_c_c_e_s_s_W_i_t_h_C_o_m_p_r_e_s_s_i_o_n if the name is resolved;
otherwise, it returns _X_c_m_s_F_a_i_l_u_r_e. If _X_c_m_s_S_u_c_c_e_s_s_W_i_t_h_C_o_m_-
_p_r_e_s_s_i_o_n is returned, the color specification returned in
color_screen_return is the result of gamut compression.
112266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
66..66.. AAllllooccaattiinngg aanndd FFrreeeeiinngg CCoolloorr CCeellllss
There are two ways of allocating color cells: explicitly as
read-only entries, one pixel value at a time, or read/write,
where you can allocate a number of color cells and planes
simultaneously. A read-only cell has its RGB value set by
the server. Read/write cells do not have defined colors
initially; functions described in the next section must be
used to store values into them. Although it is possible for
any client to store values into a read/write cell allocated
by another client, read/write cells normally should be con-
sidered private to the client that allocated them.
Read-only colormap cells are shared among clients. The
server counts each allocation and freeing of the cell by
clients. When the last client frees a shared cell, the cell
is finally deallocated. If a single client allocates the
same read-only cell multiple times, the server counts each
such allocation, not just the first one.
To allocate a read-only color cell with an RGB value, use
_X_A_l_l_o_c_C_o_l_o_r.
__
││
Status XAllocColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _s_c_r_e_e_n___i_n___o_u_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XColor *_s_c_r_e_e_n___i_n___o_u_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_s_c_r_e_e_n___i_n___o_u_t
Specifies and returns the values actually used in
the colormap.
││__
The _X_A_l_l_o_c_C_o_l_o_r function allocates a read-only colormap
entry corresponding to the closest RGB value supported by
the hardware. _X_A_l_l_o_c_C_o_l_o_r returns the pixel value of the
color closest to the specified RGB elements supported by the
hardware and returns the RGB value actually used. The cor-
responding colormap cell is read-only. In addition, _X_A_l_l_o_c_-
_C_o_l_o_r returns nonzero if it succeeded or zero if it failed.
Multiple clients that request the same effective RGB value
can be assigned the same read-only entry, thus allowing
entries to be shared. When the last client deallocates a
shared cell, it is deallocated. _X_A_l_l_o_c_C_o_l_o_r does not use or
affect the flags in the _X_C_o_l_o_r structure.
112277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_A_l_l_o_c_C_o_l_o_r can generate a _B_a_d_C_o_l_o_r error.
To allocate a read-only color cell with a color in arbitrary
format, use _X_c_m_s_A_l_l_o_c_C_o_l_o_r.
__
││
Status XcmsAllocColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r___i_n___o_u_t, _r_e_s_u_l_t___f_o_r_m_a_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XcmsColor *_c_o_l_o_r___i_n___o_u_t;
XcmsColorFormat _r_e_s_u_l_t___f_o_r_m_a_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r___i_n___o_u_t
Specifies the color to allocate and returns the
pixel and color that is actually used in the col-
ormap.
_r_e_s_u_l_t___f_o_r_m_a_t
Specifies the color format for the returned color
specification.
││__
The _X_c_m_s_A_l_l_o_c_C_o_l_o_r function is similar to _X_A_l_l_o_c_C_o_l_o_r except
the color can be specified in any format. The _X_c_m_s_A_l_l_o_c_-
_C_o_l_o_r function ultimately calls _X_A_l_l_o_c_C_o_l_o_r to allocate a
read-only color cell (colormap entry) with the specified
color. _X_c_m_s_A_l_l_o_c_C_o_l_o_r first converts the color specified to
an RGB value and then passes this to _X_A_l_l_o_c_C_o_l_o_r. _X_c_m_s_A_l_-
_l_o_c_C_o_l_o_r returns the pixel value of the color cell and the
color specification actually allocated. This returned color
specification is the result of converting the RGB value
returned by _X_A_l_l_o_c_C_o_l_o_r into the format specified with the
result_format argument. If there is no interest in a
returned color specification, unnecessary computation can be
bypassed if result_format is set to _X_c_m_s_R_G_B_F_o_r_m_a_t. The cor-
responding colormap cell is read-only. If this routine
returns _X_c_m_s_F_a_i_l_u_r_e, the color_in_out color specification is
left unchanged.
_X_c_m_s_A_l_l_o_c_C_o_l_o_r can generate a _B_a_d_C_o_l_o_r error.
To allocate a read-only color cell using a color name and
return the closest color supported by the hardware in RGB
format, use _X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r.
112288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XAllocNamedColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r___n_a_m_e, _s_c_r_e_e_n___d_e_f___r_e_t_u_r_n, _e_x_a_c_t___d_e_f___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
char *_c_o_l_o_r___n_a_m_e;
XColor *_s_c_r_e_e_n___d_e_f___r_e_t_u_r_n, *_e_x_a_c_t___d_e_f___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r___n_a_m_e
Specifies the color name string (for example, red)
whose color definition structure you want
returned.
_s_c_r_e_e_n___d_e_f___r_e_t_u_r_n
Returns the closest RGB values provided by the
hardware.
_e_x_a_c_t___d_e_f___r_e_t_u_r_n
Returns the exact RGB values.
││__
The _X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r function looks up the named color with
respect to the screen that is associated with the specified
colormap. 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, the result is implementation-
dependent. Use of uppercase or lowercase does not matter.
If screen_def_return and exact_def_return point to the same
structure, the pixel field will be set correctly, but the
color values are undefined. _X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r returns
nonzero if a cell is allocated; otherwise, it returns zero.
_X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r can generate a _B_a_d_C_o_l_o_r error.
To allocate a read-only color cell using a color name and
return the closest color supported by the hardware in an
arbitrary format, use _X_c_m_s_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r.
112299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsAllocNamedColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r___s_t_r_i_n_g, _c_o_l_o_r___s_c_r_e_e_n___r_e_t_u_r_n, _c_o_l_o_r___e_x_a_c_t___r_e_t_u_r_n,
_r_e_s_u_l_t___f_o_r_m_a_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
char *_c_o_l_o_r___s_t_r_i_n_g;
XcmsColor *_c_o_l_o_r___s_c_r_e_e_n___r_e_t_u_r_n;
XcmsColor *_c_o_l_o_r___e_x_a_c_t___r_e_t_u_r_n;
XcmsColorFormat _r_e_s_u_l_t___f_o_r_m_a_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r___s_t_r_i_n_g
Specifies the color string whose color definition
structure is to be returned.
_c_o_l_o_r___s_c_r_e_e_n___r_e_t_u_r_n
Returns the pixel value of the color cell and
color specification that actually is stored for
that cell.
_c_o_l_o_r___e_x_a_c_t___r_e_t_u_r_n
Returns the color specification parsed from the
color string or parsed from the corresponding
string found in a color-name database.
_r_e_s_u_l_t___f_o_r_m_a_t
Specifies the color format for the returned color
specifications (color_screen_return and
color_exact_return arguments). If the format is
_X_c_m_s_U_n_d_e_f_i_n_e_d_F_o_r_m_a_t and the color string contains
a numerical color specification, the specification
is returned in the format used in that numerical
color specification. If the format is _X_c_m_s_U_n_d_e_-
_f_i_n_e_d_F_o_r_m_a_t and the color string contains a color
name, the specification is returned in the format
used to store the color in the database.
││__
The _X_c_m_s_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r function is similar to _X_A_l_l_o_c_N_a_m_e_d_-
_C_o_l_o_r except that the color returned can be in any format
specified. This function ultimately calls _X_A_l_l_o_c_C_o_l_o_r to
allocate a read-only color cell with the color specified by
a color string. The color string is parsed into an _X_c_m_s_-
_C_o_l_o_r structure (see _X_c_m_s_L_o_o_k_u_p_C_o_l_o_r), converted to an RGB
value, and finally passed to _X_A_l_l_o_c_C_o_l_o_r. 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.
113300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This function returns both the color specification as a
result of parsing (exact specification) and the actual color
specification stored (screen specification). This screen
specification is the result of converting the RGB value
returned by _X_A_l_l_o_c_C_o_l_o_r into the format specified in
result_format. If there is no interest in a returned color
specification, unnecessary computation can be bypassed if
result_format is set to _X_c_m_s_R_G_B_F_o_r_m_a_t. If
color_screen_return and color_exact_return point to the same
structure, the pixel field will be set correctly, but the
color values are undefined.
_X_c_m_s_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r can generate a _B_a_d_C_o_l_o_r error.
To allocate read/write color cell and color plane combina-
tions for a _P_s_e_u_d_o_C_o_l_o_r model, use _X_A_l_l_o_c_C_o_l_o_r_C_e_l_l_s.
__
││
Status XAllocColorCells(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_n_t_i_g, _p_l_a_n_e___m_a_s_k_s___r_e_t_u_r_n, _n_p_l_a_n_e_s,
_p_i_x_e_l_s___r_e_t_u_r_n, _n_p_i_x_e_l_s)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
Bool _c_o_n_t_i_g;
unsigned long _p_l_a_n_e___m_a_s_k_s___r_e_t_u_r_n[];
unsigned int _n_p_l_a_n_e_s;
unsigned long _p_i_x_e_l_s___r_e_t_u_r_n[];
unsigned int _n_p_i_x_e_l_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_n_t_i_g Specifies a Boolean value that indicates whether
the planes must be contiguous.
_p_l_a_n_e___m_a_s_k___r_e_t_u_r_n
Returns an array of plane masks.
_n_p_l_a_n_e_s Specifies the number of plane masks that are to be
returned in the plane masks array.
_p_i_x_e_l_s___r_e_t_u_r_n
Returns an array of pixel values.
_n_p_i_x_e_l_s Specifies the number of pixel values that are to
be returned in the pixels_return array.
││__
The _X_A_l_l_o_c_C_o_l_o_r_C_e_l_l_s function allocates read/write color
cells. The number of colors must be positive and the number
of planes nonnegative, or a _B_a_d_V_a_l_u_e error results. If
113311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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 any other mask or with any of the
pixels. By ORing together each pixel with zero or more
masks, ncolors * 2_n_p_l_a_n_e_s distinct pixels can be produced.
All of these are allocated writable by the request. For
_G_r_a_y_S_c_a_l_e or _P_s_e_u_d_o_C_o_l_o_r, each mask has exactly one bit set
to 1. For _D_i_r_e_c_t_C_o_l_o_r, each has exactly three bits set to
1. If contig is _T_r_u_e and if all masks are ORed together, a
single contiguous set of bits set to 1 will be formed for
_G_r_a_y_S_c_a_l_e or _P_s_e_u_d_o_C_o_l_o_r and three contiguous sets of bits
set to 1 (one within each pixel subfield) for _D_i_r_e_c_t_C_o_l_o_r.
The RGB values of the allocated entries are undefined. _X_A_l_-
_l_o_c_C_o_l_o_r_C_e_l_l_s returns nonzero if it succeeded or zero if it
failed.
_X_A_l_l_o_c_C_o_l_o_r_C_e_l_l_s can generate _B_a_d_C_o_l_o_r and _B_a_d_V_a_l_u_e errors.
To allocate read/write color resources for a _D_i_r_e_c_t_C_o_l_o_r
model, use _X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s.
113322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XAllocColorPlanes(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_n_t_i_g, _p_i_x_e_l_s___r_e_t_u_r_n, _n_c_o_l_o_r_s, _n_r_e_d_s, _n_g_r_e_e_n_s,
_n_b_l_u_e_s, _r_m_a_s_k___r_e_t_u_r_n, _g_m_a_s_k___r_e_t_u_r_n, _b_m_a_s_k___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
Bool _c_o_n_t_i_g;
unsigned long _p_i_x_e_l_s___r_e_t_u_r_n[];
int _n_c_o_l_o_r_s;
int _n_r_e_d_s, _n_g_r_e_e_n_s, _n_b_l_u_e_s;
unsigned long *_r_m_a_s_k___r_e_t_u_r_n, *_g_m_a_s_k___r_e_t_u_r_n, *_b_m_a_s_k___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_n_t_i_g Specifies a Boolean value that indicates whether
the planes must be contiguous.
_p_i_x_e_l_s___r_e_t_u_r_n
Returns an array of pixel values. _X_A_l_l_o_c_C_o_l_o_r_-
_P_l_a_n_e_s returns the pixel values in this array.
_n_c_o_l_o_r_s Specifies the number of pixel values that are to
be returned in the pixels_return array.
_n_r_e_d_s
_n_g_r_e_e_n_s
_n_b_l_u_e_s
Specify the number of red, green, and blue planes.
The value you pass must be nonnegative.
_r_m_a_s_k___r_e_t_u_r_n
_g_m_a_s_k___r_e_t_u_r_n
_b_m_a_s_k___r_e_t_u_r_n
Return bit masks for the red, green, and blue
planes.
││__
The specified ncolors must be positive; and nreds, ngreens,
and nblues must be nonnegative, or a _B_a_d_V_a_l_u_e 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 nblues bits set to 1, respec-
tively. If contig is _T_r_u_e, 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 _D_i_r_e_c_t_C_o_l_o_r, each mask will lie within the corresponding
pixel subfield. By ORing together subsets of masks with
each pixel value, ncolors * 2(_n_r_e_d_s+_n_g_r_e_e_n_s+_n_b_l_u_e_s) distinct
pixel values can be produced. All of these are allocated by
the request. However, in the colormap, there are only ncol-
ors * 2_n_r_e_d_s independent red entries, ncolors * 2_n_g_r_e_e_n_s
113333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
independent green entries, and ncolors * 2_n_b_l_u_e_s independent
blue entries. This is true even for _P_s_e_u_d_o_C_o_l_o_r. When the
colormap entry of a pixel value is changed (using _X_S_t_o_r_e_C_o_l_-
_o_r_s, _X_S_t_o_r_e_C_o_l_o_r, or _X_S_t_o_r_e_N_a_m_e_d_C_o_l_o_r), the pixel is decom-
posed according to the masks, and the corresponding indepen-
dent entries are updated. _X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s returns nonzero
if it succeeded or zero if it failed.
_X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s can generate _B_a_d_C_o_l_o_r and _B_a_d_V_a_l_u_e errors.
To free colormap cells, use _X_F_r_e_e_C_o_l_o_r_s.
__
││
XFreeColors(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _p_i_x_e_l_s, _n_p_i_x_e_l_s, _p_l_a_n_e_s)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
unsigned long _p_i_x_e_l_s[];
int _n_p_i_x_e_l_s;
unsigned long _p_l_a_n_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_p_i_x_e_l_s Specifies an array of pixel values that map to the
cells in the specified colormap.
_n_p_i_x_e_l_s Specifies the number of pixels.
_p_l_a_n_e_s Specifies the planes you want to free.
││__
The _X_F_r_e_e_C_o_l_o_r_s function frees the cells represented by pix-
els whose values are in the pixels array. The planes argu-
ment should not have any bits set to 1 in common with any of
the 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 _X_A_l_l_o_c_C_o_l_o_r, _X_A_l_l_o_c_N_a_m_e_d_C_o_l_o_r, _X_A_l_l_o_c_C_o_l_-
_o_r_C_e_l_l_s, and _X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s). Note that freeing an indi-
vidual pixel obtained from _X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s may not actu-
ally allow it to be reused until all of its related pixels
are also freed. Similarly, a read-only entry is not actu-
ally freed until it has been freed by all clients, 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.
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 _B_a_d_V_a_l_u_e error results. If a specified pixel is
113344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
not allocated by the client (that is, is unallocated or is
only allocated by another client) or if the colormap was
created with all entries writable (by passing _A_l_l_o_c_A_l_l to
_X_C_r_e_a_t_e_C_o_l_o_r_m_a_p), a _B_a_d_A_c_c_e_s_s error results. If more than
one pixel is in error, the one that gets reported is arbi-
trary.
_X_F_r_e_e_C_o_l_o_r_s can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r, and _B_a_d_V_a_l_u_e
errors.
66..77.. MMooddiiffyyiinngg aanndd QQuueerryyiinngg CCoolloorrmmaapp CCeellllss
To store an RGB value in a single colormap cell, use _X_S_t_o_r_e_-
_C_o_l_o_r.
__
││
XStoreColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XColor *_c_o_l_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r Specifies the pixel and RGB values.
││__
The _X_S_t_o_r_e_C_o_l_o_r function changes the colormap entry of the
pixel value specified in the pixel member of the _X_C_o_l_o_r
structure. You specified this value in the pixel member of
the _X_C_o_l_o_r structure. This pixel value must be a read/write
cell and a valid index into the colormap. If a specified
pixel is not a valid index into the colormap, a _B_a_d_V_a_l_u_e
error results. _X_S_t_o_r_e_C_o_l_o_r also changes the red, green,
and/or blue color components. You specify which color com-
ponents are to be changed by setting _D_o_R_e_d, _D_o_G_r_e_e_n, and/or
_D_o_B_l_u_e in the flags member of the _X_C_o_l_o_r structure. If the
colormap is an installed map for its screen, the changes are
visible immediately.
_X_S_t_o_r_e_C_o_l_o_r can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r, and _B_a_d_V_a_l_u_e
errors.
To store multiple RGB values in multiple colormap cells, use
_X_S_t_o_r_e_C_o_l_o_r_s.
113355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XStoreColors(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r, _n_c_o_l_o_r_s)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XColor _c_o_l_o_r[];
int _n_c_o_l_o_r_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r Specifies an array of color definition structures
to be stored.
_n_c_o_l_o_r_s Specifies the number of _X_C_o_l_o_r structures in the
color definition array.
││__
The _X_S_t_o_r_e_C_o_l_o_r_s function changes the colormap entries of
the pixel values specified in the pixel members of the
_X_C_o_l_o_r structures. You specify which color components are
to be changed by setting _D_o_R_e_d, _D_o_G_r_e_e_n, and/or _D_o_B_l_u_e in
the flags member of the _X_C_o_l_o_r structures. If the colormap
is an installed map for its screen, the changes are visible
immediately. _X_S_t_o_r_e_C_o_l_o_r_s changes the specified pixels if
they are allocated writable in the colormap by any client,
even if one or more pixels generates an error. If a speci-
fied pixel is not a valid index into the colormap, a _B_a_d_-
_V_a_l_u_e error results. If a specified pixel either is unallo-
cated or is allocated read-only, a _B_a_d_A_c_c_e_s_s error results.
If more than one pixel is in error, the one that gets
reported is arbitrary.
_X_S_t_o_r_e_C_o_l_o_r_s can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r, and _B_a_d_V_a_l_u_e
errors.
To store a color of arbitrary format in a single colormap
cell, use _X_c_m_s_S_t_o_r_e_C_o_l_o_r.
113366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsStoreColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XcmsColor *_c_o_l_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r Specifies the color cell and the color to store.
Values specified in this _X_c_m_s_C_o_l_o_r structure
remain unchanged on return.
││__
The _X_c_m_s_S_t_o_r_e_C_o_l_o_r function converts the color specified in
the _X_c_m_s_C_o_l_o_r structure into RGB values. It then uses this
RGB specification in an _X_C_o_l_o_r structure, whose three flags
(_D_o_R_e_d, _D_o_G_r_e_e_n, and _D_o_B_l_u_e) are set, in a call to _X_S_t_o_r_e_-
_C_o_l_o_r to change the color cell specified by the pixel member
of the _X_c_m_s_C_o_l_o_r structure. This pixel value must be a
valid index for the specified colormap, and the color cell
specified by the pixel value must be a read/write cell. If
the pixel value is not a valid index, a _B_a_d_V_a_l_u_e error
results. If the color cell is unallocated or is allocated
read-only, a _B_a_d_A_c_c_e_s_s error results. If the colormap is an
installed map for its screen, the changes are visible imme-
diately.
Note that _X_S_t_o_r_e_C_o_l_o_r has no return value; therefore, an
_X_c_m_s_S_u_c_c_e_s_s return value from this function indicates that
the conversion to RGB succeeded and the call to _X_S_t_o_r_e_C_o_l_o_r
was made. To obtain the actual color stored, use _X_c_m_s_Q_u_e_r_y_-
_C_o_l_o_r. Because of the screen's hardware limitations or
gamut compression, the color stored in the colormap may not
be identical to the color specified.
_X_c_m_s_S_t_o_r_e_C_o_l_o_r can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r, and _B_a_d_-
_V_a_l_u_e errors.
To store multiple colors of arbitrary format in multiple
colormap cells, use _X_c_m_s_S_t_o_r_e_C_o_l_o_r_s.
113377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsStoreColors(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r_s, _n_c_o_l_o_r_s, _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XcmsColor _c_o_l_o_r_s[];
int _n_c_o_l_o_r_s;
Bool _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n[];
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r_s Specifies the color specification array of _X_c_m_s_-
_C_o_l_o_r structures, each specifying a color cell and
the color to store in that cell. Values specified
in the array remain unchanged upon return.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
_c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n
Returns an array of Boolean values indicating com-
pression status. If a non-NULL pointer is sup-
plied, each element of the array is set to _T_r_u_e if
the corresponding color was compressed and _F_a_l_s_e
otherwise. Pass NULL if the compression status is
not useful.
││__
The _X_c_m_s_S_t_o_r_e_C_o_l_o_r_s function converts the colors specified
in the array of _X_c_m_s_C_o_l_o_r structures into RGB values and
then uses these RGB specifications in _X_C_o_l_o_r structures,
whose three flags (_D_o_R_e_d, _D_o_G_r_e_e_n, and _D_o_B_l_u_e) are set, in a
call to _X_S_t_o_r_e_C_o_l_o_r_s to change the color cells specified by
the pixel member of the corresponding _X_c_m_s_C_o_l_o_r structure.
Each pixel value must be a valid index for the specified
colormap, and the color cell specified by each pixel value
must be a read/write cell. If a pixel value is not a valid
index, a _B_a_d_V_a_l_u_e error results. If a color cell is unallo-
cated or is allocated read-only, a _B_a_d_A_c_c_e_s_s error results.
If more than one pixel is in error, the one that gets
reported is arbitrary. If the colormap is an installed map
for its screen, the changes are visible immediately.
Note that _X_S_t_o_r_e_C_o_l_o_r_s has no return value; therefore, an
_X_c_m_s_S_u_c_c_e_s_s return value from this function indicates that
conversions to RGB succeeded and the call to _X_S_t_o_r_e_C_o_l_o_r_s
was made. To obtain the actual colors stored, use _X_c_m_s_-
_Q_u_e_r_y_C_o_l_o_r_s. Because of the screen's hardware limitations
or gamut compression, the colors stored in the colormap may
not be identical to the colors specified.
113388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_c_m_s_S_t_o_r_e_C_o_l_o_r_s can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r, and _B_a_d_-
_V_a_l_u_e errors.
To store a color specified by name in a single colormap
cell, use _X_S_t_o_r_e_N_a_m_e_d_C_o_l_o_r.
__
││
XStoreNamedColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r, _p_i_x_e_l, _f_l_a_g_s)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
char *_c_o_l_o_r;
unsigned long _p_i_x_e_l;
int _f_l_a_g_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r Specifies the color name string (for example,
red).
_p_i_x_e_l Specifies the entry in the colormap.
_f_l_a_g_s Specifies which red, green, and blue components
are set.
││__
The _X_S_t_o_r_e_N_a_m_e_d_C_o_l_o_r function looks up the named color with
respect to the screen associated with the colormap and
stores the result in the specified colormap. The pixel
argument determines the entry in the colormap. The flags
argument determines which of the red, green, and blue compo-
nents are set. You can set this member to the bitwise
inclusive OR of the bits _D_o_R_e_d, _D_o_G_r_e_e_n, and _D_o_B_l_u_e. 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 the specified pixel is not a
valid index into the colormap, a _B_a_d_V_a_l_u_e error results. If
the specified pixel either is unallocated or is allocated
read-only, a _B_a_d_A_c_c_e_s_s error results.
_X_S_t_o_r_e_N_a_m_e_d_C_o_l_o_r can generate _B_a_d_A_c_c_e_s_s, _B_a_d_C_o_l_o_r, _B_a_d_N_a_m_e,
and _B_a_d_V_a_l_u_e errors.
The _X_Q_u_e_r_y_C_o_l_o_r and _X_Q_u_e_r_y_C_o_l_o_r_s functions take pixel values
in the pixel member of _X_C_o_l_o_r structures and store in the
structures the RGB values for those pixels from the speci-
fied colormap. The values returned for an unallocated entry
are undefined. These functions also set the flags member in
the _X_C_o_l_o_r structure to all three colors. If a pixel is not
a valid index into the specified colormap, a _B_a_d_V_a_l_u_e error
results. If more than one pixel is in error, the one that
113399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
gets reported is arbitrary.
To query the RGB value of a single colormap cell, use
_X_Q_u_e_r_y_C_o_l_o_r.
__
││
XQueryColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _d_e_f___i_n___o_u_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XColor *_d_e_f___i_n___o_u_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_d_e_f___i_n___o_u_t
Specifies and returns the RGB values for the pixel
specified in the structure.
││__
The _X_Q_u_e_r_y_C_o_l_o_r function returns the current RGB value for
the pixel in the _X_C_o_l_o_r structure and sets the _D_o_R_e_d,
_D_o_G_r_e_e_n, and _D_o_B_l_u_e flags.
_X_Q_u_e_r_y_C_o_l_o_r can generate _B_a_d_C_o_l_o_r and _B_a_d_V_a_l_u_e errors.
To query the RGB values of multiple colormap cells, use
_X_Q_u_e_r_y_C_o_l_o_r_s.
__
││
XQueryColors(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _d_e_f_s___i_n___o_u_t, _n_c_o_l_o_r_s)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XColor _d_e_f_s___i_n___o_u_t[];
int _n_c_o_l_o_r_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_d_e_f_s___i_n___o_u_t
Specifies and returns an array of color definition
structures for the pixel specified in the struc-
ture.
_n_c_o_l_o_r_s Specifies the number of _X_C_o_l_o_r structures in the
color definition array.
││__
The _X_Q_u_e_r_y_C_o_l_o_r_s function returns the RGB value for each
114400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
pixel in each _X_C_o_l_o_r structure and sets the _D_o_R_e_d, _D_o_G_r_e_e_n,
and _D_o_B_l_u_e flags in each structure.
_X_Q_u_e_r_y_C_o_l_o_r_s can generate _B_a_d_C_o_l_o_r and _B_a_d_V_a_l_u_e errors.
To query the color of a single colormap cell in an arbitrary
format, use _X_c_m_s_Q_u_e_r_y_C_o_l_o_r.
__
││
Status XcmsQueryColor(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r___i_n___o_u_t, _r_e_s_u_l_t___f_o_r_m_a_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XcmsColor *_c_o_l_o_r___i_n___o_u_t;
XcmsColorFormat _r_e_s_u_l_t___f_o_r_m_a_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r___i_n___o_u_t
Specifies the pixel member that indicates the
color cell to query. The color specification
stored for the color cell is returned in this _X_c_m_-
_s_C_o_l_o_r structure.
_r_e_s_u_l_t___f_o_r_m_a_t
Specifies the color format for the returned color
specification.
││__
The _X_c_m_s_Q_u_e_r_y_C_o_l_o_r function obtains the RGB value for the
pixel value in the pixel member of the specified _X_c_m_s_C_o_l_o_r
structure and then converts the value to the target format
as specified by the result_format argument. If the pixel is
not a valid index in the specified colormap, a _B_a_d_V_a_l_u_e
error results.
_X_c_m_s_Q_u_e_r_y_C_o_l_o_r can generate _B_a_d_C_o_l_o_r and _B_a_d_V_a_l_u_e errors.
To query the color of multiple colormap cells in an arbi-
trary format, use _X_c_m_s_Q_u_e_r_y_C_o_l_o_r_s.
114411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsQueryColors(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_o_l_o_r_s___i_n___o_u_t, _n_c_o_l_o_r_s, _r_e_s_u_l_t___f_o_r_m_a_t)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XcmsColor _c_o_l_o_r_s___i_n___o_u_t[];
unsigned int _n_c_o_l_o_r_s;
XcmsColorFormat _r_e_s_u_l_t___f_o_r_m_a_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_o_l_o_r_s___i_n___o_u_t
Specifies an array of _X_c_m_s_C_o_l_o_r structures, each
pixel member indicating the color cell to query.
The color specifications for the color cells are
returned in these structures.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
_r_e_s_u_l_t___f_o_r_m_a_t
Specifies the color format for the returned color
specification.
││__
The _X_c_m_s_Q_u_e_r_y_C_o_l_o_r_s function obtains the RGB values for
pixel values in the pixel members of _X_c_m_s_C_o_l_o_r structures
and then converts the values to the target format as speci-
fied by the result_format argument. If a pixel is not a
valid index into the specified colormap, a _B_a_d_V_a_l_u_e error
results. If more than one pixel is in error, the one that
gets reported is arbitrary.
_X_c_m_s_Q_u_e_r_y_C_o_l_o_r_s can generate _B_a_d_C_o_l_o_r and _B_a_d_V_a_l_u_e errors.
66..88.. CCoolloorr CCoonnvveerrssiioonn CCoonntteexxtt FFuunnccttiioonnss
This section describes functions to create, modify, and
query Color Conversion Contexts (CCCs).
Associated with each colormap is an initial CCC transpar-
ently generated by Xlib. Therefore, when you specify a col-
ormap as an argument to a function, you are indirectly spec-
ifying a CCC. The CCC attributes that can be modified by
the X client are:
· Client White Point
· Gamut compression procedure and client data
· White point adjustment procedure and client data
114422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The initial values for these attributes are implementation
specific. The CCC attributes for subsequently created CCCs
can be defined by changing the CCC attributes of the default
CCC. There is a default CCC associated with each screen.
66..88..11.. GGeettttiinngg aanndd SSeettttiinngg tthhee CCoolloorr CCoonnvveerrssiioonn CCoonntteexxtt ooff
aa CCoolloorrmmaapp
To obtain the CCC associated with a colormap, use _X_c_m_s_C_C_C_O_f_-
_C_o_l_o_r_m_a_p.
__
││
XcmsCCC XcmsCCCOfColormap(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
││__
The _X_c_m_s_C_C_C_O_f_C_o_l_o_r_m_a_p function returns the CCC associated
with the specified colormap. Once obtained, the CCC
attributes can be queried or modified. Unless the CCC asso-
ciated with the specified colormap is changed with _X_c_m_s_S_e_t_C_-
_C_C_O_f_C_o_l_o_r_m_a_p, this CCC is used when the specified colormap
is used as an argument to color functions.
To change the CCC associated with a colormap, use _X_c_m_s_S_e_t_C_C_-
_C_O_f_C_o_l_o_r_m_a_p.
__
││
XcmsCCC XcmsSetCCCOfColormap(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p, _c_c_c)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
XcmsCCC _c_c_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
_c_c_c Specifies the CCC.
││__
The _X_c_m_s_S_e_t_C_C_C_O_f_C_o_l_o_r_m_a_p function changes the CCC associated
with the specified colormap. It returns the CCC previously
associated with the colormap. If they are not used again in
the application, CCCs should be freed by calling _X_c_m_s_-
_F_r_e_e_C_C_C. Several colormaps may share the same CCC without
restriction; this includes the CCCs generated by Xlib with
114433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
each colormap. Xlib, however, creates a new CCC with each
new colormap.
66..88..22.. OObbttaaiinniinngg tthhee DDeeffaauulltt CCoolloorr CCoonnvveerrssiioonn CCoonntteexxtt
You can change the default CCC attributes for subsequently
created CCCs by changing the CCC attributes of the default
CCC. A default CCC is associated with each screen.
To obtain the default CCC for a screen, use _X_c_m_s_D_e_f_a_u_l_t_C_C_C.
__
││
XcmsCCC XcmsDefaultCCC(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
The _X_c_m_s_D_e_f_a_u_l_t_C_C_C function returns the default CCC for the
specified screen. Its visual is the default visual of the
screen. Its initial gamut compression and white point
adjustment procedures as well as the associated client data
are implementation specific.
66..88..33.. CCoolloorr CCoonnvveerrssiioonn CCoonntteexxtt MMaaccrrooss
Applications should not directly modify any part of the _X_c_m_-
_s_C_C_C. The following lists the C language macros, their cor-
responding function equivalents for other language bindings,
and what data they both can return.
__
││
DisplayOfCCC(_c_c_c)
XcmsCCC _c_c_c;
Display *XcmsDisplayOfCCC(_c_c_c)
XcmsCCC _c_c_c;
_c_c_c Specifies the CCC.
││__
Both return the display associated with the specified CCC.
114444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
VisualOfCCC(_c_c_c)
XcmsCCC _c_c_c;
Visual *XcmsVisualOfCCC(_c_c_c)
XcmsCCC _c_c_c;
_c_c_c Specifies the CCC.
││__
Both return the visual associated with the specified CCC.
__
││
ScreenNumberOfCCC(_c_c_c)
XcmsCCC _c_c_c;
int XcmsScreenNumberOfCCC(_c_c_c)
XcmsCCC _c_c_c;
_c_c_c Specifies the CCC.
││__
Both return the number of the screen associated with the
specified CCC.
__
││
ScreenWhitePointOfCCC(_c_c_c)
XcmsCCC _c_c_c;
XcmsColor *XcmsScreenWhitePointOfCCC(_c_c_c)
XcmsCCC _c_c_c;
_c_c_c Specifies the CCC.
││__
Both return the white point of the screen associated with
the specified CCC.
114455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
ClientWhitePointOfCCC(_c_c_c)
XcmsCCC _c_c_c;
XcmsColor *XcmsClientWhitePointOfCCC(_c_c_c)
XcmsCCC _c_c_c;
_c_c_c Specifies the CCC.
││__
Both return the Client White Point of the specified CCC.
66..88..44.. MMooddiiffyyiinngg AAttttrriibbuutteess ooff aa CCoolloorr CCoonnvveerrssiioonn CCoonntteexxtt
To set the Client White Point in the CCC, use _X_c_m_s_S_e_t_W_h_i_t_e_-
_P_o_i_n_t.
__
││
Status XcmsSetWhitePoint(_c_c_c, _c_o_l_o_r)
XcmsCCC _c_c_c;
XcmsColor *_c_o_l_o_r;
_c_c_c Specifies the CCC.
_c_o_l_o_r Specifies the new Client White Point.
││__
The _X_c_m_s_S_e_t_W_h_i_t_e_P_o_i_n_t function changes the Client White
Point in the specified CCC. Note that the pixel member is
ignored and that the color specification is left unchanged
upon return. The format for the new white point must be
_X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t, _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t, _X_c_m_s_C_I_E_x_y_Y_F_o_r_m_a_t, or
_X_c_m_s_U_n_d_e_f_i_n_e_d_F_o_r_m_a_t. If the color argument is NULL, this
function sets the format component of the Client White Point
specification to _X_c_m_s_U_n_d_e_f_i_n_e_d_F_o_r_m_a_t, indicating that the
Client White Point is assumed to be the same as the Screen
White Point.
This function returns nonzero status if the format for the
new white point is valid; otherwise, it returns zero.
To set the gamut compression procedure and corresponding
client data in a specified CCC, use _X_c_m_s_S_e_t_C_o_m_p_r_e_s_s_i_o_n_P_r_o_c.
114466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XcmsCompressionProc XcmsSetCompressionProc(_c_c_c, _c_o_m_p_r_e_s_s_i_o_n___p_r_o_c, _c_l_i_e_n_t___d_a_t_a)
XcmsCCC _c_c_c;
XcmsCompressionProc _c_o_m_p_r_e_s_s_i_o_n___p_r_o_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
_c_c_c Specifies the CCC.
_c_o_m_p_r_e_s_s_i_o_n___p_r_o_c
Specifies the gamut compression procedure that is
to be applied when a color lies outside the
screen's color gamut. If NULL is specified and a
function using this CCC must convert a color spec-
ification to a device-dependent format and encoun-
ters a color that lies outside the screen's color
gamut, that function will return _X_c_m_s_F_a_i_l_u_r_e.
_c_l_i_e_n_t___d_a_t_a
Specifies client data for the gamut compression
procedure or NULL.
││__
The _X_c_m_s_S_e_t_C_o_m_p_r_e_s_s_i_o_n_P_r_o_c function first sets the gamut
compression procedure and client data in the specified CCC
with the newly specified procedure and client data and then
returns the old procedure.
To set the white point adjustment procedure and correspond-
ing client data in a specified CCC, use _X_c_m_s_S_e_t_W_h_i_t_e_A_d_j_u_s_t_-
_P_r_o_c.
__
││ XcmsWhiteAdjustProc XcmsSetWhiteAdjustProc(_c_c_c, _w_h_i_t_e___a_d_j_u_s_t___p_r_o_c, _c_l_i_e_n_t___d_a_t_a)
XcmsCCC _c_c_c;
XcmsWhiteAdjustProc _w_h_i_t_e___a_d_j_u_s_t___p_r_o_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
_c_c_c Specifies the CCC.
_w_h_i_t_e___a_d_j_u_s_t___p_r_o_c
Specifies the white point adjustment procedure.
_c_l_i_e_n_t___d_a_t_a
Specifies client data for the white point adjust-
ment procedure or NULL.
││__
The _X_c_m_s_S_e_t_W_h_i_t_e_A_d_j_u_s_t_P_r_o_c function first sets the white
point adjustment procedure and client data in the specified
CCC with the newly specified procedure and client data and
then returns the old procedure.
114477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
66..88..55.. CCrreeaattiinngg aanndd FFrreeeeiinngg aa CCoolloorr CCoonnvveerrssiioonn CCoonntteexxtt
You can explicitly create a CCC within your application by
calling _X_c_m_s_C_r_e_a_t_e_C_C_C. These created CCCs can then be used
by those functions that explicitly call for a CCC argument.
Old CCCs that will not be used by the application should be
freed using _X_c_m_s_F_r_e_e_C_C_C.
To create a CCC, use _X_c_m_s_C_r_e_a_t_e_C_C_C.
114488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XcmsCCC XcmsCreateCCC(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r, _v_i_s_u_a_l, _c_l_i_e_n_t___w_h_i_t_e___p_o_i_n_t, _c_o_m_p_r_e_s_s_i_o_n___p_r_o_c,
_c_o_m_p_r_e_s_s_i_o_n___c_l_i_e_n_t___d_a_t_a, _w_h_i_t_e___a_d_j_u_s_t___p_r_o_c, _w_h_i_t_e___a_d_j_u_s_t___c_l_i_e_n_t___d_a_t_a)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
Visual *_v_i_s_u_a_l;
XcmsColor *_c_l_i_e_n_t___w_h_i_t_e___p_o_i_n_t;
XcmsCompressionProc _c_o_m_p_r_e_s_s_i_o_n___p_r_o_c;
XPointer _c_o_m_p_r_e_s_s_i_o_n___c_l_i_e_n_t___d_a_t_a;
XcmsWhiteAdjustProc _w_h_i_t_e___a_d_j_u_s_t___p_r_o_c;
XPointer _w_h_i_t_e___a_d_j_u_s_t___c_l_i_e_n_t___d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
_v_i_s_u_a_l Specifies the visual type.
_c_l_i_e_n_t___w_h_i_t_e___p_o_i_n_t
Specifies the Client White Point. If NULL is
specified, the Client White Point is to be assumed
to be the same as the Screen White Point. Note
that the pixel member is ignored.
_c_o_m_p_r_e_s_s_i_o_n___p_r_o_c
Specifies the gamut compression procedure that is
to be applied when a color lies outside the
screen's color gamut. If NULL is specified and a
function using this CCC must convert a color spec-
ification to a device-dependent format and encoun-
ters a color that lies outside the screen's color
gamut, that function will return _X_c_m_s_F_a_i_l_u_r_e.
_c_o_m_p_r_e_s_s_i_o_n___c_l_i_e_n_t___d_a_t_a
Specifies client data for use by the gamut com-
pression procedure or NULL.
_w_h_i_t_e___a_d_j_u_s_t___p_r_o_c
Specifies the white adjustment procedure that is
to be applied when the Client White Point differs
from the Screen White Point. NULL indicates that
no white point adjustment is desired.
_w_h_i_t_e___a_d_j_u_s_t___c_l_i_e_n_t___d_a_t_a
Specifies client data for use with the white point
adjustment procedure or NULL.
││__
The _X_c_m_s_C_r_e_a_t_e_C_C_C function creates a CCC for the specified
display, screen, and visual.
114499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To free a CCC, use _X_c_m_s_F_r_e_e_C_C_C.
__
││
void XcmsFreeCCC(_c_c_c)
XcmsCCC _c_c_c;
_c_c_c Specifies the CCC.
││__
The _X_c_m_s_F_r_e_e_C_C_C function frees the memory used for the spec-
ified CCC. Note that default CCCs and those currently asso-
ciated with colormaps are ignored.
66..99.. CCoonnvveerrttiinngg bbeettwweeeenn CCoolloorr SSppaacceess
To convert an array of color specifications in arbitrary
color formats to a single destination format, use _X_c_m_s_C_o_n_-
_v_e_r_t_C_o_l_o_r_s.
115500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsConvertColors(_c_c_c, _c_o_l_o_r_s___i_n___o_u_t, _n_c_o_l_o_r_s, _t_a_r_g_e_t___f_o_r_m_a_t, _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColor _c_o_l_o_r_s___i_n___o_u_t[];
unsigned int _n_c_o_l_o_r_s;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
Bool _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n[];
_c_c_c Specifies the CCC. If conversion is between
device-independent color spaces only (for example,
TekHVC to CIELuv), the CCC is necessary only to
specify the Client White Point.
_c_o_l_o_r_s___i_n___o_u_t
Specifies an array of color specifications. Pixel
members are ignored and remain unchanged upon
return.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n
Returns an array of Boolean values indicating com-
pression status. If a non-NULL pointer is sup-
plied, each element of the array is set to _T_r_u_e if
the corresponding color was compressed and _F_a_l_s_e
otherwise. Pass NULL if the compression status is
not useful.
││__
The _X_c_m_s_C_o_n_v_e_r_t_C_o_l_o_r_s function converts the color specifica-
tions in the specified array of _X_c_m_s_C_o_l_o_r structures from
their current format to a single target format, using the
specified CCC. When the return value is _X_c_m_s_F_a_i_l_u_r_e, the
contents of the color specification array are left
unchanged.
The array may contain a mixture of color specification for-
mats (for example, 3 CIE XYZ, 2 CIE Luv, and so on). When
the array contains both device-independent and device-depen-
dent color specifications and the target_format argument
specifies a device-dependent format (for example, _X_c_m_s_R_G_B_i_-
_F_o_r_m_a_t, _X_c_m_s_R_G_B_F_o_r_m_a_t), all specifications are converted to
CIE XYZ format and then to the target device-dependent for-
mat.
66..1100.. CCaallllbbaacckk FFuunnccttiioonnss
This section describes the gamut compression and white point
adjustment callbacks.
115511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The gamut compression procedure specified in the CCC is
called when an attempt to convert a color specification from
_X_c_m_s_C_I_E_X_Y_Z to a device-dependent format (typically _X_c_m_s_R_G_B_i)
results in a color that lies outside the screen's color
gamut. If the gamut compression procedure requires client
data, this data is passed via the gamut compression client
data in the CCC.
During color specification conversion between device-inde-
pendent and device-dependent color spaces, if a white point
adjustment procedure is specified in the CCC, it is trig-
gered when the Client White Point and Screen White Point
differ. If required, the client data is obtained from the
CCC.
66..1100..11.. PPrroottoottyyppee GGaammuutt CCoommpprreessssiioonn PPrroocceedduurree
The gamut compression callback interface must adhere to the
following:
115522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef Status (*XcmsCompressionProc)(_c_c_c, _c_o_l_o_r_s___i_n___o_u_t, _n_c_o_l_o_r_s, _i_n_d_e_x, _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColor _c_o_l_o_r_s___i_n___o_u_t_[_];
unsigned int _n_c_o_l_o_r_s;
unsigned int _i_n_d_e_x;
Bool _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n_[_];
_c_c_c Specifies the CCC.
_c_o_l_o_r_s___i_n___o_u_t
Specifies an array of color specifications. Pixel
members should be ignored and must remain
unchanged upon return.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
_i_n_d_e_x Specifies the index into the array of _X_c_m_s_C_o_l_o_r
structures for the encountered color specification
that lies outside the screen's color gamut. Valid
values are 0 (for the first element) to ncolors -
1.
_c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n
Returns an array of Boolean values for indicating
compression status. If a non-NULL pointer is sup-
plied and a color at a given index is compressed,
then _T_r_u_e should be stored at the corresponding
index in this array; otherwise, the array should
not be modified.
││__
When implementing a gamut compression procedure, consider
the following rules and assumptions:
· The gamut compression procedure can attempt to compress
one or multiple specifications at a time.
· When called, elements 0 to index - 1 in the color spec-
ification array can be assumed to fall within the
screen's color gamut. In addition, these color speci-
fications are already in some device-dependent format
(typically _X_c_m_s_R_G_B_i). If any modifications are made to
these color specifications, they must be in their ini-
tial device-dependent format upon return.
· When called, the element in the color specification
array specified by the index argument contains the
color specification outside the screen's color gamut
encountered by the calling routine. In addition, this
color specification can be assumed to be in _X_c_m_s_C_I_E_X_Y_Z.
Upon return, this color specification must be in
115533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_c_m_s_C_I_E_X_Y_Z.
· When called, elements from index to ncolors - 1 in the
color specification array may or may not fall within
the screen's color gamut. In addition, these color
specifications can be assumed to be in _X_c_m_s_C_I_E_X_Y_Z. If
any modifications are made to these color specifica-
tions, they must be in _X_c_m_s_C_I_E_X_Y_Z upon return.
· The color specifications passed to the gamut compres-
sion procedure have already been adjusted to the Screen
White Point. This means that at this point the color
specification's white point is the Screen White Point.
· If the gamut compression procedure uses a device-inde-
pendent color space not initially accessible for use in
the color management system, use _X_c_m_s_A_d_d_C_o_l_o_r_S_p_a_c_e to
ensure that it is added.
66..1100..22.. SSuupppplliieedd GGaammuutt CCoommpprreessssiioonn PPrroocceedduurreess
The following equations are useful in describing gamut com-
pression functions:
_C_I_E_L_a_b_P_s_y_c_h_o_m_e_t_r_i_c_C_h_r_o_m_a=_s_q_r_t(_a__s_t_a_r2+_b__s_t_a_r2)
_C_I_E_L_a_b_P_s_y_c_h_o_m_e_t_r_i_c_H_u_e=tan-1[_b_a_______s_s___t_t___a_a___r_r__]
_C_I_E_L_u_v_P_s_y_c_h_o_m_e_t_r_i_c_C_h_r_o_m_a=_s_q_r_t(_u__s_t_a_r2+_v__s_t_a_r2)
_C_I_E_L_u_v_P_s_y_c_h_o_m_e_t_r_i_c_H_u_e=tan-1[_v_u_______s_s___t_t___a_a___r_r__]
The gamut compression callback procedures provided by Xlib
are as follows:
· _X_c_m_s_C_I_E_L_a_b_C_l_i_p_L
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by reducing or
increasing CIE metric lightness (L*) in the CIE L*a*b*
color space until the color is within the gamut. If
the Psychometric Chroma of the color specification is
beyond maximum for the Psychometric Hue Angle, then
while maintaining the same Psychometric Hue Angle, the
color will be clipped to the CIE L*a*b* coordinates of
maximum Psychometric Chroma. See _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_a_x_C.
No client data is necessary.
· _X_c_m_s_C_I_E_L_a_b_C_l_i_p_a_b
115544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by reducing Psy-
chometric Chroma, while maintaining Psychometric Hue
Angle, until the color is within the gamut. No client
data is necessary.
· _X_c_m_s_C_I_E_L_a_b_C_l_i_p_L_a_b
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by replacing it
with CIE L*a*b* coordinates that fall within the color
gamut while maintaining the original Psychometric Hue
Angle and whose vector to the original coordinates is
the shortest attainable. No client data is necessary.
· _X_c_m_s_C_I_E_L_u_v_C_l_i_p_L
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by reducing or
increasing CIE metric lightness (L*) in the CIE L*u*v*
color space until the color is within the gamut. If
the Psychometric Chroma of the color specification is
beyond maximum for the Psychometric Hue Angle, then,
while maintaining the same Psychometric Hue Angle, the
color will be clipped to the CIE L*u*v* coordinates of
maximum Psychometric Chroma. See _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_a_x_C.
No client data is necessary.
· _X_c_m_s_C_I_E_L_u_v_C_l_i_p_u_v
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by reducing Psy-
chometric Chroma, while maintaining Psychometric Hue
Angle, until the color is within the gamut. No client
data is necessary.
· _X_c_m_s_C_I_E_L_u_v_C_l_i_p_L_u_v
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by replacing it
with CIE L*u*v* coordinates that fall within the color
gamut while maintaining the original Psychometric Hue
Angle and whose vector to the original coordinates is
the shortest attainable. No client data is necessary.
· _X_c_m_s_T_e_k_H_V_C_C_l_i_p_V
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by reducing or
increasing the Value dimension in the TekHVC color
space until the color is within the gamut. If Chroma
of the color specification is beyond maximum for the
particular Hue, then, while maintaining the same Hue,
the color will be clipped to the Value and Chroma
115555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
coordinates that represent maximum Chroma for that par-
ticular Hue. No client data is necessary.
· _X_c_m_s_T_e_k_H_V_C_C_l_i_p_C
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by reducing the
Chroma dimension in the TekHVC color space until the
color is within the gamut. No client data is neces-
sary.
· _X_c_m_s_T_e_k_H_V_C_C_l_i_p_V_C
This brings the encountered out-of-gamut color specifi-
cation into the screen's color gamut by replacing it
with TekHVC coordinates that fall within the color
gamut while maintaining the original Hue and whose vec-
tor to the original coordinates is the shortest attain-
able. No client data is necessary.
66..1100..33.. PPrroottoottyyppee WWhhiittee PPooiinntt AAddjjuussttmmeenntt PPrroocceedduurree
The white point adjustment procedure interface must adhere
to the following:
115566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef Status (*XcmsWhiteAdjustProc)(_c_c_c, _i_n_i_t_i_a_l___w_h_i_t_e___p_o_i_n_t, _t_a_r_g_e_t___w_h_i_t_e___p_o_i_n_t, _t_a_r_g_e_t___f_o_r_m_a_t,
_c_o_l_o_r_s___i_n___o_u_t, _n_c_o_l_o_r_s, _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColor *_i_n_i_t_i_a_l___w_h_i_t_e___p_o_i_n_t;
XcmsColor *_t_a_r_g_e_t___w_h_i_t_e___p_o_i_n_t;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
XcmsColor _c_o_l_o_r_s___i_n___o_u_t_[_];
unsigned int _n_c_o_l_o_r_s;
Bool _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n_[_];
_c_c_c Specifies the CCC.
_i_n_i_t_i_a_l___w_h_i_t_e___p_o_i_n_t
Specifies the initial white point.
_t_a_r_g_e_t___w_h_i_t_e___p_o_i_n_t
Specifies the target white point.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_l_o_r_s___i_n___o_u_t
Specifies an array of color specifications. Pixel
members should be ignored and must remain
unchanged upon return.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
_c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n
Returns an array of Boolean values for indicating
compression status. If a non-NULL pointer is sup-
plied and a color at a given index is compressed,
then _T_r_u_e should be stored at the corresponding
index in this array; otherwise, the array should
not be modified.
││__
66..1100..44.. SSuupppplliieedd WWhhiittee PPooiinntt AAddjjuussttmmeenntt PPrroocceedduurreess
White point adjustment procedures provided by Xlib are as
follows:
· _X_c_m_s_C_I_E_L_a_b_W_h_i_t_e_S_h_i_f_t_C_o_l_o_r_s
This uses the CIE L*a*b* color space for adjusting the
chromatic character of colors to compensate for the
chromatic differences between the source and destina-
tion white points. This procedure simply converts the
color specifications to _X_c_m_s_C_I_E_L_a_b using the source
white point and then converts to the target
115577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
specification format using the destination's white
point. No client data is necessary.
· _X_c_m_s_C_I_E_L_u_v_W_h_i_t_e_S_h_i_f_t_C_o_l_o_r_s
This uses the CIE L*u*v* color space for adjusting the
chromatic character of colors to compensate for the
chromatic differences between the source and destina-
tion white points. This procedure simply converts the
color specifications to _X_c_m_s_C_I_E_L_u_v using the source
white point and then converts to the target specifica-
tion format using the destination's white point. No
client data is necessary.
· _X_c_m_s_T_e_k_H_V_C_W_h_i_t_e_S_h_i_f_t_C_o_l_o_r_s
This uses the TekHVC color space for adjusting the
chromatic character of colors to compensate for the
chromatic differences between the source and destina-
tion white points. This procedure simply converts the
color specifications to _X_c_m_s_T_e_k_H_V_C using the source
white point and then converts to the target specifica-
tion format using the destination's white point. An
advantage of this procedure over those previously
described is an attempt to minimize hue shift. No
client data is necessary.
From an implementation point of view, these white point
adjustment procedures convert the color specifications to a
device-independent but white-point-dependent color space
(for example, CIE L*u*v*, CIE L*a*b*, TekHVC) using one
white point and then converting those specifications to the
target color space using another white point. In other
words, the specification goes in the color space with one
white point but comes out with another white point, result-
ing in a chromatic shift based on the chromatic displacement
between the initial white point and target white point. The
CIE color spaces that are assumed to be white-point-indepen-
dent are CIE u'v'Y, CIE XYZ, and CIE xyY. When developing a
custom white point adjustment procedure that uses a device-
independent color space not initially accessible for use in
the color management system, use _X_c_m_s_A_d_d_C_o_l_o_r_S_p_a_c_e to ensure
that it is added.
As an example, if the CCC specifies a white point adjustment
procedure and if the Client White Point and Screen White
Point differ, the _X_c_m_s_A_l_l_o_c_C_o_l_o_r function will use the white
point adjustment procedure twice:
· Once to convert to _X_c_m_s_R_G_B
· A second time to convert from _X_c_m_s_R_G_B
115588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
For example, assume the specification is in _X_c_m_s_C_I_E_u_v_Y and
the adjustment procedure is _X_c_m_s_C_I_E_L_u_v_W_h_i_t_e_S_h_i_f_t_C_o_l_o_r_s.
During conversion to _X_c_m_s_R_G_B, the call to _X_c_m_s_A_l_l_o_c_C_o_l_o_r
results in the following series of color specification con-
versions:
· From _X_c_m_s_C_I_E_u_v_Y to _X_c_m_s_C_I_E_L_u_v using the Client White
Point
· From _X_c_m_s_C_I_E_L_u_v to _X_c_m_s_C_I_E_u_v_Y using the Screen White
Point
· From _X_c_m_s_C_I_E_u_v_Y to _X_c_m_s_C_I_E_X_Y_Z (CIE u'v'Y and XYZ are
white-point-independent color spaces)
· From _X_c_m_s_C_I_E_X_Y_Z to _X_c_m_s_R_G_B_i
· From _X_c_m_s_R_G_B_i to _X_c_m_s_R_G_B
The resulting RGB specification is passed to _X_A_l_l_o_c_C_o_l_o_r,
and the RGB specification returned by _X_A_l_l_o_c_C_o_l_o_r is con-
verted back to _X_c_m_s_C_I_E_u_v_Y by reversing the color conversion
sequence.
66..1111.. GGaammuutt QQuueerryyiinngg FFuunnccttiioonnss
This section describes the gamut querying functions that
Xlib provides. These functions allow the client to query
the boundary of the screen's color gamut in terms of the CIE
L*a*b*, CIE L*u*v*, and TekHVC color spaces. Functions are
also provided that allow you to query the color specifica-
tion of:
· White (full-intensity red, green, and blue)
· Red (full-intensity red while green and blue are zero)
· Green (full-intensity green while red and blue are
zero)
· Blue (full-intensity blue while red and green are zero)
· Black (zero-intensity red, green, and blue)
The white point associated with color specifications passed
to and returned from these gamut querying functions is
assumed to be the Screen White Point. This is a reasonable
assumption, because the client is trying to query the
screen's color gamut.
The following naming convention is used for the Max and Min
functions:
115599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Xcms_<_c_o_l_o_r___s_p_a_c_e_>QueryMax_<_d_i_m_e_n_s_i_o_n_s_>
Xcms_<_c_o_l_o_r___s_p_a_c_e_>QueryMin_<_d_i_m_e_n_s_i_o_n_s_>
The <dimensions> consists of a letter or letters that iden-
tify the dimensions of the color space that are not fixed.
For example, _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_C is given a fixed Hue and
Value for which maximum Chroma is found.
66..1111..11.. RReedd,, GGrreeeenn,, aanndd BBlluuee QQuueerriieess
To obtain the color specification for black (zero-intensity
red, green, and blue), use _X_c_m_s_Q_u_e_r_y_B_l_a_c_k.
__
││
Status XcmsQueryBlack(_c_c_c, _t_a_r_g_e_t___f_o_r_m_a_t, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in the specified
target format for zero-intensity red, green, and
blue. The white point associated with the
returned color specification is the Screen White
Point. The value returned in the pixel member is
undefined.
││__
The _X_c_m_s_Q_u_e_r_y_B_l_a_c_k function returns the color specification
in the specified target format for zero-intensity red,
green, and blue.
To obtain the color specification for blue (full-intensity
blue while red and green are zero), use _X_c_m_s_Q_u_e_r_y_B_l_u_e.
116600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsQueryBlue(_c_c_c, _t_a_r_g_e_t___f_o_r_m_a_t, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in the specified
target format for full-intensity blue while red
and green are zero. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_Q_u_e_r_y_B_l_u_e function returns the color specification
in the specified target format for full-intensity blue while
red and green are zero.
To obtain the color specification for green (full-intensity
green while red and blue are zero), use _X_c_m_s_Q_u_e_r_y_G_r_e_e_n.
__
││
Status XcmsQueryGreen(_c_c_c, _t_a_r_g_e_t___f_o_r_m_a_t, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in the specified
target format for full-intensity green while red
and blue are zero. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_Q_u_e_r_y_G_r_e_e_n function returns the color specification
in the specified target format for full-intensity green
116611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
while red and blue are zero.
To obtain the color specification for red (full-intensity
red while green and blue are zero), use _X_c_m_s_Q_u_e_r_y_R_e_d.
__
││
Status XcmsQueryRed(_c_c_c, _t_a_r_g_e_t___f_o_r_m_a_t, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in the specified
target format for full-intensity red while green
and blue are zero. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_Q_u_e_r_y_R_e_d function returns the color specification in
the specified target format for full-intensity red while
green and blue are zero.
To obtain the color specification for white (full-intensity
red, green, and blue), use _X_c_m_s_Q_u_e_r_y_W_h_i_t_e.
116622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsQueryWhite(_c_c_c, _t_a_r_g_e_t___f_o_r_m_a_t, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColorFormat _t_a_r_g_e_t___f_o_r_m_a_t;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_t_a_r_g_e_t___f_o_r_m_a_t
Specifies the target color specification format.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in the specified
target format for full-intensity red, green, and
blue. The white point associated with the
returned color specification is the Screen White
Point. The value returned in the pixel member is
undefined.
││__
The _X_c_m_s_Q_u_e_r_y_W_h_i_t_e function returns the color specification
in the specified target format for full-intensity red,
green, and blue.
66..1111..22.. CCIIEELLaabb QQuueerriieess
The following equations are useful in describing the CIELab
query functions:
_C_I_E_L_a_b_P_s_y_c_h_o_m_e_t_r_i_c_C_h_r_o_m_a=_s_q_r_t(_a__s_t_a_r2+_b__s_t_a_r2)
_C_I_E_L_a_b_P_s_y_c_h_o_m_e_t_r_i_c_H_u_e=tan-1[_b_a_______s_s___t_t___a_a___r_r__]
To obtain the CIE L*a*b* coordinates of maximum Psychometric
Chroma for a given Psychometric Hue Angle and CIE metric
lightness (L*), use _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_a_x_C.
116633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELabQueryMaxC(_c_c_c, _h_u_e___a_n_g_l_e, _L___s_t_a_r, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsFloat _L___s_t_a_r;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find maximum chroma.
_L___s_t_a_r Specifies the lightness (L*) at which to find max-
imum chroma.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*a*b* coordinates of maximum
chroma displayable by the screen for the given hue
angle and lightness. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_a_x_C function, given a hue angle and
lightness, finds the point of maximum chroma displayable by
the screen. It returns this point in CIE L*a*b* coordi-
nates.
To obtain the CIE L*a*b* coordinates of maximum CIE metric
lightness (L*) for a given Psychometric Hue Angle and Psy-
chometric Chroma, use _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_a_x_L.
116644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELabQueryMaxL(_c_c_c, _h_u_e___a_n_g_l_e, _c_h_r_o_m_a, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsFloat _c_h_r_o_m_a;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find maximum lightness.
_c_h_r_o_m_a Specifies the chroma at which to find maximum
lightness.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*a*b* coordinates of maximum
lightness displayable by the screen for the given
hue angle and chroma. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_a_x_L function, given a hue angle and
chroma, finds the point in CIE L*a*b* color space of maximum
lightness (L*) displayable by the screen. It returns this
point in CIE L*a*b* coordinates. An _X_c_m_s_F_a_i_l_u_r_e return
value usually indicates that the given chroma is beyond max-
imum for the given hue angle.
To obtain the CIE L*a*b* coordinates of maximum Psychometric
Chroma for a given Psychometric Hue Angle, use _X_c_m_s_C_I_E_L_a_b_-
_Q_u_e_r_y_M_a_x_L_C.
116655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELabQueryMaxLC(_c_c_c, _h_u_e___a_n_g_l_e, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find maximum chroma.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*a*b* coordinates of maximum
chroma displayable by the screen for the given hue
angle. The white point associated with the
returned color specification is the Screen White
Point. The value returned in the pixel member is
undefined.
││__
The _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_a_x_L_C function, given a hue angle, finds
the point of maximum chroma displayable by the screen. It
returns this point in CIE L*a*b* coordinates.
To obtain the CIE L*a*b* coordinates of minimum CIE metric
lightness (L*) for a given Psychometric Hue Angle and Psy-
chometric Chroma, use _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_i_n_L.
116666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELabQueryMinL(_c_c_c, _h_u_e___a_n_g_l_e, _c_h_r_o_m_a, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsFloat _c_h_r_o_m_a;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find minimum lightness.
_c_h_r_o_m_a Specifies the chroma at which to find minimum
lightness.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*a*b* coordinates of minimum
lightness displayable by the screen for the given
hue angle and chroma. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_C_I_E_L_a_b_Q_u_e_r_y_M_i_n_L function, given a hue angle and
chroma, finds the point of minimum lightness (L*) dis-
playable by the screen. It returns this point in CIE L*a*b*
coordinates. An _X_c_m_s_F_a_i_l_u_r_e return value usually indicates
that the given chroma is beyond maximum for the given hue
angle.
66..1111..33.. CCIIEELLuuvv QQuueerriieess
The following equations are useful in describing the CIELuv
query functions:
_C_I_E_L_u_v_P_s_y_c_h_o_m_e_t_r_i_c_C_h_r_o_m_a=_s_q_r_t(_u__s_t_a_r2+_v__s_t_a_r2)
_C_I_E_L_u_v_P_s_y_c_h_o_m_e_t_r_i_c_H_u_e=tan-1[_v_u_______s_s___t_t___a_a___r_r__]
To obtain the CIE L*u*v* coordinates of maximum Psychometric
Chroma for a given Psychometric Hue Angle and CIE metric
lightness (L*), use _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_a_x_C.
116677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELuvQueryMaxC(_c_c_c, _h_u_e___a_n_g_l_e, _L___s_t_a_r, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsFloat _L___s_t_a_r;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find maximum chroma.
_L___s_t_a_r Specifies the lightness (L*) at which to find max-
imum chroma.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*u*v* coordinates of maximum
chroma displayable by the screen for the given hue
angle and lightness. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_a_x_C function, given a hue angle and
lightness, finds the point of maximum chroma displayable by
the screen. It returns this point in CIE L*u*v* coordi-
nates.
To obtain the CIE L*u*v* coordinates of maximum CIE metric
lightness (L*) for a given Psychometric Hue Angle and Psy-
chometric Chroma, use _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_a_x_L.
116688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELuvQueryMaxL(_c_c_c, _h_u_e___a_n_g_l_e, _c_h_r_o_m_a, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsFloat _c_h_r_o_m_a;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find maximum lightness.
_L___s_t_a_r Specifies the lightness (L*) at which to find max-
imum lightness.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*u*v* coordinates of maximum
lightness displayable by the screen for the given
hue angle and chroma. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_a_x_L function, given a hue angle and
chroma, finds the point in CIE L*u*v* color space of maximum
lightness (L*) displayable by the screen. It returns this
point in CIE L*u*v* coordinates. An _X_c_m_s_F_a_i_l_u_r_e return
value usually indicates that the given chroma is beyond max-
imum for the given hue angle.
To obtain the CIE L*u*v* coordinates of maximum Psychometric
Chroma for a given Psychometric Hue Angle, use _X_c_m_s_C_I_E_L_u_v_-
_Q_u_e_r_y_M_a_x_L_C.
116699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELuvQueryMaxLC(_c_c_c, _h_u_e___a_n_g_l_e, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find maximum chroma.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*u*v* coordinates of maximum
chroma displayable by the screen for the given hue
angle. The white point associated with the
returned color specification is the Screen White
Point. The value returned in the pixel member is
undefined.
││__
The _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_a_x_L_C function, given a hue angle, finds
the point of maximum chroma displayable by the screen. It
returns this point in CIE L*u*v* coordinates.
To obtain the CIE L*u*v* coordinates of minimum CIE metric
lightness (L*) for a given Psychometric Hue Angle and Psy-
chometric Chroma, use _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_i_n_L.
117700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsCIELuvQueryMinL(_c_c_c, _h_u_e___a_n_g_l_e, _c_h_r_o_m_a, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e___a_n_g_l_e;
XcmsFloat _c_h_r_o_m_a;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e___a_n_g_l_e Specifies the hue angle (in degrees) at which to
find minimum lightness.
_c_h_r_o_m_a Specifies the chroma at which to find minimum
lightness.
_c_o_l_o_r___r_e_t_u_r_n
Returns the CIE L*u*v* coordinates of minimum
lightness displayable by the screen for the given
hue angle and chroma. The white point associated
with the returned color specification is the
Screen White Point. The value returned in the
pixel member is undefined.
││__
The _X_c_m_s_C_I_E_L_u_v_Q_u_e_r_y_M_i_n_L function, given a hue angle and
chroma, finds the point of minimum lightness (L*) dis-
playable by the screen. It returns this point in CIE L*u*v*
coordinates. An _X_c_m_s_F_a_i_l_u_r_e return value usually indicates
that the given chroma is beyond maximum for the given hue
angle.
66..1111..44.. TTeekkHHVVCC QQuueerriieess
To obtain the maximum Chroma for a given Hue and Value, use
_X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_C.
117711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsTekHVCQueryMaxC(_c_c_c, _h_u_e, _v_a_l_u_e, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e;
XcmsFloat _v_a_l_u_e;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e Specifies the Hue in which to find the maximum
Chroma.
_v_a_l_u_e Specifies the Value in which to find the maximum
Chroma.
_c_o_l_o_r___r_e_t_u_r_n
Returns the maximum Chroma along with the actual
Hue and Value at which the maximum Chroma was
found. The white point associated with the
returned color specification is the Screen White
Point. The value returned in the pixel member is
undefined.
││__
The _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_C function, given a Hue and Value,
determines the maximum Chroma in TekHVC color space dis-
playable by the screen. It returns the maximum Chroma along
with the actual Hue and Value at which the maximum Chroma
was found.
To obtain the maximum Value for a given Hue and Chroma, use
_X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_V.
117722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsTekHVCQueryMaxV(_c_c_c, _h_u_e, _c_h_r_o_m_a, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e;
XcmsFloat _c_h_r_o_m_a;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e Specifies the Hue in which to find the maximum
Value.
_c_h_r_o_m_a Specifies the chroma at which to find maximum
Value.
_c_o_l_o_r___r_e_t_u_r_n
Returns the maximum Value along with the Hue and
Chroma at which the maximum Value was found. The
white point associated with the returned color
specification is the Screen White Point. The
value returned in the pixel member is undefined.
││__
The _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_V function, given a Hue and Chroma,
determines the maximum Value in TekHVC color space dis-
playable by the screen. It returns the maximum Value and
the actual Hue and Chroma at which the maximum Value was
found.
To obtain the maximum Chroma and Value at which it is
reached for a specified Hue, use _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_V_C.
117733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsTekHVCQueryMaxVC(_c_c_c, _h_u_e, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e Specifies the Hue in which to find the maximum
Chroma.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in XcmsTekHVC for
the maximum Chroma, the Value at which that maxi-
mum Chroma is reached, and the actual Hue at which
the maximum Chroma was found. The white point
associated with the returned color specification
is the Screen White Point. The value returned in
the pixel member is undefined.
││__
The _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_V_C function, given a Hue, determines
the maximum Chroma in TekHVC color space displayable by the
screen and the Value at which that maximum Chroma is
reached. It returns the maximum Chroma, the Value at which
that maximum Chroma is reached, and the actual Hue for which
the maximum Chroma was found.
To obtain a specified number of TekHVC specifications such
that they contain maximum Values for a specified Hue and the
Chroma at which the maximum Values are reached, use _X_c_m_-
_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_V_S_a_m_p_l_e_s.
117744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsTekHVCQueryMaxVSamples(_c_c_c, _h_u_e, _c_o_l_o_r_s___r_e_t_u_r_n, _n_s_a_m_p_l_e_s)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e;
XcmsColor _c_o_l_o_r_s___r_e_t_u_r_n_[_];
unsigned int _n_s_a_m_p_l_e_s;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e Specifies the Hue for maximum Chroma/Value sam-
ples.
_n_s_a_m_p_l_e_s Specifies the number of samples.
_c_o_l_o_r_s___r_e_t_u_r_n
Returns nsamples of color specifications in Xcm-
sTekHVC such that the Chroma is the maximum
attainable for the Value and Hue. The white point
associated with the returned color specification
is the Screen White Point. The value returned in
the pixel member is undefined.
││__
The _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_a_x_V_S_a_m_p_l_e_s returns nsamples of maximum
Value, the Chroma at which that maximum Value is reached,
and the actual Hue for which the maximum Chroma was found.
These sample points may then be used to plot the maximum
Value/Chroma boundary of the screen's color gamut for the
specified Hue in TekHVC color space.
To obtain the minimum Value for a given Hue and Chroma, use
_X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_i_n_V.
117755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XcmsTekHVCQueryMinV(_c_c_c, _h_u_e, _c_h_r_o_m_a, _c_o_l_o_r___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsFloat _h_u_e;
XcmsFloat _c_h_r_o_m_a;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_c_c Specifies the CCC. The CCC's Client White Point
and white point adjustment procedures are ignored.
_h_u_e Specifies the Hue in which to find the minimum
Value.
_v_a_l_u_e Specifies the Value in which to find the minimum
Value.
_c_o_l_o_r___r_e_t_u_r_n
Returns the minimum Value and the actual Hue and
Chroma at which the minimum Value was found. The
white point associated with the returned color
specification is the Screen White Point. The
value returned in the pixel member is undefined.
││__
The _X_c_m_s_T_e_k_H_V_C_Q_u_e_r_y_M_i_n_V function, given a Hue and Chroma,
determines the minimum Value in TekHVC color space dis-
playable by the screen. It returns the minimum Value and
the actual Hue and Chroma at which the minimum Value was
found.
66..1122.. CCoolloorr MMaannaaggeemmeenntt EExxtteennssiioonnss
The Xlib color management facilities can be extended in two
ways:
· Device-Independent Color Spaces
Device-independent color spaces that are derivable to
CIE XYZ space can be added using the _X_c_m_s_A_d_d_C_o_l_o_r_S_p_a_c_e
function.
· Color Characterization Function Set
A Color Characterization Function Set consists of
device-dependent color spaces and their functions that
convert between these color spaces and the CIE XYZ
color space, bundled together for a specific class of
output devices. A function set can be added using the
_X_c_m_s_A_d_d_F_u_n_c_t_i_o_n_S_e_t function.
117766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
66..1122..11.. CCoolloorr SSppaacceess
The CIE XYZ color space serves as the hub for all conver-
sions between device-independent and device-dependent color
spaces. Therefore, the knowledge to convert an _X_c_m_s_C_o_l_o_r
structure to and from CIE XYZ format is associated with each
color space. For example, conversion from CIE L*u*v* to RGB
requires the knowledge to convert from CIE L*u*v* to CIE XYZ
and from CIE XYZ to RGB. This knowledge is stored as an
array of functions that, when applied in series, will con-
vert the _X_c_m_s_C_o_l_o_r structure to or from CIE XYZ format.
This color specification conversion mechanism facilitates
the addition of color spaces.
Of course, when converting between only device-independent
color spaces or only device-dependent color spaces, short-
cuts are taken whenever possible. For example, conversion
from TekHVC to CIE L*u*v* is performed by intermediate con-
version to CIE u*v*Y and then to CIE L*u*v*, thus bypassing
conversion between CIE u*v*Y and CIE XYZ.
66..1122..22.. AAddddiinngg DDeevviiccee--IInnddeeppeennddeenntt CCoolloorr SSppaacceess
To add a device-independent color space, use _X_c_m_s_A_d_d_C_o_l_-
_o_r_S_p_a_c_e.
__
││
Status XcmsAddColorSpace(_c_o_l_o_r___s_p_a_c_e)
XcmsColorSpace *_c_o_l_o_r___s_p_a_c_e;
_c_o_l_o_r___s_p_a_c_e
Specifies the device-independent color space to
add.
││__
The _X_c_m_s_A_d_d_C_o_l_o_r_S_p_a_c_e function makes a device-independent
color space (actually an _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure) accessi-
ble by the color management system. Because format values
for unregistered color spaces are assigned at run time, they
should be treated as private to the client. If references
to an unregistered color space must be made outside the
client (for example, storing color specifications in a file
using the unregistered color space), then reference should
be made by color space prefix (see _X_c_m_s_F_o_r_m_a_t_O_f_P_r_e_f_i_x and
_X_c_m_s_P_r_e_f_i_x_O_f_F_o_r_m_a_t).
If the _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure is already accessible in the
color management system, _X_c_m_s_A_d_d_C_o_l_o_r_S_p_a_c_e returns _X_c_m_s_S_u_c_-
_c_e_s_s.
Note that added _X_c_m_s_C_o_l_o_r_S_p_a_c_e_s must be retained for refer-
ence by Xlib.
117777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
66..1122..33.. QQuueerryyiinngg CCoolloorr SSppaaccee FFoorrmmaatt aanndd PPrreeffiixx
To obtain the format associated with the color space associ-
ated with a specified color string prefix, use _X_c_m_s_F_o_r_m_a_t_O_f_-
_P_r_e_f_i_x.
__
││
XcmsColorFormat XcmsFormatOfPrefix(_p_r_e_f_i_x)
char *_p_r_e_f_i_x;
_p_r_e_f_i_x Specifies the string that contains the color space
prefix.
││__
The _X_c_m_s_F_o_r_m_a_t_O_f_P_r_e_f_i_x function returns the format for the
specified color space prefix (for example, the string
``CIEXYZ''). The prefix is case-insensitive. If the color
space is not accessible in the color management system,
_X_c_m_s_F_o_r_m_a_t_O_f_P_r_e_f_i_x returns _X_c_m_s_U_n_d_e_f_i_n_e_d_F_o_r_m_a_t.
To obtain the color string prefix associated with the color
space specified by a color format, use _X_c_m_s_P_r_e_f_i_x_O_f_F_o_r_m_a_t.
__
││
char *XcmsPrefixOfFormat(_f_o_r_m_a_t)
XcmsColorFormat _f_o_r_m_a_t;
_f_o_r_m_a_t Specifies the color specification format.
││__
The _X_c_m_s_P_r_e_f_i_x_O_f_F_o_r_m_a_t function returns the string prefix
associated with the color specification encoding specified
by the format argument. Otherwise, if no encoding is found,
it returns NULL. The returned string must be treated as
read-only.
66..1122..44.. CCrreeaattiinngg AAddddiittiioonnaall CCoolloorr SSppaacceess
Color space specific information necessary for color space
conversion and color string parsing is stored in an _X_c_m_s_C_o_l_-
_o_r_S_p_a_c_e structure. Therefore, a new structure containing
this information is required for each additional color
space. In the case of device-independent color spaces, a
handle to this new structure (that is, by means of a global
variable) is usually made accessible to the client program
for use with the _X_c_m_s_A_d_d_C_o_l_o_r_S_p_a_c_e function.
If a new _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure specifies a color space
not registered with the X Consortium, they should be treated
as private to the client because format values for unregis-
tered color spaces are assigned at run time. If references
117788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
to an unregistered color space must be made outside the
client (for example, storing color specifications in a file
using the unregistered color space), then reference should
be made by color space prefix (see _X_c_m_s_F_o_r_m_a_t_O_f_P_r_e_f_i_x and
_X_c_m_s_P_r_e_f_i_x_O_f_F_o_r_m_a_t).
__
││
typedef (*XcmsConversionProc)();
typedef XcmsConversionProc *XcmsFuncListPtr;
/* A NULL terminated list of function pointers*/
typedef struct _XcmsColorSpace {
char *prefix;
XcmsColorFormat format;
XcmsParseStringProc parseString;
XcmsFuncListPtr to_CIEXYZ;
XcmsFuncListPtr from_CIEXYZ;
int inverse_flag;
} XcmsColorSpace;
││__
The prefix member specifies the prefix that indicates a
color string is in this color space's string format. For
example, the strings ``ciexyz'' or ``CIEXYZ'' for CIE XYZ,
and ``rgb'' or ``RGB'' for RGB. The prefix is case insensi-
tive. The format member specifies the color specification
format. Formats for unregistered color spaces are assigned
at run time. The parseString member contains a pointer to
the function that can parse a color string into an _X_c_m_s_C_o_l_o_r
structure. This function returns an integer (int): nonzero
if it succeeded and zero otherwise. The to_CIEXYZ and
from_CIEXYZ members contain pointers, each to a NULL termi-
nated list of function pointers. When the list of functions
is executed in series, it will convert the color specified
in an _X_c_m_s_C_o_l_o_r structure from/to the current color space
format to/from the CIE XYZ format. Each function returns an
integer (int): nonzero if it succeeded and zero otherwise.
The white point to be associated with the colors is speci-
fied explicitly, even though white points can be found in
the CCC. The inverse_flag member, if nonzero, specifies
that for each function listed in to_CIEXYZ, its inverse
function can be found in from_CIEXYZ such that:
Given: n = number of functions in each list
for each i, such that 0 <= i < n
from_CIEXYZ[n - i - 1] is the inverse of to_CIEXYZ[i].
This allows Xlib to use the shortest conversion path, thus
bypassing CIE XYZ if possible (for example, TekHVC to CIE
117799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
L*u*v*).
66..1122..55.. PPaarrssee SSttrriinngg CCaallllbbaacckk
The callback in the _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure for parsing a
color string for the particular color space must adhere to
the following software interface specification:
__
││
typedef int (*XcmsParseStringProc)(_c_o_l_o_r___s_t_r_i_n_g, _c_o_l_o_r___r_e_t_u_r_n)
char *_c_o_l_o_r___s_t_r_i_n_g;
XcmsColor *_c_o_l_o_r___r_e_t_u_r_n;
_c_o_l_o_r___s_t_r_i_n_g
Specifies the color string to parse.
_c_o_l_o_r___r_e_t_u_r_n
Returns the color specification in the color
space's format.
││__
66..1122..66.. CCoolloorr SSppeecciiffiiccaattiioonn CCoonnvveerrssiioonn CCaallllbbaacckk
Callback functions in the _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure for con-
verting a color specification between device-independent
spaces must adhere to the following software interface spec-
ification:
118800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status ConversionProc(_c_c_c, _w_h_i_t_e___p_o_i_n_t, _c_o_l_o_r_s___i_n___o_u_t, _n_c_o_l_o_r_s)
XcmsCCC _c_c_c;
XcmsColor *_w_h_i_t_e___p_o_i_n_t;
XcmsColor *_c_o_l_o_r_s___i_n___o_u_t;
unsigned int _n_c_o_l_o_r_s;
_c_c_c Specifies the CCC.
_w_h_i_t_e___p_o_i_n_t
Specifies the white point associated with color
specifications. The pixel member should be
ignored, and the entire structure remain unchanged
upon return.
_c_o_l_o_r_s___i_n___o_u_t
Specifies an array of color specifications. Pixel
members should be ignored and must remain
unchanged upon return.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
││__
Callback functions in the _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure for con-
verting a color specification to or from a device-dependent
space must adhere to the following software interface speci-
fication:
118811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status ConversionProc(_c_c_c, _c_o_l_o_r_s___i_n___o_u_t, _n_c_o_l_o_r_s, _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n)
XcmsCCC _c_c_c;
XcmsColor *_c_o_l_o_r_s___i_n___o_u_t;
unsigned int _n_c_o_l_o_r_s;
Bool _c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n[];
_c_c_c Specifies the CCC.
_c_o_l_o_r_s___i_n___o_u_t
Specifies an array of color specifications. Pixel
members should be ignored and must remain
unchanged upon return.
_n_c_o_l_o_r_s Specifies the number of _X_c_m_s_C_o_l_o_r structures in
the color-specification array.
_c_o_m_p_r_e_s_s_i_o_n___f_l_a_g_s___r_e_t_u_r_n
Returns an array of Boolean values for indicating
compression status. If a non-NULL pointer is sup-
plied and a color at a given index is compressed,
then _T_r_u_e should be stored at the corresponding
index in this array; otherwise, the array should
not be modified.
││__
Conversion functions are available globally for use by other
color spaces. The conversion functions provided by Xlib
are:
-------------------------------------------------------------
FFuunnccttiioonn CCoonnvveerrttss ffrroomm CCoonnvveerrttss ttoo
-------------------------------------------------------------
_X_c_m_s_C_I_E_L_a_b_T_o_C_I_E_X_Y_Z _X_c_m_s_C_I_E_L_a_b_F_o_r_m_a_t _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t
_X_c_m_s_C_I_E_L_u_v_T_o_C_I_E_u_v_Y _X_c_m_s_C_I_E_L_u_v_F_o_r_m_a_t _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t
_X_c_m_s_C_I_E_X_Y_Z_T_o_C_I_E_L_a_b _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t _X_c_m_s_C_I_E_L_a_b_F_o_r_m_a_t
_X_c_m_s_C_I_E_X_Y_Z_T_o_C_I_E_u_v_Y _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t
_X_c_m_s_C_I_E_X_Y_Z_T_o_C_I_E_x_y_Y _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t _X_c_m_s_C_I_E_x_y_Y_F_o_r_m_a_t
_X_c_m_s_C_I_E_X_Y_Z_T_o_R_G_B_i _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t _X_c_m_s_R_G_B_i_F_o_r_m_a_t
_X_c_m_s_C_I_E_u_v_Y_T_o_C_I_E_L_u_v _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t _X_c_m_s_C_I_E_L_a_b_F_o_r_m_a_t
_X_c_m_s_C_I_E_u_v_Y_T_o_C_I_E_X_Y_Z _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t
_X_c_m_s_C_I_E_u_v_Y_T_o_T_e_k_H_V_C _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t _X_c_m_s_T_e_k_H_V_C_F_o_r_m_a_t
_X_c_m_s_C_I_E_x_y_Y_T_o_C_I_E_X_Y_Z _X_c_m_s_C_I_E_x_y_Y_F_o_r_m_a_t _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t
_X_c_m_s_R_G_B_T_o_R_G_B_i _X_c_m_s_R_G_B_F_o_r_m_a_t _X_c_m_s_R_G_B_i_F_o_r_m_a_t
_X_c_m_s_R_G_B_i_T_o_C_I_E_X_Y_Z _X_c_m_s_R_G_B_i_F_o_r_m_a_t _X_c_m_s_C_I_E_X_Y_Z_F_o_r_m_a_t
_X_c_m_s_R_G_B_i_T_o_R_G_B _X_c_m_s_R_G_B_i_F_o_r_m_a_t _X_c_m_s_R_G_B_F_o_r_m_a_t
_X_c_m_s_T_e_k_H_V_C_T_o_C_I_E_u_v_Y _X_c_m_s_T_e_k_H_V_C_F_o_r_m_a_t _X_c_m_s_C_I_E_u_v_Y_F_o_r_m_a_t
-------------------------------------------------------------
118822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
66..1122..77.. FFuunnccttiioonn SSeettss
Functions to convert between device-dependent color spaces
and CIE XYZ may differ for different classes of output
devices (for example, color versus gray monitors). There-
fore, the notion of a Color Characterization Function Set
has been developed. A function set consists of device-
dependent color spaces and the functions that convert color
specifications between these device-dependent color spaces
and the CIE XYZ color space appropriate for a particular
class of output devices. The function set also contains a
function that reads color characterization data off root
window properties. It is this characterization data that
will differ between devices within a class of output
devices. For details about how color characterization data
is stored in root window properties, see the section on
Device Color Characterization in the _I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_-
_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l. The LINEAR_RGB function set is
provided by Xlib and will support most color monitors.
Function sets may require data that differs from those
needed for the LINEAR_RGB function set. In that case, its
corresponding data may be stored on different root window
properties.
66..1122..88.. AAddddiinngg FFuunnccttiioonn SSeettss
To add a function set, use _X_c_m_s_A_d_d_F_u_n_c_t_i_o_n_S_e_t.
__
││
Status XcmsAddFunctionSet(_f_u_n_c_t_i_o_n___s_e_t)
XcmsFunctionSet *_f_u_n_c_t_i_o_n___s_e_t;
_f_u_n_c_t_i_o_n___s_e_t
Specifies the function set to add.
││__
The _X_c_m_s_A_d_d_F_u_n_c_t_i_o_n_S_e_t function adds a function set to the
color management system. If the function set uses device-
dependent _X_c_m_s_C_o_l_o_r_S_p_a_c_e structures not accessible in the
color management system, _X_c_m_s_A_d_d_F_u_n_c_t_i_o_n_S_e_t adds them. If
an added _X_c_m_s_C_o_l_o_r_S_p_a_c_e structure is for a device-dependent
color space not registered with the X Consortium, they
should be treated as private to the client because format
values for unregistered color spaces are assigned at run
time. If references to an unregistered color space must be
made outside the client (for example, storing color specifi-
cations in a file using the unregistered color space), then
reference should be made by color space prefix (see _X_c_m_s_F_o_r_-
_m_a_t_O_f_P_r_e_f_i_x and _X_c_m_s_P_r_e_f_i_x_O_f_F_o_r_m_a_t).
Additional function sets should be added before any calls to
other Xlib routines are made. If not, the _X_c_m_s_P_e_r_S_c_r_n_I_n_f_o
member of a previously created _X_c_m_s_C_C_C does not have the
118833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
opportunity to initialize with the added function set.
66..1122..99.. CCrreeaattiinngg AAddddiittiioonnaall FFuunnccttiioonn SSeettss
The creation of additional function sets should be required
only when an output device does not conform to existing
function sets or when additional device-dependent color
spaces are necessary. A function set consists primarily of
a collection of device-dependent _X_c_m_s_C_o_l_o_r_S_p_a_c_e structures
and a means to read and store a screen's color characteriza-
tion data. This data is stored in an _X_c_m_s_F_u_n_c_t_i_o_n_S_e_t struc-
ture. A handle to this structure (that is, by means of
global variable) is usually made accessible to the client
program for use with _X_c_m_s_A_d_d_F_u_n_c_t_i_o_n_S_e_t.
If a function set uses new device-dependent _X_c_m_s_C_o_l_o_r_S_p_a_c_e
structures, they will be transparently processed into the
color management system. Function sets can share an _X_c_m_s_-
_C_o_l_o_r_S_p_a_c_e structure for a device-dependent color space. In
addition, multiple _X_c_m_s_C_o_l_o_r_S_p_a_c_e structures are allowed for
a device-dependent color space; however, a function set can
reference only one of them. These _X_c_m_s_C_o_l_o_r_S_p_a_c_e structures
will differ in the functions to convert to and from CIE XYZ,
thus tailored for the specific function set.
__
││
typedef struct _XcmsFunctionSet {
XcmsColorSpace **DDColorSpaces;
XcmsScreenInitProc screenInitProc;
XcmsScreenFreeProc screenFreeProc;
} XcmsFunctionSet;
││__
The DDColorSpaces member is a pointer to a NULL terminated
list of pointers to _X_c_m_s_C_o_l_o_r_S_p_a_c_e structures for the
device-dependent color spaces that are supported by the
function set. The screenInitProc member is set to the call-
back procedure (see the following interface specification)
that initializes the _X_c_m_s_P_e_r_S_c_r_n_I_n_f_o structure for a partic-
ular screen.
The screen initialization callback must adhere to the fol-
lowing software interface specification:
118844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef Status (*XcmsScreenInitProc)(_d_i_s_p_l_a_y, _s_c_r_e_e_n___n_u_m_b_e_r, _s_c_r_e_e_n___i_n_f_o)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n___n_u_m_b_e_r;
XcmsPerScrnInfo *_s_c_r_e_e_n___i_n_f_o;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
_s_c_r_e_e_n___i_n_f_o
Specifies the _X_c_m_s_P_e_r_S_c_r_n_I_n_f_o structure, which
contains the per screen information.
││__
The screen initialization callback in the _X_c_m_s_F_u_n_c_t_i_o_n_S_e_t
structure fetches the color characterization data (device
profile) for the specified screen, typically off properties
on the screen's root window. It then initializes the speci-
fied _X_c_m_s_P_e_r_S_c_r_n_I_n_f_o structure. If successful, the proce-
dure fills in the _X_c_m_s_P_e_r_S_c_r_n_I_n_f_o structure as follows:
· It sets the screenData member to the address of the
created device profile data structure (contents known
only by the function set).
· It next sets the screenWhitePoint member.
· It next sets the functionSet member to the address of
the _X_c_m_s_F_u_n_c_t_i_o_n_S_e_t structure.
· It then sets the state member to _X_c_m_s_I_n_i_t_S_u_c_c_e_s_s and
finally returns _X_c_m_s_S_u_c_c_e_s_s.
If unsuccessful, the procedure sets the state member to _X_c_m_-
_s_I_n_i_t_F_a_i_l_u_r_e and returns _X_c_m_s_F_a_i_l_u_r_e.
The _X_c_m_s_P_e_r_S_c_r_n_I_n_f_o structure contains:
118855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XcmsPerScrnInfo {
XcmsColor screenWhitePoint;
XPointer functionSet;
XPointer screenData;
unsigned char state;
char pad[3];
} XcmsPerScrnInfo;
││__
The screenWhitePoint member specifies the white point inher-
ent to the screen. The functionSet member specifies the
appropriate function set. The screenData member specifies
the device profile. The state member is set to one of the
following:
· _X_c_m_s_I_n_i_t_N_o_n_e indicates initialization has not been pre-
viously attempted.
· _X_c_m_s_I_n_i_t_F_a_i_l_u_r_e indicates initialization has been pre-
viously attempted but failed.
· _X_c_m_s_I_n_i_t_S_u_c_c_e_s_s indicates initialization has been pre-
viously attempted and succeeded.
The screen free callback must adhere to the following soft-
ware interface specification:
__
││
typedef void (*XcmsScreenFreeProc)(_s_c_r_e_e_n_D_a_t_a)
XPointer _s_c_r_e_e_n_D_a_t_a;
_s_c_r_e_e_n_D_a_t_a
Specifies the data to be freed.
││__
This function is called to free the screenData stored in an
_X_c_m_s_P_e_r_S_c_r_n_I_n_f_o structure.
118866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 77
GGrraapphhiiccss CCoonntteexxtt FFuunnccttiioonnss
A number of resources are used when performing graphics
operations in X. Most information about performing graphics
(for example, foreground color, background color, line
style, and so on) is stored in resources called graphics
contexts (GCs). Most graphics operations (see chapter 8)
take a GC as an argument. Although in theory the X protocol
permits sharing of GCs between applications, it is expected
that applications will use their own GCs when performing
operations. Sharing of GCs is highly discouraged because
the library may cache GC state.
Graphics operations can be performed to either windows or
pixmaps, which collectively are called drawables. Each
drawable exists on a single screen. A GC is created for a
specific screen and drawable depth and can only be used with
drawables of matching screen and depth.
This chapter discusses how to:
· Manipulate graphics context/state
· Use graphics context convenience functions
77..11.. MMaanniippuullaattiinngg GGrraapphhiiccss CCoonntteexxtt//SSttaattee
Most attributes of graphics operations are stored in GCs.
These include line width, line style, plane mask, fore-
ground, background, tile, stipple, clipping region, end
style, join style, and so on. Graphics operations (for
example, drawing lines) use these values to determine the
actual drawing operation. Extensions to X may add addi-
tional components to GCs. The contents of a GC are private
to Xlib.
Xlib implements a write-back cache for all elements of a GC
that are not resource IDs to allow Xlib to implement the
transparent coalescing of changes to GCs. For example, a
call to _X_S_e_t_F_o_r_e_g_r_o_u_n_d of a GC followed by a call to _X_S_e_t_-
_L_i_n_e_A_t_t_r_i_b_u_t_e_s results in only a single-change GC protocol
request to the server. GCs are neither expected nor encour-
aged to be shared between client applications, so this
write-back caching should present no problems. Applications
cannot share GCs without external synchronization. There-
fore, sharing GCs between applications is highly discour-
aged.
118877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To set an attribute of a GC, set the appropriate member of
the _X_G_C_V_a_l_u_e_s structure and OR in the corresponding value
bitmask in your subsequent calls to _X_C_r_e_a_t_e_G_C. The symbols
for the value mask bits and the _X_G_C_V_a_l_u_e_s structure are:
118888
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
/* GC attribute value mask bits */
#define _G_C_F_u_n_c_t_i_o_n (1L<<0)
#define _G_C_P_l_a_n_e_M_a_s_k (1L<<1)
#define _G_C_F_o_r_e_g_r_o_u_n_d (1L<<2)
#define _G_C_B_a_c_k_g_r_o_u_n_d (1L<<3)
#define _G_C_L_i_n_e_W_i_d_t_h (1L<<4)
#define _G_C_L_i_n_e_S_t_y_l_e (1L<<5)
#define _G_C_C_a_p_S_t_y_l_e (1L<<6)
#define _G_C_J_o_i_n_S_t_y_l_e (1L<<7)
#define _G_C_F_i_l_l_S_t_y_l_e (1L<<8)
#define _G_C_F_i_l_l_R_u_l_e (1L<<9)
#define _G_C_T_i_l_e (1L<<10)
#define _G_C_S_t_i_p_p_l_e (1L<<11)
#define _G_C_T_i_l_e_S_t_i_p_X_O_r_i_g_i_n (1L<<12)
#define _G_C_T_i_l_e_S_t_i_p_Y_O_r_i_g_i_n (1L<<13)
#define _G_C_F_o_n_t (1L<<14)
#define _G_C_S_u_b_w_i_n_d_o_w_M_o_d_e (1L<<15)
#define _G_C_G_r_a_p_h_i_c_s_E_x_p_o_s_u_r_e_s (1L<<16)
#define _G_C_C_l_i_p_X_O_r_i_g_i_n (1L<<17)
#define _G_C_C_l_i_p_Y_O_r_i_g_i_n (1L<<18)
#define _G_C_C_l_i_p_M_a_s_k (1L<<19)
#define _G_C_D_a_s_h_O_f_f_s_e_t (1L<<20)
#define _G_C_D_a_s_h_L_i_s_t (1L<<21)
#define _G_C_A_r_c_M_o_d_e (1L<<22)
/* Values */
typedef struct {
int function; /* logical operation */
unsigned long plane_mask;/* plane mask */
unsigned long foreground;/* foreground pixel */
unsigned long background;/* background pixel */
int line_width; /* line width (in pixels) */
int line_style; /* LineSolid, LineOnOffDash, LineDoubleDash */
int cap_style; /* CapNotLast, CapButt, CapRound, CapProjecting */
int join_style; /* JoinMiter, JoinRound, JoinBevel */
int fill_style; /* FillSolid, FillTiled, FillStippled FillOpaqueStippled*/
int fill_rule; /* EvenOddRule, WindingRule */
int arc_mode; /* ArcChord, ArcPieSlice */
Pixmap tile; /* tile pixmap for tiling operations */
Pixmap stipple; /* stipple 1 plane pixmap for stippling */
int ts_x_origin; /* offset for tile or stipple operations */
int ts_y_origin;
Font font; /* default text font for text operations */
int subwindow_mode; /* ClipByChildren, IncludeInferiors */
Bool graphics_exposures; /* boolean, should exposures be generated */
int clip_x_origin; /* origin for clipping */
int clip_y_origin;
Pixmap clip_mask; /* bitmap clipping; other calls for rects */
int dash_offset; /* patterned/dashed line information */
char dashes;
118899
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
} XGCValues;
││__
The default GC values are:
----------------------------------------------------------------------------------
CCoommppoonneenntt DDeeffaauulltt
----------------------------------------------------------------------------------
function _G_X_c_o_p_y
plane_mask All ones
foreground 0
background 1
line_width 0
line_style _L_i_n_e_S_o_l_i_d
cap_style _C_a_p_B_u_t_t
join_style _J_o_i_n_M_i_t_e_r
fill_style _F_i_l_l_S_o_l_i_d
fill_rule _E_v_e_n_O_d_d_R_u_l_e
arc_mode _A_r_c_P_i_e_S_l_i_c_e
tile Pixmap of unspecified size filled with foreground pixel
(that is, client specified pixel if any, else 0)
(subsequent changes to foreground do not affect this pixmap)
stipple Pixmap of unspecified size filled with ones
ts_x_origin 0
ts_y_origin 0
font <implementation dependent>
subwindow_mode _C_l_i_p_B_y_C_h_i_l_d_r_e_n
graphics_exposures _T_r_u_e
clip_x_origin 0
clip_y_origin 0
clip_mask _N_o_n_e
dash_offset 0
dashes 4 (that is, the list [4, 4])
----------------------------------------------------------------------------------
Note that foreground and background are not set to any val-
ues likely to be useful in a window.
The function attributes of a GC are used when you update a
section of a drawable (the destination) with bits from some-
where 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. _G_X_c_o_p_y 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 <_X_1_1_/_X_._h>, are:
119900
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-----------------------------------------------
FFuunnccttiioonn NNaammee VVaalluuee OOppeerraattiioonn
-----------------------------------------------
_G_X_c_l_e_a_r 0x0 0
_G_X_a_n_d 0x1 src AND dst
_G_X_a_n_d_R_e_v_e_r_s_e 0x2 src AND NOT dst
_G_X_c_o_p_y 0x3 src
_G_X_a_n_d_I_n_v_e_r_t_e_d 0x4 (NOT src) AND dst
_G_X_n_o_o_p 0x5 dst
_G_X_x_o_r 0x6 src XOR dst
_G_X_o_r 0x7 src OR dst
_G_X_n_o_r 0x8 (NOT src) AND (NOT
dst)
_G_X_e_q_u_i_v 0x9 (NOT src) XOR dst
_G_X_i_n_v_e_r_t 0xa NOT dst
_G_X_o_r_R_e_v_e_r_s_e 0xb src OR (NOT dst)
_G_X_c_o_p_y_I_n_v_e_r_t_e_d 0xc NOT src
_G_X_o_r_I_n_v_e_r_t_e_d 0xd (NOT src) OR dst
_G_X_n_a_n_d 0xe (NOT src) OR (NOT
dst)
_G_X_s_e_t 0xf 1
-----------------------------------------------
Many graphics operations depend on either pixel values or
planes in a GC. The planes attribute is of type long, and
it specifies which planes of the destination are to be modi-
fied, one bit per plane. A monochrome display has only one
plane and will be the least significant bit of the word. As
planes are added to the display hardware, they will occupy
more significant bits in the plane mask.
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. The plane_mask restricts the operation to a
subset of planes. A macro constant _A_l_l_P_l_a_n_e_s can be used to
refer to all planes of the screen simultaneously. The
result is computed by the following:
((src FUNC dst) AND plane-mask) OR (dst AND (NOT plane-mask))
Range checking is not performed on the values for fore-
ground, background, or plane_mask. They are simply trun-
cated to the appropriate number of bits. The line-width is
measured in pixels and either can be greater than or equal
to one (wide line) or can be the special value zero (thin
line).
Wide lines are drawn centered on the path described by the
graphics request. Unless otherwise specified by the join-
style or cap-style, the bounding box of a wide line with
119911
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
endpoints [x1, y1], [x2, y2] and width w is a rectangle with
vertices at the following real coordinates:
[x1-(w*sn/2), y1+(w*cs/2)], [x1+(w*sn/2), y1-(w*cs/2)],
[x2-(w*sn/2), y2+(w*cs/2)], [x2+(w*sn/2), y2-(w*cs/2)]
Here sn is the sine of the angle of the line, and cs is the
cosine of the angle of the line. A pixel is part of the
line and so is drawn if the center of the pixel is fully
inside the bounding box (which is viewed as having
infinitely thin edges). 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 increas-
ing 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 (y
increasing direction) and the interior or the boundary is
immediately to the right (x increasing direction).
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.
1. 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 if and only if the
point [x+dx,y+dy] is touched by drawing the second
line.
2. 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 lies inside the
clipping region and the point would be touched by the
line when drawn unclipped.
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, but this is not
required. A line-width of zero may differ from a line-width
of one in which pixels are drawn. This permits the use of
many manufacturers' line drawing hardware, which may run
many times faster than the more precisely specified wide
lines.
In general, drawing a thin line will be faster than drawing
a wide line of width one. However, because of their differ-
ent drawing algorithms, thin lines may not mix well aesthet-
ically with wide lines. If it is desirable to obtain pre-
cise and uniform results across all displays, a client
should always use a line-width of one rather than a line-
119922
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
width of zero.
The line-style defines which sections of a line are drawn:
_L_i_n_e_S_o_l_i_d The full path of the line is drawn.
_L_i_n_e_D_o_u_- The full path of the line is drawn, but the
_b_l_e_D_a_s_h even dashes are filled differently from the
odd dashes (see fill-style) with _C_a_p_B_u_t_t
style used where even and odd dashes meet.
_L_i_n_e_O_n_O_f_f_D_a_s_h Only the even dashes are drawn, and cap-style
applies to all internal ends of the individ-
ual dashes, except _C_a_p_N_o_t_L_a_s_t is treated as
_C_a_p_B_u_t_t.
The cap-style defines how the endpoints of a path are drawn:
_C_a_p_N_o_t_L_a_s_t This is equivalent to _C_a_p_B_u_t_t except that for
a line-width of zero the final endpoint is
not drawn.
_C_a_p_B_u_t_t The line is square at the endpoint (perpen-
dicular to the slope of the line) with no
projection beyond.
_C_a_p_R_o_u_n_d The line has a circular arc with the diameter
equal to the line-width, centered on the end-
point. (This is equivalent to _C_a_p_B_u_t_t for
line-width of zero).
_C_a_p_P_r_o_j_e_c_t_i_n_g 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 _C_a_p_B_u_t_t for line-width of
zero).
The join-style defines how corners are drawn for wide lines:
_J_o_i_n_M_i_t_e_r The outer edges of two lines extend to meet
at an angle. However, if the angle is less
than 11 degrees, then a _J_o_i_n_B_e_v_e_l join-style
is used instead.
_J_o_i_n_R_o_u_n_d The corner is a circular arc with the diame-
ter equal to the line-width, centered on the
joinpoint.
_J_o_i_n_B_e_v_e_l The corner has _C_a_p_B_u_t_t endpoint styles with
the triangular notch filled.
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:
119933
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_C_a_p_N_o_t_L_a_s_t thin The results are device dependent, but
the desired effect is that nothing is
drawn.
_C_a_p_B_u_t_t thin The results are device dependent, but
the desired effect is that a single
pixel is drawn.
_C_a_p_R_o_u_n_d thin The results are the same as for _C_a_p_-
_B_u_t_t/thin.
_C_a_p_P_r_o_j_e_c_t_i_n_g thin The results are the same as for _C_a_p_-
_B_u_t_t/thin.
_C_a_p_B_u_t_t wide Nothing is drawn.
_C_a_p_R_o_u_n_d wide The closed path is a circle, centered at
the endpoint, and with the diameter
equal to the line-width.
_C_a_p_P_r_o_j_e_c_t_i_n_g wide The closed path is a square, aligned
with the coordinate axes, centered at
the endpoint, and with the sides equal
to the line-width.
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 endpoints.
The tile/stipple represents an infinite two-dimensional
plane, with the tile/stipple replicated in all dimensions.
When that plane is superimposed on the drawable for use in a
graphics operation, the upper-left corner of some instance
of the tile/stipple is at the coordinates within the draw-
able specified by the tile/stipple origin. The tile/stipple
and clip origins are interpreted relative to the origin of
whatever destination drawable is specified in a graphics
request. The tile pixmap must have the same root and depth
as the GC, or a _B_a_d_M_a_t_c_h error results. The stipple pixmap
must have depth one and must have the same root as the GC,
or a _B_a_d_M_a_t_c_h error results. For stipple operations where
the fill-style is _F_i_l_l_S_t_i_p_p_l_e_d but not _F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d,
the stipple pattern is tiled in a single plane and acts as
an additional clip mask to be ANDed with the clip-mask.
Although some sizes may be faster to use than others, any
size pixmap can be used for tiling or stippling.
The fill-style defines the contents of the source for line,
text, and fill requests. For all text and fill requests
(for example, _X_D_r_a_w_T_e_x_t, _X_D_r_a_w_T_e_x_t_1_6, _X_F_i_l_l_R_e_c_t_a_n_g_l_e,
_X_F_i_l_l_P_o_l_y_g_o_n, and _X_F_i_l_l_A_r_c); for line requests with line-
style _L_i_n_e_S_o_l_i_d (for example, _X_D_r_a_w_L_i_n_e, _X_D_r_a_w_S_e_g_m_e_n_t_s,
_X_D_r_a_w_R_e_c_t_a_n_g_l_e, _X_D_r_a_w_A_r_c); and for the even dashes for line
requests with line-style _L_i_n_e_O_n_O_f_f_D_a_s_h or _L_i_n_e_D_o_u_b_l_e_D_a_s_h,
the following apply:
119944
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_F_i_l_l_S_o_l_i_d Foreground
_F_i_l_l_T_i_l_e_d Tile
_F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d A tile with the same width and height as
stipple, but with background everywhere
stipple has a zero and with foreground
everywhere stipple has a one
_F_i_l_l_S_t_i_p_p_l_e_d Foreground masked by stipple
When drawing lines with line-style _L_i_n_e_D_o_u_b_l_e_D_a_s_h, the odd
dashes are controlled by the fill-style in the following
manner:
_F_i_l_l_S_o_l_i_d Background
_F_i_l_l_T_i_l_e_d Same as for even dashes
_F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d Same as for even dashes
_F_i_l_l_S_t_i_p_p_l_e_d Background masked by stipple
Storing a pixmap in a GC might or might not result in a copy
being made. If the pixmap is later used as the destination
for a graphics request, the change might or might not be
reflected in the GC. If the pixmap is used simultaneously
in a graphics request both as a destination and as a tile or
stipple, the results are undefined.
For optimum performance, 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 implemen-
tation. It is quite likely that some amount of GC informa-
tion will be cached in display hardware and that such hard-
ware can only cache a small number of GCs.
The dashes value is actually a simplified form of the more
general patterns that can be set with _X_S_e_t_D_a_s_h_e_s. Specify-
ing a value of N is equivalent to specifying the two-element
list [N, N] in _X_S_e_t_D_a_s_h_e_s. The value must be nonzero, or a
_B_a_d_V_a_l_u_e error results.
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 _B_a_d_M_a_t_c_h error
results. If clip-mask is set to _N_o_n_e, the pixels are always
drawn regardless of the clip origin. The clip-mask also can
be set by calling the _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s or _X_S_e_t_R_e_g_i_o_n func-
tions. 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. The clip-mask origin is interpreted
relative to the origin of whatever destination drawable is
specified in a graphics request.
119955
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
You can set the subwindow-mode to _C_l_i_p_B_y_C_h_i_l_d_r_e_n or _I_n_c_l_u_d_e_-
_I_n_f_e_r_i_o_r_s. For _C_l_i_p_B_y_C_h_i_l_d_r_e_n, both source and destination
windows are additionally clipped by all viewable _I_n_p_u_t_O_u_t_p_u_t
children. For _I_n_c_l_u_d_e_I_n_f_e_r_i_o_r_s, neither source nor destina-
tion 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
_I_n_c_l_u_d_e_I_n_f_e_r_i_o_r_s on a window of one depth with mapped infe-
riors of differing depth is not illegal, but the semantics
are undefined by the core protocol.
The fill-rule defines what pixels are inside (drawn) for
paths given in _X_F_i_l_l_P_o_l_y_g_o_n requests and can be set to _E_v_e_n_-
_O_d_d_R_u_l_e or _W_i_n_d_i_n_g_R_u_l_e. For _E_v_e_n_O_d_d_R_u_l_e, a point is inside
if an infinite ray with the point as origin crosses the path
an odd number of times. For _W_i_n_d_i_n_g_R_u_l_e, a point is inside
if an infinite ray with the point as origin crosses an
unequal number of clockwise and counterclockwise directed
path segments. A clockwise directed path segment is one
that crosses the ray from left to right as observed from the
point. A counterclockwise segment is one that crosses the
ray from right to left as observed from the point. 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.
For both _E_v_e_n_O_d_d_R_u_l_e and _W_i_n_d_i_n_g_R_u_l_e, 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. 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 inte-
rior is immediately below (y increasing direction).
The arc-mode controls filling in the _X_F_i_l_l_A_r_c_s function and
can be set to _A_r_c_P_i_e_S_l_i_c_e or _A_r_c_C_h_o_r_d. For _A_r_c_P_i_e_S_l_i_c_e, the
arcs are pie-slice filled. For _A_r_c_C_h_o_r_d, the arcs are chord
filled.
The graphics-exposure flag controls _G_r_a_p_h_i_c_s_E_x_p_o_s_e event
generation for _X_C_o_p_y_A_r_e_a and _X_C_o_p_y_P_l_a_n_e requests (and any
similar requests defined by extensions).
To create a new GC that is usable on a given screen with a
depth of drawable, use _X_C_r_e_a_t_e_G_C.
119966
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
GC XCreateGC(_d_i_s_p_l_a_y, _d, _v_a_l_u_e_m_a_s_k, _v_a_l_u_e_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
unsigned long _v_a_l_u_e_m_a_s_k;
XGCValues *_v_a_l_u_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_v_a_l_u_e_m_a_s_k Specifies which components in the GC are to be set
using the information in the specified values
structure. This argument is the bitwise inclusive
OR of zero or more of the valid GC component mask
bits.
_v_a_l_u_e_s Specifies any values as specified by the value-
mask.
││__
The _X_C_r_e_a_t_e_G_C function creates a graphics context and
returns a GC. The GC can be used with any destination draw-
able having the same root and depth as the specified draw-
able. Use with other drawables results in a _B_a_d_M_a_t_c_h error.
_X_C_r_e_a_t_e_G_C can generate _B_a_d_A_l_l_o_c, _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_F_o_n_t, _B_a_d_-
_M_a_t_c_h, _B_a_d_P_i_x_m_a_p, and _B_a_d_V_a_l_u_e errors.
To copy components from a source GC to a destination GC, use
_X_C_o_p_y_G_C.
__
││
XCopyGC(_d_i_s_p_l_a_y, _s_r_c, _v_a_l_u_e_m_a_s_k, _d_e_s_t)
Display *_d_i_s_p_l_a_y;
GC _s_r_c, _d_e_s_t;
unsigned long _v_a_l_u_e_m_a_s_k;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_r_c Specifies the components of the source GC.
_v_a_l_u_e_m_a_s_k Specifies which components in the GC are to be
copied to the destination GC. This argument is
the bitwise inclusive OR of zero or more of the
valid GC component mask bits.
_d_e_s_t Specifies the destination GC.
││__
The _X_C_o_p_y_G_C function copies the specified components from
119977
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the source GC to the destination GC. The source and desti-
nation GCs must have the same root and depth, or a _B_a_d_M_a_t_c_h
error results. The valuemask specifies which component to
copy, as for _X_C_r_e_a_t_e_G_C.
_X_C_o_p_y_G_C can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.
To change the components in a given GC, use _X_C_h_a_n_g_e_G_C.
__
││
XChangeGC(_d_i_s_p_l_a_y, _g_c, _v_a_l_u_e_m_a_s_k, _v_a_l_u_e_s)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned long _v_a_l_u_e_m_a_s_k;
XGCValues *_v_a_l_u_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_v_a_l_u_e_m_a_s_k Specifies which components in the GC are to be
changed using information in the specified values
structure. This argument is the bitwise inclusive
OR of zero or more of the valid GC component mask
bits.
_v_a_l_u_e_s Specifies any values as specified by the value-
mask.
││__
The _X_C_h_a_n_g_e_G_C function changes the components specified by
valuemask for the specified GC. The values argument con-
tains the values to be set. The values and restrictions are
the same as for _X_C_r_e_a_t_e_G_C. Changing the clip-mask overrides
any previous _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s request on the context.
Changing the dash-offset or dash-list overrides any previous
_X_S_e_t_D_a_s_h_e_s request on the context. The order in which com-
ponents are verified and altered is server dependent. If an
error is generated, a subset of the components may have been
altered.
_X_C_h_a_n_g_e_G_C can generate _B_a_d_A_l_l_o_c, _B_a_d_F_o_n_t, _B_a_d_G_C, _B_a_d_M_a_t_c_h,
_B_a_d_P_i_x_m_a_p, and _B_a_d_V_a_l_u_e errors.
To obtain components of a given GC, use _X_G_e_t_G_C_V_a_l_u_e_s.
119988
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetGCValues(_d_i_s_p_l_a_y, _g_c, _v_a_l_u_e_m_a_s_k, _v_a_l_u_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned long _v_a_l_u_e_m_a_s_k;
XGCValues *_v_a_l_u_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_v_a_l_u_e_m_a_s_k Specifies which components in the GC are to be
returned in the values_return argument. This
argument is the bitwise inclusive OR of zero or
more of the valid GC component mask bits.
_v_a_l_u_e_s___r_e_t_u_r_n
Returns the GC values in the specified _X_G_C_V_a_l_u_e_s
structure.
││__
The _X_G_e_t_G_C_V_a_l_u_e_s function returns the components specified
by valuemask for the specified GC. If the valuemask con-
tains a valid set of GC mask bits (_G_C_F_u_n_c_t_i_o_n, _G_C_P_l_a_n_e_M_a_s_k,
_G_C_F_o_r_e_g_r_o_u_n_d, _G_C_B_a_c_k_g_r_o_u_n_d, _G_C_L_i_n_e_W_i_d_t_h, _G_C_L_i_n_e_S_t_y_l_e, _G_C_C_a_p_-
_S_t_y_l_e, _G_C_J_o_i_n_S_t_y_l_e, _G_C_F_i_l_l_S_t_y_l_e, _G_C_F_i_l_l_R_u_l_e, _G_C_T_i_l_e, _G_C_S_t_i_p_-
_p_l_e, _G_C_T_i_l_e_S_t_i_p_X_O_r_i_g_i_n, _G_C_T_i_l_e_S_t_i_p_Y_O_r_i_g_i_n, _G_C_F_o_n_t, _G_C_S_u_b_w_i_n_-
_d_o_w_M_o_d_e, _G_C_G_r_a_p_h_i_c_s_E_x_p_o_s_u_r_e_s, _G_C_C_l_i_p_X_O_r_i_g_i_n, _G_C_C_L_i_p_Y_O_r_i_g_i_n,
_G_C_D_a_s_h_O_f_f_s_e_t, or _G_C_A_r_c_M_o_d_e) and no error occurs, _X_G_e_t_G_C_V_a_l_-
_u_e_s sets the requested components in values_return and
returns a nonzero status. Otherwise, it returns a zero sta-
tus. Note that the clip-mask and dash-list (represented by
the _G_C_C_l_i_p_M_a_s_k and _G_C_D_a_s_h_L_i_s_t bits, respectively, in the
valuemask) cannot be requested. Also note that an invalid
resource ID (with one or more of the three most significant
bits set to 1) will be returned for _G_C_F_o_n_t, _G_C_T_i_l_e, and
_G_C_S_t_i_p_p_l_e if the component has never been explicitly set by
the client.
To free a given GC, use _X_F_r_e_e_G_C.
119999
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFreeGC(_d_i_s_p_l_a_y, _g_c)
Display *_d_i_s_p_l_a_y;
GC _g_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
││__
The _X_F_r_e_e_G_C function destroys the specified GC as well as
all the associated storage.
_X_F_r_e_e_G_C can generate a _B_a_d_G_C error.
To obtain the _G_C_o_n_t_e_x_t resource ID for a given GC, use
_X_G_C_o_n_t_e_x_t_F_r_o_m_G_C.
__
││
GContext XGContextFromGC(_g_c)
GC _g_c;
_g_c Specifies the GC for which you want the resource
ID.
││__
Xlib usually defers sending changes to the components of a
GC to the server until a graphics function is actually
called with that GC. This permits batching of component
changes into a single server request. In some circum-
stances, however, it may be necessary for the client to
explicitly force sending the changes to the server. An
example might be when a protocol extension uses the GC indi-
rectly, in such a way that the extension interface cannot
know what GC will be used. To force sending GC component
changes, use _X_F_l_u_s_h_G_C.
__
││
void XFlushGC(_d_i_s_p_l_a_y, _g_c)
Display *_d_i_s_p_l_a_y;
GC _g_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
││__
220000
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
77..22.. UUssiinngg GGrraapphhiiccss CCoonntteexxtt CCoonnvveenniieennccee RRoouuttiinneess
This section discusses how to set the:
· Foreground, background, plane mask, or function compo-
nents
· Line attributes and dashes components
· Fill style and fill rule components
· Fill tile and stipple components
· Font component
· Clip region component
· Arc mode, subwindow mode, and graphics exposure compo-
nents
77..22..11.. SSeettttiinngg tthhee FFoorreeggrroouunndd,, BBaacckkggrroouunndd,, FFuunnccttiioonn,, oorr
PPllaannee MMaasskk
To set the foreground, background, plane mask, and function
components for a given GC, use _X_S_e_t_S_t_a_t_e.
220011
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetState(_d_i_s_p_l_a_y, _g_c, _f_o_r_e_g_r_o_u_n_d, _b_a_c_k_g_r_o_u_n_d, _f_u_n_c_t_i_o_n, _p_l_a_n_e___m_a_s_k)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned long _f_o_r_e_g_r_o_u_n_d, _b_a_c_k_g_r_o_u_n_d;
int _f_u_n_c_t_i_o_n;
unsigned long _p_l_a_n_e___m_a_s_k;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_f_o_r_e_g_r_o_u_n_d
Specifies the foreground you want to set for the
specified GC.
_b_a_c_k_g_r_o_u_n_d
Specifies the background you want to set for the
specified GC.
_f_u_n_c_t_i_o_n Specifies the function you want to set for the
specified GC.
_p_l_a_n_e___m_a_s_k
Specifies the plane mask.
││__
_X_S_e_t_S_t_a_t_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e errors.
To set the foreground of a given GC, use _X_S_e_t_F_o_r_e_g_r_o_u_n_d.
__
││
XSetForeground(_d_i_s_p_l_a_y, _g_c, _f_o_r_e_g_r_o_u_n_d)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned long _f_o_r_e_g_r_o_u_n_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_f_o_r_e_g_r_o_u_n_d
Specifies the foreground you want to set for the
specified GC.
││__
_X_S_e_t_F_o_r_e_g_r_o_u_n_d can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C errors.
To set the background of a given GC, use _X_S_e_t_B_a_c_k_g_r_o_u_n_d.
220022
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetBackground(_d_i_s_p_l_a_y, _g_c, _b_a_c_k_g_r_o_u_n_d)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned long _b_a_c_k_g_r_o_u_n_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_b_a_c_k_g_r_o_u_n_d
Specifies the background you want to set for the
specified GC.
││__
_X_S_e_t_B_a_c_k_g_r_o_u_n_d can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C errors.
To set the display function in a given GC, use _X_S_e_t_F_u_n_c_t_i_o_n.
__
││
XSetFunction(_d_i_s_p_l_a_y, _g_c, _f_u_n_c_t_i_o_n)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _f_u_n_c_t_i_o_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_f_u_n_c_t_i_o_n Specifies the function you want to set for the
specified GC.
││__
_X_S_e_t_F_u_n_c_t_i_o_n can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e
errors.
To set the plane mask of a given GC, use _X_S_e_t_P_l_a_n_e_M_a_s_k.
220033
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetPlaneMask(_d_i_s_p_l_a_y, _g_c, _p_l_a_n_e___m_a_s_k)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned long _p_l_a_n_e___m_a_s_k;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_p_l_a_n_e___m_a_s_k
Specifies the plane mask.
││__
_X_S_e_t_P_l_a_n_e_M_a_s_k can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C errors.
77..22..22.. SSeettttiinngg tthhee LLiinnee AAttttrriibbuutteess aanndd DDaasshheess
To set the line drawing components of a given GC, use _X_S_e_t_-
_L_i_n_e_A_t_t_r_i_b_u_t_e_s.
220044
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetLineAttributes(_d_i_s_p_l_a_y, _g_c, _l_i_n_e___w_i_d_t_h, _l_i_n_e___s_t_y_l_e, _c_a_p___s_t_y_l_e, _j_o_i_n___s_t_y_l_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
unsigned int _l_i_n_e___w_i_d_t_h;
int _l_i_n_e___s_t_y_l_e;
int _c_a_p___s_t_y_l_e;
int _j_o_i_n___s_t_y_l_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_l_i_n_e___w_i_d_t_h
Specifies the line-width you want to set for the
specified GC.
_l_i_n_e___s_t_y_l_e
Specifies the line-style you want to set for the
specified GC. You can pass _L_i_n_e_S_o_l_i_d, _L_i_n_e_O_n_O_f_f_-
_D_a_s_h, or _L_i_n_e_D_o_u_b_l_e_D_a_s_h.
_c_a_p___s_t_y_l_e Specifies the line-style and cap-style you want to
set for the specified GC. You can pass _C_a_p_N_o_t_-
_L_a_s_t, _C_a_p_B_u_t_t, _C_a_p_R_o_u_n_d, or _C_a_p_P_r_o_j_e_c_t_i_n_g.
_j_o_i_n___s_t_y_l_e
Specifies the line join-style you want to set for
the specified GC. You can pass _J_o_i_n_M_i_t_e_r, _J_o_i_n_-
_R_o_u_n_d, or _J_o_i_n_B_e_v_e_l.
││__
_X_S_e_t_L_i_n_e_A_t_t_r_i_b_u_t_e_s can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_-
_V_a_l_u_e errors.
To set the dash-offset and dash-list for dashed line styles
of a given GC, use _X_S_e_t_D_a_s_h_e_s.
220055
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetDashes(_d_i_s_p_l_a_y, _g_c, _d_a_s_h___o_f_f_s_e_t, _d_a_s_h___l_i_s_t, _n)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _d_a_s_h___o_f_f_s_e_t;
char _d_a_s_h___l_i_s_t[];
int _n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_d_a_s_h___o_f_f_s_e_t
Specifies the phase of the pattern for the dashed
line-style you want to set for the specified GC.
_d_a_s_h___l_i_s_t Specifies the dash-list for the dashed line-style
you want to set for the specified GC.
_n Specifies the number of elements in dash_list.
││__
The _X_S_e_t_D_a_s_h_e_s function sets the dash-offset and dash-list
attributes for dashed line styles in the specified GC.
There must be at least one element in the specified
dash_list, or a _B_a_d_V_a_l_u_e error results. The initial and
alternating elements (second, fourth, and so on) of the
dash_list are the even dashes, and the others are the odd
dashes. Each element specifies a dash length in pixels.
All of the elements must be nonzero, or a _B_a_d_V_a_l_u_e error
results. Specifying an odd-length list is equivalent to
specifying the same list concatenated with itself to produce
an even-length list.
The dash-offset defines the phase of the pattern, specifying
how many pixels into the dash-list the pattern should actu-
ally begin in any single graphics request. Dashing is con-
tinuous through path elements combined with a join-style but
is reset to the dash-offset between each sequence of joined
lines.
The unit of measure for dashes is the same for the ordinary
coordinate system. Ideally, a dash length is measured along
the slope of the line, but implementations are only required
to match this ideal for horizontal and vertical lines.
Failing the ideal semantics, it is suggested that the length
be measured along the major axis of the line. The major
axis is defined as the x axis for lines drawn at an angle of
between -45 and +45 degrees or between 135 and 225 degrees
from the x axis. For all other lines, the major axis is the
y axis.
220066
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_S_e_t_D_a_s_h_e_s can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e
errors.
77..22..33.. SSeettttiinngg tthhee FFiillll SSttyyllee aanndd FFiillll RRuullee
To set the fill-style of a given GC, use _X_S_e_t_F_i_l_l_S_t_y_l_e.
__
││
XSetFillStyle(_d_i_s_p_l_a_y, _g_c, _f_i_l_l___s_t_y_l_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _f_i_l_l___s_t_y_l_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_f_i_l_l___s_t_y_l_e
Specifies the fill-style you want to set for the
specified GC. You can pass _F_i_l_l_S_o_l_i_d, _F_i_l_l_T_i_l_e_d,
_F_i_l_l_S_t_i_p_p_l_e_d, or _F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d.
││__
_X_S_e_t_F_i_l_l_S_t_y_l_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e
errors.
To set the fill-rule of a given GC, use _X_S_e_t_F_i_l_l_R_u_l_e.
__
││
XSetFillRule(_d_i_s_p_l_a_y, _g_c, _f_i_l_l___r_u_l_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _f_i_l_l___r_u_l_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_f_i_l_l___r_u_l_e Specifies the fill-rule you want to set for the
specified GC. You can pass _E_v_e_n_O_d_d_R_u_l_e or _W_i_n_d_i_n_-
_g_R_u_l_e.
││__
_X_S_e_t_F_i_l_l_R_u_l_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e
errors.
77..22..44.. SSeettttiinngg tthhee FFiillll TTiillee aanndd SSttiippppllee
Some displays have hardware support for tiling or stippling
with patterns of specific sizes. Tiling and stippling oper-
ations that restrict themselves to those specific sizes run
220077
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
much faster than such operations with arbitrary size pat-
terns. Xlib provides functions that you can use to deter-
mine the best size, tile, or stipple for the display as well
as to set the tile or stipple shape and the tile or stipple
origin.
To obtain the best size of a tile, stipple, or cursor, use
_X_Q_u_e_r_y_B_e_s_t_S_i_z_e.
__
││
Status XQueryBestSize(_d_i_s_p_l_a_y, _c_l_a_s_s, _w_h_i_c_h___s_c_r_e_e_n, _w_i_d_t_h, _h_e_i_g_h_t, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int _c_l_a_s_s;
Drawable _w_h_i_c_h___s_c_r_e_e_n;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_l_a_s_s Specifies the class that you are interested in.
You can pass _T_i_l_e_S_h_a_p_e, _C_u_r_s_o_r_S_h_a_p_e, or _S_t_i_p_p_l_e_-
_S_h_a_p_e.
_w_h_i_c_h___s_c_r_e_e_n
Specifies any drawable on the screen.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height of the object best
supported by the display hardware.
││__
The _X_Q_u_e_r_y_B_e_s_t_S_i_z_e function returns the best or closest size
to the specified size. For _C_u_r_s_o_r_S_h_a_p_e, this is the largest
size that can be fully displayed on the screen specified by
which_screen. For _T_i_l_e_S_h_a_p_e, this is the size that can be
tiled fastest. For _S_t_i_p_p_l_e_S_h_a_p_e, this is the size that can
be stippled fastest. For _C_u_r_s_o_r_S_h_a_p_e, the drawable indi-
cates the desired screen. For _T_i_l_e_S_h_a_p_e and _S_t_i_p_p_l_e_S_h_a_p_e,
the drawable indicates the screen and possibly the window
class and depth. An _I_n_p_u_t_O_n_l_y window cannot be used as the
drawable for _T_i_l_e_S_h_a_p_e or _S_t_i_p_p_l_e_S_h_a_p_e, or a _B_a_d_M_a_t_c_h error
results.
_X_Q_u_e_r_y_B_e_s_t_S_i_z_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_M_a_t_c_h, and _B_a_d_-
_V_a_l_u_e errors.
To obtain the best fill tile shape, use _X_Q_u_e_r_y_B_e_s_t_T_i_l_e.
220088
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XQueryBestTile(_d_i_s_p_l_a_y, _w_h_i_c_h___s_c_r_e_e_n, _w_i_d_t_h, _h_e_i_g_h_t, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Drawable _w_h_i_c_h___s_c_r_e_e_n;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w_h_i_c_h___s_c_r_e_e_n
Specifies any drawable on the screen.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height of the object best
supported by the display hardware.
││__
The _X_Q_u_e_r_y_B_e_s_t_T_i_l_e 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
_I_n_p_u_t_O_n_l_y window is used as the drawable, a _B_a_d_M_a_t_c_h error
results.
_X_Q_u_e_r_y_B_e_s_t_T_i_l_e can generate _B_a_d_D_r_a_w_a_b_l_e and _B_a_d_M_a_t_c_h errors.
To obtain the best stipple shape, use _X_Q_u_e_r_y_B_e_s_t_S_t_i_p_p_l_e.
220099
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XQueryBestStipple(_d_i_s_p_l_a_y, _w_h_i_c_h___s_c_r_e_e_n, _w_i_d_t_h, _h_e_i_g_h_t, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Drawable _w_h_i_c_h___s_c_r_e_e_n;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w_h_i_c_h___s_c_r_e_e_n
Specifies any drawable on the screen.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height of the object best
supported by the display hardware.
││__
The _X_Q_u_e_r_y_B_e_s_t_S_t_i_p_p_l_e function returns the best or closest
size, that is, the size that can be stippled fastest on the
screen specified by which_screen. The drawable indicates
the screen and possibly the window class and depth. If an
_I_n_p_u_t_O_n_l_y window is used as the drawable, a _B_a_d_M_a_t_c_h error
results.
_X_Q_u_e_r_y_B_e_s_t_S_t_i_p_p_l_e can generate _B_a_d_D_r_a_w_a_b_l_e and _B_a_d_M_a_t_c_h
errors.
To set the fill tile of a given GC, use _X_S_e_t_T_i_l_e.
__
││
XSetTile(_d_i_s_p_l_a_y, _g_c, _t_i_l_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
Pixmap _t_i_l_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_t_i_l_e Specifies the fill tile you want to set for the
specified GC.
││__
The tile and GC must have the same depth, or a _B_a_d_M_a_t_c_h
error results.
221100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_S_e_t_T_i_l_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and _B_a_d_-
_P_i_x_m_a_p errors.
To set the stipple of a given GC, use _X_S_e_t_S_t_i_p_p_l_e.
__
││
XSetStipple(_d_i_s_p_l_a_y, _g_c, _s_t_i_p_p_l_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
Pixmap _s_t_i_p_p_l_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_s_t_i_p_p_l_e Specifies the stipple you want to set for the
specified GC.
││__
The stipple must have a depth of one, or a _B_a_d_M_a_t_c_h error
results.
_X_S_e_t_S_t_i_p_p_l_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and _B_a_d_-
_P_i_x_m_a_p errors.
To set the tile or stipple origin of a given GC, use
_X_S_e_t_T_S_O_r_i_g_i_n.
__
││
XSetTSOrigin(_d_i_s_p_l_a_y, _g_c, _t_s___x___o_r_i_g_i_n, _t_s___y___o_r_i_g_i_n)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _t_s___x___o_r_i_g_i_n, _t_s___y___o_r_i_g_i_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_t_s___x___o_r_i_g_i_n
_t_s___y___o_r_i_g_i_n
Specify the x and y coordinates of the tile and
stipple origin.
││__
When graphics requests call for tiling or stippling, the
parent's origin will be interpreted relative to whatever
destination drawable is specified in the graphics request.
_X_S_e_t_T_S_O_r_i_g_i_n can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C errors.
221111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
77..22..55.. SSeettttiinngg tthhee CCuurrrreenntt FFoonntt
To set the current font of a given GC, use _X_S_e_t_F_o_n_t.
__
││
XSetFont(_d_i_s_p_l_a_y, _g_c, _f_o_n_t)
Display *_d_i_s_p_l_a_y;
GC _g_c;
Font _f_o_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_f_o_n_t Specifies the font.
││__
_X_S_e_t_F_o_n_t can generate _B_a_d_A_l_l_o_c, _B_a_d_F_o_n_t, and _B_a_d_G_C errors.
77..22..66.. SSeettttiinngg tthhee CClliipp RReeggiioonn
Xlib provides functions that you can use to set the clip-
origin and the clip-mask or set the clip-mask to a list of
rectangles.
To set the clip-origin of a given GC, use _X_S_e_t_C_l_i_p_O_r_i_g_i_n.
__
││
XSetClipOrigin(_d_i_s_p_l_a_y, _g_c, _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_c_l_i_p___x___o_r_i_g_i_n
_c_l_i_p___y___o_r_i_g_i_n
Specify the x and y coordinates of the clip-mask
origin.
││__
The clip-mask origin is interpreted relative to the origin
of whatever destination drawable is specified in the graph-
ics request.
_X_S_e_t_C_l_i_p_O_r_i_g_i_n can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C errors.
To set the clip-mask of a given GC to the specified pixmap,
221122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
use _X_S_e_t_C_l_i_p_M_a_s_k.
__
││
XSetClipMask(_d_i_s_p_l_a_y, _g_c, _p_i_x_m_a_p)
Display *_d_i_s_p_l_a_y;
GC _g_c;
Pixmap _p_i_x_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_p_i_x_m_a_p Specifies the pixmap or _N_o_n_e.
││__
If the clip-mask is set to _N_o_n_e, the pixels are always drawn
(regardless of the clip-origin).
_X_S_e_t_C_l_i_p_M_a_s_k can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
_B_a_d_P_i_x_m_a_p errors.
To set the clip-mask of a given GC to the specified list of
rectangles, use _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s.
221133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetClipRectangles(_d_i_s_p_l_a_y, _g_c, _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n, _r_e_c_t_a_n_g_l_e_s, _n, _o_r_d_e_r_i_n_g)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n;
XRectangle _r_e_c_t_a_n_g_l_e_s[];
int _n;
int _o_r_d_e_r_i_n_g;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_c_l_i_p___x___o_r_i_g_i_n
_c_l_i_p___y___o_r_i_g_i_n
Specify the x and y coordinates of the clip-mask
origin.
_r_e_c_t_a_n_g_l_e_s
Specifies an array of rectangles that define the
clip-mask.
_n Specifies the number of rectangles.
_o_r_d_e_r_i_n_g Specifies the ordering relations on the rectan-
gles. You can pass _U_n_s_o_r_t_e_d, _Y_S_o_r_t_e_d, _Y_X_S_o_r_t_e_d,
or _Y_X_B_a_n_d_e_d.
││__
The _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s function changes the clip-mask in the
specified GC to the specified list of rectangles and sets
the clip origin. The output is clipped to remain contained
within the rectangles. The clip-origin is interpreted rela-
tive to the origin of whatever destination drawable is spec-
ified in a graphics request. The rectangle coordinates are
interpreted relative to the clip-origin. The rectangles
should be nonintersecting, or the graphics results will be
undefined. Note that the list of rectangles can be empty,
which effectively disables output. This is the opposite of
passing _N_o_n_e as the clip-mask in _X_C_r_e_a_t_e_G_C, _X_C_h_a_n_g_e_G_C, and
_X_S_e_t_C_l_i_p_M_a_s_k.
If known by the client, ordering relations on the rectangles
can be specified with the ordering argument. This may pro-
vide faster operation by the server. If an incorrect order-
ing is specified, the X server may generate a _B_a_d_M_a_t_c_h
error, but it is not required to do so. If no error is gen-
erated, the graphics results are undefined. _U_n_s_o_r_t_e_d means
the rectangles are in arbitrary order. _Y_S_o_r_t_e_d means that
the rectangles are nondecreasing in their Y origin.
_Y_X_S_o_r_t_e_d additionally constrains _Y_S_o_r_t_e_d order in that all
rectangles with an equal Y origin are nondecreasing in their
X origin. _Y_X_B_a_n_d_e_d additionally constrains _Y_X_S_o_r_t_e_d by
221144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
requiring that, for every possible Y scanline, all rectan-
gles that include that scanline have an identical Y origins
and Y extents.
_X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, _B_a_d_M_a_t_c_h,
and _B_a_d_V_a_l_u_e errors.
Xlib provides a set of basic functions for performing region
arithmetic. For information about these functions, see sec-
tion 16.5.
77..22..77.. SSeettttiinngg tthhee AArrcc MMooddee,, SSuubbwwiinnddooww MMooddee,, aanndd GGrraapphhiiccss
EExxppoossuurree
To set the arc mode of a given GC, use _X_S_e_t_A_r_c_M_o_d_e.
__
││
XSetArcMode(_d_i_s_p_l_a_y, _g_c, _a_r_c___m_o_d_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _a_r_c___m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_a_r_c___m_o_d_e Specifies the arc mode. You can pass _A_r_c_C_h_o_r_d or
_A_r_c_P_i_e_S_l_i_c_e.
││__
_X_S_e_t_A_r_c_M_o_d_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e
errors.
To set the subwindow mode of a given GC, use _X_S_e_t_S_u_b_w_i_n_d_o_w_-
_M_o_d_e.
221155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetSubwindowMode(_d_i_s_p_l_a_y, _g_c, _s_u_b_w_i_n_d_o_w___m_o_d_e)
Display *_d_i_s_p_l_a_y;
GC _g_c;
int _s_u_b_w_i_n_d_o_w___m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_s_u_b_w_i_n_d_o_w___m_o_d_e
Specifies the subwindow mode. You can pass _C_l_i_p_-
_B_y_C_h_i_l_d_r_e_n or _I_n_c_l_u_d_e_I_n_f_e_r_i_o_r_s.
││__
_X_S_e_t_S_u_b_w_i_n_d_o_w_M_o_d_e can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_V_a_l_u_e
errors.
To set the graphics-exposures flag of a given GC, use _X_S_e_t_-
_G_r_a_p_h_i_c_s_E_x_p_o_s_u_r_e_s.
__
││
XSetGraphicsExposures(_d_i_s_p_l_a_y, _g_c, _g_r_a_p_h_i_c_s___e_x_p_o_s_u_r_e_s)
Display *_d_i_s_p_l_a_y;
GC _g_c;
Bool _g_r_a_p_h_i_c_s___e_x_p_o_s_u_r_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_g_r_a_p_h_i_c_s___e_x_p_o_s_u_r_e_s
Specifies a Boolean value that indicates whether
you want _G_r_a_p_h_i_c_s_E_x_p_o_s_e and _N_o_E_x_p_o_s_e events to be
reported when calling _X_C_o_p_y_A_r_e_a and _X_C_o_p_y_P_l_a_n_e
with this GC.
││__
_X_S_e_t_G_r_a_p_h_i_c_s_E_x_p_o_s_u_r_e_s can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, and _B_a_d_-
_V_a_l_u_e errors.
221166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 88
GGrraapphhiiccss FFuunnccttiioonnss
Once you have established a connection to a display, you can
use the Xlib graphics functions to:
· Clear and copy areas
· Draw points, lines, rectangles, and arcs
· Fill areas
· Manipulate fonts
· Draw text
· Transfer images between clients and the server
If the same drawable and GC is used for each call, Xlib
batches back-to-back calls to _X_D_r_a_w_P_o_i_n_t, _X_D_r_a_w_L_i_n_e,
_X_D_r_a_w_R_e_c_t_a_n_g_l_e, _X_F_i_l_l_A_r_c, and _X_F_i_l_l_R_e_c_t_a_n_g_l_e. Note that
this reduces the total number of requests sent to the
server.
88..11.. CClleeaarriinngg AArreeaass
Xlib provides functions that you can use to clear an area or
the entire window. Because pixmaps do not have defined
backgrounds, they cannot be filled by using the functions
described in this section. Instead, to accomplish an analo-
gous operation on a pixmap, you should use _X_F_i_l_l_R_e_c_t_a_n_g_l_e,
which sets the pixmap to a known value.
To clear a rectangular area of a given window, use _X_C_l_e_a_r_-
_A_r_e_a.
221177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XClearArea(_d_i_s_p_l_a_y, _w, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _e_x_p_o_s_u_r_e_s)
Display *_d_i_s_p_l_a_y;
Window _w;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
Bool _e_x_p_o_s_u_r_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the window and specify the
upper-left corner of the rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the dimen-
sions of the rectangle.
_e_x_p_o_s_u_r_e_s Specifies a Boolean value that indicates if _E_x_p_o_s_e
events are to be generated.
││__
The _X_C_l_e_a_r_A_r_e_a function paints a rectangular area in the
specified window according to the specified dimensions with
the window's background pixel or pixmap. The subwindow-mode
effectively is _C_l_i_p_B_y_C_h_i_l_d_r_e_n. 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, the rectangle clipped by any children is filled with
this tile. If the window has background _N_o_n_e, the contents
of the window are not changed. In either case, if exposures
is _T_r_u_e, one or more _E_x_p_o_s_e events are generated for regions
of the rectangle that are either visible or are being
retained in a backing store. If you specify a window whose
class is _I_n_p_u_t_O_n_l_y, a _B_a_d_M_a_t_c_h error results.
_X_C_l_e_a_r_A_r_e_a can generate _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
errors.
To clear the entire area in a given window, use _X_C_l_e_a_r_W_i_n_-
_d_o_w.
221188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XClearWindow(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_C_l_e_a_r_W_i_n_d_o_w function clears the entire area in the
specified window and is equivalent to _X_C_l_e_a_r_A_r_e_a (display,
w, 0, 0, 0, 0, _F_a_l_s_e). If the window has a defined back-
ground tile, the rectangle is tiled with a plane-mask of all
ones and _G_X_c_o_p_y function. If the window has background
_N_o_n_e, the contents of the window are not changed. If you
specify a window whose class is _I_n_p_u_t_O_n_l_y, a _B_a_d_M_a_t_c_h error
results.
_X_C_l_e_a_r_W_i_n_d_o_w can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w errors.
88..22.. CCooppyyiinngg AArreeaass
Xlib provides functions that you can use to copy an area or
a bit plane.
To copy an area between drawables of the same root and
depth, use _X_C_o_p_y_A_r_e_a.
221199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XCopyArea(_d_i_s_p_l_a_y, _s_r_c, _d_e_s_t, _g_c, _s_r_c___x, _s_r_c___y, _w_i_d_t_h, _h_e_i_g_h_t, _d_e_s_t___x, _d_e_s_t___y)
Display *_d_i_s_p_l_a_y;
Drawable _s_r_c, _d_e_s_t;
GC _g_c;
int _s_r_c___x, _s_r_c___y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
int _d_e_s_t___x, _d_e_s_t___y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_r_c
_d_e_s_t Specify the source and destination rectangles to
be combined.
_g_c Specifies the GC.
_s_r_c___x
_s_r_c___y Specify the x and y coordinates, which are rela-
tive to the origin of the source rectangle and
specify its upper-left corner.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the dimen-
sions of both the source and destination rectan-
gles.
_d_e_s_t___x
_d_e_s_t___y Specify the x and y coordinates, which are rela-
tive to the origin of the destination rectangle
and specify its upper-left corner.
││__
The _X_C_o_p_y_A_r_e_a function combines the specified rectangle of
src with the specified rectangle of dest. The drawables
must have the same root and depth, or a _B_a_d_M_a_t_c_h error
results.
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 following occurs on
all corresponding destination regions that are either visi-
ble or are retained in backing store. If the destination is
a window with a background other than _N_o_n_e, corresponding
regions of the destination are tiled with that background
(with plane-mask of all ones and _G_X_c_o_p_y function). Regard-
less of tiling or whether the destination is a window or a
pixmap, if graphics-exposures is _T_r_u_e, then _G_r_a_p_h_i_c_s_E_x_p_o_s_e
events for all corresponding destination regions are gener-
ated. If graphics-exposures is _T_r_u_e but no _G_r_a_p_h_i_c_s_E_x_p_o_s_e
events are generated, a _N_o_E_x_p_o_s_e event is generated. Note
that by default graphics-exposures is _T_r_u_e in new GCs.
222200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This function uses these GC components: function, plane-
mask, subwindow-mode, graphics-exposures, clip-x-origin,
clip-y-origin, and clip-mask.
_X_C_o_p_y_A_r_e_a can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, and _B_a_d_M_a_t_c_h
errors.
To copy a single bit plane of a given drawable, use _X_C_o_p_y_-
_P_l_a_n_e.
__
││
XCopyPlane(_d_i_s_p_l_a_y, _s_r_c, _d_e_s_t, _g_c, _s_r_c___x, _s_r_c___y, _w_i_d_t_h, _h_e_i_g_h_t, _d_e_s_t___x, _d_e_s_t___y, _p_l_a_n_e)
Display *_d_i_s_p_l_a_y;
Drawable _s_r_c, _d_e_s_t;
GC _g_c;
int _s_r_c___x, _s_r_c___y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
int _d_e_s_t___x, _d_e_s_t___y;
unsigned long _p_l_a_n_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_r_c
_d_e_s_t Specify the source and destination rectangles to
be combined.
_g_c Specifies the GC.
_s_r_c___x
_s_r_c___y Specify the x and y coordinates, which are rela-
tive to the origin of the source rectangle and
specify its upper-left corner.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the dimen-
sions of both the source and destination rectan-
gles.
_d_e_s_t___x
_d_e_s_t___y Specify the x and y coordinates, which are rela-
tive to the origin of the destination rectangle
and specify its upper-left corner.
_p_l_a_n_e Specifies the bit plane. You must set exactly one
bit to 1.
││__
The _X_C_o_p_y_P_l_a_n_e function uses a single bit plane of the spec-
ified source rectangle combined with the specified GC to
modify the specified rectangle of dest. The drawables must
have the same root but need not have the same depth. If the
drawables do not have the same root, a _B_a_d_M_a_t_c_h error
222211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
results. If plane does not have exactly one bit set to 1
and the value of plane is not less than 2_n, where _n is the
depth of src, a _B_a_d_V_a_l_u_e error results.
Effectively, _X_C_o_p_y_P_l_a_n_e forms a pixmap of the same depth as
the rectangle of dest and with a 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 _C_o_p_y_A_r_e_a
protocol request is performed with all the same exposure
semantics. This can also be thought of as using the speci-
fied region of the source bit plane as a stipple with a
fill-style of _F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d for filling a rectangular
area of the destination.
This function uses these GC components: function, plane-
mask, foreground, background, subwindow-mode, graphics-expo-
sures, clip-x-origin, clip-y-origin, and clip-mask.
_X_C_o_p_y_P_l_a_n_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
_B_a_d_V_a_l_u_e errors.
88..33.. DDrraawwiinngg PPooiinnttss,, LLiinneess,, RReeccttaanngglleess,, aanndd AArrccss
Xlib provides functions that you can use to draw:
· A single point or multiple points
· A single line or multiple lines
· A single rectangle or multiple rectangles
· A single arc or multiple arcs
Some of the functions described in the following sections
use these structures:
__
││
typedef struct {
short x1, y1, x2, y2;
} XSegment;
││__
222222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
short x, y;
} XPoint;
││__
__
││
typedef struct {
short x, y;
unsigned short width, height;
} XRectangle;
││__
__
││
typedef struct {
short x, y;
unsigned short width, height;
short angle1, angle2; /* Degrees * 64 */
} XArc;
││__
All x and y members are signed integers. The width and
height members are 16-bit unsigned integers. You should be
careful not to generate coordinates and sizes out of the
16-bit ranges, because the protocol only has 16-bit fields
for these values.
88..33..11.. DDrraawwiinngg SSiinnggllee aanndd MMuullttiippllee PPooiinnttss
To draw a single point in a given drawable, use _X_D_r_a_w_P_o_i_n_t.
222233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawPoint(_d_i_s_p_l_a_y, _d, _g_c, _x, _y)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates where you want the
point drawn.
││__
To draw multiple points in a given drawable, use _X_D_r_a_w_-
_P_o_i_n_t_s.
__
││
XDrawPoints(_d_i_s_p_l_a_y, _d, _g_c, _p_o_i_n_t_s, _n_p_o_i_n_t_s, _m_o_d_e)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XPoint *_p_o_i_n_t_s;
int _n_p_o_i_n_t_s;
int _m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_p_o_i_n_t_s Specifies an array of points.
_n_p_o_i_n_t_s Specifies the number of points in the array.
_m_o_d_e Specifies the coordinate mode. You can pass
_C_o_o_r_d_M_o_d_e_O_r_i_g_i_n or _C_o_o_r_d_M_o_d_e_P_r_e_v_i_o_u_s.
││__
The _X_D_r_a_w_P_o_i_n_t function uses the foreground pixel and func-
tion components of the GC to draw a single point into the
specified drawable; _X_D_r_a_w_P_o_i_n_t_s draws multiple points this
way. _C_o_o_r_d_M_o_d_e_O_r_i_g_i_n treats all coordinates as relative to
the origin, and _C_o_o_r_d_M_o_d_e_P_r_e_v_i_o_u_s treats all coordinates
after the first as relative to the previous point. _X_D_r_a_w_-
_P_o_i_n_t_s draws the points in the order listed in the array.
222244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Both functions use these GC components: function, plane-
mask, foreground, subwindow-mode, clip-x-origin, clip-y-ori-
gin, and clip-mask.
_X_D_r_a_w_P_o_i_n_t can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, and _B_a_d_M_a_t_c_h
errors. _X_D_r_a_w_P_o_i_n_t_s can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_-
_M_a_t_c_h, and _B_a_d_V_a_l_u_e errors.
88..33..22.. DDrraawwiinngg SSiinnggllee aanndd MMuullttiippllee LLiinneess
To draw a single line between two points in a given draw-
able, use _X_D_r_a_w_L_i_n_e.
__
││
XDrawLine(_d_i_s_p_l_a_y, _d, _g_c, _x_1, _y_1, _x_2, _y_2)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x_1, _y_1, _x_2, _y_2;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x_1
_y_1
_x_2
_y_2 Specify the points (x1, y1) and (x2, y2) to be
connected.
││__
To draw multiple lines in a given drawable, use _X_D_r_a_w_L_i_n_e_s.
222255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawLines(_d_i_s_p_l_a_y, _d, _g_c, _p_o_i_n_t_s, _n_p_o_i_n_t_s, _m_o_d_e)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XPoint *_p_o_i_n_t_s;
int _n_p_o_i_n_t_s;
int _m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_p_o_i_n_t_s Specifies an array of points.
_n_p_o_i_n_t_s Specifies the number of points in the array.
_m_o_d_e Specifies the coordinate mode. You can pass
_C_o_o_r_d_M_o_d_e_O_r_i_g_i_n or _C_o_o_r_d_M_o_d_e_P_r_e_v_i_o_u_s.
││__
To draw multiple, unconnected lines in a given drawable, use
_X_D_r_a_w_S_e_g_m_e_n_t_s.
__
││
XDrawSegments(_d_i_s_p_l_a_y, _d, _g_c, _s_e_g_m_e_n_t_s, _n_s_e_g_m_e_n_t_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XSegment *_s_e_g_m_e_n_t_s;
int _n_s_e_g_m_e_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_s_e_g_m_e_n_t_s Specifies an array of segments.
_n_s_e_g_m_e_n_t_s Specifies the number of segments in the array.
││__
The _X_D_r_a_w_L_i_n_e 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, _X_D_r_a_w_L_i_n_e does not draw a
pixel more than once. If lines intersect, the intersecting
pixels are drawn multiple times.
222266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The _X_D_r_a_w_L_i_n_e_s 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 _X_P_o_i_n_t 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, _X_D_r_a_w_L_i_n_e_s does
not draw a pixel more than once. 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 _P_o_l_y_L_i_n_e protocol
request were a single, filled shape. _C_o_o_r_d_M_o_d_e_O_r_i_g_i_n treats
all coordinates as relative to the origin, and _C_o_o_r_d_M_o_d_e_P_r_e_-
_v_i_o_u_s treats all coordinates after the first as relative to
the previous point.
The _X_D_r_a_w_S_e_g_m_e_n_t_s function draws multiple, unconnected
lines. For each segment, _X_D_r_a_w_S_e_g_m_e_n_t_s draws a line between
(x1, y1) and (x2, y2). It draws the lines in the order
listed in the array of _X_S_e_g_m_e_n_t structures and does not per-
form joining at coincident endpoints. For any given line,
_X_D_r_a_w_S_e_g_m_e_n_t_s does not draw a pixel more than once. If
lines intersect, the intersecting pixels are drawn multiple
times.
All three functions use these GC components: function,
plane-mask, line-width, line-style, cap-style, fill-style,
subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
The _X_D_r_a_w_L_i_n_e_s function also uses the join-style GC compo-
nent. All three functions also use these GC mode-dependent
components: foreground, background, tile, stipple, tile-
stipple-x-origin, tile-stipple-y-origin, dash-offset, and
dash-list.
_X_D_r_a_w_L_i_n_e, _X_D_r_a_w_L_i_n_e_s, and _X_D_r_a_w_S_e_g_m_e_n_t_s can generate _B_a_d_-
_D_r_a_w_a_b_l_e, _B_a_d_G_C, and _B_a_d_M_a_t_c_h errors. _X_D_r_a_w_L_i_n_e_s also can
generate _B_a_d_V_a_l_u_e errors.
88..33..33.. DDrraawwiinngg SSiinnggllee aanndd MMuullttiippllee RReeccttaanngglleess
To draw the outline of a single rectangle in a given draw-
able, use _X_D_r_a_w_R_e_c_t_a_n_g_l_e.
222277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawRectangle(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which specify the
upper-left corner of the rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which specify the
dimensions of the rectangle.
││__
To draw the outline of multiple rectangles in a given draw-
able, use _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s.
__
││
XDrawRectangles(_d_i_s_p_l_a_y, _d, _g_c, _r_e_c_t_a_n_g_l_e_s, _n_r_e_c_t_a_n_g_l_e_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XRectangle _r_e_c_t_a_n_g_l_e_s[];
int _n_r_e_c_t_a_n_g_l_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_r_e_c_t_a_n_g_l_e_s
Specifies an array of rectangles.
_n_r_e_c_t_a_n_g_l_e_s
Specifies the number of rectangles in the array.
││__
The _X_D_r_a_w_R_e_c_t_a_n_g_l_e and _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s functions draw the
outlines of the specified rectangle or rectangles as if a
five-point _P_o_l_y_L_i_n_e protocol request were specified for each
rectangle:
222288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
[x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]
For the specified rectangle or rectangles, these functions
do not draw a pixel more than once. _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s draws
the rectangles in the order listed in the array. If rectan-
gles intersect, the intersecting pixels are drawn multiple
times.
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 compo-
nents: foreground, background, tile, stipple, tile-stipple-
x-origin, tile-stipple-y-origin, dash-offset, and dash-list.
_X_D_r_a_w_R_e_c_t_a_n_g_l_e and _X_D_r_a_w_R_e_c_t_a_n_g_l_e_s can generate _B_a_d_D_r_a_w_a_b_l_e,
_B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.
88..33..44.. DDrraawwiinngg SSiinnggllee aanndd MMuullttiippllee AArrccss
To draw a single arc in a given drawable, use _X_D_r_a_w_A_r_c.
222299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawArc(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _a_n_g_l_e_1, _a_n_g_l_e_2)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
int _a_n_g_l_e_1, _a_n_g_l_e_2;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the drawable and specify the
upper-left corner of the bounding rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the major
and minor axes of the arc.
_a_n_g_l_e_1 Specifies the start of the arc relative to the
three-o'clock position from the center, in units
of degrees * 64.
_a_n_g_l_e_2 Specifies the path and extent of the arc relative
to the start of the arc, in units of degrees * 64.
││__
To draw multiple arcs in a given drawable, use _X_D_r_a_w_A_r_c_s.
223300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawArcs(_d_i_s_p_l_a_y, _d, _g_c, _a_r_c_s, _n_a_r_c_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XArc *_a_r_c_s;
int _n_a_r_c_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_a_r_c_s Specifies an array of arcs.
_n_a_r_c_s Specifies the number of arcs in the array.
││__
_X_D_r_a_w_A_r_c draws a single circular or elliptical arc, and
_X_D_r_a_w_A_r_c_s draws multiple circular or elliptical arcs. 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 mag-
nitude of angle2 is greater than 360 degrees, _X_D_r_a_w_A_r_c or
_X_D_r_a_w_A_r_c_s truncates it to 360 degrees.
For an arc specified as [_x,_y,_w_i_d_t_h,_h_e_i_g_h_t,_a_n_g_l_e1,_a_n_g_l_e2],
the origin of the major and minor axes is at
[_x+_w___i___d2___t___h__,_y+_h___e___i___g2___h___t__], and the infinitely thin path describing
the entire circle or ellipse intersects the horizontal axis
at [_x,_y+_h___e___i___g2___h___t__] and [_x+_w_i_d_t_h,_y+_h___e___i___g2___h___t__] and intersects the
vertical axis at [_x+_w___i___d2___t___h__,_y] and [_x+_w___i___d2___t___h__,_y+_h_e_i_g_h_t]. 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 by the two
infinitely thin paths consisting of all points whose perpen-
dicular distance from the path of the circle/ellipse is
equal to lw/2 (which may be a fractional value). The cap-
style and join-style are applied the same as for a line cor-
responding to the tangent of the circle/ellipse at the end-
point.
For an arc specified as [_x,_y,_w_i_d_t_h,_h_e_i_g_h_t,_a_n_g_l_e1,_a_n_g_l_e2],
the angles must be specified in the effectively skewed coor-
dinate system of the ellipse (for a circle, the angles and
coordinate systems are identical). The relationship between
these angles and angles expressed in the normal coordinate
system of the screen (as measured with a protractor) is as
223311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
follows:
skewed-angle=_a_t_a_n(tan(normal-angle)*_h___w_e___i_i___d_g___t_h___h_t__)+_a_d_j_u_s_t
The skewed-angle and normal-angle are expressed in radians
(rather than in degrees scaled by 64) in the range [0,2π]
and where atan returns a value in the range [-π2__,π2__] and
adjust is:
0 for normal-angle in the range [0,π2__]
π for normal-angle in the range [π2__,3__π2__]
2π for normal-angle in the range [3__π2__,2π]
For any given arc, _X_D_r_a_w_A_r_c and _X_D_r_a_w_A_r_c_s 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,
_X_D_r_a_w_A_r_c and _X_D_r_a_w_A_r_c_s 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.
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.
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 compo-
nents: foreground, background, tile, stipple, tile-stipple-
x-origin, tile-stipple-y-origin, dash-offset, and dash-list.
_X_D_r_a_w_A_r_c and _X_D_r_a_w_A_r_c_s can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, and
_B_a_d_M_a_t_c_h errors.
88..44.. FFiilllliinngg AArreeaass
Xlib provides functions that you can use to fill:
· A single rectangle or multiple rectangles
· A single polygon
223322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· A single arc or multiple arcs
88..44..11.. FFiilllliinngg SSiinnggllee aanndd MMuullttiippllee RReeccttaanngglleess
To fill a single rectangular area in a given drawable, use
_X_F_i_l_l_R_e_c_t_a_n_g_l_e.
__
││
XFillRectangle(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the drawable and specify the
upper-left corner of the rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the dimen-
sions of the rectangle to be filled.
││__
To fill multiple rectangular areas in a given drawable, use
_X_F_i_l_l_R_e_c_t_a_n_g_l_e_s.
223333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFillRectangles(_d_i_s_p_l_a_y, _d, _g_c, _r_e_c_t_a_n_g_l_e_s, _n_r_e_c_t_a_n_g_l_e_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XRectangle *_r_e_c_t_a_n_g_l_e_s;
int _n_r_e_c_t_a_n_g_l_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_r_e_c_t_a_n_g_l_e_s
Specifies an array of rectangles.
_n_r_e_c_t_a_n_g_l_e_s
Specifies the number of rectangles in the array.
││__
The _X_F_i_l_l_R_e_c_t_a_n_g_l_e and _X_F_i_l_l_R_e_c_t_a_n_g_l_e_s functions fill the
specified rectangle or rectangles as if a four-point
_F_i_l_l_P_o_l_y_g_o_n protocol request were specified for each rectan-
gle:
[x,y] [x+width,y] [x+width,y+height] [x,y+height]
Each function uses the x and y coordinates, width and height
dimensions, and GC you specify.
_X_F_i_l_l_R_e_c_t_a_n_g_l_e_s fills the rectangles in the order listed in
the array. For any given rectangle, _X_F_i_l_l_R_e_c_t_a_n_g_l_e and
_X_F_i_l_l_R_e_c_t_a_n_g_l_e_s do not draw a pixel more than once. If
rectangles intersect, the intersecting pixels are drawn mul-
tiple times.
Both functions use these GC components: function, plane-
mask, fill-style, subwindow-mode, clip-x-origin, clip-y-ori-
gin, and clip-mask. They also use these GC mode-dependent
components: foreground, background, tile, stipple, tile-
stipple-x-origin, and tile-stipple-y-origin.
_X_F_i_l_l_R_e_c_t_a_n_g_l_e and _X_F_i_l_l_R_e_c_t_a_n_g_l_e_s can generate _B_a_d_D_r_a_w_a_b_l_e,
_B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.
88..44..22.. FFiilllliinngg aa SSiinnggllee PPoollyyggoonn
To fill a polygon area in a given drawable, use _X_F_i_l_l_P_o_l_y_-
_g_o_n.
223344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFillPolygon(_d_i_s_p_l_a_y, _d, _g_c, _p_o_i_n_t_s, _n_p_o_i_n_t_s, _s_h_a_p_e, _m_o_d_e)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XPoint *_p_o_i_n_t_s;
int _n_p_o_i_n_t_s;
int _s_h_a_p_e;
int _m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_p_o_i_n_t_s Specifies an array of points.
_n_p_o_i_n_t_s Specifies the number of points in the array.
_s_h_a_p_e Specifies a shape that helps the server to improve
performance. You can pass _C_o_m_p_l_e_x, _C_o_n_v_e_x, or
_N_o_n_c_o_n_v_e_x.
_m_o_d_e Specifies the coordinate mode. You can pass
_C_o_o_r_d_M_o_d_e_O_r_i_g_i_n or _C_o_o_r_d_M_o_d_e_P_r_e_v_i_o_u_s.
││__
_X_F_i_l_l_P_o_l_y_g_o_n fills the region closed by the specified path.
The path is closed automatically if the last point in the
list does not coincide with the first point. _X_F_i_l_l_P_o_l_y_g_o_n
does not draw a pixel of the region more than once. _C_o_o_r_d_-
_M_o_d_e_O_r_i_g_i_n treats all coordinates as relative to the origin,
and _C_o_o_r_d_M_o_d_e_P_r_e_v_i_o_u_s treats all coordinates after the first
as relative to the previous point.
Depending on the specified shape, the following occurs:
· If shape is _C_o_m_p_l_e_x, the path may self-intersect. Note
that contiguous coincident points in the path are not
treated as self-intersection.
· If shape is _C_o_n_v_e_x, for every pair of points inside the
polygon, the line segment connecting them does not
intersect the path. If known by the client, specifying
_C_o_n_v_e_x can improve performance. If you specify _C_o_n_v_e_x
for a path that is not convex, the graphics results are
undefined.
· If shape is _N_o_n_c_o_n_v_e_x, the path does not self-inter-
sect, but the shape is not wholly convex. If known by
the client, specifying _N_o_n_c_o_n_v_e_x instead of _C_o_m_p_l_e_x may
improve performance. If you specify _N_o_n_c_o_n_v_e_x for a
223355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
self-intersecting path, the graphics results are unde-
fined.
The fill-rule of the GC controls the filling behavior of
self-intersecting polygons.
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, and tile-stipple-y-origin.
_X_F_i_l_l_P_o_l_y_g_o_n can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
_B_a_d_V_a_l_u_e errors.
88..44..33.. FFiilllliinngg SSiinnggllee aanndd MMuullttiippllee AArrccss
To fill a single arc in a given drawable, use _X_F_i_l_l_A_r_c.
__
││
XFillArc(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _a_n_g_l_e_1, _a_n_g_l_e_2)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
int _a_n_g_l_e_1, _a_n_g_l_e_2;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the drawable and specify the
upper-left corner of the bounding rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the major
and minor axes of the arc.
_a_n_g_l_e_1 Specifies the start of the arc relative to the
three-o'clock position from the center, in units
of degrees * 64.
_a_n_g_l_e_2 Specifies the path and extent of the arc relative
to the start of the arc, in units of degrees * 64.
││__
To fill multiple arcs in a given drawable, use _X_F_i_l_l_A_r_c_s.
223366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFillArcs(_d_i_s_p_l_a_y, _d, _g_c, _a_r_c_s, _n_a_r_c_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XArc *_a_r_c_s;
int _n_a_r_c_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_a_r_c_s Specifies an array of arcs.
_n_a_r_c_s Specifies the number of arcs in the array.
││__
For each arc, _X_F_i_l_l_A_r_c or _X_F_i_l_l_A_r_c_s 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 _A_r_c_C_h_o_r_d, the single line segment
joining the endpoints of the arc is used. For _A_r_c_P_i_e_S_l_i_c_e,
the two line segments joining the endpoints of the arc with
the center point are used. _X_F_i_l_l_A_r_c_s fills the arcs in the
order listed in the array. For any given arc, _X_F_i_l_l_A_r_c and
_X_F_i_l_l_A_r_c_s do not draw a pixel more than once. If regions
intersect, the intersecting pixels are drawn multiple times.
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, and tile-stipple-y-origin.
_X_F_i_l_l_A_r_c and _X_F_i_l_l_A_r_c_s can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, and
_B_a_d_M_a_t_c_h errors.
88..55.. FFoonntt MMeettrriiccss
A font is a graphical description of a set of characters
that are used to increase efficiency whenever a set of
small, similar sized patterns are repeatedly used.
This section discusses how to:
· Load and free fonts
· Obtain and free font names
· Compute character string sizes
223377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Compute logical extents
· Query character string sizes
The X server loads fonts whenever a program requests a new
font. The server can cache fonts for quick lookup. Fonts
are global across all screens in a server. Several levels
are possible when dealing with fonts. Most applications
simply use _X_L_o_a_d_Q_u_e_r_y_F_o_n_t to load a font and query the font
metrics.
Characters in fonts are regarded as masks. Except for image
text requests, the only pixels modified are those in which
bits are set to 1 in the character. This means that it
makes sense to draw text using stipples or tiles (for exam-
ple, many menus gray-out unusable entries).
223388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││ The _X_F_o_n_t_S_t_r_u_c_t structure contains all of the information
for the font and consists of the font-specific information
as well as a pointer to an array of _X_C_h_a_r_S_t_r_u_c_t structures
for the characters contained in the font. The _X_F_o_n_t_S_t_r_u_c_t,
_X_F_o_n_t_P_r_o_p, and _X_C_h_a_r_S_t_r_u_c_t structures contain:
typedef struct {
short lbearing; /* origin to left edge of raster */
short rbearing; /* origin to right edge of raster */
short width; /* advance to next char's origin */
short ascent; /* baseline to top edge of raster */
short descent; /* baseline to bottom edge of raster */
unsigned short attributes;/* per char flags (not predefined) */
} XCharStruct;
typedef struct {
Atom name;
unsigned long card32;
} XFontProp;
typedef struct { /* normal 16 bit characters are two bytes */
unsigned char byte1;
unsigned char byte2;
} XChar2b;
typedef struct {
XExtData *ext_data; /* hook for extension to hang data */
Font fid; /* Font id for this font */
unsigned direction; /* hint about the direction font is painted */
unsigned min_char_or_byte2;/* first character */
unsigned max_char_or_byte2;/* last character */
unsigned min_byte1; /* first row that exists */
unsigned max_byte1; /* last row that exists */
Bool all_chars_exist; /* flag if all characters have nonzero size */
unsigned default_char; /* char to print for undefined character */
int n_properties; /* how many properties there are */
XFontProp *properties; /* pointer to array of additional properties */
XCharStruct min_bounds; /* minimum bounds over all existing char */
XCharStruct max_bounds; /* maximum bounds over all existing char */
XCharStruct *per_char; /* first_char to last_char information */
int ascent; /* logical extent above baseline for spacing */
int descent; /* logical descent below baseline for spacing */
} XFontStruct;
││__
X supports single byte/character, two bytes/character
223399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
matrix, and 16-bit character text operations. Note that any
of these forms can be used with a font, but a single
byte/character text request can only specify a single byte
(that is, the first row of a 2-byte font). You should view
2-byte fonts as a two-dimensional matrix of defined charac-
ters: byte1 specifies the range of defined rows and 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 charac-
ters.
The bounding box of a character is defined by the
_X_C_h_a_r_S_t_r_u_c_t of that character. When characters are absent
from a font, the default_char is used. When fonts have all
characters of the same size, only the information in the
_X_F_o_n_t_S_t_r_u_c_t min and max bounds are used.
The members of the _X_F_o_n_t_S_t_r_u_c_t have the following semantics:
· The direction member can be either _F_o_n_t_L_e_f_t_T_o_R_i_g_h_t or
_F_o_n_t_R_i_g_h_t_T_o_L_e_f_t. It is just a hint as to whether most
_X_C_h_a_r_S_t_r_u_c_t elements have a positive (_F_o_n_t_L_e_f_t_T_o_R_i_g_h_t)
or a negative (_F_o_n_t_R_i_g_h_t_T_o_L_e_f_t) character width metric.
The core protocol defines no support for vertical text.
· If the min_byte1 and max_byte1 members are both zero,
min_char_or_byte2 specifies the linear character index
corresponding to the first element of the per_char
array, and max_char_or_byte2 specifies the linear char-
acter index of the last element.
If either min_byte1 or max_byte1 are nonzero, both
min_char_or_byte2 and max_char_or_byte2 are less than
256, and the 2-byte character index values correspond-
ing to the per_char array element N (counting from 0)
are:
byte1 = N/D + min_byte1
byte2 = N\D + min_char_or_byte2
where:
D = max_char_or_byte2 - min_char_or_byte2 + 1
/ = integer division
\ = integer modulus
· 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.
· If all_chars_exist is _T_r_u_e, all characters in the
per_char array have nonzero bounding boxes.
224400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· The default_char member specifies the character that
will be used when an 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, the default_char has byte1 in the most-
significant byte and byte2 in the least significant
byte. If the default_char itself specifies an unde-
fined or nonexistent character, no printing is per-
formed for an undefined or nonexistent character.
· The min_bounds and max_bounds members contain the most
extreme values of each individual _X_C_h_a_r_S_t_r_u_c_t component
over all elements of this array (and ignore nonexistent
characters). The bounding box of the font (the small-
est rectangle enclosing the shape obtained by superim-
posing all of the characters at the same origin [x,y])
has its upper-left coordinate at:
[x + min_bounds.lbearing, y - max_bounds.ascent]
Its width is:
max_bounds.rbearing - min_bounds.lbearing
Its height is:
max_bounds.ascent + max_bounds.descent
· The ascent member is the logical extent of the font
above the baseline that is used for determining line
spacing. Specific characters may extend beyond this.
· The descent member is the logical extent of the font at
or below the baseline that is used for determining line
spacing. Specific characters may extend beyond this.
· If the baseline is at Y-coordinate y, the logical
extent of the font is inclusive between the Y-coordi-
nate values (y - font.ascent) and (y + font.descent -
1). Typically, the minimum interline spacing between
rows of text is given by ascent + descent.
For a character origin at [x,y], the bounding box of a char-
acter (that is, the smallest rectangle that encloses the
character's shape) described in terms of _X_C_h_a_r_S_t_r_u_c_t compo-
nents is a rectangle with its upper-left corner at:
[x + lbearing, y - ascent]
224411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Its width is:
rbearing - lbearing
Its height is:
ascent + descent
The origin for the next character is defined to be:
[x + width, y]
The lbearing member defines the extent of the left edge of
the character ink from the origin. The rbearing member
defines the extent of the right edge of the character ink
from the origin. The ascent member defines the extent of
the top edge of the character ink from the origin. The
descent member defines the extent of the bottom edge of the
character ink from the origin. The width member defines the
logical width of the character.
Note that the baseline (the y position of the character ori-
gin) is logically viewed as being the scanline just below
nondescending characters. When descent is zero, only pixels
with Y-coordinates less than y are drawn, and the origin is
logically viewed as being coincident with the left edge of a
nonkerned character. When lbearing is zero, no pixels with
X-coordinate less than x are drawn. Any of the _X_C_h_a_r_S_t_r_u_c_t
metric members could be negative. If the width is negative,
the next character will be placed to the left of the current
origin.
The X protocol does not define the interpretation of the
attributes member in the _X_C_h_a_r_S_t_r_u_c_t structure. A nonexis-
tent character is represented with all members of its
_X_C_h_a_r_S_t_r_u_c_t set to zero.
A font is not guaranteed to have any properties. The inter-
pretation of the property value (for example, long or
unsigned long) must be derived from _a _p_r_i_o_r_i knowledge of
the property. A basic set of font properties is specified
in the X Consortium standard _X _L_o_g_i_c_a_l _F_o_n_t _D_e_s_c_r_i_p_t_i_o_n _C_o_n_-
_v_e_n_t_i_o_n_s.
88..55..11.. LLooaaddiinngg aanndd FFrreeeeiinngg FFoonnttss
Xlib provides functions that you can use to load fonts, get
font information, unload fonts, and free font information.
224422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
A few font functions use a _G_C_o_n_t_e_x_t resource ID or a font ID
interchangeably.
To load a given font, use _X_L_o_a_d_F_o_n_t.
__
││
Font XLoadFont(_d_i_s_p_l_a_y, _n_a_m_e)
Display *_d_i_s_p_l_a_y;
char *_n_a_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_a_m_e Specifies the name of the font, which is a null-
terminated string.
││__
The _X_L_o_a_d_F_o_n_t function loads the specified font and returns
its associated font ID. If the font name is not in the Host
Portable Character Encoding, the result is implementation-
dependent. Use of uppercase or lowercase does not matter.
When the characters ``?'' and ``*'' are used in a font name,
a pattern match is performed and any matching font is used.
In the pattern, the ``?'' character will match any single
character, and the ``*'' character will match any number of
characters. A structured format for font names is specified
in the X Consortium standard _X _L_o_g_i_c_a_l _F_o_n_t _D_e_s_c_r_i_p_t_i_o_n _C_o_n_-
_v_e_n_t_i_o_n_s. If _X_L_o_a_d_F_o_n_t was unsuccessful at loading the
specified font, a _B_a_d_N_a_m_e error results. 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 _X_U_n_l_o_a_d_F_o_n_t.
_X_L_o_a_d_F_o_n_t can generate _B_a_d_A_l_l_o_c and _B_a_d_N_a_m_e errors.
To return information about an available font, use _X_Q_u_e_r_y_-
_F_o_n_t.
__
││
XFontStruct *XQueryFont(_d_i_s_p_l_a_y, _f_o_n_t___I_D)
Display *_d_i_s_p_l_a_y;
XID _f_o_n_t___I_D;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_n_t___I_D Specifies the font ID or the _G_C_o_n_t_e_x_t ID.
││__
The _X_Q_u_e_r_y_F_o_n_t function returns a pointer to the _X_F_o_n_t_S_t_r_u_c_t
structure, which contains information associated with the
font. You can query a font or the font stored in a GC. The
224433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
font ID stored in the _X_F_o_n_t_S_t_r_u_c_t structure will be the
_G_C_o_n_t_e_x_t ID, and you need to be careful when using this ID
in other functions (see _X_G_C_o_n_t_e_x_t_F_r_o_m_G_C). If the font does
not exist, _X_Q_u_e_r_y_F_o_n_t returns NULL. To free this data, use
_X_F_r_e_e_F_o_n_t_I_n_f_o.
To perform a _X_L_o_a_d_F_o_n_t and _X_Q_u_e_r_y_F_o_n_t in a single operation,
use _X_L_o_a_d_Q_u_e_r_y_F_o_n_t.
__
││
XFontStruct *XLoadQueryFont(_d_i_s_p_l_a_y, _n_a_m_e)
Display *_d_i_s_p_l_a_y;
char *_n_a_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_a_m_e Specifies the name of the font, which is a null-
terminated string.
││__
The _X_L_o_a_d_Q_u_e_r_y_F_o_n_t function provides the most common way for
accessing a font. _X_L_o_a_d_Q_u_e_r_y_F_o_n_t both opens (loads) the
specified font and returns a pointer to the appropriate
_X_F_o_n_t_S_t_r_u_c_t structure. If the font name is not in the Host
Portable Character Encoding, the result is implementation-
dependent. If the font does not exist, _X_L_o_a_d_Q_u_e_r_y_F_o_n_t
returns NULL.
_X_L_o_a_d_Q_u_e_r_y_F_o_n_t can generate a _B_a_d_A_l_l_o_c error.
To unload the font and free the storage used by the font
structure that was allocated by _X_Q_u_e_r_y_F_o_n_t or _X_L_o_a_d_Q_u_e_r_y_-
_F_o_n_t, use _X_F_r_e_e_F_o_n_t.
__
││
XFreeFont(_d_i_s_p_l_a_y, _f_o_n_t___s_t_r_u_c_t)
Display *_d_i_s_p_l_a_y;
XFontStruct *_f_o_n_t___s_t_r_u_c_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_n_t___s_t_r_u_c_t
Specifies the storage associated with the font.
││__
The _X_F_r_e_e_F_o_n_t function deletes the association between the
font resource ID and the specified font and frees the
_X_F_o_n_t_S_t_r_u_c_t structure. The font itself will be freed when
no other resource references it. The data and the font
should not be referenced again.
224444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_F_r_e_e_F_o_n_t can generate a _B_a_d_F_o_n_t error.
To return a given font property, use _X_G_e_t_F_o_n_t_P_r_o_p_e_r_t_y.
__
││
Bool XGetFontProperty(_f_o_n_t___s_t_r_u_c_t, _a_t_o_m, _v_a_l_u_e___r_e_t_u_r_n)
XFontStruct *_f_o_n_t___s_t_r_u_c_t;
Atom _a_t_o_m;
unsigned long *_v_a_l_u_e___r_e_t_u_r_n;
_f_o_n_t___s_t_r_u_c_t
Specifies the storage associated with the font.
_a_t_o_m Specifies the atom for the property name you want
returned.
_v_a_l_u_e___r_e_t_u_r_n
Returns the value of the font property.
││__
Given the atom for that property, the _X_G_e_t_F_o_n_t_P_r_o_p_e_r_t_y func-
tion returns the value of the specified font property.
_X_G_e_t_F_o_n_t_P_r_o_p_e_r_t_y also returns _F_a_l_s_e if the property was not
defined or _T_r_u_e if it was defined. A set of predefined
atoms exists for font properties, which can be found in
<_X_1_1_/_X_a_t_o_m_._h>. This set contains the standard properties
associated with a font. Although it is not guaranteed, it
is likely that the predefined font properties will be
present.
To unload a font that was loaded by _X_L_o_a_d_F_o_n_t, use _X_U_n_l_o_a_d_-
_F_o_n_t.
__
││
XUnloadFont(_d_i_s_p_l_a_y, _f_o_n_t)
Display *_d_i_s_p_l_a_y;
Font _f_o_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_n_t Specifies the font.
││__
The _X_U_n_l_o_a_d_F_o_n_t function deletes the association between the
font resource ID and the specified font. The font itself
will be freed when no other resource references it. The
font should not be referenced again.
_X_U_n_l_o_a_d_F_o_n_t can generate a _B_a_d_F_o_n_t error.
224455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
88..55..22.. OObbttaaiinniinngg aanndd FFrreeeeiinngg FFoonntt NNaammeess aanndd IInnffoorrmmaattiioonn
You obtain font names and information by matching a wildcard
specification when querying a font type for a list of avail-
able sizes and so on.
To return a list of the available font names, use _X_L_i_s_t_-
_F_o_n_t_s.
__
││
char **XListFonts(_d_i_s_p_l_a_y, _p_a_t_t_e_r_n, _m_a_x_n_a_m_e_s, _a_c_t_u_a_l___c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char *_p_a_t_t_e_r_n;
int _m_a_x_n_a_m_e_s;
int *_a_c_t_u_a_l___c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_a_t_t_e_r_n Specifies the null-terminated pattern string that
can contain wildcard characters.
_m_a_x_n_a_m_e_s Specifies the maximum number of names to be
returned.
_a_c_t_u_a_l___c_o_u_n_t___r_e_t_u_r_n
Returns the actual number of font names.
││__
The _X_L_i_s_t_F_o_n_t_s function returns an array of available font
names (as controlled by the font search path; see _X_S_e_t_F_o_n_t_-
_P_a_t_h) that match the string you passed to the pattern argu-
ment. The pattern string can contain any characters, but
each asterisk (*) is a wildcard for any number of charac-
ters, and each question mark (?) is a wildcard for a single
character. If the pattern string is not in the Host
Portable Character Encoding, the result is implementation-
dependent. Use of uppercase or lowercase does not matter.
Each returned string is null-terminated. If the data
returned by the server is in the Latin Portable Character
Encoding, then the returned strings are in the Host Portable
Character Encoding. Otherwise, the result is implementa-
tion-dependent. If there are no matching font names, _X_L_i_s_t_-
_F_o_n_t_s returns NULL. The client should call _X_F_r_e_e_F_o_n_t_N_a_m_e_s
when finished with the result to free the memory.
To free a font name array, use _X_F_r_e_e_F_o_n_t_N_a_m_e_s.
224466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFreeFontNames(_l_i_s_t)
char *_l_i_s_t[];
_l_i_s_t Specifies the array of strings you want to free.
││__
The _X_F_r_e_e_F_o_n_t_N_a_m_e_s function frees the array and strings
returned by _X_L_i_s_t_F_o_n_t_s or _X_L_i_s_t_F_o_n_t_s_W_i_t_h_I_n_f_o.
To obtain the names and information about available fonts,
use _X_L_i_s_t_F_o_n_t_s_W_i_t_h_I_n_f_o.
__
││
char **XListFontsWithInfo(_d_i_s_p_l_a_y, _p_a_t_t_e_r_n, _m_a_x_n_a_m_e_s, _c_o_u_n_t___r_e_t_u_r_n, _i_n_f_o___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char *_p_a_t_t_e_r_n;
int _m_a_x_n_a_m_e_s;
int *_c_o_u_n_t___r_e_t_u_r_n;
XFontStruct **_i_n_f_o___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_a_t_t_e_r_n Specifies the null-terminated pattern string that
can contain wildcard characters.
_m_a_x_n_a_m_e_s Specifies the maximum number of names to be
returned.
_c_o_u_n_t___r_e_t_u_r_n
Returns the actual number of matched font names.
_i_n_f_o___r_e_t_u_r_n
Returns the font information.
││__
The _X_L_i_s_t_F_o_n_t_s_W_i_t_h_I_n_f_o function returns a list of font names
that match the specified pattern and their associated font
information. The list of names is limited to size specified
by maxnames. The information returned for each font is
identical to what _X_L_o_a_d_Q_u_e_r_y_F_o_n_t would return except that
the per-character metrics are not returned. The pattern
string can contain any characters, but each asterisk (*) is
a wildcard for any number of characters, and each question
mark (?) is a wildcard for a single character. If the pat-
tern string is not in the Host Portable Character Encoding,
the result is implementation-dependent. Use of uppercase or
lowercase does not matter. Each returned string is null-
terminated. If the data returned by the server is in the
Latin Portable Character Encoding, then the returned strings
are in the Host Portable Character Encoding. Otherwise, the
224477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
result is implementation-dependent. If there are no match-
ing font names, _X_L_i_s_t_F_o_n_t_s_W_i_t_h_I_n_f_o returns NULL.
To free only the allocated name array, the client should
call _X_F_r_e_e_F_o_n_t_N_a_m_e_s. To free both the name array and the
font information array or to free just the font information
array, the client should call _X_F_r_e_e_F_o_n_t_I_n_f_o.
To free font structures and font names, use _X_F_r_e_e_F_o_n_t_I_n_f_o.
__
││
XFreeFontInfo(_n_a_m_e_s, _f_r_e_e___i_n_f_o, _a_c_t_u_a_l___c_o_u_n_t)
char **_n_a_m_e_s;
XFontStruct *_f_r_e_e___i_n_f_o;
int _a_c_t_u_a_l___c_o_u_n_t;
_n_a_m_e_s Specifies the list of font names.
_f_r_e_e___i_n_f_o Specifies the font information.
_a_c_t_u_a_l___c_o_u_n_t
Specifies the actual number of font names.
││__
The _X_F_r_e_e_F_o_n_t_I_n_f_o function frees a font structure or an
array of font structures and optionally an array of font
names. If NULL is passed for names, no font names are
freed. If a font structure for an open font (returned by
_X_L_o_a_d_Q_u_e_r_y_F_o_n_t) is passed, the structure is freed, but the
font is not closed; use _X_U_n_l_o_a_d_F_o_n_t to close the font.
88..55..33.. CCoommppuuttiinngg CChhaarraacctteerr SSttrriinngg SSiizzeess
Xlib provides functions that you can use to compute the
width, the logical extents, and the server information about
8-bit and 2-byte text strings. The width is computed by
adding the character widths of all the characters. It does
not matter if the font is an 8-bit or 2-byte font. These
functions return the sum of the character metrics in pixels.
To determine the width of an 8-bit character string, use
_X_T_e_x_t_W_i_d_t_h.
224488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XTextWidth(_f_o_n_t___s_t_r_u_c_t, _s_t_r_i_n_g, _c_o_u_n_t)
XFontStruct *_f_o_n_t___s_t_r_u_c_t;
char *_s_t_r_i_n_g;
int _c_o_u_n_t;
_f_o_n_t___s_t_r_u_c_t
Specifies the font used for the width computation.
_s_t_r_i_n_g Specifies the character string.
_c_o_u_n_t Specifies the character count in the specified
string.
││__
To determine the width of a 2-byte character string, use
_X_T_e_x_t_W_i_d_t_h_1_6.
__
││
int XTextWidth16(_f_o_n_t___s_t_r_u_c_t, _s_t_r_i_n_g, _c_o_u_n_t)
XFontStruct *_f_o_n_t___s_t_r_u_c_t;
XChar2b *_s_t_r_i_n_g;
int _c_o_u_n_t;
_f_o_n_t___s_t_r_u_c_t
Specifies the font used for the width computation.
_s_t_r_i_n_g Specifies the character string.
_c_o_u_n_t Specifies the character count in the specified
string.
││__
88..55..44.. CCoommppuuttiinngg LLooggiiccaall EExxtteennttss
To compute the bounding box of an 8-bit character string in
a given font, use _X_T_e_x_t_E_x_t_e_n_t_s.
224499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XTextExtents(_f_o_n_t___s_t_r_u_c_t, _s_t_r_i_n_g, _n_c_h_a_r_s, _d_i_r_e_c_t_i_o_n___r_e_t_u_r_n, _f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n,
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n, _o_v_e_r_a_l_l___r_e_t_u_r_n)
XFontStruct *_f_o_n_t___s_t_r_u_c_t;
char *_s_t_r_i_n_g;
int _n_c_h_a_r_s;
int *_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n;
int *_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n, *_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n;
XCharStruct *_o_v_e_r_a_l_l___r_e_t_u_r_n;
_f_o_n_t___s_t_r_u_c_t
Specifies the _X_F_o_n_t_S_t_r_u_c_t structure.
_s_t_r_i_n_g Specifies the character string.
_n_c_h_a_r_s Specifies the number of characters in the charac-
ter string.
_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n
Returns the value of the direction hint (_F_o_n_t_L_e_f_t_-
_T_o_R_i_g_h_t or _F_o_n_t_R_i_g_h_t_T_o_L_e_f_t).
_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n
Returns the font ascent.
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n
Returns the font descent.
_o_v_e_r_a_l_l___r_e_t_u_r_n
Returns the overall size in the specified
_X_C_h_a_r_S_t_r_u_c_t structure.
││__
To compute the bounding box of a 2-byte character string in
a given font, use _X_T_e_x_t_E_x_t_e_n_t_s_1_6.
225500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XTextExtents16(_f_o_n_t___s_t_r_u_c_t, _s_t_r_i_n_g, _n_c_h_a_r_s, _d_i_r_e_c_t_i_o_n___r_e_t_u_r_n, _f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n,
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n, _o_v_e_r_a_l_l___r_e_t_u_r_n)
XFontStruct *_f_o_n_t___s_t_r_u_c_t;
XChar2b *_s_t_r_i_n_g;
int _n_c_h_a_r_s;
int *_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n;
int *_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n, *_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n;
XCharStruct *_o_v_e_r_a_l_l___r_e_t_u_r_n;
_f_o_n_t___s_t_r_u_c_t
Specifies the _X_F_o_n_t_S_t_r_u_c_t structure.
_s_t_r_i_n_g Specifies the character string.
_n_c_h_a_r_s Specifies the number of characters in the charac-
ter string.
_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n
Returns the value of the direction hint (_F_o_n_t_L_e_f_t_-
_T_o_R_i_g_h_t or _F_o_n_t_R_i_g_h_t_T_o_L_e_f_t).
_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n
Returns the font ascent.
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n
Returns the font descent.
_o_v_e_r_a_l_l___r_e_t_u_r_n
Returns the overall size in the specified
_X_C_h_a_r_S_t_r_u_c_t structure.
││__
The _X_T_e_x_t_E_x_t_e_n_t_s and _X_T_e_x_t_E_x_t_e_n_t_s_1_6 functions perform the
size computation locally and, thereby, avoid the round-trip
overhead of _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s and _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s_1_6. Both
functions return an _X_C_h_a_r_S_t_r_u_c_t structure, whose members are
set to the values as follows.
The ascent member is set to the maximum of the ascent met-
rics of all characters in the string. The descent member is
set to the maximum of the descent metrics. The width member
is set to the sum of the character-width metrics of all
characters in the string. For each character in the string,
let W be the sum of the character-width metrics of all char-
acters preceding it in the string. Let L be the left-side-
bearing metric of the character plus W. Let R be the right-
side-bearing metric of the character plus W. The lbearing
member is set to the minimum L of all characters in the
string. The rbearing member is set to the maximum R.
225511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
For fonts defined with linear indexing rather than 2-byte
matrix indexing, each _X_C_h_a_r_2_b structure is interpreted as a
16-bit number with byte1 as the most significant byte. If
the font has no defined default character, undefined charac-
ters in the string are taken to have all zero metrics.
88..55..55.. QQuueerryyiinngg CChhaarraacctteerr SSttrriinngg SSiizzeess
To query the server for the bounding box of an 8-bit charac-
ter string in a given font, use _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s.
__
││
XQueryTextExtents(_d_i_s_p_l_a_y, _f_o_n_t___I_D, _s_t_r_i_n_g, _n_c_h_a_r_s, _d_i_r_e_c_t_i_o_n___r_e_t_u_r_n, _f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n,
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n, _o_v_e_r_a_l_l___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XID _f_o_n_t___I_D;
char *_s_t_r_i_n_g;
int _n_c_h_a_r_s;
int *_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n;
int *_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n, *_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n;
XCharStruct *_o_v_e_r_a_l_l___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_n_t___I_D Specifies either the font ID or the _G_C_o_n_t_e_x_t ID
that contains the font.
_s_t_r_i_n_g Specifies the character string.
_n_c_h_a_r_s Specifies the number of characters in the charac-
ter string.
_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n
Returns the value of the direction hint (_F_o_n_t_L_e_f_t_-
_T_o_R_i_g_h_t or _F_o_n_t_R_i_g_h_t_T_o_L_e_f_t).
_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n
Returns the font ascent.
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n
Returns the font descent.
_o_v_e_r_a_l_l___r_e_t_u_r_n
Returns the overall size in the specified
_X_C_h_a_r_S_t_r_u_c_t structure.
││__
To query the server for the bounding box of a 2-byte charac-
ter string in a given font, use _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s_1_6.
225522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XQueryTextExtents16(_d_i_s_p_l_a_y, _f_o_n_t___I_D, _s_t_r_i_n_g, _n_c_h_a_r_s, _d_i_r_e_c_t_i_o_n___r_e_t_u_r_n, _f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n,
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n, _o_v_e_r_a_l_l___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XID _f_o_n_t___I_D;
XChar2b *_s_t_r_i_n_g;
int _n_c_h_a_r_s;
int *_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n;
int *_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n, *_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n;
XCharStruct *_o_v_e_r_a_l_l___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_n_t___I_D Specifies either the font ID or the _G_C_o_n_t_e_x_t ID
that contains the font.
_s_t_r_i_n_g Specifies the character string.
_n_c_h_a_r_s Specifies the number of characters in the charac-
ter string.
_d_i_r_e_c_t_i_o_n___r_e_t_u_r_n
Returns the value of the direction hint (_F_o_n_t_L_e_f_t_-
_T_o_R_i_g_h_t or _F_o_n_t_R_i_g_h_t_T_o_L_e_f_t).
_f_o_n_t___a_s_c_e_n_t___r_e_t_u_r_n
Returns the font ascent.
_f_o_n_t___d_e_s_c_e_n_t___r_e_t_u_r_n
Returns the font descent.
_o_v_e_r_a_l_l___r_e_t_u_r_n
Returns the overall size in the specified
_X_C_h_a_r_S_t_r_u_c_t structure.
││__
The _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s and _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s_1_6 functions
return the bounding box of the specified 8-bit and 16-bit
character string in the specified font or the font contained
in the specified GC. These functions query the X server
and, therefore, suffer the round-trip overhead that is
avoided by _X_T_e_x_t_E_x_t_e_n_t_s and _X_T_e_x_t_E_x_t_e_n_t_s_1_6. Both functions
return a _X_C_h_a_r_S_t_r_u_c_t structure, whose members are set to the
values as follows.
The ascent member is set to the maximum of the ascent met-
rics of all characters in the string. The descent member is
set to the maximum of the descent metrics. The width member
is set to the sum of the character-width metrics of all
characters in the string. For each character in the string,
let W be the sum of the character-width metrics of all char-
acters preceding it in the string. Let L be the left-side-
bearing metric of the character plus W. Let R be the right-
225533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
side-bearing metric of the character plus W. The lbearing
member is set to the minimum L of all characters in the
string. The rbearing member is set to the maximum R.
For fonts defined with linear indexing rather than 2-byte
matrix indexing, each _X_C_h_a_r_2_b structure is interpreted as a
16-bit number with byte1 as the most significant byte. If
the font has no defined default character, undefined charac-
ters in the string are taken to have all zero metrics.
Characters with all zero metrics are ignored. If the font
has no defined default_char, the undefined characters in the
string are also ignored.
_X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s and _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s_1_6 can generate _B_a_d_-
_F_o_n_t and _B_a_d_G_C errors.
88..66.. DDrraawwiinngg TTeexxtt
This section discusses how to draw:
· Complex text
· Text characters
· Image text characters
The fundamental text functions _X_D_r_a_w_T_e_x_t and _X_D_r_a_w_T_e_x_t_1_6 use
the following structures:
__
││
typedef struct {
char *chars; /* pointer to string */
int nchars; /* number of characters */
int delta; /* delta between strings */
Font font; /* Font to print it in, None don't change */
} XTextItem;
typedef struct {
XChar2b *chars; /* pointer to two-byte characters */
int nchars; /* number of characters */
int delta; /* delta between strings */
Font font; /* font to print it in, None don't change */
} XTextItem16;
││__
If the font member is not _N_o_n_e, the font is changed before
printing and also is stored in the GC. If an error was gen-
erated during text drawing, the previous items may have been
drawn. The baseline of the characters are drawn starting at
225544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the x and y coordinates that you pass in the text drawing
functions.
For example, consider the background rectangle drawn by
_X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g. If you want the upper-left corner of the
background rectangle to be at pixel coordinate (x,y), pass
the (x,y + ascent) as the baseline origin coordinates to the
text functions. The ascent is the font ascent, as given in
the _X_F_o_n_t_S_t_r_u_c_t structure. If you want the lower-left cor-
ner of the background rectangle to be at pixel coordinate
(x,y), pass the (x,y - descent + 1) as the baseline origin
coordinates to the text functions. The descent is the font
descent, as given in the _X_F_o_n_t_S_t_r_u_c_t structure.
88..66..11.. DDrraawwiinngg CCoommpplleexx TTeexxtt
To draw 8-bit characters in a given drawable, use _X_D_r_a_w_T_e_x_t.
__
││
XDrawText(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _i_t_e_m_s, _n_i_t_e_m_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
XTextItem *_i_t_e_m_s;
int _n_i_t_e_m_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the specified drawable and
define the origin of the first character.
_i_t_e_m_s Specifies an array of text items.
_n_i_t_e_m_s Specifies the number of text items in the array.
││__
To draw 2-byte characters in a given drawable, use _X_D_r_a_w_-
_T_e_x_t_1_6.
225555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawText16(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _i_t_e_m_s, _n_i_t_e_m_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
XTextItem16 *_i_t_e_m_s;
int _n_i_t_e_m_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the specified drawable and
define the origin of the first character.
_i_t_e_m_s Specifies an array of text items.
_n_i_t_e_m_s Specifies the number of text items in the array.
││__
The _X_D_r_a_w_T_e_x_t_1_6 function is similar to _X_D_r_a_w_T_e_x_t except that
it uses 2-byte or 16-bit characters. Both functions allow
complex spacing and font shifts between counted strings.
Each text item is processed in turn. A font member other
than _N_o_n_e in an item causes the font to be stored in the GC
and used for subsequent text. A text element delta speci-
fies an additional change 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 character-
istics of the font. Each character image, as defined by the
font in the GC, is treated as an additional mask for a fill
operation on the drawable. The drawable is modified only
where the font character has a bit set to 1. If a text item
generates a _B_a_d_F_o_n_t error, the previous text items may have
been drawn.
For fonts defined with linear indexing rather than 2-byte
matrix indexing, each _X_C_h_a_r_2_b structure is interpreted as a
16-bit number with byte1 as the most significant byte.
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-depen-
dent components: foreground, background, tile, stipple,
tile-stipple-x-origin, and tile-stipple-y-origin.
225566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_D_r_a_w_T_e_x_t and _X_D_r_a_w_T_e_x_t_1_6 can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_F_o_n_t,
_B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.
88..66..22.. DDrraawwiinngg TTeexxtt CChhaarraacctteerrss
To draw 8-bit characters in a given drawable, use _X_D_r_a_w_-
_S_t_r_i_n_g.
__
││
XDrawString(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _s_t_r_i_n_g, _l_e_n_g_t_h)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
char *_s_t_r_i_n_g;
int _l_e_n_g_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the specified drawable and
define the origin of the first character.
_s_t_r_i_n_g Specifies the character string.
_l_e_n_g_t_h Specifies the number of characters in the string
argument.
││__
To draw 2-byte characters in a given drawable, use _X_D_r_a_w_-
_S_t_r_i_n_g_1_6.
225577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawString16(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _s_t_r_i_n_g, _l_e_n_g_t_h)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
XChar2b *_s_t_r_i_n_g;
int _l_e_n_g_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the specified drawable and
define the origin of the first character.
_s_t_r_i_n_g Specifies the character string.
_l_e_n_g_t_h Specifies the number of characters in the string
argument.
││__
Each character image, as defined by the font in the GC, is
treated as an additional mask for a fill operation on the
drawable. The drawable is modified only where the font
character has a bit set to 1. For fonts defined with 2-byte
matrix indexing and used with _X_D_r_a_w_S_t_r_i_n_g_1_6, each byte is
used as a byte2 with a byte1 of zero.
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-depen-
dent components: foreground, background, tile, stipple,
tile-stipple-x-origin, and tile-stipple-y-origin.
_X_D_r_a_w_S_t_r_i_n_g and _X_D_r_a_w_S_t_r_i_n_g_1_6 can generate _B_a_d_D_r_a_w_a_b_l_e,
_B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.
88..66..33.. DDrraawwiinngg IImmaaggee TTeexxtt CChhaarraacctteerrss
Some applications, in particular terminal emulators, need to
print image text in which both the foreground and background
bits of each character are painted. This prevents annoying
flicker on many displays.
To draw 8-bit image text characters in a given drawable, use
_X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g.
225588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawImageString(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _s_t_r_i_n_g, _l_e_n_g_t_h)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
char *_s_t_r_i_n_g;
int _l_e_n_g_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the specified drawable and
define the origin of the first character.
_s_t_r_i_n_g Specifies the character string.
_l_e_n_g_t_h Specifies the number of characters in the string
argument.
││__
To draw 2-byte image text characters in a given drawable,
use _X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g_1_6.
225599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDrawImageString16(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _s_t_r_i_n_g, _l_e_n_g_t_h)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
XChar2b *_s_t_r_i_n_g;
int _l_e_n_g_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the specified drawable and
define the origin of the first character.
_s_t_r_i_n_g Specifies the character string.
_l_e_n_g_t_h Specifies the number of characters in the string
argument.
││__
The _X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g_1_6 function is similar to _X_D_r_a_w_I_m_-
_a_g_e_S_t_r_i_n_g except that it uses 2-byte or 16-bit characters.
Both functions also use both the foreground and background
pixels of the GC in the destination.
The effect is first to fill a destination rectangle with the
background pixel defined in the GC and then to paint the
text with the foreground pixel. The upper-left corner of
the filled rectangle is at:
[x, y - font-ascent]
The width is:
overall-width
The height is:
font-ascent + font-descent
226600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The overall-width, font-ascent, and font-descent are as
would be returned by _X_Q_u_e_r_y_T_e_x_t_E_x_t_e_n_t_s using gc and string.
The function and fill-style defined in the GC are ignored
for these functions. The effective function is _G_X_c_o_p_y, and
the effective fill-style is _F_i_l_l_S_o_l_i_d.
For fonts defined with 2-byte matrix indexing and used with
_X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g, each byte is used as a byte2 with a byte1
of zero.
Both functions use these GC components: plane-mask, fore-
ground, background, font, subwindow-mode, clip-x-origin,
clip-y-origin, and clip-mask.
_X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g and _X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g_1_6 can generate _B_a_d_-
_D_r_a_w_a_b_l_e, _B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.
88..77.. TTrraannssffeerrrriinngg IImmaaggeess bbeettwweeeenn CClliieenntt aanndd SSeerrvveerr
Xlib provides functions that you can use to transfer images
between a client and the server. Because the server may
require diverse data formats, Xlib provides an image object
that fully describes the data in memory and that provides
for basic operations on that data. You should reference the
data through the image object rather than referencing the
data directly. However, some implementations of the Xlib
library may efficiently deal with frequently used data for-
mats by replacing functions in the procedure vector with
special case functions. Supported operations include
destroying the image, getting a pixel, storing a pixel,
extracting a subimage of an image, and adding a constant to
an image (see section 16.8).
All the image manipulation functions discussed in this sec-
tion make use of the _X_I_m_a_g_e structure, which describes an
image as it exists in the client's memory.
226611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XImage {
int width, height; /* size of image */
int xoffset; /* number of pixels offset in X direction */
int format; /* XYBitmap, XYPixmap, ZPixmap */
char *data; /* pointer to image data */
int byte_order; /* data byte order, LSBFirst, MSBFirst */
int bitmap_unit; /* quant. of scanline 8, 16, 32 */
int bitmap_bit_order; /* LSBFirst, MSBFirst */
int bitmap_pad; /* 8, 16, 32 either XY or ZPixmap */
int depth; /* depth of image */
int bytes_per_line; /* accelerator to next scanline */
int bits_per_pixel; /* bits per pixel (ZPixmap) */
unsigned long red_mask; /* bits in z arrangement */
unsigned long green_mask;
unsigned long blue_mask;
XPointer obdata; /* hook for the object routines to hang on */
struct funcs { /* image manipulation routines */
struct _XImage *(*create_image)();
int (*destroy_image)();
unsigned long (*get_pixel)();
int (*put_pixel)();
struct _XImage *(*sub_image)();
int (*add_pixel)();
} f;
} XImage;
││__
To initialize the image manipulation routines of an image
structure, use _X_I_n_i_t_I_m_a_g_e.
__
││
Status XInitImage(_i_m_a_g_e)
XImage *_i_m_a_g_e;
_x_i_m_a_g_e Specifies the image.
││__
The _X_I_n_i_t_I_m_a_g_e function initializes the internal image
manipulation routines of an image structure, based on the
values of the various structure members. All fields other
than the manipulation routines must already be initialized.
If the bytes_per_line member is zero, _X_I_n_i_t_I_m_a_g_e will assume
the image data is contiguous in memory and set the
bytes_per_line member to an appropriate value based on the
other members; otherwise, the value of bytes_per_line is not
changed. All of the manipulation routines are initialized
to functions that other Xlib image manipulation functions
need to operate on the type of image specified by the rest
of the structure.
226622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This function must be called for any image constructed by
the client before passing it to any other Xlib function.
Image structures created or returned by Xlib do not need to
be initialized in this fashion.
This function returns a nonzero status if initialization of
the structure is successful. It returns zero if it detected
some error or inconsistency in the structure, in which case
the image is not changed.
To combine an image with a rectangle of a drawable on the
display, use _X_P_u_t_I_m_a_g_e.
__
││
XPutImage(_d_i_s_p_l_a_y, _d, _g_c, _i_m_a_g_e, _s_r_c___x, _s_r_c___y, _d_e_s_t___x, _d_e_s_t___y, _w_i_d_t_h, _h_e_i_g_h_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
XImage *_i_m_a_g_e;
int _s_r_c___x, _s_r_c___y;
int _d_e_s_t___x, _d_e_s_t___y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_i_m_a_g_e Specifies the image you want combined with the
rectangle.
_s_r_c___x Specifies the offset in X from the left edge of
the image defined by the _X_I_m_a_g_e structure.
_s_r_c___y Specifies the offset in Y from the top edge of the
image defined by the _X_I_m_a_g_e structure.
_d_e_s_t___x
_d_e_s_t___y Specify the x and y coordinates, which are rela-
tive to the origin of the drawable and are the
coordinates of the subimage.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height of the subimage,
which define the dimensions of the rectangle.
││__
The _X_P_u_t_I_m_a_g_e 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 arguments is drawn on
the specified part of the drawable. If _X_Y_B_i_t_m_a_p format is
226633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
used, the depth of the image must be one, or a _B_a_d_M_a_t_c_h
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 _X_Y_P_i_x_m_a_p
and _Z_P_i_x_m_a_p, the depth of the image must match the depth of
the drawable, or a _B_a_d_M_a_t_c_h error results.
If the characteristics of the image (for example, byte_order
and bitmap_unit) differ from what the server requires,
_X_P_u_t_I_m_a_g_e automatically makes the appropriate conversions.
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.
_X_P_u_t_I_m_a_g_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
_B_a_d_V_a_l_u_e errors.
To return the contents of a rectangle in a given drawable on
the display, use _X_G_e_t_I_m_a_g_e. This function specifically sup-
ports rudimentary screen dumps.
226644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XImage *XGetImage(_d_i_s_p_l_a_y, _d, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _p_l_a_n_e___m_a_s_k, _f_o_r_m_a_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned long _p_l_a_n_e___m_a_s_k;
int _f_o_r_m_a_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the drawable and define the
upper-left corner of the rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height of the subimage,
which define the dimensions of the rectangle.
_p_l_a_n_e___m_a_s_k
Specifies the plane mask.
_f_o_r_m_a_t Specifies the format for the image. You can pass
_X_Y_P_i_x_m_a_p or _Z_P_i_x_m_a_p.
││__
The _X_G_e_t_I_m_a_g_e function returns a pointer to an _X_I_m_a_g_e struc-
ture. This structure provides you with the contents of the
specified rectangle of the drawable in the format you spec-
ify. If the format argument is _X_Y_P_i_x_m_a_p, 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 _Z_P_i_x_m_a_p, _X_G_e_t_I_m_a_g_e returns as zero the bits in all planes
not specified in the plane_mask argument. The function per-
forms no range checking on the values in plane_mask and
ignores extraneous bits.
_X_G_e_t_I_m_a_g_e returns the depth of the image to the depth member
of the _X_I_m_a_g_e structure. The depth of the image is as spec-
ified when the drawable was created, except when getting a
subset of the planes in _X_Y_P_i_x_m_a_p format, when the depth is
given by the number of bits set to 1 in plane_mask.
If the drawable is a pixmap, the given rectangle must be
wholly contained within the pixmap, or a _B_a_d_M_a_t_c_h error
results. 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
226655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the window would be fully visible on the screen and wholly
contained within the outside edges of the window, or a _B_a_d_-
_M_a_t_c_h error results. 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. 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. The pointer cursor image is not included in the
returned contents. If a problem occurs, _X_G_e_t_I_m_a_g_e returns
NULL.
_X_G_e_t_I_m_a_g_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_M_a_t_c_h, and _B_a_d_V_a_l_u_e
errors.
To copy the contents of a rectangle on the display to a
location within a preexisting image structure, use _X_G_e_t_-
_S_u_b_I_m_a_g_e.
226666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XImage *XGetSubImage(_d_i_s_p_l_a_y, _d, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _p_l_a_n_e___m_a_s_k, _f_o_r_m_a_t, _d_e_s_t___i_m_a_g_e, _d_e_s_t___x,
_d_e_s_t___y)
Display *_d_i_s_p_l_a_y;
Drawable _d;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned long _p_l_a_n_e___m_a_s_k;
int _f_o_r_m_a_t;
XImage *_d_e_s_t___i_m_a_g_e;
int _d_e_s_t___x, _d_e_s_t___y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_x
_y Specify the x and y coordinates, which are rela-
tive to the origin of the drawable and define the
upper-left corner of the rectangle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height of the subimage,
which define the dimensions of the rectangle.
_p_l_a_n_e___m_a_s_k
Specifies the plane mask.
_f_o_r_m_a_t Specifies the format for the image. You can pass
_X_Y_P_i_x_m_a_p or _Z_P_i_x_m_a_p.
_d_e_s_t___i_m_a_g_e
Specifies the destination image.
_d_e_s_t___x
_d_e_s_t___y Specify the x and y coordinates, which are rela-
tive to the origin of the destination rectangle,
specify its upper-left corner, and determine where
the subimage is placed in the destination image.
││__
The _X_G_e_t_S_u_b_I_m_a_g_e function updates dest_image with the speci-
fied subimage in the same manner as _X_G_e_t_I_m_a_g_e. If the for-
mat argument is _X_Y_P_i_x_m_a_p, the image contains only the bit
planes you passed to the plane_mask argument. If the format
argument is _Z_P_i_x_m_a_p, _X_G_e_t_S_u_b_I_m_a_g_e 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. As a convenience,
_X_G_e_t_S_u_b_I_m_a_g_e returns a pointer to the same _X_I_m_a_g_e structure
specified by dest_image.
226677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The depth of the destination _X_I_m_a_g_e structure must be the
same as that of the drawable. If the specified subimage
does not fit at the specified location on the destination
image, the right and bottom edges are clipped. If the draw-
able is a pixmap, the given rectangle must be wholly con-
tained within the pixmap, or a _B_a_d_M_a_t_c_h error results. If
the drawable is a window, the window must be viewable, and
it must be the case that if there were no inferiors or over-
lapping 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_a_d_M_a_t_c_h 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, 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. If a problem occurs,
_X_G_e_t_S_u_b_I_m_a_g_e returns NULL.
_X_G_e_t_S_u_b_I_m_a_g_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
_B_a_d_V_a_l_u_e errors.
226688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 99
WWiinnddooww aanndd SSeessssiioonn MMaannaaggeerr FFuunnccttiioonnss
Although it is difficult to categorize functions as exclu-
sively for an application, a window manager, or a session
manager, the functions in this chapter are most often used
by window managers and session managers. It is not expected
that these functions will be used by most application pro-
grams. Xlib provides management functions to:
· Change the parent of a window
· Control the lifetime of a window
· Manage installed colormaps
· Set and retrieve the font search path
· Grab the server
· Kill a client
· Control the screen saver
· Control host access
99..11.. CChhaannggiinngg tthhee PPaarreenntt ooff aa WWiinnddooww
To change a window's parent to another window on the same
screen, use _X_R_e_p_a_r_e_n_t_W_i_n_d_o_w. There is no way to move a win-
dow between screens.
226699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XReparentWindow(_d_i_s_p_l_a_y, _w, _p_a_r_e_n_t, _x, _y)
Display *_d_i_s_p_l_a_y;
Window _w;
Window _p_a_r_e_n_t;
int _x, _y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_p_a_r_e_n_t Specifies the parent window.
_x
_y Specify the x and y coordinates of the position in
the new parent window.
││__
If the specified window is mapped, _X_R_e_p_a_r_e_n_t_W_i_n_d_o_w automati-
cally performs an _U_n_m_a_p_W_i_n_d_o_w request on it, removes it from
its current position in the hierarchy, and inserts it as the
child of the specified parent. The window is placed in the
stacking order on top with respect to sibling windows.
After reparenting the specified window, _X_R_e_p_a_r_e_n_t_W_i_n_d_o_w
causes the X server to generate a _R_e_p_a_r_e_n_t_N_o_t_i_f_y event. The
override_redirect member returned in this event is set to
the window's corresponding attribute. Window manager
clients usually should ignore this window if this member is
set to _T_r_u_e. Finally, if the specified window was origi-
nally mapped, the X server automatically performs a _M_a_p_W_i_n_-
_d_o_w request on it.
The X server performs normal exposure processing on formerly
obscured windows. The X server might not generate _E_x_p_o_s_e
events for regions from the initial _U_n_m_a_p_W_i_n_d_o_w request that
are immediately obscured by the final _M_a_p_W_i_n_d_o_w request. A
_B_a_d_M_a_t_c_h error results if:
· The new parent window is not on the same screen as the
old parent window.
· The new parent window is the specified window or an
inferior of the specified window.
· The new parent is _I_n_p_u_t_O_n_l_y, and the window is not.
· The specified window has a _P_a_r_e_n_t_R_e_l_a_t_i_v_e background,
and the new parent window is not the same depth as the
specified window.
_X_R_e_p_a_r_e_n_t_W_i_n_d_o_w can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w errors.
227700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
99..22.. CCoonnttrroolllliinngg tthhee LLiiffeettiimmee ooff aa WWiinnddooww
The save-set of a client is a list of other clients' windows
that, if they are inferiors of one of the client's windows
at connection close, should not be destroyed and should be
remapped if they are unmapped. For further information
about close-connection processing, see section 2.6. To
allow an application's window to survive when a window man-
ager that has reparented a window fails, Xlib provides the
save-set functions that you can use to control the longevity
of subwindows that are normally destroyed when the parent is
destroyed. For example, a window manager that wants to add
decoration to a window by adding a frame might reparent an
application's window. When the frame is destroyed, the
application's window should not be destroyed but be returned
to its previous place in the window hierarchy.
The X server automatically removes windows from the save-set
when they are destroyed.
To add or remove a window from the client's save-set, use
_X_C_h_a_n_g_e_S_a_v_e_S_e_t.
__
││
XChangeSaveSet(_d_i_s_p_l_a_y, _w, _c_h_a_n_g_e___m_o_d_e)
Display *_d_i_s_p_l_a_y;
Window _w;
int _c_h_a_n_g_e___m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window that you want to add to or
delete from the client's save-set.
_c_h_a_n_g_e___m_o_d_e
Specifies the mode. You can pass _S_e_t_M_o_d_e_I_n_s_e_r_t or
_S_e_t_M_o_d_e_D_e_l_e_t_e.
││__
Depending on the specified mode, _X_C_h_a_n_g_e_S_a_v_e_S_e_t 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_a_d_M_a_t_c_h error results.
_X_C_h_a_n_g_e_S_a_v_e_S_e_t can generate _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_-
_d_o_w errors.
To add a window to the client's save-set, use _X_A_d_d_T_o_S_a_v_e_S_e_t.
227711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XAddToSaveSet(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window that you want to add to the
client's save-set.
││__
The _X_A_d_d_T_o_S_a_v_e_S_e_t function adds the specified window to the
client's save-set. The specified window must have been cre-
ated by some other client, or a _B_a_d_M_a_t_c_h error results.
_X_A_d_d_T_o_S_a_v_e_S_e_t can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w errors.
To remove a window from the client's save-set, use _X_R_e_m_o_v_e_-
_F_r_o_m_S_a_v_e_S_e_t.
__
││
XRemoveFromSaveSet(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window that you want to delete from
the client's save-set.
││__
The _X_R_e_m_o_v_e_F_r_o_m_S_a_v_e_S_e_t function removes the specified window
from the client's save-set. The specified window must have
been created by some other client, or a _B_a_d_M_a_t_c_h error
results.
_X_R_e_m_o_v_e_F_r_o_m_S_a_v_e_S_e_t can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w
errors.
99..33.. MMaannaaggiinngg IInnssttaalllleedd CCoolloorrmmaappss
The X server maintains a list of installed colormaps. Win-
dows using these colormaps are guaranteed to display with
correct colors; windows using other colormaps may or may not
display with correct colors. Xlib provides functions that
you can use to install a colormap, uninstall a colormap, and
obtain a list of installed colormaps.
At any time, there is a subset of the installed maps that is
viewed as an ordered list and is called the required list.
The length of the required list is at most M, where M is the
227722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
minimum number of installed colormaps specified for the
screen in the connection setup. The required list is main-
tained as follows. When a colormap is specified to _X_I_n_-
_s_t_a_l_l_C_o_l_o_r_m_a_p, it is added to the head of the list; the list
is truncated at the tail, if necessary, to keep its length
to at most M. When a colormap is specified to _X_U_n_i_n_s_t_a_l_l_-
_C_o_l_o_r_m_a_p and it is in the required list, it is removed from
the list. A colormap is not added to the required list when
it is implicitly installed by the X server, and the X server
cannot implicitly uninstall a colormap that is in the
required list.
To install a colormap, use _X_I_n_s_t_a_l_l_C_o_l_o_r_m_a_p.
__
││
XInstallColormap(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
││__
The _X_I_n_s_t_a_l_l_C_o_l_o_r_m_a_p function installs the specified col-
ormap for its associated screen. All windows associated
with this colormap immediately display with true colors.
You associated the windows with this colormap when you cre-
ated them by calling _X_C_r_e_a_t_e_W_i_n_d_o_w, _X_C_r_e_a_t_e_S_i_m_p_l_e_W_i_n_d_o_w,
_X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s, or _X_S_e_t_W_i_n_d_o_w_C_o_l_o_r_m_a_p.
If the specified colormap is not already an installed col-
ormap, the X server generates a _C_o_l_o_r_m_a_p_N_o_t_i_f_y event on each
window that has that colormap. In addition, for every other
colormap that is installed as a result of a call to _X_I_n_-
_s_t_a_l_l_C_o_l_o_r_m_a_p, the X server generates a _C_o_l_o_r_m_a_p_N_o_t_i_f_y event
on each window that has that colormap.
_X_I_n_s_t_a_l_l_C_o_l_o_r_m_a_p can generate a _B_a_d_C_o_l_o_r error.
To uninstall a colormap, use _X_U_n_i_n_s_t_a_l_l_C_o_l_o_r_m_a_p.
227733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XUninstallColormap(_d_i_s_p_l_a_y, _c_o_l_o_r_m_a_p)
Display *_d_i_s_p_l_a_y;
Colormap _c_o_l_o_r_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_l_o_r_m_a_p Specifies the colormap.
││__
The _X_U_n_i_n_s_t_a_l_l_C_o_l_o_r_m_a_p function removes the specified col-
ormap from the required list for its screen. As a result,
the specified colormap might be uninstalled, and the X
server might implicitly install or uninstall additional col-
ormaps. Which colormaps get installed or uninstalled is
server dependent except that the required list must remain
installed.
If the specified colormap becomes uninstalled, the X server
generates a _C_o_l_o_r_m_a_p_N_o_t_i_f_y 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 _X_U_n_i_n_-
_s_t_a_l_l_C_o_l_o_r_m_a_p, the X server generates a _C_o_l_o_r_m_a_p_N_o_t_i_f_y event
on each window that has that colormap.
_X_U_n_i_n_s_t_a_l_l_C_o_l_o_r_m_a_p can generate a _B_a_d_C_o_l_o_r error.
To obtain a list of the currently installed colormaps for a
given screen, use _X_L_i_s_t_I_n_s_t_a_l_l_e_d_C_o_l_o_r_m_a_p_s.
__
││
Colormap *XListInstalledColormaps(_d_i_s_p_l_a_y, _w, _n_u_m___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
int *_n_u_m___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window that determines the screen.
_n_u_m___r_e_t_u_r_n
Returns the number of currently installed col-
ormaps.
││__
The _X_L_i_s_t_I_n_s_t_a_l_l_e_d_C_o_l_o_r_m_a_p_s function returns a list of the
currently installed colormaps for the screen of the speci-
fied window. The order of the colormaps in the list is not
significant and is no explicit indication of the required
list. When the allocated list is no longer needed, free it
by using _X_F_r_e_e.
227744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_L_i_s_t_I_n_s_t_a_l_l_e_d_C_o_l_o_r_m_a_p_s can generate a _B_a_d_W_i_n_d_o_w error.
99..44.. SSeettttiinngg aanndd RReettrriieevviinngg tthhee FFoonntt SSeeaarrcchh PPaatthh
The set of fonts available from a server depends on a font
search path. Xlib provides functions to set and retrieve
the search path for a server.
To set the font search path, use _X_S_e_t_F_o_n_t_P_a_t_h.
__
││
XSetFontPath(_d_i_s_p_l_a_y, _d_i_r_e_c_t_o_r_i_e_s, _n_d_i_r_s)
Display *_d_i_s_p_l_a_y;
char **_d_i_r_e_c_t_o_r_i_e_s;
int _n_d_i_r_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_i_r_e_c_t_o_r_i_e_s
Specifies the directory path used to look for a
font. Setting the path to the empty list restores
the default path defined for the X server.
_n_d_i_r_s Specifies the number of directories in the path.
││__
The _X_S_e_t_F_o_n_t_P_a_t_h function defines the directory search path
for font lookup. There is only one search path per X
server, not one per client. The encoding and interpretation
of the strings are implementation-dependent, but typically
they specify directories or font servers to be searched in
the order listed. An X server is permitted to cache font
information internally; for example, it might cache an
entire font from a file and not check on subsequent opens of
that font to see if the underlying font file has changed.
However, when the font path is changed, the X server is
guaranteed to flush all cached information about fonts for
which there currently are no explicit resource IDs allo-
cated. The meaning of an error from this request is imple-
mentation-dependent.
_X_S_e_t_F_o_n_t_P_a_t_h can generate a _B_a_d_V_a_l_u_e error.
To get the current font search path, use _X_G_e_t_F_o_n_t_P_a_t_h.
227755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char **XGetFontPath(_d_i_s_p_l_a_y, _n_p_a_t_h_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_n_p_a_t_h_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_p_a_t_h_s___r_e_t_u_r_n
Returns the number of strings in the font path
array.
││__
The _X_G_e_t_F_o_n_t_P_a_t_h function allocates and returns an array of
strings containing the search path. The contents of these
strings are implementation-dependent and are not intended to
be interpreted by client applications. When it is no longer
needed, the data in the font path should be freed by using
_X_F_r_e_e_F_o_n_t_P_a_t_h.
To free data returned by _X_G_e_t_F_o_n_t_P_a_t_h, use _X_F_r_e_e_F_o_n_t_P_a_t_h.
__
││
XFreeFontPath(_l_i_s_t)
char **_l_i_s_t;
_l_i_s_t Specifies the array of strings you want to free.
││__
The _X_F_r_e_e_F_o_n_t_P_a_t_h function frees the data allocated by _X_G_e_t_-
_F_o_n_t_P_a_t_h.
99..55.. GGrraabbbbiinngg tthhee SSeerrvveerr
Xlib provides functions that you can use to grab and ungrab
the server. These functions can be used to control process-
ing of output on other connections by the window system
server. While the server is grabbed, no processing of
requests or close downs on any other connection will occur.
A client closing its connection automatically ungrabs the
server. Although grabbing the server is highly discouraged,
it is sometimes necessary.
To grab the server, use _X_G_r_a_b_S_e_r_v_e_r.
227766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XGrabServer(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_G_r_a_b_S_e_r_v_e_r 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.
To ungrab the server, use _X_U_n_g_r_a_b_S_e_r_v_e_r.
__
││
XUngrabServer(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_U_n_g_r_a_b_S_e_r_v_e_r function restarts processing of requests
and close downs on other connections. You should avoid
grabbing the X server as much as possible.
99..66.. KKiilllliinngg CClliieennttss
Xlib provides a function to cause the connection to a client
to be closed and its resources to be destroyed. To destroy
a client, use _X_K_i_l_l_C_l_i_e_n_t.
__
││
XKillClient(_d_i_s_p_l_a_y, _r_e_s_o_u_r_c_e)
Display *_d_i_s_p_l_a_y;
XID _r_e_s_o_u_r_c_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_e_s_o_u_r_c_e Specifies any resource associated with the client
that you want to destroy or _A_l_l_T_e_m_p_o_r_a_r_y.
││__
The _X_K_i_l_l_C_l_i_e_n_t function forces a close down of the client
that created the resource if a valid resource is specified.
If the client has already terminated in either _R_e_t_a_i_n_P_e_r_m_a_-
_n_e_n_t or _R_e_t_a_i_n_T_e_m_p_o_r_a_r_y mode, all of the client's resources
are destroyed. If _A_l_l_T_e_m_p_o_r_a_r_y is specified, the resources
of all clients that have terminated in _R_e_t_a_i_n_T_e_m_p_o_r_a_r_y are
destroyed (see section 2.5). This permits implementation of
window manager facilities that aid debugging. A client can
227777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
set its close-down mode to _R_e_t_a_i_n_T_e_m_p_o_r_a_r_y. If the client
then crashes, its windows would not be destroyed. The pro-
grammer can then inspect the application's window tree and
use the window manager to destroy the zombie windows.
_X_K_i_l_l_C_l_i_e_n_t can generate a _B_a_d_V_a_l_u_e error.
99..77.. CCoonnttrroolllliinngg tthhee SSccrreeeenn SSaavveerr
Xlib provides functions that you can use to set or reset the
mode of the screen saver, to force or activate the screen
saver, or to obtain the current screen saver values.
To set the screen saver mode, use _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r.
__
││
XSetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l, _p_r_e_f_e_r___b_l_a_n_k_i_n_g, _a_l_l_o_w___e_x_p_o_s_u_r_e_s)
Display *_d_i_s_p_l_a_y;
int _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l;
int _p_r_e_f_e_r___b_l_a_n_k_i_n_g;
int _a_l_l_o_w___e_x_p_o_s_u_r_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_i_m_e_o_u_t Specifies the timeout, in seconds, until the
screen saver turns on.
_i_n_t_e_r_v_a_l Specifies the interval, in seconds, between screen
saver alterations.
_p_r_e_f_e_r___b_l_a_n_k_i_n_g
Specifies how to enable screen blanking. You can
pass _D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or
_D_e_f_a_u_l_t_B_l_a_n_k_i_n_g.
_a_l_l_o_w___e_x_p_o_s_u_r_e_s
Specifies the screen save control values. You can
pass _D_o_n_t_A_l_l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or
_D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s.
││__
Timeout and interval are specified in seconds. A timeout of
0 disables the screen saver (but an activated screen saver
is not deactivated), and a timeout of -1 restores the
default. Other negative values generate a _B_a_d_V_a_l_u_e error.
If the timeout value is nonzero, _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r enables the
screen saver. An interval of 0 disables the random-pattern
motion. If no input from devices (keyboard, mouse, and so
on) is generated for the specified number of timeout seconds
once the screen saver is enabled, the screen saver is acti-
vated.
227788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
For each screen, if blanking is preferred and the hardware
supports video blanking, the screen simply goes blank. Oth-
erwise, if either exposures are allowed or the screen can be
regenerated without sending _E_x_p_o_s_e events to clients, the
screen is tiled with the root window background tile ran-
domly re-origined each interval seconds. Otherwise, the
screens' state do not change, and the screen saver is not
activated. The screen saver is deactivated, and all screen
states are restored at the next keyboard or pointer input or
at the next call to _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r with mode _S_c_r_e_e_n_S_a_v_e_r_-
_R_e_s_e_t.
If the server-dependent screen saver method supports peri-
odic change, the interval argument serves as a hint about
how long the change period should be, and zero hints that no
periodic change should be made. Examples of ways to change
the screen include scrambling the colormap periodically,
moving an icon image around the screen periodically, or
tiling the screen with the root window background tile, ran-
domly re-origined periodically.
_X_S_e_t_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.
To force the screen saver on or off, use _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r.
__
││
XForceScreenSaver(_d_i_s_p_l_a_y, _m_o_d_e)
Display *_d_i_s_p_l_a_y;
int _m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_o_d_e Specifies the mode that is to be applied. You can
pass _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e or _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.
││__
If the specified mode is _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e and the screen
saver currently is deactivated, _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r activates
the screen saver even if the screen saver had been disabled
with a timeout of zero. If the specified mode is _S_c_r_e_e_n_-
_S_a_v_e_r_R_e_s_e_t and the screen saver currently is enabled,
_X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r deactivates the screen saver if it was
activated, and the activation timer is reset to its initial
state (as if device input had been received).
_X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.
To activate the screen saver, use _X_A_c_t_i_v_a_t_e_S_c_r_e_e_n_S_a_v_e_r.
227799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XActivateScreenSaver(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
To reset the screen saver, use _X_R_e_s_e_t_S_c_r_e_e_n_S_a_v_e_r.
__
││
XResetScreenSaver(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
To get the current screen saver values, use _X_G_e_t_S_c_r_e_e_n_S_a_v_e_r.
__
││
XGetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t___r_e_t_u_r_n, _i_n_t_e_r_v_a_l___r_e_t_u_r_n, _p_r_e_f_e_r___b_l_a_n_k_i_n_g___r_e_t_u_r_n,
_a_l_l_o_w___e_x_p_o_s_u_r_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_t_i_m_e_o_u_t___r_e_t_u_r_n, *_i_n_t_e_r_v_a_l___r_e_t_u_r_n;
int *_p_r_e_f_e_r___b_l_a_n_k_i_n_g___r_e_t_u_r_n;
int *_a_l_l_o_w___e_x_p_o_s_u_r_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_i_m_e_o_u_t___r_e_t_u_r_n
Returns the timeout, in seconds, until the screen
saver turns on.
_i_n_t_e_r_v_a_l___r_e_t_u_r_n
Returns the interval between screen saver invoca-
tions.
_p_r_e_f_e_r___b_l_a_n_k_i_n_g___r_e_t_u_r_n
Returns the current screen blanking preference
(_D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or _D_e_f_a_u_l_t_-
_B_l_a_n_k_i_n_g).
_a_l_l_o_w___e_x_p_o_s_u_r_e_s___r_e_t_u_r_n
Returns the current screen save control value
(_D_o_n_t_A_l_l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or _D_e_f_a_u_l_t_E_x_-
_p_o_s_u_r_e_s).
││__
228800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
99..88.. CCoonnttrroolllliinngg HHoosstt AAcccceessss
This section discusses how to:
· Add, get, or remove hosts from the access control list
· Change, enable, or disable access
X does not provide any protection on a per-window basis. If
you find out the resource ID of a resource, you can manipu-
late it. To provide some minimal level of protection, how-
ever, connections are permitted only from machines you
trust. This is adequate on single-user workstations but
obviously breaks down on timesharing machines. Although
provisions exist in the X protocol for proper connection
authentication, the lack of a standard authentication server
leaves host-level access control as the only common mecha-
nism.
The initial set of hosts allowed to open connections typi-
cally consists of:
· The host the window system is running on.
· On POSIX-conformant systems, each host listed in the
_/_e_t_c_/_X_?_._h_o_s_t_s file. The ? indicates the number of the
display. This file should consist of host names sepa-
rated by newlines. DECnet nodes must terminate in ::
to distinguish them from Internet hosts.
If a host is not in the access control list when the access
control mechanism is enabled and if the host attempts to
establish a connection, the server refuses the connection.
To change the access list, the client must reside on the
same host as the server and/or must have been granted per-
mission in the initial authorization at connection setup.
Servers also can implement other access control policies in
addition to or in place of this host access facility. For
further information about other access control implementa-
tions, see ``X Window System Protocol.''
99..88..11.. AAddddiinngg,, GGeettttiinngg,, oorr RReemmoovviinngg HHoossttss
Xlib provides functions that you can use to add, get, or
remove hosts from the access control list. All the host
access control functions use the _X_H_o_s_t_A_d_d_r_e_s_s structure,
which contains:
228811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int family; /* for example FamilyInternet */
int length; /* length of address, in bytes */
char *address; /* pointer to where to find the address */
} XHostAddress;
││__
The family member specifies which protocol address family to
use (for example, TCP/IP or DECnet) and can be _F_a_m_i_l_y_I_n_t_e_r_-
_n_e_t, _F_a_m_i_l_y_I_n_t_e_r_n_e_t_6, _F_a_m_i_l_y_S_e_r_v_e_r_I_n_t_e_r_p_r_e_t_e_d, _F_a_m_i_l_y_D_E_C_n_e_t,
or _F_a_m_i_l_y_C_h_a_o_s. The length member specifies the length of
the address in bytes. The address member specifies a
pointer to the address.
For TCP/IP, the address should be in network byte order.
For IP version 4 addresses, the family should be FamilyIn-
ternet and the length should be 4 bytes. For IP version 6
addresses, the family should be FamilyInternet6 and the
length should be 16 bytes.
For the DECnet family, the server performs no automatic
swapping on the address bytes. A Phase IV address is 2
bytes long. The first byte contains the least significant 8
bits of the node number. The second byte contains the most
significant 2 bits of the node number in the least signifi-
cant 2 bits of the byte and the area in the most significant
6 bits of the byte.
For the ServerInterpreted family, the length is ignored and
the address member is a pointer to a _X_S_e_r_v_e_r_I_n_t_e_r_p_r_e_t_e_d_A_d_-
_d_r_e_s_s structure, which contains:
__
││
typedef struct {
int typelength; /* length of type string, in bytes */
int valuelength;/* length of value string, in bytes */
char *type; /* pointer to where to find the type string */
char *value; /* pointer to where to find the address */
} XServerInterpretedAddress;
││__
The type and value members point to strings representing the
type and value of the server interpreted entry. These
strings may not be NULL-terminated so care should be used
when accessing them. The typelength and valuelength members
specify the length in byte of the type and value strings.
To add a single host, use _X_A_d_d_H_o_s_t.
228822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XAddHost(_d_i_s_p_l_a_y, _h_o_s_t)
Display *_d_i_s_p_l_a_y;
XHostAddress *_h_o_s_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_h_o_s_t Specifies the host that is to be added.
││__
The _X_A_d_d_H_o_s_t function adds the specified host to the access
control list for that display. The server must be on the
same host as the client issuing the command, or a _B_a_d_A_c_c_e_s_s
error results.
_X_A_d_d_H_o_s_t can generate _B_a_d_A_c_c_e_s_s and _B_a_d_V_a_l_u_e errors.
To add multiple hosts at one time, use _X_A_d_d_H_o_s_t_s.
__
││
XAddHosts(_d_i_s_p_l_a_y, _h_o_s_t_s, _n_u_m___h_o_s_t_s)
Display *_d_i_s_p_l_a_y;
XHostAddress *_h_o_s_t_s;
int _n_u_m___h_o_s_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_h_o_s_t_s Specifies each host that is to be added.
_n_u_m___h_o_s_t_s Specifies the number of hosts.
││__
The _X_A_d_d_H_o_s_t_s function adds each specified host to the
access control list for that display. The server must be on
the same host as the client issuing the command, or a _B_a_d_A_c_-
_c_e_s_s error results.
_X_A_d_d_H_o_s_t_s can generate _B_a_d_A_c_c_e_s_s and _B_a_d_V_a_l_u_e errors.
To obtain a host list, use _X_L_i_s_t_H_o_s_t_s.
228833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XHostAddress *XListHosts(_d_i_s_p_l_a_y, _n_h_o_s_t_s___r_e_t_u_r_n, _s_t_a_t_e___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_n_h_o_s_t_s___r_e_t_u_r_n;
Bool *_s_t_a_t_e___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_h_o_s_t_s___r_e_t_u_r_n
Returns the number of hosts currently in the
access control list.
_s_t_a_t_e___r_e_t_u_r_n
Returns the state of the access control.
││__
The _X_L_i_s_t_H_o_s_t_s function returns the current access control
list as well as whether the use of the list at connection
setup was enabled or disabled. _X_L_i_s_t_H_o_s_t_s 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. When no longer needed, this mem-
ory should be freed by calling _X_F_r_e_e.
To remove a single host, use _X_R_e_m_o_v_e_H_o_s_t.
__
││
XRemoveHost(_d_i_s_p_l_a_y, _h_o_s_t)
Display *_d_i_s_p_l_a_y;
XHostAddress *_h_o_s_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_h_o_s_t Specifies the host that is to be removed.
││__
The _X_R_e_m_o_v_e_H_o_s_t 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_a_d_A_c_c_e_s_s error
results. 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.
_X_R_e_m_o_v_e_H_o_s_t can generate _B_a_d_A_c_c_e_s_s and _B_a_d_V_a_l_u_e errors.
To remove multiple hosts at one time, use _X_R_e_m_o_v_e_H_o_s_t_s.
228844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XRemoveHosts(_d_i_s_p_l_a_y, _h_o_s_t_s, _n_u_m___h_o_s_t_s)
Display *_d_i_s_p_l_a_y;
XHostAddress *_h_o_s_t_s;
int _n_u_m___h_o_s_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_h_o_s_t_s Specifies each host that is to be removed.
_n_u_m___h_o_s_t_s Specifies the number of hosts.
││__
The _X_R_e_m_o_v_e_H_o_s_t_s 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_a_d_A_c_c_e_s_s
error results. 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.
_X_R_e_m_o_v_e_H_o_s_t_s can generate _B_a_d_A_c_c_e_s_s and _B_a_d_V_a_l_u_e errors.
99..88..22.. CChhaannggiinngg,, EEnnaabblliinngg,, oorr DDiissaabblliinngg AAcccceessss CCoonnttrrooll
Xlib provides functions that you can use to enable, disable,
or change access control.
For these functions to execute successfully, the client
application must reside on the same host as the X server
and/or have been given permission in the initial authoriza-
tion at connection setup.
To change access control, use _X_S_e_t_A_c_c_e_s_s_C_o_n_t_r_o_l.
__
││
XSetAccessControl(_d_i_s_p_l_a_y, _m_o_d_e)
Display *_d_i_s_p_l_a_y;
int _m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_o_d_e Specifies the mode. You can pass _E_n_a_b_l_e_A_c_c_e_s_s or
_D_i_s_a_b_l_e_A_c_c_e_s_s.
││__
The _X_S_e_t_A_c_c_e_s_s_C_o_n_t_r_o_l function either enables or disables
the use of the access control list at each connection setup.
_X_S_e_t_A_c_c_e_s_s_C_o_n_t_r_o_l can generate _B_a_d_A_c_c_e_s_s and _B_a_d_V_a_l_u_e
errors.
228855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To enable access control, use _X_E_n_a_b_l_e_A_c_c_e_s_s_C_o_n_t_r_o_l.
__
││
XEnableAccessControl(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_E_n_a_b_l_e_A_c_c_e_s_s_C_o_n_t_r_o_l function enables the use of the
access control list at each connection setup.
_X_E_n_a_b_l_e_A_c_c_e_s_s_C_o_n_t_r_o_l can generate a _B_a_d_A_c_c_e_s_s error.
To disable access control, use _X_D_i_s_a_b_l_e_A_c_c_e_s_s_C_o_n_t_r_o_l.
__
││
XDisableAccessControl(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_D_i_s_a_b_l_e_A_c_c_e_s_s_C_o_n_t_r_o_l function disables the use of the
access control list at each connection setup.
_X_D_i_s_a_b_l_e_A_c_c_e_s_s_C_o_n_t_r_o_l can generate a _B_a_d_A_c_c_e_s_s error.
228866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1100
EEvveennttss
A client application communicates with the X server through
the connection you establish with the _X_O_p_e_n_D_i_s_p_l_a_y function.
A client application sends requests to the X server over
this connection. These requests are made by the Xlib func-
tions that are called in the client application. Many Xlib
functions cause the X server to generate events, and the
user's typing or moving the pointer can generate events
asynchronously. The X server returns events to the client
on the same connection.
This chapter discusses the following topics associated with
events:
· Event types
· Event structures
· Event masks
· Event processing
Functions for handling events are dealt with in the next
chapter.
1100..11.. EEvveenntt TTyyppeess
An event is data generated asynchronously by the X server as
a result of some device activity or as side effects of a
request sent by an Xlib function. Device-related events
propagate from the source window to ancestor windows until
some client application has selected that event type or
until the event is explicitly discarded. The X server gen-
erally sends an event to a client application only if the
client has specifically asked to be informed of that event
type, typically by setting the event-mask attribute of the
window. The mask can also be set when you create a window
or by changing the window's event-mask. You can also mask
out events that would propagate to ancestor windows by
manipulating the do-not-propagate mask of the window's
attributes. However, _M_a_p_p_i_n_g_N_o_t_i_f_y events are always sent
to all clients.
An event type describes a specific event generated by the X
server. For each event type, a corresponding constant name
is defined in <_X_1_1_/_X_._h>, which is used when referring to an
event type. The following table lists the event category
228877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
and its associated event type or types. The processing
associated with these events is discussed in section 10.5.
-------------------------------------------------------------
EEvveenntt CCaatteeggoorryy EEvveenntt TTyyppee
-------------------------------------------------------------
Keyboard events _K_e_y_P_r_e_s_s, _K_e_y_R_e_l_e_a_s_e
Pointer events _B_u_t_t_o_n_P_r_e_s_s, _B_u_t_t_o_n_R_e_l_e_a_s_e, _M_o_t_i_o_n_-
_N_o_t_i_f_y
Window crossing events _E_n_t_e_r_N_o_t_i_f_y, _L_e_a_v_e_N_o_t_i_f_y
Input focus events _F_o_c_u_s_I_n, _F_o_c_u_s_O_u_t
Keymap state notifica- _K_e_y_m_a_p_N_o_t_i_f_y
tion event
Exposure events _E_x_p_o_s_e, _G_r_a_p_h_i_c_s_E_x_p_o_s_e, _N_o_E_x_p_o_s_e
Structure control _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t, _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t,
events _M_a_p_R_e_q_u_e_s_t, _R_e_s_i_z_e_R_e_q_u_e_s_t
Window state notifica- _C_i_r_c_u_l_a_t_e_N_o_t_i_f_y, _C_o_n_f_i_g_u_r_e_N_o_t_i_f_y,
tion events _C_r_e_a_t_e_N_o_t_i_f_y, _D_e_s_t_r_o_y_N_o_t_i_f_y, _G_r_a_v_i_-
_t_y_N_o_t_i_f_y, _M_a_p_N_o_t_i_f_y, _M_a_p_p_i_n_g_N_o_t_i_f_y,
_R_e_p_a_r_e_n_t_N_o_t_i_f_y, _U_n_m_a_p_N_o_t_i_f_y,
_V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y
Colormap state notifi- _C_o_l_o_r_m_a_p_N_o_t_i_f_y
cation event
Client communication _C_l_i_e_n_t_M_e_s_s_a_g_e, _P_r_o_p_e_r_t_y_N_o_t_i_f_y,
events _S_e_l_e_c_t_i_o_n_C_l_e_a_r, _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y,
_S_e_l_e_c_t_i_o_n_R_e_q_u_e_s_t
-------------------------------------------------------------
1100..22.. EEvveenntt SSttrruuccttuurreess
For each event type, a corresponding structure is declared
in <_X_1_1_/_X_l_i_b_._h>. All the event structures have the follow-
ing common members:
__
││
typedef struct {
int type;
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
} XAnyEvent;
││__
The type member is set to the event type constant name that
uniquely identifies it. For example, when the X server
reports a _G_r_a_p_h_i_c_s_E_x_p_o_s_e event to a client application, it
sends an _X_G_r_a_p_h_i_c_s_E_x_p_o_s_e_E_v_e_n_t structure with the type member
set to _G_r_a_p_h_i_c_s_E_x_p_o_s_e. The display member is set to a
228888
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
pointer to the display the event was read on. The
send_event member is set to _T_r_u_e if the event came from a
_S_e_n_d_E_v_e_n_t protocol request. The serial member is set from
the serial number reported in the protocol 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.
The X server can send events at any time in the input
stream. Xlib stores any events received while waiting for a
reply in an event queue for later use. Xlib also provides
functions that allow you to check events in the event queue
(see section 11.3).
In addition to the individual structures declared for each
event type, the _X_E_v_e_n_t structure is a union of the individ-
ual structures declared for each event type. Depending on
the type, you should access members of each event by using
the _X_E_v_e_n_t union.
228899
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef union _XEvent {
int type; /* must not be changed */
XAnyEvent xany;
XKeyEvent xkey;
XButtonEvent xbutton;
XMotionEvent xmotion;
XCrossingEvent xcrossing;
XFocusChangeEvent xfocus;
XExposeEvent xexpose;
XGraphicsExposeEvent xgraphicsexpose;
XNoExposeEvent xnoexpose;
XVisibilityEvent xvisibility;
XCreateWindowEvent xcreatewindow;
XDestroyWindowEvent xdestroywindow;
XUnmapEvent xunmap;
XMapEvent xmap;
XMapRequestEvent xmaprequest;
XReparentEvent xreparent;
XConfigureEvent xconfigure;
XGravityEvent xgravity;
XResizeRequestEvent xresizerequest;
XConfigureRequestEvent xconfigurerequest;
XCirculateEvent xcirculate;
XCirculateRequestEvent xcirculaterequest;
XPropertyEvent xproperty;
XSelectionClearEvent xselectionclear;
XSelectionRequestEvent xselectionrequest;
XSelectionEvent xselection;
XColormapEvent xcolormap;
XClientMessageEvent xclient;
XMappingEvent xmapping;
XErrorEvent xerror;
XKeymapEvent xkeymap;
long pad[24];
} XEvent;
││__
An _X_E_v_e_n_t structure's first entry always is the type member,
which is set to the event type. The second member always is
the serial number of the protocol request that generated the
event. The third member always is send_event, which is a
_B_o_o_l that indicates if the event was sent by a different
client. The fourth member always is a display, which is the
display that the event was read from. Except for keymap
events, the fifth member always is a window, which has been
carefully selected to be useful to toolkit dispatchers. To
avoid breaking toolkits, the order of these first five
entries is not to change. Most events also contain a time
member, which is the time at which an event occurred. In
addition, a pointer to the generic event must be cast before
it is used to access any other information in the structure.
229900
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1100..33.. EEvveenntt MMaasskkss
Clients select event reporting of most events relative to a
window. To do this, pass an event mask to an Xlib event-
handling function that takes an event_mask argument. The
bits of the event mask are defined in <_X_1_1_/_X_._h>. Each bit
in the event mask maps to an event mask name, which
describes the event or events you want the X server to
return to a client application.
Unless the client has specifically asked for them, most
events are not reported to clients when they are generated.
Unless the client suppresses them by setting graphics-expo-
sures in the GC to _F_a_l_s_e, _G_r_a_p_h_i_c_s_E_x_p_o_s_e and _N_o_E_x_p_o_s_e are
reported by default as a result of _X_C_o_p_y_P_l_a_n_e and _X_C_o_p_y_A_r_e_a.
_S_e_l_e_c_t_i_o_n_C_l_e_a_r, _S_e_l_e_c_t_i_o_n_R_e_q_u_e_s_t, _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y, or
_C_l_i_e_n_t_M_e_s_s_a_g_e cannot be masked. Selection-related events
are only sent to clients cooperating with selections (see
section 4.5). When the keyboard or pointer mapping is
changed, _M_a_p_p_i_n_g_N_o_t_i_f_y is always sent to clients.
The following table lists the event mask constants you can
pass to the event_mask argument and the circumstances in
which you would want to specify the event mask:
-----------------------------------------------------------
EEvveenntt MMaasskk CCiirrccuummssttaanncceess
-----------------------------------------------------------
_N_o_E_v_e_n_t_M_a_s_k No events wanted
_K_e_y_P_r_e_s_s_M_a_s_k Keyboard down events wanted
_K_e_y_R_e_l_e_a_s_e_M_a_s_k Keyboard up events wanted
_B_u_t_t_o_n_P_r_e_s_s_M_a_s_k Pointer button down events wanted
_B_u_t_t_o_n_R_e_l_e_a_s_e_M_a_s_k Pointer button up events wanted
_E_n_t_e_r_W_i_n_d_o_w_M_a_s_k Pointer window entry events wanted
_L_e_a_v_e_W_i_n_d_o_w_M_a_s_k Pointer window leave events wanted
_P_o_i_n_t_e_r_M_o_t_i_o_n_M_a_s_k Pointer motion events wanted
_P_o_i_n_t_e_r_M_o_t_i_o_n_H_i_n_t_- Pointer motion hints wanted
_M_a_s_k
_B_u_t_t_o_n_1_M_o_t_i_o_n_M_a_s_k Pointer motion while button 1 down
_B_u_t_t_o_n_2_M_o_t_i_o_n_M_a_s_k Pointer motion while button 2 down
_B_u_t_t_o_n_3_M_o_t_i_o_n_M_a_s_k Pointer motion while button 3 down
_B_u_t_t_o_n_4_M_o_t_i_o_n_M_a_s_k Pointer motion while button 4 down
_B_u_t_t_o_n_5_M_o_t_i_o_n_M_a_s_k Pointer motion while button 5 down
_B_u_t_t_o_n_M_o_t_i_o_n_M_a_s_k Pointer motion while any button
down
_K_e_y_m_a_p_S_t_a_t_e_M_a_s_k Keyboard state wanted at window
entry and focus in
_E_x_p_o_s_u_r_e_M_a_s_k Any exposure wanted
_V_i_s_i_b_i_l_i_t_y_C_h_a_n_g_e_M_a_s_k Any change in visibility wanted
_S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k Any change in window structure
wanted
_R_e_s_i_z_e_R_e_d_i_r_e_c_t_M_a_s_k Redirect resize of this window
229911
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-----------------------------------------------------------
EEvveenntt MMaasskk CCiirrccuummssttaanncceess
-----------------------------------------------------------
_S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_- Substructure notification wanted
_M_a_s_k
_S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_- Redirect structure requests on
_r_e_c_t_M_a_s_k children
_F_o_c_u_s_C_h_a_n_g_e_M_a_s_k Any change in input focus wanted
_P_r_o_p_e_r_t_y_C_h_a_n_g_e_M_a_s_k Any change in property wanted
_C_o_l_o_r_m_a_p_C_h_a_n_g_e_M_a_s_k Any change in colormap wanted
_O_w_n_e_r_G_r_a_b_B_u_t_t_o_n_M_a_s_k Automatic grabs should activate
with owner_events set to _T_r_u_e
-----------------------------------------------------------
1100..44.. EEvveenntt PPrroocceessssiinngg OOvveerrvviieeww
The event reported to a client application during event pro-
cessing depends on which event masks you provide as the
event-mask attribute for a window. For some event masks,
there is a one-to-one correspondence between the event mask
constant and the event type constant. For example, if you
pass the event mask _B_u_t_t_o_n_P_r_e_s_s_M_a_s_k, the X server sends back
only _B_u_t_t_o_n_P_r_e_s_s events. Most events contain a time member,
which is the time at which an event occurred.
In other cases, one event mask constant can map to several
event type constants. For example, if you pass the event
mask _S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k, the X server can send back _C_i_r_-
_c_u_l_a_t_e_N_o_t_i_f_y, _C_o_n_f_i_g_u_r_e_N_o_t_i_f_y, _C_r_e_a_t_e_N_o_t_i_f_y, _D_e_s_t_r_o_y_N_o_t_i_f_y,
_G_r_a_v_i_t_y_N_o_t_i_f_y, _M_a_p_N_o_t_i_f_y, _R_e_p_a_r_e_n_t_N_o_t_i_f_y, or _U_n_m_a_p_N_o_t_i_f_y
events.
In another case, two event masks can map to one event type.
For example, if you pass either _P_o_i_n_t_e_r_M_o_t_i_o_n_M_a_s_k or _B_u_t_t_o_n_-
_M_o_t_i_o_n_M_a_s_k, the X server sends back a _M_o_t_i_o_n_N_o_t_i_f_y event.
The following table lists the event mask, its associated
event type or types, and the structure name associated with
the event type. Some of these structures actually are type-
defs to a generic structure that is shared between two event
types. Note that N.A. appears in columns for which the
information is not applicable.
------------------------------------------------------------------------------------------
EEvveenntt MMaasskk EEvveenntt TTyyppee SSttrruuccttuurree GGeenneerriicc SSttrruuccttuurree
------------------------------------------------------------------------------------------
ButtonMotionMask MotionNotify XPointerMovedEvent XMotionEvent
Button1MotionMask
Button2MotionMask
Button3MotionMask
229922
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
------------------------------------------------------------------------------------------
EEvveenntt MMaasskk EEvveenntt TTyyppee SSttrruuccttuurree GGeenneerriicc SSttrruuccttuurree
------------------------------------------------------------------------------------------
Button4MotionMask
Button5MotionMask
ButtonPressMask ButtonPress XButtonPressedEvent XButtonEvent
ButtonReleaseMask ButtonRelease XButtonReleasedEvent XButtonEvent
ColormapChangeMask ColormapNotify XColormapEvent
EnterWindowMask EnterNotify XEnterWindowEvent XCrossingEvent
LeaveWindowMask LeaveNotify XLeaveWindowEvent XCrossingEvent
ExposureMask Expose XExposeEvent
GCGraphicsExposures in GC GraphicsExpose XGraphicsExposeEvent
NoExpose XNoExposeEvent
FocusChangeMask FocusIn XFocusInEvent XFocusChangeEvent
FocusOut XFocusOutEvent XFocusChangeEvent
KeymapStateMask KeymapNotify XKeymapEvent
KeyPressMask KeyPress XKeyPressedEvent XKeyEvent
KeyReleaseMask KeyRelease XKeyReleasedEvent XKeyEvent
OwnerGrabButtonMask N.A. N.A.
PointerMotionMask MotionNotify XPointerMovedEvent XMotionEvent
PointerMotionHintMask N.A. N.A.
PropertyChangeMask PropertyNotify XPropertyEvent
ResizeRedirectMask ResizeRequest XResizeRequestEvent
StructureNotifyMask CirculateNotify XCirculateEvent
ConfigureNotify XConfigureEvent
DestroyNotify XDestroyWindowEvent
GravityNotify XGravityEvent
MapNotify XMapEvent
ReparentNotify XReparentEvent
UnmapNotify XUnmapEvent
SubstructureNotifyMask CirculateNotify XCirculateEvent
ConfigureNotify XConfigureEvent
CreateNotify XCreateWindowEvent
DestroyNotify XDestroyWindowEvent
GravityNotify XGravityEvent
MapNotify XMapEvent
ReparentNotify XReparentEvent
UnmapNotify XUnmapEvent
SubstructureRedirectMask CirculateRequest XCirculateRequestEvent
ConfigureRequest XConfigureRequestEvent
MapRequest XMapRequestEvent
N.A. ClientMessage XClientMessageEvent
N.A. MappingNotify XMappingEvent
N.A. SelectionClear XSelectionClearEvent
N.A. SelectionNotify XSelectionEvent
N.A. SelectionRequest XSelectionRequestEvent
VisibilityChangeMask VisibilityNotify XVisibilityEvent
------------------------------------------------------------------------------------------
The sections that follow describe the processing that occurs
when you select the different event masks. The sections are
organized according to these processing categories:
229933
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Keyboard and pointer events
· Window crossing events
· Input focus events
· Keymap state notification events
· Exposure events
· Window state notification events
· Structure control events
· Colormap state notification events
· Client communication events
1100..55.. KKeeyybbooaarrdd aanndd PPooiinntteerr EEvveennttss
This section discusses:
· Pointer button events
· Keyboard and pointer events
1100..55..11.. PPooiinntteerr BBuuttttoonn EEvveennttss
The following describes the event processing that occurs
when a pointer button press is processed with the pointer in
some window w and when no active pointer grab is in
progress.
The X server searches the ancestors of w from the root down,
looking for a passive grab to activate. If no matching pas-
sive grab on the button exists, the X server automatically
starts an active grab for the client receiving the event and
sets the last-pointer-grab time to the current server time.
The effect is essentially equivalent to an _X_G_r_a_b_B_u_t_t_o_n with
these client passed arguments:
------------------------------------------------------
AArrgguummeenntt VVaalluuee
------------------------------------------------------
_w The event window
_e_v_e_n_t___m_a_s_k The client's selected pointer
events on the event window
_p_o_i_n_t_e_r___m_o_d_e _G_r_a_b_M_o_d_e_A_s_y_n_c
_k_e_y_b_o_a_r_d___m_o_d_e _G_r_a_b_M_o_d_e_A_s_y_n_c
_o_w_n_e_r___e_v_e_n_t_s _T_r_u_e, if the client has selected
_O_w_n_e_r_G_r_a_b_B_u_t_t_o_n_M_a_s_k on the event
window, otherwise _F_a_l_s_e
_c_o_n_f_i_n_e___t_o _N_o_n_e
229944
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
------------------------------------------------------
AArrgguummeenntt VVaalluuee
------------------------------------------------------
_c_u_r_s_o_r _N_o_n_e
------------------------------------------------------
The active grab is automatically terminated when the logical
state of the pointer has all buttons released. Clients can
modify the active grab by calling _X_U_n_g_r_a_b_P_o_i_n_t_e_r and
_X_C_h_a_n_g_e_A_c_t_i_v_e_P_o_i_n_t_e_r_G_r_a_b.
1100..55..22.. KKeeyybbooaarrdd aanndd PPooiinntteerr EEvveennttss
This section discusses the processing that occurs for the
keyboard events _K_e_y_P_r_e_s_s and _K_e_y_R_e_l_e_a_s_e and the pointer
events _B_u_t_t_o_n_P_r_e_s_s, _B_u_t_t_o_n_R_e_l_e_a_s_e, and _M_o_t_i_o_n_N_o_t_i_f_y. For
information about the keyboard event-handling utilities, see
chapter 11.
The X server reports _K_e_y_P_r_e_s_s or _K_e_y_R_e_l_e_a_s_e events to
clients wanting information about keys that logically change
state. Note that these events are generated for all keys,
even those mapped to modifier bits. The X server reports
_B_u_t_t_o_n_P_r_e_s_s or _B_u_t_t_o_n_R_e_l_e_a_s_e events to clients wanting
information about buttons that logically change state.
The X server reports _M_o_t_i_o_n_N_o_t_i_f_y events to clients wanting
information about when the pointer logically moves. The X
server generates this event whenever the pointer is moved
and the pointer motion begins and ends in the window. The
granularity of _M_o_t_i_o_n_N_o_t_i_f_y events is not guaranteed, but a
client that selects this event type is guaranteed to receive
at least one event when the pointer moves and then rests.
The generation of the logical changes lags the physical
changes if device event processing is frozen.
To receive _K_e_y_P_r_e_s_s, _K_e_y_R_e_l_e_a_s_e, _B_u_t_t_o_n_P_r_e_s_s, and _B_u_t_t_o_n_R_e_-
_l_e_a_s_e events, set _K_e_y_P_r_e_s_s_M_a_s_k, _K_e_y_R_e_l_e_a_s_e_M_a_s_k, _B_u_t_t_o_n_P_r_e_s_s_-
_M_a_s_k, and _B_u_t_t_o_n_R_e_l_e_a_s_e_M_a_s_k bits in the event-mask attribute
of the window.
To receive _M_o_t_i_o_n_N_o_t_i_f_y events, set one or more of the fol-
lowing event masks bits in the event-mask attribute of the
window.
· _B_u_t_t_o_n_1_M_o_t_i_o_n_M_a_s_k - _B_u_t_t_o_n_5_M_o_t_i_o_n_M_a_s_k
The client application receives _M_o_t_i_o_n_N_o_t_i_f_y events
only when one or more of the specified buttons is
pressed.
229955
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· _B_u_t_t_o_n_M_o_t_i_o_n_M_a_s_k
The client application receives _M_o_t_i_o_n_N_o_t_i_f_y events
only when at least one button is pressed.
· _P_o_i_n_t_e_r_M_o_t_i_o_n_M_a_s_k
The client application receives _M_o_t_i_o_n_N_o_t_i_f_y events
independent of the state of the pointer buttons.
· _P_o_i_n_t_e_r_M_o_t_i_o_n_H_i_n_t_M_a_s_k
If _P_o_i_n_t_e_r_M_o_t_i_o_n_H_i_n_t_M_a_s_k is selected in combination
with one or more of the above masks, the X server is
free to send only one _M_o_t_i_o_n_N_o_t_i_f_y event (with the
is_hint member of the _X_P_o_i_n_t_e_r_M_o_v_e_d_E_v_e_n_t structure set
to _N_o_t_i_f_y_H_i_n_t) to the client for the event window,
until either the key or button state changes, the
pointer leaves the event window, or the client calls
_X_Q_u_e_r_y_P_o_i_n_t_e_r or _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s. The server still
may send _M_o_t_i_o_n_N_o_t_i_f_y events without is_hint set to
_N_o_t_i_f_y_H_i_n_t.
The source of the event is the viewable window that the
pointer is in. The window used by the X server to report
these events depends on the window's position in the window
hierarchy and whether any intervening window prohibits the
generation of these events. Starting with the source win-
dow, the X server searches up the window hierarchy until it
locates the first window specified by a client as having an
interest in these events. If one of the intervening windows
has its do-not-propagate-mask set to prohibit generation of
the event type, the events of those types will be sup-
pressed. Clients can modify the actual window used for
reporting by performing active grabs and, in the case of
keyboard events, by using the focus window.
The structures for these event types contain:
229966
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int type; /* ButtonPress or ButtonRelease */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* ``event'' window it is reported relative to */
Window root; /* root window that the event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* pointer x, y coordinates in event window */
int x_root, y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
unsigned int button; /* detail */
Bool same_screen; /* same screen flag */
} XButtonEvent;
typedef XButtonEvent XButtonPressedEvent;
typedef XButtonEvent XButtonReleasedEvent;
typedef struct {
int type; /* KeyPress or KeyRelease */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* ``event'' window it is reported relative to */
Window root; /* root window that the event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* pointer x, y coordinates in event window */
int x_root, y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
unsigned int keycode; /* detail */
Bool same_screen; /* same screen flag */
} XKeyEvent;
typedef XKeyEvent XKeyPressedEvent;
typedef XKeyEvent XKeyReleasedEvent;
typedef struct {
int type; /* MotionNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* ``event'' window reported relative to */
Window root; /* root window that the event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* pointer x, y coordinates in event window */
int x_root, y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
char is_hint; /* detail */
229977
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Bool same_screen; /* same screen flag */
} XMotionEvent;
typedef XMotionEvent XPointerMovedEvent;
││__
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. As long as the conditions previously dis-
cussed are met, this is the window used by the X server to
report the event. The root member is set to the source win-
dow's root window. The x_root and y_root members are set to
the pointer's coordinates relative to the root window's ori-
gin at the time of 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 _T_r_u_e or _F_a_l_s_e. If _T_r_u_e, the event and root windows
are on the same screen. If _F_a_l_s_e, the event and root win-
dows are not on the same screen.
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. Oth-
erwise, the X server sets the subwindow member to _N_o_n_e. The
time member is set to the time when the event was generated
and is expressed in milliseconds.
If the event window is on the same screen as the root win-
dow, the x and y members are set to the coordinates relative
to the event window's origin. Otherwise, these members are
set to zero.
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 but-
ton or modifier key masks: _B_u_t_t_o_n_1_M_a_s_k, _B_u_t_t_o_n_2_M_a_s_k, _B_u_t_-
_t_o_n_3_M_a_s_k, _B_u_t_t_o_n_4_M_a_s_k, _B_u_t_t_o_n_5_M_a_s_k, _S_h_i_f_t_M_a_s_k, _L_o_c_k_M_a_s_k,
_C_o_n_t_r_o_l_M_a_s_k, _M_o_d_1_M_a_s_k, _M_o_d_2_M_a_s_k, _M_o_d_3_M_a_s_k, _M_o_d_4_M_a_s_k, and
_M_o_d_5_M_a_s_k.
Each of these structures also has a member that indicates
the detail. For the _X_K_e_y_P_r_e_s_s_e_d_E_v_e_n_t and _X_K_e_y_R_e_l_e_a_s_e_d_E_v_e_n_t
structures, this member is called a keycode. It is set to a
number that represents a physical key on the keyboard. The
keycode is an arbitrary representation for any key on the
keyboard (see sections 12.7 and 16.1).
For the _X_B_u_t_t_o_n_P_r_e_s_s_e_d_E_v_e_n_t and _X_B_u_t_t_o_n_R_e_l_e_a_s_e_d_E_v_e_n_t struc-
tures, this member is called button. It represents the
pointer button that changed state and can be the _B_u_t_t_o_n_1,
229988
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_B_u_t_t_o_n_2, _B_u_t_t_o_n_3, _B_u_t_t_o_n_4, or _B_u_t_t_o_n_5 value. For the
_X_P_o_i_n_t_e_r_M_o_v_e_d_E_v_e_n_t structure, this member is called is_hint.
It can be set to _N_o_t_i_f_y_N_o_r_m_a_l or _N_o_t_i_f_y_H_i_n_t.
Some of the symbols mentioned in this section have fixed
values, as follows:
-----------------------------------------------------------
SSyymmbbooll VVaalluuee
-----------------------------------------------------------
_B_u_t_t_o_n_1_M_o_t_i_o_n_M_a_s_k (1L<<8)
_B_u_t_t_o_n_2_M_o_t_i_o_n_M_a_s_k (1L<<9)
_B_u_t_t_o_n_3_M_o_t_i_o_n_M_a_s_k (1L<<10)
_B_u_t_t_o_n_4_M_o_t_i_o_n_M_a_s_k (1L<<11)
_B_u_t_t_o_n_5_M_o_t_i_o_n_M_a_s_k (1L<<12)
_B_u_t_t_o_n_1_M_a_s_k (1<<8)
_B_u_t_t_o_n_2_M_a_s_k (1<<9)
_B_u_t_t_o_n_3_M_a_s_k (1<<10)
_B_u_t_t_o_n_4_M_a_s_k (1<<11)
_B_u_t_t_o_n_5_M_a_s_k (1<<12)
_S_h_i_f_t_M_a_s_k (1<<0)
_L_o_c_k_M_a_s_k (1<<1)
_C_o_n_t_r_o_l_M_a_s_k (1<<2)
_M_o_d_1_M_a_s_k (1<<3)
_M_o_d_2_M_a_s_k (1<<4)
_M_o_d_3_M_a_s_k (1<<5)
_M_o_d_4_M_a_s_k (1<<6)
_M_o_d_5_M_a_s_k (1<<7)
_B_u_t_t_o_n_1 1
_B_u_t_t_o_n_2 2
_B_u_t_t_o_n_3 3
_B_u_t_t_o_n_4 4
_B_u_t_t_o_n_5 5
-----------------------------------------------------------
1100..66.. WWiinnddooww EEnnttrryy//EExxiitt EEvveennttss
This section describes the processing that occurs for the
window crossing events _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y. If a
pointer motion or a window hierarchy change causes the
pointer to be in a different window than before, the X
server reports _E_n_t_e_r_N_o_t_i_f_y or _L_e_a_v_e_N_o_t_i_f_y events to clients
who have selected for these events. All _E_n_t_e_r_N_o_t_i_f_y and
_L_e_a_v_e_N_o_t_i_f_y events caused by a hierarchy change are gener-
ated after any hierarchy event (_U_n_m_a_p_N_o_t_i_f_y, _M_a_p_N_o_t_i_f_y, _C_o_n_-
_f_i_g_u_r_e_N_o_t_i_f_y, _G_r_a_v_i_t_y_N_o_t_i_f_y, _C_i_r_c_u_l_a_t_e_N_o_t_i_f_y) caused by that
change; however, the X protocol does not constrain the
ordering of _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events with respect
to _F_o_c_u_s_O_u_t, _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y, and _E_x_p_o_s_e events.
This contrasts with _M_o_t_i_o_n_N_o_t_i_f_y events, which are also gen-
erated when the pointer moves but only when the pointer
motion begins and ends in a single window. An _E_n_t_e_r_N_o_t_i_f_y
229999
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
or _L_e_a_v_e_N_o_t_i_f_y event also can be generated when some client
application calls _X_G_r_a_b_P_o_i_n_t_e_r and _X_U_n_g_r_a_b_P_o_i_n_t_e_r.
To receive _E_n_t_e_r_N_o_t_i_f_y or _L_e_a_v_e_N_o_t_i_f_y events, set the _E_n_t_e_r_-
_W_i_n_d_o_w_M_a_s_k or _L_e_a_v_e_W_i_n_d_o_w_M_a_s_k bits of the event-mask
attribute of the window.
The structure for these event types contains:
__
││
typedef struct {
int type; /* EnterNotify or LeaveNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* ``event'' window reported relative to */
Window root; /* root window that the event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* pointer x, y coordinates in event window */
int x_root, y_root; /* coordinates relative to root */
int mode; /* NotifyNormal, NotifyGrab, NotifyUngrab */
int detail;
/*
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyNonlinear,NotifyNonlinearVirtual
*/
Bool same_screen; /* same screen flag */
Bool focus; /* boolean focus */
unsigned int state; /* key or button mask */
} XCrossingEvent;
typedef XCrossingEvent XEnterWindowEvent;
typedef XCrossingEvent XLeaveWindowEvent;
││__
The window member is set to the window on which the _E_n_t_e_r_-
_N_o_t_i_f_y or _L_e_a_v_e_N_o_t_i_f_y 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 win-
dow on which the event occurred. The root member is set to
the root window of the screen on which the event occurred.
For a _L_e_a_v_e_N_o_t_i_f_y event, if a child of the event window con-
tains the initial position of the pointer, the subwindow
component is set to that child. Otherwise, the X server
sets the subwindow member to _N_o_n_e. For an _E_n_t_e_r_N_o_t_i_f_y
event, if a child of the event window contains the final
pointer position, the subwindow component is set to that
child or _N_o_n_e.
The time member is set to the time when the event was gener-
ated and is expressed in milliseconds. The x and y members
330000
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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.
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.
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 _T_r_u_e or _F_a_l_s_e. If _T_r_u_e, the event and root windows
are on the same screen. If _F_a_l_s_e, the event and root win-
dows are not on the same screen.
The focus member is set to indicate whether the event window
is the focus window or an inferior of the focus window. The
X server can set this member to either _T_r_u_e or _F_a_l_s_e. If
_T_r_u_e, the event window is the focus window or an inferior of
the focus window. If _F_a_l_s_e, 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 or more of the button or modifier key masks: _B_u_t_-
_t_o_n_1_M_a_s_k, _B_u_t_t_o_n_2_M_a_s_k, _B_u_t_t_o_n_3_M_a_s_k, _B_u_t_t_o_n_4_M_a_s_k, _B_u_t_-
_t_o_n_5_M_a_s_k, _S_h_i_f_t_M_a_s_k, _L_o_c_k_M_a_s_k, _C_o_n_t_r_o_l_M_a_s_k, _M_o_d_1_M_a_s_k,
_M_o_d_2_M_a_s_k, _M_o_d_3_M_a_s_k, _M_o_d_4_M_a_s_k, _M_o_d_5_M_a_s_k.
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 _N_o_t_i_f_y_N_o_r_m_a_l, _N_o_t_i_f_y_G_r_a_b, or
_N_o_t_i_f_y_U_n_g_r_a_b.
The detail member is set to indicate the notify detail and
can be _N_o_t_i_f_y_A_n_c_e_s_t_o_r, _N_o_t_i_f_y_V_i_r_t_u_a_l, _N_o_t_i_f_y_I_n_f_e_r_i_o_r, _N_o_t_i_-
_f_y_N_o_n_l_i_n_e_a_r, or _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
1100..66..11.. NNoorrmmaall EEnnttrryy//EExxiitt EEvveennttss
_E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events are generated when the
pointer moves from one window to another window. Normal
events are identified by _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t or _X_L_e_a_v_e_W_i_n_d_o_w_-
_E_v_e_n_t structures whose mode member is set to _N_o_t_i_f_y_N_o_r_m_a_l.
· When the pointer moves from window A to window B and A
is an inferior of B, the X server does the following:
- It generates a _L_e_a_v_e_N_o_t_i_f_y event on window A, with
the detail member of the _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t struc-
ture set to _N_o_t_i_f_y_A_n_c_e_s_t_o_r.
330011
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
- It generates a _L_e_a_v_e_N_o_t_i_f_y event on each window
between window A and window B, exclusive, with the
detail member of each _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structure
set to _N_o_t_i_f_y_V_i_r_t_u_a_l.
- It generates an _E_n_t_e_r_N_o_t_i_f_y event on window B,
with the detail member of the _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t
structure set to _N_o_t_i_f_y_I_n_f_e_r_i_o_r.
· When the pointer moves from window A to window B and B
is an inferior of A, the X server does the following:
- It generates a _L_e_a_v_e_N_o_t_i_f_y event on window A, with
the detail member of the _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t struc-
ture set to _N_o_t_i_f_y_I_n_f_e_r_i_o_r.
- It generates an _E_n_t_e_r_N_o_t_i_f_y event on each window
between window A and window B, exclusive, with the
detail member of each _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t structure
set to _N_o_t_i_f_y_V_i_r_t_u_a_l.
- It generates an _E_n_t_e_r_N_o_t_i_f_y event on window B,
with the detail member of the _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t
structure set to _N_o_t_i_f_y_A_n_c_e_s_t_o_r.
· When the pointer moves from window A to window B and
window C is their least common ancestor, the X server
does the following:
- It generates a _L_e_a_v_e_N_o_t_i_f_y event on window A, with
the detail member of the _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t struc-
ture set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- It generates a _L_e_a_v_e_N_o_t_i_f_y event on each window
between window A and window C, exclusive, with the
detail member of each _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structure
set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates an _E_n_t_e_r_N_o_t_i_f_y event on each window
between window C and window B, exclusive, with the
detail member of each _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t structure
set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates an _E_n_t_e_r_N_o_t_i_f_y event on window B,
with the detail member of the _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t
structure set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
· When the pointer moves from window A to window B on
different screens, the X server does the following:
- It generates a _L_e_a_v_e_N_o_t_i_f_y event on window A, with
the detail member of the _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t struc-
ture set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
330022
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
- If window A is not a root window, it generates a
_L_e_a_v_e_N_o_t_i_f_y event on each window above window A up
to and including its root, with the detail member
of each _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structure set to _N_o_t_i_-
_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- If window B is not a root window, it generates an
_E_n_t_e_r_N_o_t_i_f_y event on each window from window B's
root down to but not including window B, with the
detail member of each _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t structure
set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates an _E_n_t_e_r_N_o_t_i_f_y event on window B,
with the detail member of the _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t
structure set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
1100..66..22.. GGrraabb aanndd UUnnggrraabb EEnnttrryy//EExxiitt EEvveennttss
Pseudo-motion mode _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events are
generated when a pointer grab activates or deactivates.
Events in which the pointer grab activates are identified by
_X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t or _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structures whose mode
member is set to _N_o_t_i_f_y_G_r_a_b. Events in which the pointer
grab deactivates are identified by _X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t or
_X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structures whose mode member is set to
_N_o_t_i_f_y_U_n_g_r_a_b (see _X_G_r_a_b_P_o_i_n_t_e_r).
· When a pointer grab activates after any initial warp
into a confine_to window and before generating any
actual _B_u_t_t_o_n_P_r_e_s_s event that activates the grab, G is
the grab_window for the grab, and P is the window the
pointer is in, the X server does the following:
- It generates _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events
(see section 10.6.1) with the mode members of the
_X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t and _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structures
set to _N_o_t_i_f_y_G_r_a_b. These events are generated as
if the pointer were to suddenly warp from its cur-
rent position in P to some position in G. How-
ever, the pointer does not warp, and the X server
uses the pointer position as both the initial and
final positions for the events.
· When a pointer grab deactivates after generating any
actual _B_u_t_t_o_n_R_e_l_e_a_s_e event that deactivates the grab, G
is the grab_window for the grab, and P is the window
the pointer is in, the X server does the following:
- It generates _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events
(see section 10.6.1) with the mode members of the
_X_E_n_t_e_r_W_i_n_d_o_w_E_v_e_n_t and _X_L_e_a_v_e_W_i_n_d_o_w_E_v_e_n_t structures
set to _N_o_t_i_f_y_U_n_g_r_a_b. These events are generated
as if the pointer were to suddenly warp from some
position in G to its current position in P.
330033
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
However, the pointer does not warp, and the X
server uses the current pointer position as both
the initial and final positions for the events.
1100..77.. IInnppuutt FFooccuuss EEvveennttss
This section describes the processing that occurs for the
input focus events _F_o_c_u_s_I_n and _F_o_c_u_s_O_u_t. The X server can
report _F_o_c_u_s_I_n or _F_o_c_u_s_O_u_t events to clients wanting infor-
mation about when the input focus changes. The keyboard is
always attached to some window (typically, the root window
or a top-level window), which is called the focus window.
The focus window and the position of the pointer determine
the window that receives keyboard input. Clients may need
to know when the input focus changes to control highlighting
of areas on the screen.
To receive _F_o_c_u_s_I_n or _F_o_c_u_s_O_u_t events, set the _F_o_c_u_s_C_h_a_n_g_e_-
_M_a_s_k bit in the event-mask attribute of the window.
The structure for these event types contains:
__
││
typedef struct {
int type; /* FocusIn or FocusOut */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* window of event */
int mode; /* NotifyNormal, NotifyGrab, NotifyUngrab */
int detail;
/*
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyNonlinear,NotifyNonlinearVirtual, NotifyPointer,
* NotifyPointerRoot, NotifyDetailNone
*/
} XFocusChangeEvent;
typedef XFocusChangeEvent XFocusInEvent;
typedef XFocusChangeEvent XFocusOutEvent;
││__
The window member is set to the window on which the _F_o_c_u_s_I_n
or _F_o_c_u_s_O_u_t 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,
focus events while grabbed, focus events when a grab acti-
vates, or focus events when a grab deactivates. The X
server can set the mode member to _N_o_t_i_f_y_N_o_r_m_a_l, _N_o_t_i_f_y_W_h_i_l_e_-
_G_r_a_b_b_e_d, _N_o_t_i_f_y_G_r_a_b, or _N_o_t_i_f_y_U_n_g_r_a_b.
All _F_o_c_u_s_O_u_t events caused by a window unmap are generated
after any _U_n_m_a_p_N_o_t_i_f_y event; however, the X protocol does
330044
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
not constrain the ordering of _F_o_c_u_s_O_u_t events with respect
to generated _E_n_t_e_r_N_o_t_i_f_y, _L_e_a_v_e_N_o_t_i_f_y, _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y, and
_E_x_p_o_s_e events.
Depending on the event mode, the detail member is set to
indicate the notify detail and can be _N_o_t_i_f_y_A_n_c_e_s_t_o_r, _N_o_t_i_-
_f_y_V_i_r_t_u_a_l, _N_o_t_i_f_y_I_n_f_e_r_i_o_r, _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r, _N_o_t_i_f_y_N_o_n_l_i_n_-
_e_a_r_V_i_r_t_u_a_l, _N_o_t_i_f_y_P_o_i_n_t_e_r, _N_o_t_i_f_y_P_o_i_n_t_e_r_R_o_o_t, or _N_o_t_i_f_y_D_e_-
_t_a_i_l_N_o_n_e.
1100..77..11.. NNoorrmmaall FFooccuuss EEvveennttss aanndd FFooccuuss EEvveennttss WWhhiillee GGrraabbbbeedd
Normal focus events are identified by _X_F_o_c_u_s_I_n_E_v_e_n_t or _X_F_o_-
_c_u_s_O_u_t_E_v_e_n_t structures whose mode member is set to _N_o_t_i_-
_f_y_N_o_r_m_a_l. Focus events while grabbed are identified by _X_F_o_-
_c_u_s_I_n_E_v_e_n_t or _X_F_o_c_u_s_O_u_t_E_v_e_n_t structures whose mode member is
set to _N_o_t_i_f_y_W_h_i_l_e_G_r_a_b_b_e_d. The X server processes normal
focus and focus events while grabbed according to the fol-
lowing:
· When the focus moves from window A to window B, A is an
inferior of B, and the pointer is in window P, the X
server does the following:
- It generates a _F_o_c_u_s_O_u_t event on window A, with
the detail member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure
set to _N_o_t_i_f_y_A_n_c_e_s_t_o_r.
- It generates a _F_o_c_u_s_O_u_t event on each window
between window A and window B, exclusive, with the
detail member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set
to _N_o_t_i_f_y_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on window B, with the
detail member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set
to _N_o_t_i_f_y_I_n_f_e_r_i_o_r.
- If window P is an inferior of window B but window
P is not window A or an inferior or ancestor of
window A, it generates a _F_o_c_u_s_I_n event on each
window below window B, down to and including win-
dow P, with the detail member of each _X_F_o_c_u_s_I_n_-
_E_v_e_n_t structure set to _N_o_t_i_f_y_P_o_i_n_t_e_r.
· When the focus moves from window A to window B, B is an
inferior of A, and the pointer is in window P, the X
server does the following:
- If window P is an inferior of window A but P is
not an inferior of window B or an ancestor of B,
it generates a _F_o_c_u_s_O_u_t event on each window from
window P up to but not including window A, with
the detail member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure
set to _N_o_t_i_f_y_P_o_i_n_t_e_r.
330055
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
- It generates a _F_o_c_u_s_O_u_t event on window A, with
the detail member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure
set to _N_o_t_i_f_y_I_n_f_e_r_i_o_r.
- It generates a _F_o_c_u_s_I_n event on each window
between window A and window B, exclusive, with the
detail member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on window B, with the
detail member of the _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_A_n_c_e_s_t_o_r.
· When the focus moves from window A to window B, window
C is their least common ancestor, and the pointer is in
window P, the X server does the following:
- If window P is an inferior of window A, it gener-
ates a _F_o_c_u_s_O_u_t event on each window from window P
up to but not including window A, with the detail
member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
- It generates a _F_o_c_u_s_O_u_t event on window A, with
the detail member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure
set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- It generates a _F_o_c_u_s_O_u_t event on each window
between window A and window C, exclusive, with the
detail member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set
to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on each window
between C and B, exclusive, with the detail member
of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set to _N_o_t_i_f_y_N_o_n_-
_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on window B, with the
detail member of the _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- If window P is an inferior of window B, it gener-
ates a _F_o_c_u_s_I_n event on each window below window B
down to and including window P, with the detail
member of the _X_F_o_c_u_s_I_n_E_v_e_n_t structure set to _N_o_t_i_-
_f_y_P_o_i_n_t_e_r.
· When the focus moves from window A to window B on dif-
ferent screens and the pointer is in window P, the X
server does the following:
- If window P is an inferior of window A, it gener-
ates a _F_o_c_u_s_O_u_t event on each window from window P
up to but not including window A, with the detail
330066
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
- It generates a _F_o_c_u_s_O_u_t event on window A, with
the detail member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure
set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- If window A is not a root window, it generates a
_F_o_c_u_s_O_u_t event on each window above window A up to
and including its root, with the detail member of
each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to _N_o_t_i_f_y_N_o_n_l_i_n_-
_e_a_r_V_i_r_t_u_a_l.
- If window B is not a root window, it generates a
_F_o_c_u_s_I_n event on each window from window B's root
down to but not including window B, with the
detail member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on window B, with the
detail member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- If window P is an inferior of window B, it gener-
ates a _F_o_c_u_s_I_n event on each window below window B
down to and including window P, with the detail
member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
· When the focus moves from window A to _P_o_i_n_t_e_r_R_o_o_t
(events sent to the window under the pointer) or _N_o_n_e
(discard), and the pointer is in window P, the X server
does the following:
- If window P is an inferior of window A, it gener-
ates a _F_o_c_u_s_O_u_t event on each window from window P
up to but not including window A, with the detail
member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
- It generates a _F_o_c_u_s_O_u_t event on window A, with
the detail member of the _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure
set to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- If window A is not a root window, it generates a
_F_o_c_u_s_O_u_t event on each window above window A up to
and including its root, with the detail member of
each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to _N_o_t_i_f_y_N_o_n_l_i_n_-
_e_a_r_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on the root window of
all screens, with the detail member of each _X_F_o_-
_c_u_s_I_n_E_v_e_n_t structure set to _N_o_t_i_f_y_P_o_i_n_t_e_r_R_o_o_t (or
_N_o_t_i_f_y_D_e_t_a_i_l_N_o_n_e).
330077
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
- If the new focus is _P_o_i_n_t_e_r_R_o_o_t, it generates a
_F_o_c_u_s_I_n event on each window from window P's root
down to and including window P, with the detail
member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
· When the focus moves from _P_o_i_n_t_e_r_R_o_o_t (events sent to
the window under the pointer) or _N_o_n_e to window A, and
the pointer is in window P, the X server does the fol-
lowing:
- If the old focus is _P_o_i_n_t_e_r_R_o_o_t, it generates a
_F_o_c_u_s_O_u_t event on each window from window P up to
and including window P's root, with the detail
member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
- It generates a _F_o_c_u_s_O_u_t event on all root windows,
with the detail member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t
structure set to _N_o_t_i_f_y_P_o_i_n_t_e_r_R_o_o_t (or _N_o_t_i_f_y_D_e_-
_t_a_i_l_N_o_n_e).
- If window A is not a root window, it generates a
_F_o_c_u_s_I_n event on each window from window A's root
down to but not including window A, with the
detail member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r_V_i_r_t_u_a_l.
- It generates a _F_o_c_u_s_I_n event on window A, with the
detail member of the _X_F_o_c_u_s_I_n_E_v_e_n_t structure set
to _N_o_t_i_f_y_N_o_n_l_i_n_e_a_r.
- If window P is an inferior of window A, it gener-
ates a _F_o_c_u_s_I_n event on each window below window A
down to and including window P, with the detail
member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
· When the focus moves from _P_o_i_n_t_e_r_R_o_o_t (events sent to
the window under the pointer) to _N_o_n_e (or vice versa),
and the pointer is in window P, the X server does the
following:
- If the old focus is _P_o_i_n_t_e_r_R_o_o_t, it generates a
_F_o_c_u_s_O_u_t event on each window from window P up to
and including window P's root, with the detail
member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
- It generates a _F_o_c_u_s_O_u_t event on all root windows,
with the detail member of each _X_F_o_c_u_s_O_u_t_E_v_e_n_t
structure set to either _N_o_t_i_f_y_P_o_i_n_t_e_r_R_o_o_t or _N_o_t_i_-
_f_y_D_e_t_a_i_l_N_o_n_e.
330088
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
- It generates a _F_o_c_u_s_I_n event on all root windows,
with the detail member of each _X_F_o_c_u_s_I_n_E_v_e_n_t
structure set to _N_o_t_i_f_y_D_e_t_a_i_l_N_o_n_e or _N_o_t_i_f_y_P_o_i_n_t_-
_e_r_R_o_o_t.
- If the new focus is _P_o_i_n_t_e_r_R_o_o_t, it generates a
_F_o_c_u_s_I_n event on each window from window P's root
down to and including window P, with the detail
member of each _X_F_o_c_u_s_I_n_E_v_e_n_t structure set to
_N_o_t_i_f_y_P_o_i_n_t_e_r.
1100..77..22.. FFooccuuss EEvveennttss GGeenneerraatteedd bbyy GGrraabbss
Focus events in which the keyboard grab activates are iden-
tified by _X_F_o_c_u_s_I_n_E_v_e_n_t or _X_F_o_c_u_s_O_u_t_E_v_e_n_t structures whose
mode member is set to _N_o_t_i_f_y_G_r_a_b. Focus events in which the
keyboard grab deactivates are identified by _X_F_o_c_u_s_I_n_E_v_e_n_t or
_X_F_o_c_u_s_O_u_t_E_v_e_n_t structures whose mode member is set to _N_o_t_i_-
_f_y_U_n_g_r_a_b (see _X_G_r_a_b_K_e_y_b_o_a_r_d).
· When a keyboard grab activates before generating any
actual _K_e_y_P_r_e_s_s event that activates the grab, G is the
grab_window, and F is the current focus, the X server
does the following:
- It generates _F_o_c_u_s_I_n and _F_o_c_u_s_O_u_t events, with the
mode members of the _X_F_o_c_u_s_I_n_E_v_e_n_t and _X_F_o_c_u_-
_s_O_u_t_E_v_e_n_t structures set to _N_o_t_i_f_y_G_r_a_b. These
events are generated as if the focus were to
change from F to G.
· When a keyboard grab deactivates after generating any
actual _K_e_y_R_e_l_e_a_s_e event that deactivates the grab, G is
the grab_window, and F is the current focus, the X
server does the following:
- It generates _F_o_c_u_s_I_n and _F_o_c_u_s_O_u_t events, with the
mode members of the _X_F_o_c_u_s_I_n_E_v_e_n_t and _X_F_o_c_u_-
_s_O_u_t_E_v_e_n_t structures set to _N_o_t_i_f_y_U_n_g_r_a_b. These
events are generated as if the focus were to
change from G to F.
1100..88.. KKeeyy MMaapp SSttaattee NNoottiiffiiccaattiioonn EEvveennttss
The X server can report _K_e_y_m_a_p_N_o_t_i_f_y events to clients that
want information about changes in their keyboard state.
To receive _K_e_y_m_a_p_N_o_t_i_f_y events, set the _K_e_y_m_a_p_S_t_a_t_e_M_a_s_k bit
in the event-mask attribute of the window. The X server
generates this event immediately after every _E_n_t_e_r_N_o_t_i_f_y and
_F_o_c_u_s_I_n event.
The structure for this event type contains:
330099
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
/* generated on EnterWindow and FocusIn when KeymapState selected */
typedef struct {
int type; /* KeymapNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
char key_vector[32];
} XKeymapEvent;
││__
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 corre-
sponding key is currently pressed. The vector is repre-
sented 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.
1100..99.. EExxppoossuurree EEvveennttss
The X protocol does not guarantee to preserve the contents
of window regions when the windows are obscured or reconfig-
ured. Some implementations may preserve the contents of
windows. Other implementations are free to destroy the con-
tents of windows when exposed. X expects client applica-
tions to assume the responsibility for restoring the con-
tents of an exposed window region. (An exposed window
region describes a formerly obscured window whose region
becomes visible.) Therefore, the X server sends _E_x_p_o_s_e
events describing the window and the region of the window
that has been exposed. A naive client application usually
redraws the entire window. A more sophisticated client
application redraws only the exposed region.
1100..99..11.. EExxppoossee EEvveennttss
The X server can report _E_x_p_o_s_e events to clients wanting
information about when the contents of window regions have
been lost. The circumstances in which the X server gener-
ates _E_x_p_o_s_e events are not as definite as those for other
events. However, the X server never generates _E_x_p_o_s_e events
on windows whose class you specified as _I_n_p_u_t_O_n_l_y. The X
server can generate _E_x_p_o_s_e events when no valid contents are
available for regions of a window and either the regions are
visible, the regions are viewable and the server is (perhaps
newly) maintaining backing store on the window, or the win-
dow is not viewable but the server is (perhaps newly) honor-
ing the window's backing-store attribute of _A_l_w_a_y_s or _W_h_e_n_-
_M_a_p_p_e_d. The regions decompose into an (arbitrary) set of
rectangles, and an _E_x_p_o_s_e event is generated for each rect-
angle. For any given window, the X server guarantees to
331100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
report contiguously all of the regions exposed by some
action that causes _E_x_p_o_s_e events, such as raising a window.
To receive _E_x_p_o_s_e events, set the _E_x_p_o_s_u_r_e_M_a_s_k bit in the
event-mask attribute of the window.
The structure for this event type contains:
__
││
typedef struct {
int type; /* Expose */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
int x, y;
int width, height;
int count; /* if nonzero, at least this many more */
} XExposeEvent;
││__
The window member is set to the exposed (damaged) window.
The x and y members are set to the coordinates relative to
the window'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. The count member is set to
the number of _E_x_p_o_s_e events that are to follow. If count is
zero, no more _E_x_p_o_s_e events follow for this window. How-
ever, if count is nonzero, at least that number of _E_x_p_o_s_e
events (and possibly more) follow for this window. Simple
applications that do not want to optimize redisplay by dis-
tinguishing between subareas of its window can just ignore
all _E_x_p_o_s_e events with nonzero counts and perform full
redisplays on events with zero counts.
1100..99..22.. GGrraapphhiiccssEExxppoossee aanndd NNooEExxppoossee EEvveennttss
The X server can report _G_r_a_p_h_i_c_s_E_x_p_o_s_e events to clients
wanting information about when a destination region could
not be computed during certain graphics requests: _X_C_o_p_y_A_r_e_a
or _X_C_o_p_y_P_l_a_n_e. The X server generates this event whenever a
destination region could not be computed because of an
obscured or out-of-bounds source region. In addition, the X
server guarantees to report contiguously all of the regions
exposed by some graphics request (for example, copying an
area of a drawable to a destination drawable).
The X server generates a _N_o_E_x_p_o_s_e event whenever a graphics
request that might produce a _G_r_a_p_h_i_c_s_E_x_p_o_s_e event does not
produce any. In other words, the client is really asking
for a _G_r_a_p_h_i_c_s_E_x_p_o_s_e event but instead receives a _N_o_E_x_p_o_s_e
event.
331111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To receive _G_r_a_p_h_i_c_s_E_x_p_o_s_e or _N_o_E_x_p_o_s_e events, you must first
set the graphics-exposure attribute of the graphics context
to _T_r_u_e. You also can set the graphics-expose attribute
when creating a graphics context using _X_C_r_e_a_t_e_G_C or by call-
ing _X_S_e_t_G_r_a_p_h_i_c_s_E_x_p_o_s_u_r_e_s.
The structures for these event types contain:
__
││
typedef struct {
int type; /* GraphicsExpose */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Drawable drawable;
int x, y;
int width, height;
int count; /* if nonzero, at least this many more */
int major_code; /* core is CopyArea or CopyPlane */
int minor_code; /* not defined in the core */
} XGraphicsExposeEvent;
typedef struct {
int type; /* NoExpose */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Drawable drawable;
int major_code; /* core is CopyArea or CopyPlane */
int minor_code; /* not defined in the core */
} XNoExposeEvent;
││__
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 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 _X___C_o_p_y_A_r_e_a or _X___C_o_p_y_P_l_a_n_e. If it is _X___C_o_p_y_A_r_e_a, a
call to _X_C_o_p_y_A_r_e_a initiated the request. If it is _X___C_o_p_y_-
_P_l_a_n_e, a call to _X_C_o_p_y_P_l_a_n_e initiated the request. These
constants are defined in <_X_1_1_/_X_p_r_o_t_o_._h>. The minor_code
member, like the major_code member, indicates which graphics
request was initiated by the client. However, the
minor_code member is not defined by the core X protocol and
will be zero in these cases, although it may be used by an
extension.
The _X_G_r_a_p_h_i_c_s_E_x_p_o_s_e_E_v_e_n_t structure has these additional mem-
bers: x, y, width, height, and count. The x and y members
331122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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. The count member is set to the number of _G_r_a_p_h_-
_i_c_s_E_x_p_o_s_e events to follow. If count is zero, no more
_G_r_a_p_h_i_c_s_E_x_p_o_s_e events follow for this window. However, if
count is nonzero, at least that number of _G_r_a_p_h_i_c_s_E_x_p_o_s_e
events (and possibly more) are to follow for this window.
1100..1100.. WWiinnddooww SSttaattee CChhaannggee EEvveennttss
The following sections discuss:
· _C_i_r_c_u_l_a_t_e_N_o_t_i_f_y events
· _C_o_n_f_i_g_u_r_e_N_o_t_i_f_y events
· _C_r_e_a_t_e_N_o_t_i_f_y events
· _D_e_s_t_r_o_y_N_o_t_i_f_y events
· _G_r_a_v_i_t_y_N_o_t_i_f_y events
· _M_a_p_N_o_t_i_f_y events
· _M_a_p_p_i_n_g_N_o_t_i_f_y events
· _R_e_p_a_r_e_n_t_N_o_t_i_f_y events
· _U_n_m_a_p_N_o_t_i_f_y events
· _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y events
1100..1100..11.. CCiirrccuullaatteeNNoottiiffyy EEvveennttss
The X server can report _C_i_r_c_u_l_a_t_e_N_o_t_i_f_y events to clients
wanting information about when a window changes its position
in the stack. The X server generates this event type when-
ever a window is actually restacked as a result of a client
application calling _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s, _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_-
_d_o_w_s_U_p, or _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_D_o_w_n.
To receive _C_i_r_c_u_l_a_t_e_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_-
_M_a_s_k bit in the event-mask attribute of the window or the
_S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of
the parent window (in which case, circulating any child gen-
erates an event).
The structure for this event type contains:
331133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int type; /* CirculateNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
int place; /* PlaceOnTop, PlaceOnBottom */
} XCirculateEvent;
││__
The event member is set either to the restacked window or to
its parent, depending on whether _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y or _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y was selected. The window member is set to
the window that was restacked. The place member is set to
the window's position after the restack occurs and is either
_P_l_a_c_e_O_n_T_o_p or _P_l_a_c_e_O_n_B_o_t_t_o_m. If it is _P_l_a_c_e_O_n_T_o_p, the win-
dow is now on top of all siblings. If it is _P_l_a_c_e_O_n_B_o_t_t_o_m,
the window is now below all siblings.
1100..1100..22.. CCoonnffiigguurreeNNoottiiffyy EEvveennttss
The X server can report _C_o_n_f_i_g_u_r_e_N_o_t_i_f_y events to clients
wanting information about actual changes to a window's
state, such as size, position, border, and stacking order.
The X server generates this event type whenever one of the
following configure window requests made by a client appli-
cation actually completes:
· A window's size, position, border, and/or stacking
order is reconfigured by calling _X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w.
· The window's position in the stacking order is changed
by calling _X_L_o_w_e_r_W_i_n_d_o_w, _X_R_a_i_s_e_W_i_n_d_o_w, or _X_R_e_s_t_a_c_k_W_i_n_-
_d_o_w_s.
· A window is moved by calling _X_M_o_v_e_W_i_n_d_o_w.
· A window's size is changed by calling _X_R_e_s_i_z_e_W_i_n_d_o_w.
· A window's size and location is changed by calling
_X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w.
· A window is mapped and its position in the stacking
order is changed by calling _X_M_a_p_R_a_i_s_e_d.
· A window's border width is changed by calling _X_S_e_t_W_i_n_-
_d_o_w_B_o_r_d_e_r_W_i_d_t_h.
To receive _C_o_n_f_i_g_u_r_e_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_-
_M_a_s_k bit in the event-mask attribute of the window or the
_S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of
331144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the parent window (in which case, configuring any child gen-
erates an event).
The structure for this event type contains:
__
││
typedef struct {
int type; /* ConfigureNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
int x, y;
int width, height;
int border_width;
Window above;
Bool override_redirect;
} XConfigureEvent;
││__
The event member is set either to the reconfigured window or
to its parent, depending on whether _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y or _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y was selected. The window member is set to
the window whose size, position, border, and/or stacking
order was changed.
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, not
including the border. The border_width member is set to the
width of the window's border, in pixels.
The above member is set to the sibling window and is used
for stacking operations. If the X server sets this member
to _N_o_n_e, 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, the window whose
state was changed is placed on top of this sibling window.
The override_redirect member is set to the override-redirect
attribute of the window. Window manager clients normally
should ignore this window if the override_redirect member is
_T_r_u_e.
1100..1100..33.. CCrreeaatteeNNoottiiffyy EEvveennttss
The X server can report _C_r_e_a_t_e_N_o_t_i_f_y events to clients want-
ing information about creation of windows. The X server
generates this event whenever a client application creates a
window by calling _X_C_r_e_a_t_e_W_i_n_d_o_w or _X_C_r_e_a_t_e_S_i_m_p_l_e_W_i_n_d_o_w.
331155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To receive _C_r_e_a_t_e_N_o_t_i_f_y events, set the _S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_-
_M_a_s_k bit in the event-mask attribute of the window. Creat-
ing any children then generates an event.
The structure for the event type contains:
__
││
typedef struct {
int type; /* CreateNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window parent; /* parent of the window */
Window window; /* window id of window created */
int x, y; /* window location */
int width, height; /* size of window */
int border_width; /* border width */
Bool override_redirect; /* creation should be overridden */
} XCreateWindowEvent;
││__
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 outside corner 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 win-
dow. Window manager clients normally should ignore this
window if the override_redirect member is _T_r_u_e.
1100..1100..44.. DDeessttrrooyyNNoottiiffyy EEvveennttss
The X server can report _D_e_s_t_r_o_y_N_o_t_i_f_y events to clients
wanting information about which windows are destroyed. The
X server generates this event whenever a client application
destroys a window by calling _X_D_e_s_t_r_o_y_W_i_n_d_o_w or _X_D_e_s_t_r_o_y_S_u_b_-
_w_i_n_d_o_w_s.
The ordering of the _D_e_s_t_r_o_y_N_o_t_i_f_y events is such that for
any given window, _D_e_s_t_r_o_y_N_o_t_i_f_y is generated on all inferi-
ors of the window before being generated on the window
itself. The X protocol does not constrain the ordering
among siblings and across subhierarchies.
To receive _D_e_s_t_r_o_y_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k
bit in the event-mask attribute of the window or the _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of the
parent window (in which case, destroying any child generates
331166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
an event).
The structure for this event type contains:
__
││
typedef struct {
int type; /* DestroyNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
} XDestroyWindowEvent;
││__
The event member is set either to the destroyed window or to
its parent, depending on whether _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y or _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y was selected. The window member is set to
the window that is destroyed.
1100..1100..55.. GGrraavviittyyNNoottiiffyy EEvveennttss
The X server can report _G_r_a_v_i_t_y_N_o_t_i_f_y events to clients
wanting information about when a window is moved because of
a change in the size of its parent. The X server generates
this event whenever a client application actually moves a
child window as a result of resizing its parent by calling
_X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w, _X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w, or _X_R_e_s_i_z_e_W_i_n_d_o_w.
To receive _G_r_a_v_i_t_y_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k
bit in the event-mask attribute of the window or the _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of the
parent window (in which case, any child that is moved
because its parent has been resized generates an event).
The structure for this event type contains:
__
││
typedef struct {
int type; /* GravityNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
int x, y;
} XGravityEvent;
││__
The event member is set either to the window that was moved
331177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
or to its parent, depending on whether _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y or
_S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y 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 new parent window's
origin and indicate the position of the upper-left outside
corner of the window.
1100..1100..66.. MMaappNNoottiiffyy EEvveennttss
The X server can report _M_a_p_N_o_t_i_f_y events to clients wanting
information about which windows are mapped. The X server
generates this event type whenever a client application
changes the window's state from unmapped to mapped by call-
ing _X_M_a_p_W_i_n_d_o_w, _X_M_a_p_R_a_i_s_e_d, _X_M_a_p_S_u_b_w_i_n_d_o_w_s, _X_R_e_p_a_r_e_n_t_W_i_n_d_o_w,
or as a result of save-set processing.
To receive _M_a_p_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit
in the event-mask attribute of the window or the _S_u_b_s_t_r_u_c_-
_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of the parent
window (in which case, mapping any child generates an
event).
The structure for this event type contains:
__
││
typedef struct {
int type; /* MapNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
Bool override_redirect; /* boolean, is override set... */
} XMapEvent;
││__
The event member is set either to the window that was mapped
or to its parent, depending on whether _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y or
_S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y 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 if
the override-redirect attribute is _T_r_u_e, because these
events usually are generated from pop-ups, which override
structure control.
1100..1100..77.. MMaappppiinnggNNoottiiffyy EEvveennttss
The X server reports _M_a_p_p_i_n_g_N_o_t_i_f_y events to all clients.
There is no mechanism to express disinterest in this event.
The X server generates this event type whenever a client
application successfully calls:
331188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· _X_S_e_t_M_o_d_i_f_i_e_r_M_a_p_p_i_n_g to indicate which KeyCodes are to
be used as modifiers
· _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g to change the keyboard mapping
· _X_S_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g to set the pointer mapping
The structure for this event type contains:
__
││
typedef struct {
int type; /* MappingNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* unused */
int request; /* one of MappingModifier, MappingKeyboard,
MappingPointer */
int first_keycode; /* first keycode */
int count; /* defines range of change w. first_keycode*/
} XMappingEvent;
││__
The request member is set to indicate the kind of mapping
change that occurred and can be _M_a_p_p_i_n_g_M_o_d_i_f_i_e_r, _M_a_p_p_i_n_g_K_e_y_-
_b_o_a_r_d, or _M_a_p_p_i_n_g_P_o_i_n_t_e_r. If it is _M_a_p_p_i_n_g_M_o_d_i_f_i_e_r, the
modifier mapping was changed. If it is _M_a_p_p_i_n_g_K_e_y_b_o_a_r_d, the
keyboard mapping was changed. If it is _M_a_p_p_i_n_g_P_o_i_n_t_e_r, the
pointer button mapping was changed. The first_keycode and
count members are set only if the request member was set to
_M_a_p_p_i_n_g_K_e_y_b_o_a_r_d. The number in first_keycode represents the
first number in the range of the altered mapping, and count
represents the number of keycodes altered.
To update the client application's knowledge of the key-
board, you should call _X_R_e_f_r_e_s_h_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g.
1100..1100..88.. RReeppaarreennttNNoottiiffyy EEvveennttss
The X server can report _R_e_p_a_r_e_n_t_N_o_t_i_f_y events to clients
wanting information about changing a window's parent. The X
server generates this event whenever a client application
calls _X_R_e_p_a_r_e_n_t_W_i_n_d_o_w and the window is actually reparented.
To receive _R_e_p_a_r_e_n_t_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_-
_M_a_s_k bit in the event-mask attribute of the window or the
_S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of
either the old or the new parent window (in which case,
reparenting any child generates an event).
The structure for this event type contains:
331199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int type; /* ReparentNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
Window parent;
int x, y;
Bool override_redirect;
} XReparentEvent;
││__
The event member is set either to the reparented window or
to the old or the new parent, depending on whether _S_t_r_u_c_-
_t_u_r_e_N_o_t_i_f_y or _S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y was selected. The window
member is set to the window that was reparented. The parent
member is set to the new parent window. The x and y members
are set to the reparented window's coordinates relative to
the new parent window's origin and define the upper-left
outer corner of the reparented window. The override_redi-
rect member is set to the override-redirect attribute of the
window specified by the window member. Window manager
clients normally should ignore this window if the over-
ride_redirect member is _T_r_u_e.
1100..1100..99.. UUnnmmaappNNoottiiffyy EEvveennttss
The X server can report _U_n_m_a_p_N_o_t_i_f_y events to clients want-
ing information about which windows are unmapped. The X
server generates this event type whenever a client applica-
tion changes the window's state from mapped to unmapped.
To receive _U_n_m_a_p_N_o_t_i_f_y events, set the _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k
bit in the event-mask attribute of the window or the _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k bit in the event-mask attribute of the
parent window (in which case, unmapping any child window
generates an event).
The structure for this event type contains:
332200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int type; /* UnmapNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window event;
Window window;
Bool from_configure;
} XUnmapEvent;
││__
The event member is set either to the unmapped window or to
its parent, depending on whether _S_t_r_u_c_t_u_r_e_N_o_t_i_f_y or _S_u_b_-
_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y was selected. This is the window used by
the X server to report the event. The window member is set
to the window that was unmapped. The from_configure member
is set to _T_r_u_e if the event was generated as a result of a
resizing of the window's parent when the window itself had a
win_gravity of _U_n_m_a_p_G_r_a_v_i_t_y.
1100..1100..1100.. VViissiibbiilliittyyNNoottiiffyy EEvveennttss
The X server can report _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y events to clients
wanting any change in the visibility of the specified win-
dow. A region of a window is visible if someone looking at
the screen can actually see it. The X server generates this
event whenever the visibility changes state. However, this
event is never generated for windows whose class is _I_n_p_u_-
_t_O_n_l_y.
All _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y events caused by a hierarchy change are
generated after any hierarchy event (_U_n_m_a_p_N_o_t_i_f_y, _M_a_p_N_o_t_i_f_y,
_C_o_n_f_i_g_u_r_e_N_o_t_i_f_y, _G_r_a_v_i_t_y_N_o_t_i_f_y, _C_i_r_c_u_l_a_t_e_N_o_t_i_f_y) caused by
that change. Any _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y event on a given window
is generated before any _E_x_p_o_s_e events on that window, but it
is not required that all _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y events on all win-
dows be generated before all _E_x_p_o_s_e events on all windows.
The X protocol does not constrain the ordering of _V_i_s_i_b_i_l_i_-
_t_y_N_o_t_i_f_y events with respect to _F_o_c_u_s_O_u_t, _E_n_t_e_r_N_o_t_i_f_y, and
_L_e_a_v_e_N_o_t_i_f_y events.
To receive _V_i_s_i_b_i_l_i_t_y_N_o_t_i_f_y events, set the _V_i_s_i_b_i_l_i_t_y_-
_C_h_a_n_g_e_M_a_s_k bit in the event-mask attribute of the window.
The structure for this event type contains:
332211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int type; /* VisibilityNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
int state;
} XVisibilityEvent;
││__
The window member is set to the window whose visibility
state changes. The state member is set to the state of the
window's visibility and can be _V_i_s_i_b_i_l_i_t_y_U_n_o_b_s_c_u_r_e_d, _V_i_s_i_-
_b_i_l_i_t_y_P_a_r_t_i_a_l_l_y_O_b_s_c_u_r_e_d, or _V_i_s_i_b_i_l_i_t_y_F_u_l_l_y_O_b_s_c_u_r_e_d. The X
server ignores all of a window's subwindows when determining
the visibility state of the window and processes _V_i_s_i_b_i_l_i_-
_t_y_N_o_t_i_f_y events according to the following:
· When the window changes state from partially obscured,
fully obscured, or not viewable to viewable and com-
pletely unobscured, the X server generates the event
with the state member of the _X_V_i_s_i_b_i_l_i_t_y_E_v_e_n_t structure
set to _V_i_s_i_b_i_l_i_t_y_U_n_o_b_s_c_u_r_e_d.
· When the window changes state from viewable and com-
pletely unobscured or not viewable to viewable and par-
tially obscured, the X server generates the event with
the state member of the _X_V_i_s_i_b_i_l_i_t_y_E_v_e_n_t structure set
to _V_i_s_i_b_i_l_i_t_y_P_a_r_t_i_a_l_l_y_O_b_s_c_u_r_e_d.
· When the window changes state from viewable and com-
pletely unobscured, viewable and partially obscured, or
not viewable to viewable and fully obscured, the X
server generates the event with the state member of the
_X_V_i_s_i_b_i_l_i_t_y_E_v_e_n_t structure set to _V_i_s_i_b_i_l_i_t_y_F_u_l_l_y_O_b_-
_s_c_u_r_e_d.
1100..1111.. SSttrruuccttuurree CCoonnttrrooll EEvveennttss
This section discusses:
· _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t events
· _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t events
· _M_a_p_R_e_q_u_e_s_t events
· _R_e_s_i_z_e_R_e_q_u_e_s_t events
332222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1100..1111..11.. CCiirrccuullaatteeRReeqquueesstt EEvveennttss
The X server can report _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t events to clients
wanting information about when another client initiates a
circulate window request on a specified window. The X
server generates this event type whenever a client initiates
a circulate window request on a window and a subwindow actu-
ally needs to be restacked. The client initiates a circu-
late window request on the window by calling _X_C_i_r_c_u_l_a_t_e_S_u_b_-
_w_i_n_d_o_w_s, _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_U_p, or _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_-
_D_o_w_n.
To receive _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t events, set the _S_u_b_s_t_r_u_c_t_u_r_-
_e_R_e_d_i_r_e_c_t_M_a_s_k in the event-mask attribute of the window.
Then, in the future, the circulate window request for the
specified window is not executed, and thus, any subwindow's
position in the stack is not changed. For example, suppose
a client application calls _X_C_i_r_c_u_l_a_t_e_S_u_b_w_i_n_d_o_w_s_U_p to raise a
subwindow to the top of the stack. If you had selected _S_u_b_-
_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on the window, the X server reports to
you a _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t event and does not raise the subwin-
dow to the top of the stack.
The structure for this event type contains:
__
││
typedef struct {
int type; /* CirculateRequest */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window parent;
Window window;
int place; /* PlaceOnTop, PlaceOnBottom */
} XCirculateRequestEvent;
││__
The parent member is set to the parent window. The window
member is set to the subwindow to be restacked. The place
member is set to what the new position in the stacking order
should be and is either _P_l_a_c_e_O_n_T_o_p or _P_l_a_c_e_O_n_B_o_t_t_o_m. If it
is _P_l_a_c_e_O_n_T_o_p, the subwindow should be on top of all sib-
lings. If it is _P_l_a_c_e_O_n_B_o_t_t_o_m, the subwindow should be
below all siblings.
1100..1111..22.. CCoonnffiigguurreeRReeqquueesstt EEvveennttss
The X server can report _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t events to clients
wanting information about when a different client initiates
a configure window request on any child of a specified win-
dow. The configure window request attempts to reconfigure a
window's size, position, border, and stacking order. The X
332233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
server generates this event whenever a different client ini-
tiates a configure window request on a window by calling
_X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w, _X_L_o_w_e_r_W_i_n_d_o_w, _X_R_a_i_s_e_W_i_n_d_o_w, _X_M_a_p_R_a_i_s_e_d,
_X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w, _X_M_o_v_e_W_i_n_d_o_w, _X_R_e_s_i_z_e_W_i_n_d_o_w, _X_R_e_s_t_a_c_k_W_i_n_-
_d_o_w_s, or _X_S_e_t_W_i_n_d_o_w_B_o_r_d_e_r_W_i_d_t_h.
To receive _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t events, set the _S_u_b_s_t_r_u_c_t_u_r_-
_e_R_e_d_i_r_e_c_t_M_a_s_k bit in the event-mask attribute of the window.
_C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t events are generated when a _C_o_n_f_i_g_u_r_e_W_i_n_d_o_w
protocol request is issued on a child window by another
client. For example, suppose a client application calls
_X_L_o_w_e_r_W_i_n_d_o_w to lower a window. If you had selected _S_u_b_-
_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on the parent window and if the over-
ride-redirect attribute of the window is set to _F_a_l_s_e, the X
server reports a _C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t event to you and does not
lower the specified window.
The structure for this event type contains:
__
││
typedef struct {
int type; /* ConfigureRequest */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window parent;
Window window;
int x, y;
int width, height;
int border_width;
Window above;
int detail; /* Above, Below, TopIf, BottomIf, Opposite */
unsigned long value_mask;
} XConfigureRequestEvent;
││__
The parent member is set to the parent window. 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 _C_o_n_f_i_g_u_r_e_W_i_n_d_o_w protocol request. The corresponding
values are reported as given in the request. The remaining
values are filled in from the current geometry of the win-
dow, except in the case of above (sibling) and detail
(stack-mode), which are reported as _N_o_n_e and _A_b_o_v_e, respec-
tively, if they are not given in the request.
1100..1111..33.. MMaappRReeqquueesstt EEvveennttss
The X server can report _M_a_p_R_e_q_u_e_s_t events to clients wanting
information about a different client's desire to map win-
dows. A window is considered mapped when a map window
332244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
request completes. The X server generates this event when-
ever a different client initiates a map window request on an
unmapped window whose override_redirect member is set to
_F_a_l_s_e. Clients initiate map window requests by calling
_X_M_a_p_W_i_n_d_o_w, _X_M_a_p_R_a_i_s_e_d, or _X_M_a_p_S_u_b_w_i_n_d_o_w_s.
To receive _M_a_p_R_e_q_u_e_s_t events, set the _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_-
_M_a_s_k bit in the event-mask attribute of the window. This
means another client's attempts to map a child window by
calling one of the map window request functions is inter-
cepted, and you are sent a _M_a_p_R_e_q_u_e_s_t instead. For example,
suppose a client application calls _X_M_a_p_W_i_n_d_o_w to map a win-
dow. If you (usually a window manager) had selected _S_u_b_-
_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k on the parent window and if the over-
ride-redirect attribute of the window is set to _F_a_l_s_e, the X
server reports a _M_a_p_R_e_q_u_e_s_t event to you and does not map
the specified window. Thus, this event gives your window
manager client the ability to control the placement of sub-
windows.
The structure for this event type contains:
__
││
typedef struct {
int type; /* MapRequest */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window parent;
Window window;
} XMapRequestEvent;
││__
The parent member is set to the parent window. The window
member is set to the window to be mapped.
1100..1111..44.. RReessiizzeeRReeqquueesstt EEvveennttss
The X server can report _R_e_s_i_z_e_R_e_q_u_e_s_t events to clients
wanting information about another client's attempts to
change the size of a window. The X server generates this
event whenever some other client attempts to change the size
of the specified window by calling _X_C_o_n_f_i_g_u_r_e_W_i_n_d_o_w, _X_R_e_-
_s_i_z_e_W_i_n_d_o_w, or _X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w.
To receive _R_e_s_i_z_e_R_e_q_u_e_s_t events, set the _R_e_s_i_z_e_R_e_d_i_r_e_c_t bit
in the event-mask attribute of the window. Any attempts to
change the size by other clients are then redirected.
The structure for this event type contains:
332255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int type; /* ResizeRequest */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
int width, height;
} XResizeRequestEvent;
││__
The window member is set to the window whose size another
client attempted to change. The width and height members
are set to the inside size of the window, excluding the bor-
der.
1100..1122.. CCoolloorrmmaapp SSttaattee CChhaannggee EEvveennttss
The X server can report _C_o_l_o_r_m_a_p_N_o_t_i_f_y events to clients
wanting information about when the colormap changes and when
a colormap is installed or uninstalled. The X server gener-
ates this event type whenever a client application:
· Changes the colormap member of the _X_S_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s
structure by calling _X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s, _X_F_r_e_e_C_o_l_-
_o_r_m_a_p, or _X_S_e_t_W_i_n_d_o_w_C_o_l_o_r_m_a_p
· Installs or uninstalls the colormap by calling _X_I_n_-
_s_t_a_l_l_C_o_l_o_r_m_a_p or _X_U_n_i_n_s_t_a_l_l_C_o_l_o_r_m_a_p
To receive _C_o_l_o_r_m_a_p_N_o_t_i_f_y events, set the _C_o_l_o_r_m_a_p_C_h_a_n_g_e_M_a_s_k
bit in the event-mask attribute of the window.
The structure for this event type contains:
__
││
typedef struct {
int type; /* ColormapNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
Colormap colormap; /* colormap or None */
Bool new;
int state; /* ColormapInstalled, ColormapUninstalled */
} XColormapEvent;
││__
The window member is set to the window whose associated col-
ormap is changed, installed, or uninstalled. For a colormap
that is changed, installed, or uninstalled, the colormap
332266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
member is set to the colormap associated with the window.
For a colormap that is changed by a call to _X_F_r_e_e_C_o_l_o_r_m_a_p,
the colormap member is set to _N_o_n_e. The new member is set
to indicate whether the colormap for the specified window
was changed or installed or uninstalled and can be _T_r_u_e or
_F_a_l_s_e. If it is _T_r_u_e, the colormap was changed. If it is
_F_a_l_s_e, the colormap was installed or uninstalled. The state
member is always set to indicate whether the colormap is
installed or uninstalled and can be _C_o_l_o_r_m_a_p_I_n_s_t_a_l_l_e_d or
_C_o_l_o_r_m_a_p_U_n_i_n_s_t_a_l_l_e_d.
1100..1133.. CClliieenntt CCoommmmuunniiccaattiioonn EEvveennttss
This section discusses:
· _C_l_i_e_n_t_M_e_s_s_a_g_e events
· _P_r_o_p_e_r_t_y_N_o_t_i_f_y events
· _S_e_l_e_c_t_i_o_n_C_l_e_a_r events
· _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y events
· _S_e_l_e_c_t_i_o_n_R_e_q_u_e_s_t events
1100..1133..11.. CClliieennttMMeessssaaggee EEvveennttss
The X server generates _C_l_i_e_n_t_M_e_s_s_a_g_e events only when a
client calls the function _X_S_e_n_d_E_v_e_n_t.
The structure for this event type contains:
__
││
typedef struct {
int type; /* ClientMessage */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
Atom message_type;
int format;
union {
char b[20];
short s[10];
long l[5];
} data;
} XClientMessageEvent;
││__
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
332277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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, ten 16-bit values, and five 32-bit val-
ues. Particular message types might not make use of all
these values. The X server places no interpretation on the
values in the window, message_type, or data members.
1100..1133..22.. PPrrooppeerrttyyNNoottiiffyy EEvveennttss
The X server can report _P_r_o_p_e_r_t_y_N_o_t_i_f_y events to clients
wanting information about property changes for a specified
window.
To receive _P_r_o_p_e_r_t_y_N_o_t_i_f_y events, set the _P_r_o_p_e_r_t_y_C_h_a_n_g_e_M_a_s_k
bit in the event-mask attribute of the window.
The structure for this event type contains:
__
││
typedef struct {
int type; /* PropertyNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
Atom atom;
Time time;
int state; /* PropertyNewValue or PropertyDelete */
} XPropertyEvent;
││__
The window member is set to the window whose associated
property was changed. The atom member is set to the prop-
erty'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 to a new value or deleted
and can be _P_r_o_p_e_r_t_y_N_e_w_V_a_l_u_e or _P_r_o_p_e_r_t_y_D_e_l_e_t_e. The state
member is set to _P_r_o_p_e_r_t_y_N_e_w_V_a_l_u_e when a property of the
window is changed using _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y or _X_R_o_t_a_t_e_W_i_n_d_o_w_-
_P_r_o_p_e_r_t_i_e_s (even when adding zero-length data using _X_C_h_a_n_g_e_-
_P_r_o_p_e_r_t_y) and when replacing all or part of a property with
identical data using _X_C_h_a_n_g_e_P_r_o_p_e_r_t_y or _X_R_o_t_a_t_e_W_i_n_d_o_w_P_r_o_p_e_r_-
_t_i_e_s. The state member is set to _P_r_o_p_e_r_t_y_D_e_l_e_t_e when a
property of the window is deleted using _X_D_e_l_e_t_e_P_r_o_p_e_r_t_y or,
if the delete argument is _T_r_u_e, _X_G_e_t_W_i_n_d_o_w_P_r_o_p_e_r_t_y.
1100..1133..33.. SSeelleeccttiioonnCClleeaarr EEvveennttss
The X server reports _S_e_l_e_c_t_i_o_n_C_l_e_a_r events to the client
losing ownership of a selection. The X server generates
332288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
this event type when another client asserts ownership of the
selection by calling _X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r.
The structure for this event type contains:
__
││
typedef struct {
int type; /* SelectionClear */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
Atom selection;
Time time;
} XSelectionClearEvent;
││__
The selection member is set to the selection atom. The time
member is set to the last change time recorded for the
selection. The window member is the window that was speci-
fied by the current owner (the owner losing the selection)
in its _X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r call.
1100..1133..44.. SSeelleeccttiioonnRReeqquueesstt EEvveennttss
The X server reports _S_e_l_e_c_t_i_o_n_R_e_q_u_e_s_t events to the owner of
a selection. The X server generates this event whenever a
client requests a selection conversion by calling _X_C_o_n_v_e_r_t_S_-
_e_l_e_c_t_i_o_n for the owned selection.
The structure for this event type contains:
__
││
typedef struct {
int type; /* SelectionRequest */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window owner;
Window requestor;
Atom selection;
Atom target;
Atom property;
Time time;
} XSelectionRequestEvent;
││__
The owner member is set to the window that was specified by
the current owner in its _X_S_e_t_S_e_l_e_c_t_i_o_n_O_w_n_e_r call. The
requestor member is set to the window requesting the
332299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
selection. The selection member is set to the atom that
names the selection. For example, PRIMARY is used to indi-
cate the primary selection. The target member is set to the
atom that indicates the type the selection is desired in.
The property member can be a property name or _N_o_n_e. The
time member is set to the timestamp or _C_u_r_r_e_n_t_T_i_m_e value
from the _C_o_n_v_e_r_t_S_e_l_e_c_t_i_o_n request.
The owner should convert the selection based on the speci-
fied target type and send a _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y event back to
the requestor. A complete specification for using selec-
tions is given in the X Consortium standard _I_n_t_e_r_-_C_l_i_e_n_t
_C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l.
1100..1133..55.. SSeelleeccttiioonnNNoottiiffyy EEvveennttss
This event is generated by the X server in response to a
_C_o_n_v_e_r_t_S_e_l_e_c_t_i_o_n protocol request when there is no owner for
the selection. When there is an owner, it should be gener-
ated by the owner of the selection by using _X_S_e_n_d_E_v_e_n_t. The
owner of a selection should send this event to a requestor
when a selection has been converted and stored as a property
or when a selection conversion could not be performed (which
is indicated by setting the property member to _N_o_n_e).
If _N_o_n_e is specified as the property in the _C_o_n_v_e_r_t_S_e_l_e_c_t_i_o_n
protocol request, the owner should choose a property name,
store the result as that property on the requestor window,
and then send a _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y giving that actual property
name.
The structure for this event type contains:
__
││
typedef struct {
int type; /* SelectionNotify */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window requestor;
Atom selection;
Atom target;
Atom property; /* atom or None */
Time time;
} XSelectionEvent;
││__
The requestor member is set to the window associated with
the requestor of the selection. The selection member is set
to the atom that indicates the selection. For example, PRI-
MARY is used for the primary selection. The target member
is set to the atom that indicates the converted type. For
333300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
example, PIXMAP is used for a pixmap. The property member
is set to the atom that indicates which property the result
was stored on. If the conversion failed, the property mem-
ber is set to _N_o_n_e. The time member is set to the time the
conversion took place and can be a timestamp or _C_u_r_r_e_n_t_T_i_m_e.
333311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1111
EEvveenntt HHaannddlliinngg FFuunnccttiioonnss
This chapter discusses the Xlib functions you can use to:
· Select events
· Handle the output buffer and the event queue
· Select events from the event queue
· Send and get events
· Handle protocol errors
Note
Some toolkits use their own event-handling
functions and do not allow you to interchange
these event-handling functions with those in
Xlib. For further information, see the docu-
mentation supplied with the toolkit.
Most applications simply are event loops: they wait for an
event, decide what to do with it, execute some amount of
code that results in changes to the display, and then wait
for the next event.
1111..11.. SSeelleeccttiinngg EEvveennttss
There are two ways to select the events you want reported to
your client application. One way is to set the event_mask
member of the _X_S_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s structure when you call
_X_C_r_e_a_t_e_W_i_n_d_o_w and _X_C_h_a_n_g_e_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s. Another way is
to use _X_S_e_l_e_c_t_I_n_p_u_t.
333322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSelectInput(_d_i_s_p_l_a_y, _w, _e_v_e_n_t___m_a_s_k)
Display *_d_i_s_p_l_a_y;
Window _w;
long _e_v_e_n_t___m_a_s_k;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose events you are inter-
ested in.
_e_v_e_n_t___m_a_s_k
Specifies the event mask.
││__
The _X_S_e_l_e_c_t_I_n_p_u_t function requests that the X server report
the events associated with the specified event mask. Ini-
tially, X will not report any of these events. Events are
reported relative to a window. If a window is not inter-
ested in a device event, it usually propagates to the clos-
est ancestor that is interested, unless the do_not_propagate
mask prohibits it.
Setting the event-mask attribute of a window overrides any
previous call for the same window but not for other clients.
Multiple clients can select for the same events on the same
window with the following restrictions:
· Multiple clients can select events on the same window
because their event masks are disjoint. When the X
server generates an event, it reports it to all inter-
ested clients.
· Only one client at a time can select _C_i_r_c_u_l_a_t_e_R_e_q_u_e_s_t,
_C_o_n_f_i_g_u_r_e_R_e_q_u_e_s_t, or _M_a_p_R_e_q_u_e_s_t events, which are asso-
ciated with the event mask _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_r_e_c_t_M_a_s_k.
· Only one client at a time can select a _R_e_s_i_z_e_R_e_q_u_e_s_t
event, which is associated with the event mask _R_e_s_i_z_-
_e_R_e_d_i_r_e_c_t_M_a_s_k.
· Only one client at a time can select a _B_u_t_t_o_n_P_r_e_s_s
event, which is associated with the event mask _B_u_t_t_o_n_-
_P_r_e_s_s_M_a_s_k.
The server reports the event to all interested clients.
_X_S_e_l_e_c_t_I_n_p_u_t can generate a _B_a_d_W_i_n_d_o_w error.
1111..22.. HHaannddlliinngg tthhee OOuuttppuutt BBuuffffeerr
The output buffer is an area used by Xlib to store requests.
The functions described in this section flush the output
333333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
buffer if the function would block or not return an event.
That is, all requests residing in the output buffer that
have not yet been sent are transmitted to the X server.
These functions differ in the additional tasks they might
perform.
To flush the output buffer, use _X_F_l_u_s_h.
__
││
XFlush(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_F_l_u_s_h function flushes the output buffer. Most client
applications need not use this function because the output
buffer is automatically flushed as needed by calls to _X_P_e_n_d_-
_i_n_g, _X_N_e_x_t_E_v_e_n_t, and _X_W_i_n_d_o_w_E_v_e_n_t. Events generated by the
server may be enqueued into the library's event queue.
To flush the output buffer and then wait until all requests
have been processed, use _X_S_y_n_c.
__
││
XSync(_d_i_s_p_l_a_y, _d_i_s_c_a_r_d)
Display *_d_i_s_p_l_a_y;
Bool _d_i_s_c_a_r_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_i_s_c_a_r_d Specifies a Boolean value that indicates whether
_X_S_y_n_c discards all events on the event queue.
││__
The _X_S_y_n_c function flushes the output buffer and then waits
until all requests have been received and processed by the X
server. Any errors generated must be handled by the error
handler. For each protocol error received by Xlib, _X_S_y_n_c
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 event queue.
Finally, if you passed _F_a_l_s_e, _X_S_y_n_c does not discard the
events in the queue. If you passed _T_r_u_e, _X_S_y_n_c discards all
events in the queue, including those events that were on the
queue before _X_S_y_n_c was called. Client applications seldom
need to call _X_S_y_n_c.
333344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1111..33.. EEvveenntt QQuueeuuee MMaannaaggeemmeenntt
Xlib maintains an event queue. However, the operating sys-
tem also may be buffering data in its network connection
that is not yet read into the event queue.
To check the number of events in the event queue, use
_X_E_v_e_n_t_s_Q_u_e_u_e_d.
__
││
int XEventsQueued(_d_i_s_p_l_a_y, _m_o_d_e)
Display *_d_i_s_p_l_a_y;
int _m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_o_d_e Specifies the mode. You can pass _Q_u_e_u_e_d_A_l_r_e_a_d_y,
_Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h, or _Q_u_e_u_e_d_A_f_t_e_r_R_e_a_d_i_n_g.
││__
If mode is _Q_u_e_u_e_d_A_l_r_e_a_d_y, _X_E_v_e_n_t_s_Q_u_e_u_e_d returns the number
of events already in the event queue (and never performs a
system call). If mode is _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h, _X_E_v_e_n_t_s_Q_u_e_u_e_d
returns the number of events already in the queue if the
number is nonzero. If there are no events in the queue,
_X_E_v_e_n_t_s_Q_u_e_u_e_d flushes the output buffer, attempts to read
more events out of the application's connection, and returns
the number read. If mode is _Q_u_e_u_e_d_A_f_t_e_r_R_e_a_d_i_n_g,
_X_E_v_e_n_t_s_Q_u_e_u_e_d returns the number of events already in the
queue if the number is nonzero. If there are no events in
the queue, _X_E_v_e_n_t_s_Q_u_e_u_e_d attempts to read more events out of
the application's connection without flushing the output
buffer and returns the number read.
_X_E_v_e_n_t_s_Q_u_e_u_e_d always returns immediately without I/O if
there are events already in the queue. _X_E_v_e_n_t_s_Q_u_e_u_e_d with
mode _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h is identical in behavior to _X_P_e_n_d_i_n_g.
_X_E_v_e_n_t_s_Q_u_e_u_e_d with mode _Q_u_e_u_e_d_A_l_r_e_a_d_y is identical to the
_X_Q_L_e_n_g_t_h function.
To return the number of events that are pending, use _X_P_e_n_d_-
_i_n_g.
333355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XPending(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_P_e_n_d_i_n_g function returns the number of events that have
been received from the X server but have not been removed
from the event queue. _X_P_e_n_d_i_n_g is identical to
_X_E_v_e_n_t_s_Q_u_e_u_e_d with the mode _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h specified.
1111..44.. MMaanniippuullaattiinngg tthhee EEvveenntt QQuueeuuee
Xlib provides functions that let you manipulate the event
queue. This section discusses how to:
· Obtain events, in order, and remove them from the queue
· Peek at events in the queue without removing them
· Obtain events that match the event mask or the arbi-
trary predicate procedures that you provide
1111..44..11.. RReettuurrnniinngg tthhee NNeexxtt EEvveenntt
To get the next event and remove it from the queue, use
_X_N_e_x_t_E_v_e_n_t.
__
││
XNextEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___r_e_t_u_r_n
Returns the next event in the queue.
││__
The _X_N_e_x_t_E_v_e_n_t function copies the first event from the
event queue into the specified _X_E_v_e_n_t structure and then
removes it from the queue. If the event queue is empty,
_X_N_e_x_t_E_v_e_n_t flushes the output buffer and blocks until an
event is received.
To peek at the event queue, use _X_P_e_e_k_E_v_e_n_t.
333366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XPeekEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___r_e_t_u_r_n
Returns a copy of the matched event's associated
structure.
││__
The _X_P_e_e_k_E_v_e_n_t function returns the first event from the
event queue, but it does not remove the event from the
queue. If the queue is empty, _X_P_e_e_k_E_v_e_n_t flushes the output
buffer and blocks until an event is received. It then
copies the event into the client-supplied _X_E_v_e_n_t structure
without removing it from the event queue.
1111..44..22.. SSeelleeccttiinngg EEvveennttss UUssiinngg aa PPrreeddiiccaattee PPrroocceedduurree
Each of the functions discussed in this section 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.
If the predicate directly or indirectly causes the state of
the event queue to change, the result is not defined. If
Xlib has been initialized for threads, the predicate is
called with the display locked and the result of a call by
the predicate to any Xlib function that locks the display is
not defined unless the caller has first called _X_L_o_c_k_D_i_s_p_l_a_y.
The predicate procedure and its associated arguments are:
__
││
Bool (*_p_r_e_d_i_c_a_t_e)(_d_i_s_p_l_a_y, _e_v_e_n_t, _a_r_g)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t;
XPointer _a_r_g;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t Specifies the _X_E_v_e_n_t structure.
_a_r_g Specifies the argument passed in from the
_X_I_f_E_v_e_n_t, _X_C_h_e_c_k_I_f_E_v_e_n_t, or _X_P_e_e_k_I_f_E_v_e_n_t function.
││__
The predicate procedure is called once for each event in the
queue until it finds a match. After finding a match, the
predicate procedure must return _T_r_u_e. If it did not find a
match, it must return _F_a_l_s_e.
333377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To check the event queue for a matching event and, if found,
remove the event from the queue, use _X_I_f_E_v_e_n_t.
__
││
XIfEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___r_e_t_u_r_n, _p_r_e_d_i_c_a_t_e, _a_r_g)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
Bool (*_p_r_e_d_i_c_a_t_e)();
XPointer _a_r_g;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
_p_r_e_d_i_c_a_t_e Specifies the procedure that is to be called to
determine if the next event in the queue matches
what you want.
_a_r_g Specifies the user-supplied argument that will be
passed to the predicate procedure.
││__
The _X_I_f_E_v_e_n_t function completes only when the specified
predicate procedure returns _T_r_u_e for an event, which indi-
cates an event in the queue matches. _X_I_f_E_v_e_n_t flushes the
output buffer if it blocks waiting for additional events.
_X_I_f_E_v_e_n_t removes the matching event from the queue and
copies the structure into the client-supplied _X_E_v_e_n_t struc-
ture.
To check the event queue for a matching event without block-
ing, use _X_C_h_e_c_k_I_f_E_v_e_n_t.
333388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XCheckIfEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___r_e_t_u_r_n, _p_r_e_d_i_c_a_t_e, _a_r_g)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
Bool (*_p_r_e_d_i_c_a_t_e)();
XPointer _a_r_g;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___r_e_t_u_r_n
Returns a copy of the matched event's associated
structure.
_p_r_e_d_i_c_a_t_e Specifies the procedure that is to be called to
determine if the next event in the queue matches
what you want.
_a_r_g Specifies the user-supplied argument that will be
passed to the predicate procedure.
││__
When the predicate procedure finds a match, _X_C_h_e_c_k_I_f_E_v_e_n_t
copies the matched event into the client-supplied _X_E_v_e_n_t
structure and returns _T_r_u_e. (This event is removed from the
queue.) If the predicate procedure finds no match, _X_C_h_e_c_k_-
_I_f_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will have been
flushed. All earlier events stored in the queue are not
discarded.
To check the event queue for a matching event without remov-
ing the event from the queue, use _X_P_e_e_k_I_f_E_v_e_n_t.
333399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XPeekIfEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___r_e_t_u_r_n, _p_r_e_d_i_c_a_t_e, _a_r_g)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
Bool (*_p_r_e_d_i_c_a_t_e)();
XPointer _a_r_g;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___r_e_t_u_r_n
Returns a copy of the matched event's associated
structure.
_p_r_e_d_i_c_a_t_e Specifies the procedure that is to be called to
determine if the next event in the queue matches
what you want.
_a_r_g Specifies the user-supplied argument that will be
passed to the predicate procedure.
││__
The _X_P_e_e_k_I_f_E_v_e_n_t function returns only when the specified
predicate procedure returns _T_r_u_e for an event. After the
predicate procedure finds a match, _X_P_e_e_k_I_f_E_v_e_n_t copies the
matched event into the client-supplied _X_E_v_e_n_t structure
without removing the event from the queue. _X_P_e_e_k_I_f_E_v_e_n_t
flushes the output buffer if it blocks waiting for addi-
tional events.
1111..44..33.. SSeelleeccttiinngg EEvveennttss UUssiinngg aa WWiinnddooww oorr EEvveenntt MMaasskk
The functions discussed in this section let you select
events by window or event types, allowing you to process
events out of order.
To remove the next event that matches both a window and an
event mask, use _X_W_i_n_d_o_w_E_v_e_n_t.
334400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XWindowEvent(_d_i_s_p_l_a_y, _w, _e_v_e_n_t___m_a_s_k, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
long _e_v_e_n_t___m_a_s_k;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose events you are inter-
ested in.
_e_v_e_n_t___m_a_s_k
Specifies the event mask.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
││__
The _X_W_i_n_d_o_w_E_v_e_n_t function searches the event queue for an
event that matches both the specified window and event mask.
When it finds a match, _X_W_i_n_d_o_w_E_v_e_n_t removes that event from
the queue and copies it into the specified _X_E_v_e_n_t structure.
The other events stored in the queue are not discarded. If
a matching event is not in the queue, _X_W_i_n_d_o_w_E_v_e_n_t flushes
the output buffer and blocks until one is received.
To remove the next event that matches both a window and an
event mask (if any), use _X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t. This function
is similar to _X_W_i_n_d_o_w_E_v_e_n_t except that it never blocks and
it returns a _B_o_o_l indicating if the event was returned.
334411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XCheckWindowEvent(_d_i_s_p_l_a_y, _w, _e_v_e_n_t___m_a_s_k, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
long _e_v_e_n_t___m_a_s_k;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window whose events you are inter-
ested in.
_e_v_e_n_t___m_a_s_k
Specifies the event mask.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
││__
The _X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t 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, _X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t removes that
event, copies it into the specified _X_E_v_e_n_t structure, and
returns _T_r_u_e. The other events stored in the queue are not
discarded. If the event you requested is not available,
_X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will
have been flushed.
To remove the next event that matches an event mask, use
_X_M_a_s_k_E_v_e_n_t.
__
││
XMaskEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___m_a_s_k, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
long _e_v_e_n_t___m_a_s_k;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___m_a_s_k
Specifies the event mask.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
││__
The _X_M_a_s_k_E_v_e_n_t function searches the event queue for the
events associated with the specified mask. When it finds a
match, _X_M_a_s_k_E_v_e_n_t removes that event and copies it into the
specified _X_E_v_e_n_t structure. The other events stored in the
334422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
queue are not discarded. If the event you requested is not
in the queue, _X_M_a_s_k_E_v_e_n_t flushes the output buffer and
blocks until one is received.
To return and remove the next event that matches an event
mask (if any), use _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t. This function is simi-
lar to _X_M_a_s_k_E_v_e_n_t except that it never blocks and it returns
a _B_o_o_l indicating if the event was returned.
__
││
Bool XCheckMaskEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___m_a_s_k, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
long _e_v_e_n_t___m_a_s_k;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___m_a_s_k
Specifies the event mask.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
││__
The _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t function searches the event queue and
then any events available on the server connection for the
first event that matches the specified mask. If it finds a
match, _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t removes that event, copies it into
the specified _X_E_v_e_n_t structure, and returns _T_r_u_e. The other
events stored in the queue are not discarded. If the event
you requested is not available, _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t returns
_F_a_l_s_e, and the output buffer will have been flushed.
To return and remove the next event in the queue that
matches an event type, use _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t.
334433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XCheckTypedEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___t_y_p_e, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int _e_v_e_n_t___t_y_p_e;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___t_y_p_e
Specifies the event type to be compared.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
││__
The _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t 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, _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t removes that event, copies it into
the specified _X_E_v_e_n_t structure, and returns _T_r_u_e. The other
events in the queue are not discarded. If the event is not
available, _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t returns _F_a_l_s_e, and the output
buffer will have been flushed.
To return and remove the next event in the queue that
matches an event type and a window, use _X_C_h_e_c_k_T_y_p_e_d_W_i_n_d_o_w_-
_E_v_e_n_t.
__
││
Bool XCheckTypedWindowEvent(_d_i_s_p_l_a_y, _w, _e_v_e_n_t___t_y_p_e, _e_v_e_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
int _e_v_e_n_t___t_y_p_e;
XEvent *_e_v_e_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_e_v_e_n_t___t_y_p_e
Specifies the event type to be compared.
_e_v_e_n_t___r_e_t_u_r_n
Returns the matched event's associated structure.
││__
The _X_C_h_e_c_k_T_y_p_e_d_W_i_n_d_o_w_E_v_e_n_t 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.
334444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
If it finds a match, _X_C_h_e_c_k_T_y_p_e_d_W_i_n_d_o_w_E_v_e_n_t removes the
event from the queue, copies it into the specified _X_E_v_e_n_t
structure, and returns _T_r_u_e. The other events in the queue
are not discarded. If the event is not available, _X_C_h_e_c_k_-
_T_y_p_e_d_W_i_n_d_o_w_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will
have been flushed.
1111..55.. PPuuttttiinngg aann EEvveenntt BBaacckk iinnttoo tthhee QQuueeuuee
To push an event back into the event queue, use _X_P_u_t_B_a_c_k_-
_E_v_e_n_t.
__
││
XPutBackEvent(_d_i_s_p_l_a_y, _e_v_e_n_t)
Display *_d_i_s_p_l_a_y;
XEvent *_e_v_e_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t Specifies the event.
││__
The _X_P_u_t_B_a_c_k_E_v_e_n_t function pushes an event back onto the
head of the display's event queue by copying the event into
the queue. This can be useful if you read an event and then
decide that you would rather deal with it later. There is
no limit to the number of times in succession that you can
call _X_P_u_t_B_a_c_k_E_v_e_n_t.
1111..66.. SSeennddiinngg EEvveennttss ttoo OOtthheerr AApppplliiccaattiioonnss
To send an event to a specified window, use _X_S_e_n_d_E_v_e_n_t.
This function is often used in selection processing. For
example, the owner of a selection should use _X_S_e_n_d_E_v_e_n_t to
send a _S_e_l_e_c_t_i_o_n_N_o_t_i_f_y event to a requestor when a selection
has been converted and stored as a property.
334455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XSendEvent(_d_i_s_p_l_a_y, _w, _p_r_o_p_a_g_a_t_e, _e_v_e_n_t___m_a_s_k, _e_v_e_n_t___s_e_n_d)
Display *_d_i_s_p_l_a_y;
Window _w;
Bool _p_r_o_p_a_g_a_t_e;
long _e_v_e_n_t___m_a_s_k;
XEvent *_e_v_e_n_t___s_e_n_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window the event is to be sent to,
or _P_o_i_n_t_e_r_W_i_n_d_o_w, or _I_n_p_u_t_F_o_c_u_s.
_p_r_o_p_a_g_a_t_e Specifies a Boolean value.
_e_v_e_n_t___m_a_s_k
Specifies the event mask.
_e_v_e_n_t___s_e_n_d
Specifies the event that is to be sent.
││__
The _X_S_e_n_d_E_v_e_n_t function identifies the destination window,
determines which clients should receive the specified
events, and ignores any active grabs. This function
requires you to pass an event mask. For a discussion of the
valid event mask names, see section 10.3. This function
uses the w argument to identify the destination window as
follows:
· If w is _P_o_i_n_t_e_r_W_i_n_d_o_w, the destination window is the
window that contains the pointer.
· If w is _I_n_p_u_t_F_o_c_u_s and if the focus window contains the
pointer, the destination window is the window that con-
tains the pointer; otherwise, the destination window is
the focus window.
To determine which clients should receive the specified
events, _X_S_e_n_d_E_v_e_n_t uses the propagate argument as follows:
· If event_mask is the empty set, the event is sent to
the client that created the destination window. If
that client no longer exists, no event is sent.
· If propagate is _F_a_l_s_e, the event is sent to every
client selecting on destination any of the event types
in the event_mask argument.
· If propagate is _T_r_u_e and no clients have selected on
destination any of the event types in event-mask, the
destination is replaced with the closest ancestor of
destination for which some client has selected a type
334466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
in event-mask and for which no intervening window has
that type in its do-not-propagate-mask. If no such
window exists or if the window is an ancestor of the
focus window and _I_n_p_u_t_F_o_c_u_s was originally specified as
the destination, the event is not sent to any clients.
Otherwise, the event is reported to every client
selecting on the final destination any of the types
specified in event_mask.
The event in the _X_E_v_e_n_t structure must be one of the core
events or one of the events defined by an extension (or a
_B_a_d_V_a_l_u_e error results) so that the X server can correctly
byte-swap the contents as necessary. The contents of the
event are otherwise unaltered and unchecked by the X server
except to force send_event to _T_r_u_e in the forwarded event
and to set the serial number in the event correctly; there-
fore these fields and the display field are ignored by
_X_S_e_n_d_E_v_e_n_t.
_X_S_e_n_d_E_v_e_n_t returns zero if the conversion to wire protocol
format failed and returns nonzero otherwise.
_X_S_e_n_d_E_v_e_n_t can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
1111..77.. GGeettttiinngg PPooiinntteerr MMoottiioonn HHiissttoorryy
Some X server implementations will maintain a more complete
history of pointer motion than is reported by event notifi-
cation. The pointer position at each pointer hardware
interrupt may be stored in a buffer for later retrieval.
This buffer is called the motion history buffer. For exam-
ple, a few applications, such as paint programs, want to
have a precise history of where the pointer traveled. How-
ever, this historical information is highly excessive for
most applications.
To determine the approximate maximum number of elements in
the motion buffer, use _X_D_i_s_p_l_a_y_M_o_t_i_o_n_B_u_f_f_e_r_S_i_z_e.
__
││
unsigned long XDisplayMotionBufferSize(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The server may retain the recent history of the pointer
motion and do so to a finer granularity than is reported by
_M_o_t_i_o_n_N_o_t_i_f_y events. The _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s function makes
this history available.
334477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To get the motion history for a specified window and time,
use _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s.
__
││
XTimeCoord *XGetMotionEvents(_d_i_s_p_l_a_y, _w, _s_t_a_r_t, _s_t_o_p, _n_e_v_e_n_t_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Time _s_t_a_r_t, _s_t_o_p;
int *_n_e_v_e_n_t_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_t_a_r_t
_s_t_o_p Specify the time interval in which the events are
returned from the motion history buffer. You can
pass a timestamp or _C_u_r_r_e_n_t_T_i_m_e.
_n_e_v_e_n_t_s___r_e_t_u_r_n
Returns the number of events from the motion his-
tory buffer.
││__
The _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s function returns all events in the
motion history buffer that fall between the specified start
and stop times, inclusive, and that have coordinates that
lie within the specified window (including its borders) at
its present placement. If the server does not support
motion history, if the start time is later than the stop
time, or if the start time is in the future, no events are
returned; _X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s returns NULL. If the stop time
is in the future, it is equivalent to specifying _C_u_r_r_e_n_t_-
_T_i_m_e. The return type for this function is a structure
defined as follows:
__
││
typedef struct {
Time time;
short x, y;
} XTimeCoord;
││__
The time member is set to the time, in milliseconds. The x
and y members are set to the coordinates of the pointer and
are reported relative to the origin of the specified window.
To free the data returned from this call, use _X_F_r_e_e.
_X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.
334488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1111..88.. HHaannddlliinngg PPrroottooccooll EErrrroorrss
Xlib provides functions that you can use to enable or dis-
able synchronization and to use the default error handlers.
1111..88..11.. EEnnaabblliinngg oorr DDiissaabblliinngg SSyynncchhrroonniizzaattiioonn
When debugging X applications, it often is very convenient
to require Xlib to behave synchronously so that errors are
reported as they occur. The following function lets you
disable or enable synchronous behavior. Note that graphics
may occur 30 or more times more slowly when synchronization
is enabled. On POSIX-conformant systems, there is also a
global variable ___X_d_e_b_u_g that, if set to nonzero before
starting a program under a debugger, will force synchronous
library behavior.
After completing their work, all Xlib functions that gener-
ate protocol requests call what is known as an after func-
tion. _X_S_e_t_A_f_t_e_r_F_u_n_c_t_i_o_n sets which function is to be
called.
__
││
int (*XSetAfterFunction(_d_i_s_p_l_a_y, _p_r_o_c_e_d_u_r_e))()
Display *_d_i_s_p_l_a_y;
int (*_p_r_o_c_e_d_u_r_e)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_r_o_c_e_d_u_r_e Specifies the procedure to be called.
││__
The specified procedure is called with only a display
pointer. _X_S_e_t_A_f_t_e_r_F_u_n_c_t_i_o_n returns the previous after func-
tion.
To enable or disable synchronization, use _X_S_y_n_c_h_r_o_n_i_z_e.
__
││
int (*XSynchronize(_d_i_s_p_l_a_y, _o_n_o_f_f))()
Display *_d_i_s_p_l_a_y;
Bool _o_n_o_f_f;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_o_n_o_f_f Specifies a Boolean value that indicates whether
to enable or disable synchronization.
││__
The _X_S_y_n_c_h_r_o_n_i_z_e function returns the previous after func-
tion. If onoff is _T_r_u_e, _X_S_y_n_c_h_r_o_n_i_z_e turns on synchronous
behavior. If onoff is _F_a_l_s_e, _X_S_y_n_c_h_r_o_n_i_z_e turns off
334499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
synchronous behavior.
1111..88..22.. UUssiinngg tthhee DDeeffaauulltt EErrrroorr HHaannddlleerrss
There are two default error handlers in Xlib: one to handle
typically fatal conditions (for example, the connection to a
display server dying because a machine crashed) and one to
handle protocol errors from the X server. These error han-
dlers can be changed to user-supplied routines if you prefer
your own error handling and can be changed as often as you
like. If either function is passed a NULL pointer, it will
reinvoke the default handler. The action of the default
handlers is to print an explanatory message and exit.
To set the error handler, use _X_S_e_t_E_r_r_o_r_H_a_n_d_l_e_r.
__
││
int (*XSetErrorHandler(_h_a_n_d_l_e_r))()
int (*_h_a_n_d_l_e_r)(Display *, XErrorEvent *)
_h_a_n_d_l_e_r Specifies the program's supplied error handler.
││__
Xlib generally calls the program's supplied error handler
whenever an error is received. It is not called on _B_a_d_N_a_m_e
errors from _O_p_e_n_F_o_n_t, _L_o_o_k_u_p_C_o_l_o_r, or _A_l_l_o_c_N_a_m_e_d_C_o_l_o_r proto-
col requests or on _B_a_d_F_o_n_t errors from a _Q_u_e_r_y_F_o_n_t protocol
request. These errors generally are reflected back to the
program through the procedural interface. Because this con-
dition is not assumed to be fatal, it is acceptable for your
error handler to return; the returned value is ignored.
However, the error handler should not call any functions
(directly or indirectly) on the display that will generate
protocol requests or that will look for input events. The
previous error handler is returned.
The _X_E_r_r_o_r_E_v_e_n_t structure contains:
typedef struct {
int type;
Display *display; /* Display the event was read from */
unsigned long serial;/* serial number of failed request */
unsigned char error_code;/* error code of failed request */
unsigned char request_code;/* Major op-code of failed request */
unsigned char minor_code;/* Minor op-code of failed request */
XID resourceid; /* resource id */
} XErrorEvent;
The serial member is the number of requests, starting from
one, sent over the network connection since it was opened.
335500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
It is the number that was the value of _N_e_x_t_R_e_q_u_e_s_t immedi-
ately before the failing call was made. The request_code
member is a protocol request of the procedure that failed,
as defined in <_X_1_1_/_X_p_r_o_t_o_._h>. The following error codes can
be returned by the functions described in this chapter:
-------------------------------------------------------------
EErrrroorr CCooddee DDeessccrriippttiioonn
-------------------------------------------------------------
_B_a_d_A_c_c_e_s_s A client attempts to grab a key/button
combination already grabbed by another
client.
A client attempts to free a colormap
entry that it had not already allocated
or to free an entry in a colormap that
was created with all entries writable.
A client attempts to store into a read-
only or unallocated colormap entry.
A client attempts to modify the access
control list from other than the local
(or otherwise authorized) host.
A client attempts to select an event
type that another client has already
selected.
_B_a_d_A_l_l_o_c The server fails to allocate the
requested resource. Note that the
explicit listing of _B_a_d_A_l_l_o_c errors in
requests only covers allocation errors
at a very coarse level and is not
intended to (nor can it in practice hope
to) cover all cases of a server running
out of allocation space in the middle of
service. The semantics when a server
runs out of allocation space are left
unspecified, but a server may generate a
_B_a_d_A_l_l_o_c error on any request for this
reason, and clients should be prepared
to receive such errors and handle or
discard them.
_B_a_d_A_t_o_m A value for an atom argument does not
name a defined atom.
_B_a_d_C_o_l_o_r A value for a colormap argument does not
name a defined colormap.
_B_a_d_C_u_r_s_o_r A value for a cursor argument does not
name a defined cursor.
_B_a_d_D_r_a_w_a_b_l_e A value for a drawable argument does not
name a defined window or pixmap.
_B_a_d_F_o_n_t A value for a font argument does not
name a defined font (or, in some cases,
_G_C_o_n_t_e_x_t).
_B_a_d_G_C A value for a _G_C_o_n_t_e_x_t argument does not
name a defined _G_C_o_n_t_e_x_t.
335511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------------
EErrrroorr CCooddee DDeessccrriippttiioonn
-------------------------------------------------------------
_B_a_d_I_D_C_h_o_i_c_e The value chosen for a resource identi-
fier either is not included in the range
assigned to the client or is already in
use. Under normal circumstances, this
cannot occur and should be considered a
server or Xlib error.
_B_a_d_I_m_p_l_e_m_e_n_t_a_t_i_o_n The server does not implement some
aspect of the request. A server that
generates this error for a core request
is deficient. As such, this error is
not listed for any of the requests, but
clients should be prepared to receive
such errors and handle or discard them.
_B_a_d_L_e_n_g_t_h The length of a request is shorter or
longer than that required to contain the
arguments. This is an internal Xlib or
server error.
The length of a request exceeds the max-
imum length accepted by the server.
_B_a_d_M_a_t_c_h In a graphics request, the root and
depth of the graphics context do not
match those of the drawable.
An _I_n_p_u_t_O_n_l_y window is used as a draw-
able.
Some argument or pair of arguments has
the correct type and range, but it fails
to match in some other way required by
the request.
An _I_n_p_u_t_O_n_l_y window lacks this
attribute.
_B_a_d_N_a_m_e A font or color of the specified name
does not exist.
_B_a_d_P_i_x_m_a_p A value for a pixmap argument does not
name a defined pixmap.
_B_a_d_R_e_q_u_e_s_t The major or minor opcode does not spec-
ify a valid request. This usually is an
Xlib or server error.
_B_a_d_V_a_l_u_e Some numeric value falls outside of the
range of values accepted by the request.
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 alterna-
tives typically can generate this error
(due to the encoding).
_B_a_d_W_i_n_d_o_w A value for a window argument does not
name a defined window.
-------------------------------------------------------------
335522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Note
The _B_a_d_A_t_o_m, _B_a_d_C_o_l_o_r, _B_a_d_C_u_r_s_o_r, _B_a_d_D_r_a_w_a_b_l_e,
_B_a_d_F_o_n_t, _B_a_d_G_C, _B_a_d_P_i_x_m_a_p, and _B_a_d_W_i_n_d_o_w errors
are also used when the argument type is extended
by a set of fixed alternatives.
To obtain textual descriptions of the specified error code,
use _X_G_e_t_E_r_r_o_r_T_e_x_t.
__
││
XGetErrorText(_d_i_s_p_l_a_y, _c_o_d_e, _b_u_f_f_e_r___r_e_t_u_r_n, _l_e_n_g_t_h)
Display *_d_i_s_p_l_a_y;
int _c_o_d_e;
char *_b_u_f_f_e_r___r_e_t_u_r_n;
int _l_e_n_g_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_d_e Specifies the error code for which you want to
obtain a description.
_b_u_f_f_e_r___r_e_t_u_r_n
Returns the error description.
_l_e_n_g_t_h Specifies the size of the buffer.
││__
The _X_G_e_t_E_r_r_o_r_T_e_x_t function copies a null-terminated string
describing the specified error code into the specified
buffer. The returned text is in the encoding of the current
locale. It is recommended that you use this function to
obtain an error description because extensions to Xlib may
define their own error codes and error strings.
To obtain error messages from the error database, use
_X_G_e_t_E_r_r_o_r_D_a_t_a_b_a_s_e_T_e_x_t.
335533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XGetErrorDatabaseText(_d_i_s_p_l_a_y, _n_a_m_e, _m_e_s_s_a_g_e, _d_e_f_a_u_l_t___s_t_r_i_n_g, _b_u_f_f_e_r___r_e_t_u_r_n, _l_e_n_g_t_h)
Display *_d_i_s_p_l_a_y;
char *_n_a_m_e, *_m_e_s_s_a_g_e;
char *_d_e_f_a_u_l_t___s_t_r_i_n_g;
char *_b_u_f_f_e_r___r_e_t_u_r_n;
int _l_e_n_g_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_a_m_e Specifies the name of the application.
_m_e_s_s_a_g_e Specifies the type of the error message.
_d_e_f_a_u_l_t___s_t_r_i_n_g
Specifies the default error message if none is
found in the database.
_b_u_f_f_e_r___r_e_t_u_r_n
Returns the error description.
_l_e_n_g_t_h Specifies the size of the buffer.
││__
The _X_G_e_t_E_r_r_o_r_D_a_t_a_b_a_s_e_T_e_x_t function returns a null-terminated
message (or the default message) from the error message
database. Xlib uses this function internally to look up its
error messages. The text in the default_string argument is
assumed to be in the encoding of the current locale, and the
text stored in the buffer_return argument is in the encoding
of the current locale.
The name argument should generally be the name of your
application. The message argument should indicate which
type of error message you want. If the name and message are
not in the Host Portable Character Encoding, the result is
implementation-dependent. Xlib uses three predefined
``application names'' to report errors. In these names,
uppercase and lowercase matter.
XProtoError
The protocol error number is used as a string for
the message argument.
XlibMessage
These are the message strings that are used inter-
nally by the library.
XRequest For a core protocol request, the major request
protocol number is used for the message argument.
For an extension request, the extension name (as
given by _I_n_i_t_E_x_t_e_n_s_i_o_n) followed by a period (.)
and the minor request protocol number is used for
335544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the message argument. If no string is found in
the error database, the default_string is returned
to the buffer argument.
To report an error to the user when the requested display
does not exist, use _X_D_i_s_p_l_a_y_N_a_m_e.
__
││
char *XDisplayName(_s_t_r_i_n_g)
char *_s_t_r_i_n_g;
_s_t_r_i_n_g Specifies the character string.
││__
The _X_D_i_s_p_l_a_y_N_a_m_e function returns the name of the display
that _X_O_p_e_n_D_i_s_p_l_a_y would attempt to use. If a NULL string is
specified, _X_D_i_s_p_l_a_y_N_a_m_e looks in the environment for the
display and returns the display name that _X_O_p_e_n_D_i_s_p_l_a_y would
attempt to use. This makes it easier to report to the user
precisely which display the program attempted to open when
the initial connection attempt failed.
To handle fatal I/O errors, use _X_S_e_t_I_O_E_r_r_o_r_H_a_n_d_l_e_r.
__
││
int (*XSetIOErrorHandler(_h_a_n_d_l_e_r))()
int (*_h_a_n_d_l_e_r)(Display *);
_h_a_n_d_l_e_r Specifies the program's supplied error handler.
││__
The _X_S_e_t_I_O_E_r_r_o_r_H_a_n_d_l_e_r sets the fatal I/O error handler.
Xlib calls the program's supplied error handler if any sort
of system call error occurs (for example, the connection to
the server was lost). This is assumed to be a fatal condi-
tion, and the called routine should not return. If the I/O
error handler does return, the client process exits.
Note that the previous error handler is returned.
335555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1122
IInnppuutt DDeevviiccee FFuunnccttiioonnss
You can use the Xlib input device functions to:
· Grab the pointer and individual buttons on the pointer
· Grab the keyboard and individual keys on the keyboard
· Resume event processing
· Move the pointer
· Set the input focus
· Manipulate the keyboard and pointer settings
· Manipulate the keyboard encoding
1122..11.. PPooiinntteerr GGrraabbbbiinngg
Xlib provides functions that you can use to control input
from the pointer, which usually is a mouse. Usually, as
soon as keyboard and mouse events occur, the X server deliv-
ers them to the appropriate client, which is determined by
the window and input focus. The X server provides suffi-
cient control over event delivery to allow window managers
to support mouse ahead and various other styles of user
interface. Many of these user interfaces depend on syn-
chronous delivery of events. The delivery of pointer and
keyboard events can be controlled independently.
When mouse buttons or keyboard keys are grabbed, events will
be sent to the grabbing client rather than the normal client
who would have received the event. If the keyboard or
pointer is in asynchronous mode, further mouse and keyboard
events will continue to be processed. If the keyboard or
pointer is in synchronous mode, no further events are pro-
cessed until the grabbing client allows them (see _X_A_l_l_o_w_-
_E_v_e_n_t_s). The keyboard or pointer is considered frozen dur-
ing this interval. The event that triggered the grab can
also be replayed.
Note that the logical state of a device (as seen by client
applications) may lag the physical state if device event
processing is frozen.
There are two kinds of grabs: active and passive. An active
grab occurs when a single client grabs the keyboard and/or
335566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
pointer explicitly (see _X_G_r_a_b_P_o_i_n_t_e_r and _X_G_r_a_b_K_e_y_b_o_a_r_d). A
passive grab occurs when clients grab a particular keyboard
key or pointer button in a window, and the grab will acti-
vate when the key or button is actually pressed. Passive
grabs are convenient for implementing reliable pop-up menus.
For example, you can guarantee that the pop-up is mapped
before the up pointer button event occurs by grabbing a but-
ton requesting synchronous behavior. The down event will
trigger the grab and freeze further processing of pointer
events until you have the chance to map the pop-up window.
You can then allow further event processing. The up event
will then be correctly processed relative to the pop-up win-
dow.
For many operations, there are functions that take a time
argument. The X server includes a timestamp in various
events. One special time, called _C_u_r_r_e_n_t_T_i_m_e, represents
the current server time. The X server maintains the time
when the input focus was last changed, when the keyboard was
last grabbed, when the pointer was last grabbed, or when a
selection was last changed. Your application may be slow
reacting to an event. You often need some way to specify
that your request should not occur if another application
has in the meanwhile taken control of the keyboard, pointer,
or selection. By providing the timestamp from the event in
the request, you can arrange that the operation not take
effect if someone else has performed an operation in the
meanwhile.
A timestamp is a time value, expressed in milliseconds. It
typically is the time since the last server reset. Times-
tamp values wrap around (after about 49.7 days). The
server, given its current time is represented by timestamp
T, always interprets timestamps from clients by treating
half of the timestamp space as being later in time than T.
One timestamp value, named _C_u_r_r_e_n_t_T_i_m_e, is never generated
by the server. This value is reserved for use in requests
to represent the current server time.
For many functions in this section, you pass pointer event
mask bits. The valid pointer event mask bits are: _B_u_t_t_o_n_-
_P_r_e_s_s_M_a_s_k, _B_u_t_t_o_n_R_e_l_e_a_s_e_M_a_s_k, _E_n_t_e_r_W_i_n_d_o_w_M_a_s_k, _L_e_a_v_e_W_i_n_d_o_w_-
_M_a_s_k, _P_o_i_n_t_e_r_M_o_t_i_o_n_M_a_s_k, _P_o_i_n_t_e_r_M_o_t_i_o_n_H_i_n_t_M_a_s_k, _B_u_t_-
_t_o_n_1_M_o_t_i_o_n_M_a_s_k, _B_u_t_t_o_n_2_M_o_t_i_o_n_M_a_s_k, _B_u_t_t_o_n_3_M_o_t_i_o_n_M_a_s_k, _B_u_t_-
_t_o_n_4_M_o_t_i_o_n_M_a_s_k, _B_u_t_t_o_n_5_M_o_t_i_o_n_M_a_s_k, _B_u_t_t_o_n_M_o_t_i_o_n_M_a_s_k, and
_K_e_y_M_a_p_S_t_a_t_e_M_a_s_k. For other functions in this section, you
pass keymask bits. The valid keymask bits are: _S_h_i_f_t_M_a_s_k,
_L_o_c_k_M_a_s_k, _C_o_n_t_r_o_l_M_a_s_k, _M_o_d_1_M_a_s_k, _M_o_d_2_M_a_s_k, _M_o_d_3_M_a_s_k,
_M_o_d_4_M_a_s_k, and _M_o_d_5_M_a_s_k.
To grab the pointer, use _X_G_r_a_b_P_o_i_n_t_e_r.
335577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XGrabPointer(_d_i_s_p_l_a_y, _g_r_a_b___w_i_n_d_o_w, _o_w_n_e_r___e_v_e_n_t_s, _e_v_e_n_t___m_a_s_k, _p_o_i_n_t_e_r___m_o_d_e,
_k_e_y_b_o_a_r_d___m_o_d_e, _c_o_n_f_i_n_e___t_o, _c_u_r_s_o_r, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Window _g_r_a_b___w_i_n_d_o_w;
Bool _o_w_n_e_r___e_v_e_n_t_s;
unsigned int _e_v_e_n_t___m_a_s_k;
int _p_o_i_n_t_e_r___m_o_d_e, _k_e_y_b_o_a_r_d___m_o_d_e;
Window _c_o_n_f_i_n_e___t_o;
Cursor _c_u_r_s_o_r;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_r_a_b___w_i_n_d_o_w
Specifies the grab window.
_o_w_n_e_r___e_v_e_n_t_s
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.
_e_v_e_n_t___m_a_s_k
Specifies which pointer events are reported to the
client. The mask is the bitwise inclusive OR of
the valid pointer event mask bits.
_p_o_i_n_t_e_r___m_o_d_e
Specifies further processing of pointer events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_k_e_y_b_o_a_r_d___m_o_d_e
Specifies further processing of keyboard events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_c_o_n_f_i_n_e___t_o
Specifies the window to confine the pointer in or
_N_o_n_e.
_c_u_r_s_o_r Specifies the cursor that is to be displayed dur-
ing the grab or _N_o_n_e.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_G_r_a_b_P_o_i_n_t_e_r function actively grabs control of the
pointer and returns _G_r_a_b_S_u_c_c_e_s_s if the grab was successful.
Further pointer events are reported only to the grabbing
client. _X_G_r_a_b_P_o_i_n_t_e_r overrides any active pointer grab by
this client. If owner_events is _F_a_l_s_e, all generated
pointer events are reported with respect to grab_window and
335588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
are reported only if selected by event_mask. If
owner_events is _T_r_u_e and if a generated 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 dis-
carded.
If the pointer_mode is _G_r_a_b_M_o_d_e_A_s_y_n_c, pointer event process-
ing continues as usual. If the pointer is currently frozen
by this client, the processing of events for the pointer is
resumed. If the pointer_mode is _G_r_a_b_M_o_d_e_S_y_n_c, 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 _X_A_l_l_o_w_E_v_e_n_t_s 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.
If the keyboard_mode is _G_r_a_b_M_o_d_e_A_s_y_n_c, keyboard event pro-
cessing is unaffected by activation of the grab. If the
keyboard_mode is _G_r_a_b_M_o_d_e_S_y_n_c, the state of the keyboard, as
seen by client applications, appears to freeze, and the X
server generates no further keyboard events until the grab-
bing client calls _X_A_l_l_o_w_E_v_e_n_t_s 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.
If a cursor is specified, it is displayed regardless of what
window the pointer is in. If _N_o_n_e is specified, the normal
cursor for that window is displayed when the pointer is in
grab_window or one of its subwindows; 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 reconfig-
ured, the pointer is warped automatically, as necessary, to
keep it contained in the window.
The time argument allows you to avoid certain circumstances
that come up 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, 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 grabbed the pointer
335599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
before its request was processed.
_X_G_r_a_b_P_o_i_n_t_e_r generates _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events.
Either if grab_window or confine_to window is not viewable
or if the confine_to window lies completely outside the
boundaries of the root window, _X_G_r_a_b_P_o_i_n_t_e_r fails and
returns _G_r_a_b_N_o_t_V_i_e_w_a_b_l_e. If the pointer is actively grabbed
by some other client, it fails and returns _A_l_r_e_a_d_y_G_r_a_b_b_e_d.
If the pointer is frozen by an active grab of another
client, it fails and returns _G_r_a_b_F_r_o_z_e_n. If the specified
time is earlier than the last-pointer-grab time or later
than the current X server time, it fails and returns _G_r_a_b_I_n_-
_v_a_l_i_d_T_i_m_e. Otherwise, the last-pointer-grab time is set to
the specified time (_C_u_r_r_e_n_t_T_i_m_e is replaced by the current X
server time).
_X_G_r_a_b_P_o_i_n_t_e_r can generate _B_a_d_C_u_r_s_o_r, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
errors.
To ungrab the pointer, use _X_U_n_g_r_a_b_P_o_i_n_t_e_r.
__
││
XUngrabPointer(_d_i_s_p_l_a_y, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_U_n_g_r_a_b_P_o_i_n_t_e_r function releases the pointer and any
queued events if this client has actively grabbed the
pointer from _X_G_r_a_b_P_o_i_n_t_e_r, _X_G_r_a_b_B_u_t_t_o_n, or from a normal
button press. _X_U_n_g_r_a_b_P_o_i_n_t_e_r 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 _E_n_t_e_r_N_o_t_i_f_y and _L_e_a_v_e_N_o_t_i_f_y events. The X server
performs an _U_n_g_r_a_b_P_o_i_n_t_e_r 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.
To change an active pointer grab, use _X_C_h_a_n_g_e_A_c_t_i_v_e_P_o_i_n_t_e_r_-
_G_r_a_b.
336600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XChangeActivePointerGrab(_d_i_s_p_l_a_y, _e_v_e_n_t___m_a_s_k, _c_u_r_s_o_r, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
unsigned int _e_v_e_n_t___m_a_s_k;
Cursor _c_u_r_s_o_r;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___m_a_s_k
Specifies which pointer events are reported to the
client. The mask is the bitwise inclusive OR of
the valid pointer event mask bits.
_c_u_r_s_o_r Specifies the cursor that is to be displayed or
_N_o_n_e.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_C_h_a_n_g_e_A_c_t_i_v_e_P_o_i_n_t_e_r_G_r_a_b function changes the specified
dynamic parameters if the pointer is actively grabbed by the
client and if the specified time is no earlier than the
last-pointer-grab time and no later than the current X
server time. This function has no effect on the passive
parameters of an _X_G_r_a_b_B_u_t_t_o_n. The interpretation of
event_mask and cursor is the same as described in _X_G_r_a_b_-
_P_o_i_n_t_e_r.
_X_C_h_a_n_g_e_A_c_t_i_v_e_P_o_i_n_t_e_r_G_r_a_b can generate _B_a_d_C_u_r_s_o_r and _B_a_d_V_a_l_u_e
errors.
To grab a pointer button, use _X_G_r_a_b_B_u_t_t_o_n.
336611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XGrabButton(_d_i_s_p_l_a_y, _b_u_t_t_o_n, _m_o_d_i_f_i_e_r_s, _g_r_a_b___w_i_n_d_o_w, _o_w_n_e_r___e_v_e_n_t_s, _e_v_e_n_t___m_a_s_k,
_p_o_i_n_t_e_r___m_o_d_e, _k_e_y_b_o_a_r_d___m_o_d_e, _c_o_n_f_i_n_e___t_o, _c_u_r_s_o_r)
Display *_d_i_s_p_l_a_y;
unsigned int _b_u_t_t_o_n;
unsigned int _m_o_d_i_f_i_e_r_s;
Window _g_r_a_b___w_i_n_d_o_w;
Bool _o_w_n_e_r___e_v_e_n_t_s;
unsigned int _e_v_e_n_t___m_a_s_k;
int _p_o_i_n_t_e_r___m_o_d_e, _k_e_y_b_o_a_r_d___m_o_d_e;
Window _c_o_n_f_i_n_e___t_o;
Cursor _c_u_r_s_o_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_b_u_t_t_o_n Specifies the pointer button that is to be grabbed
or _A_n_y_B_u_t_t_o_n.
_m_o_d_i_f_i_e_r_s Specifies the set of keymasks or _A_n_y_M_o_d_i_f_i_e_r. The
mask is the bitwise inclusive OR of the valid key-
mask bits.
_g_r_a_b___w_i_n_d_o_w
Specifies the grab window.
_o_w_n_e_r___e_v_e_n_t_s
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.
_e_v_e_n_t___m_a_s_k
Specifies which pointer events are reported to the
client. The mask is the bitwise inclusive OR of
the valid pointer event mask bits.
_p_o_i_n_t_e_r___m_o_d_e
Specifies further processing of pointer events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_k_e_y_b_o_a_r_d___m_o_d_e
Specifies further processing of keyboard events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_c_o_n_f_i_n_e___t_o
Specifies the window to confine the pointer in or
_N_o_n_e.
_c_u_r_s_o_r Specifies the cursor that is to be displayed or
_N_o_n_e.
││__
The _X_G_r_a_b_B_u_t_t_o_n function establishes a passive grab. In the
336622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
future, the pointer is actively grabbed (as for _X_G_r_a_b_-
_P_o_i_n_t_e_r), the last-pointer-grab time is set to the time at
which the button was pressed (as transmitted in the _B_u_t_t_o_n_-
_P_r_e_s_s event), and the _B_u_t_t_o_n_P_r_e_s_s event is reported if all
of the following conditions are true:
· The pointer is not grabbed, and the specified button is
logically pressed when the specified modifier keys are
logically down, and no other buttons or modifier keys
are logically down.
· The grab_window contains the pointer.
· The confine_to window (if any) is viewable.
· A passive grab on the same button/key combination does
not exist on any ancestor of grab_window.
The interpretation of the remaining arguments is as for
_X_G_r_a_b_P_o_i_n_t_e_r. 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).
Note that the logical state of a device (as seen by client
applications) may lag the physical state if device event
processing is frozen.
This request overrides all previous grabs by the same client
on the same button/key combinations on the same window. A
modifiers of _A_n_y_M_o_d_i_f_i_e_r 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 KeyCodes. A
button of _A_n_y_B_u_t_t_o_n 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.
If some other client has already issued an _X_G_r_a_b_B_u_t_t_o_n with
the same button/key combination on the same window, a _B_a_d_A_c_-
_c_e_s_s error results. When using _A_n_y_M_o_d_i_f_i_e_r or _A_n_y_B_u_t_t_o_n,
the request fails completely, and a _B_a_d_A_c_c_e_s_s error results
(no grabs are established) if there is a conflicting grab
for any combination. _X_G_r_a_b_B_u_t_t_o_n has no effect on an active
grab.
_X_G_r_a_b_B_u_t_t_o_n can generate _B_a_d_C_u_r_s_o_r, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
errors.
To ungrab a pointer button, use _X_U_n_g_r_a_b_B_u_t_t_o_n.
336633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XUngrabButton(_d_i_s_p_l_a_y, _b_u_t_t_o_n, _m_o_d_i_f_i_e_r_s, _g_r_a_b___w_i_n_d_o_w)
Display *_d_i_s_p_l_a_y;
unsigned int _b_u_t_t_o_n;
unsigned int _m_o_d_i_f_i_e_r_s;
Window _g_r_a_b___w_i_n_d_o_w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_b_u_t_t_o_n Specifies the pointer button that is to be
released or _A_n_y_B_u_t_t_o_n.
_m_o_d_i_f_i_e_r_s Specifies the set of keymasks or _A_n_y_M_o_d_i_f_i_e_r. The
mask is the bitwise inclusive OR of the valid key-
mask bits.
_g_r_a_b___w_i_n_d_o_w
Specifies the grab window.
││__
The _X_U_n_g_r_a_b_B_u_t_t_o_n function releases the passive button/key
combination on the specified window if it was grabbed by
this client. A modifiers of _A_n_y_M_o_d_i_f_i_e_r is equivalent to
issuing the ungrab request for all possible modifier combi-
nations, including the combination of no modifiers. A but-
ton of _A_n_y_B_u_t_t_o_n is equivalent to issuing the request for
all possible buttons. _X_U_n_g_r_a_b_B_u_t_t_o_n has no effect on an
active grab.
_X_U_n_g_r_a_b_B_u_t_t_o_n can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
1122..22.. KKeeyybbooaarrdd GGrraabbbbiinngg
Xlib provides functions that you can use to grab or ungrab
the keyboard as well as allow events.
For many functions in this section, you pass keymask bits.
The valid keymask bits are: _S_h_i_f_t_M_a_s_k, _L_o_c_k_M_a_s_k, _C_o_n_t_r_o_l_-
_M_a_s_k, _M_o_d_1_M_a_s_k, _M_o_d_2_M_a_s_k, _M_o_d_3_M_a_s_k, _M_o_d_4_M_a_s_k, and _M_o_d_5_M_a_s_k.
To grab the keyboard, use _X_G_r_a_b_K_e_y_b_o_a_r_d.
336644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XGrabKeyboard(_d_i_s_p_l_a_y, _g_r_a_b___w_i_n_d_o_w, _o_w_n_e_r___e_v_e_n_t_s, _p_o_i_n_t_e_r___m_o_d_e, _k_e_y_b_o_a_r_d___m_o_d_e, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Window _g_r_a_b___w_i_n_d_o_w;
Bool _o_w_n_e_r___e_v_e_n_t_s;
int _p_o_i_n_t_e_r___m_o_d_e, _k_e_y_b_o_a_r_d___m_o_d_e;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_r_a_b___w_i_n_d_o_w
Specifies the grab window.
_o_w_n_e_r___e_v_e_n_t_s
Specifies a Boolean value that indicates whether
the keyboard events are to be reported as usual.
_p_o_i_n_t_e_r___m_o_d_e
Specifies further processing of pointer events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_k_e_y_b_o_a_r_d___m_o_d_e
Specifies further processing of keyboard events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_G_r_a_b_K_e_y_b_o_a_r_d function actively grabs control of the
keyboard and generates _F_o_c_u_s_I_n and _F_o_c_u_s_O_u_t events. Further
key events are reported only to the grabbing client.
_X_G_r_a_b_K_e_y_b_o_a_r_d overrides any active keyboard grab by this
client. If owner_events is _F_a_l_s_e, all generated key events
are reported with respect to grab_window. If owner_events
is _T_r_u_e 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
_K_e_y_P_r_e_s_s and _K_e_y_R_e_l_e_a_s_e events are always reported, indepen-
dent of any event selection made by the client.
If the keyboard_mode argument is _G_r_a_b_M_o_d_e_A_s_y_n_c, keyboard
event processing continues as usual. If the keyboard is
currently frozen by this client, then processing of keyboard
events is resumed. If the keyboard_mode argument is _G_r_a_b_-
_M_o_d_e_S_y_n_c, 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 _X_A_l_l_o_w_E_v_e_n_t_s call or until the keyboard grab is
released. Actual keyboard changes are not lost while the
keyboard is frozen; they are simply queued in the server for
later processing.
336655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
If pointer_mode is _G_r_a_b_M_o_d_e_A_s_y_n_c, pointer event processing
is unaffected by activation of the grab. If pointer_mode is
_G_r_a_b_M_o_d_e_S_y_n_c, 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 _X_A_l_l_o_w_E_v_e_n_t_s call or until the keyboard grab is
released. Actual pointer changes are not lost while the
pointer is frozen; they are simply queued in the server for
later processing.
If the keyboard is actively grabbed by some other client,
_X_G_r_a_b_K_e_y_b_o_a_r_d fails and returns _A_l_r_e_a_d_y_G_r_a_b_b_e_d. If
grab_window is not viewable, it fails and returns _G_r_a_b_-
_N_o_t_V_i_e_w_a_b_l_e. If the keyboard is frozen by an active grab of
another client, it fails and returns _G_r_a_b_F_r_o_z_e_n. If the
specified time is earlier than the last-keyboard-grab time
or later than the current X server time, it fails and
returns _G_r_a_b_I_n_v_a_l_i_d_T_i_m_e. Otherwise, the last-keyboard-grab
time is set to the specified time (_C_u_r_r_e_n_t_T_i_m_e is replaced
by the current X server time).
_X_G_r_a_b_K_e_y_b_o_a_r_d can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
To ungrab the keyboard, use _X_U_n_g_r_a_b_K_e_y_b_o_a_r_d.
__
││
XUngrabKeyboard(_d_i_s_p_l_a_y, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_U_n_g_r_a_b_K_e_y_b_o_a_r_d function releases the keyboard and any
queued events if this client has it actively grabbed from
either _X_G_r_a_b_K_e_y_b_o_a_r_d or _X_G_r_a_b_K_e_y. _X_U_n_g_r_a_b_K_e_y_b_o_a_r_d does not
release the keyboard and any queued events if the specified
time is earlier than the last-keyboard-grab time or is later
than the current X server time. It also generates _F_o_c_u_s_I_n
and _F_o_c_u_s_O_u_t events. The X server automatically performs an
_U_n_g_r_a_b_K_e_y_b_o_a_r_d request if the event window for an active
keyboard grab becomes not viewable.
To passively grab a single key of the keyboard, use
_X_G_r_a_b_K_e_y.
336666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XGrabKey(_d_i_s_p_l_a_y, _k_e_y_c_o_d_e, _m_o_d_i_f_i_e_r_s, _g_r_a_b___w_i_n_d_o_w, _o_w_n_e_r___e_v_e_n_t_s, _p_o_i_n_t_e_r___m_o_d_e,
_k_e_y_b_o_a_r_d___m_o_d_e)
Display *_d_i_s_p_l_a_y;
int _k_e_y_c_o_d_e;
unsigned int _m_o_d_i_f_i_e_r_s;
Window _g_r_a_b___w_i_n_d_o_w;
Bool _o_w_n_e_r___e_v_e_n_t_s;
int _p_o_i_n_t_e_r___m_o_d_e, _k_e_y_b_o_a_r_d___m_o_d_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_c_o_d_e Specifies the KeyCode or _A_n_y_K_e_y.
_m_o_d_i_f_i_e_r_s Specifies the set of keymasks or _A_n_y_M_o_d_i_f_i_e_r. The
mask is the bitwise inclusive OR of the valid key-
mask bits.
_g_r_a_b___w_i_n_d_o_w
Specifies the grab window.
_o_w_n_e_r___e_v_e_n_t_s
Specifies a Boolean value that indicates whether
the keyboard events are to be reported as usual.
_p_o_i_n_t_e_r___m_o_d_e
Specifies further processing of pointer events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
_k_e_y_b_o_a_r_d___m_o_d_e
Specifies further processing of keyboard events.
You can pass _G_r_a_b_M_o_d_e_S_y_n_c or _G_r_a_b_M_o_d_e_A_s_y_n_c.
││__
The _X_G_r_a_b_K_e_y function establishes a passive grab on the key-
board. In the future, the keyboard is actively grabbed (as
for _X_G_r_a_b_K_e_y_b_o_a_r_d), the last-keyboard-grab time is set to
the time at which the key was pressed (as transmitted in the
_K_e_y_P_r_e_s_s event), and the _K_e_y_P_r_e_s_s event is reported if all
of the following conditions are true:
· The keyboard is not grabbed and the specified key
(which can itself be a modifier key) is logically
pressed when the specified modifier keys are logically
down, and no other modifier keys are logically down.
· Either the grab_window is an ancestor of (or is) the
focus window, 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.
336677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The interpretation of the remaining arguments is as for
_X_G_r_a_b_K_e_y_b_o_a_r_d. 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).
Note that the logical state of a device (as seen by client
applications) may lag the physical state if device event
processing is frozen.
A modifiers argument of _A_n_y_M_o_d_i_f_i_e_r is equivalent to issuing
the request for all possible modifier combinations (includ-
ing the combination of no modifiers). It is not required
that all modifiers specified have currently assigned Key-
Codes. A keycode argument of _A_n_y_K_e_y is equivalent to issu-
ing the request for all possible KeyCodes. Otherwise, the
specified keycode must be in the range specified by min_key-
code and max_keycode in the connection setup, or a _B_a_d_V_a_l_u_e
error results.
If some other client has issued a _X_G_r_a_b_K_e_y with the same key
combination on the same window, a _B_a_d_A_c_c_e_s_s error results.
When using _A_n_y_M_o_d_i_f_i_e_r or _A_n_y_K_e_y, the request fails com-
pletely, and a _B_a_d_A_c_c_e_s_s error results (no grabs are estab-
lished) if there is a conflicting grab for any combination.
_X_G_r_a_b_K_e_y can generate _B_a_d_A_c_c_e_s_s, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
errors.
To ungrab a key, use _X_U_n_g_r_a_b_K_e_y.
__
││
XUngrabKey(_d_i_s_p_l_a_y, _k_e_y_c_o_d_e, _m_o_d_i_f_i_e_r_s, _g_r_a_b___w_i_n_d_o_w)
Display *_d_i_s_p_l_a_y;
int _k_e_y_c_o_d_e;
unsigned int _m_o_d_i_f_i_e_r_s;
Window _g_r_a_b___w_i_n_d_o_w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_c_o_d_e Specifies the KeyCode or _A_n_y_K_e_y.
_m_o_d_i_f_i_e_r_s Specifies the set of keymasks or _A_n_y_M_o_d_i_f_i_e_r. The
mask is the bitwise inclusive OR of the valid key-
mask bits.
_g_r_a_b___w_i_n_d_o_w
Specifies the grab window.
││__
The _X_U_n_g_r_a_b_K_e_y function releases the key combination on the
specified window if it was grabbed by this client. It has
336688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
no effect on an active grab. A modifiers of _A_n_y_M_o_d_i_f_i_e_r is
equivalent to issuing the request for all possible modifier
combinations (including the combination of no modifiers). A
keycode argument of _A_n_y_K_e_y is equivalent to issuing the
request for all possible key codes.
_X_U_n_g_r_a_b_K_e_y can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
1122..33.. RReessuummiinngg EEvveenntt PPrroocceessssiinngg
The previous sections discussed grab mechanisms with which
processing of events by the server can be temporarily sus-
pended. This section describes the mechanism for resuming
event processing.
To allow further events to be processed when the device has
been frozen, use _X_A_l_l_o_w_E_v_e_n_t_s.
__
││
XAllowEvents(_d_i_s_p_l_a_y, _e_v_e_n_t___m_o_d_e, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
int _e_v_e_n_t___m_o_d_e;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___m_o_d_e
Specifies the event mode. You can pass _A_s_y_n_c_-
_P_o_i_n_t_e_r, _S_y_n_c_P_o_i_n_t_e_r, _A_s_y_n_c_K_e_y_b_o_a_r_d, _S_y_n_c_K_e_y_b_o_a_r_d,
_R_e_p_l_a_y_P_o_i_n_t_e_r, _R_e_p_l_a_y_K_e_y_b_o_a_r_d, _A_s_y_n_c_B_o_t_h, or
_S_y_n_c_B_o_t_h.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_A_l_l_o_w_E_v_e_n_t_s 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 is later than the current X server time. Depending on
the event_mode argument, the following occurs:
_A_s_y_n_c_P_o_i_n_t_e_r If the pointer is frozen by the client,
pointer event processing continues as usual.
If the pointer is frozen twice by the client
on behalf of two separate grabs, _A_s_y_n_c_P_o_i_n_t_e_r
thaws for both. _A_s_y_n_c_P_o_i_n_t_e_r has no effect
if the pointer is not frozen by the client,
but the pointer need not be grabbed by the
client.
336699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_S_y_n_c_P_o_i_n_t_e_r If the pointer is frozen and actively grabbed
by the client, pointer event processing con-
tinues as usual until the next _B_u_t_t_o_n_P_r_e_s_s or
_B_u_t_t_o_n_R_e_l_e_a_s_e event is reported to the
client. At this time, the pointer again
appears to freeze. However, if the reported
event causes the pointer grab to be released,
the pointer does not freeze. _S_y_n_c_P_o_i_n_t_e_r has
no effect if the pointer is not frozen by the
client or if the pointer is not grabbed by
the client.
_R_e_p_l_a_y_- If the pointer is actively grabbed by the
_P_o_i_n_t_e_r client and is frozen as the result of an
event having been sent to the client (either
from the activation of an _X_G_r_a_b_B_u_t_t_o_n or from
a previous _X_A_l_l_o_w_E_v_e_n_t_s with mode _S_y_n_c_P_o_i_n_t_e_r
but not from an _X_G_r_a_b_P_o_i_n_t_e_r), the pointer
grab is released and that event is completely
reprocessed. This time, however, the func-
tion ignores any passive grabs at or above
(toward the root of) the grab_window of the
grab just released. The request has no
effect if the pointer is not grabbed by the
client or if the pointer is not frozen as the
result of an event.
_A_s_y_n_c_K_e_y_- If the keyboard is frozen by the client, key-
_b_o_a_r_d board event processing continues as usual.
If the keyboard is frozen twice by the client
on behalf of two separate grabs, _A_s_y_n_c_K_e_y_-
_b_o_a_r_d thaws for both. _A_s_y_n_c_K_e_y_b_o_a_r_d has no
effect if the keyboard is not frozen by the
client, but the keyboard need not be grabbed
by the client.
_S_y_n_c_K_e_y_b_o_a_r_d If the keyboard is frozen and actively
grabbed by the client, keyboard event pro-
cessing continues as usual until the next
_K_e_y_P_r_e_s_s or _K_e_y_R_e_l_e_a_s_e event is reported to
the client. At this time, the keyboard again
appears to freeze. However, if the reported
event causes the keyboard grab to be
released, the keyboard does not freeze.
_S_y_n_c_K_e_y_b_o_a_r_d has no effect if the keyboard is
not frozen by the client or if the keyboard
is not grabbed by the client.
337700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_R_e_p_l_a_y_K_e_y_- If the keyboard is actively grabbed by the
_b_o_a_r_d client and is frozen as the result of an
event having been sent to the client (either
from the activation of an _X_G_r_a_b_K_e_y or from a
previous _X_A_l_l_o_w_E_v_e_n_t_s with mode _S_y_n_c_K_e_y_b_o_a_r_d
but not from an _X_G_r_a_b_K_e_y_b_o_a_r_d), the keyboard
grab is released and that event is completely
reprocessed. This time, however, the func-
tion ignores any passive grabs at or above
(toward the root of) the grab_window of the
grab just released. The request has no
effect if the keyboard is not grabbed by the
client or if the keyboard is not frozen as
the result of an event.
_S_y_n_c_B_o_t_h If both pointer and keyboard are frozen by
the client, event processing for both devices
continues as usual until the next _B_u_t_t_o_n_-
_P_r_e_s_s, _B_u_t_t_o_n_R_e_l_e_a_s_e, _K_e_y_P_r_e_s_s, or _K_e_y_R_e_l_e_a_s_e
event is reported to the client for a grabbed
device (button event for the pointer, key
event for the keyboard), at which time the
devices again appear to freeze. However, if
the reported event causes the grab to be
released, then the devices do not freeze (but
if the other device is still grabbed, then a
subsequent event for it will still cause both
devices to freeze). _S_y_n_c_B_o_t_h has no effect
unless both pointer and keyboard are frozen
by the client. If the pointer or keyboard is
frozen twice by the client on behalf of two
separate grabs, _S_y_n_c_B_o_t_h thaws for both (but
a subsequent freeze for _S_y_n_c_B_o_t_h will only
freeze each device once).
_A_s_y_n_c_B_o_t_h If the pointer and the keyboard are frozen by
the client, event processing for both devices
continues as usual. If a device is frozen
twice by the client on behalf of two separate
grabs, _A_s_y_n_c_B_o_t_h thaws for both. _A_s_y_n_c_B_o_t_h
has no effect unless both pointer and key-
board are frozen by the client.
_A_s_y_n_c_P_o_i_n_t_e_r, _S_y_n_c_P_o_i_n_t_e_r, and _R_e_p_l_a_y_P_o_i_n_t_e_r have no effect
on the processing of keyboard events. _A_s_y_n_c_K_e_y_b_o_a_r_d, _S_y_n_c_K_-
_e_y_b_o_a_r_d, and _R_e_p_l_a_y_K_e_y_b_o_a_r_d have no effect on the processing
of pointer events. It is possible for both a pointer grab
and a keyboard grab (by the same or different clients) to be
active simultaneously. If a device is frozen on behalf of
either grab, no event processing is performed for the
device. It is possible for a single device to be frozen
because of both grabs. In this case, the freeze must be
released on behalf of both grabs before events can again be
processed. If a device is frozen twice by a single client,
then a single _A_l_l_o_w_E_v_e_n_t_s releases both.
337711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_A_l_l_o_w_E_v_e_n_t_s can generate a _B_a_d_V_a_l_u_e error.
1122..44.. MMoovviinngg tthhee PPooiinntteerr
Although movement of the pointer normally should be left to
the control of the end user, sometimes it is necessary to
move the pointer to a new position under program control.
To move the pointer to an arbitrary point in a window, use
_X_W_a_r_p_P_o_i_n_t_e_r.
__
││
XWarpPointer(_d_i_s_p_l_a_y, _s_r_c___w, _d_e_s_t___w, _s_r_c___x, _s_r_c___y, _s_r_c___w_i_d_t_h, _s_r_c___h_e_i_g_h_t, _d_e_s_t___x,
_d_e_s_t___y)
Display *_d_i_s_p_l_a_y;
Window _s_r_c___w, _d_e_s_t___w;
int _s_r_c___x, _s_r_c___y;
unsigned int _s_r_c___w_i_d_t_h, _s_r_c___h_e_i_g_h_t;
int _d_e_s_t___x, _d_e_s_t___y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_r_c___w Specifies the source window or _N_o_n_e.
_d_e_s_t___w Specifies the destination window or _N_o_n_e.
_s_r_c___x
_s_r_c___y
_s_r_c___w_i_d_t_h
_s_r_c___h_e_i_g_h_t
Specify a rectangle in the source window.
_d_e_s_t___x
_d_e_s_t___y Specify the x and y coordinates within the desti-
nation window.
││__
If dest_w is _N_o_n_e, _X_W_a_r_p_P_o_i_n_t_e_r moves the pointer by the
offsets (dest_x, dest_y) relative to the current position of
the pointer. If dest_w is a window, _X_W_a_r_p_P_o_i_n_t_e_r moves the
pointer to the offsets (dest_x, dest_y) relative to the ori-
gin of dest_w. However, if src_w is a window, the move only
takes place if the window src_w contains the pointer and if
the specified rectangle of src_w contains the pointer.
The src_x and src_y coordinates are relative to the origin
of src_w. If src_height is zero, it is replaced with the
current height of src_w minus src_y. If src_width is zero,
it is replaced with the current width of src_w minus src_x.
There is seldom any reason for calling this function. The
pointer should normally be left to the user. If you do use
337722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
this function, however, it generates events just as if the
user had instantaneously moved the pointer from one position
to another. Note that you cannot use _X_W_a_r_p_P_o_i_n_t_e_r to move
the pointer outside the confine_to window of an active
pointer grab. An attempt to do so will only move the
pointer as far as the closest edge of the confine_to window.
_X_W_a_r_p_P_o_i_n_t_e_r can generate a _B_a_d_W_i_n_d_o_w error.
1122..55.. CCoonnttrroolllliinngg IInnppuutt FFooccuuss
Xlib provides functions that you can use to set and get the
input focus. The input focus is a shared resource, and
cooperation among clients is required for correct interac-
tion. See the _I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l
for input focus policy.
To set the input focus, use _X_S_e_t_I_n_p_u_t_F_o_c_u_s.
__
││
XSetInputFocus(_d_i_s_p_l_a_y, _f_o_c_u_s, _r_e_v_e_r_t___t_o, _t_i_m_e)
Display *_d_i_s_p_l_a_y;
Window _f_o_c_u_s;
int _r_e_v_e_r_t___t_o;
Time _t_i_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_c_u_s Specifies the window, _P_o_i_n_t_e_r_R_o_o_t, or _N_o_n_e.
_r_e_v_e_r_t___t_o Specifies where the input focus reverts to if the
window becomes not viewable. You can pass _R_e_v_e_r_t_-
_T_o_P_a_r_e_n_t, _R_e_v_e_r_t_T_o_P_o_i_n_t_e_r_R_o_o_t, or _R_e_v_e_r_t_T_o_N_o_n_e.
_t_i_m_e Specifies the time. You can pass either a times-
tamp or _C_u_r_r_e_n_t_T_i_m_e.
││__
The _X_S_e_t_I_n_p_u_t_F_o_c_u_s function changes the input focus and the
last-focus-change time. It has no effect if the specified
time is earlier than the current last-focus-change time or
is later than the current X server time. Otherwise, the
last-focus-change time is set to the specified time (_C_u_r_-
_r_e_n_t_T_i_m_e is replaced by the current X server time). _X_S_e_t_-
_I_n_p_u_t_F_o_c_u_s causes the X server to generate _F_o_c_u_s_I_n and _F_o_c_u_-
_s_O_u_t events.
Depending on the focus argument, the following occurs:
· If focus is _N_o_n_e, all keyboard events are discarded
until a new focus window is set, and the revert_to
argument is ignored.
337733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· If focus is a window, it becomes the keyboard's focus
window. If a generated keyboard event would normally
be reported to this window or one of its inferiors, the
event is reported as usual. Otherwise, the event is
reported relative to the focus window.
· If focus is _P_o_i_n_t_e_r_R_o_o_t, the focus window is dynami-
cally taken to be the root window of whatever screen
the pointer is on at each keyboard event. In this
case, the revert_to argument is ignored.
The specified focus window must be viewable at the time
_X_S_e_t_I_n_p_u_t_F_o_c_u_s is called, or a _B_a_d_M_a_t_c_h error results. If
the focus window later becomes not viewable, the X server
evaluates the revert_to argument to determine the new focus
window as follows:
· If revert_to is _R_e_v_e_r_t_T_o_P_a_r_e_n_t, the focus reverts to
the parent (or the closest viewable ancestor), and the
new revert_to value is taken to be _R_e_v_e_r_t_T_o_N_o_n_e.
· If revert_to is _R_e_v_e_r_t_T_o_P_o_i_n_t_e_r_R_o_o_t or _R_e_v_e_r_t_T_o_N_o_n_e,
the focus reverts to _P_o_i_n_t_e_r_R_o_o_t or _N_o_n_e, respectively.
When the focus reverts, the X server generates _F_o_c_u_s_I_n
and _F_o_c_u_s_O_u_t events, but the last-focus-change time is
not affected.
_X_S_e_t_I_n_p_u_t_F_o_c_u_s can generate _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_-
_d_o_w errors.
To obtain the current input focus, use _X_G_e_t_I_n_p_u_t_F_o_c_u_s.
__
││
XGetInputFocus(_d_i_s_p_l_a_y, _f_o_c_u_s___r_e_t_u_r_n, _r_e_v_e_r_t___t_o___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window *_f_o_c_u_s___r_e_t_u_r_n;
int *_r_e_v_e_r_t___t_o___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_c_u_s___r_e_t_u_r_n
Returns the focus window, _P_o_i_n_t_e_r_R_o_o_t, or _N_o_n_e.
_r_e_v_e_r_t___t_o___r_e_t_u_r_n
Returns the current focus state (_R_e_v_e_r_t_T_o_P_a_r_e_n_t,
_R_e_v_e_r_t_T_o_P_o_i_n_t_e_r_R_o_o_t, or _R_e_v_e_r_t_T_o_N_o_n_e).
││__
The _X_G_e_t_I_n_p_u_t_F_o_c_u_s function returns the focus window and the
current focus state.
337744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1122..66.. MMaanniippuullaattiinngg tthhee KKeeyybbooaarrdd aanndd PPooiinntteerr SSeettttiinnggss
Xlib provides functions that you can use to change the key-
board control, obtain a list of the auto-repeat keys, turn
keyboard auto-repeat on or off, ring the bell, set or obtain
the pointer button or keyboard mapping, and obtain a bit
vector for the keyboard.
This section discusses the user-preference options of bell,
key click, pointer behavior, and so on. The default values
for many of these options are server dependent. Not all
implementations will actually be able to control all of
these parameters.
The _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function changes control of a
keyboard and operates on a _X_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l structure:
__
││
/* Mask bits for ChangeKeyboardControl */
#define _K_B_K_e_y_C_l_i_c_k_P_e_r_c_e_n_t (1L<<0)
#define _K_B_B_e_l_l_P_e_r_c_e_n_t (1L<<1)
#define _K_B_B_e_l_l_P_i_t_c_h (1L<<2)
#define _K_B_B_e_l_l_D_u_r_a_t_i_o_n (1L<<3)
#define _K_B_L_e_d (1L<<4)
#define _K_B_L_e_d_M_o_d_e (1L<<5)
#define _K_B_K_e_y (1L<<6)
#define _K_B_A_u_t_o_R_e_p_e_a_t_M_o_d_e (1L<<7)
/* Values */
typedef struct {
int key_click_percent;
int bell_percent;
int bell_pitch;
int bell_duration;
int led;
int led_mode; /* LedModeOn, LedModeOff */
int key;
int auto_repeat_mode;/* AutoRepeatModeOff, AutoRepeatModeOn,
AutoRepeatModeDefault */
} XKeyboardControl;
││__
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_a_d_V_a_l_u_e error.
The bell_percent sets the base volume for the bell between 0
(off) and 100 (loud) inclusive, if possible. A setting of
-1 restores the default. Other negative values generate a
337755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_B_a_d_V_a_l_u_e error. The bell_pitch member sets the pitch (spec-
ified in Hz) of the bell, if possible. A setting of -1
restores the default. Other negative values generate a _B_a_d_-
_V_a_l_u_e error. The bell_duration member sets the duration of
the bell specified in milliseconds, if possible. A setting
of -1 restores the default. Other negative values generate
a _B_a_d_V_a_l_u_e error.
If both the led_mode and led members are specified, the
state of that LED is changed, if possible. The led_mode
member can be set to _L_e_d_M_o_d_e_O_n or _L_e_d_M_o_d_e_O_f_f. If only
led_mode is specified, the state of 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_a_d_M_a_t_c_h error results.
If both the auto_repeat_mode and key members are specified,
the auto_repeat_mode of that key is changed (according to
_A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n, _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f, or _A_u_t_o_R_e_p_e_a_t_M_o_d_e_D_e_-
_f_a_u_l_t), if possible. If only auto_repeat_mode is specified,
the global auto_repeat_mode for the entire keyboard is
changed, if possible, and does not affect the per-key set-
tings. If a key is specified without an auto_repeat_mode, a
_B_a_d_M_a_t_c_h error results. Each key has an individual mode of
whether or not it should auto-repeat and a default setting
for the mode. In addition, there is a global mode of
whether auto-repeat should be enabled or not and a default
setting for that mode. When global mode is _A_u_t_o_R_e_p_e_a_t_M_o_d_-
_e_O_n, keys should obey their individual auto-repeat modes.
When global mode is _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f, no keys should auto-
repeat. An auto-repeating key generates alternating _K_e_y_-
_P_r_e_s_s and _K_e_y_R_e_l_e_a_s_e events. When a key is used as a modi-
fier, it is desirable for the key not to auto-repeat,
regardless of its auto-repeat setting.
A bell generator connected with the console but not directly
on a keyboard is treated as if it were part of the keyboard.
The order in which controls are verified and altered is
server-dependent. If an error is generated, a subset of the
controls may have been altered.
337766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XChangeKeyboardControl(_d_i_s_p_l_a_y, _v_a_l_u_e___m_a_s_k, _v_a_l_u_e_s)
Display *_d_i_s_p_l_a_y;
unsigned long _v_a_l_u_e___m_a_s_k;
XKeyboardControl *_v_a_l_u_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_v_a_l_u_e___m_a_s_k
Specifies which controls to change. This mask is
the bitwise inclusive OR of the valid control mask
bits.
_v_a_l_u_e_s Specifies one value for each bit set to 1 in the
mask.
││__
The _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function controls the keyboard
characteristics defined by the _X_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l structure.
The value_mask argument specifies which values are to be
changed.
_X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l can generate _B_a_d_M_a_t_c_h and _B_a_d_V_a_l_u_e
errors.
To obtain the current control values for the keyboard, use
_X_G_e_t_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l.
__
││
XGetKeyboardControl(_d_i_s_p_l_a_y, _v_a_l_u_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XKeyboardState *_v_a_l_u_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_v_a_l_u_e_s___r_e_t_u_r_n
Returns the current keyboard controls in the spec-
ified _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure.
││__
The _X_G_e_t_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function returns the current control
values for the keyboard to the _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure.
337777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct {
int key_click_percent;
int bell_percent;
unsigned int bell_pitch, bell_duration;
unsigned long led_mask;
int global_auto_repeat;
char auto_repeats[32];
} XKeyboardState;
││__
For the LEDs, the least significant bit of led_mask corre-
sponds to LED one, and each bit set to 1 in led_mask indi-
cates an LED that is lit. The global_auto_repeat member can
be set to _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n or _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f. The
auto_repeats member is a bit vector. Each bit set to 1
indicates that auto-repeat is enabled for the corresponding
key. 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.
To turn on keyboard auto-repeat, use _X_A_u_t_o_R_e_p_e_a_t_O_n.
__
││
XAutoRepeatOn(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_A_u_t_o_R_e_p_e_a_t_O_n function turns on auto-repeat for the key-
board on the specified display.
To turn off keyboard auto-repeat, use _X_A_u_t_o_R_e_p_e_a_t_O_f_f.
__
││
XAutoRepeatOff(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_A_u_t_o_R_e_p_e_a_t_O_f_f function turns off auto-repeat for the
keyboard on the specified display.
To ring the bell, use _X_B_e_l_l.
337788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XBell(_d_i_s_p_l_a_y, _p_e_r_c_e_n_t)
Display *_d_i_s_p_l_a_y;
int _p_e_r_c_e_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_e_r_c_e_n_t Specifies the volume for the bell, which can range
from -100 to 100 inclusive.
││__
The _X_B_e_l_l function rings the bell on the keyboard on the
specified display, if possible. The specified volume is
relative to the base volume for the keyboard. If the value
for the percent argument is not in the range -100 to 100
inclusive, a _B_a_d_V_a_l_u_e error results. The volume at which
the bell rings when the percent argument is nonnegative is:
base - [(base * percent) / 100] + percent
The volume at which the bell rings when the percent argument
is negative is:
base + [(base * percent) / 100]
To change the base volume of the bell, use _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_-
_C_o_n_t_r_o_l.
_X_B_e_l_l can generate a _B_a_d_V_a_l_u_e error.
To obtain a bit vector that describes the state of the key-
board, use _X_Q_u_e_r_y_K_e_y_m_a_p.
__
││
XQueryKeymap(_d_i_s_p_l_a_y, _k_e_y_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char _k_e_y_s___r_e_t_u_r_n[32];
_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_s___r_e_t_u_r_n
Returns an array of bytes that identifies which
keys are pressed down. Each bit represents one
key of the keyboard.
││__
The _X_Q_u_e_r_y_K_e_y_m_a_p function returns a bit vector for the logi-
cal 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 with the least significant
337799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
bit in the byte representing key 8N.
Note that the logical state of a device (as seen by client
applications) may lag the physical state if device event
processing is frozen.
To set the mapping of the pointer buttons, use _X_S_e_t_P_o_i_n_t_-
_e_r_M_a_p_p_i_n_g.
__
││
int XSetPointerMapping(_d_i_s_p_l_a_y, _m_a_p, _n_m_a_p)
Display *_d_i_s_p_l_a_y;
unsigned char _m_a_p[];
int _n_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_a_p Specifies the mapping list.
_n_m_a_p Specifies the number of items in the mapping list.
││__
The _X_S_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g function sets the mapping of the
pointer. If it succeeds, the X server generates a _M_a_p_p_i_n_g_-
_N_o_t_i_f_y event, and _X_S_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g returns _M_a_p_p_i_n_g_S_u_c_c_e_s_s.
Element map[i] defines the logical button number for the
physical button i+1. The length of the list must be the
same as _X_G_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g would return, or a _B_a_d_V_a_l_u_e error
results. A zero element disables a button, and elements are
not restricted in value by the number of physical buttons.
However, no two elements can have the same nonzero value, or
a _B_a_d_V_a_l_u_e error results. If any of the buttons to be
altered are logically in the down state, _X_S_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g
returns _M_a_p_p_i_n_g_B_u_s_y, and the mapping is not changed.
_X_S_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g can generate a _B_a_d_V_a_l_u_e error.
To get the pointer mapping, use _X_G_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g.
338800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XGetPointerMapping(_d_i_s_p_l_a_y, _m_a_p___r_e_t_u_r_n, _n_m_a_p)
Display *_d_i_s_p_l_a_y;
unsigned char _m_a_p___r_e_t_u_r_n[];
int _n_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_a_p___r_e_t_u_r_n
Returns the mapping list.
_n_m_a_p Specifies the number of items in the mapping list.
││__
The _X_G_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g function returns the current mapping
of the pointer. Pointer buttons are numbered starting from
one. _X_G_e_t_P_o_i_n_t_e_r_M_a_p_p_i_n_g returns the number of physical but-
tons actually on the pointer. The nominal mapping for a
pointer is map[i]=i+1. The nmap argument specifies the
length of the array where the pointer mapping is returned,
and only the first nmap elements are returned in map_return.
To control the pointer's interactive feel, use _X_C_h_a_n_g_e_P_o_i_n_t_-
_e_r_C_o_n_t_r_o_l.
338811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XChangePointerControl(_d_i_s_p_l_a_y, _d_o___a_c_c_e_l, _d_o___t_h_r_e_s_h_o_l_d, _a_c_c_e_l___n_u_m_e_r_a_t_o_r,
_a_c_c_e_l___d_e_n_o_m_i_n_a_t_o_r, _t_h_r_e_s_h_o_l_d)
Display *_d_i_s_p_l_a_y;
Bool _d_o___a_c_c_e_l, _d_o___t_h_r_e_s_h_o_l_d;
int _a_c_c_e_l___n_u_m_e_r_a_t_o_r, _a_c_c_e_l___d_e_n_o_m_i_n_a_t_o_r;
int _t_h_r_e_s_h_o_l_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_o___a_c_c_e_l Specifies a Boolean value that controls whether
the values for the accel_numerator or accel_denom-
inator are used.
_d_o___t_h_r_e_s_h_o_l_d
Specifies a Boolean value that controls whether
the value for the threshold is used.
_a_c_c_e_l___n_u_m_e_r_a_t_o_r
Specifies the numerator for the acceleration mul-
tiplier.
_a_c_c_e_l___d_e_n_o_m_i_n_a_t_o_r
Specifies the denominator for the acceleration
multiplier.
_t_h_r_e_s_h_o_l_d Specifies the acceleration threshold.
││__
The _X_C_h_a_n_g_e_P_o_i_n_t_e_r_C_o_n_t_r_o_l function defines how the pointing
device moves. The acceleration, expressed as a fraction, is
a 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. Accel-
eration 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 _T_r_u_e for the pointer values
to be set, or the parameters are unchanged. Negative values
(other than -1) generate a _B_a_d_V_a_l_u_e error, as does a zero
value for the accel_denominator argument.
_X_C_h_a_n_g_e_P_o_i_n_t_e_r_C_o_n_t_r_o_l can generate a _B_a_d_V_a_l_u_e error.
To get the current pointer parameters, use _X_G_e_t_P_o_i_n_t_e_r_C_o_n_-
_t_r_o_l.
338822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XGetPointerControl(_d_i_s_p_l_a_y, _a_c_c_e_l___n_u_m_e_r_a_t_o_r___r_e_t_u_r_n, _a_c_c_e_l___d_e_n_o_m_i_n_a_t_o_r___r_e_t_u_r_n,
_t_h_r_e_s_h_o_l_d___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_a_c_c_e_l___n_u_m_e_r_a_t_o_r___r_e_t_u_r_n, *_a_c_c_e_l___d_e_n_o_m_i_n_a_t_o_r___r_e_t_u_r_n;
int *_t_h_r_e_s_h_o_l_d___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_a_c_c_e_l___n_u_m_e_r_a_t_o_r___r_e_t_u_r_n
Returns the numerator for the acceleration multi-
plier.
_a_c_c_e_l___d_e_n_o_m_i_n_a_t_o_r___r_e_t_u_r_n
Returns the denominator for the acceleration mul-
tiplier.
_t_h_r_e_s_h_o_l_d___r_e_t_u_r_n
Returns the acceleration threshold.
││__
The _X_G_e_t_P_o_i_n_t_e_r_C_o_n_t_r_o_l function returns the pointer's cur-
rent acceleration multiplier and acceleration threshold.
1122..77.. MMaanniippuullaattiinngg tthhee KKeeyybbooaarrdd EEnnccooddiinngg
A KeyCode represents a physical (or logical) key. KeyCodes
lie in the inclusive range [8,255]. A KeyCode value carries
no intrinsic information, although server implementors may
attempt to encode geometry (for example, matrix) information
in some fashion so that it can be interpreted in a server-
dependent fashion. The mapping between keys and KeyCodes
cannot be changed.
A KeySym is an encoding of a symbol on the cap of a key.
The set of defined KeySyms includes the ISO Latin character
sets (1-4), Katakana, Arabic, Cyrillic, Greek, Technical,
Special, Publishing, APL, Hebrew, Thai, Korean and a miscel-
lany of keys found on keyboards (Return, Help, Tab, and so
on). To the extent possible, these sets are derived from
international standards. In areas where no standards exist,
some of these sets are derived from Digital Equipment Corpo-
ration standards. The list of defined symbols can be found
in <_X_1_1_/_k_e_y_s_y_m_d_e_f_._h>. Unfortunately, some C preprocessors
have limits on the number of defined symbols. If you must
use KeySyms not in the Latin 1-4, Greek, and miscellaneous
classes, you may have to define a symbol for those sets.
Most applications usually only include <_X_1_1_/_k_e_y_s_y_m_._h>, which
defines symbols for ISO Latin 1-4, Greek, and miscellaneous.
A list of KeySyms is associated with each KeyCode. The list
is intended to convey the set of symbols on the correspond-
ing key. If the list (ignoring trailing _N_o_S_y_m_b_o_l entries)
338833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
is a single KeySym ``_K'', then the list is treated as if it
were the list ``_K NoSymbol _K NoSymbol''. If the list
(ignoring trailing _N_o_S_y_m_b_o_l entries) is a pair of KeySyms
``_K_1 _K_2'', then the list is treated as if it were the list
``_K_1 _K_2 _K_1 _K_2''. If the list (ignoring trailing _N_o_S_y_m_b_o_l
entries) is a triple of KeySyms ``_K_1 _K_2 _K_3'', then the list
is treated as if it were the list ``_K_1 _K_2 _K_3 NoSymbol''.
When an explicit ``void'' element is desired in the list,
the value _V_o_i_d_S_y_m_b_o_l can be used.
The first four elements of the list are split into two
groups of KeySyms. Group 1 contains the first and second
KeySyms; Group 2 contains the third and fourth KeySyms.
Within each group, if the second element of the group is
_N_o_S_y_m_b_o_l, then the group should be treated as if the second
element were the same as the first element, except when the
first element is an alphabetic KeySym ``_K'' for which both
lowercase and uppercase forms are defined. In that case,
the group should be treated as if the first element were the
lowercase form of ``_K'' and the second element were the
uppercase form of ``_K''.
The standard rules for obtaining a KeySym from a _K_e_y_P_r_e_s_s
event make use of only the Group 1 and Group 2 KeySyms; no
interpretation of other KeySyms in the list is given. Which
group to use is determined by the modifier state. Switching
between groups is controlled by the KeySym named MODE
SWITCH, by attaching that KeySym to some KeyCode and attach-
ing that KeyCode to any one of the modifiers _M_o_d_1 through
_M_o_d_5. This modifier is called the _g_r_o_u_p _m_o_d_i_f_i_e_r. For any
KeyCode, Group 1 is used when the group modifier is off, and
Group 2 is used when the group modifier is on.
The _L_o_c_k modifier is interpreted as CapsLock when the KeySym
named XK_Caps_Lock is attached to some KeyCode and that Key-
Code is attached to the _L_o_c_k modifier. The _L_o_c_k modifier is
interpreted as ShiftLock when the KeySym named XK_Shift_Lock
is attached to some KeyCode and that KeyCode is attached to
the _L_o_c_k modifier. If the _L_o_c_k modifier could be inter-
preted as both CapsLock and ShiftLock, the CapsLock inter-
pretation is used.
The operation of keypad keys is controlled by the KeySym
named XK_Num_Lock, by attaching that KeySym to some KeyCode
and attaching that KeyCode to any one of the modifiers _M_o_d_1
through _M_o_d_5. This modifier is called the _n_u_m_l_o_c_k _m_o_d_i_f_i_e_r.
The standard KeySyms with the prefix ``XK_KP_'' in their
name are called keypad KeySyms; these are KeySyms with
numeric value in the hexadecimal range 0xFF80 to 0xFFBD
inclusive. In addition, vendor-specific KeySyms in the hex-
adecimal range 0x11000000 to 0x1100FFFF are also keypad
KeySyms.
338844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Within a group, the choice of KeySym is determined by apply-
ing the first rule that is satisfied from the following
list:
· The numlock modifier is on and the second KeySym is a
keypad KeySym. In this case, if the _S_h_i_f_t modifier is
on, or if the _L_o_c_k modifier is on and is interpreted as
ShiftLock, then the first KeySym is used, otherwise the
second KeySym is used.
· The _S_h_i_f_t and _L_o_c_k modifiers are both off. In this
case, the first KeySym is used.
· The _S_h_i_f_t modifier is off, and the _L_o_c_k modifier is on
and is interpreted as CapsLock. In this case, the
first KeySym is used, but if that KeySym is lowercase
alphabetic, then the corresponding uppercase KeySym is
used instead.
· The _S_h_i_f_t modifier is on, and the _L_o_c_k modifier is on
and is interpreted as CapsLock. In this case, the sec-
ond KeySym is used, but if that KeySym is lowercase
alphabetic, then the corresponding uppercase KeySym is
used instead.
· The _S_h_i_f_t modifier is on, or the _L_o_c_k modifier is on
and is interpreted as ShiftLock, or both. In this
case, the second KeySym is used.
No spatial geometry of the symbols on the key is defined by
their order in the KeySym list, although a geometry might be
defined on a server-specific basis. The X server does not
use the mapping between KeyCodes and KeySyms. Rather, it
merely stores it for reading and writing by clients.
To obtain the legal KeyCodes for a display, use _X_D_i_s_p_l_a_y_K_e_y_-
_c_o_d_e_s.
338855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDisplayKeycodes(_d_i_s_p_l_a_y, _m_i_n___k_e_y_c_o_d_e_s___r_e_t_u_r_n, _m_a_x___k_e_y_c_o_d_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_m_i_n___k_e_y_c_o_d_e_s___r_e_t_u_r_n, *_m_a_x___k_e_y_c_o_d_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_i_n___k_e_y_c_o_d_e_s___r_e_t_u_r_n
Returns the minimum number of KeyCodes.
_m_a_x___k_e_y_c_o_d_e_s___r_e_t_u_r_n
Returns the maximum number of KeyCodes.
││__
The _X_D_i_s_p_l_a_y_K_e_y_c_o_d_e_s function returns the min-keycodes and
max-keycodes supported by the specified display. The mini-
mum number of KeyCodes returned is never less than 8, and
the maximum number of KeyCodes returned is never greater
than 255. Not all KeyCodes in this range are required to
have corresponding keys.
To obtain the symbols for the specified KeyCodes, use
_X_G_e_t_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g.
__
││
KeySym *XGetKeyboardMapping(_d_i_s_p_l_a_y, _f_i_r_s_t___k_e_y_c_o_d_e, _k_e_y_c_o_d_e___c_o_u_n_t,
_k_e_y_s_y_m_s___p_e_r___k_e_y_c_o_d_e___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
KeyCode _f_i_r_s_t___k_e_y_c_o_d_e;
int _k_e_y_c_o_d_e___c_o_u_n_t;
int *_k_e_y_s_y_m_s___p_e_r___k_e_y_c_o_d_e___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_i_r_s_t___k_e_y_c_o_d_e
Specifies the first KeyCode that is to be
returned.
_k_e_y_c_o_d_e___c_o_u_n_t
Specifies the number of KeyCodes that are to be
returned.
_k_e_y_s_y_m_s___p_e_r___k_e_y_c_o_d_e___r_e_t_u_r_n
Returns the number of KeySyms per KeyCode.
││__
The _X_G_e_t_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g function returns the symbols for the
specified number of KeyCodes starting with first_keycode.
The value specified in first_keycode must be greater than or
equal to min_keycode as returned by _X_D_i_s_p_l_a_y_K_e_y_c_o_d_e_s, or a
_B_a_d_V_a_l_u_e error results. In addition, the following
338866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
expression must be less than or equal to max_keycode as
returned by _X_D_i_s_p_l_a_y_K_e_y_c_o_d_e_s:
first_keycode + keycode_count - 1
If this is not the case, a _B_a_d_V_a_l_u_e error results. The num-
ber of elements in the KeySyms list is:
keycode_count * keysyms_per_keycode_return
KeySym number N, counting from zero, for KeyCode K has the
following index in the list, counting from zero:
(K - first_code) * keysyms_per_code_return + N
The X server arbitrarily chooses the keysyms_per_key-
code_return value to be large enough to report all requested
symbols. A special KeySym value of _N_o_S_y_m_b_o_l is used to fill
in unused elements for individual KeyCodes. To free the
storage returned by _X_G_e_t_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g, use _X_F_r_e_e.
_X_G_e_t_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g can generate a _B_a_d_V_a_l_u_e error.
To change the keyboard mapping, use _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g.
338877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XChangeKeyboardMapping(_d_i_s_p_l_a_y, _f_i_r_s_t___k_e_y_c_o_d_e, _k_e_y_s_y_m_s___p_e_r___k_e_y_c_o_d_e, _k_e_y_s_y_m_s, _n_u_m___c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
int _f_i_r_s_t___k_e_y_c_o_d_e;
int _k_e_y_s_y_m_s___p_e_r___k_e_y_c_o_d_e;
KeySym *_k_e_y_s_y_m_s;
int _n_u_m___c_o_d_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_i_r_s_t___k_e_y_c_o_d_e
Specifies the first KeyCode that is to be changed.
_k_e_y_s_y_m_s___p_e_r___k_e_y_c_o_d_e
Specifies the number of KeySyms per KeyCode.
_k_e_y_s_y_m_s Specifies an array of KeySyms.
_n_u_m___c_o_d_e_s Specifies the number of KeyCodes that are to be
changed.
││__
The _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g function defines the symbols for
the specified number of KeyCodes starting with first_key-
code. The symbols for KeyCodes outside this range remain
unchanged. The number of elements in keysyms must be:
num_codes * keysyms_per_keycode
The specified first_keycode must be greater than or equal to
min_keycode returned by _X_D_i_s_p_l_a_y_K_e_y_c_o_d_e_s, or a _B_a_d_V_a_l_u_e
error results. In addition, the following expression must
be less than or equal to max_keycode as returned by _X_D_i_s_-
_p_l_a_y_K_e_y_c_o_d_e_s, or a _B_a_d_V_a_l_u_e error results:
first_keycode + num_codes - 1
KeySym number N, counting from zero, for KeyCode K has the
following index in keysyms, counting from zero:
(K - first_keycode) * keysyms_per_keycode + N
The specified keysyms_per_keycode can be chosen arbitrarily
by the client to be large enough to hold all desired sym-
bols. A special KeySym value of _N_o_S_y_m_b_o_l should be used to
fill in unused elements for individual KeyCodes. It is
legal for _N_o_S_y_m_b_o_l to appear in nontrailing positions of the
338888
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
effective list for a KeyCode. _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g gener-
ates a _M_a_p_p_i_n_g_N_o_t_i_f_y event.
There is no requirement that the X server interpret this
mapping. It is merely stored for reading and writing by
clients.
_X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e
errors.
The next six functions make use of the _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p data
structure, which contains:
__
││
typedef struct {
int max_keypermod; /* This server's max number of keys per modifier */
KeyCode *modifiermap;/* An 8 by max_keypermod array of the modifiers */
} XModifierKeymap;
││__
To create an _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure, use _X_N_e_w_M_o_d_i_f_i_e_r_m_a_p.
__
││
XModifierKeymap *XNewModifiermap(_m_a_x___k_e_y_s___p_e_r___m_o_d)
int _m_a_x___k_e_y_s___p_e_r___m_o_d;
_m_a_x___k_e_y_s___p_e_r___m_o_d
Specifies the number of KeyCode entries preallo-
cated to the modifiers in the map.
││__
The _X_N_e_w_M_o_d_i_f_i_e_r_m_a_p function returns a pointer to _X_M_o_d_i_-
_f_i_e_r_K_e_y_m_a_p structure for later use.
To add a new entry to an _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure, use _X_I_n_-
_s_e_r_t_M_o_d_i_f_i_e_r_m_a_p_E_n_t_r_y.
338899
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XModifierKeymap *XInsertModifiermapEntry(_m_o_d_m_a_p, _k_e_y_c_o_d_e___e_n_t_r_y, _m_o_d_i_f_i_e_r)
XModifierKeymap *_m_o_d_m_a_p;
KeyCode _k_e_y_c_o_d_e___e_n_t_r_y;
int _m_o_d_i_f_i_e_r;
_m_o_d_m_a_p Specifies the _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure.
_k_e_y_c_o_d_e___e_n_t_r_y
Specifies the KeyCode.
_m_o_d_i_f_i_e_r Specifies the modifier.
││__
The _X_I_n_s_e_r_t_M_o_d_i_f_i_e_r_m_a_p_E_n_t_r_y function adds the specified Key-
Code to the set that controls the specified modifier and
returns the resulting _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure (expanded as
needed).
To delete an entry from an _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure, use
_X_D_e_l_e_t_e_M_o_d_i_f_i_e_r_m_a_p_E_n_t_r_y.
__
││
XModifierKeymap *XDeleteModifiermapEntry(_m_o_d_m_a_p, _k_e_y_c_o_d_e___e_n_t_r_y, _m_o_d_i_f_i_e_r)
XModifierKeymap *_m_o_d_m_a_p;
KeyCode _k_e_y_c_o_d_e___e_n_t_r_y;
int _m_o_d_i_f_i_e_r;
_m_o_d_m_a_p Specifies the _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure.
_k_e_y_c_o_d_e___e_n_t_r_y
Specifies the KeyCode.
_m_o_d_i_f_i_e_r Specifies the modifier.
││__
The _X_D_e_l_e_t_e_M_o_d_i_f_i_e_r_m_a_p_E_n_t_r_y function deletes the specified
KeyCode from the set that controls the specified modifier
and returns a pointer to the resulting _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p
structure.
To destroy an _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure, use _X_F_r_e_e_M_o_d_i_-
_f_i_e_r_m_a_p.
339900
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFreeModifiermap(_m_o_d_m_a_p)
XModifierKeymap *_m_o_d_m_a_p;
_m_o_d_m_a_p Specifies the _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure.
││__
The _X_F_r_e_e_M_o_d_i_f_i_e_r_m_a_p function frees the specified _X_M_o_d_i_-
_f_i_e_r_K_e_y_m_a_p structure.
To set the KeyCodes to be used as modifiers, use _X_S_e_t_M_o_d_i_-
_f_i_e_r_M_a_p_p_i_n_g.
__
││
int XSetModifierMapping(_d_i_s_p_l_a_y, _m_o_d_m_a_p)
Display *_d_i_s_p_l_a_y;
XModifierKeymap *_m_o_d_m_a_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_m_o_d_m_a_p Specifies the _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure.
││__
The _X_S_e_t_M_o_d_i_f_i_e_r_M_a_p_p_i_n_g function specifies the KeyCodes of
the keys (if any) that are to be used as modifiers. If it
succeeds, the X server generates a _M_a_p_p_i_n_g_N_o_t_i_f_y event, and
_X_S_e_t_M_o_d_i_f_i_e_r_M_a_p_p_i_n_g returns _M_a_p_p_i_n_g_S_u_c_c_e_s_s. X permits at
most 8 modifier keys. If more than 8 are specified in the
_X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure, a _B_a_d_L_e_n_g_t_h error results.
The modifiermap member of the _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure con-
tains 8 sets of max_keypermod KeyCodes, one for each modi-
fier in the order _S_h_i_f_t, _L_o_c_k, _C_o_n_t_r_o_l, _M_o_d_1, _M_o_d_2, _M_o_d_3,
_M_o_d_4, and _M_o_d_5. 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_key-
code and max_keycode in the _D_i_s_p_l_a_y structure, or a _B_a_d_V_a_l_u_e
error results.
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 sup-
ported. If some such restriction is violated, the status
reply is _M_a_p_p_i_n_g_F_a_i_l_e_d, and none of the modifiers are
changed. If the new KeyCodes specified for a modifier dif-
fer from those currently defined and any (current or new)
keys for that modifier are in the logically down state,
_X_S_e_t_M_o_d_i_f_i_e_r_M_a_p_p_i_n_g returns _M_a_p_p_i_n_g_B_u_s_y, and none of the
modifiers is changed.
339911
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_S_e_t_M_o_d_i_f_i_e_r_M_a_p_p_i_n_g can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e
errors.
To obtain the KeyCodes used as modifiers, use _X_G_e_t_M_o_d_i_-
_f_i_e_r_M_a_p_p_i_n_g.
__
││
XModifierKeymap *XGetModifierMapping(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_G_e_t_M_o_d_i_f_i_e_r_M_a_p_p_i_n_g function returns a pointer to a
newly created _X_M_o_d_i_f_i_e_r_K_e_y_m_a_p structure that contains the
keys being used as modifiers. The structure should be freed
after use by calling _X_F_r_e_e_M_o_d_i_f_i_e_r_m_a_p. If only zero values
appear in the set for any modifier, that modifier is dis-
abled.
339922
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1133
LLooccaalleess aanndd IInntteerrnnaattiioonnaalliizzeedd TTeexxtt FFuunnccttiioonnss
An internationalized application is one that is adaptable to
the requirements of different native languages, local cus-
toms, and character string encodings. The process of adapt-
ing the operation to a particular native language, local
custom, or string encoding is called _l_o_c_a_l_i_z_a_t_i_o_n. A goal
of internationalization is to permit localization without
program source modifications or recompilation.
As one of the localization mechanisms, Xlib provides an X
Input Method (_X_I_M) functional interface for international-
ized text input and an X Output Method (_X_O_M) functional
interface for internationalized text output.
Internationalization in X is based on the concept of a
_l_o_c_a_l_e. A locale defines the localized behavior of a pro-
gram at run time. Locales affect Xlib in its:
· Encoding and processing of input method text
· Encoding of resource files and values
· Encoding and imaging of text strings
· Encoding and decoding for inter-client text communica-
tion
Characters from various languages are represented in a com-
puter using an encoding. Different languages have different
encodings, and there are even different encodings for the
same characters in the same language.
This chapter defines support for localized text imaging and
text input and describes the locale mechanism that controls
all locale-dependent Xlib functions. Sets of functions are
provided for multibyte (char *) text as well as wide charac-
ter (wchar_t) text in the form supported by the host C lan-
guage environment. The multibyte and wide character func-
tions are equivalent except for the form of the text argu-
ment.
The Xlib internationalization functions are not meant to
provide support for multilingual applications (mixing multi-
ple languages within a single piece of text), but they make
it possible to implement applications that work in limited
fashion with more than one language in independent contexts.
339933
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The remainder of this chapter discusses:
· X locale management
· Locale and modifier dependencies
· Variable argument lists
· Output methods
· Input methods
· String constants
1133..11.. XX LLooccaallee MMaannaaggeemmeenntt
X supports one or more of the locales defined by the host
environment. On implementations that conform to the ANSI C
library, the locale announcement method is _s_e_t_l_o_c_a_l_e. This
function configures the locale operation of both the host C
library and Xlib. The operation of Xlib is governed by the
LC_CTYPE category; this is called the _c_u_r_r_e_n_t _l_o_c_a_l_e. An
implementation is permitted to provide implementation-depen-
dent mechanisms for announcing the locale in addition to
_s_e_t_l_o_c_a_l_e.
On implementations that do not conform to the ANSI C
library, the locale announcement method is Xlib implementa-
tion-dependent.
The mechanism by which the semantic operation of Xlib is
defined for a specific locale is implementation-dependent.
X is not required to support all the locales supported by
the host. To determine if the current locale is supported
by X, use _X_S_u_p_p_o_r_t_s_L_o_c_a_l_e.
__
││
Bool XSupportsLocale()
││__
The _X_S_u_p_p_o_r_t_s_L_o_c_a_l_e function returns _T_r_u_e if Xlib functions
are capable of operating under the current locale. If it
returns _F_a_l_s_e, Xlib locale-dependent functions for which the
_X_L_o_c_a_l_e_N_o_t_S_u_p_p_o_r_t_e_d return status is defined will return
_X_L_o_c_a_l_e_N_o_t_S_u_p_p_o_r_t_e_d. Other Xlib locale-dependent routines
will operate in the ``C'' locale.
The client is responsible for selecting its locale and X
modifiers. Clients should provide a means for the user to
override the clients' locale selection at client invocation.
Most single-display X clients operate in a single locale for
339944
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
both X and the host processing environment. They will con-
figure the locale by calling three functions: the host
locale configuration function, _X_S_u_p_p_o_r_t_s_L_o_c_a_l_e, and _X_S_e_t_L_o_-
_c_a_l_e_M_o_d_i_f_i_e_r_s.
The semantics of certain categories of X internationaliza-
tion capabilities can be configured by setting modifiers.
Modifiers are named by implementation-dependent and locale-
specific strings. The only standard use for this capability
at present is selecting one of several styles of keyboard
input method.
To configure Xlib locale modifiers for the current locale,
use _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s.
__
││
char *XSetLocaleModifiers(_m_o_d_i_f_i_e_r___l_i_s_t)
char *_m_o_d_i_f_i_e_r___l_i_s_t;
_m_o_d_i_f_i_e_r___l_i_s_t
Specifies the modifiers.
││__
The _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s function sets the X modifiers for
the current locale setting. The modifier_list argument is a
null-terminated string of the form ``{@_c_a_t_e_g_o_r_y=_v_a_l_u_e}'',
that is, having zero or more concatenated ``@_c_a_t_e_-
_g_o_r_y=_v_a_l_u_e'' entries, where _c_a_t_e_g_o_r_y is a category name and
_v_a_l_u_e is the (possibly empty) setting for that category.
The values are encoded in the current locale. Category
names are restricted to the POSIX Portable Filename Charac-
ter Set.
The local host X locale modifiers announcer (on POSIX-com-
pliant systems, the XMODIFIERS environment variable) is
appended to the modifier_list to provide default values on
the local host. If a given category appears more than once
in the list, the first setting in the list is used. If a
given category is not included in the full modifier list,
the category is set to an implementation-dependent default
for the current locale. An empty value for a category
explicitly specifies the implementation-dependent default.
If the function is successful, it returns a pointer to a
string. The contents of the string are such that a subse-
quent call with that string (in the same locale) will
restore the modifiers to the same settings. If modi-
fier_list is a NULL pointer, _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s also
returns a pointer to such a string, and the current locale
modifiers are not changed.
339955
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
If invalid values are given for one or more modifier cate-
gories supported by the locale, a NULL pointer is returned,
and none of the current modifiers are changed.
At program startup, the modifiers that are in effect are
unspecified until the first successful call to set them.
Whenever the locale is changed, the modifiers that are in
effect become unspecified until the next successful call to
set them. Clients should always call _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s
with a non-NULL modifier_list after setting the locale
before they call any locale-dependent Xlib routine.
The only standard modifier category currently defined is
``im'', which identifies the desired input method. The val-
ues for input method are not standardized. A single locale
may use multiple input methods, switching input method under
user control. The modifier may specify the initial input
method in effect or an ordered list of input methods. Mul-
tiple input methods may be specified in a single im value
string in an implementation-dependent manner.
The returned modifiers string is owned by Xlib and should
not be modified or freed by the client. It may be freed by
Xlib after the current locale or modifiers are changed.
Until freed, it will not be modified by Xlib.
The recommended procedure for clients initializing their
locale and modifiers is to obtain locale and modifier
announcers separately from one of the following prioritized
sources:
· A command line option
· A resource
· The empty string ("")
The first of these that is defined should be used. Note
that when a locale command line option or locale resource is
defined, the effect should be to set all categories to the
specified locale, overriding any category-specific settings
in the local host environment.
1133..22.. LLooccaallee aanndd MMooddiiffiieerr DDeeppeennddeenncciieess
The internationalized Xlib functions operate in the current
locale configured by the host environment and X locale modi-
fiers set by _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s or in the locale and modi-
fiers configured at the time some object supplied to the
function was created. For each locale-dependent function,
the following table describes the locale (and modifiers)
dependency:
339966
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
--------------------------------------------------------------------------
LLooccaallee ffrroomm AAffffeeccttss tthhee FFuunnccttiioonn IInn
--------------------------------------------------------------------------
Locale Query/Configuration:
_s_e_t_l_o_c_a_l_e _X_S_u_p_p_o_r_t_s_L_o_c_a_l_e Locale queried
_X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s Locale modified
Resources:
_s_e_t_l_o_c_a_l_e _X_r_m_G_e_t_F_i_l_e_D_a_t_a_b_a_s_e Locale of _X_r_m_D_a_t_a_b_a_s_e
_X_r_m_G_e_t_S_t_r_i_n_g_D_a_t_a_b_a_s_e
_X_r_m_D_a_t_a_b_a_s_e _X_r_m_P_u_t_F_i_l_e_D_a_t_a_b_a_s_e Locale of _X_r_m_D_a_t_a_b_a_s_e
_X_r_m_L_o_c_a_l_e_O_f_D_a_t_a_b_a_s_e
Setting Standard Properties:
_s_e_t_l_o_c_a_l_e _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s Encoding of sup-
plied/returned
text (some WM_ property
text in environment locale)
_s_e_t_l_o_c_a_l_e _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t Encoding of sup-
plied/returned text
_X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t
_X_m_b_T_e_x_t_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y
_X_w_c_T_e_x_t_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y
Text Input:
_s_e_t_l_o_c_a_l_e _X_O_p_e_n_I_M XIM input method selection
_X_R_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_- XIM selection
_b_a_c_k
_X_U_n_r_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_- XIM selection
_C_a_l_l_b_a_c_k
_X_I_M _X_C_r_e_a_t_e_I_C XIC input method configura-
tion
_X_L_o_c_a_l_e_O_f_I_M, and so on Queried locale
_X_I_C _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g Keyboard layout
_X_w_c_L_o_o_k_u_p_S_t_r_i_n_g Encoding of returned text
Text Drawing:
_s_e_t_l_o_c_a_l_e _X_O_p_e_n_O_M XOM output method selection
_X_C_r_e_a_t_e_F_o_n_t_S_e_t Charsets of fonts in
_X_F_o_n_t_S_e_t
_X_O_M _X_C_r_e_a_t_e_O_C XOC output method configu-
ration
_X_L_o_c_a_l_e_O_f_O_M, and so on Queried locale
_X_F_o_n_t_S_e_t _X_m_b_D_r_a_w_T_e_x_t, Locale of supplied text
_X_w_c_D_r_a_w_T_e_x_t, and so on Locale of supplied text
_X_E_x_t_e_n_t_s_O_f_F_o_n_t_S_e_t, and so on Locale-dependent metrics
_X_m_b_T_e_x_t_E_x_t_e_n_t_s,
_X_w_c_T_e_x_t_E_x_t_e_n_t_s, and so on
Xlib Errors:
_s_e_t_l_o_c_a_l_e _X_G_e_t_E_r_r_o_r_D_a_t_a_b_a_s_e_T_e_x_t Locale of error message
_X_G_e_t_E_r_r_o_r_T_e_x_t
--------------------------------------------------------------------------
339977
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Clients may assume that a locale-encoded text string
returned by an X function can be passed to a C library rou-
tine, or vice versa, if the locale is the same at the two
calls.
All text strings processed by internationalized Xlib func-
tions are assumed to begin in the initial state of the
encoding of the locale, if the encoding is state-dependent.
All Xlib functions behave as if they do not change the cur-
rent locale or X modifier setting. (This means that if they
do change locale or call _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s with a non-NULL
argument, they must save and restore the current state on
entry and exit.) Also, Xlib functions on implementations
that conform to the ANSI C library do not alter the global
state associated with the ANSI C functions _m_b_l_e_n, _m_b_t_o_w_c,
_w_c_t_o_m_b, and _s_t_r_t_o_k.
1133..33.. VVaarriiaabbllee AArrgguummeenntt LLiissttss
Various functions in this chapter have arguments that con-
form to the ANSI C variable argument list calling conven-
tion. Each function denoted with an argument of the form
``...'' takes a variable-length list of name and value
pairs, where each name is a string and each value is of type
_X_P_o_i_n_t_e_r. A name argument that is NULL identifies the end
of the list.
A variable-length argument list may contain a nested list.
If the name _X_N_V_a_N_e_s_t_e_d_L_i_s_t is specified in place of an argu-
ment name, then the following value is interpreted as an
_X_V_a_N_e_s_t_e_d_L_i_s_t value that specifies a list of values logi-
cally inserted into the original list at the point of decla-
ration. A NULL identifies the end of a nested list.
To allocate a nested variable argument list dynamically, use
_X_V_a_C_r_e_a_t_e_N_e_s_t_e_d_L_i_s_t.
__
││
typedef void * XVaNestedList;
XVaNestedList XVaCreateNestedList(_d_u_m_m_y, ...)
int _d_u_m_m_y;
_d_u_m_m_y Specifies an unused argument (required by ANSI C).
... Specifies the variable length argument list.
││__
The _X_V_a_C_r_e_a_t_e_N_e_s_t_e_d_L_i_s_t function allocates memory and copies
its arguments into a single list pointer, which may be used
as a value for arguments requiring a list value. Any
339988
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
entries are copied as specified. Data passed by reference
is not copied; the caller must ensure data remains valid for
the lifetime of the nested list. The list should be freed
using _X_F_r_e_e when it is no longer needed.
1133..44.. OOuuttppuutt MMeetthhooddss
This section provides discussions of the following X Output
Method (XOM) topics:
· Output method overview
· Output method functions
· Output method values
· Output context functions
· Output context values
· Creating and freeing a font set
· Obtaining font set metrics
· Drawing text using font sets
1133..44..11.. OOuuttppuutt MMeetthhoodd OOvveerrvviieeww
Locale-dependent text may include one or more text compo-
nents, each of which may require different fonts and charac-
ter set encodings. In some languages, each component might
have a different drawing direction, and some components
might contain context-dependent characters that change shape
based on relationships with neighboring characters.
When drawing such locale-dependent text, some locale-spe-
cific knowledge is required; for example, what fonts are
required to draw the text, how the text can be separated
into components, and which fonts are selected to draw each
component. Further, when bidirectional text must be drawn,
the internal representation order of the text must be
changed into the visual representation order to be drawn.
An X Output Method provides a functional interface so that
clients do not have to deal directly with such locale-depen-
dent details. Output methods provide the following capabil-
ities:
· Creating a set of fonts required to draw locale-depen-
dent text.
· Drawing locale-dependent text with a font set without
the caller needing to be aware of locale dependencies.
339999
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Obtaining the escapement and extents in pixels of
locale-dependent text.
· Determining if bidirectional or context-dependent draw-
ing is required in a specific locale with a specific
font set.
Two different abstractions are used in the representation of
the output method for clients.
The abstraction used to communicate with an output method is
an opaque data structure represented by the _X_O_M data type.
The abstraction for representing the state of a particular
output thread is called an _o_u_t_p_u_t _c_o_n_t_e_x_t. The Xlib repre-
sentation of an output context is an _X_O_C, which is compati-
ble with _X_F_o_n_t_S_e_t in terms of its functional interface, but
is a broader, more generalized abstraction.
1133..44..22.. OOuuttppuutt MMeetthhoodd FFuunnccttiioonnss
To open an output method, use _X_O_p_e_n_O_M.
__
││
XOM XOpenOM(_d_i_s_p_l_a_y, _d_b, _r_e_s___n_a_m_e, _r_e_s___c_l_a_s_s)
Display *_d_i_s_p_l_a_y;
XrmDatabase _d_b;
char *_r_e_s___n_a_m_e;
char *_r_e_s___c_l_a_s_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_b Specifies a pointer to the resource database.
_r_e_s___n_a_m_e Specifies the full resource name of the applica-
tion.
_r_e_s___c_l_a_s_s Specifies the full class name of the application.
││__
The _X_O_p_e_n_O_M function opens an output method matching the
current locale and modifiers specification. The current
locale and modifiers are bound to the output method when
_X_O_p_e_n_O_M is called. The locale associated with an output
method cannot be changed.
The specific output method to which this call will be routed
is identified on the basis of the current locale and modi-
fiers. _X_O_p_e_n_O_M will identify a default output method corre-
sponding to the current locale. That default can be modi-
fied using _X_S_e_t_L_o_c_a_l_e_M_o_d_i_f_i_e_r_s to set the output method mod-
ifier.
440000
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The db argument is the resource database to be used by the
output method for looking up resources that are private to
the output method. It is not intended that this database be
used to look 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.
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. The characters used for
resource names and classes must be in the X Portable Charac-
ter Set. The resources looked up are not fully specified if
res_name or res_class is NULL.
The res_name and res_class arguments are not assumed to
exist beyond the call to _X_O_p_e_n_O_M. The specified resource
database is assumed to exist for the lifetime of the output
method.
_X_O_p_e_n_O_M returns NULL if no output method could be opened.
To close an output method, use _X_C_l_o_s_e_O_M.
__
││
Status XCloseOM(_o_m)
XOM _o_m;
_o_m Specifies the output method.
││__
The _X_C_l_o_s_e_O_M function closes the specified output method.
To set output method attributes, use _X_S_e_t_O_M_V_a_l_u_e_s.
__
││
char * XSetOMValues(_o_m, ...)
XOM _o_m;
_o_m Specifies the output method.
... Specifies the variable-length argument list to set
XOM values.
││__
The _X_S_e_t_O_M_V_a_l_u_e_s function presents a variable argument list
programming interface for setting properties or features of
the specified output method. This function returns NULL if
it succeeds; otherwise, it returns the name of the first
440011
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
argument that could not be obtained.
No standard arguments are currently defined by Xlib.
To query an output method, use _X_G_e_t_O_M_V_a_l_u_e_s.
__
││
char * XGetOMValues(_o_m, ...)
XOM _o_m;
_o_m Specifies the output method.
... Specifies the variable-length argument list to get
XOM values.
││__
The _X_G_e_t_O_M_V_a_l_u_e_s function presents a variable argument list
programming interface for querying properties or features of
the specified output method. This function returns NULL if
it succeeds; otherwise, it returns the name of the first
argument that could not be obtained.
To obtain the display associated with an output method, use
_X_D_i_s_p_l_a_y_O_f_O_M.
__
││
Display * XDisplayOfOM(_o_m)
XOM _o_m;
_o_m Specifies the output method.
││__
The _X_D_i_s_p_l_a_y_O_f_O_M function returns the display associated
with the specified output method.
To get the locale associated with an output method, use _X_L_o_-
_c_a_l_e_O_f_O_M.
__
││
char * XLocaleOfOM(_o_m)
XOM _o_m;
_o_m Specifies the output method.
││__
The _X_L_o_c_a_l_e_O_f_O_M returns the locale associated with the spec-
ified output method.
440022
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..44..33.. XX OOuuttppuutt MMeetthhoodd VVaalluueess
The following table describes how XOM values are interpreted
by an output method. The first column lists the XOM values.
The second column indicates how each of the XOM values are
treated by a particular output style.
The following key applies to this table.
-------------------------------------------------------------
KKeeyy EExxppllaannaattiioonn
-------------------------------------------------------------
G This value may be read using _X_G_e_t_O_M_V_a_l_u_e_s.
-------------------------------------------------------------
-----------------------------
XXOOMM VVaalluuee KKeeyy
-----------------------------
_X_N_R_e_q_u_i_r_e_d_C_h_a_r_S_e_t G
_X_N_Q_u_e_r_y_O_r_i_e_n_t_a_t_i_o_n G
_X_N_D_i_r_e_c_t_i_o_n_a_l_D_e_p_e_n_- G
_d_e_n_t_D_r_a_w_i_n_g
_X_N_C_o_n_t_e_x_t_u_a_l_D_r_a_w_i_n_g G
-----------------------------
1133..44..33..11.. RReeqquuiirreedd CChhaarr SSeett
The _X_N_R_e_q_u_i_r_e_d_C_h_a_r_S_e_t argument returns the list of charsets
that are required for loading the fonts needed for the
locale. The value of the argument is a pointer to a struc-
ture of type _X_O_M_C_h_a_r_S_e_t_L_i_s_t.
The _X_O_M_C_h_a_r_S_e_t_L_i_s_t structure is defined as follows:
__
││
typedef struct {
int charset_count;
char **charset_list;
} XOMCharSetList;
││__
The charset_list member is a list of one or more null-termi-
nated charset names, and the charset_count member is the
number of charset names.
The required charset list is owned by Xlib and should not be
modified or freed by the client. It will be freed by a call
440033
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
to _X_C_l_o_s_e_O_M with the associated _X_O_M. Until freed, its con-
tents will not be modified by Xlib.
1133..44..33..22.. QQuueerryy OOrriieennttaattiioonn
The _X_N_Q_u_e_r_y_O_r_i_e_n_t_a_t_i_o_n argument returns the global orienta-
tion of text when drawn. Other than _X_O_M_O_r_i_e_n_t_a_t_i_o_n___L_T_R___T_T_B,
the set of orientations supported is locale-dependent. The
value of the argument is a pointer to a structure of type
_X_O_M_O_r_i_e_n_t_a_t_i_o_n. Clients are responsible for freeing the
_X_O_M_O_r_i_e_n_t_a_t_i_o_n structure by using _X_F_r_e_e; this also frees the
contents of the structure.
__
││
typedef struct {
int num_orientation;
XOrientation *orientation;/* Input Text description */
} XOMOrientation;
typedef enum {
XOMOrientation_LTR_TTB,
XOMOrientation_RTL_TTB,
XOMOrientation_TTB_LTR,
XOMOrientation_TTB_RTL,
XOMOrientation_Context
} XOrientation;
││__
The possible value for XOrientation may be:
· _X_O_M_O_r_i_e_n_t_a_t_i_o_n___L_T_R___T_T_B left-to-right, top-to-bottom
global orientation
· _X_O_M_O_r_i_e_n_t_a_t_i_o_n___R_T_L___T_T_B right-to-left, top-to-bottom
global orientation
· _X_O_M_O_r_i_e_n_t_a_t_i_o_n___T_T_B___L_T_R top-to-bottom, left-to-right
global orientation
· _X_O_M_O_r_i_e_n_t_a_t_i_o_n___T_T_B___R_T_L top-to-bottom, right-to-left
global orientation
· _X_O_M_O_r_i_e_n_t_a_t_i_o_n___C_o_n_t_e_x_t contextual global orientation
1133..44..33..33.. DDiirreeccttiioonnaall DDeeppeennddeenntt DDrraawwiinngg
The _X_N_D_i_r_e_c_t_i_o_n_a_l_D_e_p_e_n_d_e_n_t_D_r_a_w_i_n_g argument indicates whether
the text rendering functions implement implicit handling of
directional text. If this value is _T_r_u_e, the output method
has knowledge of directional dependencies and reorders text
440044
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
as necessary when rendering text. If this value is _F_a_l_s_e,
the output method does not implement any directional text
handling, and all character directions are assumed to be
left-to-right.
Regardless of the rendering order of characters, the origins
of all characters are on the primary draw direction side of
the drawing origin.
This OM value presents functionality identical to the _X_D_i_-
_r_e_c_t_i_o_n_a_l_D_e_p_e_n_d_e_n_t_D_r_a_w_i_n_g function.
1133..44..33..44.. CCoonntteexxtt DDeeppeennddeenntt DDrraawwiinngg
The _X_N_C_o_n_t_e_x_t_u_a_l_D_r_a_w_i_n_g argument indicates whether the text
rendering functions implement implicit context-dependent
drawing. If this value is _T_r_u_e, the output method has
knowledge of context dependencies and performs character
shape editing, combining glyphs to present a single charac-
ter as necessary. The actual shape editing is dependent on
the locale implementation and the font set used.
This OM value presents functionality identical to the _X_C_o_n_-
_t_e_x_t_u_a_l_D_r_a_w_i_n_g function.
1133..44..44.. OOuuttppuutt CCoonntteexxtt FFuunnccttiioonnss
An output context is an abstraction that contains both the
data required by an output method and the information
required to display that data. There can be multiple output
contexts for one output method. The programming interfaces
for creating, reading, or modifying an output context use a
variable argument list. The name elements of the argument
lists are referred to as XOC values. It is intended that
output methods be controlled by these XOC values. As new
XOC values are created, they should be registered with the X
Consortium. An _X_O_C can be used anywhere an _X_F_o_n_t_S_e_t can be
used, and vice versa; _X_F_o_n_t_S_e_t is retained for compatibility
with previous releases. The concepts of output methods and
output contexts include broader, more generalized abstrac-
tion than font set, supporting complex and more intelligent
text display, and dealing not only with multiple fonts but
also with context dependencies. However, _X_F_o_n_t_S_e_t is widely
used in several interfaces, so _X_O_C is defined as an upward
compatible type of _X_F_o_n_t_S_e_t.
To create an output context, use _X_C_r_e_a_t_e_O_C.
440055
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XOC XCreateOC(_o_m, ...)
XOM _o_m;
_o_m Specifies the output method.
... Specifies the variable-length argument list to set
XOC values.
││__
The _X_C_r_e_a_t_e_O_C function creates an output context within the
specified output method.
The base font names argument is mandatory at creation time,
and the output context will not be created unless it is pro-
vided. All other output context values can be set later.
_X_C_r_e_a_t_e_O_C returns NULL if no output context could be cre-
ated. NULL can be returned for any of the following rea-
sons:
· A required argument was not set.
· A read-only argument was set.
· An argument name is not recognized.
· The output method encountered an output method imple-
mentation-dependent error.
_X_C_r_e_a_t_e_O_C can generate a _B_a_d_A_t_o_m error.
To destroy an output context, use _X_D_e_s_t_r_o_y_O_C.
__
││
void XDestroyOC(_o_c)
XOC _o_c;
_o_c Specifies the output context.
││__
The _X_D_e_s_t_r_o_y_O_C function destroys the specified output con-
text.
To get the output method associated with an output context,
use _X_O_M_O_f_O_C.
440066
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XOM XOMOfOC(_o_c)
XOC _o_c;
_o_c Specifies the output context.
││__
The _X_O_M_O_f_O_C function returns the output method associated
with the specified output context.
Xlib provides two functions for setting and reading output
context values, respectively, _X_S_e_t_O_C_V_a_l_u_e_s and _X_G_e_t_O_C_V_a_l_u_e_s.
Both functions have a variable-length argument list. In
that argument list, any XOC value's name must be denoted
with a character string using the X Portable Character Set.
To set XOC values, use _X_S_e_t_O_C_V_a_l_u_e_s.
__
││
char * XSetOCValues(_o_c, ...)
XOC _o_c;
_o_c Specifies the output context.
... Specifies the variable-length argument list to set
XOC values.
││__
The _X_S_e_t_O_C_V_a_l_u_e_s 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:
· The argument is read-only.
· The argument name is not recognized.
· An implementation-dependent error occurs.
Each value to be set must be an appropriate datum, matching
the data type imposed by the semantics of the argument.
_X_S_e_t_O_C_V_a_l_u_e_s can generate a _B_a_d_A_t_o_m error.
To obtain XOC values, use _X_G_e_t_O_C_V_a_l_u_e_s.
440077
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char * XGetOCValues(_o_c, ...)
XOC _o_c;
_o_c Specifies the output context.
... Specifies the variable-length argument list to get
XOC values.
││__
The _X_G_e_t_O_C_V_a_l_u_e_s function returns NULL if no error occurred;
otherwise, it returns the name of the first argument that
could not be obtained. An argument might not be obtained
for any of the following reasons:
· The argument name is not recognized.
· An implementation-dependent error occurs.
Each argument value following a name must point to a loca-
tion where the value is to be stored.
1133..44..55.. OOuuttppuutt CCoonntteexxtt VVaalluueess
The following table describes how XOC values are interpreted
by an output method. The first column lists the XOC values.
The second column indicates the alternative interfaces that
function identically and are provided for compatibility with
previous releases. The third column indicates how each of
the XOC values is treated.
The following keys apply to this table.
-------------------------------------------------------------
KKeeyy EExxppllaannaattiioonn
-------------------------------------------------------------
C This value must be set with _X_C_r_e_a_t_e_O_C.
D This value may be set using _X_C_r_e_a_t_e_O_C. If it
is not set,
a default is provided.
G This value may be read using _X_G_e_t_O_C_V_a_l_u_e_s.
S This value must be set using _X_S_e_t_O_C_V_a_l_u_e_s.
-------------------------------------------------------------
-----------------------------------------------
XXOOCC VVaalluuee AAlltteerrnnaattiivvee IInntteerrffaaccee KKeeyy
-----------------------------------------------
BaseFontName _X_C_r_e_a_t_e_F_o_n_t_S_e_t C-G
MissingCharSet _X_C_r_e_a_t_e_F_o_n_t_S_e_t G
DefaultString _X_C_r_e_a_t_e_F_o_n_t_S_e_t G
440088
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-----------------------------------------------
XXOOCC VVaalluuee AAlltteerrnnaattiivvee IInntteerrffaaccee KKeeyy
-----------------------------------------------
Orientation - D-S-G
ResourceName - S-G
ResourceClass - S-G
FontInfo _X_F_o_n_t_s_O_f_F_o_n_t_S_e_t G
OMAutomatic - G
-----------------------------------------------
1133..44..55..11.. BBaassee FFoonntt NNaammee
The _X_N_B_a_s_e_F_o_n_t_N_a_m_e 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; otherwise, the result is implementation-
dependent. White space immediately on either side of a sep-
arating comma is ignored.
Use of XLFD font names permits Xlib to obtain the fonts
needed for a variety of locales from a single locale-inde-
pendent base font name. The single base font name should
name a family of fonts whose members are encoded in the var-
ious charsets needed by the locales of interest.
An XLFD base font name can explicitly name a charset needed
for the locale. This allows the user to specify an exact
font for use with a charset required by a locale, fully con-
trolling the font selection.
If a base font name is not an XLFD name, Xlib will attempt
to obtain an XLFD name from the font properties for the
font. If Xlib is successful, the _X_G_e_t_O_C_V_a_l_u_e_s function will
return this XLFD name instead of the client-supplied name.
This argument must be set at creation time and cannot be
changed. If no fonts exist 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, _X_C_r_e_a_t_e_O_C returns NULL.
When querying for the _X_N_B_a_s_e_F_o_n_t_N_a_m_e XOC value, _X_G_e_t_O_C_V_a_l_u_e_s
returns a null-terminated string identifying the base font
names that Xlib used to load the fonts needed for the
locale. This string is owned by Xlib and should not be mod-
ified or freed by the client. The string will be freed by a
call to _X_D_e_s_t_r_o_y_O_C with the associated _X_O_C. Until freed,
the string contents will not be modified by Xlib.
440099
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..44..55..22.. MMiissssiinngg CChhaarrSSeett
The _X_N_M_i_s_s_i_n_g_C_h_a_r_S_e_t argument returns the list of required
charsets that are missing from the font set. The value of
the argument is a pointer to a structure of type _X_O_M_-
_C_h_a_r_S_e_t_L_i_s_t.
If fonts exist for all of the charsets required by the cur-
rent locale, charset_list is set to NULL and charset_count
is set to zero. If no fonts exist for one or more of the
required charsets, charset_list is set to a list of one or
more null-terminated charset names for which no fonts exist,
and charset_count is set to the number of missing charsets.
The charsets are from the list of the required charsets for
the encoding of the locale and do not include any charsets
to which Xlib may be able to remap a required charset.
The missing charset list is owned by Xlib and should not be
modified or freed by the client. It will be freed by a call
to _X_D_e_s_t_r_o_y_O_C with the associated _X_O_C. Until freed, its
contents will not be modified by Xlib.
1133..44..55..33.. DDeeffaauulltt SSttrriinngg
When a drawing or measuring function is called with an _X_O_C
that has missing charsets, some characters in the locale
will not be drawable. The _X_N_D_e_f_a_u_l_t_S_t_r_i_n_g argument returns
a pointer to a string that represents the glyphs that are
drawn with this _X_O_C when the charsets of the available fonts
do not include all glyphs required to draw a character. 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 or
measure the default glyphs by including this string in a
string being drawn or measured with the _X_O_C.
If the _X_N_D_e_f_a_u_l_t_S_t_r_i_n_g argument returned 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 _X_D_e_s_t_r_o_y_O_C with the associated _X_O_C.
Until freed, its contents will not be modified by Xlib.
1133..44..55..44.. OOrriieennttaattiioonn
The _X_N_O_r_i_e_n_t_a_t_i_o_n argument specifies the current orientation
of text when drawn. The value of this argument is one of
the values returned by the _X_G_e_t_O_M_V_a_l_u_e_s function with the
_X_N_Q_u_e_r_y_O_r_i_e_n_t_a_t_i_o_n argument specified in the _X_O_r_i_e_n_t_a_t_i_o_n
list. The value of the argument is of type _X_O_r_i_e_n_t_a_t_i_o_n.
When _X_N_O_r_i_e_n_t_a_t_i_o_n is queried, the value specifies the cur-
rent orientation. When _X_N_O_r_i_e_n_t_a_t_i_o_n is set, a value is
used to set the current orientation.
441100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
When _X_O_M_O_r_i_e_n_t_a_t_i_o_n___C_o_n_t_e_x_t is set, the text orientation of
the text is determined according to an implementation-
defined method (for example, ISO 6429 control sequences),
and the initial text orientation for locale-dependent Xlib
functions is assumed to be _X_O_M_O_r_i_e_n_t_a_t_i_o_n___L_T_R___T_T_B.
The _X_N_O_r_i_e_n_t_a_t_i_o_n value does not change the prime drawing
direction for Xlib drawing functions.
1133..44..55..55.. RReessoouurrccee NNaammee aanndd CCllaassss
The _X_N_R_e_s_o_u_r_c_e_N_a_m_e and _X_N_R_e_s_o_u_r_c_e_C_l_a_s_s arguments are strings
that specify the full name and class used by the client to
obtain resources for the display of the output context.
These values should be used as prefixes for name and class
when looking up resources that may vary according to the
output context. If these values are not set, the resources
will not be fully specified.
It is not intended that values that can be set as XOM values
be set as resources.
When querying for the _X_N_R_e_s_o_u_r_c_e_N_a_m_e or _X_N_R_e_s_o_u_r_c_e_C_l_a_s_s XOC
value, _X_G_e_t_O_C_V_a_l_u_e_s returns a null-terminated string. This
string is owned by Xlib and should not be modified or freed
by the client. The string will be freed by a call to _X_D_e_-
_s_t_r_o_y_O_C with the associated _X_O_C or when the associated value
is changed via _X_S_e_t_O_C_V_a_l_u_e_s. Until freed, the string con-
tents will not be modified by Xlib.
1133..44..55..66.. FFoonntt IInnffoo
The _X_N_F_o_n_t_I_n_f_o argument specifies a list of one or more
_X_F_o_n_t_S_t_r_u_c_t structures and font names for the fonts used for
drawing by the given output context. The value of the argu-
ment is a pointer to a structure of type _X_O_M_F_o_n_t_I_n_f_o.
__
││
typedef struct {
int num_font;
XFontStruct **font_struct_list;
char **font_name_list;
} XOMFontInfo;
││__
A list of pointers to the _X_F_o_n_t_S_t_r_u_c_t structures is returned
to font_struct_list. A list of pointers to null-terminated,
fully-specified font name strings in the locale of the out-
put context is returned to font_name_list. The
font_name_list order corresponds to the font_struct_list
order. The number of _X_F_o_n_t_S_t_r_u_c_t structures and font names
is returned to num_font.
441111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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 proper-
ties, font ID, or direction hint for the font for the char-
acter. The client may access the _X_F_o_n_t_S_t_r_u_c_t list to obtain
these values for all the fonts currently in use.
Xlib does not guarantee that fonts are loaded from the
server at the creation of an _X_O_C. 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 met-
rics in the _X_F_o_n_t_S_t_r_u_c_t structures in the _X_F_o_n_t_S_t_r_u_c_t_S_e_t is
undefined. Also, note that all properties in the
_X_F_o_n_t_S_t_r_u_c_t structures are in the STRING encoding.
The client must not free the _X_O_M_F_o_n_t_I_n_f_o struct itself; it
will be freed when the _X_O_C is closed.
1133..44..55..77.. OOMM AAuuttoommaattiicc
The _X_N_O_M_A_u_t_o_m_a_t_i_c argument returns whether the associated
output context was created by _X_C_r_e_a_t_e_F_o_n_t_S_e_t or not.
Because the _X_F_r_e_e_F_o_n_t_S_e_t function not only destroys the out-
put context but also closes the implicit output method asso-
ciated with it, _X_F_r_e_e_F_o_n_t_S_e_t should be used with any output
context created by _X_C_r_e_a_t_e_F_o_n_t_S_e_t. However, it is possible
that a client does not know how the output context was cre-
ated. Before a client destroys the output context, it can
query whether _X_N_O_M_A_u_t_o_m_a_t_i_c is set to determine whether
_X_F_r_e_e_F_o_n_t_S_e_t or _X_D_e_s_t_r_o_y_O_C should be used to destroy the
output context.
1133..44..66.. CCrreeaattiinngg aanndd FFrreeeeiinngg aa FFoonntt SSeett
Xlib international text drawing is done using a set of one
or more fonts, as needed for the locale of the text. Fonts
are loaded according to a list of base font names supplied
by the client and the charsets required by the locale. The
_X_F_o_n_t_S_e_t is an opaque type representing the state of a par-
ticular output thread and is equivalent to the type _X_O_C.
The _X_C_r_e_a_t_e_F_o_n_t_S_e_t function is a convenience function for
creating an output context using only default values. The
returned _X_F_o_n_t_S_e_t has an implicitly created _X_O_M. This _X_O_M
has an OM value _X_N_O_M_A_u_t_o_m_a_t_i_c automatically set to _T_r_u_e so
that the output context self indicates whether it was cre-
ated by _X_C_r_e_a_t_e_O_C or _X_C_r_e_a_t_e_F_o_n_t_S_e_t.
441122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XFontSet XCreateFontSet(_d_i_s_p_l_a_y, _b_a_s_e___f_o_n_t___n_a_m_e___l_i_s_t, _m_i_s_s_i_n_g___c_h_a_r_s_e_t___l_i_s_t___r_e_t_u_r_n,
_m_i_s_s_i_n_g___c_h_a_r_s_e_t___c_o_u_n_t___r_e_t_u_r_n, _d_e_f___s_t_r_i_n_g___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char *_b_a_s_e___f_o_n_t___n_a_m_e___l_i_s_t;
char ***_m_i_s_s_i_n_g___c_h_a_r_s_e_t___l_i_s_t___r_e_t_u_r_n;
int *_m_i_s_s_i_n_g___c_h_a_r_s_e_t___c_o_u_n_t___r_e_t_u_r_n;
char **_d_e_f___s_t_r_i_n_g___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_b_a_s_e___f_o_n_t___n_a_m_e___l_i_s_t
Specifies the base font names.
_m_i_s_s_i_n_g___c_h_a_r_s_e_t___l_i_s_t___r_e_t_u_r_n
Returns the missing charsets.
_m_i_s_s_i_n_g___c_h_a_r_s_e_t___c_o_u_n_t___r_e_t_u_r_n
Returns the number of missing charsets.
_d_e_f___s_t_r_i_n_g___r_e_t_u_r_n
Returns the string drawn for missing charsets.
││__
The _X_C_r_e_a_t_e_F_o_n_t_S_e_t function creates a font set for the spec-
ified display. The font set is bound to the current locale
when _X_C_r_e_a_t_e_F_o_n_t_S_e_t is called. The font set may be used in
subsequent calls to obtain font and character information
and to image text in the locale of the font set.
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; otherwise, the result is
implementation-dependent. White space immediately on either
side of a separating comma is ignored.
Use of XLFD font names permits Xlib to obtain the fonts
needed for a variety of locales from a single locale-inde-
pendent base font name. The single base font name should
name a family of fonts whose members are encoded in the var-
ious charsets needed by the locales of interest.
An XLFD base font name can explicitly name a charset needed
for the locale. This allows the user to specify an exact
font for use with a charset required by a locale, fully con-
trolling the font selection.
If a base font name is not an XLFD name, Xlib will attempt
to obtain an XLFD name from the font properties for the
font. If this action is successful in obtaining an XLFD
name, the _X_B_a_s_e_F_o_n_t_N_a_m_e_L_i_s_t_O_f_F_o_n_t_S_e_t function will return
441133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
this XLFD name instead of the client-supplied name.
Xlib uses the following algorithm to select the fonts that
will be used to display text with the _X_F_o_n_t_S_e_t.
For each font charset required by the locale, 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:
· The first XLFD-conforming base font name that specifies
the required charset or a superset of the required
charset in its _C_h_a_r_S_e_t_R_e_g_i_s_t_r_y and _C_h_a_r_S_e_t_E_n_c_o_d_i_n_g
fields. The implementation may use a base font name
whose specified charset is a superset of the required
charset, for example, 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 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 by yen and
overbar; Xlib may load an ISO8859-1 font to support
this character set if a JIS Roman font is not avail-
able.
· 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 _C_h_a_r_S_e_t_R_e_g_i_s_t_r_y and _C_h_a_r_S_e_t_E_n_c_o_d_i_n_g fields in the
XLFD font name). As in case 1, the implementation may
use a charset that is a superset of the required
charset.
· The first font name that can be mapped in some imple-
mentation-dependent manner to one or more fonts that
support imaging text in the charset.
For example, assume that a locale required the charsets:
ISO8859-1
JISX0208.1983
JISX0201.1976
GB2312-1980.0
The user could supply a base_font_name_list that explicitly
specifies the charsets, ensuring that specific fonts are
used if they exist. For example:
441144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
"-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240-JISX0208.1983-0,\
-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120-JISX0201.1976-0,\
-GB-Fixed-Medium-R-Normal--26-180-100-100-C-240-GB2312-1980.0,\
-Adobe-Courier-Bold-R-Normal--25-180-75-75-M-150-ISO8859-1"
Alternatively, the user could supply a base_font_name_list
that omits the charsets, letting Xlib select font charsets
required for the locale. For example:
"-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240,\
-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120,\
-GB-Fixed-Medium-R-Normal--26-180-100-100-C-240,\
-Adobe-Courier-Bold-R-Normal--25-180-100-100-M-150"
Alternatively, the user could simply supply a single base
font name that allows Xlib to select from all available
fonts that meet certain minimum XLFD property requirements.
For example:
"-*-*-*-R-Normal--*-180-100-100-*-*"
If _X_C_r_e_a_t_e_F_o_n_t_S_e_t is unable to create the font set, either
because there is insufficient memory or because the current
locale is not supported, _X_C_r_e_a_t_e_F_o_n_t_S_e_t returns NULL, miss-
ing_charset_list_return is set to NULL, and miss-
ing_charset_count_return is set to zero. If fonts exist for
all of the charsets required by the current locale, _X_C_r_e_a_t_e_-
_F_o_n_t_S_e_t returns a valid _X_F_o_n_t_S_e_t, miss-
ing_charset_list_return is set to NULL, and miss-
ing_charset_count_return is set to zero.
If no font exists for one or more of the required charsets,
_X_C_r_e_a_t_e_F_o_n_t_S_e_t sets missing_charset_list_return to a list of
one or more null-terminated charset names for which no font
exists and sets missing_charset_count_return to the number
of missing fonts. The charsets are from the list of the
required charsets for the encoding of the locale and do not
include any charsets to which Xlib may be able to remap a
required charset.
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,
_X_C_r_e_a_t_e_F_o_n_t_S_e_t returns NULL. Otherwise, _X_C_r_e_a_t_e_F_o_n_t_S_e_t
returns a valid _X_F_o_n_t_S_e_t to font_set.
When an Xmb/wc drawing or measuring function is called with
an _X_F_o_n_t_S_e_t that has missing charsets, some characters in
the locale will not be drawable. If def_string_return is
441155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
non-NULL, _X_C_r_e_a_t_e_F_o_n_t_S_e_t returns a pointer to a string that
represents the glyphs that are drawn with this _X_F_o_n_t_S_e_t 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 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 _X_F_o_n_t_S_e_t.
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 _X_F_r_e_e_F_o_n_t_S_e_t with the associ-
ated _X_F_o_n_t_S_e_t. Until freed, its contents will not be modi-
fied by Xlib.
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.
The returned _X_F_o_n_t_S_e_t and missing charset list should be
freed with _X_F_r_e_e_F_o_n_t_S_e_t and _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t, respectively.
The client-supplied base_font_name_list may be freed by the
client after calling _X_C_r_e_a_t_e_F_o_n_t_S_e_t.
To obtain a list of _X_F_o_n_t_S_t_r_u_c_t structures and full font
names given an _X_F_o_n_t_S_e_t, use _X_F_o_n_t_s_O_f_F_o_n_t_S_e_t.
__
││
int XFontsOfFontSet(_f_o_n_t___s_e_t, _f_o_n_t___s_t_r_u_c_t___l_i_s_t___r_e_t_u_r_n, _f_o_n_t___n_a_m_e___l_i_s_t___r_e_t_u_r_n)
XFontSet _f_o_n_t___s_e_t;
XFontStruct ***_f_o_n_t___s_t_r_u_c_t___l_i_s_t___r_e_t_u_r_n;
char ***_f_o_n_t___n_a_m_e___l_i_s_t___r_e_t_u_r_n;
_f_o_n_t___s_e_t Specifies the font set.
_f_o_n_t___s_t_r_u_c_t___l_i_s_t___r_e_t_u_r_n
Returns the list of font structs.
_f_o_n_t___n_a_m_e___l_i_s_t___r_e_t_u_r_n
Returns the list of font names.
││__
The _X_F_o_n_t_s_O_f_F_o_n_t_S_e_t function returns a list of one or more
_X_F_o_n_t_S_t_r_u_c_t_s and font names for the fonts used by the Xmb
and Xwc layers for the given font set. A list of pointers
to the _X_F_o_n_t_S_t_r_u_c_t structures is returned to
font_struct_list_return. A list of pointers to null-termi-
nated, fully specified font name strings in the locale of
441166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the font set is returned to font_name_list_return. The
font_name_list order corresponds to the font_struct_list
order. The number of _X_F_o_n_t_S_t_r_u_c_t structures and font names
is returned as the value of the function.
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 proper-
ties, font ID, or direction hint for the font for the char-
acter. The client may access the _X_F_o_n_t_S_t_r_u_c_t list to obtain
these values for all the fonts currently in use.
Xlib does not guarantee that fonts are loaded from the
server at the creation of an _X_F_o_n_t_S_e_t. 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 _X_F_o_n_t_S_t_r_u_c_t structures in the
_X_F_o_n_t_S_t_r_u_c_t_S_e_t is undefined. Also, note that all properties
in the _X_F_o_n_t_S_t_r_u_c_t structures are in the STRING encoding.
The _X_F_o_n_t_S_t_r_u_c_t 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 _X_F_r_e_e_F_o_n_t_S_e_t with the associated
_X_F_o_n_t_S_e_t. Until freed, their contents will not be modified
by Xlib.
To obtain the base font name list and the selected font name
list given an _X_F_o_n_t_S_e_t, use _X_B_a_s_e_F_o_n_t_N_a_m_e_L_i_s_t_O_f_F_o_n_t_S_e_t.
__
││
char *XBaseFontNameListOfFontSet(_f_o_n_t___s_e_t)
XFontSet _f_o_n_t___s_e_t;
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_B_a_s_e_F_o_n_t_N_a_m_e_L_i_s_t_O_f_F_o_n_t_S_e_t function returns the original
base font name list supplied by the client when the _X_F_o_n_t_S_e_t
was created. A null-terminated string containing a list of
comma-separated font names is returned as the value of the
function. White space may appear immediately on either side
of separating commas.
If _X_C_r_e_a_t_e_F_o_n_t_S_e_t obtained an XLFD name from the font prop-
erties for the font specified by a non-XLFD base name, the
_X_B_a_s_e_F_o_n_t_N_a_m_e_L_i_s_t_O_f_F_o_n_t_S_e_t function will return the XLFD
name instead of the non-XLFD base name.
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 _X_F_r_e_e_F_o_n_t_S_e_t with the associated _X_F_o_n_t_S_e_t. Until freed,
its contents will not be modified by Xlib.
441177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To obtain the locale name given an _X_F_o_n_t_S_e_t, use _X_L_o_c_a_l_e_O_f_-
_F_o_n_t_S_e_t.
__
││
char *XLocaleOfFontSet(_f_o_n_t___s_e_t)
XFontSet _f_o_n_t___s_e_t;
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_L_o_c_a_l_e_O_f_F_o_n_t_S_e_t function returns the name of the locale
bound to the specified _X_F_o_n_t_S_e_t, as a null-terminated
string.
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 _X_F_r_e_e_F_o_n_t_S_e_t with the associated _X_F_o_n_t_S_e_t. Until
freed, it will not be modified by Xlib.
The _X_F_r_e_e_F_o_n_t_S_e_t function is a convenience function for
freeing an output context. _X_F_r_e_e_F_o_n_t_S_e_t also frees its
associated _X_O_M if the output context was created by _X_C_r_e_a_t_e_-
_F_o_n_t_S_e_t.
__
││
void XFreeFontSet(_d_i_s_p_l_a_y, _f_o_n_t___s_e_t)
Display *_d_i_s_p_l_a_y;
XFontSet _f_o_n_t___s_e_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_F_r_e_e_F_o_n_t_S_e_t function frees the specified font set. The
associated base font name list, font name list, _X_F_o_n_t_S_t_r_u_c_t
list, and _X_F_o_n_t_S_e_t_E_x_t_e_n_t_s, if any, are freed.
1133..44..77.. OObbttaaiinniinngg FFoonntt SSeett MMeettrriiccss
Metrics for the internationalized text drawing functions are
defined in terms of a primary draw direction, which is the
default direction in which the character origin advances for
each succeeding character in the string. The Xlib interface
is currently defined to support only a left-to-right primary
draw direction. The drawing origin is the position passed
to the drawing function when the text is drawn. The base-
line is a line drawn through the drawing origin parallel to
the primary draw direction. Character ink is the pixels
painted in the foreground color and does not include inter-
line or intercharacter spacing or image text background
441188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
pixels.
The drawing functions are allowed to implement implicit text
directionality control, reversing the order in which charac-
ters are rendered along the primary draw direction in
response to locale-specific lexical analysis of the string.
Regardless of the character rendering order, the origins of
all characters are on the primary draw direction side of the
drawing origin. The screen location of a particular charac-
ter image may be determined with _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s or
_X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s.
The drawing functions are allowed to implement context-
dependent rendering, where the glyphs drawn for a string are
not simply a concatenation of the glyphs that represent each
individual character. A string of two characters drawn with
_X_m_b_D_r_a_w_S_t_r_i_n_g may render differently than if the two charac-
ters were drawn with separate calls to _X_m_b_D_r_a_w_S_t_r_i_n_g. If
the client appends or inserts a character in a previously
drawn string, the client may need to redraw some adjacent
characters to obtain proper rendering.
To find out about direction-dependent rendering, use _X_D_i_r_e_c_-
_t_i_o_n_a_l_D_e_p_e_n_d_e_n_t_D_r_a_w_i_n_g.
__
││
Bool XDirectionalDependentDrawing(_f_o_n_t___s_e_t)
XFontSet _f_o_n_t___s_e_t;
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_D_i_r_e_c_t_i_o_n_a_l_D_e_p_e_n_d_e_n_t_D_r_a_w_i_n_g function returns _T_r_u_e if
the drawing functions implement implicit text directional-
ity; otherwise, it returns _F_a_l_s_e.
To find out about context-dependent rendering, use _X_C_o_n_t_e_x_-
_t_u_a_l_D_r_a_w_i_n_g.
__
││
Bool XContextualDrawing(_f_o_n_t___s_e_t)
XFontSet _f_o_n_t___s_e_t;
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_C_o_n_t_e_x_t_u_a_l_D_r_a_w_i_n_g function returns _T_r_u_e if text drawn
with the font set might include context-dependent drawing;
otherwise, it returns _F_a_l_s_e.
441199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To find out about context-dependent or direction-dependent
rendering, use _X_C_o_n_t_e_x_t_D_e_p_e_n_d_e_n_t_D_r_a_w_i_n_g.
__
││
Bool XContextDependentDrawing(_f_o_n_t___s_e_t)
XFontSet _f_o_n_t___s_e_t;
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_C_o_n_t_e_x_t_D_e_p_e_n_d_e_n_t_D_r_a_w_i_n_g function returns _T_r_u_e if the
drawing functions implement implicit text directionality or
if text drawn with the font_set might include context-depen-
dent drawing; otherwise, it returns _F_a_l_s_e.
The drawing functions do not interpret newline, tab, or
other control characters. The behavior when nonprinting
characters other than space are drawn is implementation-
dependent. It is the client's responsibility to interpret
control characters in a text stream.
The maximum character extents for the fonts that are used by
the text drawing layers can be accessed by the _X_F_o_n_t_S_e_t_E_x_-
_t_e_n_t_s structure:
typedef struct {
XRectangle max_ink_extent;/* over all drawable characters */
XRectangle max_logical_extent;/* over all drawable characters */
} XFontSetExtents;
The _X_R_e_c_t_a_n_g_l_e structures used to return font set metrics
are the usual Xlib screen-oriented rectangles with x, y giv-
ing the upper left corner, and width and height always posi-
tive.
The max_ink_extent member gives the maximum extent, over all
drawable characters, of the rectangles that bound the char-
acter glyph image drawn in the foreground color, relative to
a constant origin. See _X_m_b_T_e_x_t_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_E_x_t_e_n_t_s
for detailed semantics.
The max_logical_extent member gives the maximum extent, over
all drawable characters, of the rectangles that specify min-
imum spacing to other graphical features, relative to a con-
stant 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 interline spacing and the
minimum area that must be allowed in a text field to draw a
given number of arbitrary characters.
442200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Due to context-dependent rendering, appending a given char-
acter to a string may change the string's extent by an
amount other than that character's individual extent.
The rectangles for a given character in a string can be
obtained from _X_m_b_P_e_r_C_h_a_r_E_x_t_e_n_t_s or _X_w_c_P_e_r_C_h_a_r_E_x_t_e_n_t_s.
To obtain the maximum extents structure given an _X_F_o_n_t_S_e_t,
use _X_E_x_t_e_n_t_s_O_f_F_o_n_t_S_e_t.
__
││
XFontSetExtents *XExtentsOfFontSet(_f_o_n_t___s_e_t)
XFontSet _f_o_n_t___s_e_t;
_f_o_n_t___s_e_t Specifies the font set.
││__
The _X_E_x_t_e_n_t_s_O_f_F_o_n_t_S_e_t function returns an _X_F_o_n_t_S_e_t_E_x_t_e_n_t_s
structure for the fonts used by the Xmb and Xwc layers for
the given font set.
The _X_F_o_n_t_S_e_t_E_x_t_e_n_t_s structure is owned by Xlib and should
not be modified or freed by the client. It will be freed by
a call to _X_F_r_e_e_F_o_n_t_S_e_t with the associated _X_F_o_n_t_S_e_t. Until
freed, its contents will not be modified by Xlib.
To obtain the escapement in pixels of the specified text as
a value, use _X_m_b_T_e_x_t_E_s_c_a_p_e_m_e_n_t or _X_w_c_T_e_x_t_E_s_c_a_p_e_m_e_n_t.
442211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XmbTextEscapement(_f_o_n_t___s_e_t, _s_t_r_i_n_g, _n_u_m___b_y_t_e_s)
XFontSet _f_o_n_t___s_e_t;
char *_s_t_r_i_n_g;
int _n_u_m___b_y_t_e_s;
int XwcTextEscapement(_f_o_n_t___s_e_t, _s_t_r_i_n_g, _n_u_m___w_c_h_a_r_s)
XFontSet _f_o_n_t___s_e_t;
wchar_t *_s_t_r_i_n_g;
int _n_u_m___w_c_h_a_r_s;
_f_o_n_t___s_e_t Specifies the font set.
_s_t_r_i_n_g Specifies the character string.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argu-
ment.
_n_u_m___w_c_h_a_r_s
Specifies the number of characters in the string
argument.
││__
The _X_m_b_T_e_x_t_E_s_c_a_p_e_m_e_n_t and _X_w_c_T_e_x_t_E_s_c_a_p_e_m_e_n_t functions return
the escapement in pixels of the specified string as a value,
using the fonts loaded for the specified font set. The
escapement is the distance in pixels in the primary draw
direction from the drawing origin to the origin of the next
character to be drawn, assuming that the rendering of the
next character is not dependent on the supplied string.
Regardless of the character rendering order, the escapement
is always positive.
To obtain the overall_ink_return and overall_logical_return
arguments, the overall bounding box of the string's image,
and a logical bounding box, use _X_m_b_T_e_x_t_E_x_t_e_n_t_s
or _X_w_c_T_e_x_t_E_x_t_e_n_t_s.
442222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XmbTextExtents(_f_o_n_t___s_e_t, _s_t_r_i_n_g, _n_u_m___b_y_t_e_s, _o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n, _o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n)
XFontSet _f_o_n_t___s_e_t;
char *_s_t_r_i_n_g;
int _n_u_m___b_y_t_e_s;
XRectangle *_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n;
XRectangle *_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n;
int XwcTextExtents(_f_o_n_t___s_e_t, _s_t_r_i_n_g, _n_u_m___w_c_h_a_r_s,
_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n, _o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n)
XFontSet _f_o_n_t___s_e_t;
wchar_t *_s_t_r_i_n_g;
int _n_u_m___w_c_h_a_r_s;
XRectangle *_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n;
XRectangle *_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n;
_f_o_n_t___s_e_t Specifies the font set.
_s_t_r_i_n_g Specifies the character string.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argu-
ment.
_n_u_m___w_c_h_a_r_s
Specifies the number of characters in the string
argument.
_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n
Returns the overall ink dimensions.
_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n
Returns the overall logical dimensions.
││__
The _X_m_b_T_e_x_t_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_E_x_t_e_n_t_s functions set the com-
ponents of the specified overall_ink_return and overall_log-
ical_return arguments to the overall bounding box of the
string's image and a logical bounding box for spacing pur-
poses, respectively. They return the value returned by _X_m_b_-
_T_e_x_t_E_s_c_a_p_e_m_e_n_t or _X_w_c_T_e_x_t_E_s_c_a_p_e_m_e_n_t. These metrics are rel-
ative to the drawing origin of the string, using the fonts
loaded for the specified font set.
If the overall_ink_return argument is non-NULL, it is set to
the bounding box of the string's character ink. The over-
all_ink_return for a nondescending, horizontally drawn Latin
character is conventionally entirely above the baseline;
that is, overall_ink_return.height <= -overall_ink_return.y.
The overall_ink_return for a nonkerned character is entirely
at, and to the right of, the origin; that is, over-
all_ink_return.x >= 0. A character consisting of a single
pixel at the origin would set overall_ink_return fields y =
442233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
0, x = 0, width = 1, and height = 1.
If the overall_logical_return argument is non-NULL, it is
set to the bounding box that provides minimum spacing to
other graphical features for the string. Other graphical
features, for example, a border surrounding the text, should
not intersect this rectangle.
When the _X_F_o_n_t_S_e_t has missing charsets, metrics for each
unavailable character are taken from the default string
returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t so that the metrics represent the
text as it will actually be drawn. The behavior for an
invalid codepoint is undefined.
To determine the effective drawing origin for a character in
a drawn string, the client should call _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s
on the entire string, then on the character, and subtract
the x values of the returned rectangles for the character.
This is useful to redraw portions of a line of text or to
justify words, but for context-dependent rendering, the
client should not assume that it can redraw the character by
itself and get the same rendering.
To obtain per-character information for a text string, use
_X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s or _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s.
442244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XmbTextPerCharExtents(_f_o_n_t___s_e_t, _s_t_r_i_n_g, _n_u_m___b_y_t_e_s, _i_n_k___a_r_r_a_y___r_e_t_u_r_n,
_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n, _a_r_r_a_y___s_i_z_e, _n_u_m___c_h_a_r_s___r_e_t_u_r_n, _o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n, _o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n)
XFontSet _f_o_n_t___s_e_t;
char *_s_t_r_i_n_g;
int _n_u_m___b_y_t_e_s;
XRectangle *_i_n_k___a_r_r_a_y___r_e_t_u_r_n;
XRectangle *_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n;
int _a_r_r_a_y___s_i_z_e;
int *_n_u_m___c_h_a_r_s___r_e_t_u_r_n;
XRectangle *_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n;
XRectangle *_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n;
Status XwcTextPerCharExtents(_f_o_n_t___s_e_t, _s_t_r_i_n_g, _n_u_m___w_c_h_a_r_s, _i_n_k___a_r_r_a_y___r_e_t_u_r_n,
_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n, _a_r_r_a_y___s_i_z_e, _n_u_m___c_h_a_r_s___r_e_t_u_r_n, _o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n, _o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n)
XFontSet _f_o_n_t___s_e_t;
wchar_t *_s_t_r_i_n_g;
int _n_u_m___w_c_h_a_r_s;
XRectangle *_i_n_k___a_r_r_a_y___r_e_t_u_r_n;
XRectangle *_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n;
int _a_r_r_a_y___s_i_z_e;
int *_n_u_m___c_h_a_r_s___r_e_t_u_r_n;
XRectangle *_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n;
XRectangle *_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n;
_f_o_n_t___s_e_t Specifies the font set.
_s_t_r_i_n_g Specifies the character string.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argu-
ment.
_n_u_m___w_c_h_a_r_s
Specifies the number of characters in the string
argument.
_i_n_k___a_r_r_a_y___r_e_t_u_r_n
Returns the ink dimensions for each character.
_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n
Returns the logical dimensions for each character.
_a_r_r_a_y___s_i_z_e
Specifies the size of ink_array_return and logi-
cal_array_return. The caller must pass in arrays
of this size.
_n_u_m___c_h_a_r_s___r_e_t_u_r_n
Returns the number of characters in the string
argument.
_o_v_e_r_a_l_l___i_n_k___r_e_t_u_r_n
442255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Returns the overall ink extents of the entire
string.
_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n
Returns the overall logical extents of the entire
string.
││__
The _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s func-
tions return the text dimensions of each character of the
specified text, using the fonts loaded for the specified
font set. Each successive element of ink_array_return and
logical_array_return is set to the successive character's
drawn metrics, relative to the drawing origin of the string
and one rectangle for each character in the supplied text
string. The number of elements of ink_array_return and log-
ical_array_return that have been set is returned to
num_chars_return.
Each element of ink_array_return is set to the bounding box
of the corresponding character's drawn foreground color.
Each element of logical_array_return is set to the bounding
box that provides minimum spacing to other graphical fea-
tures for the corresponding character. Other graphical fea-
tures should not intersect any of the logical_array_return
rectangles.
Note that an _X_R_e_c_t_a_n_g_l_e represents the effective drawing
dimensions of the character, regardless of the number of
font glyphs that are used to draw the character or the
direction in which the character is drawn. If multiple
characters map to a single character glyph, the dimensions
of all the _X_R_e_c_t_a_n_g_l_e_s of those characters are the same.
When the _X_F_o_n_t_S_e_t has missing charsets, metrics for each
unavailable character are taken from the default string
returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t so that the metrics represent the
text as it will actually be drawn. The behavior for an
invalid codepoint is undefined.
If the array_size is too small for the number of characters
in the supplied text, the functions return zero and
num_chars_return is set to the number of rectangles
required. Otherwise, the functions return a nonzero value.
If the overall_ink_return or overall_logical_return argument
is non-NULL, _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s
return the maximum extent of the string's metrics to over-
all_ink_return or overall_logical_return, as returned by
_X_m_b_T_e_x_t_E_x_t_e_n_t_s or _X_w_c_T_e_x_t_E_x_t_e_n_t_s.
442266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..44..88.. DDrraawwiinngg TTeexxtt UUssiinngg FFoonntt SSeettss
The functions defined in this section draw text at a speci-
fied location in a drawable. They are similar to the func-
tions _X_D_r_a_w_T_e_x_t, _X_D_r_a_w_S_t_r_i_n_g, and _X_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g except
that they work with font sets instead of single fonts and
interpret the text based on the locale of the font set
instead of treating the bytes of the string as direct font
indexes. See section 8.6 for details of the use of Graphics
Contexts (GCs) and possible protocol errors. If a _B_a_d_F_o_n_t
error is generated, characters prior to the offending char-
acter may have been drawn.
The text is drawn using the fonts loaded for the specified
font set; the font in the GC is ignored and may be modified
by the functions. No validation that all fonts conform to
some width rule is performed.
The text functions _X_m_b_D_r_a_w_T_e_x_t and _X_w_c_D_r_a_w_T_e_x_t use the fol-
lowing structures:
__
││
typedef struct {
char *chars; /* pointer to string */
int nchars; /* number of bytes */
int delta; /* pixel delta between strings */
XFontSet font_set; /* fonts, None means don't change */
} XmbTextItem;
typedef struct {
wchar_t *chars; /* pointer to wide char string */
int nchars; /* number of wide characters */
int delta; /* pixel delta between strings */
XFontSet font_set; /* fonts, None means don't change */
} XwcTextItem;
││__
To draw text using multiple font sets in a given drawable,
use _X_m_b_D_r_a_w_T_e_x_t or _X_w_c_D_r_a_w_T_e_x_t.
442277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XmbDrawText(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _i_t_e_m_s, _n_i_t_e_m_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
XmbTextItem *_i_t_e_m_s;
int _n_i_t_e_m_s;
void XwcDrawText(_d_i_s_p_l_a_y, _d, _g_c, _x, _y, _i_t_e_m_s, _n_i_t_e_m_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
int _x, _y;
XwcTextItem *_i_t_e_m_s;
int _n_i_t_e_m_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates.
_i_t_e_m_s Specifies an array of text items.
_n_i_t_e_m_s Specifies the number of text items in the array.
││__
The _X_m_b_D_r_a_w_T_e_x_t and _X_w_c_D_r_a_w_T_e_x_t functions allow complex
spacing and font set shifts between text strings. Each text
item is processed in turn, with the origin of a text element
advanced in the primary draw direction by the escapement of
the previous text item. A text item delta specifies an
additional escapement of the text item drawing origin in the
primary draw direction. A font_set member other than _N_o_n_e
in an item causes the font set to be used for this and sub-
sequent text items in the text_items list. Leading text
items with a font_set member set to _N_o_n_e will not be drawn.
_X_m_b_D_r_a_w_T_e_x_t and _X_w_c_D_r_a_w_T_e_x_t do not perform any context-
dependent rendering between text segments. Clients may com-
pute the drawing metrics by passing each text segment to
_X_m_b_T_e_x_t_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_E_x_t_e_n_t_s or _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s
and _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s. When the _X_F_o_n_t_S_e_t has missing
charsets, each unavailable character is drawn with the
default string returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t. The behavior for
an invalid codepoint is undefined.
442288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To draw text using a single font set in a given drawable,
use _X_m_b_D_r_a_w_S_t_r_i_n_g or _X_w_c_D_r_a_w_S_t_r_i_n_g.
__
││
void XmbDrawString(_d_i_s_p_l_a_y, _d, _f_o_n_t___s_e_t, _g_c, _x, _y, _s_t_r_i_n_g, _n_u_m___b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
XFontSet _f_o_n_t___s_e_t;
GC _g_c;
int _x, _y;
char *_s_t_r_i_n_g;
int _n_u_m___b_y_t_e_s;
void XwcDrawString(_d_i_s_p_l_a_y, _d, _f_o_n_t___s_e_t, _g_c, _x, _y, _s_t_r_i_n_g, _n_u_m___w_c_h_a_r_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
XFontSet _f_o_n_t___s_e_t;
GC _g_c;
int _x, _y;
wchar_t *_s_t_r_i_n_g;
int _n_u_m___w_c_h_a_r_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_f_o_n_t___s_e_t Specifies the font set.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates.
_s_t_r_i_n_g Specifies the character string.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argu-
ment.
_n_u_m___w_c_h_a_r_s
Specifies the number of characters in the string
argument.
││__
The _X_m_b_D_r_a_w_S_t_r_i_n_g and _X_w_c_D_r_a_w_S_t_r_i_n_g functions draw the spec-
ified text with the foreground pixel. When the _X_F_o_n_t_S_e_t has
missing charsets, each unavailable character is drawn with
the default string returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t. The behavior
for an invalid codepoint is undefined.
To draw image text using a single font set in a given draw-
able, use _X_m_b_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g or _X_w_c_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g.
442299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XmbDrawImageString(_d_i_s_p_l_a_y, _d, _f_o_n_t___s_e_t, _g_c, _x, _y, _s_t_r_i_n_g, _n_u_m___b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
XFontSet _f_o_n_t___s_e_t;
GC _g_c;
int _x, _y;
char *_s_t_r_i_n_g;
int _n_u_m___b_y_t_e_s;
void XwcDrawImageString(_d_i_s_p_l_a_y, _d, _f_o_n_t___s_e_t, _g_c, _x, _y, _s_t_r_i_n_g, _n_u_m___w_c_h_a_r_s)
Display *_d_i_s_p_l_a_y;
Drawable _d;
XFontSet _f_o_n_t___s_e_t;
GC _g_c;
int _x, _y;
wchar_t *_s_t_r_i_n_g;
int _n_u_m___w_c_h_a_r_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_f_o_n_t___s_e_t Specifies the font set.
_g_c Specifies the GC.
_x
_y Specify the x and y coordinates.
_s_t_r_i_n_g Specifies the character string.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argu-
ment.
_n_u_m___w_c_h_a_r_s
Specifies the number of characters in the string
argument.
││__
The _X_m_b_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g and _X_w_c_D_r_a_w_I_m_a_g_e_S_t_r_i_n_g functions fill
a destination rectangle with the background pixel defined in
the GC and then paint the text with the foreground pixel.
The filled rectangle is the rectangle returned to over-
all_logical_return by _X_m_b_T_e_x_t_E_x_t_e_n_t_s or _X_w_c_T_e_x_t_E_x_t_e_n_t_s for
the same text and _X_F_o_n_t_S_e_t.
When the _X_F_o_n_t_S_e_t has missing charsets, each unavailable
character is drawn with the default string returned by _X_C_r_e_-
_a_t_e_F_o_n_t_S_e_t. The behavior for an invalid codepoint is unde-
fined.
443300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..55.. IInnppuutt MMeetthhooddss
This section provides discussions of the following X Input
Method (XIM) topics:
· Input method overview
· Input method management
· Input method functions
· Input method values
· Input context functions
· Input context values
· Input method callback semantics
· Event filtering
· Getting keyboard input
· Input method conventions
1133..55..11.. IInnppuutt MMeetthhoodd OOvveerrvviieeww
This section provides definitions for terms and concepts
used for internationalized text input and a brief overview
of the intended use of the mechanisms provided by Xlib.
A large number of languages in the world use alphabets con-
sisting of a small set of symbols (letters) to form words.
To enter text into a computer in an alphabetic language, a
user usually has a keyboard on which there exist key symbols
corresponding to the alphabet. Sometimes, a few characters
of an alphabetic language are missing on the keyboard. Many
computer users who speak a Latin-alphabet-based language
only have an English-based keyboard. They need to hit a
combination of keystrokes to enter a character that does not
exist directly on the keyboard. A number of algorithms have
been developed for entering such characters. These are
known as European input methods, compose input methods, or
dead-key input methods.
Japanese is an example of a language with a phonetic symbol
set, where each symbol represents a specific sound. There
are two phonetic symbol sets in Japanese: Katakana and
Hiragana. In general, Katakana is used for words that are
of foreign origin, and Hiragana is used for writing native
Japanese words. Collectively, the two systems are called
Kana. Each set consists of 48 characters.
443311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Korean also has a phonetic symbol set, called Hangul. Each
of the 24 basic phonetic symbols (14 consonants and 10 vow-
els) represents a specific sound. A syllable is composed of
two or three parts: the initial consonants, the vowels, and
the optional last consonants. With Hangul, syllables can be
treated as the basic units on which text processing is done.
For example, a delete operation may work on a phonetic sym-
bol or a syllable. Korean code sets include several thou-
sands of these syllables. A user types the phonetic symbols
that make up the syllables of the words to be entered. The
display may change as each phonetic symbol is entered. For
example, when the second phonetic symbol of a syllable is
entered, the first phonetic symbol may change its shape and
size. Likewise, when the third phonetic symbol is entered,
the first two phonetic symbols may change their shape and
size.
Not all languages rely solely on alphabetic or phonetic sys-
tems. Some languages, including Japanese and Korean, employ
an ideographic writing system. In an ideographic system,
rather than taking a small set of symbols and combining them
in different ways to create words, each word consists of one
unique symbol (or, occasionally, several symbols). The num-
ber of symbols can be very large: approximately 50,000 have
been identified in Hanzi, the Chinese ideographic system.
Two major aspects of ideographic systems impact their use
with computers. First, the standard computer character sets
in Japan, China, and Korea include roughly 8,000 characters,
while sets in Taiwan have between 15,000 and 30,000 charac-
ters. This makes it necessary to use more than one byte to
represent a character. Second, it obviously is impractical
to have a keyboard that includes all of a given language's
ideographic symbols. Therefore, a mechanism is required for
entering characters so that a keyboard with a reasonable
number of keys can be used. Those input methods are usually
based on phonetics, but there also exist methods based on
the graphical properties of characters.
In Japan, both Kana and the ideographic system Kanji are
used. In Korea, Hangul and sometimes the ideographic system
Hanja are used. Now consider entering ideographs in Japan,
Korea, China, and Taiwan.
In Japan, either Kana or English characters are typed and
then a region is selected (sometimes automatically) for con-
version to Kanji. Several Kanji characters may have the
same phonetic representation. If that is the case with the
string entered, a menu of characters is presented and the
user must choose the appropriate one. If no choice is nec-
essary or a preference has been established, the input
method does the substitution directly. When Latin charac-
ters are converted to Kana or Kanji, it is called a romaji
conversion.
443322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
In Korea, it is usually acceptable to keep Korean text in
Hangul form, but some people may choose to write Hanja-orig-
inated words in Hanja rather than in Hangul. To change
Hangul to Hanja, the user selects a region for conversion
and then follows the same basic method as that described for
Japanese.
Probably because there are well-accepted phonetic writing
systems for Japanese and Korean, computer input methods in
these countries for entering ideographs are fairly standard.
Keyboard keys have both English characters and phonetic sym-
bols engraved on them, and the user can switch between the
two sets.
The situation is different for Chinese. While there is a
phonetic system called Pinyin promoted by authorities, there
is no consensus for entering Chinese text. Some vendors use
a phonetic decomposition (Pinyin or another), others use
ideographic decomposition of Chinese words, with various
implementations and keyboard layouts. There are about 16
known methods, none of which is a clear standard.
Also, there are actually two ideographic sets used: Tradi-
tional Chinese (the original written Chinese) and Simplified
Chinese. Several years ago, the People's Republic of China
launched a campaign to simplify some ideographic characters
and eliminate redundancies altogether. Under the plan,
characters would be streamlined every five years. Charac-
ters have been revised several times now, resulting in the
smaller, simpler set that makes up Simplified Chinese.
1133..55..11..11.. IInnppuutt MMeetthhoodd AArrcchhiitteeccttuurree
As shown in the previous section, there are many different
input methods in use today, each varying with language, cul-
ture, and history. A common feature of many input methods
is that the user may type multiple keystrokes to compose a
single character (or set of characters). The process of
composing characters from keystrokes is called _p_r_e_e_d_i_t_i_n_g.
It may require complex algorithms and large dictionaries
involving substantial computer resources.
Input methods may require one or more areas in which to show
the feedback of the actual keystrokes, to propose disam-
biguation to the user, to list dictionaries, and so on. The
input method areas of concern are as follows:
· The _s_t_a_t_u_s area is a logical extension of the LEDs that
exist on the physical keyboard. It is a window that is
intended to present the internal state of the input
method that is critical to the user. The status area
may consist of text data and bitmaps or some combina-
tion.
443333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· The _p_r_e_e_d_i_t area displays the intermediate text for
those languages that are composing prior to the client
handling the data.
· The _a_u_x_i_l_i_a_r_y area is used for pop-up menus and cus-
tomizing dialogs that may be required for an input
method. There may be multiple auxiliary areas for an
input method. Auxiliary areas are managed by the input
method independent of the client. Auxiliary areas are
assumed to be separate dialogs, which are maintained by
the input method.
There are various user interaction styles used for preedit-
ing. The ones supported by Xlib are as follows:
· For _o_n_-_t_h_e_-_s_p_o_t input methods, preediting data will be
displayed directly in the application window. Applica-
tion data is moved to allow preedit data to appear at
the point of insertion.
· _O_v_e_r_-_t_h_e_-_s_p_o_t preediting means that the data is dis-
played in a preedit window that is placed over the
point of insertion.
· _O_f_f_-_t_h_e_-_s_p_o_t preediting means that the preedit window
is inside the application window but not at the point
of insertion. Often, this type of window is placed at
the bottom of the application window.
· _R_o_o_t_-_w_i_n_d_o_w preediting refers to input methods that use
a preedit window that is the child of _R_o_o_t_W_i_n_d_o_w.
It would require a lot of computing resources if portable
applications had to include input methods for all the lan-
guages in the world. To avoid this, a goal of the Xlib
design is to allow an application to communicate with an
input method placed in a separate process. Such a process
is called an _i_n_p_u_t _s_e_r_v_e_r. The server to which the applica-
tion should connect is dependent on the environment when the
application is started up, that is, the user language and
the actual encoding to be used for it. The input method
connection is said to be _l_o_c_a_l_e_-_d_e_p_e_n_d_e_n_t. It is also user-
dependent. For a given language, the user can choose, to
some extent, the user interface style of input method (if
choice is possible among several).
Using an input server implies communication overhead, but
applications can be migrated without relinking. Input meth-
ods can be implemented either as a stub communicating to an
input server or as a local library.
An input method may be based on a _f_r_o_n_t_-_e_n_d or a _b_a_c_k_-_e_n_d
architecture. In a front-end architecture, there are two
separate connections to the X server: keystrokes go directly
443344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
from the X server to the input method on one connection and
other events to the regular client connection. The input
method is then acting as a filter and sends composed strings
to the client. A front-end architecture requires synchro-
nization between the two connections to avoid lost key
events or locking issues.
In a back-end architecture, a single X server connection is
used. A dispatching mechanism must decide on this channel
to delegate appropriate keystrokes to the input method. For
instance, it may retain a Help keystroke for its own pur-
pose. In the case where the input method is a separate pro-
cess (that is, a server), there must be a special communica-
tion protocol between the back-end client and the input
server.
A front-end architecture introduces synchronization issues
and a filtering mechanism for noncharacter keystrokes (Func-
tion keys, Help, and so on). A back-end architecture some-
times implies more communication overhead and more process
switching. If all three processes (X server, input server,
client) are running on a single workstation, there are two
process switches for each keystroke in a back-end architec-
ture, but there is only one in a front-end architecture.
The abstraction used by a client to communicate with an
input method is an opaque data structure represented by the
_X_I_M data type. This data structure is returned by the
_X_O_p_e_n_I_M function, which opens an input method on a given
display. Subsequent operations on this data structure
encapsulate all communication between client and input
method. There is no need for an X client to use any net-
working library or natural language package to use an input
method.
A single input server may be used for one or more languages,
supporting one or more encoding schemes. But the strings
returned from an input method will always be encoded in the
(single) locale associated with the _X_I_M object.
1133..55..11..22.. IInnppuutt CCoonntteexxttss
Xlib provides the ability to manage a multi-threaded state
for text input. A client may be using multiple windows,
each window with multiple text entry areas, and the user
possibly switching among them at any time. The abstraction
for representing the state of a particular input thread is
called an _i_n_p_u_t _c_o_n_t_e_x_t. The Xlib representation of an
input context is an _X_I_C.
An input context is the abstraction retaining the state,
properties, and semantics of communication between a client
and an input method. An input context is a combination of
an input method, a locale specifying the encoding of the
443355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
character strings to be returned, a client window, internal
state information, and various layout or appearance charac-
teristics. The input context concept somewhat matches for
input the graphics context abstraction defined for graphics
output.
One input context belongs to exactly one input method. Dif-
ferent input contexts may be associated with the same input
method, possibly with the same client window. An _X_I_C is
created with the _X_C_r_e_a_t_e_I_C function, providing an _X_I_M argu-
ment and affiliating the input context to the input method
for its lifetime. When an input method is closed with _X_C_l_o_-
_s_e_I_M, all of its affiliated input contexts should not be
used any more (and should preferably be destroyed before
closing the input method).
Considering the example of a client window with multiple
text entry areas, the application programmer could, for
example, choose to implement as follows:
· As many input contexts are created as text entry areas,
and the client will get the input accumulated on each
context each time it looks up in that context.
· A single context is created for a top-level window in
the application. If such a window contains several
text entry areas, each time the user moves to another
text entry area, the client has to indicate changes in
the context.
A range of choices can be made by application designers to
use either a single or multiple input contexts, according to
the needs of their application.
1133..55..11..33.. GGeettttiinngg KKeeyybbooaarrdd IInnppuutt
To obtain characters from an input method, a client must
call the function _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g with an
input context created from that input method. Both a locale
and display are bound to an input method when it is opened,
and an input context inherits this locale and display. Any
strings returned by _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g will
be encoded in that locale.
1133..55..11..44.. FFooccuuss MMaannaaggeemmeenntt
For each text entry area in which the _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or
_X_w_c_L_o_o_k_u_p_S_t_r_i_n_g functions are used, there will be an associ-
ated input context.
When the application focus moves to a text entry area, the
application must set the input context focus to the input
context associated with that area. The input context focus
is set by calling _X_S_e_t_I_C_F_o_c_u_s with the appropriate input
443366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
context.
Also, when the application focus moves out of a text entry
area, the application should unset the focus for the associ-
ated input context by calling _X_U_n_s_e_t_I_C_F_o_c_u_s. As an opti-
mization, if _X_S_e_t_I_C_F_o_c_u_s is called successively on two dif-
ferent input contexts, setting the focus on the second will
automatically unset the focus on the first.
To set and unset the input context focus correctly, it is
necessary to track application-level focus changes. Such
focus changes do not necessarily correspond to X server
focus changes.
If a single input context is being used to do input for mul-
tiple text entry areas, it will also be necessary to set the
focus window of the input context whenever the focus window
changes (see section 13.5.6.3).
1133..55..11..55.. GGeeoommeettrryy MMaannaaggeemmeenntt
In most input method architectures (on-the-spot being the
notable exception), the input method will perform the dis-
play of its own data. To provide better visual locality, it
is often desirable to have the input method areas embedded
within a client. To do this, the client may need to allo-
cate space for an input method. Xlib provides support that
allows the size and position of input method areas to be
provided by a client. The input method areas that are sup-
ported for geometry management are the status area and the
preedit area.
The fundamental concept on which geometry management for
input method windows is based is the proper division of
responsibilities between the client (or toolkit) and the
input method. The division of responsibilities is as fol-
lows:
· The client is responsible for the geometry of the input
method window.
· The input method is responsible for the contents of the
input method window.
An input method is able to suggest a size to the client, but
it cannot suggest a placement. Also the input method can
only suggest a size. It does not determine the size, and it
must accept the size it is given.
Before a client provides geometry management for an input
method, it must determine if geometry management is needed.
The input method indicates the need for geometry management
by setting _X_I_M_P_r_e_e_d_i_t_A_r_e_a or _X_I_M_S_t_a_t_u_s_A_r_e_a in its _X_I_M_S_t_y_l_e_s
value returned by _X_G_e_t_I_M_V_a_l_u_e_s. When a client has decided
443377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
that it will provide geometry management for an input
method, it indicates that decision by setting the _X_N_I_n_p_u_t_-
_S_t_y_l_e value in the _X_I_C.
After a client has established with the input method that it
will do geometry management, the client must negotiate the
geometry with the input method. The geometry is negotiated
by the following steps:
· The client suggests an area to the input method by set-
ting the _X_N_A_r_e_a_N_e_e_d_e_d value for that area. If the
client has no constraints for the input method, it
either will not suggest an area or will set the width
and height to zero. Otherwise, it will set one of the
values.
· The client will get the XIC value _X_N_A_r_e_a_N_e_e_d_e_d. The
input method will return its suggested size in this
value. The input method should pay attention to any
constraints suggested by the client.
· The client sets the XIC value _X_N_A_r_e_a to inform the
input method of the geometry of its window. The client
should try to honor the geometry requested by the input
method. The input method must accept this geometry.
Clients doing geometry management must be aware that setting
other XIC values may affect the geometry desired by an input
method. For example, _X_N_F_o_n_t_S_e_t and _X_N_L_i_n_e_S_p_a_c_i_n_g may change
the geometry desired by the input method.
The table of XIC values (see section 13.5.6) indicates the
values that can cause the desired geometry to change when
they are set. It is the responsibility of the client to
renegotiate the geometry of the input method window when it
is needed.
In addition, a geometry management callback is provided by
which an input method can initiate a geometry change.
1133..55..11..66.. EEvveenntt FFiilltteerriinngg
A filtering mechanism is provided to allow input methods to
capture X events transparently to clients. It is expected
that toolkits (or clients) using _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or
_X_w_c_L_o_o_k_u_p_S_t_r_i_n_g will call this filter at some point in the
event processing mechanism to make sure that events needed
by an input method can be filtered by that input method.
If there were no filter, a client could receive and discard
events that are necessary for the proper functioning of an
input method. The following provides a few examples of such
events:
443388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Expose events on preedit window in local mode.
· Events may be used by an input method to communicate
with an input server. Such input server protocol-
related events have to be intercepted if one does not
want to disturb client code.
· Key events can be sent to a filter before they are
bound to translations such as those the X Toolkit
Intrinsics library provides.
Clients are expected to get the XIC value _X_N_F_i_l_t_e_r_E_v_e_n_t_s and
augment the event mask for the client window with that event
mask. This mask may be zero.
1133..55..11..77.. CCaallllbbaacckkss
When an on-the-spot input method is implemented, only the
client can insert or delete preedit data in place and possi-
bly scroll existing text. This means that the echo of the
keystrokes has to be achieved by the client itself, tightly
coupled with the input method logic.
When the user enters a keystroke, the client calls
_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g. At this point, in the
on-the-spot case, the echo of the keystroke in the preedit
has not yet been done. Before returning to the client logic
that handles the input characters, the look-up function must
call the echoing logic to insert the new keystroke. If the
keystrokes entered so far make up a character, the
keystrokes entered need to be deleted, and the composed
character will be returned. Hence, what happens is that,
while being called by client code, the input method logic
has to call back to the client before it returns. The
client code, that is, a callback procedure, is called from
the input method logic.
There are a number of cases where the input method logic has
to call back the client. Each of those cases is associated
with a well-defined callback action. It is possible for the
client to specify, for each input context, what callback is
to be called for each action.
There are also callbacks provided for feedback of status
information and a callback to initiate a geometry request
for an input method.
1133..55..11..88.. VViissiibbllee PPoossiittiioonn FFeeeeddbbaacckk MMaasskkss
In the on-the-spot input style, there is a problem when
attempting to draw preedit strings that are longer than the
available space. Once the display area is exceeded, it is
not clear how best to display the preedit string. The visi-
ble position feedback masks of _X_I_M_T_e_x_t help resolve this
443399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
problem by allowing the input method to specify hints that
indicate the essential portions of the preedit string. For
example, such hints can help developers implement scrolling
of a long preedit string within a short preedit display
area.
1133..55..11..99.. PPrreeeeddiitt SSttrriinngg MMaannaaggeemmeenntt
As highlighted before, the input method architecture pro-
vides preediting, which supports a type of preprocessor
input composition. In this case, composition consists of
interpreting a sequence of key events and returning a com-
mitted string via _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g. This
provides the basics for input methods.
In addition to preediting based on key events, a general
framework is provided to give a client that desires it more
advanced preediting based on the text within the client.
This framework is called _s_t_r_i_n_g _c_o_n_v_e_r_s_i_o_n and is provided
using XIC values. The fundamental concept of string conver-
sion is to allow the input method to manipulate the client's
text independent of any user preediting operation.
The need for string conversion is based on language needs
and input method capabilities. The following are some exam-
ples of string conversion:
· Transliteration conversion provides language-specific
conversions within the input method. In the case of
Korean input, users wish to convert a Hangul string
into a Hanja string while in preediting, after preedit-
ing, or in other situations (for example, on a selected
string). The conversion is triggered when the user
presses a Hangul-to-Hanja key sequence (which may be
input method specific). Sometimes the user may want to
invoke the conversion after finishing preediting or on
a user-selected string. Thus, the string to be con-
verted is in an application buffer, not in the preedit
area of the input method. The string conversion ser-
vices allow the client to request this transliteration
conversion from the input method. There are many other
transliteration conversions defined for various lan-
guages, for example, Kana-to-Kanji conversion in
Japanese.
The key to remember is that transliteration conversions
are triggered at the request of the user and returned
to the client immediately without affecting the preedit
area of the input method.
· Reconversion of a previously committed string or a
selected string is supported by many input methods as a
convenience to the user. For example, a user tends to
mistype the commit key while preediting. In that case,
444400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
some input methods provide a special key sequence to
request a ``reconvert'' operation on the committed
string, similiar to the undo facility provided by most
text editors. Another example is where the user is
proofreading a document that has some misconversions
from preediting and wants to correct the misconverted
text. Such reconversion is again triggered by the user
invoking some special action, but reconversions should
not affect the state of the preedit area.
· Context-sensitive conversion is required for some lan-
guages and input methods that need to retrieve text
that surrounds the current spot location (cursor posi-
tion) of the client's buffer. Such text is needed when
the preediting operation depends on some surrounding
characters (usually preceding the spot location). For
example, in Thai language input, certain character
sequences may be invalid and the input method may want
to check whether characters constitute a valid word.
Input methods that do such context-dependent checking
need to retrieve the characters surrounding the current
cursor position to obtain complete words.
Unlike other conversions, this conversion is not
explicitly requested by the user. Input methods that
provide such context-sensitive conversion continuously
need to request context from the client, and any change
in the context of the spot location may affect such
conversions. The client's context would be needed if
the user moves the cursor and starts editing again.
For this reason, an input method supporting this type
of conversion should take notice of when the client
calls _X_m_b_R_e_s_e_t_I_C or _X_w_c_R_e_s_e_t_I_C, which is usually an
indication of a context change.
Context-sensitive conversions just need a copy of the
client's text, while other conversions replace the client's
text with new text to achieve the reconversion or translit-
eration. Yet in all cases the result of a conversion,
either immediately or via preediting, is returned by the
_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g functions.
String conversion support is dependent on the availability
of the _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n or _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k XIC
values. Because the input method may not support string
conversions, clients have to query the availability of
string conversion operations by checking the supported XIC
values list by calling _X_G_e_t_I_M_V_a_l_u_e_s with the _X_N_Q_u_e_r_y_I_C_V_a_l_-
_u_e_s_L_i_s_t IM value.
The difference between these two values is whether the con-
version is invoked by the client or the input method. The
_X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n XIC value is used by clients to request a
444411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
string conversion from the input method. The client is
responsible for determining which events are used to trigger
the string conversion and whether the string to be converted
should be copied or deleted. The type of conversion is
determined by the input method; the client can only pass the
string to be converted. The client is guaranteed that no
_X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k will be issued when this value is
set; thus, the client need only set one of these values.
The _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k XIC value is used by the
client to notify the input method that it will accept
requests from the input method for string conversion. If
this value is set, it is the input method's responsibility
to determine which events are used to trigger the string
conversion. When such events occur, the input method issues
a call to the client-supplied procedure to retrieve the
string to be converted. The client's callback procedure is
notified whether to copy or delete the string and is pro-
vided with hints as to the amount of text needed. The _X_I_M_-
_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k_S_t_r_u_c_t specifies which text should
be passed back to the input method.
Finally, the input method may call the client's _X_N_S_t_r_i_n_g_C_o_n_-
_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k procedure multiple times if the string
returned from the callback is not sufficient to perform a
successful conversion. The arguments to the client's pro-
cedure allow the input method to define a position (in char-
acter units) relative to the client's cursor position and
the size of the text needed. By varying the position and
size of the desired text in subsequent callbacks, the input
method can retrieve additional text.
1133..55..22.. IInnppuutt MMeetthhoodd MMaannaaggeemmeenntt
The interface to input methods might appear to be simply
creating an input method (_X_O_p_e_n_I_M) and freeing an input
method (_X_C_l_o_s_e_I_M). However, input methods may require com-
plex communication with input method servers (IM servers),
for example:
· If the X server, IM server, and X clients are started
asynchronously, some clients may attempt to connect to
the IM server before it is fully operational, and fail.
Therefore, some mechanism is needed to allow clients to
detect when an IM server has started.
It is up to clients to decide what should be done when an IM
server is not available (for example, wait, or use some
other IM server).
· Some input methods may allow the underlying IM server
to be switched. Such customization may be desired
444422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
without restarting the entire client.
To support management of input methods in these cases, the
following functions are provided:
_X_R_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_- This function allows clients to
_C_a_l_l_b_a_c_k register a callback procedure to
be called when Xlib detects that
an IM server is up and available.
_X_O_p_e_n_I_M A client calls this function as a
result of the callback procedure
being called.
_X_S_e_t_I_M_V_a_l_u_e, _X_S_e_t_I_C_V_a_l_u_e These functions use the XIM and
XIC values, _X_N_D_e_s_t_r_o_y_C_a_l_l_b_a_c_k, to
allow a client to register a
callback procedure to be called
when Xlib detects that an IM
server that was associated with
an opened input method is no
longer available.
In addition, this function can be
used to switch IM servers for
those input methods that support
such functionality. The IM value
for switching IM servers is
implementation-dependent; see the
description below about switching
IM servers.
_X_U_n_r_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_- This function removes a callback
_a_t_e_C_a_l_l_b_a_c_k procedure registered by the
client.
Input methods that support switching of IM servers may
exhibit some side-effects:
· The input method will ensure that any new IM server
supports any of the input styles being used by input
contexts already associated with the input method.
However, the list of supported input styles may be dif-
ferent.
· Geometry management requests on previously created
input contexts may be initiated by the new IM server.
1133..55..22..11.. HHoott KKeeyyss
Some clients need to guarantee which keys can be used to
escape from the input method, regardless of the input method
state; for example, the client-specific Help key or the keys
to move the input focus. The HotKey mechanism allows
clients to specify a set of keys for this purpose. However,
444433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the input method might not allow clients to specify hot
keys. Therefore, clients have to query support of hot keys
by checking the supported XIC values list by calling _X_G_e_t_I_M_-
_V_a_l_u_e_s with the _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t IM value. When the hot
keys specified conflict with the key bindings of the input
method, hot keys take precedence over the key bindings of
the input method.
1133..55..22..22.. PPrreeeeddiitt SSttaattee OOppeerraattiioonn
An input method may have several internal states, depending
on its implementation and the locale. However, one state
that is independent of locale and implementation is whether
the input method is currently performing a preediting opera-
tion. Xlib provides the ability for an application to man-
age the preedit state programmatically. Two methods are
provided for retrieving the preedit state of an input con-
text. One method is to query the state by calling _X_G_e_t_I_C_-
_V_a_l_u_e_s with the _X_N_P_r_e_e_d_i_t_S_t_a_t_e XIC value. Another method is
to receive notification whenever the preedit state is
changed. To receive such notification, an application needs
to register a callback by calling _X_S_e_t_I_C_V_a_l_u_e_s with the
_X_N_P_r_e_e_d_i_t_S_t_a_t_e_N_o_t_i_f_y_C_a_l_l_b_a_c_k XIC value. In order to change
the preedit state programmatically, an application needs to
call _X_S_e_t_I_C_V_a_l_u_e_s with _X_N_P_r_e_e_d_i_t_S_t_a_t_e_.
Availability of the preedit state is input method dependent.
The input method may not provide the ability to set the
state or to retrieve the state programmatically. Therefore,
clients have to query availability of preedit state opera-
tions by checking the supported XIC values list by calling
_X_G_e_t_I_M_V_a_l_u_e_s with the _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t IM value.
1133..55..33.. IInnppuutt MMeetthhoodd FFuunnccttiioonnss
To open a connection, use _X_O_p_e_n_I_M.
444444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XIM XOpenIM(_d_i_s_p_l_a_y, _d_b, _r_e_s___n_a_m_e, _r_e_s___c_l_a_s_s)
Display *_d_i_s_p_l_a_y;
XrmDatabase _d_b;
char *_r_e_s___n_a_m_e;
char *_r_e_s___c_l_a_s_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_b Specifies a pointer to the resource database.
_r_e_s___n_a_m_e Specifies the full resource name of the applica-
tion.
_r_e_s___c_l_a_s_s Specifies the full class name of the application.
││__
The _X_O_p_e_n_I_M 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. This implies that the strings returned by
_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g, 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.
The specific input method to which this call will be routed
is identified on the basis of the current locale. _X_O_p_e_n_I_M
will identify a default input method corresponding to the
current locale. That default can be modified using _X_S_e_t_L_o_-
_c_a_l_e_M_o_d_i_f_i_e_r_s for the input method modifier.
The db argument is the resource database to be used by the
input method for looking up resources that are private to
the input method. It is not intended that this database be
used to look 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.
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. The characters used for
resource names and classes must be in the X Portable Charac-
ter Set. The resources looked up are not fully specified if
res_name or res_class is NULL.
The res_name and res_class arguments are not assumed to
exist beyond the call to _X_O_p_e_n_I_M. The specified resource
database is assumed to exist for the lifetime of the input
method.
444455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_O_p_e_n_I_M returns NULL if no input method could be opened.
To close a connection, use _X_C_l_o_s_e_I_M.
__
││
Status XCloseIM(_i_m)
XIM _i_m;
_i_m Specifies the input method.
││__
The _X_C_l_o_s_e_I_M function closes the specified input method.
To set input method attributes, use _X_S_e_t_I_M_V_a_l_u_e_s.
__
││
char * XSetIMValues(_i_m, ...)
XIM _i_m;
_i_m Specifies the input method.
... Specifies the variable-length argument list to set
XIM values.
││__
The _X_S_e_t_I_M_V_a_l_u_e_s function presents a variable argument list
programming interface for setting attributes of the speci-
fied input method. It returns NULL if it succeeds; other-
wise, it returns the name of the first argument that could
not be set. Xlib does not attempt to set arguments from the
supplied list that follow the failed argument; all arguments
in the list preceding the failed argument have been set cor-
rectly.
To query an input method, use _X_G_e_t_I_M_V_a_l_u_e_s.
__
││
char * XGetIMValues(_i_m, ...)
XIM _i_m;
_i_m Specifies the input method.
... Specifies the variable length argument list to get
XIM values.
││__
The _X_G_e_t_I_M_V_a_l_u_e_s function presents a variable argument list
programming interface for querying properties or features of
444466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the specified input method. This function returns NULL if
it succeeds; otherwise, it returns the name of the first
argument that could not be obtained.
Each XIM value argument (following a name) must point to a
location where the XIM value is to be stored. That is, if
the XIM value is of type T, the argument must be of type T*.
If T itself is a pointer type, then _X_G_e_t_I_M_V_a_l_u_e_s allocates
memory to store the actual data, and the client is responsi-
ble for freeing this data by calling _X_F_r_e_e with the returned
pointer.
To obtain the display associated with an input method, use
_X_D_i_s_p_l_a_y_O_f_I_M.
__
││
Display * XDisplayOfIM(_i_m)
XIM _i_m;
_i_m Specifies the input method.
││__
The _X_D_i_s_p_l_a_y_O_f_I_M function returns the display associated
with the specified input method.
To get the locale associated with an input method, use _X_L_o_-
_c_a_l_e_O_f_I_M.
__
││
char * XLocaleOfIM(_i_m)
XIM _i_m;
_i_m Specifies the input method.
││__
The _X_L_o_c_a_l_e_O_f_I_M function returns the locale associated with
the specified input method.
To register an input method instantiate callback, use _X_R_e_g_-
_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k.
444477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XRegisterIMInstantiateCallback(_d_i_s_p_l_a_y, _d_b, _r_e_s___n_a_m_e, _r_e_s___c_l_a_s_s, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t___d_a_t_a)
Display *_d_i_s_p_l_a_y;
XrmDatabase _d_b;
char *_r_e_s___n_a_m_e;
char *_r_e_s___c_l_a_s_s;
XIMProc _c_a_l_l_b_a_c_k;
XPointer *_c_l_i_e_n_t___d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_b Specifies a pointer to the resource database.
_r_e_s___n_a_m_e Specifies the full resource name of the applica-
tion.
_r_e_s___c_l_a_s_s Specifies the full class name of the application.
_c_a_l_l_b_a_c_k Specifies a pointer to the input method instanti-
ate callback.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
││__
The _X_R_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k 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.
The function returns _T_r_u_e
if it succeeds; otherwise, it returns _F_a_l_s_e.
The generic prototype is as follows:
__
││
void IMInstantiateCallback(_d_i_s_p_l_a_y, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
Display *_d_i_s_p_l_a_y;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
To unregister an input method instantiation callback, use
_X_U_n_r_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k.
444488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XUnregisterIMInstantiateCallback(_d_i_s_p_l_a_y, _d_b, _r_e_s___n_a_m_e, _r_e_s___c_l_a_s_s, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t___d_a_t_a)
Display *_d_i_s_p_l_a_y;
XrmDatabase _d_b;
char *_r_e_s___n_a_m_e;
char *_r_e_s___c_l_a_s_s;
XIMProc _c_a_l_l_b_a_c_k;
XPointer *_c_l_i_e_n_t___d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_b Specifies a pointer to the resource database.
_r_e_s___n_a_m_e Specifies the full resource name of the applica-
tion.
_r_e_s___c_l_a_s_s Specifies the full class name of the application.
_c_a_l_l_b_a_c_k Specifies a pointer to the input method instanti-
ate callback.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
││__
The _X_U_n_r_e_g_i_s_t_e_r_I_M_I_n_s_t_a_n_t_i_a_t_e_C_a_l_l_b_a_c_k function removes an
input method instantiation callback previously registered.
The function returns _T_r_u_e if it succeeds; otherwise, it
returns _F_a_l_s_e.
1133..55..44.. IInnppuutt MMeetthhoodd VVaalluueess
The following table describes how XIM values are interpreted
by an input method. The first column lists the XIM values.
The second column indicates how each of the XIM values are
treated by that input style.
The following keys apply to this table.
-------------------------------------------------------------
KKeeyy EExxppllaannaattiioonn
-------------------------------------------------------------
D This value may be set using _X_S_e_t_I_M_V_a_l_u_e_s. If
it is not set,
a default is provided.
S This value may be set using _X_S_e_t_I_M_V_a_l_u_e_s.
G This value may be read using _X_G_e_t_I_M_V_a_l_u_e_s.
-------------------------------------------------------------
444499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------
XXIIMM VVaalluuee KKeeyy
-------------------------------
_X_N_Q_u_e_r_y_I_n_p_u_t_S_t_y_l_e G
_X_N_R_e_s_o_u_r_c_e_N_a_m_e D-S-G
_X_N_R_e_s_o_u_r_c_e_C_l_a_s_s D-S-G
_X_N_D_e_s_t_r_o_y_C_a_l_l_b_a_c_k D-S-G
_X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s_L_i_s_t G
_X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t G
_X_N_V_i_s_i_b_l_e_P_o_s_i_t_i_o_n G
_X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_- D-S-G
_h_a_v_i_o_r
-------------------------------
_X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r is obsolete and its use is not
recommended (see section 13.5.4.6).
1133..55..44..11.. QQuueerryy IInnppuutt SSttyyllee
A client should always query the input method to determine
which input styles are supported. The client should then
find an input style it is capable of supporting.
If the client cannot find an input style that it can sup-
port, it should negotiate with the user the continuation of
the program (exit, choose another input method, and so on).
The argument value must be a pointer to a location where the
returned value will be stored. The returned value is a
pointer to a structure of type _X_I_M_S_t_y_l_e_s. Clients are
responsible for freeing the _X_I_M_S_t_y_l_e_s structure. To do so,
use _X_F_r_e_e.
The _X_I_M_S_t_y_l_e_s structure is defined as follows:
445500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef unsigned long XIMStyle;
#define _X_I_M_P_r_e_e_d_i_t_A_r_e_a 0x0001L
#define _X_I_M_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_s 0x0002L
#define _X_I_M_P_r_e_e_d_i_t_P_o_s_i_t_i_o_n 0x0004L
#define _X_I_M_P_r_e_e_d_i_t_N_o_t_h_i_n_g 0x0008L
#define _X_I_M_P_r_e_e_d_i_t_N_o_n_e 0x0010L
#define _X_I_M_S_t_a_t_u_s_A_r_e_a 0x0100L
#define _X_I_M_S_t_a_t_u_s_C_a_l_l_b_a_c_k_s 0x0200L
#define _X_I_M_S_t_a_t_u_s_N_o_t_h_i_n_g 0x0400L
#define _X_I_M_S_t_a_t_u_s_N_o_n_e 0x0800L
typedef struct {
unsigned short count_styles;
XIMStyle * supported_styles;
} XIMStyles;
││__
An _X_I_M_S_t_y_l_e_s structure contains the number of input styles
supported in its count_styles field. This is also the size
of the supported_styles array.
The supported styles is a list of bitmask combinations,
which indicate the combination of styles for each of the
areas supported. These areas are described later. Each
element in the list should select one of the bitmask values
for each area. The list describes the complete set of com-
binations supported. Only these combinations are supported
by the input method.
The preedit category defines what type of support is pro-
vided by the input method for preedit information.
_X_I_M_P_r_e_e_d_i_t_A_r_e_a If chosen, the input method would require
the client to provide some area values for
it to do its preediting. Refer to XIC
values _X_N_A_r_e_a and _X_N_A_r_e_a_N_e_e_d_e_d.
_X_I_M_P_r_e_e_d_i_t_P_o_s_i_- If chosen, the input method would require
_t_i_o_n the client to provide positional values.
Refer to XIC values _X_N_S_p_o_t_L_o_c_a_t_i_o_n and
_X_N_F_o_c_u_s_W_i_n_d_o_w.
_X_I_M_P_r_e_e_d_i_t_C_a_l_l_- If chosen, the input method would require
_b_a_c_k_s the client to define the set of preedit
callbacks. Refer to XIC values _X_N_P_r_e_e_d_i_t_-
_S_t_a_r_t_C_a_l_l_b_a_c_k, _X_N_P_r_e_e_d_i_t_D_o_n_e_C_a_l_l_b_a_c_k,
_X_N_P_r_e_e_d_i_t_D_r_a_w_C_a_l_l_b_a_c_k, and _X_N_P_r_e_e_d_i_t_C_a_r_e_t_-
_C_a_l_l_b_a_c_k.
445511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_I_M_P_r_e_e_d_i_t_N_o_t_h_- If chosen, the input method can function
_i_n_g without any preedit values.
_X_I_M_P_r_e_e_d_i_t_N_o_n_e The input method does not provide any
preedit feedback. Any preedit value is
ignored. This style is mutually exclusive
with the other preedit styles.
The status category defines what type of support is provided
by the input method for status information.
_X_I_M_S_t_a_t_u_s_A_r_e_a The input method requires the client to
provide some area values for it to do its
status feedback. See _X_N_A_r_e_a and _X_N_A_r_e_a_-
_N_e_e_d_e_d.
_X_I_M_S_t_a_t_u_s_C_a_l_l_- The input method requires the client to
_b_a_c_k_s define the set of status callbacks, _X_N_S_t_a_-
_t_u_s_S_t_a_r_t_C_a_l_l_b_a_c_k, _X_N_S_t_a_t_u_s_D_o_n_e_C_a_l_l_b_a_c_k,
and _X_N_S_t_a_t_u_s_D_r_a_w_C_a_l_l_b_a_c_k.
_X_I_M_S_t_a_t_u_s_N_o_t_h_- The input method can function without any
_i_n_g status values.
_X_I_M_S_t_a_t_u_s_N_o_n_e The input method does not provide any sta-
tus feedback. If chosen, any status value
is ignored. This style is mutually exclu-
sive with the other status styles.
1133..55..44..22.. RReessoouurrccee NNaammee aanndd CCllaassss
The _X_N_R_e_s_o_u_r_c_e_N_a_m_e and _X_N_R_e_s_o_u_r_c_e_C_l_a_s_s arguments are strings
that specify the full name and class used by the input
method. These values should be used as prefixes for the
name and class when looking up resources that may vary
according to the input method. If these values are not set,
the resources will not be fully specified.
It is not intended that values that can be set as XIM values
be set as resources.
1133..55..44..33.. DDeessttrrooyy CCaallllbbaacckk
The _X_N_D_e_s_t_r_o_y_C_a_l_l_b_a_c_k argument is a pointer to a structure
of type _X_I_M_C_a_l_l_b_a_c_k. _X_N_D_e_s_t_r_o_y_C_a_l_l_b_a_c_k is triggered when an
input method stops its service for any reason. After the
callback is invoked, the input method is closed and the
associated input context(s) are destroyed by Xlib. There-
fore, the client should not call _X_C_l_o_s_e_I_M or _X_D_e_s_t_r_o_y_I_C.
The generic prototype of this callback function is as fol-
lows:
445522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void DestroyCallback(_i_m, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIM _i_m;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_m Specifies the input method.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
A DestroyCallback is always called with a NULL call_data
argument.
1133..55..44..44.. QQuueerryy IIMM//IICC VVaalluueess LLiisstt
_X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s_L_i_s_t and _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t are used to
query about XIM and XIC values supported by the input
method.
The argument value must be a pointer to a location where the
returned value will be stored. The returned value is a
pointer to a structure of type _X_I_M_V_a_l_u_e_s_L_i_s_t. Clients are
responsible for freeing the _X_I_M_V_a_l_u_e_s_L_i_s_t structure. To do
so, use _X_F_r_e_e.
The _X_I_M_V_a_l_u_e_s_L_i_s_t structure is defined as follows:
__
││
typedef struct {
unsigned short count_values;
char **supported_values;
} XIMValuesList;
││__
1133..55..44..55.. VViissiibbllee PPoossiittiioonn
The _X_N_V_i_s_i_b_l_e_P_o_s_i_t_i_o_n argument indicates whether the visible
position masks of _X_I_M_F_e_e_d_b_a_c_k in _X_I_M_T_e_x_t are available.
The argument value must be a pointer to a location where the
returned value will be stored. The returned value is of
type _B_o_o_l. If the returned value is _T_r_u_e, the input method
uses the visible position masks of _X_I_M_F_e_e_d_b_a_c_k in _X_I_M_T_e_x_t;
otherwise, the input method does not use the masks.
445533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Because this XIM value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s before using this
argument. If the _X_N_V_i_s_i_b_l_e_P_o_s_i_t_i_o_n does not exist in the IM
values list returned from _X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s, the visible posi-
tion masks of _X_I_M_F_e_e_d_b_a_c_k in _X_I_M_T_e_x_t are not used to indi-
cate the visible position.
1133..55..44..66.. PPrreeeeddiitt CCaallllbbaacckk BBeehhaavviioorr
The _X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r argument originally included
in the X11R6 specification has been deprecated.†
The _X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r argument indicates whether
the behavior of preedit callbacks regarding _X_I_M_P_r_e_e_d_i_t_D_r_a_w_-
_C_a_l_l_b_a_c_k_S_t_r_u_c_t values follows Release 5 or Release 6 seman-
tics.
The value is of type _B_o_o_l. When querying for _X_N_R_6_P_r_e_e_d_i_t_-
_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r, if the returned value is _T_r_u_e, the input
method uses the Release 6 behavior; otherwise, it uses the
Release 5 behavior. The default value is _F_a_l_s_e. In order
to use Release 6 semantics, the value of _X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_-
_b_a_c_k_B_e_h_a_v_i_o_r must be set to _T_r_u_e.
Because this XIM value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s before using this
argument. If the _X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r does not exist
in the IM values list returned from _X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s, the
PreeditCallback behavior is Release 5 semantics.
1133..55..55.. IInnppuutt CCoonntteexxtt FFuunnccttiioonnss
An input context is an abstraction that is used to contain
both the data required (if any) by an input method and the
information required to display that data. There may be
multiple input contexts for one input method. The program-
ming interfaces for creating, reading, or modifying an input
context use a variable argument list. The name elements of
the argument lists are referred to as XIC values. It is
intended that input methods be controlled by these XIC val-
ues. As new XIC values are created, they should be regis-
tered with the X Consortium.
-----------
† During formulation of the X11R6 specification,
the behavior of the R6 PreeditDrawCallbacks was
going to differ significantly from that of the R5
callbacks. Late changes to the specification con-
verged the R5 and R6 behaviors, eliminating the
need for _X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r. Unfortu-
nately, this argument was not removed from the R6
specification before it was published.
445544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To create an input context, use _X_C_r_e_a_t_e_I_C.
__
││
XIC XCreateIC(_i_m, ...)
XIM _i_m;
_i_m Specifies the input method.
... Specifies the variable length argument list to set
XIC values.
││__
The _X_C_r_e_a_t_e_I_C function creates a context within the speci-
fied input method.
Some of the arguments are mandatory at creation time, and
the input context will not be created if those arguments are
not provided. The mandatory arguments are the input style
and the set of text callbacks (if the input style selected
requires callbacks). All other input context values can be
set later.
_X_C_r_e_a_t_e_I_C returns a NULL value if no input context could be
created. A NULL value could be returned for any of the fol-
lowing reasons:
· A required argument was not set.
· A read-only argument was set (for example, _X_N_F_i_l_-
_t_e_r_E_v_e_n_t_s).
· The argument name is not recognized.
· The input method encountered an input method implemen-
tation-dependent error.
_X_C_r_e_a_t_e_I_C can generate _B_a_d_A_t_o_m, _B_a_d_C_o_l_o_r, _B_a_d_P_i_x_m_a_p, and
_B_a_d_W_i_n_d_o_w errors.
To destroy an input context, use _X_D_e_s_t_r_o_y_I_C.
__
││
void XDestroyIC(_i_c)
XIC _i_c;
_i_c Specifies the input context.
││__
_X_D_e_s_t_r_o_y_I_C destroys the specified input context.
445555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To communicate to and synchronize with input method for any
changes in keyboard focus from the client side, use _X_S_e_t_I_C_-
_F_o_c_u_s and _X_U_n_s_e_t_I_C_F_o_c_u_s.
__
││
void XSetICFocus(_i_c)
XIC _i_c;
_i_c Specifies the input context.
││__
The _X_S_e_t_I_C_F_o_c_u_s function allows a client to notify an input
method that the focus window attached to the specified input
context has received keyboard focus. The input method
should take action to provide appropriate feedback. Com-
plete feedback specification is a matter of user interface
policy.
Calling _X_S_e_t_I_C_F_o_c_u_s does not affect the focus window value.
__
││
void XUnsetICFocus(_i_c)
XIC _i_c;
_i_c Specifies the input context.
││__
The _X_U_n_s_e_t_I_C_F_o_c_u_s function allows a client to notify an
input method that the specified input context has lost the
keyboard focus and that no more input is expected on the
focus window attached to that input context. The input
method should take action to provide appropriate feedback.
Complete feedback specification is a matter of user inter-
face policy.
Calling _X_U_n_s_e_t_I_C_F_o_c_u_s does not affect the focus window
value; the client may still receive events from the input
method that are directed to the focus window.
To reset the state of an input context to its initial state,
use _X_m_b_R_e_s_e_t_I_C or _X_w_c_R_e_s_e_t_I_C.
445566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char * XmbResetIC(_i_c)
XIC _i_c;
wchar_t * XwcResetIC(_i_c)
XIC _i_c;
_i_c Specifies the input context.
││__
When _X_N_R_e_s_e_t_S_t_a_t_e is set to _X_I_M_I_n_i_t_i_a_l_S_t_a_t_e, _X_m_b_R_e_s_e_t_I_C and
_X_w_c_R_e_s_e_t_I_C reset an input context to its initial state; when
_X_N_R_e_s_e_t_S_t_a_t_e is set to _X_I_M_P_r_e_s_e_r_v_e_S_t_a_t_e, the current input
context state is preserved. In both cases, any input pend-
ing on that context is deleted. The input method is
required to clear the preedit area, if any, and update the
status accordingly. Calling _X_m_b_R_e_s_e_t_I_C or _X_w_c_R_e_s_e_t_I_C does
not change the focus.
The return value of _X_m_b_R_e_s_e_t_I_C is its current preedit string
as a multibyte string. If there is any preedit text drawn
or visible to the user, then these procedures must return a
non-NULL string. If there is no visible preedit text, then
it is input method implementation-dependent whether these
procedures return a non-NULL string or NULL.
The client should free the returned string by calling _X_F_r_e_e.
To get the input method associated with an input context,
use _X_I_M_O_f_I_C.
__
││
XIM XIMOfIC(_i_c)
XIC _i_c;
_i_c Specifies the input context.
││__
The _X_I_M_O_f_I_C function returns the input method associated
with the specified input context.
Xlib provides two functions for setting and reading XIC val-
ues, respectively, _X_S_e_t_I_C_V_a_l_u_e_s and _X_G_e_t_I_C_V_a_l_u_e_s. Both
functions have a variable-length argument list. In that
argument list, any XIC value's name must be denoted with a
character string using the X Portable Character Set.
To set XIC values, use _X_S_e_t_I_C_V_a_l_u_e_s.
445577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char * XSetICValues(_i_c, ...)
XIC _i_c;
_i_c Specifies the input context.
... Specifies the variable length argument list to set
XIC values.
││__
The _X_S_e_t_I_C_V_a_l_u_e_s 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:
· The argument is read-only (for example, _X_N_F_i_l_-
_t_e_r_E_v_e_n_t_s).
· The argument name is not recognized.
· An implementation-dependent error occurs.
Each value to be set must be an appropriate datum, matching
the data type imposed by the semantics of the argument.
_X_S_e_t_I_C_V_a_l_u_e_s can generate _B_a_d_A_t_o_m, _B_a_d_C_o_l_o_r, _B_a_d_C_u_r_s_o_r, _B_a_d_-
_P_i_x_m_a_p, and _B_a_d_W_i_n_d_o_w errors.
To obtain XIC values, use _X_G_e_t_I_C_V_a_l_u_e_s.
__
││
char * XGetICValues(_i_c, ...)
XIC _i_c;
_i_c Specifies the input context.
... Specifies the variable length argument list to get
XIC values.
││__
The _X_G_e_t_I_C_V_a_l_u_e_s function returns NULL if no error occurred;
otherwise, it returns the name of the first argument that
could not be obtained. An argument could not be obtained
for any of the following reasons:
· The argument name is not recognized.
· The input method encountered an implementation-depen-
dent error.
445588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Each IC attribute value argument (following a name) must
point to a location where the IC value is to be stored.
That is, if the IC value is of type T, the argument must be
of type T*. If T itself is a pointer type, then _X_G_e_t_I_C_V_a_l_-
_u_e_s allocates memory to store the actual data, and the
client is responsible for freeing this data by calling _X_F_r_e_e
with the returned pointer. The exception to this rule is
for an IC value of type _X_V_a_N_e_s_t_e_d_L_i_s_t (for preedit and sta-
tus attributes). In this case, the argument must also be
of type _X_V_a_N_e_s_t_e_d_L_i_s_t. Then, the rule of changing type T to
T* and freeing the allocated data applies to each element of
the nested list.
1133..55..66.. IInnppuutt CCoonntteexxtt VVaalluueess
The following tables describe how XIC values are interpreted
by an input method depending on the input style chosen by
the user.
The first column lists the XIC values. The second column
indicates which values are involved in affecting, negotiat-
ing, and setting the geometry of the input method windows.
The subentries under the third column indicate the different
input styles that are supported. Each of these columns
indicates how each of the XIC values are treated by that
input style.
The following keys apply to these tables.
-------------------------------------------------------------
KKeeyy EExxppllaannaattiioonn
-------------------------------------------------------------
C This value must be set with _X_C_r_e_a_t_e_I_C.
D This value may be set using _X_C_r_e_a_t_e_I_C. If it
is not set, a default is provided.
G This value may be read using _X_G_e_t_I_C_V_a_l_u_e_s.
GN This value may cause geometry negotiation when
its value is set by means of _X_C_r_e_a_t_e_I_C or _X_S_e_t_-
_I_C_V_a_l_u_e_s.
GR This value will be the response of the input
method when any GN value is changed.
GS This value will cause the geometry of the input
method window to be set.
O This value must be set once and only once. It
need not be set at create time.
S This value may be set with _X_S_e_t_I_C_V_a_l_u_e_s.
Ignored This value is ignored by the input method for
the given input style.
-------------------------------------------------------------
445599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-----------------------------------------------------------------------------------------------
IInnppuutt SSttyyllee
XXIICC VVaalluuee GGeeoommeettrryy PPrreeeeddiitt PPrreeeeddiitt PPrreeeeddiitt PPrreeeeddiitt PPrreeeeddiitt
MMaannaaggeemmeenntt CCaallllbbaacckk PPoossiittiioonn AArreeaa NNootthhiinngg NNoonnee
-----------------------------------------------------------------------------------------------
Input Style C-G C-G C-G C-G C-G
Client Window O-G O-G O-G O-G Ignored
Focus Window GN D-S-G D-S-G D-S-G D-S-G Ignored
Resource Name Ignored D-S-G D-S-G D-S-G Ignored
Resource Class Ignored D-S-G D-S-G D-S-G Ignored
Geometry Callback Ignored Ignored D-S-G Ignored Ignored
Filter Events G G G G Ignored
Destroy Callback D-S-G D-S-G D-S-G D-S-G D-S-G
String Conversion Callback S-G S-G S-G S-G S-G
String Conversion D-S-G D-S-G D-S-G D-S-G D-S-G
Reset State D-S-G D-S-G D-S-G D-S-G Ignored
HotKey S-G S-G S-G S-G Ignored
HotKeyState D-S-G D-S-G D-S-G D-S-G Ignored
PPrreeeeddiitt
Area GS Ignored D-S-G D-S-G Ignored Ignored
Area Needed GN-GR Ignored Ignored S-G Ignored Ignored
Spot Location Ignored D-S-G Ignored Ignored Ignored
Colormap Ignored D-S-G D-S-G D-S-G Ignored
Foreground Ignored D-S-G D-S-G D-S-G Ignored
Background Ignored D-S-G D-S-G D-S-G Ignored
Background Pixmap Ignored D-S-G D-S-G D-S-G Ignored
Font Set GN Ignored D-S-G D-S-G D-S-G Ignored
Line Spacing GN Ignored D-S-G D-S-G D-S-G Ignored
Cursor Ignored D-S-G D-S-G D-S-G Ignored
Preedit State D-S-G D-S-G D-S-G D-S-G Ignored
Preedit State Notify Callback S-G S-G S-G S-G Ignored
Preedit Callbacks C-S-G Ignored Ignored Ignored Ignored
-----------------------------------------------------------------------------------------------
------------------------------------------------------------------------
IInnppuutt SSttyyllee
XXIICC VVaalluuee GGeeoommeettrryy SSttaattuuss SSttaattuuss SSttaattuuss SSttaattuuss
MMaannaaggeemmeenntt CCaallllbbaacckk AArreeaa NNootthhiinngg NNoonnee
------------------------------------------------------------------------
Input Style C-G C-G C-G C-G
Client Window O-G O-G O-G Ignored
Focus Window GN D-S-G D-S-G D-S-G Ignored
Resource Name Ignored D-S-G D-S-G Ignored
Resource Class Ignored D-S-G D-S-G Ignored
Geometry Callback Ignored D-S-G Ignored Ignored
Filter Events G G G G
SSttaattuuss
Area GS Ignored D-S-G Ignored Ignored
Area Needed GN-GR Ignored S-G Ignored Ignored
Colormap Ignored D-S-G D-S-G Ignored
Foreground Ignored D-S-G D-S-G Ignored
446600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
------------------------------------------------------------------------
IInnppuutt SSttyyllee
XXIICC VVaalluuee GGeeoommeettrryy SSttaattuuss SSttaattuuss SSttaattuuss SSttaattuuss
MMaannaaggeemmeenntt CCaallllbbaacckk AArreeaa NNootthhiinngg NNoonnee
------------------------------------------------------------------------
Background Ignored D-S-G D-S-G Ignored
Background Pixmap Ignored D-S-G D-S-G Ignored
Font Set GN Ignored D-S-G D-S-G Ignored
Line Spacing GN Ignored D-S-G D-S-G Ignored
Cursor Ignored D-S-G D-S-G Ignored
Status Callbacks C-S-G Ignored Ignored Ignored
------------------------------------------------------------------------
1133..55..66..11.. IInnppuutt SSttyyllee
The _X_N_I_n_p_u_t_S_t_y_l_e argument specifies the input style to be
used. The value of this argument must be one of the values
returned by the _X_G_e_t_I_M_V_a_l_u_e_s function with the _X_N_Q_u_e_r_y_I_n_p_u_t_-
_S_t_y_l_e argument specified in the supported_styles list.
Note that this argument must be set at creation time and
cannot be changed.
1133..55..66..22.. CClliieenntt WWiinnddooww
The _X_N_C_l_i_e_n_t_W_i_n_d_o_w argument specifies to the input method
the client window in which the input method can display data
or create subwindows. Geometry values for input method
areas are given with respect to the client window. Dynamic
change of client window is not supported. This argument may
be set only once and should be set before any input is done
using this input context. If it is not set, the input
method may not operate correctly.
If an attempt is made to set this value a second time with
_X_S_e_t_I_C_V_a_l_u_e_s, the string _X_N_C_l_i_e_n_t_W_i_n_d_o_w will be returned by
_X_S_e_t_I_C_V_a_l_u_e_s, and the client window will not be changed.
If the client window is not a valid window ID on the display
attached to the input method, a _B_a_d_W_i_n_d_o_w error can be gen-
erated when this value is used by the input method.
1133..55..66..33.. FFooccuuss WWiinnddooww
The _X_N_F_o_c_u_s_W_i_n_d_o_w argument specifies the focus window. The
primary purpose of the _X_N_F_o_c_u_s_W_i_n_d_o_w is to identify the win-
dow that will receive the key event when input is composed.
In addition, the input method may possibly affect the focus
window as follows:
· Select events on it
446611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Send events to it
· Modify its properties
· Grab the keyboard within that window
The associated value must be of type _W_i_n_d_o_w. If the focus
window is not a valid window ID on the display attached to
the input method, a _B_a_d_W_i_n_d_o_w error can be generated when
this value is used by the input method.
When this XIC value is left unspecified, the input method
will use the client window as the default focus window.
1133..55..66..44.. RReessoouurrccee NNaammee aanndd CCllaassss
The _X_N_R_e_s_o_u_r_c_e_N_a_m_e and _X_N_R_e_s_o_u_r_c_e_C_l_a_s_s arguments are strings
that specify the full name and class used by the client to
obtain resources for the client window. These values should
be used as prefixes for name and class when looking up
resources that may vary according to the input context. If
these values are not set, the resources will not be fully
specified.
It is not intended that values that can be set as XIC values
be set as resources.
1133..55..66..55.. GGeeoommeettrryy CCaallllbbaacckk
The _X_N_G_e_o_m_e_t_r_y_C_a_l_l_b_a_c_k argument is a structure of type _X_I_M_-
_C_a_l_l_b_a_c_k (see section 13.5.6.13.12).
The _X_N_G_e_o_m_e_t_r_y_C_a_l_l_b_a_c_k argument specifies the geometry call-
back that a client can set. This callback is not required
for correct operation of either an input method or a client.
It can be set for a client whose user interface policy per-
mits an input method to request the dynamic change of that
input method's window. An input method that does dynamic
change will need to filter any events that it uses to initi-
ate the change.
1133..55..66..66.. FFiilltteerr EEvveennttss
The _X_N_F_i_l_t_e_r_E_v_e_n_t_s argument returns the event mask that an
input method needs to have selected for. The client is
expected to augment its own event mask for the client window
with this one.
This argument is read-only, is set by the input method at
create time, and is never changed.
The type of this argument is _u_n_s_i_g_n_e_d _l_o_n_g. Setting this
value will cause an error.
446622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..55..66..77.. DDeessttrrooyy CCaallllbbaacckk
The _X_N_D_e_s_t_r_o_y_C_a_l_l_b_a_c_k argument is a pointer to a structure
of type _X_I_M_C_a_l_l_b_a_c_k (see section 13.5.6.13.12). This call-
back is triggered when the input method stops its service
for any reason; for example, when a connection to an IM
server is broken. After the destroy callback is called, the
input context is destroyed and the input method is closed.
Therefore, the client should not call _X_D_e_s_t_r_o_y_I_C and _X_C_l_o_-
_s_e_I_M.
1133..55..66..88.. SSttrriinngg CCoonnvveerrssiioonn CCaallllbbaacckk
The _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k argument is a structure of
type _X_I_M_C_a_l_l_b_a_c_k (see section 13.5.6.13.12).
The _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k argument specifies a string
conversion callback. This callback is not required for cor-
rect operation of either the input method or the client. It
can be set by a client to support string conversions that
may be requested by the input method. An input method that
does string conversions will filter any events that it uses
to initiate the conversion.
Because this XIC value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t before using
this argument.
1133..55..66..99.. SSttrriinngg CCoonnvveerrssiioonn
The _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n argument is a structure of type _X_I_M_-
_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_T_e_x_t.
The _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n argument specifies the string to be
converted by an input method. This argument is not required
for correct operation of either the input method or the
client.
String conversion facilitates the manipulation of text inde-
pendent of preediting. It is essential for some input meth-
ods and clients to manipulate text by performing context-
sensitive conversion, reconversion, or transliteration con-
version on it.
Because this XIC value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t before using
this argument.
The _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_T_e_x_t structure is defined as follows:
446633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XIMStringConversionText {
unsigned short length;
XIMStringConversionFeedback *feedback;
Bool encoding_is_wchar;
union {
char *mbs;
wchar_t *wcs;
} string;
} XIMStringConversionText;
typedef unsigned long XIMStringConversionFeedback;
││__
The feedback member is reserved for future use. The text to
be converted is defined by the string and length members.
The length is indicated in characters. To prevent the
library from freeing memory pointed to by an uninitialized
pointer, the client should set the feedback element to NULL.
1133..55..66..1100.. RReesseett SSttaattee
The _X_N_R_e_s_e_t_S_t_a_t_e argument specifies the state the input con-
text will return to after calling _X_m_b_R_e_s_e_t_I_C or _X_w_c_R_e_s_e_t_I_C.
The XIC state may be set to its initial state, as specified
by the _X_N_P_r_e_e_d_i_t_S_t_a_t_e value when _X_C_r_e_a_t_e_I_C was called, or it
may be set to preserve the current state.
The valid masks for _X_I_M_R_e_s_e_t_S_t_a_t_e are as follows:
__
││
typedef unsigned long XIMResetState;
#define _X_I_M_I_n_i_t_i_a_l_S_t_a_t_e (1L)
#define _X_I_M_P_r_e_s_e_r_v_e_S_t_a_t_e (1L<<1)
││__
If _X_I_M_I_n_i_t_i_a_l_S_t_a_t_e is set, then _X_m_b_R_e_s_e_t_I_C and _X_w_c_R_e_s_e_t_I_C
will return to the initial _X_N_P_r_e_e_d_i_t_S_t_a_t_e state of the XIC.
If _X_I_M_P_r_e_s_e_r_v_e_S_t_a_t_e is set, then _X_m_b_R_e_s_e_t_I_C and _X_w_c_R_e_s_e_t_I_C
will preserve the current state of the XIC.
If _X_N_R_e_s_e_t_S_t_a_t_e is left unspecified, the default is _X_I_M_I_n_i_-
_t_i_a_l_S_t_a_t_e.
446644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_I_M_R_e_s_e_t_S_t_a_t_e values other than those specified above will
default to _X_I_M_I_n_i_t_i_a_l_S_t_a_t_e.
Because this XIC value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t before using
this argument.
1133..55..66..1111.. HHoott KKeeyyss
The _X_N_H_o_t_K_e_y argument specifies the hot key list to the XIC.
The hot key list is a pointer to the structure of type
_X_I_M_H_o_t_K_e_y_T_r_i_g_g_e_r_s, which specifies the key events that must
be received without any interruption of the input method.
For the hot key list set with this argument to be utilized,
the client must also set _X_N_H_o_t_K_e_y_S_t_a_t_e to _X_I_M_H_o_t_K_e_y_S_t_a_t_e_O_N.
Because this XIC value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t before using
this functionality.
The value of the argument is a pointer to a structure of
type _X_I_M_H_o_t_K_e_y_T_r_i_g_g_e_r_s.
If an event for a key in the hot key list is found, then the
process will receive the event and it will be processed
inside the client.
__
││
typedef struct {
KeySym keysym;
unsigned int modifier;
unsigned int modifier_mask;
} XIMHotKeyTrigger;
typedef struct {
int num_hot_key;
XIMHotKeyTrigger *key;
} XIMHotKeyTriggers;
││__
The combination of modifier and modifier_mask are used to
represent one of three states for each modifier: either the
modifier must be on, or the modifier must be off, or the
modifier is a ``don't care'' - it may be on or off. When a
modifier_mask bit is set to 0, the state of the associated
modifier is ignored when evaluating whether the key is hot
or not.
446655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-----------------------------------------------------------
MMooddiiffiieerr BBiitt MMaasskk BBiitt MMeeaanniinngg
-----------------------------------------------------------
0 1 The modifier must be off.
1 1 The modifier must be on.
n/a 0 Do not care if the modifier is
on or off.
-----------------------------------------------------------
1133..55..66..1122.. HHoott KKeeyy SSttaattee
The _X_N_H_o_t_K_e_y_S_t_a_t_e argument specifies the hot key state of
the input method. This is usually used to switch the input
method between hot key operation and normal input process-
ing.
The value of the argument is a pointer to a structure of
type XIMHotKeyState .
__
││
typedef unsigned long XIMHotKeyState;
#define _X_I_M_H_o_t_K_e_y_S_t_a_t_e_O_N (0x0001L)
#define _X_I_M_H_o_t_K_e_y_S_t_a_t_e_O_F_F (0x0002L)
││__
If not specified, the default is _X_I_M_H_o_t_K_e_y_S_t_a_t_e_O_F_F.
1133..55..66..1133.. PPrreeeeddiitt aanndd SSttaattuuss AAttttrriibbuutteess
The _X_N_P_r_e_e_d_i_t_A_t_t_r_i_b_u_t_e_s and _X_N_S_t_a_t_u_s_A_t_t_r_i_b_u_t_e_s arguments
specify to an input method the attributes to be used for the
preedit and status areas, if any. Those attributes are
passed to _X_S_e_t_I_C_V_a_l_u_e_s or _X_G_e_t_I_C_V_a_l_u_e_s as a nested variable-
length list. The names to be used in these lists are
described in the following sections.
1133..55..66..1133..11.. AArreeaa
The value of the _X_N_A_r_e_a argument must be a pointer to a
structure of type _X_R_e_c_t_a_n_g_l_e_. The interpretation of the
_X_N_A_r_e_a argument is dependent on the input method style that
has been set.
If the input method style is _X_I_M_P_r_e_e_d_i_t_P_o_s_i_t_i_o_n, _X_N_A_r_e_a
specifies the clipping region within which preediting will
take place. If the focus window has been set, the coordi-
nates are assumed to be relative to the focus window.
446666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Otherwise, the coordinates are assumed to be relative to the
client window. If neither has been set, the results are
undefined.
If _X_N_A_r_e_a is not specified, is set to NULL, or is invalid,
the input method will default the clipping region to the
geometry of the _X_N_F_o_c_u_s_W_i_n_d_o_w. If the area specified is
NULL or invalid, the results are undefined.
If the input style is _X_I_M_P_r_e_e_d_i_t_A_r_e_a or _X_I_M_S_t_a_t_u_s_A_r_e_a,
_X_N_A_r_e_a specifies the geometry provided by the client to the
input method. The input method may use this area to display
its data, either preedit or status depending on the area
designated. The input method may create a window as a child
of the client window with dimensions that fit the _X_N_A_r_e_a.
The coordinates are relative to the client window. If the
client window has not been set yet, the input method should
save these values and apply them when the client window is
set. If _X_N_A_r_e_a is not specified, is set to NULL, or is
invalid, the results are undefined.
1133..55..66..1133..22.. AArreeaa NNeeeeddeedd
When set, the _X_N_A_r_e_a_N_e_e_d_e_d argument specifies the geometry
suggested by the client for this area (preedit or status).
The value associated with the argument must be a pointer to
a structure of type _X_R_e_c_t_a_n_g_l_e. Note that the x, y values
are not used and that nonzero values for width or height are
the constraints that the client wishes the input method to
respect.
When read, the _X_N_A_r_e_a_N_e_e_d_e_d argument specifies the preferred
geometry desired by the input method for the area.
This argument is only valid if the input style is _X_I_M_P_r_e_e_d_-
_i_t_A_r_e_a or _X_I_M_S_t_a_t_u_s_A_r_e_a. It is used for geometry negotia-
tion between the client and the input method and has no
other effect on the input method (see section 13.5.1.5).
1133..55..66..1133..33.. SSppoott LLooccaattiioonn
The _X_N_S_p_o_t_L_o_c_a_t_i_o_n argument specifies to the input method
the coordinates of the spot to be used by an input method
executing with _X_N_I_n_p_u_t_S_t_y_l_e set to _X_I_M_P_r_e_e_d_i_t_P_o_s_i_t_i_o_n. When
specified to any input method other than _X_I_M_P_r_e_e_d_i_t_P_o_s_i_t_i_o_n,
this XIC value is ignored.
The x coordinate specifies the position where the next char-
acter would be inserted. The y coordinate is the position
of the baseline used by the current text line in the focus
window. The x and y coordinates are relative to the focus
window, if it has been set; otherwise, they are relative to
the client window. If neither the focus window nor the
client window has been set, the results are undefined.
446677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The value of the argument is a pointer to a structure of
type _X_P_o_i_n_t.
1133..55..66..1133..44.. CCoolloorrmmaapp
Two different arguments can be used to indicate what col-
ormap the input method should use to allocate colors, a col-
ormap ID, or a standard colormap name.
The _X_N_C_o_l_o_r_m_a_p argument is used to specify a colormap ID.
The argument value is of type _C_o_l_o_r_m_a_p. An invalid argument
may generate a _B_a_d_C_o_l_o_r error when it is used by the input
method.
The _X_N_S_t_d_C_o_l_o_r_m_a_p argument is used to indicate the name of
the standard colormap in which the input method should allo-
cate colors. The argument value is an _A_t_o_m that should be a
valid atom for calling _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s. An invalid argu-
ment may generate a _B_a_d_A_t_o_m error when it is used by the
input method.
If the colormap is left unspecified, the client window col-
ormap becomes the default.
1133..55..66..1133..55.. FFoorreeggrroouunndd aanndd BBaacckkggrroouunndd
The _X_N_F_o_r_e_g_r_o_u_n_d and _X_N_B_a_c_k_g_r_o_u_n_d arguments specify the
foreground and background pixel, respectively. The argument
value is of type _u_n_s_i_g_n_e_d _l_o_n_g. It must be a valid pixel in
the input method colormap.
If these values are left unspecified, the default is deter-
mined by the input method.
1133..55..66..1133..66.. BBaacckkggrroouunndd PPiixxmmaapp
The _X_N_B_a_c_k_g_r_o_u_n_d_P_i_x_m_a_p argument specifies a background
pixmap to be used as the background of the window. The
value must be of type _P_i_x_m_a_p. An invalid argument may gen-
erate a _B_a_d_P_i_x_m_a_p error when it is used by the input method.
If this value is left unspecified, the default is determined
by the input method.
1133..55..66..1133..77.. FFoonntt SSeett
The _X_N_F_o_n_t_S_e_t argument specifies to the input method what
font set is to be used. The argument value is of type
_X_F_o_n_t_S_e_t.
If this value is left unspecified, the default is determined
by the input method.
446688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..55..66..1133..88.. LLiinnee SSppaacciinngg
The _X_N_L_i_n_e_S_p_a_c_e argument specifies to the input method what
line spacing is to be used in the preedit window if more
than one line is to be used. This argument is of type _i_n_t.
If this value is left unspecified, the default is determined
by the input method.
1133..55..66..1133..99.. CCuurrssoorr
The _X_N_C_u_r_s_o_r argument specifies to the input method what
cursor is to be used in the specified window. This argument
is of type _C_u_r_s_o_r.
An invalid argument may generate a _B_a_d_C_u_r_s_o_r error when it
is used by the input method. If this value is left unspeci-
fied, the default is determined by the input method.
1133..55..66..1133..1100.. PPrreeeeddiitt SSttaattee
The _X_N_P_r_e_e_d_i_t_S_t_a_t_e argument specifies the state of input
preediting for the input method. Input preediting can be on
or off.
The valid mask names for _X_N_P_r_e_e_d_i_t_S_t_a_t_e are as follows:
__
││
typedef unsigned long XIMPreeditState;
#define _X_I_M_P_r_e_e_d_i_t_U_n_k_n_o_w_n 0L
#define _X_I_M_P_r_e_e_d_i_t_E_n_a_b_l_e 1L
#define _X_I_M_P_r_e_e_d_i_t_D_i_s_a_b_l_e (1L<<1)
││__
If a value of _X_I_M_P_r_e_e_d_i_t_E_n_a_b_l_e is set, then input preediting
is turned on by the input method.
If a value of _X_I_M_P_r_e_e_d_i_t_D_i_s_a_b_l_e is set, then input preedit-
ing is turned off by the input method.
If _X_N_P_r_e_e_d_i_t_S_t_a_t_e is left unspecified, then the state will
be implementation-dependent.
When _X_N_R_e_s_e_t_S_t_a_t_e is set to _X_I_M_I_n_i_t_i_a_l_S_t_a_t_e, the _X_N_P_r_e_e_d_i_t_-
_S_t_a_t_e value specified at the creation time will be reflected
as the initial state for _X_m_b_R_e_s_e_t_I_C and _X_w_c_R_e_s_e_t_I_C.
Because this XIC value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t before using
446699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
this argument.
1133..55..66..1133..1111.. PPrreeeeddiitt SSttaattee NNoottiiffyy CCaallllbbaacckk
The preedit state notify callback is triggered by the input
method when the preediting state has changed. The value of
the _X_N_P_r_e_e_d_i_t_S_t_a_t_e_N_o_t_i_f_y_C_a_l_l_b_a_c_k argument is a pointer to a
structure of type _X_I_M_C_a_l_l_b_a_c_k. The generic prototype is as
follows:
__
││
void PreeditStateNotifyCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XIMPreeditStateNotifyCallbackStruct *_c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Specifies the current preedit state.
││__
The _X_I_M_P_r_e_e_d_i_t_S_t_a_t_e_N_o_t_i_f_y_C_a_l_l_b_a_c_k_S_t_r_u_c_t structure is defined
as follows:
__
││
typedef struct _XIMPreeditStateNotifyCallbackStruct {
XIMPreeditState state;
} XIMPreeditStateNotifyCallbackStruct;
││__
Because this XIC value is optional, a client should call
_X_G_e_t_I_M_V_a_l_u_e_s with argument _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t before using
this argument.
1133..55..66..1133..1122.. PPrreeeeddiitt aanndd SSttaattuuss CCaallllbbaacckkss
A client that wants to support the input style _X_I_M_P_r_e_e_d_i_t_-
_C_a_l_l_b_a_c_k_s must provide a set of preedit callbacks to the
input method. The set of preedit callbacks is as follows:
_X_N_P_r_e_e_d_i_t_S_t_a_r_t_- This is called when the input method
_C_a_l_l_b_a_c_k starts preedit.
_X_N_P_r_e_e_d_i_t_- This is called when the input method
_D_o_n_e_C_a_l_l_b_a_c_k stops preedit.
_X_N_P_r_e_e_d_i_t_D_r_a_w_- This is called when a number of preedit
_C_a_l_l_b_a_c_k keystrokes should be echoed.
447700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_N_P_r_e_e_d_i_t_C_a_r_e_t_- This is called to move the text inser-
_C_a_l_l_b_a_c_k tion point within the preedit string.
A client that wants to support the input style _X_I_M_S_t_a_t_u_s_-
_C_a_l_l_b_a_c_k_s must provide a set of status callbacks to the
input method. The set of status callbacks is as follows:
_X_N_S_t_a_t_u_s_S_t_a_r_t_- This is called when the input method
_C_a_l_l_b_a_c_k initializes the status area.
_X_N_S_t_a_t_u_s_D_o_n_e_C_a_l_l_- This is called when the input method no
_b_a_c_k longer needs the status area.
_X_N_S_t_a_t_u_s_D_r_a_w_C_a_l_l_- This is called when updating of the sta-
_b_a_c_k tus area is required.
The value of any status or preedit argument is a pointer to
a structure of type _X_I_M_C_a_l_l_b_a_c_k.
__
││
typedef void (*XIMProc)();
typedef struct {
XPointer client_data;
XIMProc callback;
} XIMCallback;
││__
Each callback has some particular semantics and will carry
the data that expresses the environment necessary to the
client into a specific data structure. This paragraph only
describes the arguments to be used to set the callback.
Setting any of these values while doing preedit may cause
unexpected results.
1133..55..77.. IInnppuutt MMeetthhoodd CCaallllbbaacckk SSeemmaannttiiccss
XIM callbacks are procedures defined by clients or text
drawing packages that are to be called from the input method
when selected events occur. Most clients will use a text
editing package or a toolkit and, hence, will not need to
define such callbacks. This section defines the callback
semantics, when they are triggered, and what their arguments
are. This information is mostly useful for X toolkit imple-
mentors.
Callbacks are mostly provided so that clients (or text edit-
ing packages) can implement on-the-spot preediting in their
own window. In that case, the input method needs to commu-
nicate and synchronize with the client. The input method
needs to communicate changes in the preedit window when it
447711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
is under control of the client. Those callbacks allow the
client to initialize the preedit area, display a new preedit
string, move the text insertion point during preedit, termi-
nate preedit, or update the status area.
All callback procedures follow the generic prototype:
__
││
void CallbackPrototype(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
SomeType _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Specifies data specific to the callback.
││__
The call_data argument is a structure that expresses the
arguments needed to achieve the semantics; that is, it is a
specific data structure appropriate to the callback. In
cases where no data is needed in the callback, this
call_data argument is NULL. The client_data argument is a
closure that has been initially specified by the client when
specifying the callback and passed back. It may serve, for
example, to inherit application context in the callback.
The following paragraphs describe the programming semantics
and specific data structure associated with the different
reasons.
1133..55..77..11.. GGeeoommeettrryy CCaallllbbaacckk
The geometry callback is triggered by the input method to
indicate that it wants the client to negotiate geometry.
The generic prototype is as follows:
447722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void GeometryCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
The callback is called with a NULL call_data argument.
1133..55..77..22.. DDeessttrrooyy CCaallllbbaacckk
The destroy callback is triggered by the input method when
it stops service for any reason. After the callback is
invoked, the input context will be freed by Xlib. The
generic prototype is as follows:
__
││
void DestroyCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
The callback is called with a NULL call_data argument.
1133..55..77..33.. SSttrriinngg CCoonnvveerrssiioonn CCaallllbbaacckk
The string conversion callback is triggered by the input
method to request the client to return the string to be con-
verted. The returned string may be either a multibyte or
wide character string, with an encoding matching the locale
bound to the input context. The callback prototype is as
follows:
447733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void StringConversionCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XIMStringConversionCallbackStruct *_c_a_l_l___d_a_t_a;
_i_c Specifies the input method.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Specifies the amount of the string to be con-
verted.
││__
The callback is passed an _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k_S_t_r_u_c_t
structure in the call_data argument. The text member is an
_X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_T_e_x_t structure (see section 13.5.6.9) to
be filled in by the client and describes the text to be sent
to the input method. The data pointed to by the string and
feedback elements of the _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_T_e_x_t structure
will be freed using _X_F_r_e_e by the input method after the
callback returns. So the client should not point to inter-
nal buffers that are critical to the client. Similarly,
because the feedback element is currently reserved for
future use, the client should set feedback to NULL to pre-
vent the library from freeing memory at some random location
due to an uninitialized pointer.
The _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k_S_t_r_u_c_t structure is defined
as follows:
447744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XIMStringConversionCallbackStruct {
XIMStringConversionPosition position;
XIMCaretDirection direction;
short factor;
XIMStringConversionOperation operation;
XIMStringConversionText *text;
} XIMStringConversionCallbackStruct;
typedef short XIMStringConversionPosition;
typedef unsigned short XIMStringConversionOperation;
#define _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_S_u_b_s_t_i_t_u_- (0x0001)
_t_i_o_n
#define _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_R_e_t_r_i_e_v_a_l (0x0002)
││__
_X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_P_o_s_i_t_i_o_n specifies the starting position
of the string to be returned in the _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_T_e_x_t
structure. The value identifies a position, in units of
characters, relative to the client's cursor position in the
client's buffer.
The ending position of the text buffer is determined by the
direction and factor members. Specifically, it is the char-
acter position relative to the starting point as defined by
the _X_I_M_C_a_r_e_t_D_i_r_e_c_t_i_o_n. The factor member of _X_I_M_S_t_r_i_n_g_C_o_n_-
_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k_S_t_r_u_c_t specifies the number of _X_I_M_C_a_r_e_t_D_i_r_e_c_-
_t_i_o_n positions to be applied. For example, if the direction
specifies _X_I_M_L_i_n_e_E_n_d and factor is 1, then all characters
from the starting position to the end of the current display
line are returned. If the direction specifies _X_I_M_F_o_r_w_a_r_d_-
_C_h_a_r or _X_I_M_B_a_c_k_w_a_r_d_C_h_a_r, then the factor specifies a rela-
tive position, indicated in characters, from the starting
position.
_X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_O_p_e_r_a_t_i_o_n specifies whether the string to
be converted should be deleted (substitution) or copied
(retrieval) from the client's buffer. When the _X_I_M_S_t_r_i_n_g_-
_C_o_n_v_e_r_s_i_o_n_O_p_e_r_a_t_i_o_n is _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_S_u_b_s_t_i_t_u_t_i_o_n, the
client must delete the string to be converted from its own
buffer. When the _X_I_M_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_O_p_e_r_a_t_i_o_n is _X_I_M_S_t_r_i_n_g_-
_C_o_n_v_e_r_s_i_o_n_R_e_t_r_i_e_v_a_l, the client must not delete the string
to be converted from its buffer. The substitute operation
is typically used for reconversion and transliteration con-
version, while the retrieval operation is typically used for
context-sensitive conversion.
447755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1133..55..77..44.. PPrreeeeddiitt SSttaattee CCaallllbbaacckkss
When the input method turns preediting on or off, a _P_r_e_e_d_i_t_-
_S_t_a_r_t_C_a_l_l_b_a_c_k or _P_r_e_e_d_i_t_D_o_n_e_C_a_l_l_b_a_c_k callback is triggered
to let the toolkit do the setup or the cleanup for the
preedit region.
__
││
int PreeditStartCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
When preedit starts on the specified input context, the
callback is called with a NULL call_data argument. _P_r_e_e_d_i_t_-
_S_t_a_r_t_C_a_l_l_b_a_c_k will return the maximum size of the preedit
string. A positive number indicates the maximum number of
bytes allowed in the preedit string, and a value of -1 indi-
cates there is no limit.
__
││
void PreeditDoneCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
When preedit stops on the specified input context, the call-
back is called with a NULL call_data argument. The client
can release the data allocated by _P_r_e_e_d_i_t_S_t_a_r_t_C_a_l_l_b_a_c_k.
_P_r_e_e_d_i_t_S_t_a_r_t_C_a_l_l_b_a_c_k should initialize appropriate data
needed for displaying preedit information and for handling
further _P_r_e_e_d_i_t_D_r_a_w_C_a_l_l_b_a_c_k calls. Once _P_r_e_e_d_i_t_S_t_a_r_t_C_a_l_l_-
_b_a_c_k is called, it will not be called again before
447766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_P_r_e_e_d_i_t_D_o_n_e_C_a_l_l_b_a_c_k has been called.
1133..55..77..55.. PPrreeeeddiitt DDrraaww CCaallllbbaacckk
This callback is triggered to draw and insert, delete or
replace, preedit text in the preedit region. The preedit
text may include unconverted input text such as Japanese
Kana, converted text such as Japanese Kanji characters, or
characters of both kinds. That string is either a multibyte
or wide character string, whose encoding matches the locale
bound to the input context. The callback prototype is as
follows:
__
││
void PreeditDrawCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XIMPreeditDrawCallbackStruct *_c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Specifies the preedit drawing information.
││__
The callback is passed an _X_I_M_P_r_e_e_d_i_t_D_r_a_w_C_a_l_l_b_a_c_k_S_t_r_u_c_t
structure in the call_data argument. The text member of
this structure contains the text to be drawn. After the
string has been drawn, the caret should be moved to the
specified location.
The _X_I_M_P_r_e_e_d_i_t_D_r_a_w_C_a_l_l_b_a_c_k_S_t_r_u_c_t structure is defined as
follows:
__
││
typedef struct _XIMPreeditDrawCallbackStruct {
int caret; /* Cursor offset within preedit string */
int chg_first; /* Starting change position */
int chg_length; /* Length of the change in character count */
XIMText *text;
} XIMPreeditDrawCallbackStruct;
││__
The client must keep updating a buffer of the preedit text
and the callback arguments referring to indexes in that
buffer. The call_data fields have specific meanings accord-
ing to the operation, as follows:
447777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· To indicate text deletion, the call_data member speci-
fies a NULL text field. The text to be deleted is then
the current text in the buffer from position chg_first
(starting at zero) on a character length of chg_length.
· When text is non-NULL, it indicates insertion or
replacement of text in the buffer.
The chg_length member identifies the number of charac-
ters in the current preedit buffer that are affected by
this call. A positive chg_length indicates that
chg_length number of characters, starting at chg_first,
must be deleted or must be replaced by text, whose
length is specified in the _X_I_M_T_e_x_t structure.
A chg_length value of zero indicates that text must be
inserted right at the position specified by chg_first.
A value of zero for chg_first specifies the first char-
acter in the buffer.
chg_length and chg_first combine to identify the modi-
fication required to the preedit buffer; beginning at
chg_first, replace chg_length number of characters with
the text in the supplied _X_I_M_T_e_x_t structure. For exam-
ple, suppose the preedit buffer contains the string
"ABCDE".
Text: A B C D E
^ ^ ^ ^ ^ ^
CharPos: 0 1 2 3 4 5
The CharPos in the diagram shows the location of the
character position relative to the character.
If the value of chg_first is 1 and the value of
chg_length is 3, this says to replace 3 characters
beginning at character position 1 with the string in
the _X_I_M_T_e_x_t structure. Hence, BCD would be replaced by
the value in the structure.
Though chg_length and chg_first are both signed inte-
gers they will never have a negative value.
· The caret member identifies the character position
before which the cursor should be placed - after modi-
fication to the preedit buffer has been completed. For
example, if caret is zero, the cursor is at the begin-
ning of the buffer. If the caret is one, the cursor is
between the first and second character.
447788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XIMText {
unsigned short length;
XIMFeedback * feedback;
Bool encoding_is_wchar;
union {
char * multi_byte;
wchar_t * wide_char;
} string;
} XIMText;
││__
The text string passed is actually a structure specifying as
follows:
· The length member is the text length in characters.
· The encoding_is_wchar member is a value that indicates
if the text string is encoded in wide character or
multibyte format. The text string may be passed either
as multibyte or as wide character; the input method
controls in which form data is passed. The client's
callback routine must be able to handle data passed in
either form.
· The string member is the text string.
· The feedback member indicates rendering type for each
character in the string member. If string is NULL
(indicating that only highlighting of the existing
preedit buffer should be updated), feedback points to
length highlight elements that should be applied to the
existing preedit buffer, beginning at chg_first.
The feedback member expresses the types of rendering feed-
back the callback should apply when drawing text. Rendering
of the text to be drawn is specified either in generic ways
(for example, primary, secondary) or in specific ways
(reverse, underline). When generic indications are given,
the client is free to choose the rendering style. It is
necessary, however, that primary and secondary be mapped to
two distinct rendering styles.
If an input method wants to control display of the preedit
string, an input method can indicate the visibility hints
using feedbacks in a specific way. The _X_I_M_V_i_s_i_b_l_e_T_o_F_o_r_w_a_r_d,
_X_I_M_V_i_s_i_b_l_e_T_o_B_a_c_k_w_a_r_d, and _X_I_M_V_i_s_i_b_l_e_C_e_n_t_e_r masks are exclu-
sively used for these visibility hints. The _X_I_M_V_i_s_i_b_l_e_T_o_-
_F_o_r_w_a_r_d mask indicates that the preedit text is preferably
displayed in the primary draw direction from the caret posi-
tion in the preedit area forward. The _X_I_M_V_i_s_i_b_l_e_T_o_B_a_c_k_w_a_r_d
mask indicates that the preedit text is preferably displayed
from the caret position in the preedit area backward,
447799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
relative to the primary draw direction. The _X_I_M_V_i_s_i_b_l_e_C_e_n_-
_t_e_r mask indicates that the preedit text is preferably dis-
played with the caret position in the preedit area centered.
The insertion point of the preedit string could exist out-
side of the visible area when visibility hints are used.
Only one of the masks is valid for the entire preedit
string, and only one character can hold one of these feed-
backs for a given input context at one time. This feedback
may be OR'ed together with another highlight (such as _X_I_M_R_e_-
_v_e_r_s_e). Only the most recently set feedback is valid, and
any previous feedback is automatically canceled. This is a
hint to the client, and the client is free to choose how to
display the preedit string.
The feedback member also specifies how rendering of the text
argument should be performed. If the feedback is NULL, the
callback should apply the same feedback as is used for the
surrounding characters in the preedit buffer; if chg_first
is at a highlight boundary, the client can choose which of
the two highlights to use. If feedback is not NULL, feed-
back specifies an array defining the rendering for each
character of the string, and the length of the array is thus
length.
If an input method wants to indicate that it is only updat-
ing the feedback of the preedit text without changing the
content of it, the _X_I_M_T_e_x_t structure will contain a NULL
value for the string field, the number of characters
affected (relative to chg_first) will be in the length
field, and the feedback field will point to an array of _X_I_M_-
_F_e_e_d_b_a_c_k.
Each element in the feedback array is a bitmask represented
by a value of type _X_I_M_F_e_e_d_b_a_c_k. The valid mask names are as
follows:
448800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef unsigned long XIMFeedback;
#define _X_I_M_R_e_v_e_r_s_e 1L
#define _X_I_M_U_n_d_e_r_l_i_n_e (1L<<1)
#define _X_I_M_H_i_g_h_l_i_g_h_t (1L<<2)
#define _X_I_M_P_r_i_m_a_r_y (1L<<5)†
#define _X_I_M_S_e_c_o_n_d_a_r_y (1L<<6)†
#define _X_I_M_T_e_r_t_i_a_r_y (1L<<7)†
#define _X_I_M_V_i_s_i_b_l_e_T_o_F_o_r_w_a_r_d (1L<<8)
#define _X_I_M_V_i_s_i_b_l_e_T_o_B_a_c_k_w_a_r_d (1L<<9)
#define _X_I_M_V_i_s_i_b_l_e_C_e_n_t_e_r (1L<<10)
││__
Characters drawn with the _X_I_M_R_e_v_e_r_s_e highlight should be
drawn by swapping the foreground and background colors used
to draw normal, unhighlighted characters. Characters drawn
with the _X_I_M_U_n_d_e_r_l_i_n_e highlight should be underlined. Char-
acters drawn with the _X_I_M_H_i_g_h_l_i_g_h_t, _X_I_M_P_r_i_m_a_r_y, _X_I_M_S_e_c_-
_o_n_d_a_r_y, and _X_I_M_T_e_r_t_i_a_r_y highlights should be drawn in some
unique manner that must be different from _X_I_M_R_e_v_e_r_s_e and
_X_I_M_U_n_d_e_r_l_i_n_e.
1133..55..77..66.. PPrreeeeddiitt CCaarreett CCaallllbbaacckk
An input method may have its own navigation keys to allow
the user to move the text insertion point in the preedit
area (for example, to move backward or forward). Conse-
quently, input method needs to indicate to the client that
it should move the text insertion point. It then calls the
PreeditCaretCallback.
-----------
† The values for _X_I_M_P_r_i_m_a_r_y, _X_I_M_S_e_c_o_n_d_a_r_y, and
_X_I_M_T_e_r_t_i_a_r_y were incorrectly defined in the R5
specification. The X Consortium's X11R5 implemen-
tation correctly implemented the values for these
highlights. The value of these highlights has
been corrected in this specification to agree with
the values in the Consortium's X11R5 and X11R6
implementations.
448811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void PreeditCaretCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XIMPreeditCaretCallbackStruct *_c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Specifies the preedit caret information.
││__
The input method will trigger PreeditCaretCallback to move
the text insertion point during preedit. The call_data
argument contains a pointer to an _X_I_M_P_r_e_e_d_i_t_C_a_r_e_t_C_a_l_l_b_a_c_k_-
_S_t_r_u_c_t structure, which indicates where the caret should be
moved. The callback must move the insertion point to its
new location and return, in field position, the new offset
value from the initial position.
The _X_I_M_P_r_e_e_d_i_t_C_a_r_e_t_C_a_l_l_b_a_c_k_S_t_r_u_c_t structure is defined as
follows:
__
││
typedef struct _XIMPreeditCaretCallbackStruct {
int position; /* Caret offset within preedit string */
XIMCaretDirection direction;/* Caret moves direction */
XIMCaretStyle style;/* Feedback of the caret */
} XIMPreeditCaretCallbackStruct;
││__
The _X_I_M_C_a_r_e_t_S_t_y_l_e structure is defined as follows:
__
││
typedef enum {
XIMIsInvisible, /* Disable caret feedback */
XIMIsPrimary, /* UI defined caret feedback */
XIMIsSecondary, /* UI defined caret feedback */
} XIMCaretStyle;
││__
The _X_I_M_C_a_r_e_t_D_i_r_e_c_t_i_o_n structure is defined as follows:
448822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef enum {
XIMForwardChar, XIMBackwardChar,
XIMForwardWord, XIMBackwardWord,
XIMCaretUp, XIMCaretDown,
XIMNextLine, XIMPreviousLine,
XIMLineStart, XIMLineEnd,
XIMAbsolutePosition,
XIMDontChange,
} XIMCaretDirection;
││__
These values are defined as follows:
_X_I_M_F_o_r_w_a_r_d_C_h_a_r Move the caret forward one character posi-
tion.
_X_I_M_B_a_c_k_w_a_r_d_C_h_a_r Move the caret backward one character
position.
_X_I_M_F_o_r_w_a_r_d_W_o_r_d Move the caret forward one word.
_X_I_M_B_a_c_k_w_a_r_d_W_o_r_d Move the caret backward one word.
_X_I_M_C_a_r_e_t_U_p Move the caret up one line keeping the
current horizontal offset.
_X_I_M_C_a_r_e_t_D_o_w_n Move the caret down one line keeping the
current horizontal offset.
_X_I_M_P_r_e_v_i_o_u_s_L_i_n_e Move the caret to the beginning of the
previous line.
_X_I_M_N_e_x_t_L_i_n_e Move the caret to the beginning of the
next line.
_X_I_M_L_i_n_e_S_t_a_r_t Move the caret to the beginning of the
current display line that contains the
caret.
_X_I_M_L_i_n_e_E_n_d Move the caret to the end of the current
display line that contains the caret.
_X_I_M_A_b_s_o_l_u_t_e_P_o_- The callback must move to the location
_s_i_t_i_o_n specified by the position field of the
callback data, indicated in characters,
starting from the beginning of the preedit
text. Hence, a value of zero means move
back to the beginning of the preedit text.
_X_I_M_D_o_n_t_C_h_a_n_g_e The caret position does not change.
1133..55..77..77.. SSttaattuuss CCaallllbbaacckkss
An input method may communicate changes in the status of an
input context (for example, created, destroyed, or focus
changes) with three status callbacks: StatusStartCallback,
StatusDoneCallback, and StatusDrawCallback.
When the input context is created or gains focus, the input
method calls the StatusStartCallback callback.
448833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void StatusStartCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
The callback should initialize appropriate data for display-
ing status and for responding to StatusDrawCallback calls.
Once StatusStartCallback is called, it will not be called
again before StatusDoneCallback has been called.
When an input context is destroyed or when it loses focus,
the input method calls StatusDoneCallback.
__
││
void StatusDoneCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XPointer _c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Not used for this callback and always passed as
NULL.
││__
The callback may release any data allocated on _S_t_a_t_u_s_S_t_a_r_t.
When an input context status has to be updated, the input
method calls StatusDrawCallback.
448844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void StatusDrawCallback(_i_c, _c_l_i_e_n_t___d_a_t_a, _c_a_l_l___d_a_t_a)
XIC _i_c;
XPointer _c_l_i_e_n_t___d_a_t_a;
XIMStatusDrawCallbackStruct *_c_a_l_l___d_a_t_a;
_i_c Specifies the input context.
_c_l_i_e_n_t___d_a_t_a
Specifies the additional client data.
_c_a_l_l___d_a_t_a Specifies the status drawing information.
││__
The callback should update the status area by either drawing
a string or imaging a bitmap in the status area.
The _X_I_M_S_t_a_t_u_s_D_a_t_a_T_y_p_e and _X_I_M_S_t_a_t_u_s_D_r_a_w_C_a_l_l_b_a_c_k_S_t_r_u_c_t struc-
tures are defined as follows:
__
││
typedef enum {
XIMTextType,
XIMBitmapType,
} XIMStatusDataType;
typedef struct _XIMStatusDrawCallbackStruct {
XIMStatusDataType type;
union {
XIMText *text;
Pixmap bitmap;
} data;
} XIMStatusDrawCallbackStruct;
││__
The feedback styles _X_I_M_V_i_s_i_b_l_e_T_o_F_o_r_w_a_r_d, _X_I_M_V_i_s_i_b_l_e_T_o_B_a_c_k_-
_w_a_r_d, and _X_I_M_V_i_s_i_b_l_e_T_o_C_e_n_t_e_r are not relevant and will not
appear in the _X_I_M_F_e_e_d_b_a_c_k element of the _X_I_M_T_e_x_t structure.
1133..55..88.. EEvveenntt FFiilltteerriinngg
Xlib provides the ability for an input method to register a
filter internal to Xlib. This filter is called by a client
(or toolkit) by calling _X_F_i_l_t_e_r_E_v_e_n_t after calling _X_N_e_x_-
_t_E_v_e_n_t. Any client that uses the _X_I_M interface should call
_X_F_i_l_t_e_r_E_v_e_n_t to allow input methods to process their events
without knowledge of the client's dispatching mechanism. A
client's user interface policy may determine the priority of
event filters with respect to other event-handling
448855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
mechanisms (for example, modal grabs).
Clients may not know how many filters there are, if any, and
what they do. They may only know if an event has been fil-
tered on return of _X_F_i_l_t_e_r_E_v_e_n_t. Clients should discard
filtered events.
To filter an event, use _X_F_i_l_t_e_r_E_v_e_n_t.
__
││
Bool XFilterEvent(_e_v_e_n_t, _w)
XEvent *_e_v_e_n_t;
Window _w;
_e_v_e_n_t Specifies the event to filter.
_w Specifies the window for which the filter is to be
applied.
││__
If the window argument is _N_o_n_e, _X_F_i_l_t_e_r_E_v_e_n_t applies the
filter to the window specified in the _X_E_v_e_n_t structure. The
window argument is provided so that layers above Xlib that
do event redirection can indicate to which window an event
has been redirected.
If _X_F_i_l_t_e_r_E_v_e_n_t returns _T_r_u_e, then some input method has
filtered the event, and the client should discard the event.
If _X_F_i_l_t_e_r_E_v_e_n_t returns _F_a_l_s_e, then the client should con-
tinue processing the event.
If a grab has occurred in the client and _X_F_i_l_t_e_r_E_v_e_n_t
returns _T_r_u_e, the client should ungrab the keyboard.
1133..55..99.. GGeettttiinngg KKeeyybbooaarrdd IInnppuutt
To get composed input from an input method, use _X_m_b_L_o_o_k_u_p_-
_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g.
448866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XmbLookupString(_i_c, _e_v_e_n_t, _b_u_f_f_e_r___r_e_t_u_r_n, _b_y_t_e_s___b_u_f_f_e_r, _k_e_y_s_y_m___r_e_t_u_r_n, _s_t_a_t_u_s___r_e_t_u_r_n)
XIC _i_c;
XKeyPressedEvent *_e_v_e_n_t;
char *_b_u_f_f_e_r___r_e_t_u_r_n;
int _b_y_t_e_s___b_u_f_f_e_r;
KeySym *_k_e_y_s_y_m___r_e_t_u_r_n;
Status *_s_t_a_t_u_s___r_e_t_u_r_n;
int XwcLookupString(_i_c, _e_v_e_n_t, _b_u_f_f_e_r___r_e_t_u_r_n, _b_y_t_e_s___b_u_f_f_e_r, _k_e_y_s_y_m___r_e_t_u_r_n, _s_t_a_t_u_s___r_e_t_u_r_n)
XIC _i_c;
XKeyPressedEvent *_e_v_e_n_t;
wchar_t *_b_u_f_f_e_r___r_e_t_u_r_n;
int _w_c_h_a_r_s___b_u_f_f_e_r;
KeySym *_k_e_y_s_y_m___r_e_t_u_r_n;
Status *_s_t_a_t_u_s___r_e_t_u_r_n;
_i_c Specifies the input context.
_e_v_e_n_t Specifies the key event to be used.
_b_u_f_f_e_r___r_e_t_u_r_n
Returns a multibyte string or wide character
string (if any) from the input method.
_b_y_t_e_s___b_u_f_f_e_r
_w_c_h_a_r_s___b_u_f_f_e_r
Specifies space available in the return buffer.
_k_e_y_s_y_m___r_e_t_u_r_n
Returns the KeySym computed from the event if this
argument is not NULL.
_s_t_a_t_u_s___r_e_t_u_r_n
Returns a value indicating what kind of data is
returned.
││__
The _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g functions return the
string from the input method specified in the buffer_return
argument. If no string is returned, the buffer_return argu-
ment is unchanged.
The KeySym into which the KeyCode from the event was mapped
is returned in the keysym_return argument if it is non-NULL
and the status_return argument indicates that a KeySym was
returned. If both a string and a KeySym are returned, the
KeySym value does not necessarily correspond to the string
returned.
_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g returns the length of the string in bytes,
and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g returns the length of the string in
448877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
characters. Both _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g return
text in the encoding of the locale bound to the input method
of the specified input context.
Each string returned by _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g
begins in the initial state of the encoding of the locale
(if the encoding of the locale is state-dependent).
Note
To insure proper input processing, it is essential
that the client pass only _K_e_y_P_r_e_s_s events to
_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g. Their behav-
ior when a client passes a _K_e_y_R_e_l_e_a_s_e event is
undefined.
Clients should check the status_return argument before using
the other returned values. These two functions both return
a value to status_return that indicates what has been
returned in the other arguments. The possible values
returned are:
_X_B_u_f_f_e_r_O_v_e_r_f_l_o_w The input string to be returned is too
large for the supplied buffer_return. The
required size (_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g in bytes;
_X_w_c_L_o_o_k_u_p_S_t_r_i_n_g in characters) is returned
as the value of the function, and the con-
tents of buffer_return and keysym_return
are not modified. The client should recall
the function with the same event and a
buffer of adequate size to obtain the
string.
_X_L_o_o_k_u_p_N_o_n_e No consistent input has been composed so
far. The contents of buffer_return and
keysym_return are not modified, and the
function returns zero.
_X_L_o_o_k_u_p_C_h_a_r_s Some input characters have been composed.
They are placed in the buffer_return argu-
ment, and the string length is returned as
the value of the function. The string is
encoded in the locale bound to the input
context. The content of the keysym_return
argument is not modified.
_X_L_o_o_k_u_p_K_e_y_S_y_m A KeySym has been returned instead of a
string and is returned in keysym_return.
The content of the buffer_return argument
is not modified, and the function returns
zero.
_X_L_o_o_k_u_p_B_o_t_h Both a KeySym and a string are returned;
_X_L_o_o_k_u_p_C_h_a_r_s and _X_L_o_o_k_u_p_K_e_y_S_y_m occur simul-
taneously.
448888
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
It does not make any difference if the input context passed
as an argument to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g is the
one currently in possession of the focus or not. Input may
have been composed within an input context before it lost
the focus, and that input may be returned on subsequent
calls to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g even though it
does not have any more keyboard focus.
1133..55..1100.. IInnppuutt MMeetthhoodd CCoonnvveennttiioonnss
The input method architecture is transparent to the client.
However, clients should respect a number of conventions in
order to work properly. Clients must also be aware of pos-
sible effects of synchronization between input method and
library in the case of a remote input server.
1133..55..1100..11.. CClliieenntt CCoonnvveennttiioonnss
A well-behaved client (or toolkit) should first query the
input method style. If the client cannot satisfy the
requirements of the supported styles (in terms of geometry
management or callbacks), it should negotiate with the user
continuation of the program or raise an exception or error
of some sort.
1133..55..1100..22.. SSyynncchhrroonniizzaattiioonn CCoonnvveennttiioonnss
A _K_e_y_P_r_e_s_s event with a KeyCode of zero is used exclusively
as a signal that an input method has composed input that can
be returned by _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g. No other
use is made of a _K_e_y_P_r_e_s_s event with KeyCode of zero.
Such an event may be generated by either a front-end or a
back-end input method in an implementation-dependent manner.
Some possible ways to generate this event include:
· A synthetic event sent by an input method server
· An artificial event created by a input method filter
and pushed onto a client's event queue
· A _K_e_y_P_r_e_s_s event whose KeyCode value is modified by an
input method filter
When callback support is specified by the client, input
methods will not take action unless they explicitly called
back the client and obtained no response (the callback is
not specified or returned invalid data).
1133..66.. SSttrriinngg CCoonnssttaannttss
The following symbols for string constants are defined in
<_X_1_1_/_X_l_i_b_._h>. Although they are shown here with particular
macro definitions, they may be implemented as macros, as
448899
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
global symbols, or as a mixture of the two. The string
pointer value itself is not significant; clients must not
assume that inequality of two values implies inequality of
the actual string data.
#define _X_N_V_a_N_e_s_t_e_d_L_i_s_t "XNVaNestedList"
#define _X_N_S_e_p_a_r_a_t_o_r_o_f_N_e_s_t_e_d_L_i_s_t "separatorofNestedList"
#define _X_N_Q_u_e_r_y_I_n_p_u_t_S_t_y_l_e "queryInputStyle"
#define _X_N_C_l_i_e_n_t_W_i_n_d_o_w "clientWindow"
#define _X_N_I_n_p_u_t_S_t_y_l_e "inputStyle"
#define _X_N_F_o_c_u_s_W_i_n_d_o_w "focusWindow"
#define _X_N_R_e_s_o_u_r_c_e_N_a_m_e "resourceName"
#define _X_N_R_e_s_o_u_r_c_e_C_l_a_s_s "resourceClass"
#define _X_N_G_e_o_m_e_t_r_y_C_a_l_l_b_a_c_k "geometryCallback"
#define _X_N_D_e_s_t_r_o_y_C_a_l_l_b_a_c_k "destroyCallback"
#define _X_N_F_i_l_t_e_r_E_v_e_n_t_s "filterEvents"
#define _X_N_P_r_e_e_d_i_t_S_t_a_r_t_C_a_l_l_b_a_c_k "preeditStartCallback"
#define _X_N_P_r_e_e_d_i_t_D_o_n_e_C_a_l_l_b_a_c_k "preeditDoneCallback"
#define _X_N_P_r_e_e_d_i_t_D_r_a_w_C_a_l_l_b_a_c_k "preeditDrawCallback"
#define _X_N_P_r_e_e_d_i_t_C_a_r_e_t_C_a_l_l_b_a_c_k "preeditCaretCallback"
#define _X_N_P_r_e_e_d_i_t_S_t_a_t_e_N_o_t_i_f_y_C_a_l_l_- "preeditStateNotifyCall-
_b_a_c_k back"
#define _X_N_P_r_e_e_d_i_t_A_t_t_r_i_b_u_t_e_s "preeditAttributes"
#define _X_N_S_t_a_t_u_s_S_t_a_r_t_C_a_l_l_b_a_c_k "statusStartCallback"
#define _X_N_S_t_a_t_u_s_D_o_n_e_C_a_l_l_b_a_c_k "statusDoneCallback"
#define _X_N_S_t_a_t_u_s_D_r_a_w_C_a_l_l_b_a_c_k "statusDrawCallback"
#define _X_N_S_t_a_t_u_s_A_t_t_r_i_b_u_t_e_s "statusAttributes"
#define _X_N_A_r_e_a "area"
#define _X_N_A_r_e_a_N_e_e_d_e_d "areaNeeded"
#define _X_N_S_p_o_t_L_o_c_a_t_i_o_n "spotLocation"
#define _X_N_C_o_l_o_r_m_a_p "colorMap"
#define _X_N_S_t_d_C_o_l_o_r_m_a_p "stdColorMap"
#define _X_N_F_o_r_e_g_r_o_u_n_d "foreground"
#define _X_N_B_a_c_k_g_r_o_u_n_d "background"
#define _X_N_B_a_c_k_g_r_o_u_n_d_P_i_x_m_a_p "backgroundPixmap"
#define _X_N_F_o_n_t_S_e_t "fontSet"
#define _X_N_L_i_n_e_S_p_a_c_e "lineSpace"
#define _X_N_C_u_r_s_o_r "cursor"
#define _X_N_Q_u_e_r_y_I_M_V_a_l_u_e_s_L_i_s_t "queryIMValuesList"
#define _X_N_Q_u_e_r_y_I_C_V_a_l_u_e_s_L_i_s_t "queryICValuesList"
#define _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n_C_a_l_l_b_a_c_k "stringConversionCall-
back"
#define _X_N_S_t_r_i_n_g_C_o_n_v_e_r_s_i_o_n "stringConversion"
#define _X_N_R_e_s_e_t_S_t_a_t_e "resetState"
#define _X_N_H_o_t_K_e_y "hotkey"
#define _X_N_H_o_t_K_e_y_S_t_a_t_e "hotkeyState"
#define _X_N_P_r_e_e_d_i_t_S_t_a_t_e "preeditState"
#define _X_N_V_i_s_i_b_l_e_P_o_s_i_t_i_o_n "visiblePosition"
#define _X_N_R_6_P_r_e_e_d_i_t_C_a_l_l_b_a_c_k_B_e_h_a_v_i_o_r "r6PreeditCallback"
#define _X_N_R_e_q_u_i_r_e_d_C_h_a_r_S_e_t "requiredCharSet"
449900
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
#define _X_N_Q_u_e_r_y_O_r_i_e_n_t_a_t_i_o_n "queryOrientation"
#define _X_N_D_i_r_e_c_t_i_o_n_a_l_D_e_p_e_n_d_e_n_t_D_r_a_w_- "directionalDependent-
_i_n_g Drawing"
#define _X_N_C_o_n_t_e_x_t_u_a_l_D_r_a_w_i_n_g "contextualDrawing"
#define _X_N_B_a_s_e_F_o_n_t_N_a_m_e "baseFontName"
#define _X_N_M_i_s_s_i_n_g_C_h_a_r_S_e_t "missingCharSet"
#define _X_N_D_e_f_a_u_l_t_S_t_r_i_n_g "defaultString"
#define _X_N_O_r_i_e_n_t_a_t_i_o_n "orientation"
#define _X_N_F_o_n_t_I_n_f_o "fontInfo"
#define _X_N_O_M_A_u_t_o_m_a_t_i_c "omAutomatic"
449911
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1144
IInntteerr--CClliieenntt CCoommmmuunniiccaattiioonn FFuunnccttiioonnss
The _I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l, hereafter
referred to as the ICCCM, details the X Consortium approved
conventions that govern inter-client communications. These
conventions ensure peer-to-peer client cooperation in the
use of selections, cut buffers, and shared resources as well
as client cooperation with window and session managers. For
further information, see the _I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_-
_v_e_n_t_i_o_n_s _M_a_n_u_a_l.
Xlib provides a number of standard properties and program-
ming interfaces that are ICCCM compliant. The predefined
atoms for some of these properties are defined in the
<_X_1_1_/_X_a_t_o_m_._h> header file, where to avoid name conflicts
with user symbols their _#_d_e_f_i_n_e name has an XA_ prefix. For
further information about atoms and properties, see section
4.3.
Xlib's selection and cut buffer mechanisms provide the pri-
mary programming interfaces by which peer client applica-
tions communicate with each other (see sections 4.5 and
16.6). The functions discussed in this chapter provide the
primary programming interfaces by which client applications
communicate with their window and session managers as well
as share standard colormaps.
The standard properties that are of special interest for
communicating with window and session managers are:
-----------------------------------------------------------------------
NNaammee TTyyppee FFoorrmmaatt DDeessccrriippttiioonn
-----------------------------------------------------------------------
WM_CLASS STRING 8 Set by application
programs to allow win-
dow and session man-
agers to obtain the
application's
resources from the
resource database.
WM_CLIENT_MACHINE TEXT The string name of the
machine on which the
client application is
running.
449922
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-----------------------------------------------------------------------
NNaammee TTyyppee FFoorrmmaatt DDeessccrriippttiioonn
-----------------------------------------------------------------------
WM_COLORMAP_WINDOWS WINDOW 32 The list of window IDs
that may need a dif-
ferent colormap from
that of their top-
level window.
WM_COMMAND TEXT The command and argu-
ments, null-separated,
used to invoke the
application.
WM_HINTS WM_HINTS 32 Additional hints set
by the client for use
by the window manager.
The C type of this
property is _X_W_M_H_i_n_t_s.
WM_ICON_NAME TEXT The name to be used in
an icon.
WM_ICON_SIZE WM_ICON_SIZE 32 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 _X_I_c_o_n_S_i_z_e.
WM_NAME TEXT The name of the appli-
cation.
WM_NORMAL_HINTS WM_SIZE_HINTS 32 Size hints for a win-
dow in its normal
state. The C type of
this property is
_X_S_i_z_e_H_i_n_t_s.
WM_PROTOCOLS ATOM 32 List of atoms that
identify the communi-
cations protocols
between the client and
window manager in
which the client is
willing to partici-
pate.
WM_STATE WM_STATE 32 Intended for communi-
cation between window
and session managers
only.
WM_TRANSIENT_FOR WINDOW 32 Set by application
programs to indicate
to the window manager
that a transient top-
level window, such as
a dialog box.
-----------------------------------------------------------------------
449933
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The remainder of this chapter discusses:
· Client to window manager communication
· Client to session manager communication
· Standard colormaps
1144..11.. CClliieenntt ttoo WWiinnddooww MMaannaaggeerr CCoommmmuunniiccaattiioonn
This section discusses how to:
· Manipulate top-level windows
· Convert string lists
· Set and read text properties
· Set and read the WM_NAME property
· Set and read the WM_ICON_NAME property
· Set and read the WM_HINTS property
· Set and read the WM_NORMAL_HINTS property
· Set and read the WM_CLASS property
· Set and read the WM_TRANSIENT_FOR property
· Set and read the WM_PROTOCOLS property
· Set and read the WM_COLORMAP_WINDOWS property
· Set and read the WM_ICON_SIZE property
· Use window manager convenience functions
1144..11..11.. MMaanniippuullaattiinngg TToopp--LLeevveell WWiinnddoowwss
Xlib provides functions that you can use to change the visi-
bility or size of top-level windows (that is, those that
were created as children of the root window). Note that the
subwindows that you create are ignored by window managers.
Therefore, you should use the basic window functions
described in chapter 3 to manipulate your application's sub-
windows.
To request that a top-level window be iconified, use _X_I_c_o_n_i_-
_f_y_W_i_n_d_o_w.
449944
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XIconifyWindow(_d_i_s_p_l_a_y, _w, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
Window _w;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
The _X_I_c_o_n_i_f_y_W_i_n_d_o_w function sends a WM_CHANGE_STATE
_C_l_i_e_n_t_M_e_s_s_a_g_e event with a format of 32 and a first data
element of _I_c_o_n_i_c_S_t_a_t_e (as described in section 4.1.4 of the
_I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l) and a window
of w to the root window of the specified screen with an
event mask set to _S_u_b_s_t_r_u_c_t_u_r_e_N_o_t_i_f_y_M_a_s_k| _S_u_b_s_t_r_u_c_t_u_r_e_R_e_d_i_-
_r_e_c_t_M_a_s_k. Window managers may elect to receive this message
and if the window is in its normal state, may treat it as a
request to change the window's state from normal to iconic.
If the WM_CHANGE_STATE property cannot be interned, _X_I_c_o_n_i_-
_f_y_W_i_n_d_o_w 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.
To request that a top-level window be withdrawn, use _X_W_i_t_h_-
_d_r_a_w_W_i_n_d_o_w.
__
││
Status XWithdrawWindow(_d_i_s_p_l_a_y, _w, _s_c_r_e_e_n___n_u_m_b_e_r)
Display *_d_i_s_p_l_a_y;
Window _w;
int _s_c_r_e_e_n___n_u_m_b_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
││__
The _X_W_i_t_h_d_r_a_w_W_i_n_d_o_w function unmaps the specified window and
sends a synthetic _U_n_m_a_p_N_o_t_i_f_y event to the root window of
the specified screen. Window managers may elect to receive
this message and may treat it as a request to change the
449955
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
window's state to withdrawn. When a window is in the with-
drawn state, neither its normal nor its iconic representa-
tions is visible. It returns a nonzero status if the _U_n_m_a_p_-
_N_o_t_i_f_y event is successfully sent; otherwise, it returns a
zero status.
_X_W_i_t_h_d_r_a_w_W_i_n_d_o_w can generate a _B_a_d_W_i_n_d_o_w error.
To request that a top-level window be reconfigured, use _X_R_e_-
_c_o_n_f_i_g_u_r_e_W_M_W_i_n_d_o_w.
__
││
Status XReconfigureWMWindow(_d_i_s_p_l_a_y, _w, _s_c_r_e_e_n___n_u_m_b_e_r, _v_a_l_u_e___m_a_s_k, _v_a_l_u_e_s)
Display *_d_i_s_p_l_a_y;
Window _w;
int _s_c_r_e_e_n___n_u_m_b_e_r;
unsigned int _v_a_l_u_e___m_a_s_k;
XWindowChanges *_v_a_l_u_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_c_r_e_e_n___n_u_m_b_e_r
Specifies the appropriate screen number on the
host server.
_v_a_l_u_e___m_a_s_k
Specifies which values are to be set using infor-
mation in the values structure. This mask is the
bitwise inclusive OR of the valid configure window
values bits.
_v_a_l_u_e_s Specifies the _X_W_i_n_d_o_w_C_h_a_n_g_e_s structure.
││__
The _X_R_e_c_o_n_f_i_g_u_r_e_W_M_W_i_n_d_o_w function issues a _C_o_n_f_i_g_u_r_e_W_i_n_d_o_w
request on the specified top-level window. If the stacking
mode is changed and the request fails with a _B_a_d_M_a_t_c_h error,
the error is trapped by Xlib and a synthetic _C_o_n_f_i_g_u_r_-
_e_R_e_q_u_e_s_t_E_v_e_n_t containing the same configuration parameters
is sent to the root of the specified window. Window man-
agers 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.
_X_R_e_c_o_n_f_i_g_u_r_e_W_M_W_i_n_d_o_w can generate _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w
errors.
449966
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1144..11..22.. CCoonnvveerrttiinngg SSttrriinngg LLiissttss
Many of the text properties allow a variety of types and
formats. Because the data stored in these properties are
not simple null-terminated strings, an _X_T_e_x_t_P_r_o_p_e_r_t_y struc-
ture is used to describe the encoding, type, and length of
the text as well as its value. The _X_T_e_x_t_P_r_o_p_e_r_t_y structure
contains:
__
││
typedef struct {
unsigned char *value;/* property data */
Atom encoding; /* type of property */
int format; /* 8, 16, or 32 */
unsigned long nitems;/* number of items in value */
} XTextProperty;
││__
Xlib provides functions to convert localized text to or from
encodings that support the inter-client communication con-
ventions for text. In addition, functions are provided for
converting between lists of pointers to character strings
and text properties in the STRING encoding.
The functions for localized text return a signed integer
error status that encodes _S_u_c_c_e_s_s as zero, specific error
conditions as negative numbers, and partial conversion as a
count of unconvertible characters.
__
││
#define _X_N_o_M_e_m_o_r_y -1
#define _X_L_o_c_a_l_e_N_o_t_S_u_p_p_o_r_t_e_d -2
#define _X_C_o_n_v_e_r_t_e_r_N_o_t_F_o_u_n_d -3
typedef enum {
XStringStyle, /* STRING */
XCompoundTextStyle, /* COMPOUND_TEXT */
XTextStyle, /* text in owner's encoding (current locale) */
XStdICCTextStyle /* STRING, else COMPOUND_TEXT */
} XICCEncodingStyle;
││__
To convert a list of text strings to an _X_T_e_x_t_P_r_o_p_e_r_t_y struc-
ture, use _X_m_b_T_e_x_t_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y or _X_w_c_T_e_x_t_L_i_s_t_T_o_-
_T_e_x_t_P_r_o_p_e_r_t_y.
449977
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XmbTextListToTextProperty(_d_i_s_p_l_a_y, _l_i_s_t, _c_o_u_n_t, _s_t_y_l_e, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char **_l_i_s_t;
int _c_o_u_n_t;
XICCEncodingStyle _s_t_y_l_e;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
int XwcTextListToTextProperty(_d_i_s_p_l_a_y, _l_i_s_t, _c_o_u_n_t, _s_t_y_l_e, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
wchar_t **_l_i_s_t;
int _c_o_u_n_t;
XICCEncodingStyle _s_t_y_l_e;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_l_i_s_t Specifies a list of null-terminated character
strings.
_c_o_u_n_t Specifies the number of strings specified.
_s_t_y_l_e Specifies the manner in which the property is
encoded.
_t_e_x_t___p_r_o_p___r_e_t_u_r_n
Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
││__
The _X_m_b_T_e_x_t_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y and _X_w_c_T_e_x_t_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y
functions set the specified _X_T_e_x_t_P_r_o_p_e_r_t_y value to a set of
null-separated elements representing the concatenation of
the specified list of null-terminated text strings. A final
terminating null is stored at the end of the value field of
text_prop_return but is not included in the nitems member.
The functions set the encoding field of text_prop_return to
an _A_t_o_m for the specified display naming the encoding deter-
mined by the specified style and convert the specified text
list to this encoding for storage in the text_prop_return
value field. If the style _X_S_t_r_i_n_g_S_t_y_l_e or _X_C_o_m_p_o_u_n_d_-
_T_e_x_t_S_t_y_l_e is specified, this encoding is ``STRING'' or
``COMPOUND_TEXT'', respectively. If the style _X_T_e_x_t_S_t_y_l_e is
specified, this encoding is the encoding of the current
locale. If the style _X_S_t_d_I_C_C_T_e_x_t_S_t_y_l_e is specified, this
encoding is ``STRING'' if the text is fully convertible to
STRING, else ``COMPOUND_TEXT''.
If insufficient memory is available for the new value
string, the functions return _X_N_o_M_e_m_o_r_y. If the current
locale is not supported, the functions return _X_L_o_c_a_l_e_N_o_t_S_u_p_-
_p_o_r_t_e_d. In both of these error cases, the functions do not
449988
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
set text_prop_return.
To determine if the functions are guaranteed not to return
_X_L_o_c_a_l_e_N_o_t_S_u_p_p_o_r_t_e_d, use _X_S_u_p_p_o_r_t_s_L_o_c_a_l_e.
If the supplied text is not fully convertible to the speci-
fied encoding, the functions return the number of unconvert-
ible characters. Each unconvertible character is converted
to an implementation-defined and encoding-specific default
string. Otherwise, the functions return _S_u_c_c_e_s_s. Note that
full convertibility to all styles except _X_S_t_r_i_n_g_S_t_y_l_e is
guaranteed.
To free the storage for the value field, use _X_F_r_e_e.
To obtain a list of text strings from an _X_T_e_x_t_P_r_o_p_e_r_t_y
structure, use _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t or _X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_-
_T_o_T_e_x_t_L_i_s_t.
__
││
int XmbTextPropertyToTextList(_d_i_s_p_l_a_y, _t_e_x_t___p_r_o_p, _l_i_s_t___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XTextProperty *_t_e_x_t___p_r_o_p;
char ***_l_i_s_t___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
int XwcTextPropertyToTextList(_d_i_s_p_l_a_y, _t_e_x_t___p_r_o_p, _l_i_s_t___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XTextProperty *_t_e_x_t___p_r_o_p;
wchar_t ***_l_i_s_t___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
_l_i_s_t___r_e_t_u_r_n
Returns a list of null-terminated character
strings.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of strings.
││__
The _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t and _X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t
functions return a list of text strings in the current
locale representing the null-separated elements of the spec-
ified _X_T_e_x_t_P_r_o_p_e_r_t_y structure. The data in text_prop must
be format 8.
449999
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Multiple elements of the property (for example, the strings
in a disjoint text selection) are separated by a null byte.
The contents of the property are not required to be null-
terminated; any terminating null should not be included in
text_prop.nitems.
If insufficient memory is available for the list and its
elements, _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t and _X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_T_o_-
_T_e_x_t_L_i_s_t return _X_N_o_M_e_m_o_r_y. If the current locale is not
supported, the functions return _X_L_o_c_a_l_e_N_o_t_S_u_p_p_o_r_t_e_d. Other-
wise, if the encoding field of text_prop is not convertible
to the encoding of the current locale, the functions return
_X_C_o_n_v_e_r_t_e_r_N_o_t_F_o_u_n_d. For supported locales, existence of a
converter from COMPOUND_TEXT, STRING or the encoding of the
current locale is guaranteed if _X_S_u_p_p_o_r_t_s_L_o_c_a_l_e returns _T_r_u_e
for the current locale (but the actual text may contain
unconvertible characters). Conversion of other encodings is
implementation-dependent. In all of these error cases, the
functions do not set any return values.
Otherwise, _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t and _X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_T_o_-
_T_e_x_t_L_i_s_t return the list of null-terminated text strings to
list_return and the number of text strings to count_return.
If the value field of text_prop is not fully convertible to
the encoding of the current locale, the functions return the
number of unconvertible characters. Each unconvertible
character is converted to a string in the current locale
that is specific to the current locale. To obtain the value
of this string, use _X_D_e_f_a_u_l_t_S_t_r_i_n_g. Otherwise, _X_m_b_T_e_x_t_P_r_o_p_-
_e_r_t_y_T_o_T_e_x_t_L_i_s_t and _X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t return _S_u_c_c_e_s_s.
To free the storage for the list and its contents returned
by _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t, use _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t. To free
the storage for the list and its contents returned by _X_w_c_-
_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t, use _X_w_c_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
To free the in-memory data associated with the specified
wide character string list, use _X_w_c_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
__
││
void XwcFreeStringList(_l_i_s_t)
wchar_t **_l_i_s_t;
_l_i_s_t Specifies the list of strings to be freed.
││__
The _X_w_c_F_r_e_e_S_t_r_i_n_g_L_i_s_t function frees memory allocated by
_X_w_c_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t.
550000
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To obtain the default string for text conversion in the cur-
rent locale, use _X_D_e_f_a_u_l_t_S_t_r_i_n_g.
__
││
char *XDefaultString()
││__
The _X_D_e_f_a_u_l_t_S_t_r_i_n_g function returns the default string used
by Xlib for text conversion (for example, in _X_m_b_T_e_x_t_P_r_o_p_e_r_-
_t_y_T_o_T_e_x_t_L_i_s_t). The default string is the string in the cur-
rent locale that is output when an unconvertible character
is found during text conversion. If the string returned by
_X_D_e_f_a_u_l_t_S_t_r_i_n_g is the empty string (""), no character is
output in the converted text. _X_D_e_f_a_u_l_t_S_t_r_i_n_g does not
return NULL.
The string returned by _X_D_e_f_a_u_l_t_S_t_r_i_n_g is independent of the
default string for text drawing; see _X_C_r_e_a_t_e_F_o_n_t_S_e_t to
obtain the default string for an _X_F_o_n_t_S_e_t.
The behavior when an invalid codepoint is supplied to any
Xlib function is undefined.
The returned string is null-terminated. It is owned by Xlib
and should not be modified or freed by the client. It may
be freed after the current locale is changed. Until freed,
it will not be modified by Xlib.
To set the specified list of strings in the STRING encoding
to a _X_T_e_x_t_P_r_o_p_e_r_t_y structure, use _X_S_t_r_i_n_g_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y.
__
││
Status XStringListToTextProperty(_l_i_s_t, _c_o_u_n_t, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
char **_l_i_s_t;
int _c_o_u_n_t;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
_l_i_s_t Specifies a list of null-terminated character
strings.
_c_o_u_n_t Specifies the number of strings.
_t_e_x_t___p_r_o_p___r_e_t_u_r_n
Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
││__
The _X_S_t_r_i_n_g_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y function sets the specified
_X_T_e_x_t_P_r_o_p_e_r_t_y to be of type STRING (format 8) with a value
representing the concatenation of the specified list of
null-separated character strings. An extra null byte (which
is not included in the nitems member) is stored at the end
550011
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
of the value field of text_prop_return. The strings are
assumed (without verification) to be in the STRING encoding.
If insufficient memory is available for the new value
string, _X_S_t_r_i_n_g_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y does not set any fields in
the _X_T_e_x_t_P_r_o_p_e_r_t_y structure and returns a zero status. Oth-
erwise, it returns a nonzero status. To free the storage
for the value field, use _X_F_r_e_e.
To obtain a list of strings from a specified _X_T_e_x_t_P_r_o_p_e_r_t_y
structure in the STRING encoding, use _X_T_e_x_t_P_r_o_p_e_r_t_y_-
_T_o_S_t_r_i_n_g_L_i_s_t.
__
││
Status XTextPropertyToStringList(_t_e_x_t___p_r_o_p, _l_i_s_t___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
XTextProperty *_t_e_x_t___p_r_o_p;
char ***_l_i_s_t___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
_t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
_l_i_s_t___r_e_t_u_r_n
Returns a list of null-terminated character
strings.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of strings.
││__
The _X_T_e_x_t_P_r_o_p_e_r_t_y_T_o_S_t_r_i_n_g_L_i_s_t function returns a list of
strings representing the null-separated elements of the
specified _X_T_e_x_t_P_r_o_p_e_r_t_y structure. The data in text_prop
must be of type STRING and format 8. Multiple elements of
the property (for example, the strings in a disjoint text
selection) are separated by NULL (encoding 0). The contents
of the property are not null-terminated. If insufficient
memory is available for the list and its elements,
_X_T_e_x_t_P_r_o_p_e_r_t_y_T_o_S_t_r_i_n_g_L_i_s_t sets no return values and returns
a zero status. Otherwise, it returns a nonzero status. To
free the storage for the list and its contents, use
_X_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
To free the in-memory data associated with the specified
string list, use _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
550022
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XFreeStringList(_l_i_s_t)
char **_l_i_s_t;
_l_i_s_t Specifies the list of strings to be freed.
││__
The _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t function releases memory allocated by
_X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t and _X_T_e_x_t_P_r_o_p_e_r_t_y_T_o_S_t_r_i_n_g_L_i_s_t and
the missing charset list allocated by _X_C_r_e_a_t_e_F_o_n_t_S_e_t.
1144..11..33.. SSeettttiinngg aanndd RReeaaddiinngg TTeexxtt PPrrooppeerrttiieess
Xlib provides two functions that you can use to set and read
the text properties for a given window. You can use these
functions to set and read those properties of type TEXT
(WM_NAME, WM_ICON_NAME, WM_COMMAND, and WM_CLIENT_MACHINE).
In addition, Xlib provides separate convenience functions
that you can use to set each of these properties. For fur-
ther information about these convenience functions, see sec-
tions 14.1.4, 14.1.5, 14.2.1, and 14.2.2, respectively.
To set one of a window's text properties, use _X_S_e_t_T_e_x_t_P_r_o_p_-
_e_r_t_y.
__
││
void XSetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y function replaces the existing speci-
fied property for the named window with the data, type, for-
mat, and number of items determined by the value field, the
encoding field, the format field, and the nitems field,
respectively, of the specified _X_T_e_x_t_P_r_o_p_e_r_t_y structure. If
the property does not already exist, _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y sets
it for the specified window.
_X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, _B_a_d_V_a_l_u_e,
and _B_a_d_W_i_n_d_o_w errors.
550033
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To read one of a window's text properties, use _X_G_e_t_T_e_x_t_P_r_o_p_-
_e_r_t_y.
__
││
Status XGetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p___r_e_t_u_r_n, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p___r_e_t_u_r_n
Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y function reads the specified property
from the window and stores the data in the returned
_X_T_e_x_t_P_r_o_p_e_r_t_y structure. It stores the data in the value
field, the type of the data in the encoding field, the for-
mat of the data in the format field, and the number of items
of data in the nitems field. An extra byte containing null
(which is not included in the nitems member) is stored at
the end of the value field of text_prop_return. The partic-
ular interpretation of the property's encoding and data as
text is left to the calling application. If the specified
property does not exist on the window, _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y sets
the value field to NULL, the encoding field to _N_o_n_e, the
format field to zero, and the nitems field to zero.
If it was able to read and store the data in the _X_T_e_x_t_P_r_o_p_-
_e_r_t_y structure, _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y returns a nonzero status;
otherwise, it returns a zero status.
_X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
1144..11..44.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__NNAAMMEE PPrrooppeerrttyy
Xlib provides convenience functions that you can use to set
and read the WM_NAME property for a given window.
To set a window's WM_NAME property with the supplied conve-
nience function, use _X_S_e_t_W_M_N_a_m_e.
550044
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XSetWMName(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
││__
The _X_S_e_t_W_M_N_a_m_e convenience function calls _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y
to set the WM_NAME property.
To read a window's WM_NAME property with the supplied conve-
nience function, use _X_G_e_t_W_M_N_a_m_e.
__
││
Status XGetWMName(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p___r_e_t_u_r_n
Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
││__
The _X_G_e_t_W_M_N_a_m_e convenience function calls _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y
to obtain the WM_NAME property. It returns a nonzero status
on success; otherwise, it returns a zero status.
The following two functions have been superseded by _X_S_e_t_W_M_-
_N_a_m_e and _X_G_e_t_W_M_N_a_m_e, respectively. You can use these addi-
tional convenience functions for window names that are
encoded as STRING properties.
To assign a name to a window, use _X_S_t_o_r_e_N_a_m_e.
550055
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XStoreName(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e)
Display *_d_i_s_p_l_a_y;
Window _w;
char *_w_i_n_d_o_w___n_a_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_n_d_o_w___n_a_m_e
Specifies the window name, which should be a null-
terminated string.
││__
The _X_S_t_o_r_e_N_a_m_e function assigns the name passed to win-
dow_name to the specified window. A window manager can dis-
play the window name in some prominent place, such as the
title bar, to allow users to identify windows easily. Some
window managers may display a window's name in the window's
icon, although they are encouraged to use the window's icon
name if one is provided by the application. If the string
is not in the Host Portable Character Encoding, the result
is implementation-dependent.
_X_S_t_o_r_e_N_a_m_e can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To get the name of a window, use _X_F_e_t_c_h_N_a_m_e.
__
││
Status XFetchName(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
char **_w_i_n_d_o_w___n_a_m_e___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_n_d_o_w___n_a_m_e___r_e_t_u_r_n
Returns the window name, which is a null-termi-
nated string.
││__
The _X_F_e_t_c_h_N_a_m_e function returns the name of the specified
window. If it succeeds, it returns a nonzero status; other-
wise, no name has been set for the window, and it returns
zero. If the WM_NAME property has not been set for this
window, _X_F_e_t_c_h_N_a_m_e sets window_name_return to NULL. If the
data returned by the server is in the Latin Portable Charac-
ter Encoding, then the returned string is in the Host
550066
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Portable Character Encoding. Otherwise, the result is
implementation-dependent. When finished with it, a client
must free the window name string using _X_F_r_e_e.
_X_F_e_t_c_h_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..55.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__IICCOONN__NNAAMMEE PPrrooppeerrttyy
Xlib provides convenience functions that you can use to set
and read the WM_ICON_NAME property for a given window.
To set a window's WM_ICON_NAME property, use _X_S_e_t_W_M_I_c_o_n_N_a_m_e.
__
││
void XSetWMIconName(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
││__
The _X_S_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls _X_S_e_t_T_e_x_t_P_r_o_p_-
_e_r_t_y to set the WM_ICON_NAME property.
To read a window's WM_ICON_NAME property, use _X_G_e_t_W_M_I_c_o_n_-
_N_a_m_e.
__
││
Status XGetWMIconName(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p___r_e_t_u_r_n
Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
││__
The _X_G_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls _X_G_e_t_T_e_x_t_P_r_o_p_-
_e_r_t_y to obtain the WM_ICON_NAME property. It returns a
nonzero status on success; otherwise, it returns a zero sta-
tus.
550077
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The next two functions have been superseded by _X_S_e_t_W_M_I_c_o_n_-
_N_a_m_e and _X_G_e_t_W_M_I_c_o_n_N_a_m_e, respectively. You can use these
additional convenience functions for window names that are
encoded as STRING properties.
To set the name to be displayed in a window's icon, use
_X_S_e_t_I_c_o_n_N_a_m_e.
__
││
XSetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n___n_a_m_e)
Display *_d_i_s_p_l_a_y;
Window _w;
char *_i_c_o_n___n_a_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_i_c_o_n___n_a_m_e Specifies the icon name, which should be a null-
terminated string.
││__
If the string is not in the Host Portable Character Encod-
ing, the result is implementation-dependent. _X_S_e_t_I_c_o_n_N_a_m_e
can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To get the name a window wants displayed in its icon, use
_X_G_e_t_I_c_o_n_N_a_m_e.
__
││
Status XGetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n___n_a_m_e___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
char **_i_c_o_n___n_a_m_e___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_i_c_o_n___n_a_m_e___r_e_t_u_r_n
Returns the window's icon name, which is a null-
terminated string.
││__
The _X_G_e_t_I_c_o_n_N_a_m_e function returns the name to be displayed
in the specified window's icon. If it succeeds, it returns
a nonzero status; otherwise, if no icon name has been set
for the window, it returns zero. If you never assigned a
name to the window, _X_G_e_t_I_c_o_n_N_a_m_e sets icon_name_return to
550088
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
NULL. If the data returned by the server is in the Latin
Portable Character Encoding, then the returned string is in
the Host Portable Character Encoding. Otherwise, the result
is implementation-dependent. When finished with it, a
client must free the icon name string using _X_F_r_e_e.
_X_G_e_t_I_c_o_n_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..66.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__HHIINNTTSS PPrrooppeerrttyy
Xlib provides functions that you can use to set and read the
WM_HINTS property for a given window. These functions use
the flags and the _X_W_M_H_i_n_t_s structure, as defined in the
<_X_1_1_/_X_u_t_i_l_._h> header file.
To allocate an _X_W_M_H_i_n_t_s structure, use _X_A_l_l_o_c_W_M_H_i_n_t_s.
__
││
XWMHints *XAllocWMHints()
││__
The _X_A_l_l_o_c_W_M_H_i_n_t_s function allocates and returns a pointer
to an _X_W_M_H_i_n_t_s structure. Note that all fields in the
_X_W_M_H_i_n_t_s structure are initially set to zero. If insuffi-
cient memory is available, _X_A_l_l_o_c_W_M_H_i_n_t_s returns NULL. To
free the memory allocated to this structure, use _X_F_r_e_e.
The _X_W_M_H_i_n_t_s structure contains:
550099
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││ /* Window manager hints mask bits */
#define _I_n_p_u_t_H_i_n_t (1L << 0)
#define _S_t_a_t_e_H_i_n_t (1L << 1)
#define _I_c_o_n_P_i_x_m_a_p_H_i_n_t (1L << 2)
#define _I_c_o_n_W_i_n_d_o_w_H_i_n_t (1L << 3)
#define _I_c_o_n_P_o_s_i_t_i_o_n_H_i_n_t (1L << 4)
#define _I_c_o_n_M_a_s_k_H_i_n_t (1L << 5)
#define _W_i_n_d_o_w_G_r_o_u_p_H_i_n_t (1L << 6)
#define _U_r_g_e_n_c_y_H_i_n_t (1L << 8)
#define _A_l_l_H_i_n_t_s (InputHint|State-
Hint|IconPixmapHint|
IconWindowHint|IconPosi-
tionHint|
IconMaskHint|Window-
GroupHint)
/* Values */
typedef struct {
long flags; /* marks which fields in this structure are defined */
Bool input; /* does this application rely on the window manager to
get keyboard input? */
int initial_state; /* see below */
Pixmap icon_pixmap; /* pixmap to be used as icon */
Window icon_window; /* window to be used as icon */
int icon_x, icon_y; /* initial position of icon */
Pixmap icon_mask; /* pixmap to be used as mask for icon_pixmap */
XID window_group; /* id of related window group */
/* this structure may be extended in the future */
} XWMHints;
││__
The input member is used to communicate to the window man-
ager the input focus model used by the application. Appli-
cations 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
_T_r_u_e. 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 _T_r_u_e.
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 manage-
ment) should set this member to _F_a_l_s_e. Applications that
never expect any keyboard input also should set this member
to _F_a_l_s_e.
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
551100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_T_r_u_e. Push model window managers should make sure that pull
model applications do not break them by resetting input
focus to _P_o_i_n_t_e_r_R_o_o_t when it is appropriate (for example,
whenever an application whose input member is _F_a_l_s_e sets
input focus to one of its subwindows).
The definitions for the initial_state flag are:
#define _W_i_t_h_d_r_a_w_n_S_t_a_t_e 0
#define _N_o_r_m_a_l_S_t_a_t_e 1 /* most applications start
this way */
#define _I_c_o_n_i_c_S_t_a_t_e 3 /* application wants to
start as an icon */
The icon_mask specifies which pixels of the icon_pixmap
should be used as the 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 win-
dow_group lets you specify that this window belongs to a
group of other windows. For example, if a single applica-
tion 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.
The _U_r_g_e_n_c_y_H_i_n_t flag, if set in the flags field, indicates
that the client deems the window contents to be urgent,
requiring the timely response of the user. The window man-
ager will make some effort to draw the user's attention to
this window while this flag is set. The client must provide
some means by which the user can cause the urgency flag to
be cleared (either mitigating the condition that made the
window urgent or merely shutting off the alarm) or the win-
dow to be withdrawn.
To set a window's WM_HINTS property, use _X_S_e_t_W_M_H_i_n_t_s.
__
││
XSetWMHints(_d_i_s_p_l_a_y, _w, _w_m_h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
XWMHints *_w_m_h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_m_h_i_n_t_s Specifies the _X_W_M_H_i_n_t_s structure to be used.
││__
The _X_S_e_t_W_M_H_i_n_t_s function sets the window manager hints that
551111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
include icon information and location, the initial state of
the window, and whether the application relies on the window
manager to get keyboard input.
_X_S_e_t_W_M_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To read a window's WM_HINTS property, use _X_G_e_t_W_M_H_i_n_t_s.
__
││
XWMHints *XGetWMHints(_d_i_s_p_l_a_y, _w)
Display *_d_i_s_p_l_a_y;
Window _w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
││__
The _X_G_e_t_W_M_H_i_n_t_s function reads the window manager hints and
returns NULL if no WM_HINTS property was set on the window
or returns a pointer to an _X_W_M_H_i_n_t_s structure if it suc-
ceeds. When finished with the data, free the space used for
it by calling _X_F_r_e_e.
_X_G_e_t_W_M_H_i_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..77.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__NNOORRMMAALL__HHIINNTTSS PPrrooppeerrttyy
Xlib provides functions that you can use to set or read the
WM_NORMAL_HINTS property for a given window. The functions
use the flags and the _X_S_i_z_e_H_i_n_t_s structure, as defined in
the <_X_1_1_/_X_u_t_i_l_._h> header file.
The size of the _X_S_i_z_e_H_i_n_t_s structure may grow in future
releases, as new components are added to support new ICCCM
features. Passing statically allocated instances of this
structure into Xlib may result in memory corruption when
running against a future release of the library. As such,
it is recommended that only dynamically allocated instances
of the structure be used.
To allocate an _X_S_i_z_e_H_i_n_t_s structure, use _X_A_l_l_o_c_S_i_z_e_H_i_n_t_s.
__
││
XSizeHints *XAllocSizeHints()
││__
The _X_A_l_l_o_c_S_i_z_e_H_i_n_t_s function allocates and returns a pointer
to an _X_S_i_z_e_H_i_n_t_s structure. Note that all fields in the
_X_S_i_z_e_H_i_n_t_s structure are initially set to zero. If
551122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
insufficient memory is available, _X_A_l_l_o_c_S_i_z_e_H_i_n_t_s returns
NULL. To free the memory allocated to this structure, use
_X_F_r_e_e.
The _X_S_i_z_e_H_i_n_t_s structure contains:
__
││ /* Size hints mask bits */
#define _U_S_P_o_s_i_t_i_o_n (1L << 0) /* user specified x, y */
#define _U_S_S_i_z_e (1L << 1) /* user specified width, height
*/
#define _P_P_o_s_i_t_i_o_n (1L << 2) /* program specified position
*/
#define _P_S_i_z_e (1L << 3) /* program specified size */
#define _P_M_i_n_S_i_z_e (1L << 4) /* program specified minimum
size */
#define _P_M_a_x_S_i_z_e (1L << 5) /* program specified maximum
size */
#define _P_R_e_s_i_z_e_I_n_c (1L << 6) /* program specified resize
increments */
#define _P_A_s_p_e_c_t (1L << 7) /* program specified min and
max aspect ratios */
#define _P_B_a_s_e_S_i_z_e (1L << 8)
#define _P_W_i_n_G_r_a_v_i_t_y (1L << 9)
#define _P_A_l_l_H_i_n_t_s (PPosi-
tion|PSize|
PMinSize|PMax-
Size|
PRe-
sizeInc|PAspect)
/* Values */
typedef struct {
long flags; /* marks which fields in this structure are defined */
int x, y; /* Obsolete */
int width, height; /* Obsolete */
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
struct {
int x; /* numerator */
int y; /* denominator */
} min_aspect, max_aspect;
int base_width, base_height;
int win_gravity;
/* this structure may be extended in the future */
} XSizeHints;
││__
The x, y, width, and height members are now obsolete and are
551133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
left solely for compatibility reasons. The min_width and
min_height members specify the minimum window size that
still allows the application to be useful. The max_width
and max_height members specify the maximum window size. The
width_inc and height_inc members define an arithmetic pro-
gression of sizes (minimum to maximum) into which the window
prefers to be resized. The min_aspect and max_aspect mem-
bers are expressed 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 inter-
pret 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 rect-
angle of the window includes any borders or decorations sup-
plied 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 in the absence of a window manager.
Note that use of the _P_A_l_l_H_i_n_t_s macro is highly discouraged.
To set a window's WM_NORMAL_HINTS property, use _X_S_e_t_W_M_N_o_r_-
_m_a_l_H_i_n_t_s.
__
││
void XSetWMNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s Specifies the size hints for the window in its
normal state.
││__
The _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function replaces the size hints for
the WM_NORMAL_HINTS property on the specified window. If
the property does not already exist, _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s sets
the size hints for the WM_NORMAL_HINTS property on the spec-
ified window. The property is stored with a type of
WM_SIZE_HINTS and a format of 32.
_X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w
errors.
551144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To read a window's WM_NORMAL_HINTS property, use _X_G_e_t_W_M_N_o_r_-
_m_a_l_H_i_n_t_s.
__
││
Status XGetWMNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s___r_e_t_u_r_n, _s_u_p_p_l_i_e_d___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s___r_e_t_u_r_n;
long *_s_u_p_p_l_i_e_d___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s___r_e_t_u_r_n
Returns the size hints for the window in its
normal state.
_s_u_p_p_l_i_e_d___r_e_t_u_r_n
Returns the hints that were supplied by the user.
││__
The _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s 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, _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s sets the various
fields of the _X_S_i_z_e_H_i_n_t_s 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 sta-
tus.
If _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s returns successfully and a pre-ICCCM
size hints property is read, the supplied_return argument
will contain the following bits:
(USPosition|USSize|PPosition|PSize|PMinSize|
PMaxSize|PResizeInc|PAspect)
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:
PBaseSize|PWinGravity
_X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.
551155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To set a window's WM_SIZE_HINTS property, use _X_S_e_t_W_M_S_i_z_e_-
_H_i_n_t_s.
__
││
void XSetWMSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s Specifies the _X_S_i_z_e_H_i_n_t_s structure to be used.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s function replaces the size hints for the
specified property on the named window. If the specified
property does not already exist, _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s 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 _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function.
_X_S_e_t_W_M_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, and _B_a_d_W_i_n_-
_d_o_w errors.
To read a window's WM_SIZE_HINTS property, use _X_G_e_t_W_M_S_i_z_e_-
_H_i_n_t_s.
551166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetWMSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s___r_e_t_u_r_n, _s_u_p_p_l_i_e_d___r_e_t_u_r_n, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s___r_e_t_u_r_n;
long *_s_u_p_p_l_i_e_d___r_e_t_u_r_n;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s___r_e_t_u_r_n
Returns the _X_S_i_z_e_H_i_n_t_s structure.
_s_u_p_p_l_i_e_d___r_e_t_u_r_n
Returns the hints that were supplied by the user.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s function returns the size hints stored
in the specified property on the named window. If the prop-
erty 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, _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s sets the various fields of
the _X_S_i_z_e_H_i_n_t_s 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. To
get a window's normal size hints, you can use the _X_G_e_t_W_M_N_o_r_-
_m_a_l_H_i_n_t_s function.
If _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s returns successfully and a pre-ICCCM size
hints property is read, the supplied_return argument will
contain the following bits:
(USPosition|USSize|PPosition|PSize|PMinSize|
PMaxSize|PResizeInc|PAspect)
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:
PBaseSize|PWinGravity
_X_G_e_t_W_M_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
551177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1144..11..88.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__CCLLAASSSS PPrrooppeerrttyy
Xlib provides functions that you can use to set and get the
WM_CLASS property for a given window. These functions use
the _X_C_l_a_s_s_H_i_n_t structure, which is defined in the
<_X_1_1_/_X_u_t_i_l_._h> header file.
To allocate an _X_C_l_a_s_s_H_i_n_t structure, use _X_A_l_l_o_c_C_l_a_s_s_H_i_n_t.
__
││
XClassHint *XAllocClassHint()
││__
The _X_A_l_l_o_c_C_l_a_s_s_H_i_n_t function allocates and returns a pointer
to an _X_C_l_a_s_s_H_i_n_t structure. Note that the pointer fields in
the _X_C_l_a_s_s_H_i_n_t structure are initially set to NULL. If
insufficient memory is available, _X_A_l_l_o_c_C_l_a_s_s_H_i_n_t returns
NULL. To free the memory allocated to this structure, use
_X_F_r_e_e.
The _X_C_l_a_s_s_H_i_n_t contains:
__
││
typedef struct {
char *res_name;
char *res_class;
} XClassHint;
││__
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 dis-
played 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, 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 resource database.
To set a window's WM_CLASS property, use _X_S_e_t_C_l_a_s_s_H_i_n_t.
551188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetClassHint(_d_i_s_p_l_a_y, _w, _c_l_a_s_s___h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
XClassHint *_c_l_a_s_s___h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_l_a_s_s___h_i_n_t_s
Specifies the _X_C_l_a_s_s_H_i_n_t structure that is to be
used.
││__
The _X_S_e_t_C_l_a_s_s_H_i_n_t function sets the class hint for the spec-
ified window. If the strings are not in the Host Portable
Character Encoding, the result is implementation-dependent.
_X_S_e_t_C_l_a_s_s_H_i_n_t can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To read a window's WM_CLASS property, use _X_G_e_t_C_l_a_s_s_H_i_n_t.
__
││
Status XGetClassHint(_d_i_s_p_l_a_y, _w, _c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XClassHint *_c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_l_a_s_s___h_i_n_t_s___r_e_t_u_r_n
Returns the _X_C_l_a_s_s_H_i_n_t structure.
││__
The _X_G_e_t_C_l_a_s_s_H_i_n_t function returns the class hint of the
specified window to the members of the supplied structure.
If the data returned by the server is in the Latin Portable
Character Encoding, then the returned strings are in the
Host Portable Character Encoding. Otherwise, the result is
implementation-dependent. It returns a nonzero status on
success; otherwise, it returns a zero status. To free
res_name and res_class when finished with the strings, use
_X_F_r_e_e on each individually.
_X_G_e_t_C_l_a_s_s_H_i_n_t can generate a _B_a_d_W_i_n_d_o_w error.
551199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1144..11..99.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__TTRRAANNSSIIEENNTT__FFOORR PPrrooppeerrttyy
Xlib provides functions that you can use to set and read the
WM_TRANSIENT_FOR property for a given window.
To set a window's WM_TRANSIENT_FOR property, use _X_S_e_t_T_r_a_n_-
_s_i_e_n_t_F_o_r_H_i_n_t.
__
││
XSetTransientForHint(_d_i_s_p_l_a_y, _w, _p_r_o_p___w_i_n_d_o_w)
Display *_d_i_s_p_l_a_y;
Window _w;
Window _p_r_o_p___w_i_n_d_o_w;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_p_r_o_p___w_i_n_d_o_w
Specifies the window that the WM_TRANSIENT_FOR
property is to be set to.
││__
The _X_S_e_t_T_r_a_n_s_i_e_n_t_F_o_r_H_i_n_t function sets the WM_TRANSIENT_FOR
property of the specified window to the specified prop_win-
dow.
_X_S_e_t_T_r_a_n_s_i_e_n_t_F_o_r_H_i_n_t can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w
errors.
To read a window's WM_TRANSIENT_FOR property, use _X_G_e_t_T_r_a_n_-
_s_i_e_n_t_F_o_r_H_i_n_t.
__
││
Status XGetTransientForHint(_d_i_s_p_l_a_y, _w, _p_r_o_p___w_i_n_d_o_w___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Window *_p_r_o_p___w_i_n_d_o_w___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_p_r_o_p___w_i_n_d_o_w___r_e_t_u_r_n
Returns the WM_TRANSIENT_FOR property of the spec-
ified window.
││__
The _X_G_e_t_T_r_a_n_s_i_e_n_t_F_o_r_H_i_n_t function returns the WM_TRAN-
SIENT_FOR property for the specified window. It returns a
552200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
nonzero status on success; otherwise, it returns a zero sta-
tus.
_X_G_e_t_T_r_a_n_s_i_e_n_t_F_o_r_H_i_n_t can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..1100.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__PPRROOTTOOCCOOLLSS PPrrooppeerrttyy
Xlib provides functions that you can use to set and read the
WM_PROTOCOLS property for a given window.
To set a window's WM_PROTOCOLS property, use _X_S_e_t_W_M_P_r_o_t_o_-
_c_o_l_s.
__
││
Status XSetWMProtocols(_d_i_s_p_l_a_y, _w, _p_r_o_t_o_c_o_l_s, _c_o_u_n_t)
Display *_d_i_s_p_l_a_y;
Window _w;
Atom *_p_r_o_t_o_c_o_l_s;
int _c_o_u_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_p_r_o_t_o_c_o_l_s Specifies the list of protocols.
_c_o_u_n_t Specifies the number of protocols in the list.
││__
The _X_S_e_t_W_M_P_r_o_t_o_c_o_l_s function replaces the WM_PROTOCOLS prop-
erty on the specified window with the list of atoms speci-
fied by the protocols argument. If the property does not
already exist, _X_S_e_t_W_M_P_r_o_t_o_c_o_l_s sets the WM_PROTOCOLS prop-
erty on the specified window to the list of atoms specified
by the protocols argument. The property is stored with a
type of ATOM and a format of 32. If it cannot intern the
WM_PROTOCOLS atom, _X_S_e_t_W_M_P_r_o_t_o_c_o_l_s returns a zero status.
Otherwise, it returns a nonzero status.
_X_S_e_t_W_M_P_r_o_t_o_c_o_l_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To read a window's WM_PROTOCOLS property, use _X_G_e_t_W_M_P_r_o_t_o_-
_c_o_l_s.
552211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetWMProtocols(_d_i_s_p_l_a_y, _w, _p_r_o_t_o_c_o_l_s___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Atom **_p_r_o_t_o_c_o_l_s___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_p_r_o_t_o_c_o_l_s___r_e_t_u_r_n
Returns the list of protocols.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of protocols in the list.
││__
The _X_G_e_t_W_M_P_r_o_t_o_c_o_l_s function returns the list of atoms
stored in the WM_PROTOCOLS property on the specified window.
These atoms describe window manager protocols in which the
owner of this window is willing to participate. If the
property exists, is of type ATOM, is of format 32, and the
atom WM_PROTOCOLS can be interned, _X_G_e_t_W_M_P_r_o_t_o_c_o_l_s sets the
protocols_return argument to a list of atoms, sets the
count_return argument to the number of elements in the list,
and returns a nonzero status. Otherwise, it sets neither of
the return arguments and returns a zero status. To release
the list of atoms, use _X_F_r_e_e.
_X_G_e_t_W_M_P_r_o_t_o_c_o_l_s can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..1111.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__CCOOLLOORRMMAAPP__WWIINNDDOOWWSS PPrroopp--
eerrttyy
Xlib provides functions that you can use to set and read the
WM_COLORMAP_WINDOWS property for a given window.
To set a window's WM_COLORMAP_WINDOWS property, use _X_S_e_t_W_M_-
_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s.
552222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XSetWMColormapWindows(_d_i_s_p_l_a_y, _w, _c_o_l_o_r_m_a_p___w_i_n_d_o_w_s, _c_o_u_n_t)
Display *_d_i_s_p_l_a_y;
Window _w;
Window *_c_o_l_o_r_m_a_p___w_i_n_d_o_w_s;
int _c_o_u_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_o_l_o_r_m_a_p___w_i_n_d_o_w_s
Specifies the list of windows.
_c_o_u_n_t Specifies the number of windows in the list.
││__
The _X_S_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s function replaces the WM_COL-
ORMAP_WINDOWS property on the specified window with the list
of windows specified by the colormap_windows argument. If
the property does not already exist, _X_S_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s
sets the WM_COLORMAP_WINDOWS property on the specified win-
dow to the list of windows specified by the colormap_windows
argument. The property is stored with a type of WINDOW and
a format of 32. If it cannot intern the WM_COLORMAP_WINDOWS
atom, _X_S_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s returns a zero status. Other-
wise, it returns a nonzero status.
_X_S_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w
errors.
To read a window's WM_COLORMAP_WINDOWS property, use _X_G_e_t_W_M_-
_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s.
552233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetWMColormapWindows(_d_i_s_p_l_a_y, _w, _c_o_l_o_r_m_a_p___w_i_n_d_o_w_s___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
Window **_c_o_l_o_r_m_a_p___w_i_n_d_o_w_s___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_o_l_o_r_m_a_p___w_i_n_d_o_w_s___r_e_t_u_r_n
Returns the list of windows.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of windows in the list.
││__
The _X_G_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s function returns the list of win-
dow identifiers stored in the WM_COLORMAP_WINDOWS property
on the specified window. These identifiers indicate the
colormaps that the window manager may need to install for
this window. If the property exists, is of type WINDOW, is
of format 32, and the atom WM_COLORMAP_WINDOWS can be
interned, _X_G_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s sets the windows_return
argument to a list of window identifiers, sets the
count_return argument to the number of elements in the list,
and returns a nonzero status. Otherwise, it sets neither of
the return arguments and returns a zero status. To release
the list of window identifiers, use _X_F_r_e_e.
_X_G_e_t_W_M_C_o_l_o_r_m_a_p_W_i_n_d_o_w_s can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..1122.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__IICCOONN__SSIIZZEE PPrrooppeerrttyy
Xlib provides functions that you can use to set and read the
WM_ICON_SIZE property for a given window. These functions
use the _X_I_c_o_n_S_i_z_e structure, which is defined in the
<_X_1_1_/_X_u_t_i_l_._h> header file.
To allocate an _X_I_c_o_n_S_i_z_e structure, use _X_A_l_l_o_c_I_c_o_n_S_i_z_e.
__
││
XIconSize *XAllocIconSize()
││__
The _X_A_l_l_o_c_I_c_o_n_S_i_z_e function allocates and returns a pointer
to an _X_I_c_o_n_S_i_z_e structure. Note that all fields in the
_X_I_c_o_n_S_i_z_e structure are initially set to zero. If insuffi-
cient memory is available, _X_A_l_l_o_c_I_c_o_n_S_i_z_e returns NULL. To
free the memory allocated to this structure, use _X_F_r_e_e.
552244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The _X_I_c_o_n_S_i_z_e structure contains:
__
││
typedef struct {
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
} XIconSize;
││__
The width_inc and height_inc members define an arithmetic
progression of sizes (minimum to maximum) that represent the
supported icon sizes.
To set a window's WM_ICON_SIZE property, use _X_S_e_t_I_c_o_n_S_i_z_e_s.
__
││
XSetIconSizes(_d_i_s_p_l_a_y, _w, _s_i_z_e___l_i_s_t, _c_o_u_n_t)
Display *_d_i_s_p_l_a_y;
Window _w;
XIconSize *_s_i_z_e___l_i_s_t;
int _c_o_u_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_i_z_e___l_i_s_t Specifies the size list.
_c_o_u_n_t Specifies the number of items in the size list.
││__
The _X_S_e_t_I_c_o_n_S_i_z_e_s function is used only by window managers
to set the supported icon sizes.
_X_S_e_t_I_c_o_n_S_i_z_e_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To read a window's WM_ICON_SIZE property, use _X_G_e_t_I_c_o_n_S_i_z_e_s.
552255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetIconSizes(_d_i_s_p_l_a_y, _w, _s_i_z_e___l_i_s_t___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XIconSize **_s_i_z_e___l_i_s_t___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_i_z_e___l_i_s_t___r_e_t_u_r_n
Returns the size list.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of items in the size list.
││__
The _X_G_e_t_I_c_o_n_S_i_z_e_s function returns zero if a window manager
has not set icon sizes; otherwise, it returns nonzero.
_X_G_e_t_I_c_o_n_S_i_z_e_s should be called by an application that wants
to find out what icon sizes would be most appreciated by the
window manager under which the application is running. The
application should then use _X_S_e_t_W_M_H_i_n_t_s to supply the window
manager with an icon pixmap or window in one of the sup-
ported sizes. To free the data allocated in
size_list_return, use _X_F_r_e_e.
_X_G_e_t_I_c_o_n_S_i_z_e_s can generate a _B_a_d_W_i_n_d_o_w error.
1144..11..1133.. UUssiinngg WWiinnddooww MMaannaaggeerr CCoonnvveenniieennccee FFuunnccttiioonnss
The _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s function stores the standard set of
window manager properties, with text properties in standard
encodings for internationalized text communication. The
standard window manager properties for a given window are
WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS,
WM_COMMAND, WM_CLIENT_MACHINE, and WM_LOCALE_NAME.
552266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XmbSetWMProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e, _i_c_o_n___n_a_m_e, _a_r_g_v, _a_r_g_c,
_n_o_r_m_a_l___h_i_n_t_s, _w_m___h_i_n_t_s, _c_l_a_s_s___h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
char *_w_i_n_d_o_w___n_a_m_e;
char *_i_c_o_n___n_a_m_e;
char *_a_r_g_v[];
int _a_r_g_c;
XSizeHints *_n_o_r_m_a_l___h_i_n_t_s;
XWMHints *_w_m___h_i_n_t_s;
XClassHint *_c_l_a_s_s___h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_n_d_o_w___n_a_m_e
Specifies the window name, which should be a null-
terminated string.
_i_c_o_n___n_a_m_e Specifies the icon name, which should be a null-
terminated string.
_a_r_g_v Specifies the application's argument list.
_a_r_g_c Specifies the number of arguments.
_h_i_n_t_s Specifies the size hints for the window in its
normal state.
_w_m___h_i_n_t_s Specifies the _X_W_M_H_i_n_t_s structure to be used.
_c_l_a_s_s___h_i_n_t_s
Specifies the _X_C_l_a_s_s_H_i_n_t structure to be used.
││__
The _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a sim-
ple programming interface for setting those essential window
properties that are used for communicating with other
clients (particularly window and session managers).
If the window_name argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
sets the WM_NAME property. If the icon_name argument is
non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets the WM_ICON_NAME property.
The window_name and icon_name arguments are null-terminated
strings in the encoding of the current locale. If the argu-
ments can be fully converted to the STRING encoding, the
properties are created with type ``STRING''; otherwise, the
arguments are converted to Compound Text, and the properties
are created with type ``COMPOUND_TEXT''.
552277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
If the normal_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS
property (see section 14.1.7). If the wm_hints argument is
non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_H_i_n_t_s, which sets
the WM_HINTS property (see section 14.1.6).
If the argv argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets
the WM_COMMAND property from argv and argc. An argc of zero
indicates a zero-length command.
The hostname of the machine is stored using _X_S_e_t_W_M_C_l_i_e_n_t_M_a_-
_c_h_i_n_e (see section 14.2.2).
If the class_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
sets the WM_CLASS property. If the res_name member in the
_X_C_l_a_s_s_H_i_n_t structure is set to the NULL pointer and the
RESOURCE_NAME environment variable is set, the value of the
environment variable is substituted for res_name. If the
res_name member is NULL, the environment variable is not
set, and argv and argv[0] are set, then the value of
argv[0], stripped of any directory prefixes, is substituted
for res_name.
It is assumed that the supplied class_hints.res_name and
argv, the RESOURCE_NAME environment variable, and the host-
name of the machine are in the encoding of the locale
announced for the LC_CTYPE category (on POSIX-compliant sys-
tems, the LC_CTYPE, else LANG environment variable). The
corresponding WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE
properties are typed according to the local host locale
announcer. No encoding conversion is performed prior to
storage in the properties.
For clients that need to process the property text in a
locale, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s sets the WM_LOCALE_NAME property
to be the name of the current locale. The name is assumed
to be in the Host Portable Character Encoding and is con-
verted to STRING for storage in the property.
_X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w
errors.
To set a window's standard window manager properties with
strings in client-specified encodings, use _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s.
The standard window manager properties for a given window
are WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS,
WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE.
552288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XSetWMProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e, _i_c_o_n___n_a_m_e, _a_r_g_v, _a_r_g_c, _n_o_r_m_a_l___h_i_n_t_s, _w_m___h_i_n_t_s, _c_l_a_s_s___h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_w_i_n_d_o_w___n_a_m_e;
XTextProperty *_i_c_o_n___n_a_m_e;
char **_a_r_g_v;
int _a_r_g_c;
XSizeHints *_n_o_r_m_a_l___h_i_n_t_s;
XWMHints *_w_m___h_i_n_t_s;
XClassHint *_c_l_a_s_s___h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_n_d_o_w___n_a_m_e
Specifies the window name, which should be a null-
terminated string.
_i_c_o_n___n_a_m_e Specifies the icon name, which should be a null-
terminated string.
_a_r_g_v Specifies the application's argument list.
_a_r_g_c Specifies the number of arguments.
_n_o_r_m_a_l___h_i_n_t_s
Specifies the size hints for the window in its
normal state.
_w_m___h_i_n_t_s Specifies the _X_W_M_H_i_n_t_s structure to be used.
_c_l_a_s_s___h_i_n_t_s
Specifies the _X_C_l_a_s_s_H_i_n_t structure to be used.
││__
The _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a single
programming interface for setting those essential window
properties that are used for communicating with other
clients (particularly window and session managers).
If the window_name argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
calls _X_S_e_t_W_M_N_a_m_e, which, in turn, sets the WM_NAME property
(see section 14.1.4). If the icon_name argument is non-
NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_I_c_o_n_N_a_m_e, which sets the
WM_ICON_NAME property (see section 14.1.5). If the argv
argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_C_o_m_m_a_n_d,
which sets the WM_COMMAND property (see section 14.2.1).
Note that an argc of zero is allowed to indicate a zero-
length command. Note also that the hostname of this machine
is stored using _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e (see section 14.2.2).
552299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
If the normal_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS
property (see section 14.1.7). If the wm_hints argument is
non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_H_i_n_t_s, which sets the
WM_HINTS property (see section 14.1.6).
If the class_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s
calls _X_S_e_t_C_l_a_s_s_H_i_n_t, which sets the WM_CLASS property (see
section 14.1.8). If the res_name member in the _X_C_l_a_s_s_H_i_n_t
structure is set to the NULL pointer and the RESOURCE_NAME
environment variable is set, then the value of the environ-
ment variable is substituted for res_name. If the res_name
member is NULL, the environment variable is not set, and
argv and argv[0] are set, then the value of argv[0],
stripped of any directory prefixes, is substituted for
res_name.
_X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
1144..22.. CClliieenntt ttoo SSeessssiioonn MMaannaaggeerr CCoommmmuunniiccaattiioonn
This section discusses how to:
· Set and read the WM_COMMAND property
· Set and read the WM_CLIENT_MACHINE property
1144..22..11.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__CCOOMMMMAANNDD PPrrooppeerrttyy
Xlib provides functions that you can use to set and read the
WM_COMMAND property for a given window.
To set a window's WM_COMMAND property, use _X_S_e_t_C_o_m_m_a_n_d.
__
││
XSetCommand(_d_i_s_p_l_a_y, _w, _a_r_g_v, _a_r_g_c)
Display *_d_i_s_p_l_a_y;
Window _w;
char **_a_r_g_v;
int _a_r_g_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_a_r_g_v Specifies the application's argument list.
_a_r_g_c Specifies the number of arguments.
││__
The _X_S_e_t_C_o_m_m_a_n_d function sets the command and arguments used
to invoke the application. (Typically, argv is the argv
553300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
array of your main program.) If the strings are not in the
Host Portable Character Encoding, the result is implementa-
tion-dependent.
_X_S_e_t_C_o_m_m_a_n_d can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To read a window's WM_COMMAND property, use _X_G_e_t_C_o_m_m_a_n_d.
__
││
Status XGetCommand(_d_i_s_p_l_a_y, _w, _a_r_g_v___r_e_t_u_r_n, _a_r_g_c___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
char ***_a_r_g_v___r_e_t_u_r_n;
int *_a_r_g_c___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_a_r_g_v___r_e_t_u_r_n
Returns the application's argument list.
_a_r_g_c___r_e_t_u_r_n
Returns the number of arguments returned.
││__
The _X_G_e_t_C_o_m_m_a_n_d function reads the WM_COMMAND property from
the specified window and returns a string list. If the
WM_COMMAND property exists, it is of type STRING and format
8. If sufficient memory can be allocated to contain the
string list, _X_G_e_t_C_o_m_m_a_n_d fills in the argv_return and
argc_return arguments and returns a nonzero status. Other-
wise, it returns a zero status. If the data returned by the
server is in the Latin Portable Character Encoding, then the
returned strings are in the Host Portable Character Encod-
ing. Otherwise, the result is implementation-dependent. To
free the memory allocated to the string list, use
_X_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
1144..22..22.. SSeettttiinngg aanndd RReeaaddiinngg tthhee WWMM__CCLLIIEENNTT__MMAACCHHIINNEE PPrrooppeerrttyy
Xlib provides functions that you can use to set and read the
WM_CLIENT_MACHINE property for a given window.
To set a window's WM_CLIENT_MACHINE property, use _X_S_e_t_W_M_-
_C_l_i_e_n_t_M_a_c_h_i_n_e.
553311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XSetWMClientMachine(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
││__
The _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e convenience function calls _X_S_e_t_-
_T_e_x_t_P_r_o_p_e_r_t_y to set the WM_CLIENT_MACHINE property.
To read a window's WM_CLIENT_MACHINE property, use _X_G_e_t_W_M_-
_C_l_i_e_n_t_M_a_c_h_i_n_e.
__
││
Status XGetWMClientMachine(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_t_e_x_t___p_r_o_p___r_e_t_u_r_n
Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
││__
The _X_G_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e convenience function performs an
_X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y on the WM_CLIENT_MACHINE property. It
returns a nonzero status on success; otherwise, it returns a
zero status.
1144..33.. SSttaannddaarrdd CCoolloorrmmaappss
Applications with color palettes, smooth-shaded drawings, or
digitized images demand large numbers of colors. In addi-
tion, these applications often require an efficient mapping
from color triples to pixel values that display the appro-
priate colors.
As an example, consider a three-dimensional display program
that wants to draw a smoothly shaded sphere. At each pixel
in the image of the sphere, the program computes the inten-
sity and color of light reflected back to the viewer. The
result of each computation is a triple of red, green, and
553322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
blue (RGB) coefficients in the range 0.0 to 1.0. To draw
the sphere, the program needs a colormap that provides a
large range of uniformly distributed colors. The colormap
should be arranged so that the program can convert its RGB
triples into pixel values very quickly, because drawing the
entire sphere requires many such conversions.
On many current workstations, the display is limited to 256
or fewer colors. Applications must allocate colors care-
fully, not only to make sure they cover the entire range
they need but also to make use of as many of the available
colors as possible. On a typical X display, many applica-
tions are active at once. Most workstations have only one
hardware look-up table for colors, so only one application
colormap can be installed at a given time. The application
using the installed colormap is displayed correctly, and the
other applications go technicolor and are displayed with
false colors.
As another example, consider a user who is running an image
processing program to display earth-resources data. The
image processing program needs a colormap set up with 8
reds, 8 greens, and 4 blues, for a total of 256 colors.
Because some colors are already in use in the default col-
ormap, the image processing program allocates and installs a
new colormap.
The user decides to alter some of the colors in the image by
invoking a color palette program to mix and choose colors.
The color palette program also needs a colormap with eight
reds, eight greens, and four blues, so just like the image
processing program, it must allocate and install a new col-
ormap.
Because only one colormap can be installed at a time, the
color palette may be displayed incorrectly whenever the
image processing program is active. Conversely, whenever
the palette program is active, the image may be displayed
incorrectly. The user can never match or compare colors in
the palette and image. Contention for colormap resources
can be reduced if applications with similar color needs
share colormaps.
The image processing program and the color palette program
could share the same colormap if there existed a convention
that described how the colormap was set up. Whenever either
program was active, both would be displayed correctly.
The standard colormap properties define a set of commonly
used colormaps. Applications that share these colormaps and
conventions display true colors more often and provide a
better interface to the user.
553333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Standard colormaps allow applications to share commonly used
color resources. This allows many applications to be dis-
played in true colors simultaneously, even when each appli-
cation needs an entirely filled colormap.
Several standard colormaps are described in this section.
Usually, a window manager creates these colormaps. Applica-
tions should use the standard colormaps if they already
exist.
To allocate an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure, use _X_A_l_l_o_c_S_t_a_n_-
_d_a_r_d_C_o_l_o_r_m_a_p.
__
││
XStandardColormap *XAllocStandardColormap()
││__
The _X_A_l_l_o_c_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p function allocates and returns a
pointer to an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure. Note that all
fields in the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure are initially set
to zero. If insufficient memory is available, _X_A_l_l_o_c_S_t_a_n_-
_d_a_r_d_C_o_l_o_r_m_a_p returns NULL. To free the memory allocated to
this structure, use _X_F_r_e_e.
The _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure contains:
__
││ /* Hints */
#define _R_e_l_e_a_s_e_B_y_F_r_e_e_i_n_g_C_o_l_- ( (XID)
_o_r_m_a_p 1L)
/* Values */
typedef struct {
Colormap colormap;
unsigned long red_max;
unsigned long red_mult;
unsigned long green_max;
unsigned long green_mult;
unsigned long blue_max;
unsigned long blue_mult;
unsigned long base_pixel;
VisualID visualid;
XID killid;
} XStandardColormap;
││__
The colormap member is the colormap created by the _X_C_r_e_a_t_e_-
_C_o_l_o_r_m_a_p function. The red_max, green_max, and blue_max
members give the maximum red, green, and blue values,
553344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
respectively. Each color coefficient ranges from zero to
its max, inclusive. For example, a common colormap alloca-
tion 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, green_max = 5, and
blue_max = 5.
The red_mult, green_mult, and blue_mult members give the
scale factors used to compose a full pixel value. (See the
discussion of the base_pixel members for further informa-
tion.) 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 6, and blue_mult might be 1.
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 _X_A_l_l_o_c_C_o_l_o_r_P_l_a_n_e_s 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:
(r * red_mult + g * green_mult + b * blue_mult + base_pixel) & 0xFFFFFFFF
For _G_r_a_y_S_c_a_l_e colormaps, only the colormap, red_max,
red_mult, and base_pixel members are defined. The other
members are ignored. To compute a _G_r_a_y_S_c_a_l_e pixel value,
use the following expression:
(gray * red_mult + base_pixel) & 0xFFFFFFFF
Negative multipliers can be represented by converting the
2's complement representation of the multiplier into an
unsigned long and storing the result in the appropriate
_mult field. The step of masking by 0xFFFFFFFF effectively
converts the resulting positive multiplier into a negative
one. The masking step will take place automatically on many
machine architectures, 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 by freeing the colormap
ID or by calling the _X_K_i_l_l_C_l_i_e_n_t function on the indicated
resource. (Note that this method is necessary for allocat-
ing out of an existing colormap.)
553355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The properties containing the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p information
have the type RGB_COLOR_MAP.
The remainder of this section discusses standard colormap
properties and atoms as well as how to manipulate standard
colormaps.
1144..33..11.. SSttaannddaarrdd CCoolloorrmmaapp PPrrooppeerrttiieess aanndd AAttoommss
Several standard colormaps are available. Each standard
colormap is defined by a property, and each such property is
identified by an atom. The following list names the atoms
and describes the colormap associated with each one. The
<_X_1_1_/_X_a_t_o_m_._h> header file contains the definitions for each
of the following atoms, which are prefixed with XA_.
RGB_DEFAULT_MAP
This atom names a property. The value of the property
is an array of _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structures. Each
entry in the array describes an RGB subset of the
default color map for the Visual specified by
visual_id.
Some applications only need a few RGB colors and may be
able to allocate them from the system default colormap.
This is the ideal situation because the fewer colormaps
that are active in the system the more applications are
displayed with correct colors at all times.
A typical allocation for the RGB_DEFAULT_MAP on 8-plane
displays is 6 reds, 6 greens, and 6 blues. This gives
216 uniformly distributed colors (6 intensities of 36
different hues) and still leaves 40 elements of a
256-element colormap available for special-purpose col-
ors for text, borders, and so on.
RGB_BEST_MAP
This atom names a property. The value of the property
is an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p.
The property defines the best RGB colormap available on
the screen. (Of course, this is a subjective evalua-
tion.) Many image processing and three-dimensional
applications need to use all available colormap cells
and to distribute as many perceptually distinct colors
as possible over those cells. This implies that there
may be more green values available than red, as well as
more green or red than blue.
For an 8-plane _P_s_e_u_d_o_C_o_l_o_r visual, RGB_BEST_MAP is
likely to be a 3/3/2 allocation. For a 24-plane
_D_i_r_e_c_t_C_o_l_o_r visual, RGB_BEST_MAP is normally an 8/8/8
allocation.
553366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
RGB_RED_MAP
RGB_GREEN_MAP
RGB_BLUE_MAP
These atoms name properties. The value of each prop-
erty is an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p.
The properties define all-red, all-green, and all-blue
colormaps, respectively. These maps are used by appli-
cations that want to make color-separated images. For
example, a user might generate a full-color image on an
8-plane display both by rendering an image three times
(once with high color resolution in red, once with
green, and once with blue) and by multiply exposing a
single frame in a camera.
RGB_GRAY_MAP
This atom names a property. The value of the property
is an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p.
The property describes the best _G_r_a_y_S_c_a_l_e colormap
available on the screen. As previously mentioned, only
the colormap, red_max, red_mult, and base_pixel members
of the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure are used for
_G_r_a_y_S_c_a_l_e colormaps.
1144..33..22.. SSeettttiinngg aanndd OObbttaaiinniinngg SSttaannddaarrdd CCoolloorrmmaappss
Xlib provides functions that you can use to set and obtain
an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure.
To set an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure, use _X_S_e_t_R_G_B_C_o_l_o_r_m_a_p_s.
553377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XSetRGBColormaps(_d_i_s_p_l_a_y, _w, _s_t_d___c_o_l_o_r_m_a_p, _c_o_u_n_t, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XStandardColormap *_s_t_d___c_o_l_o_r_m_a_p;
int _c_o_u_n_t;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_t_d___c_o_l_o_r_m_a_p
Specifies the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure to be
used.
_c_o_u_n_t Specifies the number of colormaps.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_S_e_t_R_G_B_C_o_l_o_r_m_a_p_s function replaces the RGB colormap def-
inition in the specified property on the named window. If
the property does not already exist, _X_S_e_t_R_G_B_C_o_l_o_r_m_a_p_s sets
the RGB colormap definition in the specified property on the
named window. The property is stored with a type of
RGB_COLOR_MAP and a format of 32. Note that it is the
caller's responsibility to honor the ICCCM restriction that
only RGB_DEFAULT_MAP contain more than one definition.
The _X_S_e_t_R_G_B_C_o_l_o_r_m_a_p_s function usually is only used by window
or session managers. To create a standard colormap, follow
this procedure:
1. Open a new connection to the same server.
2. Grab the server.
3. See if the property is on the property list of the root
window for the screen.
4. If the desired property is not present:
· Create a colormap (unless you are using the
default colormap of the screen).
· Determine the color characteristics of the visual.
· Allocate cells in the colormap (or create it with
_A_l_l_o_c_A_l_l).
· Call _X_S_t_o_r_e_C_o_l_o_r_s to store appropriate color val-
ues in the colormap.
553388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
· Fill in the descriptive members in the _X_S_t_a_n_d_a_r_d_-
_C_o_l_o_r_m_a_p structure.
· Attach the property to the root window.
· Use _X_S_e_t_C_l_o_s_e_D_o_w_n_M_o_d_e to make the resource perma-
nent.
5. Ungrab the server.
_X_S_e_t_R_G_B_C_o_l_o_r_m_a_p_s can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, and _B_a_d_W_i_n_-
_d_o_w errors.
To obtain the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure associated with
the specified property, use _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s.
__
││
Status XGetRGBColormaps(_d_i_s_p_l_a_y, _w, _s_t_d___c_o_l_o_r_m_a_p___r_e_t_u_r_n, _c_o_u_n_t___r_e_t_u_r_n, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XStandardColormap **_s_t_d___c_o_l_o_r_m_a_p___r_e_t_u_r_n;
int *_c_o_u_n_t___r_e_t_u_r_n;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_s_t_d___c_o_l_o_r_m_a_p___r_e_t_u_r_n
Returns the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure.
_c_o_u_n_t___r_e_t_u_r_n
Returns the number of colormaps.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s function returns the RGB colormap defi-
nitions stored in the specified property on the named win-
dow. If the property exists, is of type RGB_COLOR_MAP, is
of format 32, and is long enough to contain a colormap defi-
nition, _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s allocates and fills in space for
the returned colormaps and returns a nonzero status. If the
visualid is not present, _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s assumes the
default visual for the screen on which the window is
located; if the killid is not present, _N_o_n_e is assumed,
which indicates that the resources cannot be released. Oth-
erwise, none of the fields are set, and _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s
returns a zero status. Note that it is the caller's respon-
sibility to honor the ICCCM restriction that only
RGB_DEFAULT_MAP contain more than one definition.
553399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_G_e_t_R_G_B_C_o_l_o_r_m_a_p_s can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
554400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1155
RReessoouurrccee MMaannaaggeerr FFuunnccttiioonnss
A program often needs a variety of options in the X environ-
ment (for example, fonts, colors, icons, and cursors).
Specifying all of these options on the command line is awk-
ward because users may want to customize many aspects of the
program and need a convenient way to establish these cus-
tomizations as the default settings. The resource manager
is provided for this purpose. Resource specifications are
usually stored in human-readable files and in server proper-
ties.
The resource manager is a database manager with a twist. In
most database systems, you perform a query using an impre-
cise specification, and you get back a set of records. The
resource manager, however, allows you to specify a large set
of values with an imprecise specification, to query the
database with a precise specification, and to get back only
a single value. This should be used by applications that
need to know what the user prefers for colors, fonts, and
other resources. It is this use as a database for dealing
with X resources that inspired the name ``Resource Man-
ager,'' although the resource manager can be and is used in
other ways.
For example, a user of your application may want to specify
that all windows should have a blue background but that all
mail-reading windows should have a red background. With
well-engineered and coordinated applications, a user can
define this information using only two lines of specifica-
tions.
As an example of how the resource manager works, consider a
mail-reading application called xmh. Assume that it is
designed so that it uses a complex window hierarchy all the
way down to individual command buttons, which may be actual
small subwindows in some toolkits. These are often called
objects or widgets. In such toolkit systems, each user
interface object can be composed of other objects and can be
assigned a name and a class. Fully qualified names or
classes can have arbitrary numbers of component names, but a
fully qualified name always has the same number of component
names as a fully qualified class. This generally reflects
the structure of the application as composed of these
objects, starting with the application itself.
For example, the xmh mail program has a name ``xmh'' and is
one of a class of ``Mail'' programs. By convention, the
554411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
first character of class components is capitalized, and the
first letter of name components is in lowercase. Each name
and class finally has an attribute (for example, ``fore-
ground'' or ``font''). If each window is properly assigned
a name and class, it is easy for the user to specify
attributes of any portion of the application.
At the top level, the application might consist of a paned
window (that is, a window divided into several sections)
named ``toc''. One pane of the paned window is a button box
window named ``buttons'' and is filled with command buttons.
One of these command buttons is used to incorporate new mail
and has the name ``incorporate''. This window has a fully
qualified name, ``xmh.toc.buttons.incorporate'', and a fully
qualified class, ``Xmh.Paned.Box.Command''. Its fully qual-
ified name is the name of its parent, ``xmh.toc.buttons'',
followed by its name, ``incorporate''. Its class is the
class of its parent, ``Xmh.Paned.Box'', followed by its par-
ticular class, ``Command''. The fully qualified name of a
resource is the attribute's name appended to the object's
fully qualified name, and the fully qualified class is its
class appended to the object's class.
The incorporate button might need the following resources:
Title string, Font, Foreground color for its inactive state,
Background color for its inactive state, Foreground color
for its active state, and Background color for its active
state. Each resource is considered to be an attribute of
the button and, as such, has a name and a class. For exam-
ple, the foreground color for the button in its active state
might be named ``activeForeground'', and its class might be
``Foreground''.
When an application looks up a resource (for example, a
color), it passes the complete name and complete class of
the resource to a look-up routine. The resource manager
compares this complete specification against the incomplete
specifications of entries in the resource database, finds
the best match, and returns the corresponding value for that
entry.
The definitions for the resource manager are contained in
<_X_1_1_/_X_r_e_s_o_u_r_c_e_._h>.
1155..11.. RReessoouurrccee FFiillee SSyynnttaaxx
The syntax of a resource file is a sequence of resource
lines terminated by newline characters or the end of the
file. The syntax of an individual resource line is:
ResourceLine = Comment | IncludeFile | ResourceSpec | <empty line>
Comment = "!" {<any character except null or newline>}
IncludeFile = "#" WhiteSpace "include" WhiteSpace FileName WhiteSpace
554422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
FileName = <valid filename for operating system>
ResourceSpec = WhiteSpace ResourceName WhiteSpace ":" WhiteSpace Value
ResourceName = [Binding] {Component Binding} ComponentName
Binding = "." | "*"
WhiteSpace = {<space> | <horizontal tab>}
Component = "?" | ComponentName
ComponentName = NameChar {NameChar}
NameChar = "a"-"z" | "A"-"Z" | "0"-"9" | "_" | "-"
Value = {<any character except null or unescaped newline>}
Elements separated by vertical bar (|) are alternatives.
Curly braces ({...}) indicate zero or more repetitions of
the enclosed elements. Square brackets ([...]) indicate
that the enclosed element is optional. Quotes ("...") are
used around literal characters.
IncludeFile lines are interpreted by replacing the line with
the contents of the specified file. The word ``include''
must be in lowercase. The file name is interpreted relative
to the directory of the file in which the line occurs (for
example, if the file name contains no directory or contains
a relative directory specification).
If a ResourceName contains a contiguous sequence of two or
more Binding characters, the sequence will be replaced with
a single ``.'' character if the sequence contains only ``.''
characters; otherwise, the sequence will be replaced with a
single ``*'' character.
A resource database never contains more than one entry for a
given ResourceName. If a resource file contains multiple
lines with the same ResourceName, the last line in the file
is used.
Any white space characters before or after the name or colon
in a ResourceSpec are ignored. To allow a Value to begin
with white space, the two-character sequence ``\_s_p_a_c_e''
(backslash followed by space) is recognized and replaced by
a space character, and the two-character sequence ``\_t_a_b''
(backslash followed by horizontal tab) is recognized and
replaced by a horizontal tab character. To allow a Value to
contain embedded newline characters, the two-character
sequence ``\n'' is recognized and replaced by a newline
character. To allow a Value to be broken across multiple
lines in a text file, the two-character sequence ``\_n_e_w_-
_l_i_n_e'' (backslash followed by newline) is recognized and
removed from the value. To allow a Value to contain arbi-
trary character codes, the four-character sequence ``\_n_n_n'',
where each _n is a digit character in the range of
``0''-``7'', is recognized and replaced with a single byte
that contains the octal value specified by the sequence.
Finally, the two-character sequence ``\\'' is recognized and
replaced with a single backslash.
554433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
As an example of these sequences, the following resource
line contains a value consisting of four characters: a back-
slash, a null, a ``z'', and a newline:
magic.values: \\\000\
z\n
1155..22.. RReessoouurrccee MMaannaaggeerr MMaattcchhiinngg RRuulleess
The algorithm for determining which resource database entry
matches a given query is the heart of the resource manager.
All queries must fully specify the name and class of the
desired resource (use of the characters ``*'' and ``?'' is
not permitted). The library supports up to 100 components
in a full name or class. Resources are stored in the
database with only partially specified names and classes,
using pattern matching constructs. An asterisk (*) is a
loose binding and is used to represent any number of inter-
vening components, including none. A period (.) is a tight
binding and is used to separate immediately adjacent compo-
nents. A question mark (?) is used to match any single com-
ponent name or class. A database entry cannot end in a
loose binding; the final component (which cannot be the
character ``?'') must be specified. The lookup algorithm
searches the database for the entry that most closely
matches (is most specific for) the full name and class being
queried. When more than one database entry matches the full
name and class, precedence rules are used to select just
one.
The full name and class are scanned from left to right (from
highest level in the hierarchy to lowest), one component at
a time. At each level, the corresponding component and/or
binding of each matching entry is determined, and these
matching components and bindings are compared according to
precedence rules. Each of the rules is applied at each
level before moving to the next level, until a rule selects
a single entry over all others. The rules, in order of
precedence, are:
1. An entry that contains a matching component (whether
name, class, or the character ``?'') takes precedence
over entries that elide the level (that is, entries
that match the level in a loose binding).
2. An entry with a matching name takes precedence over
both entries with a matching class and entries that
match using the character ``?''. An entry with a
matching class takes precedence over entries that match
using the character ``?''.
3. An entry preceded by a tight binding takes precedence
over entries preceded by a loose binding.
554444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To illustrate these rules, consider the following resource
database entries:
xmh*Paned*activeForeground: red_(_e_n_t_r_y _A_)
*incorporate.Foreground: blue _(_e_n_t_r_y _B_)
xmh.toc*Command*activeForeground: green_(_e_n_t_r_y _C_)
xmh.toc*?.Foreground: white _(_e_n_t_r_y _D_)
xmh.toc*Command.activeForeground: black_(_e_n_t_r_y _E_)
Consider a query for the resource:
xmh.toc.messagefunctions.incorporate.activeForeground_(_n_a_m_e_)
Xmh.Paned.Box.Command.Foreground _(_c_l_a_s_s_)
At the first level (xmh, Xmh), rule 1 eliminates entry B.
At the second level (toc, Paned), rule 2 eliminates entry A.
At the third level (messagefunctions, Box), no entries are
eliminated. At the fourth level (incorporate, Command),
rule 2 eliminates entry D. At the fifth level (activeFore-
ground, Foreground), rule 3 eliminates entry C.
1155..33.. QQuuaarrkkss
Most uses of the resource manager involve defining names,
classes, and representation types as string constants. How-
ever, always referring to strings in the resource manager
can be slow, because it is so heavily used in some toolkits.
To solve this problem, a shorthand for a string is used in
place of the string in many of the resource manager func-
tions. Simple comparisons can be performed rather than
string comparisons. The shorthand name for a string is
called a quark and is the type _X_r_m_Q_u_a_r_k. On some occasions,
you may want to allocate a quark that has no string equiva-
lent.
A quark is to a string what an atom is to a string in the
server, but its use is entirely local to your application.
To allocate a new quark, use _X_r_m_U_n_i_q_u_e_Q_u_a_r_k.
__
││
XrmQuark XrmUniqueQuark()
││__
The _X_r_m_U_n_i_q_u_e_Q_u_a_r_k function allocates a quark that is guar-
anteed not to represent any string that is known to the
resource manager.
554455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Each name, class, and representation type is typedef'd as an
_X_r_m_Q_u_a_r_k.
__
││
typedef int XrmQuark, *XrmQuarkList;
typedef XrmQuark XrmName;
typedef XrmQuark XrmClass;
typedef XrmQuark XrmRepresentation;
#define NULLQUARK ((XrmQuark) 0)
││__
Lists are represented as null-terminated arrays of quarks.
The size of the array must be large enough for the number of
components used.
__
││
typedef XrmQuarkList XrmNameList;
typedef XrmQuarkList XrmClassList;
││__
To convert a string to a quark, use _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k or _X_r_m_-
_P_e_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k.
__
││
#define XrmStringToName(string) XrmStringToQuark(string)
#define XrmStringToClass(string) XrmStringToQuark(string)
#define XrmStringToRepresentation(string) XrmStringToQuark(string)
XrmQuark XrmStringToQuark(_s_t_r_i_n_g)
char *_s_t_r_i_n_g;
XrmQuark XrmPermStringToQuark(_s_t_r_i_n_g)
char *_s_t_r_i_n_g;
_s_t_r_i_n_g Specifies the string for which a quark is to be
allocated.
││__
These functions can be used to convert from string to quark
representation. If the string is not in the Host Portable
Character Encoding, the conversion is implementation-depen-
dent. The string argument to _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k need not be
permanently allocated storage. _X_r_m_P_e_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k is just
like _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k, except that Xlib is permitted to
assume the string argument is permanently allocated, and,
hence, that it can be used as the value to be returned by
_X_r_m_Q_u_a_r_k_T_o_S_t_r_i_n_g.
554466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
For any given quark, if _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k returns a non-NULL
value, all future calls will return the same value (identi-
cal address).
To convert a quark to a string, use _X_r_m_Q_u_a_r_k_T_o_S_t_r_i_n_g.
__
││
#define XrmNameToString(name) XrmQuarkToString(name)
#define XrmClassToString(class) XrmQuarkToString(class)
#define XrmRepresentationToString(type) XrmQuarkToString(type)
char *XrmQuarkToString(_q_u_a_r_k)
XrmQuark _q_u_a_r_k;
_q_u_a_r_k Specifies the quark for which the equivalent
string is desired.
││__
These functions can be used to convert from quark represen-
tation to string. The string pointed to by the return value
must not be modified or freed. The returned string is byte-
for-byte equal to the original string passed to one of the
string-to-quark routines. If no string exists for that
quark, _X_r_m_Q_u_a_r_k_T_o_S_t_r_i_n_g returns NULL. For any given quark,
if _X_r_m_Q_u_a_r_k_T_o_S_t_r_i_n_g returns a non-NULL value, all future
calls will return the same value (identical address).
To convert a string with one or more components to a quark
list, use _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k_L_i_s_t.
__
││
#define XrmStringToNameList(str, name) XrmStringToQuarkList((str), (name))
#define XrmStringToClassList(str, class) XrmStringToQuarkList((str), (class))
void XrmStringToQuarkList(_s_t_r_i_n_g, _q_u_a_r_k_s___r_e_t_u_r_n)
char *_s_t_r_i_n_g;
XrmQuarkList _q_u_a_r_k_s___r_e_t_u_r_n;
_s_t_r_i_n_g Specifies the string for which a quark list is to
be allocated.
_q_u_a_r_k_s___r_e_t_u_r_n
Returns the list of quarks. The caller must allo-
cate sufficient space for the quarks list before
calling _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k_L_i_s_t.
││__
The _X_r_m_S_t_r_i_n_g_T_o_Q_u_a_r_k_L_i_s_t function converts the null-termi-
nated string (generally a fully qualified name) to a list of
quarks. Note that the string must be in the valid
554477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
ResourceName format (see section 15.1). If the string is
not in the Host Portable Character Encoding, the conversion
is implementation-dependent.
A binding list is a list of type _X_r_m_B_i_n_d_i_n_g_L_i_s_t and indi-
cates if components of name or class lists are bound tightly
or loosely (that is, if wildcarding of intermediate compo-
nents is specified).
typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList;
_X_r_m_B_i_n_d_T_i_g_h_t_l_y indicates that a period separates the compo-
nents, and _X_r_m_B_i_n_d_L_o_o_s_e_l_y indicates that an asterisk sepa-
rates the components.
To convert a string with one or more components to a binding
list and a quark list, use _X_r_m_S_t_r_i_n_g_T_o_B_i_n_d_i_n_g_Q_u_a_r_k_L_i_s_t.
__
││
XrmStringToBindingQuarkList(_s_t_r_i_n_g, _b_i_n_d_i_n_g_s___r_e_t_u_r_n, _q_u_a_r_k_s___r_e_t_u_r_n)
char *_s_t_r_i_n_g;
XrmBindingList _b_i_n_d_i_n_g_s___r_e_t_u_r_n;
XrmQuarkList _q_u_a_r_k_s___r_e_t_u_r_n;
_s_t_r_i_n_g Specifies the string for which a quark list is to
be allocated.
_b_i_n_d_i_n_g_s___r_e_t_u_r_n
Returns the binding list. The caller must allo-
cate sufficient space for the binding list before
calling _X_r_m_S_t_r_i_n_g_T_o_B_i_n_d_i_n_g_Q_u_a_r_k_L_i_s_t.
_q_u_a_r_k_s___r_e_t_u_r_n
Returns the list of quarks. The caller must allo-
cate sufficient space for the quarks list before
calling _X_r_m_S_t_r_i_n_g_T_o_B_i_n_d_i_n_g_Q_u_a_r_k_L_i_s_t.
││__
Component names in the list are separated by a period or an
asterisk character. The string must be in the format of a
valid ResourceName (see section 15.1). If the string does
not start with a period or an asterisk, a tight binding is
assumed. For example, the string ``*a.b*c'' becomes:
quarks: a bc
bindings: loose tightloose
554488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
1155..44.. CCrreeaattiinngg aanndd SSttoorriinngg DDaattaabbaasseess
A resource database is an opaque type, _X_r_m_D_a_t_a_b_a_s_e. Each
database value is stored in an _X_r_m_V_a_l_u_e structure. This
structure consists of a size, an address, and a representa-
tion type. The size is specified in bytes. The representa-
tion type is a way for you to store data tagged by some
application-defined type (for example, the strings ``font''
or ``color''). It has nothing to do with the C data type or
with its class. The _X_r_m_V_a_l_u_e structure is defined as:
__
││
typedef struct {
unsigned int size;
XPointer addr;
} XrmValue, *XrmValuePtr;
││__
To initialize the resource manager, use _X_r_m_I_n_i_t_i_a_l_i_z_e.
__
││
void XrmInitialize();
││__
To retrieve a database from disk, use _X_r_m_G_e_t_F_i_l_e_D_a_t_a_b_a_s_e.
__
││
XrmDatabase XrmGetFileDatabase(_f_i_l_e_n_a_m_e)
char *_f_i_l_e_n_a_m_e;
_f_i_l_e_n_a_m_e Specifies the resource database file name.
││__
The _X_r_m_G_e_t_F_i_l_e_D_a_t_a_b_a_s_e function opens the specified file,
creates a new resource database, and loads it with the spec-
ifications read in from the specified file. The specified
file should contain a sequence of entries in valid Resource-
Line format (see section 15.1); the database that results
from reading a file with incorrect syntax is implementation-
dependent. The file is parsed in the current locale, and
the database is created in the current locale. If it cannot
open the specified file, _X_r_m_G_e_t_F_i_l_e_D_a_t_a_b_a_s_e returns NULL.
To store a copy of a database to disk, use _X_r_m_P_u_t_F_i_l_e_-
_D_a_t_a_b_a_s_e.
554499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XrmPutFileDatabase(_d_a_t_a_b_a_s_e, _s_t_o_r_e_d___d_b)
XrmDatabase _d_a_t_a_b_a_s_e;
char *_s_t_o_r_e_d___d_b;
_d_a_t_a_b_a_s_e Specifies the database that is to be used.
_s_t_o_r_e_d___d_b Specifies the file name for the stored database.
││__
The _X_r_m_P_u_t_F_i_l_e_D_a_t_a_b_a_s_e function stores a copy of the speci-
fied database in the specified file. Text is written to the
file as a sequence of entries in valid ResourceLine format
(see section 15.1). The file is written in the locale of
the database. Entries containing resource names that are
not in the Host Portable Character Encoding or containing
values that are not in the encoding of the database locale,
are written in an implementation-dependent manner. The
order in which entries are written is implementation-depen-
dent. Entries with representation types other than
``String'' are ignored.
To obtain a pointer to the screen-independent resources of a
display, use _X_R_e_s_o_u_r_c_e_M_a_n_a_g_e_r_S_t_r_i_n_g.
__
││
char *XResourceManagerString(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_R_e_s_o_u_r_c_e_M_a_n_a_g_e_r_S_t_r_i_n_g function returns the
RESOURCE_MANAGER property from the server's root window of
screen zero, which was returned when the connection was
opened using _X_O_p_e_n_D_i_s_p_l_a_y. The property is converted from
type STRING to the current locale. The conversion is iden-
tical to that produced by _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t for a
single element STRING property. The returned string is
owned by Xlib and should not be freed by the client. The
property value must be in a format that is acceptable to
_X_r_m_G_e_t_S_t_r_i_n_g_D_a_t_a_b_a_s_e. If no property exists, NULL is
returned.
To obtain a pointer to the screen-specific resources of a
screen, use _X_S_c_r_e_e_n_R_e_s_o_u_r_c_e_S_t_r_i_n_g.
555500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char *XScreenResourceString(_s_c_r_e_e_n)
Screen *_s_c_r_e_e_n;
_s_c_r_e_e_n Specifies the screen.
││__
The _X_S_c_r_e_e_n_R_e_s_o_u_r_c_e_S_t_r_i_n_g function returns the
SCREEN_RESOURCES property from the root window of the speci-
fied screen. The property is converted from type STRING to
the current locale. The conversion is identical to that
produced by _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t for a single element
STRING property. The property value must be in a format
that is acceptable to _X_r_m_G_e_t_S_t_r_i_n_g_D_a_t_a_b_a_s_e. If no property
exists, NULL is returned. The caller is responsible for
freeing the returned string by using _X_F_r_e_e.
To create a database from a string, use _X_r_m_G_e_t_S_t_r_i_n_g_-
_D_a_t_a_b_a_s_e.
__
││
XrmDatabase XrmGetStringDatabase(_d_a_t_a)
char *_d_a_t_a;
_d_a_t_a Specifies the database contents using a string.
││__
The _X_r_m_G_e_t_S_t_r_i_n_g_D_a_t_a_b_a_s_e function creates a new database and
stores the resources specified in the specified null-termi-
nated string. _X_r_m_G_e_t_S_t_r_i_n_g_D_a_t_a_b_a_s_e is similar to _X_r_m_G_e_t_-
_F_i_l_e_D_a_t_a_b_a_s_e except that it reads the information out of a
string instead of out of a file. The string should contain
a sequence of entries in valid ResourceLine format (see sec-
tion 15.1) terminated by a null character; the database that
results from using a string with incorrect syntax is imple-
mentation-dependent. The string is parsed in the current
locale, and the database is created in the current locale.
To obtain the locale name of a database, use _X_r_m_L_o_c_a_l_e_O_f_-
_D_a_t_a_b_a_s_e.
__
││
char *XrmLocaleOfDatabase(_d_a_t_a_b_a_s_e)
XrmDatabase _d_a_t_a_b_a_s_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
││__
The _X_r_m_L_o_c_a_l_e_O_f_D_a_t_a_b_a_s_e function returns the name of the
555511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
locale bound to the specified database, as a null-terminated
string. The returned locale name string is owned by Xlib
and should not be modified or freed by the client. Xlib is
not permitted to free the string until the database is
destroyed. Until the string is freed, it will not be modi-
fied by Xlib.
To destroy a resource database and free its allocated mem-
ory, use _X_r_m_D_e_s_t_r_o_y_D_a_t_a_b_a_s_e.
__
││
void XrmDestroyDatabase(_d_a_t_a_b_a_s_e)
XrmDatabase _d_a_t_a_b_a_s_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
││__
If database is NULL, _X_r_m_D_e_s_t_r_o_y_D_a_t_a_b_a_s_e returns immediately.
To associate a resource database with a display, use _X_r_m_S_e_t_-
_D_a_t_a_b_a_s_e.
__
││
void XrmSetDatabase(_d_i_s_p_l_a_y, _d_a_t_a_b_a_s_e)
Display *_d_i_s_p_l_a_y;
XrmDatabase _d_a_t_a_b_a_s_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_a_t_a_b_a_s_e Specifies the resource database.
││__
The _X_r_m_S_e_t_D_a_t_a_b_a_s_e function associates the specified
resource database (or NULL) with the specified display. The
database previously associated with the display (if any) is
not destroyed. A client or toolkit may find this function
convenient for retaining a database once it is constructed.
To get the resource database associated with a display, use
_X_r_m_G_e_t_D_a_t_a_b_a_s_e.
555522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XrmDatabase XrmGetDatabase(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
The _X_r_m_G_e_t_D_a_t_a_b_a_s_e function returns the database associated
with the specified display. It returns NULL if a database
has not yet been set.
1155..55.. MMeerrggiinngg RReessoouurrccee DDaattaabbaasseess
To merge the contents of a resource file into a database,
use _X_r_m_C_o_m_b_i_n_e_F_i_l_e_D_a_t_a_b_a_s_e.
__
││
Status XrmCombineFileDatabase(_f_i_l_e_n_a_m_e, _t_a_r_g_e_t___d_b, _o_v_e_r_r_i_d_e)
char *_f_i_l_e_n_a_m_e;
XrmDatabase *_t_a_r_g_e_t___d_b;
Bool _o_v_e_r_r_i_d_e;
_f_i_l_e_n_a_m_e Specifies the resource database file name.
_t_a_r_g_e_t___d_b Specifies the resource database into which the
source database is to be merged.
_o_v_e_r_r_i_d_e Specifies whether source entries override target
ones.
││__
The _X_r_m_C_o_m_b_i_n_e_F_i_l_e_D_a_t_a_b_a_s_e function merges the contents of a
resource file into a database. If the same specifier is
used for an entry in both the file and the database, the
entry in the file will replace the entry in the database if
override is _T_r_u_e; otherwise, the entry in the file is dis-
carded. The file is parsed in the current locale. If the
file cannot be read, a zero status is returned; otherwise, a
nonzero status is returned. If target_db contains NULL,
_X_r_m_C_o_m_b_i_n_e_F_i_l_e_D_a_t_a_b_a_s_e creates and returns a new database to
it. Otherwise, the database pointed to by target_db is not
destroyed by the merge. The database entries are merged
without changing values or types, regardless of the locale
of the database. The locale of the target database is not
modified.
To merge the contents of one database into another database,
use _X_r_m_C_o_m_b_i_n_e_D_a_t_a_b_a_s_e.
555533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XrmCombineDatabase(_s_o_u_r_c_e___d_b, _t_a_r_g_e_t___d_b, _o_v_e_r_r_i_d_e)
XrmDatabase _s_o_u_r_c_e___d_b, *_t_a_r_g_e_t___d_b;
Bool _o_v_e_r_r_i_d_e;
_s_o_u_r_c_e___d_b Specifies the resource database that is to be
merged into the target database.
_t_a_r_g_e_t___d_b Specifies the resource database into which the
source database is to be merged.
_o_v_e_r_r_i_d_e Specifies whether source entries override target
ones.
││__
The _X_r_m_C_o_m_b_i_n_e_D_a_t_a_b_a_s_e function merges the contents of one
database into another. If the same specifier is used for an
entry in both databases, the entry in the source_db will
replace the entry in the target_db if override is _T_r_u_e; oth-
erwise, the entry in source_db is discarded. If target_db
contains NULL, _X_r_m_C_o_m_b_i_n_e_D_a_t_a_b_a_s_e simply stores source_db in
it. Otherwise, source_db is destroyed by the merge, but the
database pointed to by target_db is not destroyed. The
database entries are merged without changing values or
types, regardless of the locales of the databases. The
locale of the target database is not modified.
To merge the contents of one database into another database
with override semantics, use _X_r_m_M_e_r_g_e_D_a_t_a_b_a_s_e_s.
__
││
void XrmMergeDatabases(_s_o_u_r_c_e___d_b, _t_a_r_g_e_t___d_b)
XrmDatabase _s_o_u_r_c_e___d_b, *_t_a_r_g_e_t___d_b;
_s_o_u_r_c_e___d_b Specifies the resource database that is to be
merged into the target database.
_t_a_r_g_e_t___d_b Specifies the resource database into which the
source database is to be merged.
││__
Calling the _X_r_m_M_e_r_g_e_D_a_t_a_b_a_s_e_s function is equivalent to
calling the _X_r_m_C_o_m_b_i_n_e_D_a_t_a_b_a_s_e function with an override
argument of _T_r_u_e.
1155..66.. LLooookkiinngg UUpp RReessoouurrcceess
To retrieve a resource from a resource database, use _X_r_m_G_e_-
_t_R_e_s_o_u_r_c_e, _X_r_m_Q_G_e_t_R_e_s_o_u_r_c_e, or _X_r_m_Q_G_e_t_S_e_a_r_c_h_R_e_s_o_u_r_c_e.
555544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XrmGetResource(_d_a_t_a_b_a_s_e, _s_t_r___n_a_m_e, _s_t_r___c_l_a_s_s, _s_t_r___t_y_p_e___r_e_t_u_r_n, _v_a_l_u_e___r_e_t_u_r_n)
XrmDatabase _d_a_t_a_b_a_s_e;
char *_s_t_r___n_a_m_e;
char *_s_t_r___c_l_a_s_s;
char **_s_t_r___t_y_p_e___r_e_t_u_r_n;
XrmValue *_v_a_l_u_e___r_e_t_u_r_n;
_d_a_t_a_b_a_s_e Specifies the database that is to be used.
_s_t_r___n_a_m_e Specifies the fully qualified name of the value
being retrieved (as a string).
_s_t_r___c_l_a_s_s Specifies the fully qualified class of the value
being retrieved (as a string).
_s_t_r___t_y_p_e___r_e_t_u_r_n
Returns the representation type of the destination
(as a string).
_v_a_l_u_e___r_e_t_u_r_n
Returns the value in the database.
││__
555555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XrmQGetResource(_d_a_t_a_b_a_s_e, _q_u_a_r_k___n_a_m_e, _q_u_a_r_k___c_l_a_s_s, _q_u_a_r_k___t_y_p_e___r_e_t_u_r_n, _v_a_l_u_e___r_e_t_u_r_n)
XrmDatabase _d_a_t_a_b_a_s_e;
XrmNameList _q_u_a_r_k___n_a_m_e;
XrmClassList _q_u_a_r_k___c_l_a_s_s;
XrmRepresentation *_q_u_a_r_k___t_y_p_e___r_e_t_u_r_n;
XrmValue *_v_a_l_u_e___r_e_t_u_r_n;
_d_a_t_a_b_a_s_e Specifies the database that is to be used.
_q_u_a_r_k___n_a_m_e
Specifies the fully qualified name of the value
being retrieved (as a quark).
_q_u_a_r_k___c_l_a_s_s
Specifies the fully qualified class of the value
being retrieved (as a quark).
_q_u_a_r_k___t_y_p_e___r_e_t_u_r_n
Returns the representation type of the destination
(as a quark).
_v_a_l_u_e___r_e_t_u_r_n
Returns the value in the database.
││__
The _X_r_m_G_e_t_R_e_s_o_u_r_c_e and _X_r_m_Q_G_e_t_R_e_s_o_u_r_c_e functions retrieve a
resource from the specified database. Both take a fully
qualified name/class pair, a destination resource represen-
tation, and the address of a value (size/address pair). The
value and returned type point into database memory; there-
fore, you must not modify the data.
The database only frees or overwrites entries on _X_r_m_P_u_t_R_e_-
_s_o_u_r_c_e, _X_r_m_Q_P_u_t_R_e_s_o_u_r_c_e, or _X_r_m_M_e_r_g_e_D_a_t_a_b_a_s_e_s. A client
that is not storing new values into the database or is not
merging the database should be safe using the address passed
back at any time until it exits. If a resource was found,
both _X_r_m_G_e_t_R_e_s_o_u_r_c_e and _X_r_m_Q_G_e_t_R_e_s_o_u_r_c_e return _T_r_u_e; other-
wise, they return _F_a_l_s_e.
Most applications and toolkits do not make random probes
into a resource database to fetch resources. The X toolkit
access pattern for a resource database is quite stylized. A
series of from 1 to 20 probes is made with only the last
name/class differing in each probe. The _X_r_m_G_e_t_R_e_s_o_u_r_c_e
function is at worst a 2_n algorithm, where _n is the length
of the name/class list. This can be improved upon by the
application programmer by prefetching a list of database
levels that might match the first part of a name/class list.
555566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To obtain a list of database levels, use _X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t.
__
││
typedef XrmHashTable *XrmSearchList;
Bool XrmQGetSearchList(_d_a_t_a_b_a_s_e, _n_a_m_e_s, _c_l_a_s_s_e_s, _l_i_s_t___r_e_t_u_r_n, _l_i_s_t___l_e_n_g_t_h)
XrmDatabase _d_a_t_a_b_a_s_e;
XrmNameList _n_a_m_e_s;
XrmClassList _c_l_a_s_s_e_s;
XrmSearchList _l_i_s_t___r_e_t_u_r_n;
int _l_i_s_t___l_e_n_g_t_h;
_d_a_t_a_b_a_s_e Specifies the database that is to be used.
_n_a_m_e_s Specifies a list of resource names.
_c_l_a_s_s_e_s Specifies a list of resource classes.
_l_i_s_t___r_e_t_u_r_n
Returns a search list for further use. The caller
must allocate sufficient space for the list before
calling _X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t.
_l_i_s_t___l_e_n_g_t_h
Specifies the number of entries (not the byte
size) allocated for list_return.
││__
The _X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t function takes a list of names and
classes and returns a list of database levels where a match
might occur. The returned list is in best-to-worst order
and uses the same algorithm as _X_r_m_G_e_t_R_e_s_o_u_r_c_e for determin-
ing precedence. If list_return was large enough for the
search list, _X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t returns _T_r_u_e; otherwise, it
returns _F_a_l_s_e.
The size of the search list that the caller must allocate is
dependent upon the number of levels and wildcards in the
resource specifiers that are stored in the database. The
worst case length is 3_n, where _n is the number of name or
class components in names or classes.
When using _X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t followed by multiple probes for
resources with a common name and class prefix, only the com-
mon prefix should be specified in the name and class list to
_X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t.
To search resource database levels for a given resource, use
_X_r_m_Q_G_e_t_S_e_a_r_c_h_R_e_s_o_u_r_c_e.
555577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XrmQGetSearchResource(_l_i_s_t, _n_a_m_e, _c_l_a_s_s, _t_y_p_e___r_e_t_u_r_n, _v_a_l_u_e___r_e_t_u_r_n)
XrmSearchList _l_i_s_t;
XrmName _n_a_m_e;
XrmClass _c_l_a_s_s;
XrmRepresentation *_t_y_p_e___r_e_t_u_r_n;
XrmValue *_v_a_l_u_e___r_e_t_u_r_n;
_l_i_s_t Specifies the search list returned by _X_r_m_Q_G_e_t_-
_S_e_a_r_c_h_L_i_s_t.
_n_a_m_e Specifies the resource name.
_c_l_a_s_s Specifies the resource class.
_t_y_p_e___r_e_t_u_r_n
Returns data representation type.
_v_a_l_u_e___r_e_t_u_r_n
Returns the value in the database.
││__
The _X_r_m_Q_G_e_t_S_e_a_r_c_h_R_e_s_o_u_r_c_e function searches the specified
database levels for the resource that is fully identified by
the specified name and class. The search stops with the
first match. _X_r_m_Q_G_e_t_S_e_a_r_c_h_R_e_s_o_u_r_c_e returns _T_r_u_e if the
resource was found; otherwise, it returns _F_a_l_s_e.
A call to _X_r_m_Q_G_e_t_S_e_a_r_c_h_L_i_s_t with a name and class list con-
taining all but the last component of a resource name fol-
lowed by a call to _X_r_m_Q_G_e_t_S_e_a_r_c_h_R_e_s_o_u_r_c_e with the last com-
ponent name and class returns the same database entry as
_X_r_m_G_e_t_R_e_s_o_u_r_c_e and _X_r_m_Q_G_e_t_R_e_s_o_u_r_c_e with the fully qualified
name and class.
1155..77.. SSttoorriinngg iinnttoo aa RReessoouurrccee DDaattaabbaassee
To store resources into the database, use _X_r_m_P_u_t_R_e_s_o_u_r_c_e or
_X_r_m_Q_P_u_t_R_e_s_o_u_r_c_e. Both functions take a partial resource
specification, a representation type, and a value. This
value is copied into the specified database.
555588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XrmPutResource(_d_a_t_a_b_a_s_e, _s_p_e_c_i_f_i_e_r, _t_y_p_e, _v_a_l_u_e)
XrmDatabase *_d_a_t_a_b_a_s_e;
char *_s_p_e_c_i_f_i_e_r;
char *_t_y_p_e;
XrmValue *_v_a_l_u_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
_s_p_e_c_i_f_i_e_r Specifies a complete or partial specification of
the resource.
_t_y_p_e Specifies the type of the resource.
_v_a_l_u_e Specifies the value of the resource, which is
specified as a string.
││__
If database contains NULL, _X_r_m_P_u_t_R_e_s_o_u_r_c_e creates a new
database and returns a pointer to it. _X_r_m_P_u_t_R_e_s_o_u_r_c_e is a
convenience function that calls _X_r_m_S_t_r_i_n_g_T_o_B_i_n_d_i_n_g_Q_u_a_r_k_L_i_s_t
followed by:
XrmQPutResource(database, bindings, quarks, XrmStringToQuark(type), value)
If the specifier and type are not in the Host Portable Char-
acter Encoding, the result is implementation-dependent. The
value is stored in the database without modification.
555599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XrmQPutResource(_d_a_t_a_b_a_s_e, _b_i_n_d_i_n_g_s, _q_u_a_r_k_s, _t_y_p_e, _v_a_l_u_e)
XrmDatabase *_d_a_t_a_b_a_s_e;
XrmBindingList _b_i_n_d_i_n_g_s;
XrmQuarkList _q_u_a_r_k_s;
XrmRepresentation _t_y_p_e;
XrmValue *_v_a_l_u_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
_b_i_n_d_i_n_g_s Specifies a list of bindings.
_q_u_a_r_k_s Specifies the complete or partial name or the
class list of the resource.
_t_y_p_e Specifies the type of the resource.
_v_a_l_u_e Specifies the value of the resource, which is
specified as a string.
││__
If database contains NULL, _X_r_m_Q_P_u_t_R_e_s_o_u_r_c_e creates a new
database and returns a pointer to it. If a resource entry
with the identical bindings and quarks already exists in the
database, the previous type and value are replaced by the
new specified type and value. The value is stored in the
database without modification.
To add a resource that is specified as a string, use _X_r_m_P_u_t_-
_S_t_r_i_n_g_R_e_s_o_u_r_c_e.
__
││
void XrmPutStringResource(_d_a_t_a_b_a_s_e, _s_p_e_c_i_f_i_e_r, _v_a_l_u_e)
XrmDatabase *_d_a_t_a_b_a_s_e;
char *_s_p_e_c_i_f_i_e_r;
char *_v_a_l_u_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
_s_p_e_c_i_f_i_e_r Specifies a complete or partial specification of
the resource.
_v_a_l_u_e Specifies the value of the resource, which is
specified as a string.
││__
If database contains NULL, _X_r_m_P_u_t_S_t_r_i_n_g_R_e_s_o_u_r_c_e creates a
new database and returns a pointer to it. _X_r_m_P_u_t_S_t_r_i_n_g_R_e_-
_s_o_u_r_c_e adds a resource with the specified value to the spec-
ified database. _X_r_m_P_u_t_S_t_r_i_n_g_R_e_s_o_u_r_c_e is a convenience func-
tion that first calls _X_r_m_S_t_r_i_n_g_T_o_B_i_n_d_i_n_g_Q_u_a_r_k_L_i_s_t on the
556600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
specifier and then calls _X_r_m_Q_P_u_t_R_e_s_o_u_r_c_e, using a ``String''
representation type. If the specifier is not in the Host
Portable Character Encoding, the result is implementation-
dependent. The value is stored in the database without mod-
ification.
To add a string resource using quarks as a specification,
use _X_r_m_Q_P_u_t_S_t_r_i_n_g_R_e_s_o_u_r_c_e.
__
││
void XrmQPutStringResource(_d_a_t_a_b_a_s_e, _b_i_n_d_i_n_g_s, _q_u_a_r_k_s, _v_a_l_u_e)
XrmDatabase *_d_a_t_a_b_a_s_e;
XrmBindingList _b_i_n_d_i_n_g_s;
XrmQuarkList _q_u_a_r_k_s;
char *_v_a_l_u_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
_b_i_n_d_i_n_g_s Specifies a list of bindings.
_q_u_a_r_k_s Specifies the complete or partial name or the
class list of the resource.
_v_a_l_u_e Specifies the value of the resource, which is
specified as a string.
││__
If database contains NULL, _X_r_m_Q_P_u_t_S_t_r_i_n_g_R_e_s_o_u_r_c_e creates a
new database and returns a pointer to it. _X_r_m_Q_P_u_t_S_t_r_i_n_g_R_e_-
_s_o_u_r_c_e is a convenience routine that constructs an _X_r_m_V_a_l_u_e
for the value string (by calling _s_t_r_l_e_n to compute the size)
and then calls _X_r_m_Q_P_u_t_R_e_s_o_u_r_c_e, using a ``String'' represen-
tation type. The value is stored in the database without
modification.
To add a single resource entry that is specified as a string
that contains both a name and a value, use _X_r_m_P_u_t_L_i_n_e_R_e_-
_s_o_u_r_c_e.
556611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XrmPutLineResource(_d_a_t_a_b_a_s_e, _l_i_n_e)
XrmDatabase *_d_a_t_a_b_a_s_e;
char *_l_i_n_e;
_d_a_t_a_b_a_s_e Specifies the resource database.
_l_i_n_e Specifies the resource name and value pair as a
single string.
││__
If database contains NULL, _X_r_m_P_u_t_L_i_n_e_R_e_s_o_u_r_c_e creates a new
database and returns a pointer to it. _X_r_m_P_u_t_L_i_n_e_R_e_s_o_u_r_c_e
adds a single resource entry to the specified database. The
line should be in valid ResourceLine format (see section
15.1) terminated by a newline or null character; the
database that results from using a string with incorrect
syntax is implementation-dependent. The string is parsed in
the locale of the database. If the _R_e_s_o_u_r_c_e_N_a_m_e is not in
the Host Portable Character Encoding, the result is imple-
mentation-dependent. Note that comment lines are not
stored.
1155..88.. EEnnuummeerraattiinngg DDaattaabbaassee EEnnttrriieess
To enumerate the entries of a database, use _X_r_m_E_n_u_m_e_r_a_t_e_-
_D_a_t_a_b_a_s_e.
556622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
#define _X_r_m_E_n_u_m_A_l_l_L_e_v_e_l_s 0
#define _X_r_m_E_n_u_m_O_n_e_L_e_v_e_l 1
Bool XrmEnumerateDatabase(_d_a_t_a_b_a_s_e, _n_a_m_e___p_r_e_f_i_x, _c_l_a_s_s___p_r_e_f_i_x, _m_o_d_e, _p_r_o_c, _a_r_g)
XrmDatabase _d_a_t_a_b_a_s_e;
XrmNameList _n_a_m_e___p_r_e_f_i_x;
XrmClassList _c_l_a_s_s___p_r_e_f_i_x;
int _m_o_d_e;
Bool (*_p_r_o_c)();
XPointer _a_r_g;
_d_a_t_a_b_a_s_e Specifies the resource database.
_n_a_m_e___p_r_e_f_i_x
Specifies the resource name prefix.
_c_l_a_s_s___p_r_e_f_i_x
Specifies the resource class prefix.
_m_o_d_e Specifies the number of levels to enumerate.
_p_r_o_c Specifies the procedure that is to be called for
each matching entry.
_a_r_g Specifies the user-supplied argument that will be
passed to the procedure.
││__
The _X_r_m_E_n_u_m_e_r_a_t_e_D_a_t_a_b_a_s_e function calls the specified proce-
dure for each resource in the database that would match some
completion of the given name/class resource prefix. The
order in which resources are found is implementation-depen-
dent. If mode is _X_r_m_E_n_u_m_O_n_e_L_e_v_e_l, a resource must match the
given name/class prefix with just a single name and class
appended. If mode is _X_r_m_E_n_u_m_A_l_l_L_e_v_e_l_s, the resource must
match the given name/class prefix with one or more names and
classes appended. If the procedure returns _T_r_u_e, the enu-
meration terminates and the function returns _T_r_u_e. If the
procedure always returns _F_a_l_s_e, all matching resources are
enumerated and the function returns _F_a_l_s_e.
The procedure is called with the following arguments:
(*_p_r_o_c)(_d_a_t_a_b_a_s_e, _b_i_n_d_i_n_g_s, _q_u_a_r_k_s, _t_y_p_e, _v_a_l_u_e, _a_r_g)
XrmDatabase *_d_a_t_a_b_a_s_e;
XrmBindingList _b_i_n_d_i_n_g_s;
XrmQuarkList _q_u_a_r_k_s;
XrmRepresentation *_t_y_p_e;
XrmValue *_v_a_l_u_e;
XPointer _a_r_g;
556633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The bindings and quarks lists are terminated by _N_U_L_L_Q_U_A_R_K.
Note that pointers to the database and type are passed, but
these values should not be modified.
The procedure must not modify the database. If Xlib has
been initialized for threads, the procedure is called with
the database locked and the result of a call by the proce-
dure to any Xlib function using the same database is not
defined.
1155..99.. PPaarrssiinngg CCoommmmaanndd LLiinnee OOppttiioonnss
The _X_r_m_P_a_r_s_e_C_o_m_m_a_n_d function can be used to parse the com-
mand line arguments to a program and modify a resource
database with selected entries from the command line.
__
││
typedef enum {
XrmoptionNoArg, /* Value is specified in XrmOptionDescRec.value */
XrmoptionIsArg, /* Value is the option string itself */
XrmoptionStickyArg, /* Value is characters immediately following option */
XrmoptionSepArg, /* Value is next argument in argv */
XrmoptionResArg, /* Resource and value in next argument in argv */
XrmoptionSkipArg, /* Ignore this option and the next argument in argv */
XrmoptionSkipLine, /* Ignore this option and the rest of argv */
XrmoptionSkipNArgs /* Ignore this option and the next
XrmOptionDescRec.value arguments in argv */
} XrmOptionKind;
││__
Note that _X_r_m_o_p_t_i_o_n_S_k_i_p_A_r_g is equivalent to _X_r_m_o_p_t_i_o_n_S_k_i_p_-
_N_A_r_g_s with the _X_r_m_O_p_t_i_o_n_D_e_s_c_R_e_c_._v_a_l_u_e field containing the
value one. Note also that the value zero for _X_r_m_o_p_t_i_o_n_S_k_i_p_-
_N_A_r_g_s indicates that only the option itself is to be
skipped.
__
││
typedef struct {
char *option; /* Option specification string in argv */
char *specifier; /* Binding and resource name (sans application name) */
XrmOptionKind argKind;/* Which style of option it is */
XPointer value; /* Value to provide if XrmoptionNoArg or
XrmoptionSkipNArgs */
} XrmOptionDescRec, *XrmOptionDescList;
││__
To load a resource database from a C command line, use _X_r_m_-
_P_a_r_s_e_C_o_m_m_a_n_d.
556644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XrmParseCommand(_d_a_t_a_b_a_s_e, _t_a_b_l_e, _t_a_b_l_e___c_o_u_n_t, _n_a_m_e, _a_r_g_c___i_n___o_u_t, _a_r_g_v___i_n___o_u_t)
XrmDatabase *_d_a_t_a_b_a_s_e;
XrmOptionDescList _t_a_b_l_e;
int _t_a_b_l_e___c_o_u_n_t;
char *_n_a_m_e;
int *_a_r_g_c___i_n___o_u_t;
char **_a_r_g_v___i_n___o_u_t;
_d_a_t_a_b_a_s_e Specifies the resource database.
_t_a_b_l_e Specifies the table of command line arguments to
be parsed.
_t_a_b_l_e___c_o_u_n_t
Specifies the number of entries in the table.
_n_a_m_e Specifies the application name.
_a_r_g_c___i_n___o_u_t
Specifies the number of arguments and returns the
number of remaining arguments.
_a_r_g_v___i_n___o_u_t
Specifies the command line arguments and returns
the remaining arguments.
││__
The _X_r_m_P_a_r_s_e_C_o_m_m_a_n_d function parses an (argc, argv) pair
according to the specified option table, loads recognized
options into the specified database with type ``String,''
and modifies the (argc, argv) pair to remove all recognized
options. If database contains NULL, _X_r_m_P_a_r_s_e_C_o_m_m_a_n_d creates
a new database and returns a pointer to it. Otherwise,
entries are added to the database specified. If a database
is created, it is created in the current locale.
The specified table is used to parse the command line. Rec-
ognized options in the table are removed from argv, and
entries are added to the specified resource database in the
order they occur in argv. The table entries contain infor-
mation on the option string, the option name, the style of
option, and a value to provide if the option kind is _X_r_m_o_p_-
_t_i_o_n_N_o_A_r_g. The option names are compared byte-for-byte to
arguments in argv, independent of any locale. The resource
values given in the table are stored in the resource
database without modification. All resource database
entries are created using a ``String'' representation type.
The argc argument specifies the number of arguments in argv
and is set on return to the remaining number of arguments
that were not parsed. The name argument should be the name
of your application for use in building the database entry.
The name argument is prefixed to the resourceName in the
556655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
option table before storing a database entry. The name
argument is treated as a single component, even if it has
embedded periods. No separating (binding) character is
inserted, so the table must contain either a period (.) or
an asterisk (*) as the first character in each resourceName
entry. To specify a more completely qualified resource
name, the resourceName entry can contain multiple compo-
nents. If the name argument and the resourceNames are not
in the Host Portable Character Encoding, the result is
implementation-dependent.
The following provides a sample option table:
static XrmOptionDescRec opTable[] = {
{"-background", "*background", XrmoptionSepArg,(XPointer) NULL},
{"-bd", "*borderColor", XrmoptionSepArg,(XPointer) NULL},
{"-bg", "*background", XrmoptionSepArg,(XPointer) NULL},
{"-borderwidth", "*TopLevelShell.borderWidth",XrmoptionSepArg,(XPointer) NULL},
{"-bordercolor", "*borderColor",XrmoptionSepArg,(XPointer) NULL},
{"-bw", "*TopLevelShell.borderWidth", XrmoptionSepArg,(XPointer) NULL},
{"-display", ".display", XrmoptionSepArg,(XPointer) NULL},
{"-fg", "*foreground", XrmoptionSepArg,(XPointer) NULL},
{"-fn", "*font", XrmoptionSepArg,(XPointer) NULL},
{"-font", "*font", XrmoptionSepArg,(XPointer) NULL},
{"-foreground", "*foreground", XrmoptionSepArg,(XPointer) NULL},
{"-geometry", ".TopLevelShell.geometry",XrmoptionSepArg,(XPointer) NULL},
{"-iconic", ".TopLevelShell.iconic", XrmoptionNoArg,(XPointer) "on"},
{"-name", ".name", XrmoptionSepArg,(XPointer) NULL},
{"-reverse", "*reverseVideo",XrmoptionNoArg,(XPointer) "on"},
{"-rv", "*reverseVideo", XrmoptionNoArg,(XPointer) "on"},
{"-synchronous", "*synchronous",XrmoptionNoArg,(XPointer) "on"},
{"-title", ".TopLevelShell.title", XrmoptionSepArg,(XPointer) NULL},
{"-xrm", NULL, XrmoptionResArg,(XPointer) NULL},
};
In this table, if the -background (or -bg) option is used to
set background colors, the stored resource specifier matches
all resources of attribute background. If the -borderwidth
option is used, the stored resource specifier applies only
to border width attributes of class TopLevelShell (that is,
outer-most windows, including pop-up windows). If the
-title option is used to set a window name, only the topmost
application windows receive the resource.
When parsing the command line, any unique unambiguous abbre-
viation for an option name in the table is considered a
match for the option. Note that uppercase and lowercase
matter.
556666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CChhaapptteerr 1166
AApppplliiccaattiioonn UUttiilliittyy FFuunnccttiioonnss
Once you have initialized the X system, you can use the Xlib
utility functions to:
· Use keyboard utility functions
· Use Latin-1 keyboard event functions
· Allocate permanent storage
· Parse the window geometry
· Manipulate regions
· Use cut buffers
· Determine the appropriate visual type
· Manipulate images
· Manipulate bitmaps
· Use the context manager
As a group, the functions discussed in this chapter provide
the functionality that is frequently needed and that spans
toolkits. Many of these functions do not generate actual
protocol requests to the server.
1166..11.. UUssiinngg KKeeyybbooaarrdd UUttiilliittyy FFuunnccttiioonnss
This section discusses mapping between KeyCodes and KeySyms,
classifying KeySyms, and mapping between KeySyms and string
names. The first three functions in this section operate on
a cached copy of the server keyboard mapping. The first
four KeySyms for each KeyCode are modified according to the
rules given in section 12.7. To obtain the untransformed
KeySyms defined for a key, use the functions described in
section 12.7.
To obtain a KeySym for the KeyCode of an event, use _X_L_o_o_k_u_p_-
_K_e_y_s_y_m.
556677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
KeySym XLookupKeysym(_k_e_y___e_v_e_n_t, _i_n_d_e_x)
XKeyEvent *_k_e_y___e_v_e_n_t;
int _i_n_d_e_x;
_k_e_y___e_v_e_n_t Specifies the _K_e_y_P_r_e_s_s or _K_e_y_R_e_l_e_a_s_e event.
_i_n_d_e_x Specifies the index into the KeySyms list for the
event's KeyCode.
││__
The _X_L_o_o_k_u_p_K_e_y_s_y_m function uses a given keyboard event and
the index you specified to return the KeySym from the list
that corresponds to the KeyCode member in the _X_K_e_y_P_r_e_s_s_e_d_E_-
_v_e_n_t or _X_K_e_y_R_e_l_e_a_s_e_d_E_v_e_n_t structure. If no KeySym is
defined for the KeyCode of the event, _X_L_o_o_k_u_p_K_e_y_s_y_m returns
_N_o_S_y_m_b_o_l.
To obtain a KeySym for a specific KeyCode, use _X_K_e_y_-
_c_o_d_e_T_o_K_e_y_s_y_m.
__
││
KeySym XKeycodeToKeysym(_d_i_s_p_l_a_y, _k_e_y_c_o_d_e, _i_n_d_e_x)
Display *_d_i_s_p_l_a_y;
KeyCode _k_e_y_c_o_d_e;
int _i_n_d_e_x;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_c_o_d_e Specifies the KeyCode.
_i_n_d_e_x Specifies the element of KeyCode vector.
││__
The _X_K_e_y_c_o_d_e_T_o_K_e_y_s_y_m function uses internal Xlib tables and
returns the KeySym defined for the specified KeyCode and the
element of the KeyCode vector. If no symbol is defined,
_X_K_e_y_c_o_d_e_T_o_K_e_y_s_y_m returns _N_o_S_y_m_b_o_l.
To obtain a KeyCode for a key having a specific KeySym, use
_X_K_e_y_s_y_m_T_o_K_e_y_c_o_d_e.
556688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
KeyCode XKeysymToKeycode(_d_i_s_p_l_a_y, _k_e_y_s_y_m)
Display *_d_i_s_p_l_a_y;
KeySym _k_e_y_s_y_m;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_s_y_m Specifies the KeySym that is to be searched for.
││__
If the specified KeySym is not defined for any KeyCode,
_X_K_e_y_s_y_m_T_o_K_e_y_c_o_d_e returns zero.
The mapping between KeyCodes and KeySyms is cached internal
to Xlib. When this information is changed at the server, an
Xlib function must be called to refresh the cache. To
refresh the stored modifier and keymap information, use _X_R_e_-
_f_r_e_s_h_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g.
__
││
XRefreshKeyboardMapping(_e_v_e_n_t___m_a_p)
XMappingEvent *_e_v_e_n_t___m_a_p;
_e_v_e_n_t___m_a_p Specifies the mapping event that is to be used.
││__
The _X_R_e_f_r_e_s_h_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g function refreshes the stored
modifier and keymap information. You usually call this
function when a _M_a_p_p_i_n_g_N_o_t_i_f_y event with a request member of
_M_a_p_p_i_n_g_K_e_y_b_o_a_r_d or _M_a_p_p_i_n_g_M_o_d_i_f_i_e_r occurs. The result is to
update Xlib's knowledge of the keyboard.
To obtain the uppercase and lowercase forms of a KeySym, use
_X_C_o_n_v_e_r_t_C_a_s_e.
556699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
void XConvertCase(_k_e_y_s_y_m, _l_o_w_e_r___r_e_t_u_r_n, _u_p_p_e_r___r_e_t_u_r_n)
KeySym _k_e_y_s_y_m;
KeySym *_l_o_w_e_r___r_e_t_u_r_n;
KeySym *_u_p_p_e_r___r_e_t_u_r_n;
_k_e_y_s_y_m Specifies the KeySym that is to be converted.
_l_o_w_e_r___r_e_t_u_r_n
Returns the lowercase form of keysym, or keysym.
_u_p_p_e_r___r_e_t_u_r_n
Returns the uppercase form of keysym, or keysym.
││__
The _X_C_o_n_v_e_r_t_C_a_s_e function returns the uppercase and lower-
case forms of the specified Keysym, if the KeySym is subject
to case conversion; otherwise, the specified KeySym is
returned to both lower_return and upper_return. Support for
conversion of other than Latin and Cyrillic KeySyms is
implementation-dependent.
KeySyms have string names as well as numeric codes. To con-
vert the name of the KeySym to the KeySym code, use _X_S_t_r_i_n_g_-
_T_o_K_e_y_s_y_m.
__
││
KeySym XStringToKeysym(_s_t_r_i_n_g)
char *_s_t_r_i_n_g;
_s_t_r_i_n_g Specifies the name of the KeySym that is to be
converted.
││__
Standard KeySym names are obtained from <_X_1_1_/_k_e_y_s_y_m_d_e_f_._h> by
removing the XK_ prefix from each name. KeySyms that are
not part of the Xlib standard also may be obtained with this
function. The set of KeySyms that are available in this
manner and the mechanisms by which Xlib obtains them is
implementation-dependent.
If the KeySym name is not in the Host Portable Character
Encoding, the result is implementation-dependent. If the
specified string does not match a valid KeySym, _X_S_t_r_i_n_g_-
_T_o_K_e_y_s_y_m returns _N_o_S_y_m_b_o_l.
To convert a KeySym code to the name of the KeySym, use
_X_K_e_y_s_y_m_T_o_S_t_r_i_n_g.
557700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char *XKeysymToString(_k_e_y_s_y_m)
KeySym _k_e_y_s_y_m;
_k_e_y_s_y_m Specifies the KeySym that is to be converted.
││__
The returned string is in a static area and must not be mod-
ified. The returned string is in the Host Portable Charac-
ter Encoding. If the specified KeySym is not defined,
_X_K_e_y_s_y_m_T_o_S_t_r_i_n_g returns a NULL.
1166..11..11.. KKeeyySSyymm CCllaassssiiffiiccaattiioonn MMaaccrrooss
You may want to test if a KeySym is, for example, on the
keypad or on one of the function keys. You can use KeySym
macros to perform the following tests.
__
││
IsCursorKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a cursor key.
__
││
IsFunctionKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a function key.
__
││
IsKeypadKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a standard keypad
key.
557711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
IsPrivateKeypadKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a vendor-private
keypad key.
__
││
IsMiscFunctionKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a miscellaneous
function key.
__
││
IsModifierKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a modifier key.
__
││
IsPFKey(_k_e_y_s_y_m)
_k_e_y_s_y_m Specifies the KeySym that is to be tested.
││__
Returns _T_r_u_e if the specified KeySym is a PF key.
1166..22.. UUssiinngg LLaattiinn--11 KKeeyybbooaarrdd EEvveenntt FFuunnccttiioonnss
Chapter 13 describes internationalized text input facili-
ties, but sometimes it is expedient to write an application
that only deals with Latin-1 characters and ASCII controls,
so Xlib provides a simple function for that purpose.
_X_L_o_o_k_u_p_S_t_r_i_n_g handles the standard modifier semantics
described in section 12.7. This function does not use any
of the input method facilities described in chapter 13 and
does not depend on the current locale.
557722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To map a key event to an ISO Latin-1 string, use _X_L_o_o_k_u_p_-
_S_t_r_i_n_g.
__
││
int XLookupString(_e_v_e_n_t___s_t_r_u_c_t, _b_u_f_f_e_r___r_e_t_u_r_n, _b_y_t_e_s___b_u_f_f_e_r, _k_e_y_s_y_m___r_e_t_u_r_n, _s_t_a_t_u_s___i_n___o_u_t)
XKeyEvent *_e_v_e_n_t___s_t_r_u_c_t;
char *_b_u_f_f_e_r___r_e_t_u_r_n;
int _b_y_t_e_s___b_u_f_f_e_r;
KeySym *_k_e_y_s_y_m___r_e_t_u_r_n;
XComposeStatus *_s_t_a_t_u_s___i_n___o_u_t;
_e_v_e_n_t___s_t_r_u_c_t
Specifies the key event structure to be used. You
can pass _X_K_e_y_P_r_e_s_s_e_d_E_v_e_n_t or _X_K_e_y_R_e_l_e_a_s_e_d_E_v_e_n_t.
_b_u_f_f_e_r___r_e_t_u_r_n
Returns the translated characters.
_b_y_t_e_s___b_u_f_f_e_r
Specifies the length of the buffer. No more than
bytes_buffer of translation are returned.
_k_e_y_s_y_m___r_e_t_u_r_n
Returns the KeySym computed from the event if this
argument is not NULL.
_s_t_a_t_u_s___i_n___o_u_t
Specifies or returns the _X_C_o_m_p_o_s_e_S_t_a_t_u_s structure
or NULL.
││__
The _X_L_o_o_k_u_p_S_t_r_i_n_g function translates a key event to a
KeySym and a string. The KeySym is obtained by using the
standard interpretation of the _S_h_i_f_t, _L_o_c_k, group, and num-
lock modifiers as defined in the X Protocol specification.
If the KeySym has been rebound (see _X_R_e_b_i_n_d_K_e_y_s_y_m), the
bound string will be stored in the buffer. Otherwise, the
KeySym is mapped, if possible, to an ISO Latin-1 character
or (if the Control modifier is on) to an ASCII control char-
acter, and that character is stored in the buffer. _X_L_o_o_k_u_p_-
_S_t_r_i_n_g returns the number of characters that are stored in
the buffer.
If present (non-NULL), the _X_C_o_m_p_o_s_e_S_t_a_t_u_s structure records
the state, which is private to Xlib, that needs preservation
across calls to _X_L_o_o_k_u_p_S_t_r_i_n_g to implement compose process-
ing. The creation of _X_C_o_m_p_o_s_e_S_t_a_t_u_s structures is implemen-
tation-dependent; a portable program must pass NULL for this
argument.
_X_L_o_o_k_u_p_S_t_r_i_n_g depends on the cached keyboard information
mentioned in the previous section, so it is necessary to use
_X_R_e_f_r_e_s_h_K_e_y_b_o_a_r_d_M_a_p_p_i_n_g to keep this information up-to-date.
557733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To rebind the meaning of a KeySym for _X_L_o_o_k_u_p_S_t_r_i_n_g, use
_X_R_e_b_i_n_d_K_e_y_s_y_m.
__
││
XRebindKeysym(_d_i_s_p_l_a_y, _k_e_y_s_y_m, _l_i_s_t, _m_o_d___c_o_u_n_t, _s_t_r_i_n_g, _n_u_m___b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
KeySym _k_e_y_s_y_m;
KeySym _l_i_s_t[];
int _m_o_d___c_o_u_n_t;
unsigned char *_s_t_r_i_n_g;
int _n_u_m___b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_s_y_m Specifies the KeySym that is to be rebound.
_l_i_s_t Specifies the KeySyms to be used as modifiers.
_m_o_d___c_o_u_n_t Specifies the number of modifiers in the modifier
list.
_s_t_r_i_n_g Specifies the string that is copied and will be
returned by _X_L_o_o_k_u_p_S_t_r_i_n_g.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argu-
ment.
││__
The _X_R_e_b_i_n_d_K_e_y_s_y_m function can be used to rebind the meaning
of a KeySym for the client. It does not redefine any key in
the X server but merely provides an easy way for long
strings to be attached to keys. _X_L_o_o_k_u_p_S_t_r_i_n_g returns this
string when the appropriate set of modifier keys are pressed
and when the KeySym would have been used for the transla-
tion. No text conversions are performed; the client is
responsible for supplying appropriately encoded strings.
Note that you can rebind a KeySym that may not exist.
1166..33.. AAllllooccaattiinngg PPeerrmmaanneenntt SSttoorraaggee
To allocate some memory you will never give back, use
_X_p_e_r_m_a_l_l_o_c.
__
││
char *Xpermalloc(_s_i_z_e)
unsigned int _s_i_z_e;
││__
The _X_p_e_r_m_a_l_l_o_c function allocates storage that can never be
freed for the life of the program. The memory is allocated
with alignment for the C type double. This function may
provide some performance and space savings over the standard
557744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
operating system memory allocator.
1166..44.. PPaarrssiinngg tthhee WWiinnddooww GGeeoommeettrryy
To parse standard window geometry strings, use _X_P_a_r_s_e_G_e_o_m_e_-
_t_r_y.
__
││
int XParseGeometry(_p_a_r_s_e_s_t_r_i_n_g, _x___r_e_t_u_r_n, _y___r_e_t_u_r_n, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n)
char *_p_a_r_s_e_s_t_r_i_n_g;
int *_x___r_e_t_u_r_n, *_y___r_e_t_u_r_n;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
_p_a_r_s_e_s_t_r_i_n_g
Specifies the string you want to parse.
_x___r_e_t_u_r_n
_y___r_e_t_u_r_n Return the x and y offsets.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height determined.
││__
By convention, X applications use a standard string to indi-
cate window size and placement. _X_P_a_r_s_e_G_e_o_m_e_t_r_y makes it
easier to conform to this standard because it allows you to
parse the standard window geometry. Specifically, this
function lets you parse strings of the form:
[=][<_w_i_d_t_h>{xX}<_h_e_i_g_h_t>][{+-}<_x_o_f_f_s_e_t>{+-}<_y_o_f_f_s_e_t>]
The fields map into the arguments associated with this func-
tion. (Items enclosed in <> are integers, items in [] are
optional, and items enclosed in {} indicate ``choose one
of.'' Note that the brackets should not appear in the
actual string.) If the string is not in the Host Portable
Character Encoding, the result is implementation-dependent.
The _X_P_a_r_s_e_G_e_o_m_e_t_r_y function returns a bitmask that indicates
which of the four values (width, height, xoffset, and yoff-
set) 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 ``position the
window relative to the right or bottom edge.'' For each
value found, the corresponding argument is updated. For
each value not found, the argument is left unchanged. The
bits are represented by _X_V_a_l_u_e, _Y_V_a_l_u_e, _W_i_d_t_h_V_a_l_u_e, _H_e_i_g_h_t_-
_V_a_l_u_e, _X_N_e_g_a_t_i_v_e, or _Y_N_e_g_a_t_i_v_e and are defined in
<_X_1_1_/_X_u_t_i_l_._h>. They will be set whenever one of the values
557755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
is defined or one of the signs is set.
If the function returns either the _X_V_a_l_u_e or _Y_V_a_l_u_e flag,
you should place the window at the requested position.
To construct a window's geometry information, use _X_W_M_G_e_o_m_e_-
_t_r_y.
__
││
int XWMGeometry(_d_i_s_p_l_a_y, _s_c_r_e_e_n, _u_s_e_r___g_e_o_m, _d_e_f___g_e_o_m, _b_w_i_d_t_h, _h_i_n_t_s, _x___r_e_t_u_r_n, _y___r_e_t_u_r_n,
_w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n, _g_r_a_v_i_t_y___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n;
char *_u_s_e_r___g_e_o_m;
char *_d_e_f___g_e_o_m;
unsigned int _b_w_i_d_t_h;
XSizeHints *_h_i_n_t_s;
int *_x___r_e_t_u_r_n, *_y___r_e_t_u_r_n;
int *_w_i_d_t_h___r_e_t_u_r_n;
int *_h_e_i_g_h_t___r_e_t_u_r_n;
int *_g_r_a_v_i_t_y___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n Specifies the screen.
_u_s_e_r___g_e_o_m Specifies the user-specified geometry or NULL.
_d_e_f___g_e_o_m Specifies the application's default geometry or
NULL.
_b_w_i_d_t_h Specifies the border width.
_h_i_n_t_s Specifies the size hints for the window in its
normal state.
_x___r_e_t_u_r_n
_y___r_e_t_u_r_n Return the x and y offsets.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height determined.
_g_r_a_v_i_t_y___r_e_t_u_r_n
Returns the window gravity.
││__
The _X_W_M_G_e_o_m_e_t_r_y function combines any geometry information
(given in the format used by _X_P_a_r_s_e_G_e_o_m_e_t_r_y) 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 (_N_o_r_t_h_W_e_s_t_G_r_a_v_i_t_y,
557766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_N_o_r_t_h_E_a_s_t_G_r_a_v_i_t_y, _S_o_u_t_h_E_a_s_t_G_r_a_v_i_t_y, or _S_o_u_t_h_W_e_s_t_G_r_a_v_i_t_y)
that describe the window. If the base size is not set in
the _X_S_i_z_e_H_i_n_t_s 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, the base size is used.
A mask (in the form returned by _X_P_a_r_s_e_G_e_o_m_e_t_r_y) 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 coordi-
nates will have already been accounted for in the x_return
and y_return values.
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 as gravity_return to
update the hints directly.
1166..55.. MMaanniippuullaattiinngg RReeggiioonnss
Regions are arbitrary sets of pixel locations. Xlib pro-
vides functions for manipulating regions. The opaque type
_R_e_g_i_o_n is defined in <_X_1_1_/_X_u_t_i_l_._h>. Xlib provides functions
that you can use to manipulate regions. This section dis-
cusses how to:
· Create, copy, or destroy regions
· Move or shrink regions
· Compute with regions
· Determine if regions are empty or equal
· Locate a point or rectangle in a region
1166..55..11.. CCrreeaattiinngg,, CCooppyyiinngg,, oorr DDeessttrrooyyiinngg RReeggiioonnss
To create a new empty region, use _X_C_r_e_a_t_e_R_e_g_i_o_n.
__
││
Region XCreateRegion()
││__
To generate a region from a polygon, use _X_P_o_l_y_g_o_n_R_e_g_i_o_n.
557777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Region XPolygonRegion(_p_o_i_n_t_s, _n, _f_i_l_l___r_u_l_e)
XPoint _p_o_i_n_t_s_[_];
int _n;
int _f_i_l_l___r_u_l_e;
_p_o_i_n_t_s Specifies an array of points.
_n Specifies the number of points in the polygon.
_f_i_l_l___r_u_l_e Specifies the fill-rule you want to set for the
specified GC. You can pass _E_v_e_n_O_d_d_R_u_l_e or _W_i_n_d_i_n_-
_g_R_u_l_e.
││__
The _X_P_o_l_y_g_o_n_R_e_g_i_o_n function returns a region for the polygon
defined by the points array. For an explanation of
fill_rule, see _X_C_r_e_a_t_e_G_C.
To set the clip-mask of a GC to a region, use _X_S_e_t_R_e_g_i_o_n.
__
││
XSetRegion(_d_i_s_p_l_a_y, _g_c, _r)
Display *_d_i_s_p_l_a_y;
GC _g_c;
Region _r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_r Specifies the region.
││__
The _X_S_e_t_R_e_g_i_o_n function sets the clip-mask in the GC to the
specified region. The region is specified relative to the
drawable's origin. The resulting GC clip origin is imple-
mentation-dependent. Once it is set in the GC, the region
can be destroyed.
To deallocate the storage associated with a specified
region, use _X_D_e_s_t_r_o_y_R_e_g_i_o_n.
557788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDestroyRegion(_r)
Region _r;
_r Specifies the region.
││__
1166..55..22.. MMoovviinngg oorr SShhrriinnkkiinngg RReeggiioonnss
To move a region by a specified amount, use _X_O_f_f_s_e_t_R_e_g_i_o_n.
__
││
XOffsetRegion(_r, _d_x, _d_y)
Region _r;
int _d_x, _d_y;
_r Specifies the region.
_d_x
_d_y Specify the x and y coordinates, which define the
amount you want to move the specified region.
││__
To reduce a region by a specified amount, use _X_S_h_r_i_n_k_R_e_g_i_o_n.
__
││
XShrinkRegion(_r, _d_x, _d_y)
Region _r;
int _d_x, _d_y;
_r Specifies the region.
_d_x
_d_y Specify the x and y coordinates, which define the
amount you want to shrink the specified region.
││__
Positive values shrink the size of the region, and negative
values expand the region.
1166..55..33.. CCoommppuuttiinngg wwiitthh RReeggiioonnss
To generate the smallest rectangle enclosing a region, use
_X_C_l_i_p_B_o_x.
557799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XClipBox(_r, _r_e_c_t___r_e_t_u_r_n)
Region _r;
XRectangle *_r_e_c_t___r_e_t_u_r_n;
_r Specifies the region.
_r_e_c_t___r_e_t_u_r_n
Returns the smallest enclosing rectangle.
││__
The _X_C_l_i_p_B_o_x function returns the smallest rectangle enclos-
ing the specified region.
To compute the intersection of two regions, use _X_I_n_t_e_r_s_e_c_-
_t_R_e_g_i_o_n.
__
││
XIntersectRegion(_s_r_a, _s_r_b, _d_r___r_e_t_u_r_n)
Region _s_r_a, _s_r_b, _d_r___r_e_t_u_r_n;
_s_r_a
_s_r_b Specify the two regions with which you want to
perform the computation.
_d_r___r_e_t_u_r_n Returns the result of the computation.
││__
To compute the union of two regions, use _X_U_n_i_o_n_R_e_g_i_o_n.
__
││
XUnionRegion(_s_r_a, _s_r_b, _d_r___r_e_t_u_r_n)
Region _s_r_a, _s_r_b, _d_r___r_e_t_u_r_n;
_s_r_a
_s_r_b Specify the two regions with which you want to
perform the computation.
_d_r___r_e_t_u_r_n Returns the result of the computation.
││__
To create a union of a source region and a rectangle, use
_X_U_n_i_o_n_R_e_c_t_W_i_t_h_R_e_g_i_o_n.
558800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XUnionRectWithRegion(_r_e_c_t_a_n_g_l_e, _s_r_c___r_e_g_i_o_n, _d_e_s_t___r_e_g_i_o_n___r_e_t_u_r_n)
XRectangle *_r_e_c_t_a_n_g_l_e;
Region _s_r_c___r_e_g_i_o_n;
Region _d_e_s_t___r_e_g_i_o_n___r_e_t_u_r_n;
_r_e_c_t_a_n_g_l_e Specifies the rectangle.
_s_r_c___r_e_g_i_o_n
Specifies the source region to be used.
_d_e_s_t___r_e_g_i_o_n___r_e_t_u_r_n
Returns the destination region.
││__
The _X_U_n_i_o_n_R_e_c_t_W_i_t_h_R_e_g_i_o_n function updates the destination
region from a union of the specified rectangle and the spec-
ified source region.
To subtract two regions, use _X_S_u_b_t_r_a_c_t_R_e_g_i_o_n.
__
││
XSubtractRegion(_s_r_a, _s_r_b, _d_r___r_e_t_u_r_n)
Region _s_r_a, _s_r_b, _d_r___r_e_t_u_r_n;
_s_r_a
_s_r_b Specify the two regions with which you want to
perform the computation.
_d_r___r_e_t_u_r_n Returns the result of the computation.
││__
The _X_S_u_b_t_r_a_c_t_R_e_g_i_o_n function subtracts srb from sra and
stores the results in dr_return.
To calculate the difference between the union and intersec-
tion of two regions, use _X_X_o_r_R_e_g_i_o_n.
558811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XXorRegion(_s_r_a, _s_r_b, _d_r___r_e_t_u_r_n)
Region _s_r_a, _s_r_b, _d_r___r_e_t_u_r_n;
_s_r_a
_s_r_b Specify the two regions with which you want to
perform the computation.
_d_r___r_e_t_u_r_n Returns the result of the computation.
││__
1166..55..44.. DDeetteerrmmiinniinngg iiff RReeggiioonnss AArree EEmmppttyy oorr EEqquuaall
To determine if the specified region is empty, use _X_E_m_p_t_y_R_e_-
_g_i_o_n.
__
││
Bool XEmptyRegion(_r)
Region _r;
_r Specifies the region.
││__
The _X_E_m_p_t_y_R_e_g_i_o_n function returns _T_r_u_e if the region is
empty.
To determine if two regions have the same offset, size, and
shape, use _X_E_q_u_a_l_R_e_g_i_o_n.
__
││
Bool XEqualRegion(_r_1, _r_2)
Region _r_1, _r_2;
_r_1
_r_2 Specify the two regions.
││__
The _X_E_q_u_a_l_R_e_g_i_o_n function returns _T_r_u_e if the two regions
have the same offset, size, and shape.
1166..55..55.. LLooccaattiinngg aa PPooiinntt oorr aa RReeccttaannggllee iinn aa RReeggiioonn
To determine if a specified point resides in a specified
region, use _X_P_o_i_n_t_I_n_R_e_g_i_o_n.
558822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XPointInRegion(_r, _x, _y)
Region _r;
int _x, _y;
_r Specifies the region.
_x
_y Specify the x and y coordinates, which define the
point.
││__
The _X_P_o_i_n_t_I_n_R_e_g_i_o_n function returns _T_r_u_e if the point (x, y)
is contained in the region r.
To determine if a specified rectangle is inside a region,
use _X_R_e_c_t_I_n_R_e_g_i_o_n.
__
││
int XRectInRegion(_r, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t)
Region _r;
int _x, _y;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_r Specifies the region.
_x
_y Specify the x and y coordinates, which define the
coordinates of the upper-left corner of the rect-
angle.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which define the
rectangle.
││__
The _X_R_e_c_t_I_n_R_e_g_i_o_n function returns _R_e_c_t_a_n_g_l_e_I_n if the rect-
angle is entirely in the specified region, _R_e_c_t_a_n_g_l_e_O_u_t if
the rectangle is entirely out of the specified region, and
_R_e_c_t_a_n_g_l_e_P_a_r_t if the rectangle is partially in the specified
region.
1166..66.. UUssiinngg CCuutt BBuuffffeerrss
Xlib provides functions to manipulate cut buffers, a very
simple form of cut-and-paste inter-client communication.
Selections are a much more powerful and useful mechanism for
interchanging data between clients (see section 4.5) and
generally should be used instead of cut buffers.
558833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Cut buffers are implemented as properties on the first root
window of the display. The buffers can only contain text,
in the STRING encoding. The text encoding is not changed by
Xlib when fetching or storing. Eight buffers are provided
and can be accessed as a ring or as explicit buffers (num-
bered 0 through 7).
To store data in cut buffer 0, use _X_S_t_o_r_e_B_y_t_e_s.
__
││
XStoreBytes(_d_i_s_p_l_a_y, _b_y_t_e_s, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
char *_b_y_t_e_s;
int _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_b_y_t_e_s Specifies the bytes, which are not necessarily
ASCII or null-terminated.
_n_b_y_t_e_s Specifies the number of bytes to be stored.
││__
The data can have embedded null characters and need not be
null-terminated. The cut buffer's contents can be retrieved
later by any client calling _X_F_e_t_c_h_B_y_t_e_s.
_X_S_t_o_r_e_B_y_t_e_s can generate a _B_a_d_A_l_l_o_c error.
To store data in a specified cut buffer, use _X_S_t_o_r_e_B_u_f_f_e_r.
__
││
XStoreBuffer(_d_i_s_p_l_a_y, _b_y_t_e_s, _n_b_y_t_e_s, _b_u_f_f_e_r)
Display *_d_i_s_p_l_a_y;
char *_b_y_t_e_s;
int _n_b_y_t_e_s;
int _b_u_f_f_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_b_y_t_e_s Specifies the bytes, which are not necessarily
ASCII or null-terminated.
_n_b_y_t_e_s Specifies the number of bytes to be stored.
_b_u_f_f_e_r Specifies the buffer in which you want to store
the bytes.
││__
If an invalid buffer is specified, the call has no effect.
558844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The data can have embedded null characters and need not be
null-terminated.
_X_S_t_o_r_e_B_u_f_f_e_r can generate a _B_a_d_A_l_l_o_c error.
To return data from cut buffer 0, use _X_F_e_t_c_h_B_y_t_e_s.
__
││
char *XFetchBytes(_d_i_s_p_l_a_y, _n_b_y_t_e_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_n_b_y_t_e_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_b_y_t_e_s___r_e_t_u_r_n
Returns the number of bytes in the buffer.
││__
The _X_F_e_t_c_h_B_y_t_e_s function returns the number of bytes in the
nbytes_return argument, if the buffer contains data. Other-
wise, the function returns NULL and sets nbytes to 0. The
appropriate amount of storage is allocated and the pointer
returned. The client must free this storage when finished
with it by calling _X_F_r_e_e.
To return data from a specified cut buffer, use _X_F_e_t_c_h_-
_B_u_f_f_e_r.
__
││
char *XFetchBuffer(_d_i_s_p_l_a_y, _n_b_y_t_e_s___r_e_t_u_r_n, _b_u_f_f_e_r)
Display *_d_i_s_p_l_a_y;
int *_n_b_y_t_e_s___r_e_t_u_r_n;
int _b_u_f_f_e_r;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_b_y_t_e_s___r_e_t_u_r_n
Returns the number of bytes in the buffer.
_b_u_f_f_e_r Specifies the buffer from which you want the
stored data returned.
││__
The _X_F_e_t_c_h_B_u_f_f_e_r function returns zero to the nbytes_return
argument if there is no data in the buffer or if an invalid
buffer is specified.
To rotate the cut buffers, use _X_R_o_t_a_t_e_B_u_f_f_e_r_s.
558855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XRotateBuffers(_d_i_s_p_l_a_y, _r_o_t_a_t_e)
Display *_d_i_s_p_l_a_y;
int _r_o_t_a_t_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_o_t_a_t_e Specifies how much to rotate the cut buffers.
││__
The _X_R_o_t_a_t_e_B_u_f_f_e_r_s function rotates the cut buffers, such
that buffer 0 becomes buffer n, buffer 1 becomes n + 1 mod
8, and so on. This cut buffer numbering is global to the
display. Note that _X_R_o_t_a_t_e_B_u_f_f_e_r_s generates _B_a_d_M_a_t_c_h errors
if any of the eight buffers have not been created.
1166..77.. DDeetteerrmmiinniinngg tthhee AApppprroopprriiaattee VViissuuaall TTyyppee
A single display can support multiple screens. Each screen
can have several different visual types supported at differ-
ent depths. You can use the functions described in this
section to determine which visual to use for your applica-
tion.
The functions in this section use the visual information
masks and the _X_V_i_s_u_a_l_I_n_f_o structure, which is defined in
<_X_1_1_/_X_u_t_i_l_._h> and contains:
558866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
/* Visual information mask bits */
#define _V_i_s_u_a_l_N_o_M_a_s_k 0x0
#define _V_i_s_u_a_l_I_D_M_a_s_k 0x1
#define _V_i_s_u_a_l_S_c_r_e_e_n_M_a_s_k 0x2
#define _V_i_s_u_a_l_D_e_p_t_h_M_a_s_k 0x4
#define _V_i_s_u_a_l_C_l_a_s_s_M_a_s_k 0x8
#define _V_i_s_u_a_l_R_e_d_M_a_s_k_M_a_s_k 0x10
#define _V_i_s_u_a_l_G_r_e_e_n_M_a_s_k_M_a_s_k 0x20
#define _V_i_s_u_a_l_B_l_u_e_M_a_s_k_M_a_s_k 0x40
#define _V_i_s_u_a_l_C_o_l_o_r_m_a_p_S_i_z_e_M_a_s_k 0x80
#define _V_i_s_u_a_l_B_i_t_s_P_e_r_R_G_B_M_a_s_k 0x100
#define _V_i_s_u_a_l_A_l_l_M_a_s_k 0x1FF
/* Values */
typedef struct {
Visual *visual;
VisualID visualid;
int screen;
unsigned int depth;
int class;
unsigned long red_mask;
unsigned long green_mask;
unsigned long blue_mask;
int colormap_size;
int bits_per_rgb;
} XVisualInfo;
││__
To obtain a list of visual information structures that match
a specified template, use _X_G_e_t_V_i_s_u_a_l_I_n_f_o.
558877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XVisualInfo *XGetVisualInfo(_d_i_s_p_l_a_y, _v_i_n_f_o___m_a_s_k, _v_i_n_f_o___t_e_m_p_l_a_t_e, _n_i_t_e_m_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
long _v_i_n_f_o___m_a_s_k;
XVisualInfo *_v_i_n_f_o___t_e_m_p_l_a_t_e;
int *_n_i_t_e_m_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_v_i_n_f_o___m_a_s_k
Specifies the visual mask value.
_v_i_n_f_o___t_e_m_p_l_a_t_e
Specifies the visual attributes that are to be
used in matching the visual structures.
_n_i_t_e_m_s___r_e_t_u_r_n
Returns the number of matching visual structures.
││__
The _X_G_e_t_V_i_s_u_a_l_I_n_f_o function returns a list of visual struc-
tures that have attributes equal to the attributes specified
by vinfo_template. If no visual structures match the tem-
plate using the specified vinfo_mask, _X_G_e_t_V_i_s_u_a_l_I_n_f_o returns
a NULL. To free the data returned by this function, use
_X_F_r_e_e.
To obtain the visual information that matches the specified
depth and class of the screen, use _X_M_a_t_c_h_V_i_s_u_a_l_I_n_f_o.
__
││
Status XMatchVisualInfo(_d_i_s_p_l_a_y, _s_c_r_e_e_n, _d_e_p_t_h, _c_l_a_s_s, _v_i_n_f_o___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n;
int _d_e_p_t_h;
int _c_l_a_s_s;
XVisualInfo *_v_i_n_f_o___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n Specifies the screen.
_d_e_p_t_h Specifies the depth of the screen.
_c_l_a_s_s Specifies the class of the screen.
_v_i_n_f_o___r_e_t_u_r_n
Returns the matched visual information.
││__
The _X_M_a_t_c_h_V_i_s_u_a_l_I_n_f_o function returns the visual information
558888
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
for a visual that matches the specified depth and class for
a screen. Because multiple visuals that match the specified
depth and class can exist, the exact visual chosen is unde-
fined. If a visual is found, _X_M_a_t_c_h_V_i_s_u_a_l_I_n_f_o returns
nonzero and the information on the visual to vinfo_return.
Otherwise, when a visual is not found, _X_M_a_t_c_h_V_i_s_u_a_l_I_n_f_o
returns zero.
1166..88.. MMaanniippuullaattiinngg IImmaaggeess
Xlib provides several functions that perform basic opera-
tions on images. All operations on images are defined using
an _X_I_m_a_g_e structure, as defined in <_X_1_1_/_X_l_i_b_._h>. Because
the number of different types of image formats can be very
large, this hides details of image storage properly from
applications.
This section describes the functions for generic operations
on images. Manufacturers can provide very fast implementa-
tions of these for the formats frequently encountered on
their hardware. These functions are neither sufficient nor
desirable to use for general image processing. Rather, they
are here to provide minimal functions on screen format
images. The basic operations for getting and putting images
are _X_G_e_t_I_m_a_g_e and _X_P_u_t_I_m_a_g_e.
Note that no functions have been defined, as yet, to read
and write images to and from disk files.
The _X_I_m_a_g_e structure describes an image as it exists in the
client's memory. The user can request that some of the mem-
bers such as height, width, and xoffset be changed when the
image is sent to the server. Note that bytes_per_line in
concert with offset can be used to extract a subset of the
image. Other members (for example, byte order, bitmap_unit,
and so forth) are characteristics of both the image and the
server. If these members differ between the image and the
server, _X_P_u_t_I_m_a_g_e makes the appropriate conversions. The
first byte of the first line of plane n must be located at
the address (data + (n * height * bytes_per_line)). For a
description of the _X_I_m_a_g_e structure, see section 8.7.
To allocate an _X_I_m_a_g_e structure and initialize it with image
format values from a display, use _X_C_r_e_a_t_e_I_m_a_g_e.
558899
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XImage *XCreateImage(_d_i_s_p_l_a_y, _v_i_s_u_a_l, _d_e_p_t_h, _f_o_r_m_a_t, _o_f_f_s_e_t, _d_a_t_a, _w_i_d_t_h, _h_e_i_g_h_t, _b_i_t_m_a_p___p_a_d,
_b_y_t_e_s___p_e_r___l_i_n_e)
Display *_d_i_s_p_l_a_y;
Visual *_v_i_s_u_a_l;
unsigned int _d_e_p_t_h;
int _f_o_r_m_a_t;
int _o_f_f_s_e_t;
char *_d_a_t_a;
unsigned int _w_i_d_t_h;
unsigned int _h_e_i_g_h_t;
int _b_i_t_m_a_p___p_a_d;
int _b_y_t_e_s___p_e_r___l_i_n_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_v_i_s_u_a_l Specifies the _V_i_s_u_a_l structure.
_d_e_p_t_h Specifies the depth of the image.
_f_o_r_m_a_t Specifies the format for the image. You can pass
_X_Y_B_i_t_m_a_p, _X_Y_P_i_x_m_a_p, or _Z_P_i_x_m_a_p.
_o_f_f_s_e_t Specifies the number of pixels to ignore at the
beginning of the scanline.
_d_a_t_a Specifies the image data.
_w_i_d_t_h Specifies the width of the image, in pixels.
_h_e_i_g_h_t Specifies the height of the image, in pixels.
_b_i_t_m_a_p___p_a_d
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.
_b_y_t_e_s___p_e_r___l_i_n_e
Specifies the number of bytes in the client image
between the start of one scanline and the start of
the next.
││__
The _X_C_r_e_a_t_e_I_m_a_g_e function allocates the memory needed for an
_X_I_m_a_g_e 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 _X_I_m_a_g_e struc-
ture. The red, green, and blue mask values are defined for
Z format images only and are derived from the _V_i_s_u_a_l struc-
ture passed in. Other values also are passed in. The
559900
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
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 in memory and calculates the value
of bytes_per_line itself.
Note that when the image is created using _X_C_r_e_a_t_e_I_m_a_g_e, _X_G_e_-
_t_I_m_a_g_e, or _X_S_u_b_I_m_a_g_e, the destroy procedure that the _X_D_e_-
_s_t_r_o_y_I_m_a_g_e function calls frees both the image structure and
the data pointed to by the image structure.
The basic functions used to get a pixel, set a pixel, create
a subimage, and add a constant value to an image are defined
in the image object. The functions in this section are
really macro invocations of the functions in the image
object and are defined in <_X_1_1_/_X_u_t_i_l_._h>.
To obtain a pixel value in an image, use _X_G_e_t_P_i_x_e_l.
__
││
unsigned long XGetPixel(_x_i_m_a_g_e, _x, _y)
XImage *_x_i_m_a_g_e;
int _x;
int _y;
_x_i_m_a_g_e Specifies the image.
_x
_y Specify the x and y coordinates.
││__
The _X_G_e_t_P_i_x_e_l function returns the specified pixel from the
named image. The pixel value is returned in normalized for-
mat (that is, the least significant byte of the long is the
least significant byte of the pixel). The image must con-
tain the x and y coordinates.
To set a pixel value in an image, use _X_P_u_t_P_i_x_e_l.
559911
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XPutPixel(_x_i_m_a_g_e, _x, _y, _p_i_x_e_l)
XImage *_x_i_m_a_g_e;
int _x;
int _y;
unsigned long _p_i_x_e_l;
_x_i_m_a_g_e Specifies the image.
_x
_y Specify the x and y coordinates.
_p_i_x_e_l Specifies the new pixel value.
││__
The _X_P_u_t_P_i_x_e_l function overwrites the pixel in the named
image with the specified pixel value. The input pixel value
must be in normalized format (that is, the least significant
byte of the long is the least significant byte of the
pixel). The image must contain the x and y coordinates.
To create a subimage, use _X_S_u_b_I_m_a_g_e.
__
││
XImage *XSubImage(_x_i_m_a_g_e, _x, _y, _s_u_b_i_m_a_g_e___w_i_d_t_h, _s_u_b_i_m_a_g_e___h_e_i_g_h_t)
XImage *_x_i_m_a_g_e;
int _x;
int _y;
unsigned int _s_u_b_i_m_a_g_e___w_i_d_t_h;
unsigned int _s_u_b_i_m_a_g_e___h_e_i_g_h_t;
_x_i_m_a_g_e Specifies the image.
_x
_y Specify the x and y coordinates.
_s_u_b_i_m_a_g_e___w_i_d_t_h
Specifies the width of the new subimage, in pix-
els.
_s_u_b_i_m_a_g_e___h_e_i_g_h_t
Specifies the height of the new subimage, in pix-
els.
││__
The _X_S_u_b_I_m_a_g_e function creates a new image that is a subsec-
tion of an existing one. It allocates the memory necessary
for the new _X_I_m_a_g_e structure and returns a pointer to the
new image. The data is copied from the source image, and
the image must contain the rectangle defined by x, y, subim-
age_width, and subimage_height.
559922
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
To increment each pixel in an image by a constant value, use
_X_A_d_d_P_i_x_e_l.
__
││
XAddPixel(_x_i_m_a_g_e, _v_a_l_u_e)
XImage *_x_i_m_a_g_e;
long _v_a_l_u_e;
_x_i_m_a_g_e Specifies the image.
_v_a_l_u_e Specifies the constant value that is to be added.
││__
The _X_A_d_d_P_i_x_e_l function adds a constant value to every pixel
in an image. It is useful when you have a base pixel value
from allocating color resources and need to manipulate the
image to that form.
To deallocate the memory allocated in a previous call to
_X_C_r_e_a_t_e_I_m_a_g_e, use _X_D_e_s_t_r_o_y_I_m_a_g_e.
__
││
XDestroyImage(_x_i_m_a_g_e)
XImage *_x_i_m_a_g_e;
_x_i_m_a_g_e Specifies the image.
││__
The _X_D_e_s_t_r_o_y_I_m_a_g_e function deallocates the memory associated
with the _X_I_m_a_g_e structure.
Note that when the image is created using _X_C_r_e_a_t_e_I_m_a_g_e, _X_G_e_-
_t_I_m_a_g_e, or _X_S_u_b_I_m_a_g_e, the destroy procedure that this macro
calls frees both the image structure and the data pointed to
by the image structure.
1166..99.. MMaanniippuullaattiinngg BBiittmmaappss
Xlib provides functions that you can use to read a bitmap
from a file, save a bitmap to a file, or create a bitmap.
This section describes those functions that transfer bitmaps
to and from the client's file system, thus allowing their
reuse in a later connection (for example, from an entirely
different client or to a different display or server).
The X version 11 bitmap file format is:
559933
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
#define _n_a_m_e_width _w_i_d_t_h
#define _n_a_m_e_height _h_e_i_g_h_t
#define _n_a_m_e_x_hot _x
#define _n_a_m_e_y_hot _y
static unsigned char _n_a_m_e_bits[] = { 0x_N_N,... }
││__
The lines for the variables ending with _x_hot and _y_hot
suffixes are optional because they are present only if a
hotspot has been defined for this bitmap. The lines for the
other variables are required. The word ``unsigned'' is
optional; that is, the type of the _bits array can be
``char'' or ``unsigned char''. The _bits array must be
large enough to contain the size bitmap. The bitmap unit is
8.
To read a bitmap from a file and store it in a pixmap, use
_X_R_e_a_d_B_i_t_m_a_p_F_i_l_e.
__
││
int XReadBitmapFile(_d_i_s_p_l_a_y, _d, _f_i_l_e_n_a_m_e, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n, _b_i_t_m_a_p___r_e_t_u_r_n, _x___h_o_t___r_e_t_u_r_n,
_y___h_o_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Drawable _d;
char *_f_i_l_e_n_a_m_e;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
Pixmap *_b_i_t_m_a_p___r_e_t_u_r_n;
int *_x___h_o_t___r_e_t_u_r_n, *_y___h_o_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable that indicates the screen.
_f_i_l_e_n_a_m_e Specifies the file name to use. The format of the
file name is operating-system dependent.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height values of the read in
bitmap file.
_b_i_t_m_a_p___r_e_t_u_r_n
Returns the bitmap that is created.
_x___h_o_t___r_e_t_u_r_n
_y___h_o_t___r_e_t_u_r_n
Return the hotspot coordinates.
││__
The _X_R_e_a_d_B_i_t_m_a_p_F_i_l_e function reads in a file containing a
559944
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
bitmap. The file is parsed in the encoding of the current
locale. The ability to read other than the standard format
is implementation-dependent. If the file cannot be opened,
_X_R_e_a_d_B_i_t_m_a_p_F_i_l_e returns _B_i_t_m_a_p_O_p_e_n_F_a_i_l_e_d. If the file can
be opened but does not contain valid bitmap data, it returns
_B_i_t_m_a_p_F_i_l_e_I_n_v_a_l_i_d. If insufficient working storage is allo-
cated, it returns _B_i_t_m_a_p_N_o_M_e_m_o_r_y. If the file is readable
and valid, it returns _B_i_t_m_a_p_S_u_c_c_e_s_s.
_X_R_e_a_d_B_i_t_m_a_p_F_i_l_e returns the bitmap's height and width, as
read from the file, to width_return and height_return. It
then creates a pixmap of the appropriate size, reads the
bitmap data from the file into the pixmap, and assigns the
pixmap to the caller's variable bitmap. The caller must
free the bitmap using _X_F_r_e_e_P_i_x_m_a_p when finished. If
_n_a_m_e_x_hot and _n_a_m_e_y_hot exist, _X_R_e_a_d_B_i_t_m_a_p_F_i_l_e returns
them to x_hot_return and y_hot_return; otherwise, it returns
-1,-1.
_X_R_e_a_d_B_i_t_m_a_p_F_i_l_e can generate _B_a_d_A_l_l_o_c, _B_a_d_D_r_a_w_a_b_l_e, and
_B_a_d_G_C errors.
To read a bitmap from a file and return it as data, use
_X_R_e_a_d_B_i_t_m_a_p_F_i_l_e_D_a_t_a.
__
││
int XReadBitmapFileData(_f_i_l_e_n_a_m_e, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n, _d_a_t_a___r_e_t_u_r_n, _x___h_o_t___r_e_t_u_r_n, _y___h_o_t___r_e_t_u_r_n)
char *_f_i_l_e_n_a_m_e;
unsigned int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
unsigned char *_d_a_t_a___r_e_t_u_r_n;
int *_x___h_o_t___r_e_t_u_r_n, *_y___h_o_t___r_e_t_u_r_n;
_f_i_l_e_n_a_m_e Specifies the file name to use. The format of the
file name is operating-system dependent.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height values of the read in
bitmap file.
_d_a_t_a___r_e_t_u_r_n
Returns the bitmap data.
_x___h_o_t___r_e_t_u_r_n
_y___h_o_t___r_e_t_u_r_n
Return the hotspot coordinates.
││__
The _X_R_e_a_d_B_i_t_m_a_p_F_i_l_e_D_a_t_a function reads in a file containing
a bitmap, in the same manner as _X_R_e_a_d_B_i_t_m_a_p_F_i_l_e, but returns
the data directly rather than creating a pixmap in the
server. The bitmap data is returned in data_return; the
559955
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
client must free this storage when finished with it by call-
ing _X_F_r_e_e. The status and other return values are the same
as for _X_R_e_a_d_B_i_t_m_a_p_F_i_l_e.
To write out a bitmap from a pixmap to a file, use
_X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e.
__
││
int XWriteBitmapFile(_d_i_s_p_l_a_y, _f_i_l_e_n_a_m_e, _b_i_t_m_a_p, _w_i_d_t_h, _h_e_i_g_h_t, _x___h_o_t, _y___h_o_t)
Display *_d_i_s_p_l_a_y;
char *_f_i_l_e_n_a_m_e;
Pixmap _b_i_t_m_a_p;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
int _x___h_o_t, _y___h_o_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_f_i_l_e_n_a_m_e Specifies the file name to use. The format of the
file name is operating-system dependent.
_b_i_t_m_a_p Specifies the bitmap.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height.
_x___h_o_t
_y___h_o_t Specify where to place the hotspot coordinates (or
-1,-1 if none are present) in the file.
││__
The _X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e function writes a bitmap out to a file
in the X Version 11 format. The name used in the output
file is derived from the file name by deleting the directory
prefix. The file is written in the encoding of the current
locale. If the file cannot be opened for writing, it
returns _B_i_t_m_a_p_O_p_e_n_F_a_i_l_e_d. If insufficient memory is allo-
cated, _X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e returns _B_i_t_m_a_p_N_o_M_e_m_o_r_y; otherwise,
on no error, it returns _B_i_t_m_a_p_S_u_c_c_e_s_s. If x_hot and y_hot
are not -1, -1, _X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e writes them out as the
hotspot coordinates for the bitmap.
_X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e can generate _B_a_d_D_r_a_w_a_b_l_e and _B_a_d_M_a_t_c_h
errors.
To create a pixmap and then store bitmap-format data into
it, use _X_C_r_e_a_t_e_P_i_x_m_a_p_F_r_o_m_B_i_t_m_a_p_D_a_t_a.
559966
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Pixmap XCreatePixmapFromBitmapData(_d_i_s_p_l_a_y, _d, _d_a_t_a, _w_i_d_t_h, _h_e_i_g_h_t, _f_g, _b_g, _d_e_p_t_h)
Display *_d_i_s_p_l_a_y;
Drawable _d;
char *_d_a_t_a;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
unsigned long _f_g, _b_g;
unsigned int _d_e_p_t_h;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable that indicates the screen.
_d_a_t_a Specifies the data in bitmap format.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height.
_f_g
_b_g Specify the foreground and background pixel values
to use.
_d_e_p_t_h Specifies the depth of the pixmap.
││__
The _X_C_r_e_a_t_e_P_i_x_m_a_p_F_r_o_m_B_i_t_m_a_p_D_a_t_a function creates a pixmap of
the given depth and then does a bitmap-format _X_P_u_t_I_m_a_g_e of
the data into it. The depth must be supported by the screen
of the specified drawable, or a _B_a_d_M_a_t_c_h error results.
_X_C_r_e_a_t_e_P_i_x_m_a_p_F_r_o_m_B_i_t_m_a_p_D_a_t_a can generate _B_a_d_A_l_l_o_c, _B_a_d_D_r_a_w_-
_a_b_l_e, _B_a_d_G_C, and _B_a_d_V_a_l_u_e errors.
To include a bitmap written out by _X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e in a
program directly, as opposed to reading it in every time at
run time, use _X_C_r_e_a_t_e_B_i_t_m_a_p_F_r_o_m_D_a_t_a.
559977
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Pixmap XCreateBitmapFromData(_d_i_s_p_l_a_y, _d, _d_a_t_a, _w_i_d_t_h, _h_e_i_g_h_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
char *_d_a_t_a;
unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable that indicates the screen.
_d_a_t_a Specifies the location of the bitmap data.
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height.
││__
The _X_C_r_e_a_t_e_B_i_t_m_a_p_F_r_o_m_D_a_t_a function allows you to include in
your C program (using _#_i_n_c_l_u_d_e) a bitmap file that was writ-
ten out by _X_W_r_i_t_e_B_i_t_m_a_p_F_i_l_e (X version 11 format only) with-
out reading in the bitmap file. The following example cre-
ates a gray bitmap:
#include "gray.bitmap"
Pixmap bitmap;
bitmap = XCreateBitmapFromData(display, window, gray_bits, gray_width, gray_height);
If insufficient working storage was allocated, _X_C_r_e_-
_a_t_e_B_i_t_m_a_p_F_r_o_m_D_a_t_a returns _N_o_n_e. It is your responsibility
to free the bitmap using _X_F_r_e_e_P_i_x_m_a_p when finished.
_X_C_r_e_a_t_e_B_i_t_m_a_p_F_r_o_m_D_a_t_a can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C
errors.
1166..1100.. UUssiinngg tthhee CCoonntteexxtt MMaannaaggeerr
The context manager provides a way of associating data with
an X resource ID (mostly typically a window) in your pro-
gram. Note that this is local to your program; the data is
not stored in the server on a property list. Any amount of
data in any number of pieces can be associated with a
resource ID, and each piece of data has a type associated
with it. The context manager requires knowledge of the
resource ID and type to store or retrieve data.
Essentially, the context manager can be viewed as a two-
dimensional, sparse array: one dimension is subscripted by
the X resource ID and the other by a context type field.
Each entry in the array contains a pointer to the data.
Xlib provides context management functions with which you
can save data values, get data values, delete entries, and
559988
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
create a unique context type. The symbols used are in
<_X_1_1_/_X_u_t_i_l_._h>.
To save a data value that corresponds to a resource ID and
context type, use _X_S_a_v_e_C_o_n_t_e_x_t.
__
││
int XSaveContext(_d_i_s_p_l_a_y, _r_i_d, _c_o_n_t_e_x_t, _d_a_t_a)
Display *_d_i_s_p_l_a_y;
XID _r_i_d;
XContext _c_o_n_t_e_x_t;
XPointer _d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_i_d Specifies the resource ID with which the data is
associated.
_c_o_n_t_e_x_t Specifies the context type to which the data
belongs.
_d_a_t_a Specifies the data to be associated with the win-
dow and type.
││__
If an entry with the specified resource ID and type already
exists, _X_S_a_v_e_C_o_n_t_e_x_t overrides it with the specified con-
text. The _X_S_a_v_e_C_o_n_t_e_x_t function returns a nonzero error
code if an error has occurred and zero otherwise. Possible
errors are _X_C_N_O_M_E_M (out of memory).
To get the data associated with a resource ID and type, use
_X_F_i_n_d_C_o_n_t_e_x_t.
559999
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XFindContext(_d_i_s_p_l_a_y, _r_i_d, _c_o_n_t_e_x_t, _d_a_t_a___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
XID _r_i_d;
XContext _c_o_n_t_e_x_t;
XPointer *_d_a_t_a___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_i_d Specifies the resource ID with which the data is
associated.
_c_o_n_t_e_x_t Specifies the context type to which the data
belongs.
_d_a_t_a___r_e_t_u_r_n
Returns the data.
││__
Because it is a return value, the data is a pointer. The
_X_F_i_n_d_C_o_n_t_e_x_t function returns a nonzero error code if an
error has occurred and zero otherwise. Possible errors are
_X_C_N_O_E_N_T (context-not-found).
To delete an entry for a given resource ID and type, use
_X_D_e_l_e_t_e_C_o_n_t_e_x_t.
__
││
int XDeleteContext(_d_i_s_p_l_a_y, _r_i_d, _c_o_n_t_e_x_t)
Display *_d_i_s_p_l_a_y;
XID _r_i_d;
XContext _c_o_n_t_e_x_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_i_d Specifies the resource ID with which the data is
associated.
_c_o_n_t_e_x_t Specifies the context type to which the data
belongs.
││__
The _X_D_e_l_e_t_e_C_o_n_t_e_x_t function deletes the entry for the given
resource ID and type from the data structure. This function
returns the same error codes that _X_F_i_n_d_C_o_n_t_e_x_t returns if
called with the same arguments. _X_D_e_l_e_t_e_C_o_n_t_e_x_t does not
free the data whose address was saved.
To create a unique context type that may be used in subse-
quent calls to _X_S_a_v_e_C_o_n_t_e_x_t and _X_F_i_n_d_C_o_n_t_e_x_t, use
660000
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_U_n_i_q_u_e_C_o_n_t_e_x_t.
__
││
XContext XUniqueContext()
││__
660011
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
AAppppeennddiixx AA
XXlliibb FFuunnccttiioonnss aanndd PPrroottooccooll RReeqquueessttss
This appendix provides two tables that relate to Xlib func-
tions and the X protocol. The following table lists each
Xlib function (in alphabetical order) and the corresponding
protocol request that it generates.
-------------------------------------------------------
XXlliibb FFuunnccttiioonn PPrroottooccooll RReeqquueesstt
-------------------------------------------------------
XActivateScreenSaver ForceScreenSaver
XAddHost ChangeHosts
XAddHosts ChangeHosts
XAddToSaveSet ChangeSaveSet
XAllocColor AllocColor
XAllocColorCells AllocColorCells
XAllocColorPlanes AllocColorPlanes
XAllocNamedColor AllocNamedColor
XAllowEvents AllowEvents
XAutoRepeatOff ChangeKeyboardControl
XAutoRepeatOn ChangeKeyboardControl
XBell Bell
XChangeActivePointerGrab ChangeActivePointerGrab
XChangeGC ChangeGC
XChangeKeyboardControl ChangeKeyboardControl
XChangeKeyboardMapping ChangeKeyboardMapping
XChangePointerControl ChangePointerControl
XChangeProperty ChangeProperty
XChangeSaveSet ChangeSaveSet
XChangeWindowAttributes ChangeWindowAttributes
XCirculateSubwindows CirculateWindow
XCirculateSubwindowsDown CirculateWindow
XCirculateSubwindowsUp CirculateWindow
XClearArea ClearArea
XClearWindow ClearArea
XConfigureWindow ConfigureWindow
XConvertSelection ConvertSelection
XCopyArea CopyArea
XCopyColormapAndFree CopyColormapAndFree
XCopyGC CopyGC
XCopyPlane CopyPlane
XCreateBitmapFromData CreateGC
CreatePixmap
FreeGC
PutImage
XCreateColormap CreateColormap
660022
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
XXlliibb FFuunnccttiioonn PPrroottooccooll RReeqquueesstt
-------------------------------------------------------
XCreateFontCursor CreateGlyphCursor
XCreateGC CreateGC
XCreateGlyphCursor CreateGlyphCursor
XCreatePixmap CreatePixmap
XCreatePixmapCursor CreateCursor
XCreatePixmapFromData CreateGC
CreatePixmap
FreeGC
PutImage
XCreateSimpleWindow CreateWindow
XCreateWindow CreateWindow
XDefineCursor ChangeWindowAttributes
XDeleteProperty DeleteProperty
XDestroySubwindows DestroySubwindows
XDestroyWindow DestroyWindow
XDisableAccessControl SetAccessControl
XDrawArc PolyArc
XDrawArcs PolyArc
XDrawImageString ImageText8
XDrawImageString16 ImageText16
XDrawLine PolySegment
XDrawLines PolyLine
XDrawPoint PolyPoint
XDrawPoints PolyPoint
XDrawRectangle PolyRectangle
XDrawRectangles PolyRectangle
XDrawSegments PolySegment
XDrawString PolyText8
XDrawString16 PolyText16
XDrawText PolyText8
XDrawText16 PolyText16
XEnableAccessControl SetAccessControl
XFetchBytes GetProperty
XFetchName GetProperty
XFillArc PolyFillArc
XFillArcs PolyFillArc
XFillPolygon FillPoly
XFillRectangle PolyFillRectangle
XFillRectangles PolyFillRectangle
XForceScreenSaver ForceScreenSaver
XFreeColormap FreeColormap
XFreeColors FreeColors
XFreeCursor FreeCursor
XFreeFont CloseFont
XFreeGC FreeGC
XFreePixmap FreePixmap
XGetAtomName GetAtomName
XGetClassHint GetProperty
XGetFontPath GetFontPath
XGetGeometry GetGeometry
660033
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
XXlliibb FFuunnccttiioonn PPrroottooccooll RReeqquueesstt
-------------------------------------------------------
XGetIconName GetProperty
XGetIconSizes GetProperty
XGetImage GetImage
XGetInputFocus GetInputFocus
XGetKeyboardControl GetKeyboardControl
XGetKeyboardMapping GetKeyboardMapping
XGetModifierMapping GetModifierMapping
XGetMotionEvents GetMotionEvents
XGetNormalHints GetProperty
XGetPointerControl GetPointerControl
XGetPointerMapping GetPointerMapping
XGetRGBColormaps GetProperty
XGetScreenSaver GetScreenSaver
XGetSelectionOwner GetSelectionOwner
XGetSizeHints GetProperty
XGetTextProperty GetProperty
XGetTransientForHint GetProperty
XGetWMClientMachine GetProperty
XGetWMColormapWindows GetProperty
InternAtom
XGetWMHints GetProperty
XGetWMIconName GetProperty
XGetWMName GetProperty
XGetWMNormalHints GetProperty
XGetWMProtocols GetProperty
InternAtom
XGetWMSizeHints GetProperty
XGetWindowAttributes GetWindowAttributes
GetGeometry
XGetWindowProperty GetProperty
XGetZoomHints GetProperty
XGrabButton GrabButton
XGrabKey GrabKey
XGrabKeyboard GrabKeyboard
XGrabPointer GrabPointer
XGrabServer GrabServer
XIconifyWindow InternAtom
SendEvent
XInitExtension QueryExtension
XInstallColormap InstallColormap
XInternAtom InternAtom
XKillClient KillClient
XListExtensions ListExtensions
XListFonts ListFonts
XListFontsWithInfo ListFontsWithInfo
XListHosts ListHosts
XListInstalledColormaps ListInstalledColormaps
XListProperties ListProperties
XLoadFont OpenFont
XLoadQueryFont OpenFont
660044
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
XXlliibb FFuunnccttiioonn PPrroottooccooll RReeqquueesstt
-------------------------------------------------------
QueryFont
XLookupColor LookupColor
XLowerWindow ConfigureWindow
XMapRaised ConfigureWindow
MapWindow
XMapSubwindows MapSubwindows
XMapWindow MapWindow
XMoveResizeWindow ConfigureWindow
XMoveWindow ConfigureWindow
XNoOp NoOperation
XOpenDisplay CreateGC
XParseColor LookupColor
XPutImage PutImage
XQueryBestCursor QueryBestSize
XQueryBestSize QueryBestSize
XQueryBestStipple QueryBestSize
XQueryBestTile QueryBestSize
XQueryColor QueryColors
XQueryColors QueryColors
XQueryExtension QueryExtension
XQueryFont QueryFont
XQueryKeymap QueryKeymap
XQueryPointer QueryPointer
XQueryTextExtents QueryTextExtents
XQueryTextExtents16 QueryTextExtents
XQueryTree QueryTree
XRaiseWindow ConfigureWindow
XReadBitmapFile CreateGC
CreatePixmap
FreeGC
PutImage
XRecolorCursor RecolorCursor
XReconfigureWMWindow ConfigureWindow
SendEvent
XRemoveFromSaveSet ChangeSaveSet
XRemoveHost ChangeHosts
XRemoveHosts ChangeHosts
XReparentWindow ReparentWindow
XResetScreenSaver ForceScreenSaver
XResizeWindow ConfigureWindow
XRestackWindows ConfigureWindow
XRotateBuffers RotateProperties
XRotateWindowProperties RotateProperties
XSelectInput ChangeWindowAttributes
XSendEvent SendEvent
XSetAccessControl SetAccessControl
XSetArcMode ChangeGC
XSetBackground ChangeGC
XSetClassHint ChangeProperty
XSetClipMask ChangeGC
660055
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
XXlliibb FFuunnccttiioonn PPrroottooccooll RReeqquueesstt
-------------------------------------------------------
XSetClipOrigin ChangeGC
XSetClipRectangles SetClipRectangles
XSetCloseDownMode SetCloseDownMode
XSetCommand ChangeProperty
XSetDashes SetDashes
XSetFillRule ChangeGC
XSetFillStyle ChangeGC
XSetFont ChangeGC
XSetFontPath SetFontPath
XSetForeground ChangeGC
XSetFunction ChangeGC
XSetGraphicsExposures ChangeGC
XSetIconName ChangeProperty
XSetIconSizes ChangeProperty
XSetInputFocus SetInputFocus
XSetLineAttributes ChangeGC
XSetModifierMapping SetModifierMapping
XSetNormalHints ChangeProperty
XSetPlaneMask ChangeGC
XSetPointerMapping SetPointerMapping
XSetRGBColormaps ChangeProperty
XSetScreenSaver SetScreenSaver
XSetSelectionOwner SetSelectionOwner
XSetSizeHints ChangeProperty
XSetStandardProperties ChangeProperty
XSetState ChangeGC
XSetStipple ChangeGC
XSetSubwindowMode ChangeGC
XSetTextProperty ChangeProperty
XSetTile ChangeGC
XSetTransientForHint ChangeProperty
XSetTSOrigin ChangeGC
XSetWMClientMachine ChangeProperty
XSetWMColormapWindows ChangeProperty
InternAtom
XSetWMHints ChangeProperty
XSetWMIconName ChangeProperty
XSetWMName ChangeProperty
XSetWMNormalHints ChangeProperty
XSetWMProperties ChangeProperty
XSetWMProtocols ChangeProperty
InternAtom
XSetWMSizeHints ChangeProperty
XSetWindowBackground ChangeWindowAttributes
XSetWindowBackgroundPixmap ChangeWindowAttributes
XSetWindowBorder ChangeWindowAttributes
XSetWindowBorderPixmap ChangeWindowAttributes
XSetWindowBorderWidth ConfigureWindow
XSetWindowColormap ChangeWindowAttributes
XSetZoomHints ChangeProperty
660066
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
XXlliibb FFuunnccttiioonn PPrroottooccooll RReeqquueesstt
-------------------------------------------------------
XStoreBuffer ChangeProperty
XStoreBytes ChangeProperty
XStoreColor StoreColors
XStoreColors StoreColors
XStoreName ChangeProperty
XStoreNamedColor StoreNamedColor
XSync GetInputFocus
XSynchronize GetInputFocus
XTranslateCoordinates TranslateCoordinates
XUndefineCursor ChangeWindowAttributes
XUngrabButton UngrabButton
XUngrabKey UngrabKey
XUngrabKeyboard UngrabKeyboard
XUngrabPointer UngrabPointer
XUngrabServer UngrabServer
XUninstallColormap UninstallColormap
XUnloadFont CloseFont
XUnmapSubwindows UnmapSubwindows
XUnmapWindow UnmapWindow
XWarpPointer WarpPointer
XWithdrawWindow SendEvent
UnmapWindow
660077
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The following table lists each X protocol request (in alpha-
betical order) and the Xlib functions that reference it.
-------------------------------------------------------
PPrroottooccooll RReeqquueesstt XXlliibb FFuunnccttiioonn
-------------------------------------------------------
AllocColor XAllocColor
AllocColorCells XAllocColorCells
AllocColorPlanes XAllocColorPlanes
AllocNamedColor XAllocNamedColor
AllowEvents XAllowEvents
Bell XBell
ChangeActivePointerGrab XChangeActivePointerGrab
ChangeGC XChangeGC
XSetArcMode
XSetBackground
XSetClipMask
XSetClipOrigin
XSetFillRule
XSetFillStyle
XSetFont
XSetForeground
XSetFunction
XSetGraphicsExposures
XSetLineAttributes
XSetPlaneMask
XSetState
XSetStipple
XSetSubwindowMode
XSetTile
XSetTSOrigin
ChangeHosts XAddHost
XAddHosts
XRemoveHost
XRemoveHosts
ChangeKeyboardControl XAutoRepeatOff
XAutoRepeatOn
XChangeKeyboardControl
ChangeKeyboardMapping XChangeKeyboardMapping
ChangePointerControl XChangePointerControl
ChangeProperty XChangeProperty
XSetClassHint
XSetCommand
XSetIconName
XSetIconSizes
XSetNormalHints
XSetRGBColormaps
XSetSizeHints
XSetStandardProperties
XSetTextProperty
XSetTransientForHint
XSetWMClientMachine
XSetWMColormapWindows
660088
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
PPrroottooccooll RReeqquueesstt XXlliibb FFuunnccttiioonn
-------------------------------------------------------
XSetWMHints
XSetWMIconName
XSetWMName
XSetWMNormalHints
XSetWMProperties
XSetWMProtocols
XSetWMSizeHints
XSetZoomHints
XStoreBuffer
XStoreBytes
XStoreName
ChangeSaveSet XAddToSaveSet
XChangeSaveSet
XRemoveFromSaveSet
ChangeWindowAttributes XChangeWindowAttributes
XDefineCursor
XSelectInput
XSetWindowBackground
XSetWindowBackgroundPixmap
XSetWindowBorder
XSetWindowBorderPixmap
XSetWindowColormap
XUndefineCursor
CirculateWindow XCirculateSubwindowsDown
XCirculateSubwindowsUp
XCirculateSubwindows
ClearArea XClearArea
XClearWindow
CloseFont XFreeFont
XUnloadFont
ConfigureWindow XConfigureWindow
XLowerWindow
XMapRaised
XMoveResizeWindow
XMoveWindow
XRaiseWindow
XReconfigureWMWindow
XResizeWindow
XRestackWindows
XSetWindowBorderWidth
ConvertSelection XConvertSelection
CopyArea XCopyArea
CopyColormapAndFree XCopyColormapAndFree
CopyGC XCopyGC
CopyPlane XCopyPlane
CreateColormap XCreateColormap
CreateCursor XCreatePixmapCursor
CreateGC XCreateGC
XCreateBitmapFromData
XCreatePixmapFromData
660099
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
PPrroottooccooll RReeqquueesstt XXlliibb FFuunnccttiioonn
-------------------------------------------------------
XOpenDisplay
XReadBitmapFile
CreateGlyphCursor XCreateFontCursor
XCreateGlyphCursor
CreatePixmap XCreatePixmap
XCreateBitmapFromData
XCreatePixmapFromData
XReadBitmapFile
CreateWindow XCreateSimpleWindow
XCreateWindow
DeleteProperty XDeleteProperty
DestroySubwindows XDestroySubwindows
DestroyWindow XDestroyWindow
FillPoly XFillPolygon
ForceScreenSaver XActivateScreenSaver
XForceScreenSaver
XResetScreenSaver
FreeColormap XFreeColormap
FreeColors XFreeColors
FreeCursor XFreeCursor
FreeGC XFreeGC
XCreateBitmapFromData
XCreatePixmapFromData
XReadBitmapFile
FreePixmap XFreePixmap
GetAtomName XGetAtomName
GetFontPath XGetFontPath
GetGeometry XGetGeometry
XGetWindowAttributes
GetImage XGetImage
GetInputFocus XGetInputFocus
XSync
XSynchronize
GetKeyboardControl XGetKeyboardControl
GetKeyboardMapping XGetKeyboardMapping
GetModifierMapping XGetModifierMapping
GetMotionEvents XGetMotionEvents
GetPointerControl XGetPointerControl
GetPointerMapping XGetPointerMapping
GetProperty XFetchBytes
XFetchName
XGetClassHint
XGetIconName
XGetIconSizes
XGetNormalHints
XGetRGBColormaps
XGetSizeHints
XGetTextProperty
XGetTransientForHint
XGetWMClientMachine
661100
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
PPrroottooccooll RReeqquueesstt XXlliibb FFuunnccttiioonn
-------------------------------------------------------
XGetWMColormapWindows
XGetWMHints
XGetWMIconName
XGetWMName
XGetWMNormalHints
XGetWMProtocols
XGetWMSizeHints
XGetWindowProperty
XGetZoomHints
GetSelectionOwner XGetSelectionOwner
GetWindowAttributes XGetWindowAttributes
GrabButton XGrabButton
GrabKey XGrabKey
GrabKeyboard XGrabKeyboard
GrabPointer XGrabPointer
GrabServer XGrabServer
ImageText8 XDrawImageString
ImageText16 XDrawImageString16
InstallColormap XInstallColormap
InternAtom XGetWMColormapWindows
XGetWMProtocols
XIconifyWindow
XInternAtom
XSetWMColormapWindows
XSetWMProtocols
KillClient XKillClient
ListExtensions XListExtensions
ListFonts XListFonts
ListFontsWithInfo XListFontsWithInfo
ListHosts XListHosts
ListInstalledColormaps XListInstalledColormaps
ListProperties XListProperties
LookupColor XLookupColor
XParseColor
MapSubwindows XMapSubwindows
MapWindow XMapRaised
XMapWindow
NoOperation XNoOp
OpenFont XLoadFont
XLoadQueryFont
PolyArc XDrawArc
XDrawArcs
PolyFillArc XFillArc
XFillArcs
PolyFillRectangle XFillRectangle
XFillRectangles
PolyLine XDrawLines
PolyPoint XDrawPoint
XDrawPoints
PolyRectangle XDrawRectangle
661111
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
PPrroottooccooll RReeqquueesstt XXlliibb FFuunnccttiioonn
-------------------------------------------------------
XDrawRectangles
PolySegment XDrawLine
XDrawSegments
PolyText8 XDrawString
XDrawText
PolyText16 XDrawString16
XDrawText16
PutImage XPutImage
XCreateBitmapFromData
XCreatePixmapFromData
XReadBitmapFile
QueryBestSize XQueryBestCursor
XQueryBestSize
XQueryBestStipple
XQueryBestTile
QueryColors XQueryColor
XQueryColors
QueryExtension XInitExtension
XQueryExtension
QueryFont XLoadQueryFont
XQueryFont
QueryKeymap XQueryKeymap
QueryPointer XQueryPointer
QueryTextExtents XQueryTextExtents
XQueryTextExtents16
QueryTree XQueryTree
RecolorCursor XRecolorCursor
ReparentWindow XReparentWindow
RotateProperties XRotateBuffers
XRotateWindowProperties
SendEvent XIconifyWindow
XReconfigureWMWindow
XSendEvent
XWithdrawWindow
SetAccessControl XDisableAccessControl
XEnableAccessControl
XSetAccessControl
SetClipRectangles XSetClipRectangles
SetCloseDownMode XSetCloseDownMode
SetDashes XSetDashes
SetFontPath XSetFontPath
SetInputFocus XSetInputFocus
SetModifierMapping XSetModifierMapping
SetPointerMapping XSetPointerMapping
SetScreenSaver XGetScreenSaver
XSetScreenSaver
SetSelectionOwner XSetSelectionOwner
StoreColors XStoreColor
XStoreColors
StoreNamedColor XStoreNamedColor
661122
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
-------------------------------------------------------
PPrroottooccooll RReeqquueesstt XXlliibb FFuunnccttiioonn
-------------------------------------------------------
TranslateCoordinates XTranslateCoordinates
UngrabButton XUngrabButton
UngrabKey XUngrabKey
UngrabKeyboard XUngrabKeyboard
UngrabPointer XUngrabPointer
UngrabServer XUngrabServer
UninstallColormap XUninstallColormap
UnmapSubwindows XUnmapSubWindows
UnmapWindow XUnmapWindow
XWithdrawWindow
WarpPointer XWarpPointer
661133
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
AAppppeennddiixx BB
XX FFoonntt CCuurrssoorrss
The following are the available cursors that can be used
with _X_C_r_e_a_t_e_F_o_n_t_C_u_r_s_o_r.
#define XC_X_cursor 0 #define XC_ll_angle 76
#define XC_arrow 2 #define XC_lr_angle 78
#define XC_based_arrow_down 4 #define XC_man 80
#define XC_based_arrow_up 6 #define XC_middlebutton 82
#define XC_boat 8 #define XC_mouse 84
#define XC_bogosity 10 #define XC_pencil 86
#define XC_bottom_left_corner 12#define XC_pirate 88
#define XC_bottom_right_corner 14#define XC_plus 90
#define XC_bottom_side 16 #define XC_question_arrow 92
#define XC_bottom_tee 18 #define XC_right_ptr 94
#define XC_box_spiral 20 #define XC_right_side 96
#define XC_center_ptr 22 #define XC_right_tee 98
#define XC_circle 24 #define XC_rightbutton 100
#define XC_clock 26 #define XC_rtl_logo 102
#define XC_coffee_mug 28 #define XC_sailboat 104
#define XC_cross 30 #define XC_sb_down_arrow 106
#define XC_cross_reverse 32 #define XC_sb_h_double_arrow 108
#define XC_crosshair 34 #define XC_sb_left_arrow 110
#define XC_diamond_cross 36 #define XC_sb_right_arrow 112
#define XC_dot 38 #define XC_sb_up_arrow 114
#define XC_dot_box_mask 40 #define XC_sb_v_double_arrow 116
#define XC_double_arrow 42 #define XC_shuttle 118
#define XC_draft_large 44 #define XC_sizing 120
#define XC_draft_small 46 #define XC_spider 122
#define XC_draped_box 48 #define XC_spraycan 124
#define XC_exchange 50 #define XC_star 126
#define XC_fleur 52 #define XC_target 128
#define XC_gobbler 54 #define XC_tcross 130
#define XC_gumby 56 #define XC_top_left_arrow 132
#define XC_hand1 58 #define XC_top_left_corner 134
#define XC_hand2 60 #define XC_top_right_corner 136
#define XC_heart 62 #define XC_top_side 138
#define XC_icon 64 #define XC_top_tee 140
#define XC_iron_cross 66 #define XC_trek 142
#define XC_left_ptr 68 #define XC_ul_angle 144
#define XC_left_side 70 #define XC_umbrella 146
#define XC_left_tee 72 #define XC_ur_angle 148
#define XC_leftbutton 74 #define XC_watch 150
#define XC_xterm 152
661144
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
AAppppeennddiixx CC
EExxtteennssiioonnss
Because X can evolve by extensions to the core protocol, it
is important that extensions not be perceived as second-
class citizens. At some point, your favorite extensions may
be adopted as additional parts of the X Standard.
Therefore, there should be little to distinguish the use of
an extension from that of the core protocol. To avoid hav-
ing to initialize extensions explicitly in application pro-
grams, it is also important that extensions perform lazy
evaluations, automatically initializing themselves when
called for the first time.
This appendix describes techniques for writing extensions to
Xlib that will run at essentially the same performance as
the core protocol requests.
Note
It is expected that a given extension to X con-
sists of multiple requests. Defining 10 new fea-
tures as 10 separate extensions is a bad practice.
Rather, they should be packaged into a single
extension and should use minor opcodes to distin-
guish the requests.
The symbols and macros used for writing stubs to Xlib are
listed in <_X_1_1_/_X_l_i_b_i_n_t_._h>.
BBaassiicc PPrroottooccooll SSuuppppoorrtt RRoouuttiinneess
The basic protocol requests for extensions are _X_Q_u_e_r_y_E_x_t_e_n_-
_s_i_o_n and _X_L_i_s_t_E_x_t_e_n_s_i_o_n_s.
661155
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Bool XQueryExtension(_d_i_s_p_l_a_y, _n_a_m_e, _m_a_j_o_r___o_p_c_o_d_e___r_e_t_u_r_n, _f_i_r_s_t___e_v_e_n_t___r_e_t_u_r_n, _f_i_r_s_t___e_r_r_o_r___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
char *_n_a_m_e_;
int *_m_a_j_o_r___o_p_c_o_d_e___r_e_t_u_r_n;
int *_f_i_r_s_t___e_v_e_n_t___r_e_t_u_r_n;
int *_f_i_r_s_t___e_r_r_o_r___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_a_m_e Specifies the extension name.
_m_a_j_o_r___o_p_c_o_d_e___r_e_t_u_r_n
Returns the major opcode.
_f_i_r_s_t___e_v_e_n_t___r_e_t_u_r_n
Returns the first event code, if any.
_f_i_r_s_t___e_r_r_o_r___r_e_t_u_r_n
Returns the first error code, if any.
││__
The _X_Q_u_e_r_y_E_x_t_e_n_s_i_o_n function determines if the named exten-
sion is present. If the extension is not present, _X_Q_u_e_r_y_E_x_-
_t_e_n_s_i_o_n returns _F_a_l_s_e; otherwise, it returns _T_r_u_e. If the
extension is present, _X_Q_u_e_r_y_E_x_t_e_n_s_i_o_n returns the major
opcode for the extension to major_opcode_return; otherwise,
it returns zero. Any minor opcode and the request formats
are specific to the extension. If the extension involves
additional event types, _X_Q_u_e_r_y_E_x_t_e_n_s_i_o_n returns the base
event type code to first_event_return; otherwise, it returns
zero. The format of the events is specific to the exten-
sion. If the extension involves additional error codes,
_X_Q_u_e_r_y_E_x_t_e_n_s_i_o_n returns the base error code to
first_error_return; otherwise, it returns zero. The format
of additional data in the errors is specific to the exten-
sion.
If the extension name is not in the Host Portable Character
Encoding the result is implementation-dependent. Uppercase
and lowercase matter; the strings ``thing'', ``Thing'', and
``thinG'' are all considered different names.
661166
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char **XListExtensions(_d_i_s_p_l_a_y, _n_e_x_t_e_n_s_i_o_n_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int *_n_e_x_t_e_n_s_i_o_n_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_e_x_t_e_n_s_i_o_n_s___r_e_t_u_r_n
Returns the number of extensions listed.
││__
The _X_L_i_s_t_E_x_t_e_n_s_i_o_n_s function returns a list of all exten-
sions supported by the server. If the data returned by the
server is in the Latin Portable Character Encoding, then the
returned strings are in the Host Portable Character Encod-
ing. Otherwise, the result is implementation-dependent.
__
││
XFreeExtensionList(_l_i_s_t)
char **_l_i_s_t;
_l_i_s_t Specifies the list of extension names.
││__
The _X_F_r_e_e_E_x_t_e_n_s_i_o_n_L_i_s_t function frees the memory allocated
by _X_L_i_s_t_E_x_t_e_n_s_i_o_n_s.
HHooookkiinngg iinnttoo XXlliibb
These functions allow you to hook into the library. They
are not normally used by application programmers but are
used by people who need to extend the core X protocol and
the X library interface. The functions, which generate pro-
tocol requests for X, are typically called stubs.
In extensions, stubs first should check to see if they have
initialized themselves on a connection. If they have not,
they then should call _X_I_n_i_t_E_x_t_e_n_s_i_o_n to attempt to initial-
ize themselves on the connection.
If the extension needs to be informed of GC/font allocation
or deallocation or if the extension defines new event types,
the functions described here allow the extension to be
called when these events occur.
The _X_E_x_t_C_o_d_e_s structure returns the information from _X_I_n_i_-
_t_E_x_t_e_n_s_i_o_n and is defined in <_X_1_1_/_X_l_i_b_._h>:
661177
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XExtCodes { /* public to extension, cannot be changed */
int extension; /* extension number */
int major_opcode; /* major op-code assigned by server */
int first_event; /* first event number for the extension */
int first_error; /* first error number for the extension */
} XExtCodes;
││__
__
││
XExtCodes *XInitExtension(_d_i_s_p_l_a_y, _n_a_m_e)
Display *_d_i_s_p_l_a_y;
char *_n_a_m_e;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_a_m_e Specifies the extension name.
││__
The _X_I_n_i_t_E_x_t_e_n_s_i_o_n function determines if the named exten-
sion exists. Then, it allocates storage for maintaining the
information about the extension on the connection, chains
this onto the extension list for the connection, and returns
the information the stub implementor will need to access the
extension. If the extension does not exist, _X_I_n_i_t_E_x_t_e_n_s_i_o_n
returns NULL.
If the extension name is not in the Host Portable Character
Encoding, the result is implementation-dependent. Uppercase
and lowercase matter; the strings ``thing'', ``Thing'', and
``thinG'' are all considered different names.
The extension number in the _X_E_x_t_C_o_d_e_s structure is needed in
the other calls that follow. This extension number is
unique only to a single connection.
__
││
XExtCodes *XAddExtension(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
For local Xlib extensions, the _X_A_d_d_E_x_t_e_n_s_i_o_n function allo-
cates the _X_E_x_t_C_o_d_e_s structure, bumps the extension number
count, and chains the extension onto the extension list.
(This permits extensions to Xlib without requiring server
extensions.)
661188
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
HHooookkss iinnttoo tthhee LLiibbrraarryy
These functions allow you to define procedures that are to
be called when various circumstances occur. The procedures
include the creation of a new GC for a connection, the copy-
ing of a GC, the freeing of a GC, the creating and freeing
of fonts, the conversion of events defined by extensions to
and from wire format, and the handling of errors.
All of these functions return the previous procedure defined
for this extension.
__
││
int (*XESetCloseDisplay(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when the display
is closed.
││__
The _X_E_S_e_t_C_l_o_s_e_D_i_s_p_l_a_y function defines a procedure to be
called whenever _X_C_l_o_s_e_D_i_s_p_l_a_y is called. It returns any
previously defined procedure, usually NULL.
When _X_C_l_o_s_e_D_i_s_p_l_a_y is called, your procedure is called with
these arguments:
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
XExtCodes *_c_o_d_e_s;
││__
661199
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int (*XESetCreateGC(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when a GC is
closed.
││__
The _X_E_S_e_t_C_r_e_a_t_e_G_C function defines a procedure to be called
whenever a new GC is created. It returns any previously
defined procedure, usually NULL.
When a GC is created, your procedure is called with these
arguments:
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _g_c, _c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
GC _g_c;
XExtCodes *_c_o_d_e_s;
││__
__
││
int (*XESetCopyGC(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when GC components
are copied.
││__
The _X_E_S_e_t_C_o_p_y_G_C function defines a procedure to be called
whenever a GC is copied. It returns any previously defined
procedure, usually NULL.
When a GC is copied, your procedure is called with these
arguments:
662200
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _g_c, _c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
GC _g_c;
XExtCodes *_c_o_d_e_s;
││__
__
││
int (*XESetFreeGC(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c_))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when a GC is
freed.
││__
The _X_E_S_e_t_F_r_e_e_G_C function defines a procedure to be called
whenever a GC is freed. It returns any previously defined
procedure, usually NULL.
When a GC is freed, your procedure is called with these
arguments:
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _g_c, _c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
GC _g_c;
XExtCodes *_c_o_d_e_s;
││__
662211
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int (*XESetCreateFont(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when a font is
created.
││__
The _X_E_S_e_t_C_r_e_a_t_e_F_o_n_t function defines a procedure to be
called whenever _X_L_o_a_d_Q_u_e_r_y_F_o_n_t and _X_Q_u_e_r_y_F_o_n_t are called.
It returns any previously defined procedure, usually NULL.
When _X_L_o_a_d_Q_u_e_r_y_F_o_n_t or _X_Q_u_e_r_y_F_o_n_t is called, your procedure
is called with these arguments:
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _f_s, _c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
XFontStruct *_f_s;
XExtCodes *_c_o_d_e_s;
││__
__
││
int (*XESetFreeFont(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when a font is
freed.
││__
The _X_E_S_e_t_F_r_e_e_F_o_n_t function defines a procedure to be called
whenever _X_F_r_e_e_F_o_n_t is called. It returns any previously
defined procedure, usually NULL.
When _X_F_r_e_e_F_o_n_t is called, your procedure is called with
these arguments:
662222
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _f_s, _c_o_d_e_s)
Display *_d_i_s_p_l_a_y;
XFontStruct *_f_s;
XExtCodes *_c_o_d_e_s;
││__
The _X_E_S_e_t_W_i_r_e_T_o_E_v_e_n_t and _X_E_S_e_t_E_v_e_n_t_T_o_W_i_r_e functions allow
you to define new events to the library. An _X_E_v_e_n_t struc-
ture always has a type code (type _i_n_t) as the first compo-
nent. This uniquely identifies what kind of event it is.
The second component is always the serial number (type
_u_n_s_i_g_n_e_d _l_o_n_g) of the last request processed by the server.
The third component is always a Boolean (type _B_o_o_l) indicat-
ing whether the event came from a _S_e_n_d_E_v_e_n_t protocol
request. The fourth component is always a pointer to the
display the event was read from. The fifth component is
always a resource ID of one kind or another, usually a win-
dow, carefully selected to be useful to toolkit dispatchers.
The fifth component should always exist, even if the event
does not have a natural destination; if there is no value
from the protocol to put in this component, initialize it to
zero.
Note
There is an implementation limit such that your
host event structure size cannot be bigger than
the size of the _X_E_v_e_n_t union of structures. There
also is no way to guarantee that more than 24 ele-
ments or 96 characters in the structure will be
fully portable between machines.
__
││
int (*XESetWireToEvent(_d_i_s_p_l_a_y, _e_v_e_n_t___n_u_m_b_e_r, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_v_e_n_t___n_u_m_b_e_r;
Status (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___n_u_m_b_e_r
Specifies the event code.
_p_r_o_c Specifies the procedure to call when converting an
event.
││__
The _X_E_S_e_t_W_i_r_e_T_o_E_v_e_n_t function defines a procedure to be
called when an event needs to be converted from wire format
(_x_E_v_e_n_t) to host format (_X_E_v_e_n_t). The event number defines
662233
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
which protocol event number to install a conversion proce-
dure for. _X_E_S_e_t_W_i_r_e_T_o_E_v_e_n_t returns any previously defined
procedure.
Note
You can replace a core event conversion function
with one of your own, although this is not encour-
aged. It would, however, allow you to intercept a
core event and modify it before being placed in
the queue or otherwise examined.
When Xlib needs to convert an event from wire format to host
format, your procedure is called with these arguments:
__
││
Status (*_p_r_o_c)(_d_i_s_p_l_a_y, _r_e, _e_v_e_n_t)
Display *_d_i_s_p_l_a_y;
XEvent *_r_e;
xEvent *_e_v_e_n_t;
││__
Your procedure must return status to indicate if the conver-
sion succeeded. The re argument is a pointer to where the
host format event should be stored, and the event argument
is the 32-byte wire event structure. In the _X_E_v_e_n_t struc-
ture you are creating, you must fill in the five required
members of the event structure. You should fill in the type
member with the type specified for the _x_E_v_e_n_t structure.
You should copy all other members from the _x_E_v_e_n_t structure
(wire format) to the _X_E_v_e_n_t structure (host format). Your
conversion procedure should return _T_r_u_e if the event should
be placed in the queue or _F_a_l_s_e if it should not be placed
in the queue.
To initialize the serial number component of the event, call
___X_S_e_t_L_a_s_t_R_e_q_u_e_s_t_R_e_a_d with the event and use the return
value.
__
││
unsigned long _XSetLastRequestRead(_d_i_s_p_l_a_y, _r_e_p)
Display *_d_i_s_p_l_a_y;
xGenericReply *_r_e_p;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_e_p Specifies the wire event structure.
││__
The ___X_S_e_t_L_a_s_t_R_e_q_u_e_s_t_R_e_a_d function computes and returns a
662244
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
complete serial number from the partial serial number in the
event.
__
││
Status (*XESetEventToWire(_d_i_s_p_l_a_y, _e_v_e_n_t___n_u_m_b_e_r, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_v_e_n_t___n_u_m_b_e_r;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___n_u_m_b_e_r
Specifies the event code.
_p_r_o_c Specifies the procedure to call when converting an
event.
││__
The _X_E_S_e_t_E_v_e_n_t_T_o_W_i_r_e function defines a procedure to be
called when an event needs to be converted from host format
(_X_E_v_e_n_t) to wire format (_x_E_v_e_n_t) form. The event number
defines which protocol event number to install a conversion
procedure for. _X_E_S_e_t_E_v_e_n_t_T_o_W_i_r_e returns any previously
defined procedure. It returns zero if the conversion fails
or nonzero otherwise.
Note
You can replace a core event conversion function
with one of your own, although this is not encour-
aged. It would, however, allow you to intercept a
core event and modify it before being sent to
another client.
When Xlib needs to convert an event from host format to wire
format, your procedure is called with these arguments:
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _r_e, _e_v_e_n_t)
Display *_d_i_s_p_l_a_y;
XEvent *_r_e;
xEvent *_e_v_e_n_t;
││__
The re argument is a pointer to the host format event, and
the event argument is a pointer to where the 32-byte wire
event structure should be stored. You should fill in the
type with the type from the _X_E_v_e_n_t structure. All other
members then should be copied from the host format to the
662255
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_x_E_v_e_n_t structure.
__
││
Bool (*XESetWireToError(_d_i_s_p_l_a_y, _e_r_r_o_r___n_u_m_b_e_r, _p_r_o_c)()
Display *_d_i_s_p_l_a_y;
int _e_r_r_o_r___n_u_m_b_e_r;
Bool (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_r_r_o_r___n_u_m_b_e_r
Specifies the error code.
_p_r_o_c Specifies the procedure to call when an error is
received.
││__
The _X_E_S_e_t_W_i_r_e_T_o_E_r_r_o_r function defines a procedure to be
called when an extension error needs to be converted from
wire format to host format. The error number defines which
protocol error code to install the conversion procedure for.
_X_E_S_e_t_W_i_r_e_T_o_E_r_r_o_r returns any previously defined procedure.
Use this function for extension errors that contain addi-
tional error values beyond those in a core X error, when
multiple wire errors must be combined into a single Xlib
error, or when it is necessary to intercept an X error
before it is otherwise examined.
When Xlib needs to convert an error from wire format to host
format, the procedure is called with these arguments:
__
││
Bool (*_p_r_o_c)(_d_i_s_p_l_a_y, _h_e, _w_e)
Display *_d_i_s_p_l_a_y;
XErrorEvent *_h_e;
xError *_w_e;
││__
The he argument is a pointer to where the host format error
should be stored. The structure pointed at by he is guaran-
teed to be as large as an _X_E_v_e_n_t structure and so can be
cast to a type larger than an _X_E_r_r_o_r_E_v_e_n_t to store addi-
tional values. If the error is to be completely ignored by
Xlib (for example, several protocol error structures will be
combined into one Xlib error), then the function should
return _F_a_l_s_e; otherwise, it should return _T_r_u_e.
662266
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int (*XESetError(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when an error is
received.
││__
Inside Xlib, there are times that you may want to suppress
the calling of the external error handling when an error
occurs. This allows status to be returned on a call at the
cost of the call being synchronous (though most such func-
tions are query operations, in any case, and are typically
programmed to be synchronous).
When Xlib detects a protocol error in ___X_R_e_p_l_y, it calls your
procedure with these arguments:
__
││
int (*_p_r_o_c)(_d_i_s_p_l_a_y, _e_r_r, _c_o_d_e_s, _r_e_t___c_o_d_e)
Display *_d_i_s_p_l_a_y;
xError *_e_r_r;
XExtCodes *_c_o_d_e_s;
int *_r_e_t___c_o_d_e;
││__
The err argument is a pointer to the 32-byte wire format
error. The codes argument is a pointer to the extension
codes structure. The ret_code argument is the return code
you may want ___X_R_e_p_l_y returned to.
If your procedure returns a zero value, the error is not
suppressed, and the client's error handler is called. (For
further information, see section 11.8.2.) If your procedure
returns nonzero, the error is suppressed, and ___X_R_e_p_l_y
returns the value of ret_code.
662277
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char *(*XESetErrorString(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
char *(*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call to obtain an error
string.
││__
The _X_G_e_t_E_r_r_o_r_T_e_x_t function returns a string to the user for
an error. _X_E_S_e_t_E_r_r_o_r_S_t_r_i_n_g allows you to define a procedure
to be called that should return a pointer to the error mes-
sage. The following is an example.
__
││
(*_p_r_o_c)(_d_i_s_p_l_a_y, _c_o_d_e, _c_o_d_e_s, _b_u_f_f_e_r, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
int _c_o_d_e;
XExtCodes *_c_o_d_e_s;
char *_b_u_f_f_e_r;
int _n_b_y_t_e_s;
││__
Your procedure is called with the error code for every error
detected. You should copy nbytes of a null-terminated
string containing the error message into buffer.
__
││
void (*XESetPrintErrorValues(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
void (*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when an error is
printed.
││__
The _X_E_S_e_t_P_r_i_n_t_E_r_r_o_r_V_a_l_u_e_s function defines a procedure to be
called when an extension error is printed, to print the
error values. Use this function for extension errors that
contain additional error values beyond those in a core X
662288
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
error. It returns any previously defined procedure.
When Xlib needs to print an error, the procedure is called
with these arguments:
__
││
void (*_p_r_o_c)(_d_i_s_p_l_a_y, _e_v, _f_p)
Display *_d_i_s_p_l_a_y;
XErrorEvent *_e_v;
void *_f_p;
││__
The structure pointed at by ev is guaranteed to be as large
as an _X_E_v_e_n_t structure and so can be cast to a type larger
than an _X_E_r_r_o_r_E_v_e_n_t to obtain additional values set by using
_X_E_S_e_t_W_i_r_e_T_o_E_r_r_o_r. The underlying type of the fp argument is
system dependent; on a POSIX-compliant system, fp should be
cast to type FILE*.
__
││
int (*XESetFlushGC(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int *(*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when a GC is
flushed.
││__
The procedure set by the _X_E_S_e_t_F_l_u_s_h_G_C function has the same
interface as the procedure set by the _X_E_S_e_t_C_o_p_y_G_C function,
but is called when a GC cache needs to be updated in the
server.
662299
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int (*XESetBeforeFlush(_d_i_s_p_l_a_y, _e_x_t_e_n_s_i_o_n, _p_r_o_c))()
Display *_d_i_s_p_l_a_y;
int _e_x_t_e_n_s_i_o_n;
int *(*_p_r_o_c)();
_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_x_t_e_n_s_i_o_n Specifies the extension number.
_p_r_o_c Specifies the procedure to call when a buffer is
flushed.
││__
The _X_E_S_e_t_B_e_f_o_r_e_F_l_u_s_h function defines a procedure to be
called when data is about to be sent to the server. When
data is about to be sent, your procedure is called one or
more times with these arguments:
__
││
void (*_p_r_o_c)(_d_i_s_p_l_a_y, _c_o_d_e_s, _d_a_t_a, _l_e_n)
Display *_d_i_s_p_l_a_y;
XExtCodes *_c_o_d_e_s;
char *_d_a_t_a;
long _l_e_n;
││__
The data argument specifies a portion of the outgoing data
buffer, and its length in bytes is specified by the len
argument. Your procedure must not alter the contents of the
data and must not do additional protocol requests to the
same display.
HHooookkss oonnttoo XXlliibb DDaattaa SSttrruuccttuurreess
Various Xlib data structures have provisions for extension
procedures to chain extension supplied data onto a list.
These structures are _G_C, _V_i_s_u_a_l, _S_c_r_e_e_n, _S_c_r_e_e_n_F_o_r_m_a_t, _D_i_s_-
_p_l_a_y, and _X_F_o_n_t_S_t_r_u_c_t. Because the list pointer is always
the first member in the structure, a single set of proce-
dures can be used to manipulate the data on these lists.
The following structure is used in the functions in this
section and is defined in <_X_1_1_/_X_l_i_b_._h>:
663300
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
typedef struct _XExtData {
int number; /* number returned by XInitExtension */
struct _XExtData *next; /* next item on list of data for structure */
int (*free_private)(); /* if defined, called to free private */
XPointer private_data; /* data private to this extension. */
} XExtData;
││__
When any of the data structures listed above are freed, the
list is walked, and the structure's free procedure (if any)
is called. If free is NULL, then the library frees both the
data pointed to by the private_data member and the structure
itself.
__
││
union {Display *display;
GC gc;
Visual *visual;
Screen *screen;
ScreenFormat *pixmap_format;
XFontStruct *font } XEDataObject;
││__
__
││
XExtData **XEHeadOfExtensionList(_o_b_j_e_c_t)
XEDataObject _o_b_j_e_c_t;
_o_b_j_e_c_t Specifies the object.
││__
The _X_E_H_e_a_d_O_f_E_x_t_e_n_s_i_o_n_L_i_s_t function returns a pointer to the
list of extension structures attached to the specified
object. In concert with _X_A_d_d_T_o_E_x_t_e_n_s_i_o_n_L_i_s_t, _X_E_H_e_a_d_O_f_E_x_t_e_n_-
_s_i_o_n_L_i_s_t allows an extension to attach arbitrary data to any
of the structures of types contained in _X_E_D_a_t_a_O_b_j_e_c_t.
663311
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XAddToExtensionList(_s_t_r_u_c_t_u_r_e, _e_x_t___d_a_t_a)
XExtData **_s_t_r_u_c_t_u_r_e;
XExtData *_e_x_t___d_a_t_a;
_s_t_r_u_c_t_u_r_e Specifies the extension list.
_e_x_t___d_a_t_a Specifies the extension data structure to add.
││__
The structure argument is a pointer to one of the data
structures enumerated above. You must initialize
ext_data->number with the extension number before calling
this function.
__
││
XExtData *XFindOnExtensionList(_s_t_r_u_c_t_u_r_e, _n_u_m_b_e_r)
struct _XExtData **_s_t_r_u_c_t_u_r_e;
int _n_u_m_b_e_r;
_s_t_r_u_c_t_u_r_e Specifies the extension list.
_n_u_m_b_e_r Specifies the extension number from _X_I_n_i_t_E_x_t_e_n_-
_s_i_o_n.
││__
The _X_F_i_n_d_O_n_E_x_t_e_n_s_i_o_n_L_i_s_t function returns the first exten-
sion data structure for the extension numbered number. It
is expected that an extension will add at most one extension
data structure to any single data structure's extension data
list. There is no way to find additional structures.
The _X_A_l_l_o_c_I_D macro, which allocates and returns a resource
ID, is defined in <_X_1_1_/_X_l_i_b_._h>.
__
││
XAllocID(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
This macro is a call through the _D_i_s_p_l_a_y structure to an
internal resource ID allocator. It returns a resource ID
that you can use when creating new resources.
The _X_A_l_l_o_c_I_D_s macro allocates and returns an array of
resource ID.
663322
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XAllocIDs(_d_i_s_p_l_a_y, _i_d_s___r_e_t_u_r_n, _c_o_u_n_t)
Display *_d_i_s_p_l_a_y;
XID *_i_d_s___r_e_t_u_r_n;
int _c_o_u_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_i_d_s___r_e_t_u_r_n
Returns the resource IDs.
_r_e_p Specifies the number of resource IDs requested.
││__
This macro is a call through the _D_i_s_p_l_a_y structure to an
internal resource ID allocator. It returns resource IDs to
the array supplied by the caller. To correctly handle auto-
matic reuse of resource IDs, you must call _X_A_l_l_o_c_I_D_s when
requesting multiple resource IDs. This call might generate
protocol requests.
GGCC CCaacchhiinngg
GCs are cached by the library to allow merging of indepen-
dent change requests to the same GC into single protocol
requests. This is typically called a write-back cache. Any
extension procedure whose behavior depends on the contents
of a GC must flush the GC cache to make sure the server has
up-to-date contents in its GC.
The _F_l_u_s_h_G_C macro checks the dirty bits in the library's GC
structure and calls ___X_F_l_u_s_h_G_C_C_a_c_h_e if any elements have
changed. The _F_l_u_s_h_G_C macro is defined as follows:
__
││
FlushGC(_d_i_s_p_l_a_y, _g_c)
Display *_d_i_s_p_l_a_y;
GC _g_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
││__
Note that if you extend the GC to add additional resource ID
components, you should ensure that the library stub sends
the change request immediately. This is because a client
can free a resource immediately after using it, so if you
only stored the value in the cache without forcing a proto-
col request, the resource might be destroyed before being
set into the GC. You can use the ___X_F_l_u_s_h_G_C_C_a_c_h_e procedure
to force the cache to be flushed. The ___X_F_l_u_s_h_G_C_C_a_c_h_e
663333
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
procedure is defined as follows:
__
││
_XFlushGCCache(_d_i_s_p_l_a_y, _g_c)
Display *_d_i_s_p_l_a_y;
GC _g_c;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
││__
GGrraapphhiiccss BBaattcchhiinngg
If you extend X to add more poly graphics primitives, you
may be able to take advantage of facilities in the library
to allow back-to-back single calls to be transformed into
poly requests. This may dramatically improve performance of
programs that are not written using poly requests. A
pointer to an _x_R_e_q, called last_req in the display struc-
ture, is the last request being processed. By checking that
the last request type, drawable, gc, and other options are
the same as the new one and that there is enough space left
in the buffer, you may be able to just extend the previous
graphics request by extending the length field of the
request and appending the data to the buffer. This can
improve performance by five times or more in naive programs.
For example, here is the source for the _X_D_r_a_w_P_o_i_n_t stub.
(Writing extension stubs is discussed in the next section.)
663344
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
#include <X11/Xlibint.h>
/* precompute the maximum size of batching request allowed */
static int size = sizeof(xPolyPointReq) + EPERBATCH * sizeof(xPoint);
XDrawPoint(dpy, d, gc, x, y)
register Display *dpy;
Drawable d;
GC gc;
int x, y; /* INT16 */
{
xPoint *point;
LockDisplay(dpy);
FlushGC(dpy, gc);
{
register xPolyPointReq *req = (xPolyPointReq *) dpy->last_req;
/* if same as previous request, with same drawable, batch requests */
if (
(req->reqType == X_PolyPoint)
&& (req->drawable == d)
&& (req->gc == gc->gid)
&& (req->coordMode == CoordModeOrigin)
&& ((dpy->bufptr + sizeof (xPoint)) <= dpy->bufmax)
&& (((char *)dpy->bufptr - (char *)req) < size) ) {
point = (xPoint *) dpy->bufptr;
req->length += sizeof (xPoint) >> 2;
dpy->bufptr += sizeof (xPoint);
}
else {
GetReqExtra(PolyPoint, 4, req); /* 1 point = 4 bytes */
req->drawable = d;
req->gc = gc->gid;
req->coordMode = CoordModeOrigin;
point = (xPoint *) (req + 1);
}
point->x = x;
point->y = y;
}
UnlockDisplay(dpy);
SyncHandle();
}
││__
To keep clients from generating very long requests that may
monopolize the server, there is a symbol defined in
<_X_1_1_/_X_l_i_b_i_n_t_._h> of EPERBATCH on the number of requests
batched. Most of the performance benefit occurs in the
first few merged requests. Note that _F_l_u_s_h_G_C is called
_b_e_f_o_r_e picking up the value of last_req, because it may mod-
ify this field.
663355
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
WWrriittiinngg EExxtteennssiioonn SSttuubbss
All X requests always contain the length of the request,
expressed as a 16-bit quantity of 32 bits. This means that
a single request can be no more than 256K bytes in length.
Some servers may not support single requests of such a
length. The value of dpy->max_request_size contains the
maximum length as defined by the server implementation. For
further information, see ``X Window System Protocol.''
RReeqquueessttss,, RReepplliieess,, aanndd XXpprroottoo..hh
The <_X_1_1_/_X_p_r_o_t_o_._h> file contains three sets of definitions
that are of interest to the stub implementor: request names,
request structures, and reply structures.
You need to generate a file equivalent to <_X_1_1_/_X_p_r_o_t_o_._h> for
your extension and need to include it in your stub proce-
dure. Each stub procedure also must include <_X_1_1_/_X_l_i_b_-
_i_n_t_._h>.
The identifiers are deliberately chosen in such a way that,
if the request is called X_DoSomething, then its request
structure is xDoSomethingReq, and its reply is xDoSomethin-
gReply. The GetReq family of macros, defined in <_X_1_1_/_X_l_i_b_-
_i_n_t_._h>, takes advantage of this naming scheme.
For each X request, there is a definition in <_X_1_1_/_X_p_r_o_t_o_._h>
that looks similar to this:
#define X_DoSomething 42
In your extension header file, this will be a minor opcode,
instead of a major opcode.
RReeqquueesstt FFoorrmmaatt
Every request contains an 8-bit major opcode and a 16-bit
length field expressed in units of 4 bytes. Every request
consists of 4 bytes of header (containing the major opcode,
the length field, and a data byte) followed by zero or more
additional bytes of data. The length field defines the
total length of the request, including the header. The
length field in a request must equal the minimum length
required to contain the request. If the specified length is
smaller or larger than the required length, the server
should generate a _B_a_d_L_e_n_g_t_h error. Unused bytes in a
request are not required to be zero. Extensions should be
designed in such a way that long protocol requests can be
split up into smaller requests, if it is possible to exceed
the maximum request size of the server. The protocol guar-
antees the maximum request size to be no smaller than 4096
units (16384 bytes).
663366
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Major opcodes 128 through 255 are reserved for extensions.
Extensions are intended to contain multiple requests, so
extension requests typically have an additional minor opcode
encoded in the second data byte in the request header, but
the placement and interpretation of this minor opcode as
well as all other fields in extension requests are not
defined by the core protocol. Every request is implicitly
assigned a sequence number (starting with one) used in
replies, errors, and events.
To help but not cure portability problems to certain
machines, the _B_1_6 and _B_3_2 macros have been defined so that
they can become bitfield specifications on some machines.
For example, on a Cray, these should be used for all 16-bit
and 32-bit quantities, as discussed below.
Most protocol requests have a corresponding structure type-
def in <_X_1_1_/_X_p_r_o_t_o_._h>, which looks like:
__
││
typedef struct _DoSomethingReq {
CARD8 reqType; /* X_DoSomething */
CARD8 someDatum; /* used differently in different requests */
CARD16 length B16; /* total # of bytes in request, divided by 4 */
...
/* request-specific data */
...
} xDoSomethingReq;
││__
If a core protocol request has a single 32-bit argument, you
need not declare a request structure in your extension
header file. Instead, such requests use the _x_R_e_s_o_u_r_c_e_R_e_q
structure in <_X_1_1_/_X_p_r_o_t_o_._h>. This structure is used for any
request whose single argument is a _W_i_n_d_o_w, _P_i_x_m_a_p, _D_r_a_w_a_b_l_e,
_G_C_o_n_t_e_x_t, _F_o_n_t, _C_u_r_s_o_r, _C_o_l_o_r_m_a_p, _A_t_o_m, or _V_i_s_u_a_l_I_D.
__
││
typedef struct _ResourceReq {
CARD8 reqType; /* the request type, e.g. X_DoSomething */
BYTE pad; /* not used */
CARD16 length B16; /* 2 (= total # of bytes in request, divided by 4) */
CARD32 id B32; /* the Window, Drawable, Font, GContext, etc. */
} xResourceReq;
││__
If convenient, you can do something similar in your exten-
sion header file.
663377
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
In both of these structures, the reqType field identifies
the type of the request (for example, X_MapWindow or X_Cre-
atePixmap). The length field tells how long the request is
in units of 4-byte longwords. This length includes both the
request structure itself and any variable-length data, such
as strings or lists, that follow the request structure.
Request structures come in different sizes, but all requests
are padded to be multiples of four bytes long.
A few protocol requests take no arguments at all. Instead,
they use the _x_R_e_q structure in <_X_1_1_/_X_p_r_o_t_o_._h>, which con-
tains only a reqType and a length (and a pad byte).
If the protocol request requires a reply, then
<_X_1_1_/_X_p_r_o_t_o_._h> also contains a reply structure typedef:
__
││
typedef struct _DoSomethingReply {
BYTE type; /* always X_Reply */
BYTE someDatum; /* used differently in different requests */
CARD16 sequenceNumber B16;/* # of requests sent so far */
CARD32 length B32; /* # of additional bytes, divided by 4 */
...
/* request-specific data */
...
} xDoSomethingReply;
││__
Most of these reply structures are 32 bytes long. If there
are not that many reply values, then they contain a suffi-
cient number of pad fields to bring them up to 32 bytes.
The length field is the total number of bytes in the request
minus 32, divided by 4. This length will be nonzero only
if:
· The reply structure is followed by variable-length
data, such as a list or string.
· The reply structure is longer than 32 bytes.
Only _G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s, _Q_u_e_r_y_F_o_n_t, _Q_u_e_r_y_K_e_y_m_a_p, and
_G_e_t_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l have reply structures longer than 32
bytes in the core protocol.
A few protocol requests return replies that contain no data.
<_X_1_1_/_X_p_r_o_t_o_._h> does not define reply structures for these.
Instead, they use the _x_G_e_n_e_r_i_c_R_e_p_l_y structure, which con-
tains only a type, length, and sequence number (and suffi-
cient padding to make it 32 bytes long).
663388
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
SSttaarrttiinngg ttoo WWrriittee aa SSttuubb PPrroocceedduurree
An Xlib stub procedure should start like this:
#include "<X11/Xlibint.h>
XDoSomething (arguments, ... )
/* argument declarations */
{
register XDoSomethingReq *req;
...
If the protocol request has a reply, then the variable dec-
larations should include the reply structure for the
request. The following is an example:
xDoSomethingReply rep;
LLoocckkiinngg DDaattaa SSttrruuccttuurreess
To lock the display structure for systems that want to sup-
port multithreaded access to a single display connection,
each stub will need to lock its critical section. Gener-
ally, this section is the point from just before the appro-
priate GetReq call until all arguments to the call have been
stored into the buffer. The precise instructions needed for
this locking depend upon the machine architecture. Two
calls, which are generally implemented as macros, have been
provided.
__
││
LockDisplay(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
UnlockDisplay(_d_i_s_p_l_a_y)
Display *_d_i_s_p_l_a_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
││__
SSeennddiinngg tthhee PPrroottooccooll RReeqquueesstt aanndd AArrgguummeennttss
After the variable declarations, a stub procedure should
call one of four macros defined in <_X_1_1_/_X_l_i_b_i_n_t_._h>: _G_e_t_R_e_q,
_G_e_t_R_e_q_E_x_t_r_a, _G_e_t_R_e_s_R_e_q, or _G_e_t_E_m_p_t_y_R_e_q. All of these macros
take, as their first argument, the name of the protocol
663399
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
request as declared in <_X_1_1_/_X_p_r_o_t_o_._h> except with X_
removed. Each one declares a _D_i_s_p_l_a_y structure pointer,
called dpy, and a pointer to a request structure, called
req, which is of the appropriate type. The macro then
appends the request structure to the output buffer, fills in
its type and length field, and sets req to point to it.
If the protocol request has no arguments (for instance,
X_GrabServer), then use _G_e_t_E_m_p_t_y_R_e_q.
GetEmptyReq (DoSomething, req);
If the protocol request has a single 32-bit argument (such
as a _P_i_x_m_a_p, _W_i_n_d_o_w, _D_r_a_w_a_b_l_e, _A_t_o_m, and so on), then use
_G_e_t_R_e_s_R_e_q. The second argument to the macro is the 32-bit
object. _X___M_a_p_W_i_n_d_o_w is a good example.
GetResReq (DoSomething, rid, req);
The rid argument is the _P_i_x_m_a_p, _W_i_n_d_o_w, or other resource
ID.
If the protocol request takes any other argument list, then
call _G_e_t_R_e_q. After the _G_e_t_R_e_q, you need to set all the
other fields in the request structure, usually from argu-
ments to the stub procedure.
GetReq (DoSomething, req);
/* fill in arguments here */
req->arg1 = arg1;
req->arg2 = arg2;
...
A few stub procedures (such as _X_C_r_e_a_t_e_G_C and _X_C_r_e_a_t_e_P_i_x_m_a_p)
return a resource ID to the caller but pass a resource ID as
an argument to the protocol request. Such procedures use
the macro _X_A_l_l_o_c_I_D to allocate a resource ID from the range
of IDs that were assigned to this client when it opened the
connection.
rid = req->rid = XAllocID();
...
return (rid);
Finally, some stub procedures transmit a fixed amount of
variable-length data after the request. Typically, these
procedures (such as _X_M_o_v_e_W_i_n_d_o_w and _X_S_e_t_B_a_c_k_g_r_o_u_n_d) are spe-
cial cases of more general functions like _X_M_o_v_e_R_e_s_i_z_e_W_i_n_d_o_w
and _X_C_h_a_n_g_e_G_C. These procedures use _G_e_t_R_e_q_E_x_t_r_a, which is
the same as _G_e_t_R_e_q except that it takes an additional
664400
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
argument (the number of extra bytes to allocate in the out-
put buffer after the request structure). This number should
always be a multiple of four.
VVaarriiaabbllee LLeennggtthh AArrgguummeennttss
Some protocol requests take additional variable-length data
that follow the _x_D_o_S_o_m_e_t_h_i_n_g_R_e_q structure. The format of
this data varies from request to request. Some requests
require a sequence of 8-bit bytes, others a sequence of
16-bit or 32-bit entities, and still others a sequence of
structures.
It is necessary to add the length of any variable-length
data to the length field of the request structure. That
length field is in units of 32-bit longwords. If the data
is a string or other sequence of 8-bit bytes, then you must
round the length up and shift it before adding:
req->length += (nbytes+3)>>2;
To transmit variable-length data, use the _D_a_t_a macros. If
the data fits into the output buffer, then this macro copies
it to the buffer. If it does not fit, however, the _D_a_t_a
macro calls ___X_S_e_n_d, which transmits first the contents of
the buffer and then your data. The _D_a_t_a macros take three
arguments: the display, a pointer to the beginning of the
data, and the number of bytes to be sent.
__
││
Data(_d_i_s_p_l_a_y, (char *) _d_a_t_a, _n_b_y_t_e_s);
Data16(_d_i_s_p_l_a_y, (short *) _d_a_t_a, _n_b_y_t_e_s);
Data32(_d_i_s_p_l_a_y, (long *) _d_a_t_a, _n_b_y_t_e_s);
││__
_D_a_t_a, _D_a_t_a_1_6, and _D_a_t_a_3_2 are macros that may use their last
argument more than once, so that argument should be a vari-
able rather than an expression such as
``nitems*sizeof(item)''. You should do that kind of compu-
tation in a separate statement before calling them. Use the
appropriate macro when sending byte, short, or long data.
If the protocol request requires a reply, then call the pro-
cedure ___X_S_e_n_d instead of the _D_a_t_a macro. ___X_S_e_n_d takes the
same arguments, but because it sends your data immediately
instead of copying it into the output buffer (which would
later be flushed anyway by the following call on ___X_R_e_p_l_y),
it is faster.
664411
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
RReepplliieess
If the protocol request has a reply, then call ___X_R_e_p_l_y after
you have finished dealing with all the fixed-length and
variable-length arguments. ___X_R_e_p_l_y flushes the output
buffer and waits for an _x_R_e_p_l_y packet to arrive. If any
events arrive in the meantime, ___X_R_e_p_l_y places them in the
queue for later use.
__
││
Status _XReply(_d_i_s_p_l_a_y, _r_e_p, _e_x_t_r_a, _d_i_s_c_a_r_d)
Display *_d_i_s_p_l_a_y;
xReply *_r_e_p;
int _e_x_t_r_a;
Bool _d_i_s_c_a_r_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_r_e_p Specifies the reply structure.
_e_x_t_r_a Specifies the number of 32-bit words expected
after the replay.
_d_i_s_c_a_r_d Specifies if any data beyond that specified in the
extra argument should be discarded.
││__
The ___X_R_e_p_l_y function waits for a reply packet and copies its
contents into the specified rep. ___X_R_e_p_l_y handles error and
event packets that occur before the reply is received.
___X_R_e_p_l_y takes four arguments:
· A _D_i_s_p_l_a_y * structure
· A pointer to a reply structure (which must be cast to
an _x_R_e_p_l_y *)
· The number of additional 32-bit words (beyond
sizeof(_x_R_e_p_l_y) = 32 bytes) in the reply structure
· A Boolean that indicates whether ___X_R_e_p_l_y is to discard
any additional bytes beyond those it was told to read
Because most reply structures are 32 bytes long, the third
argument is usually 0. The only core protocol exceptions
are the replies to _G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s, _Q_u_e_r_y_F_o_n_t,
_Q_u_e_r_y_K_e_y_m_a_p, and _G_e_t_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l, which have longer
replies.
The last argument should be _F_a_l_s_e if the reply structure is
followed by additional variable-length data (such as a list
or string). It should be _T_r_u_e if there is not any variable-
length data.
664422
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
Note
This last argument is provided for upward-compati-
bility reasons to allow a client to communicate
properly with a hypothetical later version of the
server that sends more data than the client
expected. For example, some later version of
_G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s might use a larger, but com-
patible, _x_G_e_t_W_i_n_d_o_w_A_t_t_r_i_b_u_t_e_s_R_e_p_l_y that contains
additional attribute data at the end.
___X_R_e_p_l_y returns _T_r_u_e if it received a reply successfully or
_F_a_l_s_e if it received any sort of error.
For a request with a reply that is not followed by variable-
length data, you write something like:
_XReply(display, (xReply *)&rep, 0, True);
*ret1 = rep.ret1;
*ret2 = rep.ret2;
*ret3 = rep.ret3;
...
UnlockDisplay(dpy);
SyncHandle();
return (rep.ret4);
}
If there is variable-length data after the reply, change the
_T_r_u_e to _F_a_l_s_e, and use the appropriate ___X_R_e_a_d function to
read the variable-length data.
__
││
_XRead(_d_i_s_p_l_a_y, _d_a_t_a___r_e_t_u_r_n, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
char *_d_a_t_a___r_e_t_u_r_n;
long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_a_t_a___r_e_t_u_r_n
Specifies the buffer.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
The ___X_R_e_a_d function reads the specified number of bytes into
data_return.
664433
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
_XRead16(_d_i_s_p_l_a_y, _d_a_t_a___r_e_t_u_r_n, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
short *_d_a_t_a___r_e_t_u_r_n;
long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_a_t_a___r_e_t_u_r_n
Specifies the buffer.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
The ___X_R_e_a_d_1_6 function reads the specified number of bytes,
unpacking them as 16-bit quantities, into the specified
array as shorts.
__
││
_XRead32(_d_i_s_p_l_a_y, _d_a_t_a___r_e_t_u_r_n, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
long *_d_a_t_a___r_e_t_u_r_n;
long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_a_t_a___r_e_t_u_r_n
Specifies the buffer.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
The ___X_R_e_a_d_3_2 function reads the specified number of bytes,
unpacking them as 32-bit quantities, into the specified
array as longs.
664444
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
_XRead16Pad(_d_i_s_p_l_a_y, _d_a_t_a___r_e_t_u_r_n, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
short *_d_a_t_a___r_e_t_u_r_n;
long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_a_t_a___r_e_t_u_r_n
Specifies the buffer.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
The ___X_R_e_a_d_1_6_P_a_d function reads the specified number of
bytes, unpacking them as 16-bit quantities, into the speci-
fied array as shorts. If the number of bytes is not a mul-
tiple of four, ___X_R_e_a_d_1_6_P_a_d reads and discards up to two
additional pad bytes.
__
││
_XReadPad(_d_i_s_p_l_a_y, _d_a_t_a___r_e_t_u_r_n, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
char *_d_a_t_a___r_e_t_u_r_n;
long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d_a_t_a___r_e_t_u_r_n
Specifies the buffer.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
The ___X_R_e_a_d_P_a_d function reads the specified number of bytes
into data_return. If the number of bytes is not a multiple
of four, ___X_R_e_a_d_P_a_d reads and discards up to three additional
pad bytes.
Each protocol request is a little different. For further
information, see the Xlib sources for examples.
SSyynncchhrroonnoouuss CCaalllliinngg
Each procedure should have a call, just before returning to
the user, to a macro called _S_y_n_c_H_a_n_d_l_e. If synchronous mode
is enabled (see _X_S_y_n_c_h_r_o_n_i_z_e), the request is sent immedi-
ately. The library, however, waits until any error the pro-
cedure could generate at the server has been handled.
664455
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
AAllllooccaattiinngg aanndd DDeeaallllooccaattiinngg MMeemmoorryy
To support the possible reentry of these procedures, you
must observe several conventions when allocating and deallo-
cating memory, most often done when returning data to the
user from the window system of a size the caller could not
know in advance (for example, a list of fonts or a list of
extensions). The standard C library functions on many sys-
tems are not protected against signals or other multi-
threaded uses. The following analogies to standard I/O
library functions have been defined:
_X_m_a_l_l_o_c() Replaces _m_a_l_l_o_c()
_X_F_r_e_e() Replaces _f_r_e_e()
_X_c_a_l_l_o_c() Replaces _c_a_l_l_o_c()
These should be used in place of any calls you would make to
the normal C library functions.
If you need a single scratch buffer inside a critical sec-
tion (for example, to pack and unpack data to and from the
wire protocol), the general memory allocators may be too
expensive to use (particularly in output functions, which
are performance critical). The following function returns a
scratch buffer for use within a critical section:
__
││
char *_XAllocScratch(_d_i_s_p_l_a_y, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
unsigned long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
This storage must only be used inside of a critical section
of your stub. The returned pointer cannot be assumed valid
after any call that might permit another thread to execute
inside Xlib. For example, the pointer cannot be assumed
valid after any use of the _G_e_t_R_e_q or _D_a_t_a families of
macros, after any use of ___X_R_e_p_l_y, or after any use of the
___X_S_e_n_d or ___X_R_e_a_d families of functions.
The following function returns a scratch buffer for use
across critical sections:
664466
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
char *_XAllocTemp(_d_i_s_p_l_a_y, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
unsigned long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_n_b_y_t_e_s Specifies the number of bytes required.
││__
This storage can be used across calls that might permit
another thread to execute inside Xlib. The storage must be
explicitly returned to Xlib. The following function returns
the storage:
__
││
void _XFreeTemp(_d_i_s_p_l_a_y, _b_u_f, _n_b_y_t_e_s)
Display *_d_i_s_p_l_a_y;
char *_b_u_f;
unsigned long _n_b_y_t_e_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_b_u_f Specifies the buffer to return.
_n_b_y_t_e_s Specifies the size of the buffer.
││__
You must pass back the same pointer and size that were
returned by ___X_A_l_l_o_c_T_e_m_p.
PPoorrttaabbiilliittyy CCoonnssiiddeerraattiioonnss
Many machine architectures, including many of the more
recent RISC architectures, do not correctly access data at
unaligned locations; their compilers pad out structures to
preserve this characteristic. Many other machines capable
of unaligned references pad inside of structures as well to
preserve alignment, because accessing aligned data is usu-
ally much faster. Because the library and the server use
structures to access data at arbitrary points in a byte
stream, all data in request and reply packets _m_u_s_t be natu-
rally aligned; that is, 16-bit data starts on 16-bit bound-
aries in the request and 32-bit data on 32-bit boundaries.
All requests _m_u_s_t be a multiple of 32 bits in length to pre-
serve the natural alignment in the data stream. You must
pad structures out to 32-bit boundaries. Pad information
does not have to be zeroed unless you want to preserve such
fields for future use in your protocol requests. Floating
point varies radically between machines and should be
avoided completely if at all possible.
664477
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This code may run on machines with 16-bit ints. So, if any
integer argument, variable, or return value either can take
only nonnegative values or is declared as a _C_A_R_D_1_6 in the
protocol, be sure to declare it as _u_n_s_i_g_n_e_d _i_n_t and not as
_i_n_t. (This, of course, does not apply to Booleans or enu-
merations.)
Similarly, if any integer argument or return value is
declared _C_A_R_D_3_2 in the protocol, declare it as an _u_n_s_i_g_n_e_d
_l_o_n_g and not as _i_n_t or _l_o_n_g. This also goes for any inter-
nal variables that may take on values larger than the maxi-
mum 16-bit _u_n_s_i_g_n_e_d _i_n_t.
The library currently assumes that a _c_h_a_r is 8 bits, a _s_h_o_r_t
is 16 bits, an _i_n_t is 16 or 32 bits, and a _l_o_n_g is 32 bits.
The _P_a_c_k_D_a_t_a macro is a half-hearted attempt to deal with
the possibility of 32 bit shorts. However, much more work
is needed to make this work properly.
DDeerriivviinngg tthhee CCoorrrreecctt EExxtteennssiioonn OOppccooddee
The remaining problem a writer of an extension stub proce-
dure faces that the core protocol does not face is to map
from the call to the proper major and minor opcodes. While
there are a number of strategies, the simplest and fastest
is outlined below.
1. Declare an array of pointers, _NFILE long (this is nor-
mally found in <_s_t_d_i_o_._h> and is the number of file
descriptors supported on the system) of type _X_E_x_t_C_o_d_e_s.
Make sure these are all initialized to NULL.
2. When your stub is entered, your initialization test is
just to use the display pointer passed in to access the
file descriptor and an index into the array. If the
entry is NULL, then this is the first time you are
entering the procedure for this display. Call your
initialization procedure and pass to it the display
pointer.
3. Once in your initialization procedure, call _X_I_n_i_t_E_x_t_e_n_-
_s_i_o_n; if it succeeds, store the pointer returned into
this array. Make sure to establish a close display
handler to allow you to zero the entry. Do whatever
other initialization your extension requires. (For
example, install event handlers and so on.) Your ini-
tialization procedure would normally return a pointer
to the _X_E_x_t_C_o_d_e_s structure for this extension, which is
what would normally be found in your array of pointers.
4. After returning from your initialization procedure, the
stub can now continue normally, because it has its
major opcode safely in its hand in the _X_E_x_t_C_o_d_e_s struc-
ture.
664488
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
AAppppeennddiixx DD
CCoommppaattiibbiilliittyy FFuunnccttiioonnss
The X Version 11 and X Version 10 functions discussed in
this appendix are obsolete, have been superseded by newer X
Version 11 functions, and are maintained for compatibility
reasons only.
XX VVeerrssiioonn 1111 CCoommppaattiibbiilliittyy FFuunnccttiioonnss
You can use the X Version 11 compatibility functions to:
· Set standard properties
· Set and get window sizing hints
· Set and get an _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure
· Parse window geometry
· Get X environment defaults
SSeettttiinngg SSttaannddaarrdd PPrrooppeerrttiieess
To specify a minimum set of properties describing the sim-
plest application, use _X_S_e_t_S_t_a_n_d_a_r_d_P_r_o_p_e_r_t_i_e_s. This func-
tion has been superseded by _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and sets all or
portions of the WM_NAME, WM_ICON_NAME, WM_HINTS, WM_COMMAND,
and WM_NORMAL_HINTS properties.
664499
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetStandardProperties(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e, _i_c_o_n___n_a_m_e, _i_c_o_n___p_i_x_m_a_p, _a_r_g_v, _a_r_g_c, _h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
char *_w_i_n_d_o_w___n_a_m_e;
char *_i_c_o_n___n_a_m_e;
Pixmap _i_c_o_n___p_i_x_m_a_p;
char **_a_r_g_v;
int _a_r_g_c;
XSizeHints *_h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_i_n_d_o_w___n_a_m_e
Specifies the window name, which should be a null-
terminated string.
_i_c_o_n___n_a_m_e Specifies the icon name, which should be a null-
terminated string.
_i_c_o_n___p_i_x_m_a_p
Specifies the bitmap that is to be used for the
icon or _N_o_n_e.
_a_r_g_v Specifies the application's argument list.
_a_r_g_c Specifies the number of arguments.
_h_i_n_t_s Specifies a pointer to the size hints for the win-
dow in its normal state.
││__
The _X_S_e_t_S_t_a_n_d_a_r_d_P_r_o_p_e_r_t_i_e_s function provides a means by
which simple applications set the most essential properties
with a single call. _X_S_e_t_S_t_a_n_d_a_r_d_P_r_o_p_e_r_t_i_e_s should be used
to give a window manager some information about your pro-
gram's preferences. It should not be used by applications
that need to communicate more information than is possible
with _X_S_e_t_S_t_a_n_d_a_r_d_P_r_o_p_e_r_t_i_e_s. (Typically, argv is the argv
array of your main program.) If the strings are not in the
Host Portable Character Encoding, the result is implementa-
tion-dependent.
_X_S_e_t_S_t_a_n_d_a_r_d_P_r_o_p_e_r_t_i_e_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w
errors.
SSeettttiinngg aanndd GGeettttiinngg WWiinnddooww SSiizziinngg HHiinnttss
Xlib provides functions that you can use to set or get win-
dow sizing hints. The functions discussed in this section
use the flags and the _X_S_i_z_e_H_i_n_t_s structure, as defined in
665500
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
the <_X_1_1_/_X_u_t_i_l_._h> header file and use the WM_NORMAL_HINTS
property.
To set the size hints for a given window in its normal
state, use _X_S_e_t_N_o_r_m_a_l_H_i_n_t_s. This function has been super-
seded by _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s.
__
││
XSetNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s Specifies a pointer to the size hints for the win-
dow in its normal state.
││__
The _X_S_e_t_N_o_r_m_a_l_H_i_n_t_s function sets the size hints structure
for the specified window. Applications use _X_S_e_t_N_o_r_m_a_l_H_i_n_t_s
to inform the window manager of the size or position desir-
able for that window. In addition, an application that
wants to move or resize itself should call _X_S_e_t_N_o_r_m_a_l_H_i_n_t_s
and specify its new desired location and size as well as
making direct Xlib calls to move or resize. This is because
window managers may ignore redirected configure requests,
but they pay attention to property changes.
To set size hints, an application not only must assign val-
ues to the appropriate members in the hints structure but
also must set the flags member of the structure to indicate
which information is present and where it came from. A call
to _X_S_e_t_N_o_r_m_a_l_H_i_n_t_s is meaningless, unless the flags member
is set to indicate which members of the structure have been
assigned values.
_X_S_e_t_N_o_r_m_a_l_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To return the size hints for a window in its normal state,
use _X_G_e_t_N_o_r_m_a_l_H_i_n_t_s. This function has been superseded by
_X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s.
665511
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s___r_e_t_u_r_n
Returns the size hints for the window in its
normal state.
││__
The _X_G_e_t_N_o_r_m_a_l_H_i_n_t_s function returns the size hints for a
window in its normal state. It returns a nonzero status if
it succeeds or zero if the application specified no normal
size hints for this window.
_X_G_e_t_N_o_r_m_a_l_H_i_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.
The next two functions set and read the WM_ZOOM_HINTS prop-
erty.
To set the zoom hints for a window, use _X_S_e_t_Z_o_o_m_H_i_n_t_s. This
function is no longer supported by the _I_n_t_e_r_-_C_l_i_e_n_t _C_o_m_m_u_n_i_-
_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l.
__
││
XSetZoomHints(_d_i_s_p_l_a_y, _w, _z_h_i_n_t_s)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_z_h_i_n_t_s;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_z_h_i_n_t_s Specifies a pointer to the zoom hints.
││__
Many window managers think of windows in one of three
states: iconic, normal, or zoomed. The _X_S_e_t_Z_o_o_m_H_i_n_t_s func-
tion provides the window manager with information for the
window in the zoomed state.
_X_S_e_t_Z_o_o_m_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
To read the zoom hints for a window, use _X_G_e_t_Z_o_o_m_H_i_n_t_s.
665522
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
This function is no longer supported by the _I_n_t_e_r_-_C_l_i_e_n_t
_C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l.
__
││
Status XGetZoomHints(_d_i_s_p_l_a_y, _w, _z_h_i_n_t_s___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_z_h_i_n_t_s___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_z_h_i_n_t_s___r_e_t_u_r_n
Returns the zoom hints.
││__
The _X_G_e_t_Z_o_o_m_H_i_n_t_s function returns the size hints for a win-
dow in its zoomed state. It returns a nonzero status if it
succeeds or zero if the application specified no zoom size
hints for this window.
_X_G_e_t_Z_o_o_m_H_i_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.
To set the value of any property of type WM_SIZE_HINTS, use
_X_S_e_t_S_i_z_e_H_i_n_t_s. This function has been superseded by _X_S_e_t_W_M_-
_S_i_z_e_H_i_n_t_s.
__
││
XSetSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s Specifies a pointer to the size hints.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_S_e_t_S_i_z_e_H_i_n_t_s function sets the _X_S_i_z_e_H_i_n_t_s structure for
the named property and the specified window. This is used
by _X_S_e_t_N_o_r_m_a_l_H_i_n_t_s and _X_S_e_t_Z_o_o_m_H_i_n_t_s and can be used to set
the value of any property of type WM_SIZE_HINTS. Thus, it
may be useful if other properties of that type get defined.
665533
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_S_e_t_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, and _B_a_d_W_i_n_d_o_w
errors.
To read the value of any property of type WM_SIZE_HINTS, use
_X_G_e_t_S_i_z_e_H_i_n_t_s. This function has been superseded by _X_G_e_t_W_M_-
_S_i_z_e_H_i_n_t_s.
__
││
Status XGetSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s___r_e_t_u_r_n, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XSizeHints *_h_i_n_t_s___r_e_t_u_r_n;
Atom _p_r_o_p_e_r_t_y;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_h_i_n_t_s___r_e_t_u_r_n
Returns the size hints.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_G_e_t_S_i_z_e_H_i_n_t_s function returns the _X_S_i_z_e_H_i_n_t_s structure
for the named property and the specified window. This is
used by _X_G_e_t_N_o_r_m_a_l_H_i_n_t_s and _X_G_e_t_Z_o_o_m_H_i_n_t_s. It also can be
used to retrieve the value of any property of type
WM_SIZE_HINTS. Thus, it may be useful if other properties
of that type get defined. _X_G_e_t_S_i_z_e_H_i_n_t_s returns a nonzero
status if a size hint was defined or zero otherwise.
_X_G_e_t_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
GGeettttiinngg aanndd SSeettttiinngg aann XXSSttaannddaarrddCCoolloorrmmaapp SSttrruuccttuurree
To get the _X_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p structure associated with one
of the described atoms, use _X_G_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p. This
function has been superseded by _X_G_e_t_R_G_B_C_o_l_o_r_m_a_p.
665544
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
Status XGetStandardColormap(_d_i_s_p_l_a_y, _w, _c_o_l_o_r_m_a_p___r_e_t_u_r_n, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XStandardColormap *_c_o_l_o_r_m_a_p___r_e_t_u_r_n;
Atom _p_r_o_p_e_r_t_y; /* RGB_BEST_MAP, etc. */
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_o_l_o_r_m_a_p___r_e_t_u_r_n
Returns the colormap associated with the specified
atom.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_G_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p function returns the colormap defi-
nition associated with the atom supplied as the property
argument. _X_G_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p returns a nonzero status if
successful and zero otherwise. For example, to fetch the
standard _G_r_a_y_S_c_a_l_e colormap for a display, you use _X_G_e_t_S_t_a_n_-
_d_a_r_d_C_o_l_o_r_m_a_p with the following syntax:
__
││
XGetStandardColormap(dpy, DefaultRootWindow(dpy), &cmap, XA_RGB_GRAY_MAP);
││__
See section 14.3 for the semantics of standard colormaps.
_X_G_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w
errors.
To set a standard colormap, use _X_S_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p. This
function has been superseded by _X_S_e_t_R_G_B_C_o_l_o_r_m_a_p.
665555
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XSetStandardColormap(_d_i_s_p_l_a_y, _w, _c_o_l_o_r_m_a_p, _p_r_o_p_e_r_t_y)
Display *_d_i_s_p_l_a_y;
Window _w;
XStandardColormap *_c_o_l_o_r_m_a_p;
Atom _p_r_o_p_e_r_t_y; /* RGB_BEST_MAP, etc. */
_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_c_o_l_o_r_m_a_p Specifies the colormap.
_p_r_o_p_e_r_t_y Specifies the property name.
││__
The _X_S_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p function usually is only used by
window or session managers.
_X_S_e_t_S_t_a_n_d_a_r_d_C_o_l_o_r_m_a_p can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, _B_a_d_-
_D_r_a_w_a_b_l_e, and _B_a_d_W_i_n_d_o_w errors.
PPaarrssiinngg WWiinnddooww GGeeoommeettrryy
To parse window geometry given a user-specified position and
a default position, use _X_G_e_o_m_e_t_r_y. This function has been
superseded by _X_W_M_G_e_o_m_e_t_r_y.
665566
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
int XGeometry(_d_i_s_p_l_a_y, _s_c_r_e_e_n, _p_o_s_i_t_i_o_n, _d_e_f_a_u_l_t___p_o_s_i_t_i_o_n, _b_w_i_d_t_h, _f_w_i_d_t_h, _f_h_e_i_g_h_t, _x_a_d_d_e_r,
_y_a_d_d_e_r, _x___r_e_t_u_r_n, _y___r_e_t_u_r_n, _w_i_d_t_h___r_e_t_u_r_n, _h_e_i_g_h_t___r_e_t_u_r_n)
Display *_d_i_s_p_l_a_y;
int _s_c_r_e_e_n;
char *_p_o_s_i_t_i_o_n, *_d_e_f_a_u_l_t___p_o_s_i_t_i_o_n;
unsigned int _b_w_i_d_t_h;
unsigned int _f_w_i_d_t_h, _f_h_e_i_g_h_t;
int _x_a_d_d_e_r, _y_a_d_d_e_r;
int *_x___r_e_t_u_r_n, *_y___r_e_t_u_r_n;
int *_w_i_d_t_h___r_e_t_u_r_n, *_h_e_i_g_h_t___r_e_t_u_r_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_s_c_r_e_e_n Specifies the screen.
_p_o_s_i_t_i_o_n
_d_e_f_a_u_l_t___p_o_s_i_t_i_o_n
Specify the geometry specifications.
_b_w_i_d_t_h Specifies the border width.
_f_h_e_i_g_h_t
_f_w_i_d_t_h Specify the font height and width in pixels
(increment size).
_x_a_d_d_e_r
_y_a_d_d_e_r Specify additional interior padding needed in the
window.
_x___r_e_t_u_r_n
_y___r_e_t_u_r_n Return the x and y offsets.
_w_i_d_t_h___r_e_t_u_r_n
_h_e_i_g_h_t___r_e_t_u_r_n
Return the width and height determined.
││__
You pass in the border width (bwidth), size of the incre-
ments fwidth and fheight (typically font width and height),
and any additional interior space (xadder and yadder) to
make it easy to compute the resulting size. The _X_G_e_o_m_e_t_r_y
function returns the position the window should be placed
given a position and a default position. _X_G_e_o_m_e_t_r_y deter-
mines the placement of a window using a geometry specifica-
tion as specified by _X_P_a_r_s_e_G_e_o_m_e_t_r_y and the additional
information about the window. Given a fully qualified
default geometry specification and an incomplete geometry
specification, _X_P_a_r_s_e_G_e_o_m_e_t_r_y returns a bitmask value as
defined above in the _X_P_a_r_s_e_G_e_o_m_e_t_r_y call, by using the posi-
tion argument.
665577
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
The returned width and height will be the width and height
specified by default_position as overridden by any user-
specified position. They are not affected by fwidth,
fheight, xadder, or yadder. The x and y coordinates are
computed by using the border width, the screen width and
height, padding as specified by xadder and yadder, and the
fheight and fwidth times the width and height from the geom-
etry specifications.
GGeettttiinngg tthhee XX EEnnvviirroonnmmeenntt DDeeffaauullttss
The _X_G_e_t_D_e_f_a_u_l_t function provides a primitive interface to
the resource manager facilities discussed in chapter 15. It
is only useful in very simple applications.
__
││
char *XGetDefault(_d_i_s_p_l_a_y, _p_r_o_g_r_a_m, _o_p_t_i_o_n)
Display *_d_i_s_p_l_a_y;
char *_p_r_o_g_r_a_m;
char *_o_p_t_i_o_n;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_p_r_o_g_r_a_m Specifies the program name for the Xlib defaults
(usually argv[0] of the main program).
_o_p_t_i_o_n Specifies the option name.
││__
The _X_G_e_t_D_e_f_a_u_l_t function returns the value of the resource
_p_r_o_g._o_p_t_i_o_n, where _p_r_o_g is the program argument with the
directory prefix removed and _o_p_t_i_o_n must be a single compo-
nent. Note that multilevel resources cannot be used with
_X_G_e_t_D_e_f_a_u_l_t. The class "Program.Name" is always used for
the resource lookup. If the specified option name does not
exist for this program, _X_G_e_t_D_e_f_a_u_l_t returns NULL. The
strings returned by _X_G_e_t_D_e_f_a_u_l_t are owned by Xlib and should
not be modified or freed by the client.
If a database has been set with _X_r_m_S_e_t_D_a_t_a_b_a_s_e, that
database is used for the lookup. Otherwise, a database is
created and is set in the display (as if by calling _X_r_m_S_e_t_-
_D_a_t_a_b_a_s_e). The database is created in the current locale.
To create a database, _X_G_e_t_D_e_f_a_u_l_t uses resources from the
RESOURCE_MANAGER property on the root window of screen zero.
If no such property exists, a resource file in the user's
home directory is used. On a POSIX-conformant system, this
file is _$_H_O_M_E_/_._X_d_e_f_a_u_l_t_s. After loading these defaults,
_X_G_e_t_D_e_f_a_u_l_t merges additional defaults specified by the XEN-
VIRONMENT environment variable. If XENVIRONMENT is defined,
it contains a full path name for the additional resource
665588
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
file. If XENVIRONMENT is not defined, _X_G_e_t_D_e_f_a_u_l_t looks for
_$_H_O_M_E_/_._X_d_e_f_a_u_l_t_s_-_n_a_m_e_, _w_h_e_r_e _n_a_m_e _s_p_e_c_i_f_i_e_s _t_h_e _n_a_m_e _o_f _t_h_e
_m_a_c_h_i_n_e _o_n _w_h_i_c_h _t_h_e _a_p_p_l_i_c_a_t_i_o_n _i_s _r_u_n_n_i_n_g_.
XX VVeerrssiioonn 1100 CCoommppaattiibbiilliittyy FFuunnccttiioonnss
You can use the X Version 10 compatibility functions to:
· Draw and fill polygons and curves
· Associate user data with a value
DDrraawwiinngg aanndd FFiilllliinngg PPoollyyggoonnss aanndd CCuurrvveess
Xlib provides functions that you can use to draw or fill
arbitrary polygons or curves. These functions are provided
mainly for compatibility with X Version 10 and have no
server support. That is, they call other Xlib functions,
not the server directly. Thus, if you just have straight
lines to draw, using _X_D_r_a_w_L_i_n_e_s or _X_D_r_a_w_S_e_g_m_e_n_t_s is much
faster.
The functions discussed here provide all the functionality
of the X Version 10 functions _X_D_r_a_w, _X_D_r_a_w_F_i_l_l_e_d, _X_D_r_a_w_P_a_t_-
_t_e_r_n_e_d, _X_D_r_a_w_D_a_s_h_e_d, and _X_D_r_a_w_T_i_l_e_d. They are as compatible
as possible given X Version 11's new line-drawing functions.
One thing to note, however, is that _V_e_r_t_e_x_D_r_a_w_L_a_s_t_P_o_i_n_t is
no longer supported. Also, the error status returned is the
opposite of what it was under X Version 10 (this is the X
Version 11 standard error status). _X_A_p_p_e_n_d_V_e_r_t_e_x and
_X_C_l_e_a_r_V_e_r_t_e_x_F_l_a_g from X Version 10 also are not supported.
Just how the graphics context you use is set up actually
determines whether you get dashes or not, and so on. Lines
are properly joined if they connect and include the closing
of a closed figure (see _X_D_r_a_w_L_i_n_e_s). The functions dis-
cussed here fail (return zero) only if they run out of mem-
ory or are passed a _V_e_r_t_e_x list that has a _V_e_r_t_e_x with _V_e_r_-
_t_e_x_S_t_a_r_t_C_l_o_s_e_d set that is not followed by a _V_e_r_t_e_x with
_V_e_r_t_e_x_E_n_d_C_l_o_s_e_d set.
To achieve the effects of the X Version 10 _X_D_r_a_w, _X_D_r_a_w_-
_D_a_s_h_e_d, and _X_D_r_a_w_P_a_t_t_e_r_n_e_d, use _X_D_r_a_w.
665599
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
#include <X11/X10.h>
Status XDraw(_d_i_s_p_l_a_y, _d, _g_c, _v_l_i_s_t, _v_c_o_u_n_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
Vertex *_v_l_i_s_t;
int _v_c_o_u_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_v_l_i_s_t Specifies a pointer to the list of vertices that
indicate what to draw.
_v_c_o_u_n_t Specifies how many vertices are in vlist.
││__
The _X_D_r_a_w function draws an arbitrary polygon or curve. The
figure drawn is defined by the specified list of vertices
(vlist). The points are connected by lines as specified in
the flags in the vertex structure.
Each Vertex, as defined in <_X_1_1_/_X_1_0_._h>, is a structure with
the following members:
__
││
typedef struct _Vertex {
short x,y;
unsigned short flags;
} Vertex;
││__
The x and y members are the coordinates of the vertex that
are relative to either the upper left inside corner of the
drawable (if _V_e_r_t_e_x_R_e_l_a_t_i_v_e is zero) or the previous vertex
(if _V_e_r_t_e_x_R_e_l_a_t_i_v_e is one).
The flags, as defined in <_X_1_1_/_X_1_0_._h>, are as follows:
666600
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
_V_e_r_t_e_x_R_e_l_a_t_i_v_e 0x0001 /* else abso-
lute */
_V_e_r_t_e_x_D_o_n_t_D_r_a_w 0x0002 /* else draw */
_V_e_r_t_e_x_C_u_r_v_e_d 0x0004 /* else
straight */
_V_e_r_t_e_x_S_t_a_r_t_- 0x0008 /* else not */
_C_l_o_s_e_d
_V_e_r_t_e_x_E_n_d_C_l_o_s_e_d 0x0010 /* else not */
││__
· If _V_e_r_t_e_x_R_e_l_a_t_i_v_e is not set, the coordinates are abso-
lute (that is, relative to the drawable's origin). The
first vertex must be an absolute vertex.
· If _V_e_r_t_e_x_D_o_n_t_D_r_a_w is one, no line or curve is drawn
from the previous vertex to this one. This is analo-
gous to picking up the pen and moving to another place
before drawing another line.
· If _V_e_r_t_e_x_C_u_r_v_e_d is one, a spline algorithm is used to
draw a smooth curve from the previous vertex through
this one to the next vertex. Otherwise, a straight
line is drawn from the previous vertex to this one. It
makes sense to set _V_e_r_t_e_x_C_u_r_v_e_d to one only if a previ-
ous and next vertex are both defined (either explicitly
in the array or through the definition of a closed
curve).
· It is permissible for _V_e_r_t_e_x_D_o_n_t_D_r_a_w bits and _V_e_r_t_e_x_-
_C_u_r_v_e_d bits both to be one. This is useful if you want
to define the previous point for the smooth curve but
do not want an actual curve drawing to start until this
point.
· If _V_e_r_t_e_x_S_t_a_r_t_C_l_o_s_e_d is one, then this point marks the
beginning of a closed curve. This vertex must be fol-
lowed later in the array by another vertex whose effec-
tive coordinates are identical and that has a _V_e_r_t_e_x_-
_E_n_d_C_l_o_s_e_d bit of one. The points in between form a
cycle to determine predecessor and successor vertices
for the spline algorithm.
This function uses 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. It also uses these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-ori-
gin, tile-stipple-y-origin, dash-offset, and dash-list.
To achieve the effects of the X Version 10 _X_D_r_a_w_T_i_l_e_d and
666611
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
_X_D_r_a_w_F_i_l_l_e_d, use _X_D_r_a_w_F_i_l_l_e_d.
__
││
#include <X11/X10.h>
Status XDrawFilled(_d_i_s_p_l_a_y, _d, _g_c, _v_l_i_s_t, _v_c_o_u_n_t)
Display *_d_i_s_p_l_a_y;
Drawable _d;
GC _g_c;
Vertex *_v_l_i_s_t;
int _v_c_o_u_n_t;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_d Specifies the drawable.
_g_c Specifies the GC.
_v_l_i_s_t Specifies a pointer to the list of vertices that
indicate what to draw.
_v_c_o_u_n_t Specifies how many vertices are in vlist.
││__
The _X_D_r_a_w_F_i_l_l_e_d function draws arbitrary polygons or curves
and then fills them.
This function uses 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. It also uses these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-ori-
gin, tile-stipple-y-origin, dash-offset, dash-list, fill-
style, and fill-rule.
AAssssoocciiaattiinngg UUsseerr DDaattaa wwiitthh aa VVaalluuee
These functions have been superseded by the context manage-
ment functions (see section 16.10). It is often necessary
to associate arbitrary information with resource IDs. Xlib
provides the _X_A_s_s_o_c_T_a_b_l_e functions that you can use to make
such an association. Application programs often need to be
able to easily refer to their own data structures when an
event arrives. The _X_A_s_s_o_c_T_a_b_l_e system provides users of the
X library with a method for associating their own data
structures with X resources (_P_i_x_m_a_p_s, _F_o_n_t_s, _W_i_n_d_o_w_s, and so
on).
An _X_A_s_s_o_c_T_a_b_l_e can be used to type X resources. For exam-
ple, the user may want to have three or four types of win-
dows, each with different properties. This can be accom-
plished by associating each X window ID with a pointer to a
window property data structure defined by the user. A
666622
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
generic type has been defined in the X library for resource
IDs. It is called an XID.
There are a few guidelines that should be observed when
using an _X_A_s_s_o_c_T_a_b_l_e:
· All XIDs are relative to the specified display.
· Because of the hashing scheme used by the asso-
ciation mechanism, the following rules for determining
the size of a _X_A_s_s_o_c_T_a_b_l_e should be followed. Associa-
tions will be made and looked up more efficiently
if the table size (number of buckets in the hash-
ing system) is a power of two and if there are not more
than 8 XIDs per bucket.
To return a pointer to a new _X_A_s_s_o_c_T_a_b_l_e, use _X_C_r_e_a_t_e_A_s_-
_s_o_c_T_a_b_l_e.
__
││
XAssocTable *XCreateAssocTable(_s_i_z_e)
int _s_i_z_e;
_s_i_z_e Specifies the number of buckets in the hash system
of _X_A_s_s_o_c_T_a_b_l_e.
││__
The size argument specifies the number of buckets in the
hash system of _X_A_s_s_o_c_T_a_b_l_e. For reasons of efficiency
the number of buckets should be a power of two. Some size
suggestions might be: use 32 buckets per 100 objects,
and a reasonable maximum number of objects per buckets is 8.
If an error allocating memory for the _X_A_s_s_o_c_T_a_b_l_e
occurs, a NULL pointer is returned.
To create an entry in a given _X_A_s_s_o_c_T_a_b_l_e, use _X_M_a_k_e_A_s_s_o_c.
666633
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XMakeAssoc(_d_i_s_p_l_a_y, _t_a_b_l_e, _x___i_d, _d_a_t_a)
Display *_d_i_s_p_l_a_y;
XAssocTable *_t_a_b_l_e;
XID _x___i_d;
char *_d_a_t_a;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_a_b_l_e Specifies the assoc table.
_x___i_d Specifies the X resource ID.
_d_a_t_a Specifies the data to be associated with the X
resource ID.
││__
The _X_M_a_k_e_A_s_s_o_c function inserts data into an _X_A_s_s_o_c_T_a_b_l_e
keyed on an XID. Data is inserted into the table only once.
Redundant inserts are ignored. The queue in each associa-
tion bucket is sorted from the lowest XID to the highest
XID.
To obtain data from a given _X_A_s_s_o_c_T_a_b_l_e, use _X_L_o_o_k_U_p_A_s_s_o_c.
__
││
char *XLookUpAssoc(_d_i_s_p_l_a_y, _t_a_b_l_e, _x___i_d)
Display *_d_i_s_p_l_a_y;
XAssocTable *_t_a_b_l_e;
XID _x___i_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_a_b_l_e Specifies the assoc table.
_x___i_d Specifies the X resource ID.
││__
The _X_L_o_o_k_U_p_A_s_s_o_c function retrieves the data stored in an
_X_A_s_s_o_c_T_a_b_l_e by its XID. If an appropriately matching XID
can be found in the table, _X_L_o_o_k_U_p_A_s_s_o_c returns the data
associated with it. If the x_id cannot be found in the ta-
ble, it returns NULL.
To delete an entry from a given _X_A_s_s_o_c_T_a_b_l_e, use _X_D_e_l_e_t_e_A_s_-
_s_o_c.
666644
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
__
││
XDeleteAssoc(_d_i_s_p_l_a_y, _t_a_b_l_e, _x___i_d)
Display *_d_i_s_p_l_a_y;
XAssocTable *_t_a_b_l_e;
XID _x___i_d;
_d_i_s_p_l_a_y Specifies the connection to the X server.
_t_a_b_l_e Specifies the assoc table.
_x___i_d Specifies the X resource ID.
││__
The _X_D_e_l_e_t_e_A_s_s_o_c function deletes an association in an _X_A_s_-
_s_o_c_T_a_b_l_e keyed on its XID. Redundant deletes (and deletes
of nonexistent XIDs) are ignored. Deleting associations in
no way impairs the performance of an _X_A_s_s_o_c_T_a_b_l_e.
To free the memory associated with a given _X_A_s_s_o_c_T_a_b_l_e, use
_X_D_e_s_t_r_o_y_A_s_s_o_c_T_a_b_l_e.
__
││
XDestroyAssocTable(_t_a_b_l_e)
XAssocTable *_t_a_b_l_e;
_t_a_b_l_e Specifies the assoc table.
││__
666655
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
GGlloossssaarryy
AAcccceessss ccoonnttrrooll lliisstt
X maintains a list of hosts from which client programs
can be run. By default, only programs on the local
host and hosts specified in an initial list read by the
server can use the display. This access control list
can be changed by clients on the local host. Some
server implementations can also implement other autho-
rization mechanisms in addition to or in place of this
mechanism. The action of this mechanism can be condi-
tional based on the authorization protocol name and
data received by the server at connection setup.
AAccttiivvee ggrraabb
A grab is active when the pointer or keyboard is actu-
ally owned by the single grabbing client.
AAnncceessttoorrss
If W is an inferior of A, then A is an ancestor of W.
AAttoomm
An atom is a unique ID corresponding to a string name.
Atoms are used to identify properties, types, and
selections.
BBaacckkggrroouunndd
An _I_n_p_u_t_O_u_t_p_u_t window can have a background, which is
defined as a pixmap. When regions of the window have
their contents lost or invalidated, the server automat-
ically tiles those regions with the background.
BBaacckkiinngg ssttoorree
When a server maintains the contents of a window, the
pixels saved off-screen are known as a backing store.
666666
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
BBaassee ffoonntt nnaammee
A font name used to select a family of fonts whose mem-
bers may be encoded in various charsets. The _C_h_a_r_S_e_-
_t_R_e_g_i_s_t_r_y and _C_h_a_r_S_e_t_E_n_c_o_d_i_n_g fields of an XLFD name
identify the charset of the font. A base font name may
be a full XLFD name, with all fourteen '-' delimiters,
or an abbreviated XLFD name containing only the first
12 fields of an XLFD name, up to but not including
_C_h_a_r_S_e_t_R_e_g_i_s_t_r_y, with or without the thirteenth '-', or
a non-XLFD name. Any XLFD fields may contain wild
cards.
When creating an _X_F_o_n_t_S_e_t, Xlib accepts from the client
a list of one or more base font names which select one
or more font families. They are combined with charset
names obtained from the encoding of the locale to load
the fonts required to render text.
BBiitt ggrraavviittyy
When a window is resized, the contents of the window
are not necessarily discarded. It is possible to
request that the server relocate the previous contents
to some region of the window (though no guarantees are
made). This attraction of window contents for some
location of a window is known as bit gravity.
BBiitt ppllaannee
When a pixmap or window is thought of as a stack of
bitmaps, each bitmap is called a bit plane or plane.
BBiittmmaapp
A bitmap is a pixmap of depth one.
BBoorrddeerr
An _I_n_p_u_t_O_u_t_p_u_t window can have a border of equal thick-
ness on all four sides of the window. The contents of
the border are defined by a pixmap, and the server
automatically maintains the contents of the border.
Exposure events are never generated for border regions.
BBuuttttoonn ggrraabbbbiinngg
Buttons on the pointer can be passively grabbed by a
client. When the button is pressed, the pointer is
then actively grabbed by the client.
666677
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
BByyttee oorrddeerr
For image (pixmap/bitmap) data, the server defines the
byte order, and clients with different native byte
ordering must swap bytes as necessary. For all other
parts of the protocol, the client defines the byte
order, and the server swaps bytes as necessary.
CChhaarraacctteerr
A member of a set of elements used for the organiza-
tion, control, or representation of text (ISO2022, as
adapted by XPG3). Note that in ISO2022 terms, a char-
acter is not bound to a coded value until it is identi-
fied as part of a coded character set.
CChhaarraacctteerr ggllyypphh
The abstract graphical symbol for a character. Charac-
ter glyphs may or may not map one-to-one to font
glyphs, and may be context-dependent, varying with the
adjacent characters. Multiple characters may map to a
single character glyph.
CChhaarraacctteerr sseett
A collection of characters.
CChhaarrsseett
An encoding with a uniform, state-independent mapping
from characters to codepoints. A coded character set.
For display in X, there can be a direct mapping from a
charset to one font, if the width of all characters in
the charset is either one or two bytes. A text string
encoded in an encoding such as Shift-JIS cannot be
passed directly to the X server, because the text imag-
ing requests accept only single-width charsets (either
8 or 16 bits). Charsets which meet these restrictions
can serve as ``font charsets''. Font charsets strictly
speaking map font indices to font glyphs, not charac-
ters to character glyphs.
Note that a single font charset is sometimes used as
the encoding of a locale, for example, ISO8859-1.
CChhiillddrreenn
The children of a window are its first-level subwin-
dows.
666688
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CCllaassss
Windows can be of different classes or types. See the
entries for _I_n_p_u_t_O_n_l_y and _I_n_p_u_t_O_u_t_p_u_t windows for fur-
ther information about valid window types.
CClliieenntt
An application program connects to the window system
server by some interprocess communication (IPC) path,
such as a TCP connection or a shared memory buffer.
This program is referred to as a client of the window
system server. More precisely, the client is the IPC
path itself. A program with multiple paths open to the
server is viewed as multiple clients by the protocol.
Resource lifetimes are controlled by connection life-
times, not by program lifetimes.
CClliippppiinngg rreeggiioonn
In a graphics context, a bitmap or list of rectangles
can be specified to restrict output to a particular
region of the window. The image defined by the bitmap
or rectangles is called a clipping region.
CCooddeedd cchhaarraacctteerr
A character bound to a codepoint.
CCooddeedd cchhaarraacctteerr sseett
A set of unambiguous rules that establishes a character
set and the one-to-one relationship between each char-
acter of the set and its bit representation. (ISO2022,
as adapted by XPG3) A definition of a one-to-one map-
ping of a set of characters to a set of codepoints.
CCooddeeppooiinntt
The coded representation of a single character in a
coded character set.
CCoolloorrmmaapp
A colormap consists of a set of entries defining color
values. The colormap associated with a window is used
to display the contents of the window; each pixel value
indexes the colormap to produce an RGB value that
drives the guns of a monitor. Depending on hardware
limitations, one or more colormaps can be installed at
one time so that windows associated with those maps
display with true colors.
666699
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
CCoonnnneeccttiioonn
The IPC path between the server and client program is
known as a connection. A client program typically (but
not necessarily) has one connection to the server over
which requests and events are sent.
CCoonnttaaiinnmmeenntt
A window contains the pointer if the window is viewable
and the hotspot of the cursor is within a visible
region of the window or a visible region of one of its
inferiors. The border of the window is included as
part of the window for containment. The pointer is in
a window if the window contains the pointer but no
inferior contains the pointer.
CCoooorrddiinnaattee ssyysstteemm
The coordinate system has X horizontal and Y vertical,
with the origin [0, 0] at the upper left. Coordinates
are integral and coincide with pixel centers. Each
window and pixmap has its own coordinate system. For a
window, the origin is inside the border at the inside
upper-left corner.
CCuurrssoorr
A cursor is the visible shape of the pointer on a
screen. It consists of a hotspot, a source bitmap, a
shape bitmap, and a pair of colors. The cursor defined
for a window controls the visible appearance when the
pointer is in that window.
DDeepptthh
The depth of a window or pixmap is the number of bits
per pixel it has. The depth of a graphics context is
the depth of the drawables it can be used in conjunc-
tion with graphics output.
DDeevviiccee
Keyboards, mice, tablets, track-balls, button boxes,
and so on are all collectively known as input devices.
Pointers can have one or more buttons (the most common
number is three). The core protocol only deals with
two devices: the keyboard and the pointer.
667700
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
DDiirreeccttCCoolloorr
_D_i_r_e_c_t_C_o_l_o_r is a class of colormap in which a pixel
value is decomposed into three separate subfields for
indexing. The first subfield indexes an array to pro-
duce red intensity values. The second subfield indexes
a second array to produce blue intensity values. The
third subfield indexes a third array to produce green
intensity values. The RGB (red, green, and blue) val-
ues in the colormap entry can be changed dynamically.
DDiissppllaayy
A server, together with its screens and input devices,
is called a display. The Xlib _D_i_s_p_l_a_y structure con-
tains all information about the particular display and
its screens as well as the state that Xlib needs to
communicate with the display over a particular connec-
tion.
DDrraawwaabbllee
Both windows and pixmaps can be used as sources and
destinations in graphics operations. These windows and
pixmaps are collectively known as drawables. However,
an _I_n_p_u_t_O_n_l_y window cannot be used as a source or des-
tination in a graphics operation.
EEnnccooddiinngg
A set of unambiguous rules that establishes a character
set and a relationship between the characters and their
representations. The character set does not have to be
fixed to a finite pre-defined set of characters. The
representations do not have to be of uniform length.
Examples are an ISO2022 graphic set, a state-indepen-
dent or state-dependent combination of graphic sets,
possibly including control sets, and the X Compound
Text encoding.
In X, encodings are identified by a string which
appears as: the _C_h_a_r_S_e_t_R_e_g_i_s_t_r_y and _C_h_a_r_S_e_t_E_n_c_o_d_i_n_g
components of an XLFD name; the name of a charset of
the locale for which a font could not be found; or an
atom which identifies the encoding of a text property
or which names an encoding for a text selection target
type. Encoding names should be composed of characters
from the X Portable Character Set.
667711
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
EEssccaappeemmeenntt
The escapement of a string is the distance in pixels in
the primary draw direction from the drawing origin to
the origin of the next character (that is, the one fol-
lowing the given string) to be drawn.
EEvveenntt
Clients are informed of information asynchronously by
means of events. These events can be either asyn-
chronously generated from devices or generated as side
effects of client requests. Events are grouped into
types. The server never sends an event to a client
unless the client has specifically asked to be informed
of that type of event. However, clients can force
events to be sent to other clients. Events are typi-
cally reported relative to a window.
EEvveenntt mmaasskk
Events are requested relative to a window. The set of
event types a client requests relative to a window is
described by using an event mask.
EEvveenntt pprrooppaaggaattiioonn
Device-related events propagate from the source window
to ancestor windows until some client has expressed
interest in handling that type of event or until the
event is discarded explicitly.
EEvveenntt ssoouurrccee
The deepest viewable window that the pointer is in is
called the source of a device-related event.
EEvveenntt ssyynncchhrroonniizzaattiioonn
There are certain race conditions possible when demul-
tiplexing device events to clients (in particular,
deciding where pointer and keyboard events should be
sent when in the middle of window management opera-
tions). The event synchronization mechanism allows
synchronous processing of device events.
EExxppoossuurree eevveenntt
Servers do not guarantee to preserve the contents of
windows when windows are obscured or reconfigured.
Exposure events are sent to clients to inform them when
contents of regions of windows have been lost.
667722
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
EExxtteennssiioonn
Named extensions to the core protocol can be defined to
extend the system. Extensions to output requests,
resources, and event types are all possible and
expected.
FFoonntt
A font is an array of glyphs (typically characters).
The protocol does no translation or interpretation of
character sets. The client simply indicates values
used to index the glyph array. A font contains addi-
tional metric information to determine interglyph and
interline spacing.
FFoonntt ggllyypphh
The abstract graphical symbol for an index into a font.
FFrroozzeenn eevveennttss
Clients can freeze event processing during keyboard and
pointer grabs.
GGCC
GC is an abbreviation for graphics context. See GGrraapphh--
iiccss ccoonntteexxtt.
GGllyypphh
An identified abstract graphical symbol independent of
any actual image. (ISO/IEC/DIS 9541-1) An abstract
visual representation of a graphic character, not bound
to a codepoint.
GGllyypphh iimmaaggee
An image of a glyph, as obtained from a glyph represen-
tation displayed on a presentation surface.
(ISO/IEC/DIS 9541-1)
GGrraabb
Keyboard keys, the keyboard, pointer buttons, the
pointer, and the server can be grabbed for exclusive
use by a client. In general, these facilities are not
intended to be used by normal applications but are
intended for various input and window managers to
implement various styles of user interfaces.
667733
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
GGrraapphhiiccss ccoonntteexxtt
Various information for graphics output is stored in a
graphics context (GC), such as foreground pixel, back-
ground pixel, line width, clipping region, and so on.
A graphics context can only be used with drawables that
have the same root and the same depth as the graphics
context.
GGrraavviittyy
The contents of windows and windows themselves have a
gravity, which determines how the contents move when a
window is resized. See BBiitt ggrraavviittyy and WWiinnddooww ggrraavviittyy.
GGrraayySSccaallee
_G_r_a_y_S_c_a_l_e can be viewed as a degenerate case of _P_s_e_u_d_o_-
_C_o_l_o_r, in which the red, green, and blue values in any
given colormap entry are equal and thus, produce shades
of gray. The gray values can be changed dynamically.
HHoosstt PPoorrttaabbllee CChhaarraacctteerr EEnnccooddiinngg
The encoding of the X Portable Character Set on the
host. The encoding itself is not defined by this stan-
dard, but the encoding must be the same in all locales
supported by Xlib on the host. If a string is said to
be in the Host Portable Character Encoding, then it
only contains characters from the X Portable Character
Set, in the host encoding.
HHoottssppoott
A cursor has an associated hotspot, which defines the
point in the cursor corresponding to the coordinates
reported for the pointer.
IIddeennttiiffiieerr
An identifier is a unique value associated with a
resource that clients use to name that resource. The
identifier can be used over any connection to name the
resource.
IInnffeerriioorrss
The inferiors of a window are all of the subwindows
nested below it: the children, the children's children,
and so on.
667744
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
IInnppuutt ffooccuuss
The input focus is usually a window defining the scope
for processing of keyboard input. If a generated key-
board event usually would be reported to this window or
one of its inferiors, the event is reported as usual.
Otherwise, the event is reported with respect to the
focus window. The input focus also can be set such
that all keyboard events are discarded and such that
the focus window is dynamically taken to be the root
window of whatever screen the pointer is on at each
keyboard event.
IInnppuutt mmaannaaggeerr
Control over keyboard input is typically provided by an
input manager client, which usually is part of a window
manager.
IInnppuuttOOnnllyy wwiinnddooww
An _I_n_p_u_t_O_n_l_y window is a window that cannot be used for
graphics requests. _I_n_p_u_t_O_n_l_y windows are invisible and
are used to control such things as cursors, input event
generation, and grabbing. _I_n_p_u_t_O_n_l_y windows cannot
have _I_n_p_u_t_O_u_t_p_u_t windows as inferiors.
IInnppuuttOOuuttppuutt wwiinnddooww
An _I_n_p_u_t_O_u_t_p_u_t window is the normal kind of window that
is used for both input and output. _I_n_p_u_t_O_u_t_p_u_t windows
can have both _I_n_p_u_t_O_u_t_p_u_t and _I_n_p_u_t_O_n_l_y windows as
inferiors.
IInntteerrnnaattiioonnaalliizzaattiioonn
The process of making software adaptable to the
requirements of different native languages, local cus-
toms, and character string encodings. Making a com-
puter program adaptable to different locales without
program source modifications or recompilation.
IISSOO22002222
ISO standard for code extension techniques for 7-bit
and 8-bit coded character sets.
KKeeyy ggrraabbbbiinngg
Keys on the keyboard can be passively grabbed by a
client. When the key is pressed, the keyboard is then
actively grabbed by the client.
667755
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
KKeeyybbooaarrdd ggrraabbbbiinngg
A client can actively grab control of the keyboard, and
key events will be sent to that client rather than the
client the events would normally have been sent to.
KKeeyyssyymm
An encoding of a symbol on a keycap on a keyboard.
LLaattiinn--11
The coded character set defined by the ISO8859-1 stan-
dard.
LLaattiinn PPoorrttaabbllee CChhaarraacctteerr EEnnccooddiinngg
The encoding of the X Portable Character Set using the
Latin-1 codepoints plus ASCII control characters. If a
string is said to be in the Latin Portable Character
Encoding, then it only contains characters from the X
Portable Character Set, not all of Latin-1.
LLooccaallee
The international environment of a computer program
defining the ``localized'' behavior of that program at
run-time. This information can be established from one
or more sets of localization data. ANSI C defines
locale-specific processing by C system library calls.
See ANSI C and the X/Open Portability Guide specifica-
tions for more details. In this specification, on
implementations that conform to the ANSI C library, the
``current locale'' is the current setting of the
LC_CTYPE _s_e_t_l_o_c_a_l_e category. Associated with each
locale is a text encoding. When text is processed in
the context of a locale, the text must be in the encod-
ing of the locale. The current locale affects Xlib in
its:
· Encoding and processing of input method text
· Encoding of resource files and values
· Encoding and imaging of text strings
· Encoding and decoding for inter-client text commu-
nication
667766
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
LLooccaallee nnaammee
The identifier used to select the desired locale for
the host C library and X library functions. On ANSI C
library compliant systems, the locale argument to the
_s_e_t_l_o_c_a_l_e function.
LLooccaalliizzaattiioonn
The process of establishing information within a com-
puter system specific to the operation of particular
native languages, local customs and coded character
sets. (XPG3)
MMaappppeedd
A window is said to be mapped if a map call has been
performed on it. Unmapped windows and their inferiors
are never viewable or visible.
MMooddiiffiieerr kkeeyyss
Shift, Control, Meta, Super, Hyper, Alt, Compose,
Apple, CapsLock, ShiftLock, and similar keys are called
modifier keys.
MMoonnoocchhrroommee
Monochrome is a special case of _S_t_a_t_i_c_G_r_a_y in which
there are only two colormap entries.
MMuullttiibbyyttee
A character whose codepoint is stored in more than one
byte; any encoding which can contain multibyte charac-
ters; text in a multibyte encoding. The ``char *''
null-terminated string datatype in ANSI C. Note that
references in this document to multibyte strings imply
only that the strings _m_a_y contain multibyte characters.
OObbssccuurree
A window is obscured if some other window obscures it.
A window can be partially obscured and so still have
visible regions. Window A obscures window B if both
are viewable _I_n_p_u_t_O_u_t_p_u_t windows, if A is higher in the
global stacking order, and if the rectangle defined by
the outside edges of A intersects the rectangle defined
by the outside edges of B. Note the distinction
between obscures and occludes. Also note that window
borders are included in the calculation.
667777
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
OOcccclluuddee
A window is occluded if some other window occludes it.
Window A occludes window B if both are mapped, if A is
higher in the global stacking order, and if the rectan-
gle defined by the outside edges of A intersects the
rectangle defined by the outside edges of B. Note the
distinction between occludes and obscures. Also note
that window borders are included in the calculation and
that _I_n_p_u_t_O_n_l_y windows never obscure other windows but
can occlude other windows.
PPaaddddiinngg
Some padding bytes are inserted in the data stream to
maintain alignment of the protocol requests on natural
boundaries. This increases ease of portability to some
machine architectures.
PPaarreenntt wwiinnddooww
If C is a child of P, then P is the parent of C.
PPaassssiivvee ggrraabb
Grabbing a key or button is a passive grab. The grab
activates when the key or button is actually pressed.
PPiixxeell vvaalluuee
A pixel is an N-bit value, where N is the number of bit
planes used in a particular window or pixmap (that is,
is the depth of the window or pixmap). A pixel in a
window indexes a colormap to derive an actual color to
be displayed.
PPiixxmmaapp
A pixmap is a three-dimensional array of bits. A
pixmap is normally thought of as a two-dimensional
array of pixels, where each pixel can be a value from 0
to 2_N-1, and where N is the depth (z axis) of the
pixmap. A pixmap can also be thought of as a stack of
N bitmaps. A pixmap can only be used on the screen
that it was created in.
PPllaannee
When a pixmap or window is thought of as a stack of
bitmaps, each bitmap is called a plane or bit plane.
667788
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
PPllaannee mmaasskk
Graphics operations can be restricted to only affect a
subset of bit planes of a destination. A plane mask is
a bit mask describing which planes are to be modified.
The plane mask is stored in a graphics context.
PPooiinntteerr
The pointer is the pointing device currently attached
to the cursor and tracked on the screens.
PPooiinntteerr ggrraabbbbiinngg
A client can actively grab control of the pointer.
Then button and motion events will be sent to that
client rather than the client the events would normally
have been sent to.
PPooiinnttiinngg ddeevviiccee
A pointing device is typically a mouse, tablet, or some
other device with effective dimensional motion. The
core protocol defines only one visible cursor, which
tracks whatever pointing device is attached as the
pointer.
PPOOSSIIXX
Portable Operating System Interface, ISO/IEC 9945-1
(IEEE Std 1003.1).
PPOOSSIIXX PPoorrttaabbllee FFiilleennaammee CChhaarraacctteerr SSeett
The set of 65 characters which can be used in naming
files on a POSIX-compliant host that are correctly pro-
cessed in all locales. The set is:
a..z A..Z 0..9 ._-
PPrrooppeerrttyy
Windows can have associated properties that consist of
a name, a type, a data format, and some data. The pro-
tocol places no interpretation on properties. They are
intended as a general-purpose naming mechanism for
clients. For example, clients might use properties to
share information such as resize hints, program names,
and icon formats with a window manager.
667799
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
PPrrooppeerrttyy lliisstt
The property list of a window is the list of properties
that have been defined for the window.
PPsseeuuddooCCoolloorr
_P_s_e_u_d_o_C_o_l_o_r is a class of colormap in which a pixel
value indexes the colormap entry to produce an indepen-
dent RGB value; that is, the colormap is viewed as an
array of triples (RGB values). The RGB values can be
changed dynamically.
RReeccttaannggllee
A rectangle specified by [x,y,w,h] has an infinitely
thin outline path with corners at [x,y], [x+w,y],
[x+w,y+h], and [x, y+h]. When a rectangle is filled,
the lower-right edges are not drawn. For example, if
w=h=0, nothing would be drawn. For w=h=1, a single
pixel would be drawn.
RReeddiirreeccttiinngg ccoonnttrrooll
Window managers (or client programs) may enforce window
layout policy in various ways. When a client attempts
to change the size or position of a window, the opera-
tion may be redirected to a specified client rather
than the operation actually being performed.
RReeppllyy
Information requested by a client program using the X
protocol is sent back to the client with a reply. Both
events and replies are multiplexed on the same connec-
tion. Most requests do not generate replies, but some
requests generate multiple replies.
RReeqquueesstt
A command to the server is called a request. It is a
single block of data sent over a connection.
RReessoouurrccee
Windows, pixmaps, cursors, fonts, graphics contexts,
and colormaps are known as resources. They all have
unique identifiers associated with them for naming pur-
poses. The lifetime of a resource usually is bounded
by the lifetime of the connection over which the
resource was created.
668800
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
RRGGBB vvaalluueess
RGB values are the red, green, and blue intensity val-
ues that are used to define a color. These values are
always represented as 16-bit, unsigned numbers, with 0
the minimum intensity and 65535 the maximum intensity.
The X server scales these values to match the display
hardware.
RRoooott
The root of a pixmap or graphics context is the same as
the root of whatever drawable was used when the pixmap
or GC was created. The root of a window is the root
window under which the window was created.
RRoooott wwiinnddooww
Each screen has a root window covering it. The root
window cannot be reconfigured or unmapped, but other-
wise it acts as a full-fledged window. A root window
has no parent.
SSaavvee sseett
The save set of a client is a list of other clients'
windows that, if they are inferiors of one of the
client's windows at connection close, should not be
destroyed and that should be remapped if currently
unmapped. Save sets are typically used by window man-
agers to avoid lost windows if the manager should ter-
minate abnormally.
SSccaannlliinnee
A scanline is a list of pixel or bit values viewed as a
horizontal row (all values having the same y coordi-
nate) of an image, with the values ordered by increas-
ing the x coordinate.
SSccaannlliinnee oorrddeerr
An image represented in scanline order contains scan-
lines ordered by increasing the y coordinate.
SSccrreeeenn
A server can provide several independent screens, which
typically have physically independent monitors. This
would be the expected configuration when there is only
a single keyboard and pointer shared among the screens.
A _S_c_r_e_e_n structure contains the information about that
screen and is linked to the _D_i_s_p_l_a_y structure.
668811
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
SSeelleeccttiioonn
A selection can be thought of as an indirect property
with dynamic type. That is, rather than having the
property stored in the X server, it is maintained by
some client (the owner). A selection is global and is
thought of as belonging to the user and being main-
tained by clients, rather than being private to a par-
ticular window subhierarchy or a particular set of
clients. When a client asks for the contents of a
selection, it specifies a selection target type, which
can be used to control the transmitted representation
of the contents. For example, if the selection is
``the last thing the user clicked on,'' and that is
currently an image, then the target type might specify
whether the contents of the image should be sent in XY
format or Z format.
The target type can also be used to control the class
of contents transmitted; for example, asking for the
``looks'' (fonts, line spacing, indentation, and so
forth) of a paragraph selection, rather than the text
of the paragraph. The target type can also be used for
other purposes. The protocol does not constrain the
semantics.
SSeerrvveerr
The server, which is also referred to as the X server,
provides the basic windowing mechanism. It handles IPC
connections from clients, multiplexes graphics requests
onto the screens, and demultiplexes input back to the
appropriate clients.
SSeerrvveerr ggrraabbbbiinngg
The server can be grabbed by a single client for exclu-
sive use. This prevents processing of any requests
from other client connections until the grab is com-
pleted. This is typically only a transient state for
such things as rubber-banding, pop-up menus, or execut-
ing requests indivisibly.
SShhiifftt sseeqquueennccee
ISO2022 defines control characters and escape sequences
which temporarily (single shift) or permanently (lock-
ing shift) cause a different character set to be in
effect (``invoking'' a character set).
668822
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
SSiibblliinngg
Children of the same parent window are known as sibling
windows.
SSttaacckkiinngg oorrddeerr
Sibling windows, similar to sheets of paper on a desk,
can stack on top of each other. Windows above both
obscure and occlude lower windows. The relationship
between sibling windows is known as the stacking order.
SSttaattee--ddeeppeennddeenntt eennccooddiinngg
An encoding in which an invocation of a charset can
apply to multiple characters in sequence. A state-
dependent encoding begins in an ``initial state'' and
enters other ``shift states'' when specific ``shift
sequences'' are encountered in the byte sequence. In
ISO2022 terms, this means use of locking shifts, not
single shifts.
SSttaattee--iinnddeeppeennddeenntt eennccooddiinngg
Any encoding in which the invocations of the charsets
are fixed, or span only a single character. In ISO2022
terms, this means use of at most single shifts, not
locking shifts.
SSttaattiiccCCoolloorr
_S_t_a_t_i_c_C_o_l_o_r can be viewed as a degenerate case of _P_s_e_u_-
_d_o_C_o_l_o_r in which the RGB values are predefined and
read-only.
SSttaattiiccGGrraayy
_S_t_a_t_i_c_G_r_a_y can be viewed as a degenerate case of
_G_r_a_y_S_c_a_l_e in which the gray values are predefined and
read-only. The values are typically linear or near-
linear increasing ramps.
SSttaattuuss
Many Xlib functions return a success status. If the
function does not succeed, however, its arguments are
not disturbed.
SSttiippppllee
A stipple pattern is a bitmap that is used to tile a
region to serve as an additional clip mask for a fill
operation with the foreground color.
668833
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
SSTTRRIINNGG eennccooddiinngg
Latin-1, plus tab and newline.
SSttrriinngg EEqquuiivvaalleennccee
Two ISO Latin-1 STRING8 values are considered equal if
they are the same length and if corresponding bytes are
either equal or are equivalent as follows: decimal
values 65 to 90 inclusive (characters ``A'' to ``Z'')
are pairwise equivalent to decimal values 97 to 122
inclusive (characters ``a'' to ``z''), decimal values
192 to 214 inclusive (characters ``A grave'' to ``O
diaeresis'') are pairwise equivalent to decimal values
224 to 246 inclusive (characters ``a grave'' to ``o
diaeresis''), and decimal values 216 to 222 inclusive
(characters ``O oblique'' to ``THORN'') are pairwise
equivalent to decimal values 246 to 254 inclusive
(characters ``o oblique'' to ``thorn'').
TTiillee
A pixmap can be replicated in two dimensions to tile a
region. The pixmap itself is also known as a tile.
TTiimmeessttaammpp
A timestamp is a time value expressed in milliseconds.
It is typically the time since the last server reset.
Timestamp values wrap around (after about 49.7 days).
The server, given its current time is represented by
timestamp T, always interprets timestamps from clients
by treating half of the timestamp space as being ear-
lier in time than T and half of the timestamp space as
being later in time than T. One timestamp value, rep-
resented by the constant _C_u_r_r_e_n_t_T_i_m_e, is never gener-
ated by the server. This value is reserved for use in
requests to represent the current server time.
TTrruueeCCoolloorr
_T_r_u_e_C_o_l_o_r can be viewed as a degenerate case of _D_i_r_e_c_t_-
_C_o_l_o_r in which the subfields in the pixel value
directly encode the corresponding RGB values. That is,
the colormap has predefined read-only RGB values. The
values are typically linear or near-linear increasing
ramps.
668844
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
TTyyppee
A type is an arbitrary atom used to identify the inter-
pretation of property data. Types are completely unin-
terpreted by the server. They are solely for the bene-
fit of clients. X predefines type atoms for many fre-
quently used types, and clients also can define new
types.
VViieewwaabbllee
A window is viewable if it and all of its ancestors are
mapped. This does not imply that any portion of the
window is actually visible. Graphics requests can be
performed on a window when it is not viewable, but out-
put will not be retained unless the server is maintain-
ing backing store.
VViissiibbllee
A region of a window is visible if someone looking at
the screen can actually see it; that is, the window is
viewable and the region is not occluded by any other
window.
WWhhiitteessppaaccee
Any spacing character. On implementations that conform
to the ANSI C library, whitespace is any character for
which _i_s_s_p_a_c_e returns true.
WWiinnddooww ggrraavviittyy
When windows are resized, subwindows may be reposi-
tioned automatically relative to some position in the
window. This attraction of a subwindow to some part of
its parent is known as window gravity.
WWiinnddooww mmaannaaggeerr
Manipulation of windows on the screen and much of the
user interface (policy) is typically provided by a win-
dow manager client.
668855
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
XX PPoorrttaabbllee CChhaarraacctteerr SSeett
A basic set of 97 characters which are assumed to exist
in all locales supported by Xlib. This set contains
the following characters:
a..z A..Z 0..9 !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ <space>,
<tab>, and <newline>
This is the left/lower half (also called the G0 set) of
the graphic character set of ISO8859-1 plus <space>,
<tab>, and <newline>. It is also the set of graphic
characters in 7-bit ASCII plus the same three control
characters. The actual encoding of these characters on
the host is system dependent; see the Host Portable
Character Encoding.
XXLLFFDD
The X Logical Font Description Conventions that define
a standard syntax for structured font names.
XXYY ffoorrmmaatt
The data for a pixmap is said to be in XY format if it
is organized as a set of bitmaps representing individ-
ual bit planes with the planes appearing from most-sig-
nificant to least-significant bit order.
ZZ ffoorrmmaatt
The data for a pixmap is said to be in Z format if it
is organized as a set of pixel values in scanline
order.
RReeffeerreenncceess
ANSI Programming Language - C: ANSI X3.159-1989, December
14, 1989.
Draft Proposed Multibyte Extension of ANSI C, Draft 1.1,
November 30, 1989, SC22/C WG/SWG IPSJ/ITSCJ Japan.
ISO2022: Information processing - ISO 7-bit and 8-bit coded
character sets - Code extension techniques.
ISO8859-1: Information processing - 8-bit single-byte coded
graphic character sets - Part 1: Latin alphabet No. 1.
668866
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
POSIX: Information Technology - Portable Operating System
Interface (POSIX) - Part 1: System Application Program
Interface (API) [C Language], ISO/IEC 9945-1.
Text of ISO/IEC/DIS 9541-1, Information Processing - Font
Information Interchange - Part 1: Architecture.
X/Open Portability Guide, Issue 3, December 1988 (XPG3),
X/Open Company, Ltd, Prentice-Hall, Inc. 1989. ISBN
0-13-685835-8. (See especially Volume 3: XSI Supplementary
Definitions.)
668877
XXlliibb -- CC LLiibbrraarryy lliibbXX1111 11..33..22
668888
TTaabbllee ooff CCoonntteennttss
Table of Contents . . . . . . . . . . . . . . . . . . . ii
Acknowledgments . . . . . . . . . . . . . . . . . . . . iii
Chapter 1: Introduction to Xlib . . . . . . . . . . . . 1
1.1. Overview of the X Window System . . . . . . . . . . 2
1.2. Errors . . . . . . . . . . . . . . . . . . . . . . 4
1.3. Standard Header Files . . . . . . . . . . . . . . . 4
1.4. Generic Values and Types . . . . . . . . . . . . . 6
1.5. Naming and Argument Conventions within Xlib . . . . 7
1.6. Programming Considerations . . . . . . . . . . . . 8
1.7. Character Sets and Encodings . . . . . . . . . . . 8
1.8. Formatting Conventions . . . . . . . . . . . . . . 9
Chapter 2: Display Functions . . . . . . . . . . . . . . 11
2.1. Opening the Display . . . . . . . . . . . . . . . . 11
2.2. Obtaining Information about the Display, Image
Formats, or Screens . . . . . . . . . . . . . . . . . . 13
2.2.1. Display Macros . . . . . . . . . . . . . . . . . 14
2.2.2. Image Format Functions and Macros . . . . . . . . 23
2.2.3. Screen Information Macros . . . . . . . . . . . . 27
2.3. Generating a NoOperation Protocol Request . . . . . 33
2.4. Freeing Client-Created Data . . . . . . . . . . . . 34
2.5. Closing the Display . . . . . . . . . . . . . . . . 34
2.6. Using X Server Connection Close Operations . . . . 35
2.7. Using Xlib with Threads . . . . . . . . . . . . . . 37
2.8. Using Internal Connections . . . . . . . . . . . . 38
Chapter 3: Window Functions . . . . . . . . . . . . . . 42
3.1. Visual Types . . . . . . . . . . . . . . . . . . . 42
3.2. Window Attributes . . . . . . . . . . . . . . . . . 44
3.2.1. Background Attribute . . . . . . . . . . . . . . 48
3.2.2. Border Attribute . . . . . . . . . . . . . . . . 49
3.2.3. Gravity Attributes . . . . . . . . . . . . . . . 50
3.2.4. Backing Store Attribute . . . . . . . . . . . . . 51
3.2.5. Save Under Flag . . . . . . . . . . . . . . . . . 52
3.2.6. Backing Planes and Backing Pixel Attributes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
3.2.7. Event Mask and Do Not Propagate Mask
Attributes . . . . . . . . . . . . . . . . . . . . . . . 53
3.2.8. Override Redirect Flag . . . . . . . . . . . . . 53
3.2.9. Colormap Attribute . . . . . . . . . . . . . . . 53
3.2.10. Cursor Attribute . . . . . . . . . . . . . . . . 54
3.3. Creating Windows . . . . . . . . . . . . . . . . . 54
3.4. Destroying Windows . . . . . . . . . . . . . . . . 59
3.5. Mapping Windows . . . . . . . . . . . . . . . . . . 60
3.6. Unmapping Windows . . . . . . . . . . . . . . . . . 62
3.7. Configuring Windows . . . . . . . . . . . . . . . . 63
3.8. Changing Window Stacking Order . . . . . . . . . . 70
3.9. Changing Window Attributes . . . . . . . . . . . . 74
Chapter 4: Window Information Functions . . . . . . . . 81
4.1. Obtaining Window Information . . . . . . . . . . . 81
4.2. Translating Screen Coordinates . . . . . . . . . . 87
4.3. Properties and Atoms . . . . . . . . . . . . . . . 89
4.4. Obtaining and Changing Window Properties . . . . . 94
4.5. Selections . . . . . . . . . . . . . . . . . . . . 101
Chapter 5: Pixmap and Cursor Functions . . . . . . . . . 105
5.1. Creating and Freeing Pixmaps . . . . . . . . . . . 105
5.2. Creating, Recoloring, and Freeing Cursors . . . . . 106
Chapter 6: Color Management Functions . . . . . . . . . 112
6.1. Color Structures . . . . . . . . . . . . . . . . . 113
6.2. Color Strings . . . . . . . . . . . . . . . . . . . 117
6.2.1. RGB Device String Specification . . . . . . . . . 118
6.2.2. RGB Intensity String Specification . . . . . . . 119
6.2.3. Device-Independent String Specifications . . . . 119
6.3. Color Conversion Contexts and Gamut Mapping . . . . 120
6.4. Creating, Copying, and Destroying Colormaps . . . . 121
6.5. Mapping Color Names to Values . . . . . . . . . . . 123
6.6. Allocating and Freeing Color Cells . . . . . . . . 127
6.7. Modifying and Querying Colormap Cells . . . . . . . 135
6.8. Color Conversion Context Functions . . . . . . . . 142
6.8.1. Getting and Setting the Color Conversion Con-
text of a Colormap . . . . . . . . . . . . . . . . . . . 143
6.8.2. Obtaining the Default Color Conversion Con-
text . . . . . . . . . . . . . . . . . . . . . . . . . . 144
6.8.3. Color Conversion Context Macros . . . . . . . . . 144
6.8.4. Modifying Attributes of a Color Conversion
Context . . . . . . . . . . . . . . . . . . . . . . . . 146
6.8.5. Creating and Freeing a Color Conversion Con-
text . . . . . . . . . . . . . . . . . . . . . . . . . . 148
6.9. Converting between Color Spaces . . . . . . . . . . 150
6.10. Callback Functions . . . . . . . . . . . . . . . . 151
6.10.1. Prototype Gamut Compression Procedure . . . . . 152
6.10.2. Supplied Gamut Compression Procedures . . . . . 154
6.10.3. Prototype White Point Adjustment Procedure
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
6.10.4. Supplied White Point Adjustment Procedures
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
6.11. Gamut Querying Functions . . . . . . . . . . . . . 159
6.11.1. Red, Green, and Blue Queries . . . . . . . . . . 160
6.11.2. CIELab Queries . . . . . . . . . . . . . . . . . 163
6.11.3. CIELuv Queries . . . . . . . . . . . . . . . . . 167
6.11.4. TekHVC Queries . . . . . . . . . . . . . . . . . 171
6.12. Color Management Extensions . . . . . . . . . . . 176
6.12.1. Color Spaces . . . . . . . . . . . . . . . . . . 177
6.12.2. Adding Device-Independent Color Spaces . . . . . 177
6.12.3. Querying Color Space Format and Prefix . . . . . 178
6.12.4. Creating Additional Color Spaces . . . . . . . . 178
6.12.5. Parse String Callback . . . . . . . . . . . . . 180
6.12.6. Color Specification Conversion Callback . . . . 180
6.12.7. Function Sets . . . . . . . . . . . . . . . . . 183
6.12.8. Adding Function Sets . . . . . . . . . . . . . . 183
6.12.9. Creating Additional Function Sets . . . . . . . 184
Chapter 7: Graphics Context Functions . . . . . . . . . 187
7.1. Manipulating Graphics Context/State . . . . . . . . 187
7.2. Using Graphics Context Convenience Routines . . . . 201
7.2.1. Setting the Foreground, Background, Function,
or Plane Mask . . . . . . . . . . . . . . . . . . . . . 201
7.2.2. Setting the Line Attributes and Dashes . . . . . 204
7.2.3. Setting the Fill Style and Fill Rule . . . . . . 207
7.2.4. Setting the Fill Tile and Stipple . . . . . . . . 207
7.2.5. Setting the Current Font . . . . . . . . . . . . 212
7.2.6. Setting the Clip Region . . . . . . . . . . . . . 212
7.2.7. Setting the Arc Mode, Subwindow Mode, and
Graphics Exposure . . . . . . . . . . . . . . . . . . . 215
Chapter 8: Graphics Functions . . . . . . . . . . . . . 217
8.1. Clearing Areas . . . . . . . . . . . . . . . . . . 217
8.2. Copying Areas . . . . . . . . . . . . . . . . . . . 219
8.3. Drawing Points, Lines, Rectangles, and Arcs . . . . 222
8.3.1. Drawing Single and Multiple Points . . . . . . . 223
8.3.2. Drawing Single and Multiple Lines . . . . . . . . 225
8.3.3. Drawing Single and Multiple Rectangles . . . . . 227
8.3.4. Drawing Single and Multiple Arcs . . . . . . . . 229
8.4. Filling Areas . . . . . . . . . . . . . . . . . . . 232
8.4.1. Filling Single and Multiple Rectangles . . . . . 233
8.4.2. Filling a Single Polygon . . . . . . . . . . . . 234
8.4.3. Filling Single and Multiple Arcs . . . . . . . . 236
8.5. Font Metrics . . . . . . . . . . . . . . . . . . . 237
8.5.1. Loading and Freeing Fonts . . . . . . . . . . . . 242
8.5.2. Obtaining and Freeing Font Names and Informa-
tion . . . . . . . . . . . . . . . . . . . . . . . . . . 246
8.5.3. Computing Character String Sizes . . . . . . . . 248
8.5.4. Computing Logical Extents . . . . . . . . . . . . 249
8.5.5. Querying Character String Sizes . . . . . . . . . 252
8.6. Drawing Text . . . . . . . . . . . . . . . . . . . 254
8.6.1. Drawing Complex Text . . . . . . . . . . . . . . 255
8.6.2. Drawing Text Characters . . . . . . . . . . . . . 257
8.6.3. Drawing Image Text Characters . . . . . . . . . . 258
8.7. Transferring Images between Client and Server
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Chapter 9: Window and Session Manager Functions . . . . 269
9.1. Changing the Parent of a Window . . . . . . . . . . 269
9.2. Controlling the Lifetime of a Window . . . . . . . 271
9.3. Managing Installed Colormaps . . . . . . . . . . . 272
9.4. Setting and Retrieving the Font Search Path . . . . 275
9.5. Grabbing the Server . . . . . . . . . . . . . . . . 276
9.6. Killing Clients . . . . . . . . . . . . . . . . . . 277
9.7. Controlling the Screen Saver . . . . . . . . . . . 278
9.8. Controlling Host Access . . . . . . . . . . . . . . 281
9.8.1. Adding, Getting, or Removing Hosts . . . . . . . 281
9.8.2. Changing, Enabling, or Disabling Access Con-
trol . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Chapter 10: Events . . . . . . . . . . . . . . . . . . . 287
10.1. Event Types . . . . . . . . . . . . . . . . . . . 287
10.2. Event Structures . . . . . . . . . . . . . . . . . 288
10.3. Event Masks . . . . . . . . . . . . . . . . . . . 291
10.4. Event Processing Overview . . . . . . . . . . . . 292
10.5. Keyboard and Pointer Events . . . . . . . . . . . 294
10.5.1. Pointer Button Events . . . . . . . . . . . . . 294
10.5.2. Keyboard and Pointer Events . . . . . . . . . . 295
10.6. Window Entry/Exit Events . . . . . . . . . . . . . 299
10.6.1. Normal Entry/Exit Events . . . . . . . . . . . . 301
10.6.2. Grab and Ungrab Entry/Exit Events . . . . . . . 303
10.7. Input Focus Events . . . . . . . . . . . . . . . . 304
10.7.1. Normal Focus Events and Focus Events While
Grabbed . . . . . . . . . . . . . . . . . . . . . . . . 305
10.7.2. Focus Events Generated by Grabs . . . . . . . . 309
10.8. Key Map State Notification Events . . . . . . . . 309
10.9. Exposure Events . . . . . . . . . . . . . . . . . 310
10.9.1. Expose Events . . . . . . . . . . . . . . . . . 310
10.9.2. GraphicsExpose and NoExpose Events . . . . . . . 311
10.10. Window State Change Events . . . . . . . . . . . 313
10.10.1. CirculateNotify Events . . . . . . . . . . . . 313
10.10.2. ConfigureNotify Events . . . . . . . . . . . . 314
10.10.3. CreateNotify Events . . . . . . . . . . . . . . 315
10.10.4. DestroyNotify Events . . . . . . . . . . . . . 316
10.10.5. GravityNotify Events . . . . . . . . . . . . . 317
10.10.6. MapNotify Events . . . . . . . . . . . . . . . 318
10.10.7. MappingNotify Events . . . . . . . . . . . . . 318
10.10.8. ReparentNotify Events . . . . . . . . . . . . . 319
10.10.9. UnmapNotify Events . . . . . . . . . . . . . . 320
10.10.10. VisibilityNotify Events . . . . . . . . . . . 321
10.11. Structure Control Events . . . . . . . . . . . . 322
10.11.1. CirculateRequest Events . . . . . . . . . . . . 323
10.11.2. ConfigureRequest Events . . . . . . . . . . . . 323
10.11.3. MapRequest Events . . . . . . . . . . . . . . . 324
10.11.4. ResizeRequest Events . . . . . . . . . . . . . 325
10.12. Colormap State Change Events . . . . . . . . . . 326
10.13. Client Communication Events . . . . . . . . . . . 327
10.13.1. ClientMessage Events . . . . . . . . . . . . . 327
10.13.2. PropertyNotify Events . . . . . . . . . . . . . 328
10.13.3. SelectionClear Events . . . . . . . . . . . . . 328
10.13.4. SelectionRequest Events . . . . . . . . . . . . 329
10.13.5. SelectionNotify Events . . . . . . . . . . . . 330
Chapter 11: Event Handling Functions . . . . . . . . . . 332
11.1. Selecting Events . . . . . . . . . . . . . . . . . 332
11.2. Handling the Output Buffer . . . . . . . . . . . . 333
11.3. Event Queue Management . . . . . . . . . . . . . . 335
11.4. Manipulating the Event Queue . . . . . . . . . . . 336
11.4.1. Returning the Next Event . . . . . . . . . . . . 336
11.4.2. Selecting Events Using a Predicate Procedure
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
11.4.3. Selecting Events Using a Window or Event
Mask . . . . . . . . . . . . . . . . . . . . . . . . . . 340
11.5. Putting an Event Back into the Queue . . . . . . . 345
11.6. Sending Events to Other Applications . . . . . . . 345
11.7. Getting Pointer Motion History . . . . . . . . . . 347
11.8. Handling Protocol Errors . . . . . . . . . . . . . 349
11.8.1. Enabling or Disabling Synchronization . . . . . 349
11.8.2. Using the Default Error Handlers . . . . . . . . 350
Chapter 12: Input Device Functions . . . . . . . . . . . 356
12.1. Pointer Grabbing . . . . . . . . . . . . . . . . . 356
12.2. Keyboard Grabbing . . . . . . . . . . . . . . . . 364
12.3. Resuming Event Processing . . . . . . . . . . . . 369
12.4. Moving the Pointer . . . . . . . . . . . . . . . . 372
12.5. Controlling Input Focus . . . . . . . . . . . . . 373
12.6. Manipulating the Keyboard and Pointer Settings
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
12.7. Manipulating the Keyboard Encoding . . . . . . . . 383
Chapter 13: Locales and Internationalized Text Func-
tions . . . . . . . . . . . . . . . . . . . . . . . . . 393
13.1. X Locale Management . . . . . . . . . . . . . . . 394
13.2. Locale and Modifier Dependencies . . . . . . . . . 396
13.3. Variable Argument Lists . . . . . . . . . . . . . 398
13.4. Output Methods . . . . . . . . . . . . . . . . . . 399
13.4.1. Output Method Overview . . . . . . . . . . . . . 399
13.4.2. Output Method Functions . . . . . . . . . . . . 400
13.4.3. X Output Method Values . . . . . . . . . . . . . 403
13.4.3.1. Required Char Set . . . . . . . . . . . . . . 403
13.4.3.2. Query Orientation . . . . . . . . . . . . . . 404
13.4.3.3. Directional Dependent Drawing . . . . . . . . 404
13.4.3.4. Context Dependent Drawing . . . . . . . . . . 405
13.4.4. Output Context Functions . . . . . . . . . . . . 405
13.4.5. Output Context Values . . . . . . . . . . . . . 408
13.4.5.1. Base Font Name . . . . . . . . . . . . . . . . 409
13.4.5.2. Missing CharSet . . . . . . . . . . . . . . . 410
13.4.5.3. Default String . . . . . . . . . . . . . . . . 410
13.4.5.4. Orientation . . . . . . . . . . . . . . . . . 410
13.4.5.5. Resource Name and Class . . . . . . . . . . . 411
13.4.5.6. Font Info . . . . . . . . . . . . . . . . . . 411
13.4.5.7. OM Automatic . . . . . . . . . . . . . . . . . 412
13.4.6. Creating and Freeing a Font Set . . . . . . . . 412
13.4.7. Obtaining Font Set Metrics . . . . . . . . . . . 418
13.4.8. Drawing Text Using Font Sets . . . . . . . . . . 427
13.5. Input Methods . . . . . . . . . . . . . . . . . . 431
13.5.1. Input Method Overview . . . . . . . . . . . . . 431
13.5.1.1. Input Method Architecture . . . . . . . . . . 433
13.5.1.2. Input Contexts . . . . . . . . . . . . . . . . 435
13.5.1.3. Getting Keyboard Input . . . . . . . . . . . . 436
13.5.1.4. Focus Management . . . . . . . . . . . . . . . 436
13.5.1.5. Geometry Management . . . . . . . . . . . . . 437
13.5.1.6. Event Filtering . . . . . . . . . . . . . . . 438
13.5.1.7. Callbacks . . . . . . . . . . . . . . . . . . 439
13.5.1.8. Visible Position Feedback Masks . . . . . . . 439
13.5.1.9. Preedit String Management . . . . . . . . . . 440
13.5.2. Input Method Management . . . . . . . . . . . . 442
13.5.2.1. Hot Keys . . . . . . . . . . . . . . . . . . . 443
13.5.2.2. Preedit State Operation . . . . . . . . . . . 444
13.5.3. Input Method Functions . . . . . . . . . . . . . 444
13.5.4. Input Method Values . . . . . . . . . . . . . . 449
13.5.4.1. Query Input Style . . . . . . . . . . . . . . 450
13.5.4.2. Resource Name and Class . . . . . . . . . . . 452
13.5.4.3. Destroy Callback . . . . . . . . . . . . . . . 452
13.5.4.4. Query IM/IC Values List . . . . . . . . . . . 453
13.5.4.5. Visible Position . . . . . . . . . . . . . . . 453
13.5.4.6. Preedit Callback Behavior . . . . . . . . . . 454
13.5.5. Input Context Functions . . . . . . . . . . . . 454
13.5.6. Input Context Values . . . . . . . . . . . . . . 459
13.5.6.1. Input Style . . . . . . . . . . . . . . . . . 461
13.5.6.2. Client Window . . . . . . . . . . . . . . . . 461
13.5.6.3. Focus Window . . . . . . . . . . . . . . . . . 461
13.5.6.4. Resource Name and Class . . . . . . . . . . . 462
13.5.6.5. Geometry Callback . . . . . . . . . . . . . . 462
13.5.6.6. Filter Events . . . . . . . . . . . . . . . . 462
13.5.6.7. Destroy Callback . . . . . . . . . . . . . . . 463
13.5.6.8. String Conversion Callback . . . . . . . . . . 463
13.5.6.9. String Conversion . . . . . . . . . . . . . . 463
13.5.6.10. Reset State . . . . . . . . . . . . . . . . . 464
13.5.6.11. Hot Keys . . . . . . . . . . . . . . . . . . 465
13.5.6.12. Hot Key State . . . . . . . . . . . . . . . . 466
13.5.6.13. Preedit and Status Attributes . . . . . . . . 466
13.5.6.13.1. Area . . . . . . . . . . . . . . . . . . . 466
13.5.6.13.2. Area Needed . . . . . . . . . . . . . . . . 467
13.5.6.13.3. Spot Location . . . . . . . . . . . . . . . 467
13.5.6.13.4. Colormap . . . . . . . . . . . . . . . . . 468
13.5.6.13.5. Foreground and Background . . . . . . . . . 468
13.5.6.13.6. Background Pixmap . . . . . . . . . . . . . 468
13.5.6.13.7. Font Set . . . . . . . . . . . . . . . . . 468
13.5.6.13.8. Line Spacing . . . . . . . . . . . . . . . 469
13.5.6.13.9. Cursor . . . . . . . . . . . . . . . . . . 469
13.5.6.13.10. Preedit State . . . . . . . . . . . . . . 469
13.5.6.13.11. Preedit State Notify Callback . . . . . . 470
13.5.6.13.12. Preedit and Status Callbacks . . . . . . . 470
13.5.7. Input Method Callback Semantics . . . . . . . . 471
13.5.7.1. Geometry Callback . . . . . . . . . . . . . . 472
13.5.7.2. Destroy Callback . . . . . . . . . . . . . . . 473
13.5.7.3. String Conversion Callback . . . . . . . . . . 473
13.5.7.4. Preedit State Callbacks . . . . . . . . . . . 476
13.5.7.5. Preedit Draw Callback . . . . . . . . . . . . 477
13.5.7.6. Preedit Caret Callback . . . . . . . . . . . . 481
13.5.7.7. Status Callbacks . . . . . . . . . . . . . . . 483
13.5.8. Event Filtering . . . . . . . . . . . . . . . . 485
13.5.9. Getting Keyboard Input . . . . . . . . . . . . . 486
13.5.10. Input Method Conventions . . . . . . . . . . . 489
13.5.10.1. Client Conventions . . . . . . . . . . . . . 489
13.5.10.2. Synchronization Conventions . . . . . . . . . 489
13.6. String Constants . . . . . . . . . . . . . . . . . 489
Chapter 14: Inter-Client Communication Functions . . . . 492
14.1. Client to Window Manager Communication . . . . . . 494
14.1.1. Manipulating Top-Level Windows . . . . . . . . . 494
14.1.2. Converting String Lists . . . . . . . . . . . . 497
14.1.3. Setting and Reading Text Properties . . . . . . 503
14.1.4. Setting and Reading the WM_NAME Property . . . . 504
14.1.5. Setting and Reading the WM_ICON_NAME Prop-
erty . . . . . . . . . . . . . . . . . . . . . . . . . . 507
14.1.6. Setting and Reading the WM_HINTS Property
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
14.1.7. Setting and Reading the WM_NORMAL_HINTS
Property . . . . . . . . . . . . . . . . . . . . . . . . 512
14.1.8. Setting and Reading the WM_CLASS Property
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
14.1.9. Setting and Reading the WM_TRANSIENT_FOR
Property . . . . . . . . . . . . . . . . . . . . . . . . 520
14.1.10. Setting and Reading the WM_PROTOCOLS Prop-
erty . . . . . . . . . . . . . . . . . . . . . . . . . . 521
14.1.11. Setting and Reading the WM_COLORMAP_WINDOWS
Property . . . . . . . . . . . . . . . . . . . . . . . . 522
14.1.12. Setting and Reading the WM_ICON_SIZE Prop-
erty . . . . . . . . . . . . . . . . . . . . . . . . . . 524
14.1.13. Using Window Manager Convenience Functions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
14.2. Client to Session Manager Communication . . . . . 530
14.2.1. Setting and Reading the WM_COMMAND Property
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
14.2.2. Setting and Reading the WM_CLIENT_MACHINE
Property . . . . . . . . . . . . . . . . . . . . . . . . 531
14.3. Standard Colormaps . . . . . . . . . . . . . . . . 532
14.3.1. Standard Colormap Properties and Atoms . . . . . 536
14.3.2. Setting and Obtaining Standard Colormaps . . . . 537
Chapter 15: Resource Manager Functions . . . . . . . . . 541
15.1. Resource File Syntax . . . . . . . . . . . . . . . 542
15.2. Resource Manager Matching Rules . . . . . . . . . 544
15.3. Quarks . . . . . . . . . . . . . . . . . . . . . . 545
15.4. Creating and Storing Databases . . . . . . . . . . 549
15.5. Merging Resource Databases . . . . . . . . . . . . 553
15.6. Looking Up Resources . . . . . . . . . . . . . . . 554
15.7. Storing into a Resource Database . . . . . . . . . 558
15.8. Enumerating Database Entries . . . . . . . . . . . 562
15.9. Parsing Command Line Options . . . . . . . . . . . 564
Chapter 16: Application Utility Functions . . . . . . . 567
16.1. Using Keyboard Utility Functions . . . . . . . . . 567
16.1.1. KeySym Classification Macros . . . . . . . . . . 571
16.2. Using Latin-1 Keyboard Event Functions . . . . . . 572
16.3. Allocating Permanent Storage . . . . . . . . . . . 574
16.4. Parsing the Window Geometry . . . . . . . . . . . 575
16.5. Manipulating Regions . . . . . . . . . . . . . . . 577
16.5.1. Creating, Copying, or Destroying Regions . . . . 577
16.5.2. Moving or Shrinking Regions . . . . . . . . . . 579
16.5.3. Computing with Regions . . . . . . . . . . . . . 579
16.5.4. Determining if Regions Are Empty or Equal
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
16.5.5. Locating a Point or a Rectangle in a Region
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
16.6. Using Cut Buffers . . . . . . . . . . . . . . . . 583
16.7. Determining the Appropriate Visual Type . . . . . 586
16.8. Manipulating Images . . . . . . . . . . . . . . . 589
16.9. Manipulating Bitmaps . . . . . . . . . . . . . . . 593
16.10. Using the Context Manager . . . . . . . . . . . . 598
Appendix A: Xlib Functions and Protocol Requests . . . . 602
Appendix B: X Font Cursors . . . . . . . . . . . . . . 614
Appendix C: Extensions . . . . . . . . . . . . . . . . . 615
Appendix D: Compatibility Functions . . . . . . . . . . 649
Glossary . . . . . . . . . . . . . . . . . . . . . . . . 666
Index . . . . . . . . . . . . . . . . . . . . . . . . . 689
ACC SHELL 2018