diff --git a/specs/libX11/AppC.xml b/specs/libX11/AppC.xml index bc45b159..8fd0ed7c 100644 --- a/specs/libX11/AppC.xml +++ b/specs/libX11/AppC.xml @@ -98,9 +98,9 @@ function determines if the named extension is present. If the extension is not present, XQueryExtension returns -False; +False; otherwise, it returns -True. +True. If the extension is present, XQueryExtension returns the major opcode for the extension to major_opcode_return; @@ -229,7 +229,7 @@ called when these events occur. The -XExtCodes +XExtCodes structure returns the information from XInitExtension and is defined in @@ -312,7 +312,7 @@ are all considered different names. The extension number in the -XExtCodes +XExtCodes structure is needed in the other calls that follow. This extension number is unique only to a single connection. @@ -347,7 +347,7 @@ Specifies the connection to the X server. For local Xlib extensions, the XAddExtension function allocates the -XExtCodes +XExtCodes structure, bumps the extension number count, and chains the extension onto the extension list. (This permits extensions to Xlib without requiring server extensions.) @@ -799,19 +799,19 @@ and XESetEventToWire functions allow you to define new events to the library. An -XEvent +XEvent structure always has a type code (type -int) +int) as the first component. This uniquely identifies what kind of event it is. The second component is always the serial number (type -unsigned -long) +unsigned +long) of the last request processed by the server. The third component is always a Boolean (type -Bool) +Bool) indicating whether the event came from a -SendEvent +SendEvent protocol request. The fourth component is always a pointer to the display the event was read from. @@ -824,7 +824,7 @@ from the protocol to put in this component, initialize it to zero. There is an implementation limit such that your host event structure size cannot be bigger than the size of the -XEvent +XEvent union of structures. There also is no way to guarantee that more than 24 elements or 96 characters in the structure will be fully portable between machines. @@ -880,9 +880,9 @@ The XESetWireToEvent function defines a procedure to be called when an event needs to be converted from wire format -(xEvent) +(xEvent) to host format -(XEvent). +(XEvent). The event number defines which protocol event number to install a conversion procedure for. XESetWireToEvent @@ -916,21 +916,21 @@ Your procedure must return status to indicate if the conversion 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 -XEvent +XEvent structure 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 -xEvent +xEvent structure. You should copy all other members from the -xEvent +xEvent structure (wire format) to the -XEvent +XEvent structure (host format). Your conversion procedure should return -True +True if the event should be placed in the queue or -False +False if it should not be placed in the queue. @@ -1036,9 +1036,9 @@ The XESetEventToWire function defines a procedure to be called when an event needs to be converted from host format -(XEvent) +(XEvent) to wire format -(xEvent) +(xEvent) form. The event number defines which protocol event number to install a conversion procedure for. @@ -1074,10 +1074,10 @@ 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 -XEvent +XEvent structure. All other members then should be copied from the host format to the -xEvent +xEvent structure. XESetWireToError @@ -1165,17 +1165,17 @@ Bool (*proc)(display The he argument is a pointer to where the host format error should be stored. The structure pointed at by he is guaranteed to be as large as an -XEvent +XEvent structure and so can be cast to a type larger than an -XErrorEvent +XErrorEvent to store additional 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 -False; +False; otherwise, it should return -True. +True. XESetError @@ -1348,7 +1348,7 @@ error message into buffer. - void *XESSetPrintErrorValues + void *XESetPrintErrorValues Display *display int extension void (*proc)() @@ -1421,9 +1421,9 @@ void (*proc)(display The structure pointed at by ev is guaranteed to be as large as an -XEvent +XEvent structure and so can be cast to a type larger than an -XErrorEvent +XErrorEvent to obtain additional values set by using XESetWireToError. The underlying type of the fp argument is system dependent; @@ -1562,13 +1562,13 @@ Hooks onto Xlib Data Structures Various Xlib data structures have provisions for extension procedures to chain extension supplied data onto a list. These structures are -GC, -Visual, -Screen, -ScreenFormat, -Display, +GC, +Visual, +Screen, +ScreenFormat, +Display, and -XFontStruct. +XFontStruct. Because the list pointer is always the first member in the structure, a single set of procedures can be used to manipulate the data on these lists. @@ -1654,7 +1654,7 @@ In concert with XEHeadOfExtensionList allows an extension to attach arbitrary data to any of the structures of types contained in -XEDataObject. +XEDataObject. @@ -1775,7 +1775,7 @@ Specifies the connection to the X server. This macro is a call through the -Display +Display structure to an internal resource ID allocator. It returns a resource ID that you can use when creating new resources. @@ -1832,7 +1832,7 @@ Specifies the number of resource IDs requested. This macro is a call through the -Display +Display structure to an internal resource ID allocator. It returns resource IDs to the array supplied by the caller. To correctly handle automatic reuse of resource IDs, you must call @@ -1958,7 +1958,7 @@ single calls to be transformed into poly requests. This may dramatically improve performance of programs that are not written using poly requests. A pointer to an -xReq, +xReq, called last_req in the display structure, is the last request being processed. By checking that the last request type, drawable, gc, and other options are the same as the new one @@ -2110,7 +2110,7 @@ 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 -BadLength +BadLength error. Unused bytes in a request are not required to be zero. Extensions should be designed in such a way that long protocol requests @@ -2133,9 +2133,9 @@ used in replies, errors, and events. To help but not cure portability problems to certain machines, the -B16 +B16 and -B32 +B32 macros have been defined so that they can become bitfield specifications on some machines. For example, on a Cray, @@ -2170,20 +2170,20 @@ typedef struct _DoSomethingReq { 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 -xResourceReq +xResourceReq structure in <X11/Xproto.h>. This structure is used for any request whose single argument is a -Window, -Pixmap, -Drawable, -GContext, -Font, -Cursor, -Colormap, -Atom, +Window, +Pixmap, +Drawable, +GContext, +Font, +Cursor, +Colormap, +Atom, or -VisualID. +VisualID. @@ -2223,7 +2223,7 @@ 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 -xReq +xReq structure in <X11/Xproto.h>, which contains only a reqType and a length (and a pad byte). @@ -2280,11 +2280,11 @@ The reply structure is longer than 32 bytes. Only -GetWindowAttributes, -QueryFont, -QueryKeymap, +GetWindowAttributesl, +QueryFont, +QueryKeymap, and -GetKeyboardControl +GetKeyboardControl have reply structures longer than 32 bytes in the core protocol. @@ -2293,7 +2293,7 @@ A few protocol requests return replies that contain no data. <X11/Xproto.h> does not define reply structures for these. Instead, they use the -xGenericReply +xGenericReply structure, which contains only a type, length, and sequence number (and sufficient padding to make it 32 bytes long). @@ -2393,7 +2393,7 @@ the name of the protocol request as declared in <X11/Xproto.h> except with X_ removed. Each one declares a -Display +Display structure pointer, called dpy, and a pointer to a request structure, called req, which is of the appropriate type. @@ -2413,15 +2413,15 @@ then use GetEmptyReq (DoSomething, req); If the protocol request has a single 32-bit argument (such as a -Pixmap, -Window, -Drawable, -Atom, +Pixmap, +Window, +Drawable, +Atom, and so on), then use GetResReq. The second argument to the macro is the 32-bit object. -X_MapWindow +X_MapWindow is a good example. @@ -2431,8 +2431,8 @@ is a good example. GetResReq (DoSomething, rid, req); The rid argument is the -Pixmap, -Window, +Pixmap, +Window, or other resource ID. @@ -2498,7 +2498,7 @@ Variable Length Arguments Some protocol requests take additional variable-length data that follow the -xDoSomethingReq +xDoSomethingReq structure. The format of this data varies from request to request. Some requests require a sequence of 8-bit bytes, @@ -2585,7 +2585,7 @@ after you have finished dealing with all the fixed-length and variable-length arguments. _XReply flushes the output buffer and waits for an -xReply +xReply packet to arrive. If any events arrive in the meantime, _XReply @@ -2662,14 +2662,14 @@ takes four arguments: A -Display +Display * structure A pointer to a reply structure (which must be cast to an -xReply +xReply *) @@ -2695,38 +2695,38 @@ 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 -GetWindowAttributes, -QueryFont, -QueryKeymap, +GetWindowAttributesl, +QueryFont, +QueryKeymap, and -GetKeyboardControl, +GetKeyboardControl, which have longer replies. The last argument should be -False +False if the reply structure is followed by additional variable-length data (such as a list or string). It should be -True +True if there is not any variable-length data. This last argument is provided for upward-compatibility 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 -GetWindowAttributes +GetWindowAttributesl might use a larger, but compatible, -xGetWindowAttributesReply +xGetWindowAttributesReply that contains additional attribute data at the end. _XReply returns -True +True if it received a reply successfully or -False +False if it received any sort of error. @@ -2750,9 +2750,9 @@ return (rep.ret4); If there is variable-length data after the reply, change the -True +True to -False, +False, and use the appropriate _XRead function to read the variable-length data. @@ -3041,7 +3041,7 @@ Synchronous Calling Each procedure should have a call, just before returning to the user, to a macro called -SyncHandle. +SyncHandle. If synchronous mode is enabled (see XSynchronize), the request is sent immediately. @@ -3250,42 +3250,42 @@ avoided completely if at all possible. 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 -CARD16 +CARD16 in the protocol, be sure to declare it as -unsigned -int +unsigned +int and not as -int. +int. (This, of course, does not apply to Booleans or enumerations.) Similarly, if any integer argument or return value is declared -CARD32 +CARD32 in the protocol, declare it as an -unsigned -long +unsigned +long and not as -int +int or -long. +long. This also goes for any internal variables that may take on values larger than the maximum 16-bit -unsigned -int. +unsigned +int. The library currently assumes that a -char +char is 8 bits, a -short +short is 16 bits, an -int +int is 16 or 32 bits, and a -long +long is 32 bits. The PackData @@ -3310,7 +3310,7 @@ in <stdio.h> and is the number of file descriptors supported on the system) of type -XExtCodes. +XExtCodes. Make sure these are all initialized to NULL. @@ -3333,7 +3333,7 @@ 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 initialization procedure would normally return a pointer to the -XExtCodes +XExtCodes structure for this extension, which is what would normally be found in your array of pointers. @@ -3343,7 +3343,7 @@ be found in your array of pointers. After returning from your initialization procedure, the stub can now continue normally, because it has its major opcode safely in its hand in the -XExtCodes +XExtCodes structure. diff --git a/specs/libX11/AppD.xml b/specs/libX11/AppD.xml index d90298ad..31f92a16 100644 --- a/specs/libX11/AppD.xml +++ b/specs/libX11/AppD.xml @@ -26,7 +26,7 @@ Set and get window sizing hints Set and get an -XStandardColormap +XStandardColormap structure @@ -119,7 +119,7 @@ which should be a null-terminated string. Specifies the bitmap that is to be used for the icon or -None. +None. @@ -176,9 +176,9 @@ the result is implementation-dependent. XSetStandardProperties can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -189,7 +189,7 @@ Setting and Getting Window Sizing Hints Xlib provides functions that you can use to set or get window sizing hints. The functions discussed in this section use the flags and the -XSizeHints +XSizeHints structure, as defined in the header file and use the WM_NORMAL_HINTS property. @@ -278,9 +278,9 @@ the structure have been assigned values. XSetNormalHints can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -347,7 +347,7 @@ the application specified no normal size hints for this window. XGetNormalHints can generate a -BadWindow +BadWindow error. @@ -419,9 +419,9 @@ zoomed state. XSetZoomHints can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -488,7 +488,7 @@ the application specified no zoom size hints for this window. XGetZoomHints can generate a -BadWindow +BadWindow error. @@ -559,7 +559,7 @@ Specifies the property name. The XSetSizeHints function sets the -XSizeHints +XSizeHints structure for the named property and the specified window. This is used by XSetNormalHints @@ -572,10 +572,10 @@ Thus, it may be useful if other properties of that type get defined. XSetSizeHints can generate -BadAlloc, -BadAtom, +BadAlloc, +BadAtom, and -BadWindow +BadWindow errors. @@ -646,7 +646,7 @@ Specifies the property name. The XGetSizeHints function returns the -XSizeHints +XSizeHints structure for the named property and the specified window. This is used by XGetNormalHints @@ -663,9 +663,9 @@ or zero otherwise. XGetSizeHints can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. Getting and Setting an XStandardColormap Structure @@ -673,11 +673,11 @@ Getting and Setting an XStandardColormap Structure To get the -XStandardColormap +XStandardColormap structure associated with one of the described atoms, use XGetStandardColormap. This function has been superseded by -XGetRGBColormap. +XGetRGBColormaps. XGetStandardColormap @@ -744,7 +744,7 @@ as the property argument. returns a nonzero status if successful and zero otherwise. For example, to fetch the standard -GrayScale +GrayScale colormap for a display, you use XGetStandardColormap @@ -768,9 +768,9 @@ See section 14.3 for the semantics of standard colormaps. XGetStandardColormap can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. @@ -779,7 +779,7 @@ errors. To set a standard colormap, use XSetStandardColormap. This function has been superseded by -XSetRGBColormap. +XSetRGBColormaps. XSetStandardColormap @@ -846,11 +846,11 @@ function usually is only used by window or session managers. XSetStandardColormap can generate -BadAlloc, -BadAtom, -BadDrawable, +BadAlloc, +BadAtom, +BadDrawable, and -BadWindow +BadWindow errors. Parsing Window Geometry @@ -1148,7 +1148,7 @@ a resource file in the user's home directory is used. On a POSIX-conformant system, this file is "$HOME/.Xdefaults". -Files$HOME/.Xdefaults +Files$HOME/.Xdefaults After loading these defaults, XGetDefault merges additional defaults specified by the XENVIRONMENT @@ -1158,8 +1158,8 @@ it contains a full path name for the additional resource file. If XENVIRONMENT is not defined, XGetDefault looks for -"$HOME/.Xdefaults-name" , -where name specifies the name of the machine on which the application +"$HOME/.Xdefaults-name" , +where name specifies the name of the machine on which the application is running. X Version 10 Compatibility Functions @@ -1233,15 +1233,15 @@ the closing of a closed figure (see XDrawLines). The functions discussed here fail (return zero) only if they run out of memory or are passed a -Vertex +Vertex list that has a -Vertex +Vertex with -VertexStartClosed +VertexStartClosed set that is not followed by a -Vertex +Vertex with -VertexEndClosed +VertexEndClosed set. @@ -1361,9 +1361,9 @@ typedef struct _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 -VertexRelative +VertexRelative is zero) or the previous vertex (if -VertexRelative +VertexRelative is one). @@ -1391,7 +1391,7 @@ VertexEndClosed 0x0010 /* else not */ If -VertexRelative +VertexRelative is not set, the coordinates are absolute (that is, relative to the drawable's origin). The first vertex must be an absolute vertex. @@ -1400,7 +1400,7 @@ The first vertex must be an absolute vertex. If -VertexDontDraw +VertexDontDraw is one, no line or curve is drawn from the previous vertex to this one. This is analogous to picking up the pen and moving to another place @@ -1410,13 +1410,13 @@ before drawing another line. If -VertexCurved +VertexCurved 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 -VertexCurved +VertexCurved to one only if a previous and next vertex are both defined (either explicitly in the array or through the definition of a closed curve). @@ -1425,9 +1425,9 @@ curve). It is permissible for -VertexDontDraw +VertexDontDraw bits and -VertexCurved +VertexCurved 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. @@ -1436,13 +1436,13 @@ but do not want an actual curve drawing to start until this point. If -VertexStartClosed +VertexStartClosed is one, then this point marks the beginning of a closed curve. This vertex must be followed later in the array by another vertex whose effective coordinates are identical and that has a -VertexEndClosed +VertexEndClosed bit of one. The points in between form a cycle to determine predecessor and successor vertices for the spline algorithm. @@ -1575,9 +1575,9 @@ The XAssocTable system provides users of the X library with a method for associating their own data structures with X resources -(Pixmaps, -Fonts, -Windows, +(Pixmaps, +Fonts, +Windows, and so on). @@ -1597,7 +1597,7 @@ It is called an XID. There are a few guidelines that should be observed when using an -XAssocTable : +XAssocTable : diff --git a/specs/libX11/CH01.xml b/specs/libX11/CH01.xml index 1203e80b..cf15efe4 100644 --- a/specs/libX11/CH01.xml +++ b/specs/libX11/CH01.xml @@ -121,7 +121,7 @@ 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 -Expose +Expose 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. @@ -171,13 +171,13 @@ that returns a value from the server or waits for input. Many Xlib functions will return an integer resource ID, which allows you to refer to objects stored on the X server. These can be of type -Window, -Font, -Pixmap, -Colormap, -Cursor, +Window, +Font, +Pixmap, +Colormap, +Cursor, and -GContext, +GContext, as defined in the file These resources are created by requests and are destroyed @@ -196,7 +196,7 @@ Xlib provides no support for sharing graphics contexts between applications. Client programs are informed of events. Events may either be side effects of a request (for example, restacking windows generates -Expose +Expose 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, @@ -214,9 +214,9 @@ In addition, some library functions (for example, XRaiseWindow) generate -Expose +Expose and -ConfigureRequest +ConfigureRequest events. These events also arrive asynchronously, but the client may XSync @@ -233,7 +233,7 @@ after calling a function that can cause the server to generate events. Some functions return -Status, +Status, an integer error indication. If the function fails, it returns a zero. If the function returns a status of zero, @@ -294,7 +294,7 @@ The following include files are part of the Xlib standard: This is the main header file for Xlib. The majority of all Xlib symbols are declared by including this file. This file also contains the preprocessor symbol -XlibSpecificationRelease. +XlibSpecificationRelease. XlibSpecificationRelease 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.) @@ -459,17 +459,17 @@ The following symbols are defined by Xlib and used throughout the manual: Xlib defines the type -Bool +Bool and the Boolean values -True +True and -False. +False. None -None +None is the universal null resource ID or atom. XID @@ -477,7 +477,7 @@ is the universal null resource ID or atom. The type -XID +XID is used for generic resource IDs. XPointer @@ -485,7 +485,7 @@ is used for generic resource IDs. The type -XPointer +XPointer is defined to be char\^* and is used as a generic opaque pointer to data. @@ -611,7 +611,7 @@ Coordinates and sizes in X are actually 16-bit quantities. This decision was made to minimize the bandwidth required for a given level of performance. Coordinates usually are declared as an -int +int in the interface. Values larger than 16 bits are truncated silently. Sizes (width and height) are declared as unsigned quantities. diff --git a/specs/libX11/CH02.xml b/specs/libX11/CH02.xml index 0146ddff..e68660b0 100644 --- a/specs/libX11/CH02.xml +++ b/specs/libX11/CH02.xml @@ -22,7 +22,7 @@ Obtain information about the display, image formats, or screens Generate a -NoOperation +NoOperation protocol request @@ -182,7 +182,7 @@ dual-headed:0.1 The XOpenDisplay function returns a -Display +Display structure that serves as the connection to the X server and that contains all the information about that X server. @@ -216,7 +216,7 @@ mechanisms. If successful, XOpenDisplay returns a pointer to a -Display +Display structure, which is defined in @@ -233,13 +233,13 @@ macro (or the XDefaultScreen function). You can access elements of the -Display +Display and -Screen +Screen structures only by using the information macros or functions. For information about using macros and functions to obtain information from the -Display +Display structure, see section 2.2.1. @@ -258,7 +258,7 @@ X servers may implement various types of access control mechanisms The Xlib library provides a number of useful macros and corresponding functions that return data from the -Display +Display structure. The macros are used for C programming, and their corresponding function equivalents are for other language bindings. @@ -285,11 +285,11 @@ Screen information macros Displaydata structure All other members of the -Display +Display 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 -Display +Display structure. The @@ -314,9 +314,9 @@ Our apologies for the resulting confusion. Applications should not directly modify any part of the -Display +Display and -Screen +Screen structures. The members should be considered read-only, although they may change as the result of other operations on the display. @@ -1480,7 +1480,7 @@ most of the work required to convert the data is provided by Xlib The -XPixmapFormatValues +XPixmapFormatValues structure provides an interface to the pixmap format information that is returned at the time of a connection setup. It contains: @@ -1547,14 +1547,14 @@ Returns the number of (Cn. The XListPixmapFormats function returns an array of -XPixmapFormatValues +XPixmapFormatValues structures that describe the types of Z format images supported by the specified display. If insufficient memory is available, XListPixmapFormats returns NULL. To free the allocated storage for the -XPixmapFormatValues +XPixmapFormatValues structures, use XFree. @@ -1601,9 +1601,9 @@ 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 -LSBFirst +LSBFirst or -MSBFirst. +MSBFirst. @@ -1676,9 +1676,9 @@ 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 -LSBFirst +LSBFirst or -MSBFirst. +MSBFirst. @@ -1933,7 +1933,7 @@ BlackPixelOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -1969,7 +1969,7 @@ WhitePixelOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2005,7 +2005,7 @@ CellsOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2042,7 +2042,7 @@ DefaultColormapOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2078,7 +2078,7 @@ DefaultDepthOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2114,7 +2114,7 @@ DefaultGCOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2152,7 +2152,7 @@ DefaultVisualOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2190,7 +2190,7 @@ DoesBackingStore(screen) Specifies the appropriate -Screen +Screen structure. @@ -2204,10 +2204,10 @@ structure. Both return a value indicating whether the screen supports backing stores. The value returned can be one of -WhenMapped, -NotUseful, +WhenMapped, +NotUseful, or -Always +Always (see section 3.2.4). @@ -2233,7 +2233,7 @@ DoesSaveUnders(screen) Specifies the appropriate -Screen +Screen structure. @@ -2247,10 +2247,10 @@ structure. Both return a Boolean value indicating whether the screen supports save unders. If -True, +True, the screen supports save unders. If -False, +False, the screen does not support save unders (see section 3.2.5). @@ -2276,7 +2276,7 @@ DisplayOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2313,7 +2313,7 @@ EventMaskOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2349,7 +2349,7 @@ EventMaskOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2386,7 +2386,7 @@ WidthOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2422,7 +2422,7 @@ HeightOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2458,7 +2458,7 @@ WidthMMOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2494,7 +2494,7 @@ HeightMMOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2530,7 +2530,7 @@ MaxCmapsOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2567,7 +2567,7 @@ MinCmapsOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2604,7 +2604,7 @@ PlanesOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2640,7 +2640,7 @@ RootWindowOfScreen(screen) Specifies the appropriate -Screen +Screen structure. @@ -2663,7 +2663,7 @@ Both return the root window of the specified screen. To execute a -NoOperation +NoOperation protocol request, use XNoOp. XNoOp @@ -2690,7 +2690,7 @@ protocol request, use The XNoOp function sends a -NoOperation +NoOperation protocol request to the X server, thereby exercising the connection. @@ -2779,15 +2779,15 @@ Specifies the connection to the X server. The XCloseDisplay function closes the connection to the X server for the display specified in the -Display +Display structure and destroys all windows, resource IDs -(Window, -Font, -Pixmap, -Colormap, -Cursor, +(Window, +Font, +Pixmap, +Colormap, +Cursor, and -GContext), +GContext), or other resources that the client has created on this display, unless the close-down mode of the resource has been changed (see @@ -2808,7 +2808,7 @@ operation. XCloseDisplay can generate a -BadGC +BadGC error. @@ -2848,10 +2848,10 @@ Specifies the connection to the X server. Specifies the client close-down mode. You can pass -DestroyAll, -RetainPermanent, +DestroyAll, +RetainPermanent, or -RetainTemporary. +RetainTemporary. @@ -2863,20 +2863,20 @@ The XSetCloseDownMode defines what will happen to the client's resources at connection close. A connection starts in -DestroyAll +DestroyAll mode. For information on what happens to the client's resources when the close_mode argument is -RetainPermanent +RetainPermanent or -RetainTemporary, +RetainTemporary, see section 2.6. XSetCloseDownMode can generate a -BadValue +BadValue error. @@ -2928,9 +2928,9 @@ It releases all passive grabs made by the client. It marks all resources (including colormap entries) allocated by the client either as permanent or temporary, depending on whether the close-down mode is -RetainPermanent +RetainPermanent or -RetainTemporary. +RetainTemporary. However, this does not prevent other client applications from explicitly destroying the resources (see XSetCloseDownMode). @@ -2940,7 +2940,7 @@ destroying the resources (see When the close-down mode is -DestroyAll, +DestroyAll, the X server destroys all of a client's resources as follows: @@ -2960,7 +2960,7 @@ window. It performs a -MapWindow +MapWindow 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. @@ -2975,12 +2975,12 @@ It destroys all windows created by the client. It performs the appropriate free request on each nonwindow resource created by the client in the server (for example, -Font, -Pixmap, -Cursor, -Colormap, +Font, +Pixmap, +Cursor, +Colormap, and -GContext). +GContext). @@ -2996,7 +2996,7 @@ An X server goes through a cycle of having no connections and having some connections. When the last connection to the X server closes as a result of a connection closing with the close_mode of -DestroyAll, +DestroyAll, the X server does the following: @@ -3006,9 +3006,9 @@ 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 -RetainPermanent +RetainPermanent or -RetainTemporary +RetainTemporary mode. @@ -3042,7 +3042,7 @@ It restores the default font path. It restores the input focus to state -PointerRoot. +PointerRoot. @@ -3050,9 +3050,9 @@ It restores the input focus to state However, the X server does not reset if you close a connection with a close-down mode set to -RetainPermanent +RetainPermanent or -RetainTemporary. +RetainTemporary. @@ -3272,11 +3272,11 @@ internal connection for the specified display. The procedure is passed the display, the specified client_data, the file descriptor for the connection, a Boolean indicating whether the connection is being opened or closed, and a pointer to a location for private watch data. If opening is -True, +True, 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 -False, +False, the location pointed to by watch_data will hold this same private data pointer. diff --git a/specs/libX11/CH03.xml b/specs/libX11/CH03.xml index 25335a60..11770dc9 100644 --- a/specs/libX11/CH03.xml +++ b/specs/libX11/CH03.xml @@ -25,11 +25,11 @@ the default depth of the default root window, and the default visual type Xlib uses an opaque -Visual +Visual Visual structure that contains information about the possible color mapping. The visual utility functions (see section 16.7) use an -XVisualInfo +XVisualInfo 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 colormap_size. @@ -41,13 +41,13 @@ and can be Visual ClassesStaticColor Visual ClassesGrayScale Visual ClassesPseudoColor -StaticGray, -StaticColor, -TrueColor, -GrayScale, -PseudoColor, +StaticGray, +StaticColor, +TrueColor, +GrayScale, +PseudoColor, or -DirectColor. +DirectColor. @@ -89,16 +89,16 @@ the RGB values in the following ways: For -PseudoColor, +PseudoColor, a pixel value indexes a colormap to produce independent RGB values, and the RGB values can be changed dynamically. -GrayScale +GrayScale is treated the same way as -PseudoColor +PseudoColor except that the primary that drives the screen is undefined. Thus, the client should always store the same value for red, green, and blue in the colormaps. @@ -107,7 +107,7 @@ same value for red, green, and blue in the colormaps. For -DirectColor, +DirectColor, a pixel value is decomposed into separate RGB subfields, and each subfield separately indexes the colormap for the corresponding value. The RGB values can be changed dynamically. @@ -115,9 +115,9 @@ The RGB values can be changed dynamically. -TrueColor +TrueColor is treated the same way as -DirectColor +DirectColor except that the colormap has predefined, read-only RGB values. These RGB values are server dependent but provide linear or near-linear ramps in each primary. @@ -125,21 +125,21 @@ ramps in each primary. -StaticColor +StaticColor is treated the same way as -PseudoColor +PseudoColor except that the colormap has predefined, read-only, server-dependent RGB values. -StaticGray +StaticGray is treated the same way as -StaticColor +StaticColor except that the RGB values are equal for any single pixel value, thus resulting in shades of gray. -StaticGray +StaticGray with a two-entry colormap can be thought of as monochrome. @@ -148,9 +148,9 @@ colormap can be thought of as monochrome. The red_mask, green_mask, and blue_mask members are only defined for -DirectColor +DirectColor and -TrueColor. +TrueColor. Each has one contiguous set of bits with no intersections. The bits_per_rgb member specifies the log base 2 of the @@ -159,16 +159,16 @@ 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 -DirectColor +DirectColor and -TrueColor, +TrueColor, this is the size of an individual pixel subfield. To obtain the visual ID from a -Visual, +Visual, use XVisualIDFromVisual. XVisualIDFromVisual @@ -211,7 +211,7 @@ function returns the visual ID for the specified visual type. Window Windowattributes All -InputOutput +InputOutput 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). @@ -233,12 +233,12 @@ Windows also have associated property lists (see section 4.3). Both -InputOutput +InputOutput and -InputOnly +InputOnly windows have the following common attributes, which are the only attributes of an -InputOnly +InputOnly window: @@ -271,26 +271,26 @@ cursor If you specify any other attributes for an -InputOnly +InputOnly window, a -BadMatch +BadMatch error results. -InputOnly +InputOnly windows are used for controlling input events in situations where -InputOutput +InputOutput windows are unnecessary. -InputOnly +InputOnly windows are invisible; can only be used to control such things as cursors, input event generation, and grabbing; and cannot be used in any graphics requests. Note that -InputOnly +InputOnly windows cannot have -InputOutput +InputOutput windows as inferiors. @@ -308,7 +308,7 @@ are to be made. The pattern can either be relative to the parent or absolute. If -ParentRelative, +ParentRelative, the parent's background is used. @@ -325,7 +325,7 @@ When a window is eventually mapped to the screen XMapWindow), XMapWindow the X server generates an -Expose +Expose event for the window if backing store has not been maintained. @@ -346,7 +346,7 @@ for window managers. To set an attribute of a window, set the appropriate member of the -XSetWindowAttributes +XSetWindowAttributes structure and OR in the corresponding value bitmask in your subsequent calls to XCreateWindow and @@ -354,7 +354,7 @@ and or use one of the other convenience functions that set the appropriate attribute. The symbols for the value mask bits and the -XSetWindowAttributes +XSetWindowAttributes structure are: @@ -412,9 +412,9 @@ typedef struct { The following lists the defaults for each window attribute and indicates whether the attribute is applicable to -InputOutput +InputOutput and -InputOnly +InputOnly windows: @@ -434,7 +434,7 @@ windows: background-pixmap - None + None Yes No @@ -446,7 +446,7 @@ windows: border-pixmap - CopyFromParent + CopyFromParent Yes No @@ -458,19 +458,19 @@ windows: bit-gravity - ForgetGravity + ForgetGravity Yes No win-gravity - NorthWestGravity + NorthWestGravity Yes Yes backing-store - NotUseful + NotUseful Yes No @@ -488,7 +488,7 @@ windows: save-under - False + False Yes No @@ -506,19 +506,19 @@ windows: override-redirect - False + False Yes Yes colormap - CopyFromParent + CopyFromParent Yes No cursor - None + None Yes Yes @@ -534,10 +534,10 @@ windows: Only -InputOutput +InputOutput windows can have a background. You can set the background of an -InputOutput +InputOutput window by using a pixel or a pixmap. @@ -551,9 +551,9 @@ a window's background in a single color. You can set the background-pixmap to a pixmap, -None +None (default), or -ParentRelative. +ParentRelative. 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 @@ -569,13 +569,13 @@ If you set the background-pixmap, it overrides the default. The background-pixmap and the window must have the same depth, or a -BadMatch +BadMatch error results. If you set background-pixmap to -None, +None, the window has no defined background. If you set the background-pixmap to -ParentRelative : +ParentRelative: @@ -584,16 +584,16 @@ The parent window's background-pixmap is used. The child window, however, must have the same depth as its parent, or a -BadMatch +BadMatch error results. If the parent window has a background-pixmap of -None, +None, the window also has a background-pixmap of -None. +None. @@ -608,7 +608,7 @@ background-pixmap is required. The background tile origin always aligns with the parent window's background tile origin. If the background-pixmap is not -ParentRelative, +ParentRelative, the background tile origin is the child window's origin. @@ -630,17 +630,17 @@ When no valid contents are available for regions of a window and either the regions are visible or the server is maintaining backing store, the server automatically tiles the regions with the window's background unless the window has a background of -None. +None. If the background is -None, +None, 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. -Expose +Expose events are then generated for the regions, even if the background-pixmap is -None +None (see section 10.9). @@ -652,10 +652,10 @@ is Only -InputOutput +InputOutput windows can have a border. You can set the border of an -InputOutput +InputOutput window by using a pixel or a pixmap. @@ -672,7 +672,7 @@ The border tile origin is always the same as the background tile origin. You can also set the border-pixmap to a pixmap of any size (some may be faster than others) or to -CopyFromParent +CopyFromParent (default). You can set the border-pixel to any pixel value (no default). @@ -682,16 +682,16 @@ If you set a border-pixmap, it overrides the default. The border-pixmap and the window must have the same depth, or a -BadMatch +BadMatch error results. If you set the border-pixmap to -CopyFromParent, +CopyFromParent, 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 -BadMatch +BadMatch error results. @@ -724,17 +724,17 @@ Therefore, graphics operations never affect the window border. The bit gravity of a window defines which region of the window should be retained when an -InputOutput +InputOutput window is resized. The default value for the bit-gravity attribute is -ForgetGravity. +ForgetGravity. The window gravity of a window allows you to define how the -InputOutput +InputOutput or -InputOnly +InputOnly window should be repositioned if its parent is resized. The default value for the win-gravity attribute is -NorthWestGravity. +NorthWestGravity. @@ -761,39 +761,39 @@ change of width and height, the (x, y) pairs are defined: - NorthWestGravity + NorthWestGravity (0, 0) - NorthGravity + NorthGravity (Width/2, 0) - NorthEastGravity + NorthEastGravity (Width, 0) - WestGravity + WestGravity (0, Height/2) - CenterGravity + CenterGravity (Width/2, Height/2) - EastGravity + EastGravity (Width, Height/2) - SouthWestGravity + SouthWestGravity (0, Height) - SouthGravity + SouthGravity (Width/2, Height) - SouthEastGravity + SouthEastGravity (Width, Height) @@ -809,13 +809,13 @@ When a window with one of these win-gravities has its parent window resized, the corresponding pair defines the change in position of the window within the parent. When a window is so repositioned, a -GravityNotify +GravityNotify event is generated (see section 10.10.5). A bit-gravity of -StaticGravity +StaticGravity 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), @@ -823,25 +823,25 @@ 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 -StaticGravity +StaticGravity still only takes effect when the width or height of the window is changed, not when the window is moved. A bit-gravity of -ForgetGravity +ForgetGravity 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 -Expose +Expose 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 -Expose +Expose events. @@ -849,20 +849,20 @@ 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 -Forget +Forget instead. A win-gravity of -UnmapGravity +UnmapGravity is like -NorthWestGravity +NorthWestGravity (the window is not moved), except the child is also unmapped when the parent is resized, and an -UnmapNotify +UnmapNotify event is generated. @@ -875,7 +875,7 @@ generated. Some implementations of the X server may choose to maintain the contents of -InputOutput +InputOutput windows. If the X server maintains the contents of a window, the off-screen saved pixels @@ -883,39 +883,39 @@ 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 -NotUseful +NotUseful (default), -WhenMapped, +WhenMapped, or -Always. +Always. A backing-store attribute of -NotUseful +NotUseful advises the X server that maintaining contents is unnecessary, although some X implementations may still choose to maintain contents and, therefore, not generate -Expose +Expose events. A backing-store attribute of -WhenMapped +WhenMapped advises the X server that maintaining contents of obscured regions when the window is mapped would be beneficial. In this case, the server may generate an -Expose +Expose event when the window is created. A backing-store attribute of -Always +Always advises the X server that maintaining contents even when the window is unmapped would be beneficial. 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, -Expose +Expose events normally are not generated, but the X server may stop maintaining contents at any time. @@ -937,9 +937,9 @@ However, regions obscured by inferior windows are not included. Some server implementations may preserve contents of -InputOutput +InputOutput windows under other -InputOutput +InputOutput windows. This is not the same as preserving the contents of a window for you. You may get better visual @@ -950,12 +950,12 @@ so the temporarily obscured applications do not have to repaint. You can set the save-under flag to -True +True or -False +False (default). If save-under is -True, +True, the X server is advised that, when this window is mapped, saving the contents of windows it obscures would be beneficial. @@ -969,7 +969,7 @@ saving the contents of windows it obscures would be beneficial. You can set backing planes to indicate (with bits set to 1) which bit planes of an -InputOutput +InputOutput 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. @@ -994,14 +994,14 @@ required to store your window. The event mask defines which events the client is interested in for this -InputOutput +InputOutput or -InputOnly +InputOnly 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 -NoEventMask +NoEventMask (default). @@ -1009,26 +1009,26 @@ You can specify that no maskable events are reported by setting 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 -InputOutput +InputOutput or -InputOnly +InputOnly window. The do-not-propagate-mask is the bitwise inclusive OR of zero or more of the following masks: -KeyPress, -KeyRelease, -ButtonPress, -ButtonRelease, -PointerMotion, -Button1Motion, -Button2Motion, -Button3Motion, -Button4Motion, -Button5Motion, +KeyPress, +KeyRelease, +ButtonPress, +ButtonRelease, +PointerMotion, +Button1Motion, +Button2Motion, +Button3Motion, +Button4Motion, +Button5Motion, and -ButtonMotion. +ButtonMotion. You can specify that all events are propagated by setting -NoEventMask +NoEventMask (default). @@ -1045,9 +1045,9 @@ request. Pop-up windows, however, often need to be mapped without a window manager getting in the way. To control whether an -InputOutput +InputOutput or -InputOnly +InputOnly window is to ignore these structure control facilities, use the override-redirect flag. @@ -1055,12 +1055,12 @@ use the override-redirect flag. The override-redirect flag specifies whether map and configure requests on this window should override a -SubstructureRedirectMask +SubstructureRedirectMask on the parent. You can set the override-redirect flag to -True +True or -False +False (default). Window managers use this information to avoid tampering with pop-up windows (see also chapter 14). @@ -1075,33 +1075,33 @@ Window managers use this information to avoid tampering with pop-up windows The colormap attribute specifies which colormap best reflects the true colors of the -InputOutput +InputOutput window. The colormap must have the same visual type as the window, or a -BadMatch +BadMatch error results. X servers capable of supporting multiple hardware colormaps can use this information, and window managers can use it for calls to XInstallColormap. You can set the colormap attribute to a colormap or to -CopyFromParent +CopyFromParent (default). If you set the colormap to -CopyFromParent, +CopyFromParent, the parent window's colormap is copied and used by its child. However, the child window must have the same visual type as the parent, or a -BadMatch +BadMatch error results. The parent window must not have a colormap of -None, +None, or a -BadMatch +BadMatch error results. The colormap is copied by sharing the colormap object between the child and parent, not by making a complete copy of the colormap contents. @@ -1118,23 +1118,23 @@ not affect the child window. The cursor attribute specifies which cursor is to be used when the pointer is in the -InputOutput +InputOutput or -InputOnly +InputOnly window. You can set the cursor to a cursor or -None +None (default). If you set the cursor to -None, +None, the parent's cursor is used when the pointer is in the -InputOutput +InputOutput or -InputOnly +InputOnly window, and any change in the parent's cursor will cause an immediate change in the displayed cursor. By calling @@ -1216,18 +1216,18 @@ creates a window that inherits its attributes from its parent window. WindowInputOnly The X server acts as if -InputOnly +InputOnly windows do not exist for the purposes of graphics requests, exposure processing, and -VisibilityNotify +VisibilityNotify events. An -InputOnly +InputOnly window cannot be used as a drawable (that is, as a source or destination for graphics requests). -InputOnly +InputOnly and -InputOutput +InputOutput windows act identically in other respects (properties, grabs, input control, and so on). Extension packages can define other classes of windows. @@ -1320,7 +1320,7 @@ and do not include the created window's borders Specify the width and height(Wh. The dimensions must be nonzero, or a -BadValue +BadValue error results. @@ -1343,7 +1343,7 @@ Specifies the width of the created window's border in pixels. Specifies the window's depth. A depth of -CopyFromParent +CopyFromParent means the depth is taken from the parent. @@ -1356,12 +1356,12 @@ means the depth is taken from the parent. Specifies the created window's class. You can pass -InputOutput, -InputOnly, +InputOutput, +InputOnly, or -CopyFromParent. +CopyFromParent. A class of -CopyFromParent +CopyFromParent means the class is taken from the parent. @@ -1375,7 +1375,7 @@ is taken from the parent. Specifies the visual type. A visual of -CopyFromParent +CopyFromParent means the visual type is taken from the parent. @@ -1418,7 +1418,7 @@ The function creates an unmapped subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a -CreateNotify +CreateNotify event. The created window is placed on top in the stacking order with respect to siblings. @@ -1437,33 +1437,33 @@ the origin is inside the border at the inside, upper-left corner. The border_width for an -InputOnly +InputOnly window must be zero, or a -BadMatch +BadMatch error results. For class -InputOutput, +InputOutput, the visual type and depth must be a combination supported for the screen, or a -BadMatch +BadMatch error results. The depth need not be the same as the parent, but the parent must not be a window of class -InputOnly, +InputOnly, or a -BadMatch +BadMatch error results. For an -InputOnly +InputOnly window, the depth must be zero, and the visual must be one supported by the screen. If either condition is not met, a -BadMatch +BadMatch error results. The parent window, however, may have any depth and class. If you specify any invalid window attribute for a window, a -BadMatch +BadMatch error results. @@ -1484,21 +1484,21 @@ ancestors are mapped and it is not obscured by any of its ancestors. XCreateWindow can generate -BadAlloc, -BadColor, -BadCursor, -BadMatch, -BadPixmap, -BadValue, +BadAlloc, +BadColor, +BadCursor, +BadMatch, +BadPixmap, +BadValue, and -BadWindow +BadWindow errors. To create an unmapped -InputOutput +InputOutput subwindow of a given parent window, use XCreateSimpleWindow. XCreateSimpleWindow @@ -1582,7 +1582,7 @@ and do not include the created window's borders Specify the width and height(Wh. The dimensions must be nonzero, or a -BadValue +BadValue error results. @@ -1626,18 +1626,18 @@ Specifies the background pixel value of the window. The XCreateSimpleWindow function creates an unmapped -InputOutput +InputOutput subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a -CreateNotify +CreateNotify event. The created window is placed on top in the stacking order with respect to siblings. Any part of the window that extends outside its parent window is clipped. The border_width for an -InputOnly +InputOnly window must be zero, or a -BadMatch +BadMatch error results. XCreateSimpleWindow inherits its depth, class, and visual from its parent. @@ -1648,11 +1648,11 @@ have their default values. XCreateSimpleWindow can generate -BadAlloc, -BadMatch, -BadValue, +BadAlloc, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -1711,29 +1711,29 @@ The XDestroyWindow function destroys the specified window as well as all of its subwindows and causes the X server to generate a -DestroyNotify +DestroyNotify 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 -DestroyNotify +DestroyNotify events is such that for any given window being destroyed, -DestroyNotify +DestroyNotify is generated on any inferiors of the window before being generated on the window itself. The ordering among siblings and across subhierarchies is not otherwise constrained. If the window you specified is a root window, no windows are destroyed. Destroying a mapped window will generate -Expose +Expose events on other windows that were obscured by the window being destroyed. XDestroyWindow can generate a -BadWindow +BadWindow error. @@ -1782,13 +1782,13 @@ The function destroys all inferior windows of the specified window, in bottom-to-top stacking order. It causes the X server to generate a -DestroyNotify +DestroyNotify event for each window. If any mapped subwindows were actually destroyed, XDestroySubwindows causes the X server to generate -Expose +Expose events on the specified window. This is much more efficient than deleting many windows one at a time because much of the work need be performed only once for all @@ -1799,7 +1799,7 @@ The subwindows should never be referenced again. XDestroySubwindows can generate a -BadWindow +BadWindow error. @@ -1834,11 +1834,11 @@ It is entirely clipped by an ancestor. -Expose +Expose events are generated for the window when part or all of it becomes visible on the screen. A client receives the -Expose +Expose events only if it has asked for them. Windows retain their position in the stacking order when they are unmapped. @@ -1846,15 +1846,15 @@ Windows retain their position in the stacking order when they are unmapped. A window manager may want to control the placement of subwindows. If -SubstructureRedirectMask +SubstructureRedirectMask 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 -MapRequest +MapRequest event. However, if the override-redirect flag on the child had been set to -True +True (usually only on pop-up menus), the map request is performed. @@ -1867,16 +1867,16 @@ 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 -SubstructureRedirectMask. +SubstructureRedirectMask. Similarly, a single client can select for -ResizeRedirectMask +ResizeRedirectMask on a parent window. Then, any attempt to resize the window by another client is suppressed, and the client receives a -ResizeRequest +ResizeRequest event. @@ -1937,16 +1937,16 @@ This function has no effect if the window is already mapped. If the override-redirect of the window is -False +False and if some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent window, then the X server generates a -MapRequest +MapRequest event, and the XMapWindow function does not map the window. Otherwise, the window is mapped, and the X server generates a -MapNotify +MapNotify event. @@ -1956,10 +1956,10 @@ 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 -Expose +Expose events. If backing-store was maintained while the window was unmapped, no -Expose +Expose events are generated. If backing-store will now be maintained, @@ -1971,29 +1971,29 @@ Similar tiling and exposure take place for any newly viewable inferiors. XMapWindow If the window is an -InputOutput +InputOutput window, XMapWindow generates -Expose +Expose events on each -InputOutput +InputOutput 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 -Expose +Expose events and then map the window, so the client processes input events as usual. The event list will include -Expose +Expose for each window that has appeared on the screen. The client's normal response to an -Expose +Expose event should be to repaint the window. This method usually leads to simpler programs and to proper interaction with window managers. @@ -2002,7 +2002,7 @@ with window managers. XMapWindow can generate a -BadWindow +BadWindow error. @@ -2062,7 +2062,7 @@ see XMapRaised can generate multiple -BadWindow +BadWindow errors. @@ -2112,7 +2112,7 @@ The function maps all subwindows for a specified window in top-to-bottom stacking order. The X server generates -Expose +Expose 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 @@ -2122,7 +2122,7 @@ only once, for all of the windows, rather than for each window. XMapSubwindows can generate a -BadWindow +BadWindow error. @@ -2179,7 +2179,7 @@ Specifies the window. The XUnmapWindow function unmaps the specified window and causes the X server to generate an -UnmapNotify +UnmapNotify UnmapNotify Event XUnmapWindow event. @@ -2192,14 +2192,14 @@ 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 -Expose +Expose events on windows that were formerly obscured by it. XUnmapWindow can generate a -BadWindow +BadWindow error. @@ -2248,9 +2248,9 @@ The function unmaps all subwindows for the specified window in bottom-to-top stacking order. It causes the X server to generate an -UnmapNotify +UnmapNotify event on each subwindow and -Expose +Expose events on formerly obscured windows. UnmapNotify Event Using this function is much more efficient than unmapping multiple windows @@ -2261,7 +2261,7 @@ only once, for all of the windows, rather than for each window. XUnmapSubwindows can generate a -BadWindow +BadWindow error. @@ -2280,11 +2280,11 @@ move a window, resize a window, move and resize a window, or change a window's border width. To change one of these parameters, set the appropriate member of the -XWindowChanges +XWindowChanges structure and OR in the corresponding value mask in subsequent calls to XConfigureWindow. The symbols for the value mask bits and the -XWindowChanges +XWindowChanges structure are: @@ -2323,7 +2323,7 @@ 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 -BadValue +BadValue error results. Attempts to configure a root window have no effect. @@ -2333,9 +2333,9 @@ The border_width member is used to set the width of the border in pixels. Note that setting just the border width leaves the outer-left corner of the window in a fixed position but moves the absolute position of the window's origin. If you attempt to set the border-width attribute of an -InputOnly +InputOnly window nonzero, a -BadMatch +BadMatch error results. @@ -2343,49 +2343,49 @@ 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 -Above, -Below, -TopIf, -BottomIf, +Above, +Below, +TopIf, +BottomIf, or -Opposite. +Opposite. If the override-redirect flag of the window is -False +False and if some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates a -ConfigureRequest +ConfigureRequest event, and no further processing is performed. Otherwise, if some other client has selected -ResizeRedirectMask +ResizeRedirectMask on the window and the inside width or height of the window is being changed, a -ResizeRequest +ResizeRequest 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 -ResizeRedirectMask +ResizeRedirectMask and that -SubstructureRedirectMask +SubstructureRedirectMask on the parent has precedence over -ResizeRedirectMask +ResizeRedirectMask on the window. When the geometry of the window is changed as specified, the window is restacked among siblings, and a -ConfigureNotify +ConfigureNotify event is generated if the state of the window actually changes. -GravityNotify +GravityNotify events are generated after -ConfigureNotify +ConfigureNotify events. If the inside width or height of the window has actually changed, children of the window are affected as specified. @@ -2409,15 +2409,15 @@ and any regions where window contents are lost. The restack check (specifically, the computation for -BottomIf, -TopIf, +BottomIf, +TopIf, and -Opposite) +Opposite) 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 -BadMatch +BadMatch error results. @@ -2431,23 +2431,23 @@ the window is restacked as follows: - Above + Above The window is placed just above the sibling. - Below + Below The window is placed just below the sibling. - TopIf + TopIf If the sibling occludes the window, the window is placed at the top of the stack. - BottomIf + BottomIf If the window occludes the sibling, the window is placed at the bottom of the stack. - Opposite + Opposite If the sibling occludes the window, the window is placed at the top of the stack. If the window occludes the sibling, @@ -2470,15 +2470,15 @@ the window is restacked as follows: - Above + Above The window is placed at the top of the stack. - Below + Below The window is placed at the bottom of the stack. - TopIf + TopIf If any sibling occludes the window, the window is placed at the top of the stack. @@ -2491,7 +2491,7 @@ the bottom of the stack. - Opposite + Opposite If any sibling occludes the window, the window is placed at the top of the stack. @@ -2565,7 +2565,7 @@ This mask is the bitwise inclusive OR of the valid configure window values bits. Specifies the -XWindowChanges +XWindowChanges structure. @@ -2578,7 +2578,7 @@ structure. The XConfigureWindow function uses the values specified in the -XWindowChanges +XWindowChanges structure to reconfigure a window's size, position, border, and stacking order. Values not specified are taken from the existing geometry of the window. @@ -2587,13 +2587,13 @@ 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 -BadMatch +BadMatch error results. Note that the computations for -BottomIf, -TopIf, +BottomIf, +TopIf, and -Opposite +Opposite are performed with respect to the window's final geometry (as controlled by the other arguments passed to XConfigureWindow), @@ -2607,10 +2607,10 @@ changed to reflect the current screen contents XConfigureWindow can generate -BadMatch, -BadValue, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -2689,21 +2689,21 @@ depending on if the window is obscured by nonchildren and if no backing store exists. If the contents of the window are lost, the X server generates -Expose +Expose events. Moving a mapped window generates -Expose +Expose events on any formerly obscured windows. If the override-redirect flag of the window is -False +False and some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates a -ConfigureRequest +ConfigureRequest event, and no further processing is performed. Otherwise, the window is moved. @@ -2712,7 +2712,7 @@ Otherwise, the window is moved. XMoveWindow can generate a -BadWindow +BadWindow error. @@ -2787,35 +2787,35 @@ its borders. This function 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 -Expose +Expose events. If a mapped window is made smaller, changing its size generates -Expose +Expose events on windows that the mapped window formerly obscured. If the override-redirect flag of the window is -False +False and some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates a -ConfigureRequest +ConfigureRequest event, and no further processing is performed. If either width or height is zero, a -BadValue +BadValue error results. XResizeWindow can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -2911,22 +2911,22 @@ The function changes the size and location of the specified window without raising it. Moving and resizing a mapped window may generate an -Expose +Expose event on the window. Depending on the new size and location parameters, moving and resizing a window may generate -Expose +Expose events on windows that the window formerly obscured. If the override-redirect flag of the window is -False +False and some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates a -ConfigureRequest +ConfigureRequest event, and no further processing is performed. Otherwise, the window size and location are changed. @@ -2934,9 +2934,9 @@ Otherwise, the window size and location are changed. XMoveResizeWindow can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -2999,7 +2999,7 @@ function sets the specified window's border width to the specified width. XSetWindowBorderWidth can generate a -BadWindow +BadWindow error. @@ -3067,18 +3067,18 @@ 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 window may generate -Expose +Expose events for the window and any mapped subwindows that were formerly obscured. If the override-redirect attribute of the window is -False +False and some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates a -ConfigureRequest +ConfigureRequest event, and no processing is performed. Otherwise, the window is raised. @@ -3086,7 +3086,7 @@ Otherwise, the window is raised. XRaiseWindow can generate a -BadWindow +BadWindow error. @@ -3140,18 +3140,18 @@ stacked on a desk, then lowering a window is analogous 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 -Expose +Expose events on any windows it formerly obscured. If the override-redirect attribute of the window is -False +False and some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates a -ConfigureRequest +ConfigureRequest event, and no processing is performed. Otherwise, the window is lowered to the bottom of the stack. @@ -3160,7 +3160,7 @@ stack. XLowerWindow can generate a -BadWindow +BadWindow error. @@ -3209,9 +3209,9 @@ Specifies the window. Specifies the direction (up or down) that you want to circulate the window. You can pass -RaiseLowest +RaiseLowest or -LowerHighest. +LowerHighest. @@ -3225,33 +3225,33 @@ The function circulates children of the specified window in the specified direction. If you specify -RaiseLowest, +RaiseLowest, XCirculateSubwindows raises the lowest mapped child (if any) that is occluded by another child to the top of the stack. If you specify -LowerHighest, +LowerHighest, XCirculateSubwindows 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 -SubstructureRedirectMask +SubstructureRedirectMask on the window, the X server generates a -CirculateRequest +CirculateRequest event, and no further processing is performed. If a child is actually restacked, the X server generates a -CirculateNotify +CirculateNotify event. XCirculateSubwindows can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -3306,14 +3306,14 @@ Completely unobscured children are not affected. This is a convenience function equivalent to XCirculateSubwindows with -RaiseLowest +RaiseLowest specified. XCirculateSubwindowsUp can generate a -BadWindow +BadWindow error. @@ -3366,14 +3366,14 @@ Completely unobscured children are not affected. This is a convenience function equivalent to XCirculateSubwindows with -LowerHighest +LowerHighest specified. XCirculateSubwindowsDown can generate a -BadWindow +BadWindow error. @@ -3439,18 +3439,18 @@ in the order of the array. The stacking order of the other windows is not affected. For each window in the window array that is not a child of the specified window, a -BadMatch +BadMatch error results. If the override-redirect attribute of a window is -False +False and some other client has selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent, the X server generates -ConfigureRequest +ConfigureRequest 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. @@ -3459,7 +3459,7 @@ Otherwise, the windows will be restacked in top-to-bottom order. XRestackWindows can generate a -BadWindow +BadWindow error. @@ -3477,7 +3477,7 @@ Xlib provides functions that you can use to set window attributes. XChangeWindowAttributes is the more general function that allows you to set one or more window attributes provided by the -XSetWindowAttributes +XSetWindowAttributes structure. The other functions described in this section allow you to set one specific window attribute, such as a window's background. @@ -3569,7 +3569,7 @@ Depending on the valuemask, the XChangeWindowAttributes function uses the window attributes in the -XSetWindowAttributes +XSetWindowAttributes structure to change the specified window attributes. Changing the background does not cause the window contents to be changed. @@ -3578,31 +3578,31 @@ To repaint the window and its background, use Setting the border or changing the background such that the border tile origin changes causes the border to be repainted. Changing the background of a root window to -None +None or -ParentRelative +ParentRelative restores the default background pixmap. Changing the border of a root window to -CopyFromParent +CopyFromParent restores the default border pixmap. Changing the win-gravity does not affect the current position of the window. Changing the backing-store of an obscured window to -WhenMapped +WhenMapped or -Always, +Always, or changing the backing-planes, backing-pixel, or save-under of a mapped window may have no immediate effect. Changing the colormap of a window (that is, defining a new map, not changing the contents of the existing map) generates a -ColormapNotify +ColormapNotify event. Changing the colormap of a visible window may have no immediate effect on the screen because the map may not be installed (see XInstallColormap). Changing the cursor of a root window to -None +None restores the default cursor. Whenever possible, you are encouraged to share colormaps. @@ -3614,14 +3614,14 @@ Their event masks are maintained separately. When an event is generated, it is reported to all interested clients. However, only one client at a time can select for -SubstructureRedirectMask, -ResizeRedirectMask, +SubstructureRedirectMask, +ResizeRedirectMask, and -ButtonPressMask. +ButtonPressMask. If a client attempts to select any of these event masks and some other client has already selected one, a -BadAccess +BadAccess error results. There is only one do-not-propagate-mask for a window, not one per client. @@ -3630,14 +3630,14 @@ not one per client. XChangeWindowAttributes can generate -BadAccess, -BadColor, -BadCursor, -BadMatch, -BadPixmap, -BadValue, +BadAccess, +BadColor, +BadCursor, +BadMatch, +BadPixmap, +BadValue, and -BadWindow +BadWindow errors. @@ -3699,18 +3699,18 @@ Changing the background does not cause the window contents to be changed. XSetWindowBackground uses a pixmap of undefined size filled with the pixel value you passed. If you try to change the background of an -InputOnly +InputOnly window, a -BadMatch +BadMatch error results. XSetWindowBackground can generate -BadMatch +BadMatch and -BadWindow +BadWindow errors. @@ -3761,9 +3761,9 @@ Specifies the window. Specifies the background pixmap, -ParentRelative, +ParentRelative, or -None. +None. @@ -3780,27 +3780,27 @@ function sets the background pixmap of the window to the specified pixmap. The background pixmap can immediately be freed if no further explicit references to it are to be made. If -ParentRelative +ParentRelative 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 -InputOnly +InputOnly window, a -BadMatch +BadMatch error results. If the background is set to -None, +None, the window has no defined background. XSetWindowBackgroundPixmap can generate -BadMatch, -BadPixmap, +BadMatch, +BadPixmap, and -BadWindow +BadWindow errors. XSetWindowBackground @@ -3865,18 +3865,18 @@ The XSetWindowBorder function sets the border of the window to the pixel value you specify. If you attempt to perform this on an -InputOnly +InputOnly window, a -BadMatch +BadMatch error results. XSetWindowBorder can generate -BadMatch +BadMatch and -BadWindow +BadWindow errors. @@ -3923,7 +3923,7 @@ Specifies the window. Specifies the border pixmap or -CopyFromParent. +CopyFromParent. @@ -3938,12 +3938,12 @@ 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 -CopyFromParent, +CopyFromParent, a copy of the parent window's border pixmap is used. If you attempt to perform this on an -InputOnly +InputOnly window, a -BadMatch +BadMatch error results. Resource IDsfreeing Freeingresources @@ -3952,10 +3952,10 @@ error results. XSetWindowBorderPixmap can generate -BadMatch, -BadPixmap, +BadMatch, +BadPixmap, and -BadWindow +BadWindow errors. @@ -4015,17 +4015,17 @@ The function sets the specified colormap of the specified window. The colormap must have the same visual type as the window, or a -BadMatch +BadMatch error results. XSetWindowColormap can generate -BadColor, -BadMatch, +BadColor, +BadMatch, and -BadWindow +BadWindow errors. @@ -4073,7 +4073,7 @@ Specifies the window. Specifies the cursor that is to be displayed or -None. +None. @@ -4084,7 +4084,7 @@ Specifies the cursor that is to be displayed or If a cursor is set, it will be used when the pointer is in the window. If the cursor is -None, +None, it is equivalent to XUndefineCursor. @@ -4092,9 +4092,9 @@ it is equivalent to XDefineCursor can generate -BadCursor +BadCursor and -BadWindow +BadWindow errors. @@ -4153,7 +4153,7 @@ the default cursor is restored. XUndefineCursor can generate a -BadWindow +BadWindow error. diff --git a/specs/libX11/CH04.xml b/specs/libX11/CH04.xml index a3d99844..532df369 100644 --- a/specs/libX11/CH04.xml +++ b/specs/libX11/CH04.xml @@ -134,7 +134,7 @@ To free a non-NULL children list when it is no longer needed, use XQueryTree can generate a -BadWindow +BadWindow error. @@ -182,7 +182,7 @@ Specifies the window (Wi. Returns the specified window's attributes in the -XWindowAttributes +XWindowAttributes structure. @@ -195,7 +195,7 @@ structure. The XGetWindowAttributes function returns the current attributes for the specified window to an -XWindowAttributes +XWindowAttributes structure. @@ -241,13 +241,13 @@ The border_width member is set to the window's border width in pixels. The depth member is set to the depth of the window (that is, bits per pixel for the object). The visual member is a pointer to the screen's associated -Visual +Visual 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 -InputOutput +InputOutput or -InputOnly. +InputOnly. @@ -260,24 +260,24 @@ and can be one of the following: - ForgetGravity - EastGravity + ForgetGravity + EastGravity - NorthWestGravity - SouthWestGravity + NorthWestGravity + SouthWestGravity - NorthGravity - SouthGravity + NorthGravity + SouthGravity - NorthEastGravity - SouthEastGravity + NorthEastGravity + SouthEastGravity - WestGravity - StaticGravity + WestGravity + StaticGravity @@ -294,27 +294,27 @@ and can be one of the following: - UnmapGravity - EastGravity + UnmapGravity + EastGravity - NorthWestGravity - SouthWestGravity + NorthWestGravity + SouthWestGravity - NorthGravity - SouthGravity + NorthGravity + SouthGravity - NorthEastGravity - SouthEastGravity + NorthEastGravity + SouthEastGravity - WestGravity - StaticGravity + WestGravity + StaticGravity - CenterGravity + CenterGravity @@ -330,10 +330,10 @@ 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 -WhenMapped, -Always, +WhenMapped, +Always, or -NotUseful. +NotUseful. The backing_planes member is set to indicate (with bits set to 1) which bit planes of the window hold dynamic data that must be preserved in backing_stores and during save_unders. @@ -343,23 +343,23 @@ for planes not set in backing_planes. The save_under member is set to -True +True or -False. +False. The colormap member is set to the colormap for the specified window and can be a colormap ID or -None. +None. The map_installed member is set to indicate whether the colormap is currently installed and can be -True +True or -False. +False. The map_state member is set to indicate the state of the window and can be -IsUnmapped, -IsUnviewable, +IsUnmapped, +IsUnviewable, or -IsViewable. -IsUnviewable +IsViewable. +IsUnviewable is used if the window is mapped but some ancestor is unmapped. @@ -375,11 +375,11 @@ 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 -True +True or -False. +False. Window manager clients should ignore the window if this member is -True. +True. @@ -392,9 +392,9 @@ having to loop over the root window fields to see which field matches. XGetWindowAttributes can generate -BadDrawable +BadDrawable and -BadWindow +BadWindow errors. @@ -530,13 +530,13 @@ The geometry of the drawable includes the x and y coordinates, width and height, border width, and depth. These are described in the argument list. It is legal to pass to this function a window whose class is -InputOnly. +InputOnly. XGetGeometry can generate a -BadDrawable +BadDrawable error. @@ -668,7 +668,7 @@ destination window. If XTranslateCoordinates returns -True, +True, it takes the src_x and src_y coordinates relative to the source window's origin and returns these coordinates to dest_x_return and dest_y_return @@ -676,19 +676,19 @@ relative to the destination window's origin. If XTranslateCoordinates returns -False, +False, 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 -None. +None. XTranslateCoordinates can generate a -BadWindow +BadWindow error. @@ -817,23 +817,23 @@ coordinates relative to the root window's origin. If XQueryPointer returns -False, +False, the pointer is not on the same screen as the specified window, and XQueryPointer returns -None +None to child_return and zero to win_x_return and win_y_return. If XQueryPointer returns -True, +True, the pointer coordinates returned to win_x_return and win_y_return are relative to the origin of the specified window. In this case, XQueryPointer returns the child that contains the pointer, if any, or else -None +None to child_return. @@ -855,7 +855,7 @@ may lag the physical state if device event processing is frozen XQueryPointer can generate a -BadWindow +BadWindow error. @@ -912,7 +912,7 @@ predefined in the server for commonly used functions. The atoms for these properties are defined in To avoid name clashes with user symbols, the -#define +#define 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 properties, @@ -962,7 +962,7 @@ Font properties Type of a -ClientMessage +ClientMessage event (none are built into the X server) @@ -1237,12 +1237,12 @@ The function returns the atom identifier associated with the specified atom_name string. If only_if_exists is -False, +False, the atom is created if it does not exist. Therefore, XInternAtom can return -None. +None. If the atom name is not in the Host Portable Character Encoding, the result is implementation-dependent. Uppercase and lowercase matter; @@ -1256,9 +1256,9 @@ the X server closes. XInternAtom can generate -BadAlloc +BadAlloc and -BadValue +BadValue errors. @@ -1357,9 +1357,9 @@ otherwise, it returns zero. XInternAtoms can generate -BadAlloc +BadAlloc and -BadValue +BadValue errors. @@ -1418,7 +1418,7 @@ call XGetAtomName can generate a -BadAtom +BadAtom error. @@ -1506,7 +1506,7 @@ otherwise, it returns zero. XGetAtomNames can generate a -BadAtom +BadAtom error. @@ -1521,11 +1521,11 @@ You can attach a property list to every window. Each property 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 -char +char is used to represent 8-bit quantities, the type -short +short is used to represent 16-bit quantities, and the type -long +long is used to represent 32-bit quantities. @@ -1634,7 +1634,7 @@ Specifies a Boolean value that determines whether the property is deleted. Specifies the atom identifier associated with the property type or -AnyPropertyType. +AnyPropertyType. @@ -1709,7 +1709,7 @@ sets the return arguments as follows: If the specified property does not exist for the specified window, XGetWindowProperty returns -None +None to actual_type_return and the value zero to actual_format_return and bytes_after_return. The nitems_return argument is empty. @@ -1733,7 +1733,7 @@ The nitems_return argument is empty. If the specified property exists and either you assign -AnyPropertyType +AnyPropertyType to the req_type argument or the specified type matches the actual property type, XGetWindowProperty returns the actual property type to actual_type_return and the actual @@ -1761,7 +1761,7 @@ The returned value starts at byte index I in the property (indexing from zero), and its length in bytes is L. If the value for long_offset causes L to be negative, a -BadValue +BadValue error results. The value of bytes_after_return is A, giving the number of trailing unread bytes in the stored property. @@ -1771,13 +1771,13 @@ giving the number of trailing unread bytes in the stored property. If the returned format is 8, the returned data is represented as a -char +char array. If the returned format is 16, the returned data is represented as a -short +short array and should be cast to that type to obtain the elements. If the returned format is 32, the returned data is represented as a -long +long array and should be cast to that type to obtain the elements. @@ -1791,18 +1791,18 @@ do not have to be copied into yet another string before use. If delete is -True +True and bytes_after_return is zero, XGetWindowProperty deletes the property from the window and generates a -PropertyNotify +PropertyNotify event on the window. The function returns -Success +Success if it executes successfully. To free the resulting data, use @@ -1812,10 +1812,10 @@ use XGetWindowProperty can generate -BadAtom, -BadValue, +BadAtom, +BadValue, and -BadWindow +BadWindow errors. @@ -1883,7 +1883,7 @@ To free the memory allocated by this function, use XListProperties can generate a -BadWindow +BadWindow error. @@ -1984,10 +1984,10 @@ to Specifies the mode of the operation. You can pass -PropModeReplace, -PropModePrepend, +PropModeReplace, +PropModePrepend, or -PropModeAppend. +PropModeAppend. @@ -2020,7 +2020,7 @@ The XChangeProperty function alters the property for the specified window and causes the X server to generate a -PropertyNotify +PropertyNotify event on that window. XChangeProperty performs the following: @@ -2029,7 +2029,7 @@ performs the following: If mode is -PropModeReplace, +PropModeReplace, XChangeProperty discards the previous property value and stores the new data. @@ -2037,15 +2037,15 @@ discards the previous property value and stores the new data. If mode is -PropModePrepend +PropModePrepend or -PropModeAppend, +PropModeAppend, XChangeProperty inserts the specified data before the beginning of the existing data or onto the end of the existing data, respectively. The type and format must match the existing property value, or a -BadMatch +BadMatch error results. If the property is undefined, it is treated as defined with the correct type and @@ -2056,13 +2056,13 @@ format with zero-length data. If the specified format is 8, the property data must be a -char +char array. If the specified format is 16, the property data must be a -short +short array. If the specified format is 32, the property data must be a -long +long array. @@ -2075,19 +2075,19 @@ 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 -BadAlloc +BadAlloc error results.) XChangeProperty can generate -BadAlloc, -BadAtom, -BadMatch, -BadValue, +BadAlloc, +BadAtom, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -2171,7 +2171,7 @@ The XRotateWindowProperties function allows you to rotate properties on a window and causes the X server to generate -PropertyNotify +PropertyNotify events. If the property names in the properties array are viewed as being numbered starting from zero and if there are num_prop property names in the list, @@ -2182,17 +2182,17 @@ of property names (right for positive npositions, left for negative npositions). If npositions mod N is nonzero, the X server generates a -PropertyNotify +PropertyNotify event for each property in the order that they are listed in the array. If an atom occurs more than once in the list or no property with that name is defined for the window, a -BadMatch +BadMatch error results. If a -BadAtom +BadAtom or -BadMatch +BadMatch error results, no properties are changed. @@ -2200,10 +2200,10 @@ no properties are changed. XRotateWindowProperties can generate -BadAtom, -BadMatch, +BadAtom, +BadMatch, and -BadWindow +BadWindow errors. @@ -2265,16 +2265,16 @@ The function deletes the specified property only if the property was defined on the specified window and causes the X server to generate a -PropertyNotify +PropertyNotify event on the window unless the property does not exist. XDeleteProperty can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. @@ -2376,7 +2376,7 @@ Specifies the selection atom. Specifies the owner of the specified selection atom. You can pass a window or -None. +None. @@ -2388,7 +2388,7 @@ You can pass a window or Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -2405,12 +2405,12 @@ 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 -CurrentTime +CurrentTime replaced by the current server time. If the owner window is specified as -None, +None, then the owner of the selection becomes -None +None (that is, no owner). Otherwise, the owner of the selection becomes the client executing the request. @@ -2418,13 +2418,13 @@ the request. If the new owner (whether a client or -None) +None) is not the same as the current owner of the selection and the current owner is not -None, +None, the current owner is sent a -SelectionClear +SelectionClear event. If the client that is the owner of a selection is later terminated (that is, its connection is closed) @@ -2432,14 +2432,14 @@ or if the owner window it has specified in the request is later destroyed, the owner of the selection automatically reverts to -None, +None, but the last-change time is not affected. The selection atom is uninterpreted by the X server. XGetSelectionOwner returns the owner window, which is reported in -SelectionRequest +SelectionRequest and -SelectionClear +SelectionClear events. Selections are global to the X server. @@ -2447,9 +2447,9 @@ Selections are global to the X server. XSetSelectionOwner can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. @@ -2501,9 +2501,9 @@ function returns the window ID associated with the window that currently owns the specified selection. If no selection was specified, the function returns the constant -None. +None. If -None +None is returned, there is no owner for the selection. @@ -2511,7 +2511,7 @@ there is no owner for the selection. XGetSelectionOwner can generate a -BadAtom +BadAtom error. @@ -2572,7 +2572,7 @@ Specifies the target atom. Specifies the property name. You also can pass -None. +None. @@ -2594,7 +2594,7 @@ Specifies the requestor. Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -2611,7 +2611,7 @@ type: If the specified selection has an owner, the X server sends a -SelectionRequest +SelectionRequest event to that owner. @@ -2619,10 +2619,10 @@ event to that owner. If no owner for the specified selection exists, the X server generates a -SelectionNotify +SelectionNotify event to the requestor with property -None. +None. @@ -2635,9 +2635,9 @@ There are two predefined selection atoms: PRIMARY and SECONDARY. XConvertSelection can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. diff --git a/specs/libX11/CH05.xml b/specs/libX11/CH05.xml index 12dfd33f..2b245b6e 100644 --- a/specs/libX11/CH05.xml +++ b/specs/libX11/CH05.xml @@ -94,16 +94,16 @@ The 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 -InputOnly +InputOnly window to the drawable argument. The width and height arguments must be nonzero, or a -BadValue +BadValue error results. The depth argument must be one of the depths supported by the screen of the specified drawable, or a -BadValue +BadValue error results. @@ -120,10 +120,10 @@ The initial contents of the pixmap are undefined. XCreatePixmap can generate -BadAlloc, -BadDrawable, +BadAlloc, +BadDrawable, and -BadValue +BadValue errors. @@ -177,7 +177,7 @@ The pixmap should never be referenced again. XFreePixmap can generate a -BadPixmap +BadPixmap error. @@ -280,9 +280,9 @@ see appendix B. XCreateFontCursor can generate -BadAlloc +BadAlloc and -BadValue +BadValue errors. @@ -331,7 +331,7 @@ Specifies the font for the source glyph. Specifies the font for the mask glyph or -None. +None. @@ -388,12 +388,12 @@ 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 -BadValue +BadValue error results. If mask_font is given, mask_char must be a defined glyph in mask_font, or a -BadValue +BadValue error results. The mask_font and character are optional. The origins of the source_char and mask_char (if defined) glyphs are @@ -417,10 +417,10 @@ least significant byte. XCreateGlyphCursor can generate -BadAlloc, -BadFont, +BadAlloc, +BadFont, and -BadValue +BadValue errors. @@ -472,7 +472,7 @@ Specifies the shape of the source cursor. Specifies the cursor's source bits to be displayed or -None. +None. @@ -529,14 +529,14 @@ function creates a cursor and returns the cursor ID associated with it. The foreground and background RGB values must be specified using foreground_color and background_color, even if the X server only has a -StaticGray +StaticGray or -GrayScale +GrayScale screen. The foreground color is used for the pixels set to 1 in the source, and the background color is used for the pixels set to 0. Both source and mask, if specified, must have depth one (or a -BadMatch +BadMatch error results) but can have any root. The mask argument defines the shape of the cursor. The pixels set to 1 in the mask define which source pixels are displayed, @@ -545,11 +545,11 @@ 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 -BadMatch +BadMatch error results. The hotspot must be a point within the source, or a -BadMatch +BadMatch error results. @@ -566,9 +566,9 @@ The X server might or might not make a copy of the pixmap. XCreatePixmapCursor can generate -BadAlloc +BadAlloc and -BadPixmap +BadPixmap errors. @@ -673,7 +673,7 @@ cannot support large ones. XQueryBestCursor can generate a -BadDrawable +BadDrawable error. @@ -744,14 +744,14 @@ function changes the color of the specified cursor, and if the cursor is being displayed on a screen, the change is visible immediately. The pixel members of the -XColor +XColor structures are ignored; only the RGB values are used. XRecolorCursor can generate a -BadCursor +BadCursor error. @@ -806,7 +806,7 @@ The specified cursor ID should not be referred to again. XFreeCursor can generate a -BadCursor +BadCursor error. diff --git a/specs/libX11/CH06.xml b/specs/libX11/CH06.xml index 3e432fab..719bfd6e 100644 --- a/specs/libX11/CH06.xml +++ b/specs/libX11/CH06.xml @@ -156,13 +156,13 @@ macro returns the default visual type for the specified screen. Color map Possible visual types are -StaticGray, -GrayScale, -StaticColor, -PseudoColor, -TrueColor, +StaticGray, +GrayScale, +StaticColor, +PseudoColor, +TrueColor, or -DirectColor +DirectColor (see section 3.1). @@ -173,7 +173,7 @@ or Functions that operate only on RGB color space values use an -XColor +XColor structure, which contains: @@ -204,26 +204,26 @@ 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 -DoRed, -DoGreen, +DoRed, +DoGreen, and -DoBlue. +DoBlue. Functions that operate on all color space values use an -XcmsColor +XcmsColor structure. This structure contains a union of substructures, each supporting color specification encoding for a particular color space. Like the -XColor +XColor structure, the -XcmsColor +XcmsColor structure contains pixel and color specification information (the spec member in the -XcmsColor +XcmsColor structure). XcmsColor @@ -258,7 +258,7 @@ typedef struct { Because the color specification can be encoded for the various color spaces, encoding for the spec member is identified by the format member, which is of type -XcmsColorFormat. +XcmsColorFormat. The following macros define standard formats. @@ -431,7 +431,7 @@ The device-dependent formats provided allow color specification in: RGB Intensity -(XcmsRGBi) +(XcmsRGBi) @@ -444,17 +444,17 @@ where 1.0 indicates full intensity, 0.5 half intensity, and so on. RGB Device -(XcmsRGB) +(XcmsRGB) Red, green, and blue values appropriate for the specified output device. -XcmsRGB +XcmsRGB values are of type unsigned short, scaled from 0 to 65535 inclusive, and are interchangeable with the red, green, and blue values in an -XColor +XColor structure. @@ -762,20 +762,20 @@ so the default CCC attributes can be modified to affect new CCCs. Xcms functions in which gamut mapping can occur return -Status +Status and have specific status values defined for them, as follows: -XcmsFailure +XcmsFailure indicates that the function failed. -XcmsSuccess +XcmsSuccess indicates that the function succeeded. In addition, if the function performed any color conversion, @@ -784,7 +784,7 @@ the colors did not need to be compressed. -XcmsSuccessWithCompression +XcmsSuccessWithCompression indicates the function performed color conversion and at least one of the colors needed to be compressed. The gamut compression method is determined by the gamut compression @@ -846,7 +846,7 @@ Specifies the window (Wi. Specifies a visual type supported on the screen. If the visual type is not one supported by the screen, a -BadMatch +BadMatch error results. @@ -859,9 +859,9 @@ error results. Specifies the colormap entries to be allocated. You can pass -AllocNone +AllocNone or -AllocAll. +AllocAll. @@ -881,30 +881,30 @@ Note that the specified window is only used to determine the screen. The initial values of the colormap entries are undefined for the visual classes -GrayScale, -PseudoColor, +GrayScale, +PseudoColor, and -DirectColor. +DirectColor. For -StaticGray, -StaticColor, +StaticGray, +StaticColor, and -TrueColor, +TrueColor, the entries have defined values, but those values are specific to the visual and are not defined by X. For -StaticGray, -StaticColor, +StaticGray, +StaticColor, and -TrueColor, +TrueColor, alloc must be -AllocNone, +AllocNone, or a -BadMatch +BadMatch error results. For the other visual classes, if alloc is -AllocNone, +AllocNone, the colormap initially has no allocated entries, and clients can allocate them. For information about the visual types, @@ -913,19 +913,19 @@ see section 3.1. If alloc is -AllocAll, +AllocAll, the entire colormap is allocated writable. The initial values of all allocated entries are undefined. For -GrayScale +GrayScale and -PseudoColor, +PseudoColor, the effect is as if an XAllocColorCells call returned all pixel values from zero to N - 1, where N is the colormap entries value in the specified visual. For -DirectColor, +DirectColor, the effect is as if an XAllocColorPlanes call returned a pixel value of zero and red_mask, green_mask, @@ -939,11 +939,11 @@ none of these entries can be freed by using XCreateColormap can generate -BadAlloc, -BadMatch, -BadValue, +BadAlloc, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -998,13 +998,13 @@ 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 -AllocAll, +AllocAll, the new colormap is also created with -AllocAll, +AllocAll, all color values for all entries are copied from the specified colormap, and then all entries in the specified colormap are freed. If the specified colormap was not created by the client with -AllocAll, +AllocAll, the allocations to be moved are all those pixels and planes that have been allocated by the client using XAllocColor, @@ -1018,9 +1018,9 @@ and that have not been freed since they were allocated. XCopyColormapAndFree can generate -BadAlloc +BadAlloc and -BadColor +BadColor errors. @@ -1081,18 +1081,18 @@ or XChangeWindowAttributes), XFreeColormap changes the colormap associated with the window to -None +None and generates a -ColormapNotify +ColormapNotify event. X does not define the colors displayed for a window with a colormap of -None. +None. XFreeColormap can generate a -BadColor +BadColor error. @@ -1195,7 +1195,7 @@ otherwise, it returns zero. XLookupColor can generate a -BadColor +BadColor error. @@ -1256,10 +1256,10 @@ case is ignored. Returns the exact color value for later use and sets the -DoRed, -DoGreen, +DoRed, +DoGreen, and -DoBlue +DoBlue flags. @@ -1285,7 +1285,7 @@ otherwise, it returns zero. XParseColor can generate a -BadColor +BadColor error. @@ -1370,13 +1370,13 @@ Returns the color that can be reproduced on the screen. Specifies the color format for the returned color specifications (color_screen_return and color_exact_return arguments). If the format is -XcmsUndefinedFormat +XcmsUndefinedFormat 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 -XcmsUndefinedFormat +XcmsUndefinedFormat and the color string contains a color name, the specification is returned in the format used to store the color in the database. @@ -1401,13 +1401,13 @@ the result is implementation-dependent. Use of uppercase or lowercase does not matter. XcmsLookupColor returns -XcmsSuccess +XcmsSuccess or -XcmsSuccessWithCompression +XcmsSuccessWithCompression if the name is resolved; otherwise, it returns -XcmsFailure. +XcmsFailure. If -XcmsSuccessWithCompression +XcmsSuccessWithCompression is returned, the color specification returned in color_screen_return is the result of gamut compression. @@ -1519,14 +1519,14 @@ the same read-only entry, thus allowing entries to be shared. When the last client deallocates a shared cell, it is deallocated. XAllocColor does not use or affect the flags in the -XColor +XColor structure. XAllocColor can generate a -BadColor +BadColor error. delim %% @@ -1622,17 +1622,17 @@ returned by 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 -XcmsRGBFormat. +XcmsRGBFormat. The corresponding colormap cell is read-only. If this routine returns -XcmsFailure, +XcmsFailure, the color_in_out color specification is left unchanged. XcmsAllocColor can generate a -BadColor +BadColor error. @@ -1737,7 +1737,7 @@ otherwise, it returns zero. XAllocNamedColor can generate a -BadColor +BadColor error. @@ -1828,13 +1828,13 @@ or parsed from the corresponding string found in a color-name database. Specifies the color format for the returned color specifications (color_screen_return and color_exact_return arguments). If the format is -XcmsUndefinedFormat +XcmsUndefinedFormat 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 -XcmsUndefinedFormat +XcmsUndefinedFormat and the color string contains a color name, the specification is returned in the format used to store the color in the database. @@ -1856,7 +1856,7 @@ ultimately calls to allocate a read-only color cell with the color specified by a color string. The color string is parsed into an -XcmsColor +XcmsColor structure (see XcmsLookupColor), converted @@ -1877,7 +1877,7 @@ returned by 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 -XcmsRGBFormat. +XcmsRGBFormat. 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. @@ -1886,14 +1886,14 @@ but the color values are undefined. XcmsAllocNamedColor can generate a -BadColor +BadColor error. To allocate read/write color cell and color plane combinations for a -PseudoColor +PseudoColor model, use XAllocColorCells. @@ -2002,7 +2002,7 @@ The function allocates read/write color cells. The number of colors must be positive and the number of planes nonnegative, or a -BadValue +BadValue error results. If ncolors and nplanes are requested, then ncolors pixels @@ -2014,23 +2014,23 @@ ncolors * %2 sup nplanes% distinct pixels can be produced. All of these are allocated writable by the request. For -GrayScale +GrayScale or -PseudoColor, +PseudoColor, each mask has exactly one bit set to 1. For -DirectColor, +DirectColor, each has exactly three bits set to 1. If contig is -True +True and if all masks are ORed together, a single contiguous set of bits set to 1 will be formed for -GrayScale +GrayScale or -PseudoColor +PseudoColor and three contiguous sets of bits set to 1 (one within each pixel subfield) for -DirectColor. +DirectColor. The RGB values of the allocated entries are undefined. XAllocColorCells @@ -2040,16 +2040,16 @@ returns nonzero if it succeeded or zero if it failed. XAllocColorCells can generate -BadColor +BadColor and -BadValue +BadValue errors. To allocate read/write color resources for a -DirectColor +DirectColor model, use XAllocColorPlanes. @@ -2203,19 +2203,19 @@ delim %% The specified ncolors must be positive; and nreds, ngreens, and nblues must be nonnegative, or a -BadValue +BadValue error results. If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested, ncolors pixels are returned; and the masks have nreds, ngreens, and nblues bits set to 1, respectively. If contig is -True, +True, each mask will have a contiguous set of bits set to 1. No mask will have any bits set to 1 in common with any other mask or with any of the pixels. For -DirectColor, +DirectColor, each mask will lie within the corresponding pixel subfield. By ORing together @@ -2227,7 +2227,7 @@ colormap, there are only ncolors * %2 sup nreds% independent red entries, ncolors * %2 sup ngreens% independent green entries, and ncolors * %2 sup nblues% independent blue entries. This is true even for -PseudoColor. +PseudoColor. When the colormap entry of a pixel value is changed (using XStoreColors, @@ -2243,9 +2243,9 @@ returns nonzero if it succeeded or zero if it failed. XAllocColorPlanes can generate -BadColor +BadColor and -BadValue +BadValue errors. @@ -2360,16 +2360,16 @@ 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 -BadValue +BadValue error results. If a specified pixel is 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 -AllocAll +AllocAll to XCreateColormap), a -BadAccess +BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. @@ -2378,10 +2378,10 @@ the one that gets reported is arbitrary. XFreeColors can generate -BadAccess, -BadColor, +BadAccess, +BadColor, and -BadValue +BadValue errors. @@ -2448,26 +2448,26 @@ The XStoreColor function changes the colormap entry of the pixel value specified in the pixel member of the -XColor +XColor structure. You specified this value in the pixel member of the -XColor +XColor 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 -BadValue +BadValue error results. XStoreColor also changes the red, green, and/or blue color components. You specify which color components are to be changed by setting -DoRed, -DoGreen, +DoRed, +DoGreen, and/or -DoBlue +DoBlue in the flags member of the -XColor +XColor structure. If the colormap is an installed map for its screen, the changes are visible immediately. @@ -2476,10 +2476,10 @@ the changes are visible immediately. XStoreColor can generate -BadAccess, -BadColor, +BadAccess, +BadColor, and -BadValue +BadValue errors. @@ -2540,7 +2540,7 @@ Specifies an array of color definition structures to be stored. Specifies the number of -XColor +XColor structures in the color definition array. @@ -2554,15 +2554,15 @@ The XStoreColors function changes the colormap entries of the pixel values specified in the pixel members of the -XColor +XColor structures. You specify which color components are to be changed by setting -DoRed, -DoGreen, +DoRed, +DoGreen, and/or -DoBlue +DoBlue in the flags member of the -XColor +XColor structures. If the colormap is an installed map for its screen, the changes are visible immediately. @@ -2570,10 +2570,10 @@ changes are visible immediately. 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 specified pixel is not a valid index into the colormap, a -BadValue +BadValue error results. If a specified pixel either is unallocated or is allocated read-only, a -BadAccess +BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. @@ -2582,10 +2582,10 @@ the one that gets reported is arbitrary. XStoreColors can generate -BadAccess, -BadColor, +BadAccess, +BadColor, and -BadValue +BadValue errors. @@ -2635,7 +2635,7 @@ Specifies the colormap. Specifies the color cell and the color to store. Values specified in this -XcmsColor +XcmsColor structure remain unchanged on return. @@ -2648,27 +2648,27 @@ structure remain unchanged on return. The XcmsStoreColor function converts the color specified in the -XcmsColor +XcmsColor structure into RGB values. It then uses this RGB specification in an -XColor +XColor structure, whose three flags -(DoRed, -DoGreen, +(DoRed, +DoGreen, and -DoBlue) +DoBlue) are set, in a call to XStoreColor to change the color cell specified by the pixel member of the -XcmsColor +XcmsColor 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 -BadValue +BadValue error results. If the color cell is unallocated or is allocated read-only, a -BadAccess +BadAccess error results. If the colormap is an installed map for its screen, the changes are visible immediately. @@ -2678,7 +2678,7 @@ the changes are visible immediately. Note that XStoreColor has no return value; therefore, an -XcmsSuccess +XcmsSuccess return value from this function indicates that the conversion to RGB succeeded and the call to XStoreColor @@ -2693,10 +2693,10 @@ to the color specified. XcmsStoreColor can generate -BadAccess, -BadColor, +BadAccess, +BadColor, and -BadValue +BadValue errors. @@ -2747,7 +2747,7 @@ Specifies the colormap. Specifies the color specification array of -XcmsColor +XcmsColor structures, each specifying a color cell and the color to store in that cell. Values specified in the array remain unchanged upon return. @@ -2761,7 +2761,7 @@ Values specified in the array remain unchanged upon return. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -2775,9 +2775,9 @@ structures in the color-specification array. Returns an array of Boolean values indicating compression status. If a non-NULL pointer is supplied, each element of the array is set to -True +True if the corresponding color was compressed and -False +False otherwise. Pass NULL if the compression status is not useful. @@ -2791,26 +2791,26 @@ Pass NULL if the compression status is not useful. The XcmsStoreColors function converts the colors specified in the array of -XcmsColor +XcmsColor structures into RGB values and then uses these RGB specifications in -XColor +XColor structures, whose three flags -(DoRed, -DoGreen, +(DoRed, +DoGreen, and -DoBlue) +DoBlue) are set, in a call to XStoreColors to change the color cells specified by the pixel member of the corresponding -XcmsColor +XcmsColor 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 -BadValue +BadValue error results. If a color cell is unallocated or is allocated read-only, a -BadAccess +BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. @@ -2822,7 +2822,7 @@ the changes are visible immediately. Note that XStoreColors has no return value; therefore, an -XcmsSuccess +XcmsSuccess return value from this function indicates that conversions to RGB succeeded and the call to XStoreColors @@ -2837,10 +2837,10 @@ to the colors specified. XcmsStoreColors can generate -BadAccess, -BadColor, +BadAccess, +BadColor, and -BadValue +BadValue errors. @@ -2929,29 +2929,29 @@ The flags argument determines which of the red, green, and blue components are set. You can set this member to the bitwise inclusive OR of the bits -DoRed, -DoGreen, +DoRed, +DoGreen, and -DoBlue. +DoBlue. 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 -BadValue +BadValue error results. If the specified pixel either is unallocated or is allocated read-only, a -BadAccess +BadAccess error results. XStoreNamedColor can generate -BadAccess, -BadColor, -BadName, +BadAccess, +BadColor, +BadName, and -BadValue +BadValue errors. @@ -2961,15 +2961,15 @@ The and XQueryColors functions take pixel values in the pixel member of -XColor +XColor structures and store in the structures the RGB values for those pixels from the specified colormap. The values returned for an unallocated entry are undefined. These functions also set the flags member in the -XColor +XColor structure to all three colors. If a pixel is not a valid index into the specified colormap, a -BadValue +BadValue error results. If more than one pixel is in error, the one that gets reported is arbitrary. @@ -3031,21 +3031,21 @@ Specifies and returns the RGB values for the pixel specified The XQueryColor function returns the current RGB value for the pixel in the -XColor +XColor structure and sets the -DoRed, -DoGreen, +DoRed, +DoGreen, and -DoBlue +DoBlue flags. XQueryColor can generate -BadColor +BadColor and -BadValue +BadValue errors. @@ -3107,7 +3107,7 @@ specified in the structure. Specifies the number of -XColor +XColor structures in the color definition array. @@ -3120,12 +3120,12 @@ structures in the color definition array. The XQueryColors function returns the RGB value for each pixel in each -XColor +XColor structure and sets the -DoRed, -DoGreen, +DoRed, +DoGreen, and -DoBlue +DoBlue flags in each structure. @@ -3133,9 +3133,9 @@ flags in each structure. XQueryColors can generate -BadColor +BadColor and -BadValue +BadValue errors. @@ -3186,7 +3186,7 @@ Specifies the colormap. Specifies the pixel member that indicates the color cell to query. The color specification stored for the color cell is returned in this -XcmsColor +XcmsColor structure. @@ -3210,21 +3210,21 @@ The XcmsQueryColor function obtains the RGB value for the pixel value in the pixel member of the specified -XcmsColor +XcmsColor 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 -BadValue +BadValue error results. XcmsQueryColor can generate -BadColor +BadColor and -BadValue +BadValue errors. @@ -3275,7 +3275,7 @@ Specifies the colormap. Specifies an array of -XcmsColor +XcmsColor structures, each pixel member indicating the color cell to query. The color specifications for the color cells are returned in these structures. @@ -3288,7 +3288,7 @@ The color specifications for the color cells are returned in these structures. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -3312,12 +3312,12 @@ The XcmsQueryColors function obtains the RGB values for pixel values in the pixel members of -XcmsColor +XcmsColor structures and then converts the values to the target format as specified by the result_format argument. If a pixel is not a valid index into the specified colormap, a -BadValue +BadValue error results. If more than one pixel is in error, the one that gets reported is arbitrary. @@ -3326,9 +3326,9 @@ the one that gets reported is arbitrary. XcmsQueryColors can generate -BadColor +BadColor and -BadValue +BadValue errors. @@ -3581,7 +3581,7 @@ specific. Applications should not directly modify any part of the -XcmsCCC. +XcmsCCC. The following lists the C language macros, their corresponding function equivalents for other language bindings, and what data they both can return. @@ -3827,14 +3827,14 @@ 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 -XcmsCIEXYZFormat, -XcmsCIEuvYFormat, -XcmsCIExyYFormat, +XcmsCIEXYZFormat, +XcmsCIEuvYFormat, +XcmsCIExyYFormat, or -XcmsUndefinedFormat. +XcmsUndefinedFormat. If the color argument is NULL, this function sets the format component of the Client White Point specification to -XcmsUndefinedFormat, +XcmsUndefinedFormat, indicating that the Client White Point is assumed to be the same as the Screen White Point. @@ -3889,7 +3889,7 @@ If NULL is specified and a function using this CCC must convert a color specification to a device-dependent format and encounters a color that lies outside the screen's color gamut, that function will return -XcmsFailure. +XcmsFailure. @@ -4074,7 +4074,7 @@ If NULL is specified and a function using this CCC must convert a color specification to a device-dependent format and encounters a color that lies outside the screen's color gamut, that function will return -XcmsFailure. +XcmsFailure. @@ -4220,7 +4220,7 @@ Pixel members are ignored and remain unchanged upon return. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -4244,9 +4244,9 @@ Specifies the target color specification format. Returns an array of Boolean values indicating compression status. If a non-NULL pointer is supplied, each element of the array is set to -True +True if the corresponding color was compressed and -False +False otherwise. Pass NULL if the compression status is not useful. @@ -4260,11 +4260,11 @@ Pass NULL if the compression status is not useful. The XcmsConvertColors function converts the color specifications in the specified array of -XcmsColor +XcmsColor structures from their current format to a single target format, using the specified CCC. When the return value is -XcmsFailure, +XcmsFailure, the contents of the color specification array are left unchanged. @@ -4274,8 +4274,8 @@ The array may contain a mixture of color specification formats When the array contains both device-independent and device-dependent color specifications and the target_format argument specifies a device-dependent format (for example, -XcmsRGBiFormat, -XcmsRGBFormat), +XcmsRGBiFormat, +XcmsRGBFormat), all specifications are converted to CIE XYZ format and then to the target device-dependent format. @@ -4294,9 +4294,9 @@ adjustment callbacks. The gamut compression procedure specified in the CCC is called when an attempt to convert a color specification from -XcmsCIEXYZ +XcmsCIEXYZ to a device-dependent format (typically -XcmsRGBi) +XcmsRGBi) 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. @@ -4361,7 +4361,7 @@ Pixel members should be ignored and must remain unchanged upon return. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -4373,7 +4373,7 @@ structures in the color-specification array. Specifies the index into the array of -XcmsColor +XcmsColor 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. @@ -4389,7 +4389,7 @@ Valid values are 0 (for the first element) to ncolors - 1. Returns an array of Boolean values for indicating compression status. If a non-NULL pointer is supplied and a color at a given index is compressed, then -True +True should be stored at the corresponding index in this array; otherwise, the array should not be modified. @@ -4416,7 +4416,7 @@ When called, elements 0 to index - 1 in the color specification array can be assumed to fall within the screen's color gamut. In addition, these color specifications are already in some device-dependent format (typically -XcmsRGBi). +XcmsRGBi). If any modifications are made to these color specifications, they must be in their initial device-dependent format upon return. @@ -4427,9 +4427,9 @@ 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 -XcmsCIEXYZ. +XcmsCIEXYZ. Upon return, this color specification must be in -XcmsCIEXYZ. +XcmsCIEXYZ. @@ -4438,10 +4438,10 @@ 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 -XcmsCIEXYZ. +XcmsCIEXYZ. If any modifications are made to these color specifications, they must be in -XcmsCIEXYZ +XcmsCIEXYZ upon return. @@ -4720,7 +4720,7 @@ Pixel members should be ignored and must remain unchanged upon return. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -4734,7 +4734,7 @@ structures in the color-specification array. Returns an array of Boolean values for indicating compression status. If a non-NULL pointer is supplied and a color at a given index is compressed, then -True +True should be stored at the corresponding index in this array; otherwise, the array should not be modified. @@ -4768,7 +4768,7 @@ This uses the CIE L*a*b* color space for adjusting the chroma of colors to compensate for the chromatic differences between the source and destination white points. This procedure simply converts the color specifications to -XcmsCIELab +XcmsCIELab using the source white point and then converts to the target specification format using the destination's white point. No client data is necessary. @@ -4785,7 +4785,7 @@ This uses the CIE L*u*v* color space for adjusting the chroma of colors to compensate for the chromatic differences between the source and destination white points. This procedure simply converts the color specifications to -XcmsCIELuv +XcmsCIELuv using the source white point and then converts to the target specification format using the destination's white point. No client data is necessary. @@ -4802,7 +4802,7 @@ This uses the TekHVC color space for adjusting the chromatic character of colors to compensate for the chromatic differences between the source and destination white points. This procedure simply converts the color specifications to -XcmsTekHVC +XcmsTekHVC using the source white point and then converts to the target specification format using the destination's white point. An advantage of this procedure over those previously described @@ -4845,24 +4845,24 @@ procedure twice: Once to convert to -XcmsRGB +XcmsRGB A second time to convert from -XcmsRGB +XcmsRGB For example, assume the specification is in -XcmsCIEuvY +XcmsCIEuvY and the adjustment procedure is XcmsCIELuvWhiteShiftColors. During conversion to -XcmsRGB, +XcmsRGB, the call to XcmsAllocColor results in the following series of color specification conversions: @@ -4872,44 +4872,44 @@ results in the following series of color specification conversions: From -XcmsCIEuvY +XcmsCIEuvY to -XcmsCIELuv +XcmsCIELuv using the Client White Point From -XcmsCIELuv +XcmsCIELuv to -XcmsCIEuvY +XcmsCIEuvY using the Screen White Point From -XcmsCIEuvY +XcmsCIEuvY to -XcmsCIEXYZ +XcmsCIEXYZ (CIE u'v'Y and XYZ are white-point-independent color spaces) From -XcmsCIEXYZ +XcmsCIEXYZ to -XcmsRGBi +XcmsRGBi From -XcmsRGBi +XcmsRGBi to -XcmsRGB +XcmsRGB @@ -4921,7 +4921,7 @@ and the RGB specification returned by XAllocColor is converted back to -XcmsCIEuvY +XcmsCIEuvY by reversing the color conversion sequence. @@ -5520,7 +5520,7 @@ 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 -XcmsFailure +XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. @@ -5682,7 +5682,7 @@ function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen. It returns this point in CIE L*a*b* coordinates. An -XcmsFailure +XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. @@ -5877,7 +5877,7 @@ 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 -XcmsFailure +XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. @@ -6039,7 +6039,7 @@ function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen. It returns this point in CIE L*u*v* coordinates. An -XcmsFailure +XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. @@ -6512,13 +6512,13 @@ function. The CIE XYZ color space serves as the hub for all conversions between device-independent and device-dependent color spaces. Therefore, the knowledge to convert an -XcmsColor +XcmsColor 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 convert the -XcmsColor +XcmsColor structure to or from CIE XYZ format. This color specification conversion mechanism facilitates the addition of color spaces. @@ -6571,7 +6571,7 @@ Specifies the device-independent color space to add. The XcmsAddColorSpace function makes a device-independent color space (actually an -XcmsColorSpace +XcmsColorSpace structure) accessible 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. @@ -6587,16 +6587,16 @@ and If the -XcmsColorSpace +XcmsColorSpace structure is already accessible in the color management system, XcmsAddColorSpace returns -XcmsSuccess. +XcmsSuccess. Note that added -XcmsColorSpaces +XcmsColorSpaces must be retained for reference by Xlib. @@ -6644,7 +6644,7 @@ The prefix is case-insensitive. If the color space is not accessible in the color management system, XcmsFormatOfPrefix returns -XcmsUndefinedFormat. +XcmsUndefinedFormat. @@ -6695,7 +6695,7 @@ The returned string must be treated as read-only. Color space specific information necessary for color space conversion and color string parsing is stored in an -XcmsColorSpace +XcmsColorSpace structure. Therefore, a new structure containing this information is required for each additional color space. @@ -6708,7 +6708,7 @@ function. If a new -XcmsColorSpace +XcmsColorSpace structure specifies a 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. @@ -6752,7 +6752,7 @@ 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 -XcmsColor +XcmsColor structure. This function returns an integer (int): nonzero if it succeeded and zero otherwise. @@ -6760,7 +6760,7 @@ The to_CIEXYZ and from_CIEXYZ members contain pointers, each to a NULL terminated list of function pointers. When the list of functions is executed in series, it will convert the color specified in an -XcmsColor +XcmsColor 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. @@ -6793,7 +6793,7 @@ thus bypassing CIE XYZ if possible (for example, TekHVC to The callback in the -XcmsColorSpace +XcmsColorSpace structure for parsing a color string for the particular color space must adhere to the following software interface specification: @@ -6843,7 +6843,7 @@ Returns the color specification in the color space's format. Callback functions in the -XcmsColorSpace +XcmsColorSpace structure for converting a color specification between device-independent spaces must adhere to the following software interface specification: @@ -6851,7 +6851,7 @@ following software interface specification: - Status ConversionProc + Status ConversionProc XcmsCCC ccc XcmsColor *white_point XcmsColor *colors_in_out @@ -6900,7 +6900,7 @@ Pixel members should be ignored and must remain unchanged upon return. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -6912,7 +6912,7 @@ structures in the color-specification array. Callback functions in the -XcmsColorSpace +XcmsColorSpace structure for converting a color specification to or from a device-dependent space must adhere to the following software interface specification: @@ -6920,7 +6920,7 @@ following software interface specification: - Status ConversionProc + Status ConversionProc XcmsCCC ccc XcmsColor *colors_in_out unsignedint ncolors @@ -6957,7 +6957,7 @@ Pixel members should be ignored and must remain unchanged upon return. Specifies the number of -XcmsColor +XcmsColor structures in the color-specification array. @@ -6971,7 +6971,7 @@ structures in the color-specification array. Returns an array of Boolean values for indicating compression status. If a non-NULL pointer is supplied and a color at a given index is compressed, then -True +True should be stored at the corresponding index in this array; otherwise, the array should not be modified. @@ -7001,73 +7001,73 @@ The conversion functions provided by Xlib are: XcmsCIELabToCIEXYZ - XcmsCIELabFormat - XcmsCIEXYZFormat + XcmsCIELabFormat + XcmsCIEXYZFormat XcmsCIELuvToCIEuvY - XcmsCIELuvFormat - XcmsCIEuvYFormat + XcmsCIELuvFormat + XcmsCIEuvYFormat XcmsCIEXYZToCIELab - XcmsCIEXYZFormat - XcmsCIELabFormat + XcmsCIEXYZFormat + XcmsCIELabFormat XcmsCIEXYZToCIEuvY - XcmsCIEXYZFormat - XcmsCIEuvYFormat + XcmsCIEXYZFormat + XcmsCIEuvYFormat XcmsCIEXYZToCIExyY - XcmsCIEXYZFormat - XcmsCIExyYFormat + XcmsCIEXYZFormat + XcmsCIExyYFormat XcmsCIEXYZToRGBi - XcmsCIEXYZFormat - XcmsRGBiFormat + XcmsCIEXYZFormat + XcmsRGBiFormat XcmsCIEuvYToCIELuv - XcmsCIEuvYFormat - XcmsCIELabFormat + XcmsCIEuvYFormat + XcmsCIELabFormat XcmsCIEuvYToCIEXYZ - XcmsCIEuvYFormat - XcmsCIEXYZFormat + XcmsCIEuvYFormat + XcmsCIEXYZFormat XcmsCIEuvYToTekHVC - XcmsCIEuvYFormat - XcmsTekHVCFormat + XcmsCIEuvYFormat + XcmsTekHVCFormat XcmsCIExyYToCIEXYZ - XcmsCIExyYFormat - XcmsCIEXYZFormat + XcmsCIExyYFormat + XcmsCIEXYZFormat XcmsRGBToRGBi - XcmsRGBFormat - XcmsRGBiFormat + XcmsRGBFormat + XcmsRGBiFormat XcmsRGBiToCIEXYZ - XcmsRGBiFormat - XcmsCIEXYZFormat + XcmsRGBiFormat + XcmsCIEXYZFormat XcmsRGBiToRGB - XcmsRGBiFormat - XcmsRGBFormat + XcmsRGBiFormat + XcmsRGBFormat XcmsTekHVCToCIEuvY - XcmsTekHVCFormat - XcmsCIEuvYFormat + XcmsTekHVCFormat + XcmsCIEuvYFormat @@ -7148,12 +7148,12 @@ The XcmsAddFunctionSet function adds a function set to the color management system. If the function set uses device-dependent -XcmsColorSpace +XcmsColorSpace structures not accessible in the color management system, XcmsAddFunctionSet adds them. If an added -XcmsColorSpace +XcmsColorSpace structure is for a device-dependent color space not registered with the X Consortium, they should be treated as private to the client @@ -7172,9 +7172,9 @@ and Additional function sets should be added before any calls to other Xlib routines are made. If not, the -XcmsPerScrnInfo +XcmsPerScrnInfo member of a previously created -XcmsCCC +XcmsCCC does not have the opportunity to initialize with the added function set. @@ -7190,11 +7190,11 @@ 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 -XcmsColorSpace +XcmsColorSpace structures and a means to read and store a screen's color characterization data. This data is stored in an -XcmsFunctionSet +XcmsFunctionSet structure. A handle to this structure (that is, by means of global variable) is usually made accessible to the client program for use with @@ -7203,18 +7203,18 @@ is usually made accessible to the client program for use with If a function set uses new device-dependent -XcmsColorSpace +XcmsColorSpace structures, they will be transparently processed into the color management system. Function sets can share an -XcmsColorSpace +XcmsColorSpace structure for a device-dependent color space. In addition, multiple -XcmsColorSpace +XcmsColorSpace structures are allowed for a device-dependent color space; however, a function set can reference only one of them. These -XcmsColorSpace +XcmsColorSpace structures will differ in the functions to convert to and from CIE XYZ, thus tailored for the specific function set. @@ -7236,12 +7236,12 @@ typedef struct _XcmsFunctionSet { The DDColorSpaces member is a pointer to a NULL terminated list of pointers to -XcmsColorSpace +XcmsColorSpace structures for the device-dependent color spaces that are supported by the function set. The screenInitProc member is set to the callback procedure (see the following interface specification) that initializes the -XcmsPerScrnInfo +XcmsPerScrnInfo structure for a particular screen. @@ -7289,7 +7289,7 @@ Specifies the appropriate screen number on the host server. Specifies the -XcmsPerScrnInfo +XcmsPerScrnInfo structure, which contains the per screen information. @@ -7300,18 +7300,18 @@ structure, which contains the per screen information. The screen initialization callback in the -XcmsFunctionSet +XcmsFunctionSet 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 specified -XcmsPerScrnInfo +XcmsPerScrnInfo structure. Device profile Color Characterization Data If successful, the procedure fills in the -XcmsPerScrnInfo +XcmsPerScrnInfo structure as follows: @@ -7330,30 +7330,30 @@ It next sets the screenWhitePoint member. It next sets the functionSet member to the address of the -XcmsFunctionSet +XcmsFunctionSet structure. It then sets the state member to -XcmsInitSuccess +XcmsInitSuccess and finally returns -XcmsSuccess. +XcmsSuccess. If unsuccessful, the procedure sets the state member to -XcmsInitFailure +XcmsInitFailure and returns -XcmsFailure. +XcmsFailure. The -XcmsPerScrnInfo +XcmsPerScrnInfo structure contains: @@ -7383,19 +7383,19 @@ The state member is set to one of the following: -XcmsInitNone +XcmsInitNone indicates initialization has not been previously attempted. -XcmsInitFailure +XcmsInitFailure indicates initialization has been previously attempted but failed. -XcmsInitSuccess +XcmsInitSuccess indicates initialization has been previously attempted and succeeded. @@ -7429,7 +7429,7 @@ Specifies the data to be freed. This function is called to free the screenData stored in an -XcmsPerScrnInfo +XcmsPerScrnInfo structure. diff --git a/specs/libX11/CH07.xml b/specs/libX11/CH07.xml index 068f7a13..498d18f6 100644 --- a/specs/libX11/CH07.xml +++ b/specs/libX11/CH07.xml @@ -58,11 +58,11 @@ sharing GCs between applications is highly discouraged. To set an attribute of a GC, set the appropriate member of the -XGCValues +XGCValues structure and OR in the corresponding value bitmask in your subsequent calls to XCreateGC. The symbols for the value mask bits and the -XGCValues +XGCValues structure are: @@ -147,7 +147,7 @@ The default GC values are: function - GXcopy + GXcopy plane_mask @@ -167,27 +167,27 @@ The default GC values are: line_style - LineSolid + LineSolid cap_style - CapButt + CapButt join_style - JoinMiter + JoinMiter fill_style - FillSolid + FillSolid fill_rule - EvenOddRule + EvenOddRule arc_mode - ArcPieSlice + ArcPieSlice tile @@ -219,11 +219,11 @@ The default GC values are: subwindow_mode - ClipByChildren + ClipByChildren graphics_exposures - True + True clip_x_origin @@ -235,7 +235,7 @@ The default GC values are: clip_mask - None + None dash_offset @@ -264,7 +264,7 @@ The function attributes of a GC are used when you update a section of a drawable (the destination) with bits from somewhere else (the source). The function in a GC defines how the new destination bits are to be computed from the source bits and the old destination bits. -GXcopy +GXcopy is typically the most useful because it will work on a color display, but special applications may use other functions, particularly in concert with particular planes of a color display. @@ -291,82 +291,82 @@ are: - GXclear + GXclear 0x0 0 - GXand + GXand 0x1 src AND dst - GXandReverse + GXandReverse 0x2 src AND NOT dst - GXcopy + GXcopy 0x3 src - GXandInverted + GXandInverted 0x4 (NOT src) AND dst - GXnoop + GXnoop 0x5 dst - GXxor + GXxor 0x6 src XOR dst - GXor + GXor 0x7 src OR dst - GXnor + GXnor 0x8 (NOT src) AND (NOT dst) - GXequiv + GXequiv 0x9 (NOT src) XOR dst - GXinvert + GXinvert 0xa NOT dst - GXorReverse + GXorReverse 0xb src OR (NOT dst) - GXcopyInverted + GXcopyInverted 0xc NOT src - GXorInverted + GXorInverted 0xd (NOT src) OR dst - GXnand + GXnand 0xe (NOT src) OR (NOT dst) - GXset + GXset 0xf 1 @@ -393,7 +393,7 @@ 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 -AllPlanes +AllPlanes can be used to refer to all planes of the screen simultaneously. The result is computed by the following: @@ -496,34 +496,34 @@ The line-style defines which sections of a line are drawn: - LineSolid + LineSolid The full path of the line is drawn. - LineDoubleDash + LineDoubleDash The full path of the line is drawn, but the even dashes are filled differently from the odd dashes (see fill-style) with -CapButt +CapButt style used where even and odd dashes meet. - LineOnOffDash + LineOnOffDash Only the even dashes are drawn, and cap-style applies to all internal ends of the individual dashes, except -CapNotLast +CapNotLast is treated as -CapButt. +CapButt. @@ -534,18 +534,18 @@ The cap-style defines how the endpoints of a path are drawn: - CapNotLast + CapNotLast This is equivalent to -CapButt +CapButt except that for a line-width of zero the final endpoint is not drawn. - CapButt + CapButt The line is square at the endpoint (perpendicular to the slope of the line) @@ -554,25 +554,25 @@ with no projection beyond. - CapRound + CapRound The line has a circular arc with the diameter equal to the line-width, centered on the endpoint. (This is equivalent to -CapButt +CapButt for line-width of zero). - CapProjecting + CapProjecting 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 -CapButt +CapButt for line-width of zero). @@ -585,19 +585,19 @@ The join-style defines how corners are drawn for wide lines: - JoinMiter + JoinMiter The outer edges of two lines extend to meet at an angle. However, if the angle is less than 11 degrees, then a -JoinBevel +JoinBevel join-style is used instead. - JoinRound + JoinRound The corner is a circular arc with the diameter equal to the line-width, @@ -606,11 +606,11 @@ centered on the joinpoint. - JoinBevel + JoinBevel The corner has -CapButt +CapButt endpoint styles with the triangular notch filled. @@ -632,42 +632,42 @@ the semantics depends on the line-width and the cap-style: - CapNotLast + CapNotLast thin The results are device dependent, but the desired effect is that nothing is drawn. - CapButt + CapButt thin The results are device dependent, but the desired effect is that a single pixel is drawn. - CapRound + CapRound thin The results are the same as for - CapButt /thin. + CapButt /thin. - CapProjecting + CapProjecting thin The results are the same as for - CapButt /thin. + CapButt /thin. - CapButt + CapButt wide Nothing is drawn. - CapRound + CapRound wide The closed path is a circle, centered at the endpoint, and with the diameter equal to the line-width. - CapProjecting + CapProjecting 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. @@ -698,16 +698,16 @@ 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 -BadMatch +BadMatch error results. The stipple pixmap must have depth one and must have the same root as the GC, or a -BadMatch +BadMatch error results. For stipple operations where the fill-style is -FillStippled +FillStippled but not -FillOpaqueStippled, +FillOpaqueStippled, 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, @@ -727,16 +727,16 @@ and XFillArc); for line requests with line-style -LineSolid +LineSolid (for example, XDrawLine, XDrawSegments, XDrawRectangle, XDrawArc); and for the even dashes for line requests with line-style -LineOnOffDash +LineOnOffDash or -LineDoubleDash, +LineDoubleDash, the following apply: @@ -746,21 +746,21 @@ the following apply: - FillSolid + FillSolid Foreground - FillTiled + FillTiled Tile - FillOpaqueStippled + FillOpaqueStippled 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 - FillStippled + FillStippled Foreground masked by stipple @@ -770,7 +770,7 @@ the following apply: When drawing lines with line-style -LineDoubleDash, +LineDoubleDash, the odd dashes are controlled by the fill-style in the following manner: @@ -780,19 +780,19 @@ the odd dashes are controlled by the fill-style in the following manner: - FillSolid + FillSolid Background - FillTiled + FillTiled Same as for even dashes - FillOpaqueStippled + FillOpaqueStippled Same as for even dashes - FillStippled + FillStippled Background masked by stipple @@ -830,7 +830,7 @@ value of N is equivalent to specifying the two-element list [N, N] in XSetDashes. The value must be nonzero, or a -BadValue +BadValue error results. @@ -839,10 +839,10 @@ 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 -BadMatch +BadMatch error results. If clip-mask is set to -None, +None, the pixels are always drawn regardless of the clip origin. The clip-mask also can be set by calling the XSetClipRectangles @@ -860,22 +860,22 @@ destination drawable is specified in a graphics request. You can set the subwindow-mode to -ClipByChildren +ClipByChildren or -IncludeInferiors. +IncludeInferiors. For -ClipByChildren, +ClipByChildren, both source and destination windows are additionally clipped by all viewable -InputOutput +InputOutput children. For -IncludeInferiors, +IncludeInferiors, neither source nor destination window is clipped by inferiors. This will result in including subwindow contents in the source and drawing through subwindow boundaries of the destination. The use of -IncludeInferiors +IncludeInferiors on a window of one depth with mapped inferiors of differing depth is not illegal, but the semantics are undefined by the core protocol. @@ -886,16 +886,16 @@ The fill-rule defines what pixels are inside (drawn) for paths given in XFillPolygon requests and can be set to -EvenOddRule +EvenOddRule or -WindingRule. +WindingRule. For -EvenOddRule, +EvenOddRule, a point is inside if an infinite ray with the point as origin crosses the path an odd number of times. For -WindingRule, +WindingRule, a point is inside if an infinite ray with the point as origin crosses an unequal number of clockwise and counterclockwise directed path segments. @@ -910,9 +910,9 @@ coincident with a segment. For both -EvenOddRule +EvenOddRule and -WindingRule, +WindingRule, 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 @@ -929,20 +929,20 @@ and are inside if and only if the polygon interior is immediately below The arc-mode controls filling in the XFillArcs function and can be set to -ArcPieSlice +ArcPieSlice or -ArcChord. +ArcChord. For -ArcPieSlice, +ArcPieSlice, the arcs are pie-slice filled. For -ArcChord, +ArcChord, the arcs are chord filled. The graphics-exposure flag controls -GraphicsExpose +GraphicsExpose event generation for XCopyArea @@ -1024,20 +1024,20 @@ function creates a graphics context and returns a GC. The GC can be used with any destination drawable having the same root and depth as the specified drawable. Use with other drawables results in a -BadMatch +BadMatch error. XCreateGC can generate -BadAlloc, -BadDrawable, -BadFont, -BadMatch, -BadPixmap, +BadAlloc, +BadDrawable, +BadFont, +BadMatch, +BadPixmap, and -BadValue +BadValue errors. @@ -1111,7 +1111,7 @@ function copies the specified components from the source GC to the destination GC. The source and destination GCs must have the same root and depth, or a -BadMatch +BadMatch error results. The valuemask specifies which component to copy, as for XCreateGC. @@ -1120,10 +1120,10 @@ The valuemask specifies which component to copy, as for XCopyGC can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadMatch +BadMatch errors. @@ -1213,13 +1213,13 @@ If an error is generated, a subset of the components may have been altered. XChangeGC can generate -BadAlloc, -BadFont, -BadGC, -BadMatch, -BadPixmap, +BadAlloc, +BadFont, +BadGC, +BadMatch, +BadPixmap, and -BadValue +BadValue errors. @@ -1280,7 +1280,7 @@ GC component mask bits. Returns the GC values in the specified -XGCValues +XGCValues structure. @@ -1294,44 +1294,44 @@ The XGetGCValues function returns the components specified by valuemask for the specified GC. If the valuemask contains a valid set of GC mask bits -(GCFunction, -GCPlaneMask, -GCForeground, -GCBackground, -GCLineWidth, -GCLineStyle, -GCCapStyle, -GCJoinStyle, -GCFillStyle, -GCFillRule, -GCTile, -GCStipple, -GCTileStipXOrigin, -GCTileStipYOrigin, -GCFont, -GCSubwindowMode, -GCGraphicsExposures, -GCClipXOrigin, -GCCLipYOrigin, -GCDashOffset, +(GCFunction, +GCPlaneMask, +GCForeground, +GCBackground, +GCLineWidth, +GCLineStyle, +GCCapStyle, +GCJoinStyle, +GCFillStyle, +GCFillRule, +GCTile, +GCStipple, +GCTileStipXOrigin, +GCTileStipYOrigin, +GCFont, +GCSubwindowMode, +GCGraphicsExposures, +GCClipXOrigin, +GCClipYOrigin, +GCDashOffset, or -GCArcMode) +GCArcMode) and no error occurs, XGetGCValues sets the requested components in values_return and returns a nonzero status. Otherwise, it returns a zero status. Note that the clip-mask and dash-list (represented by the -GCClipMask +GCClipMask and -GCDashList +GCDashList 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 -GCFont, -GCTile, +GCFont, +GCTile, and -GCStipple +GCStipple if the component has never been explicitly set by the client. @@ -1383,14 +1383,14 @@ function destroys the specified GC as well as all the associated storage. XFreeGC can generate a -BadGC +BadGC error. To obtain the -GContext +GContext resource ID for a given GC, use XGContextFromGC. XGContextFromGC @@ -1605,10 +1605,10 @@ Specifies the plane mask. XSetState can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -1665,9 +1665,9 @@ Specifies the foreground you want to set for the specified GC. XSetForeground can generate -BadAlloc +BadAlloc and -BadGC +BadGC errors. @@ -1724,9 +1724,9 @@ Specifies the background you want to set for the specified GC. XSetBackground can generate -BadAlloc +BadAlloc and -BadGC +BadGC errors. @@ -1783,10 +1783,10 @@ Specifies the function you want to set for the specified GC. XSetFunction can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -1844,9 +1844,9 @@ Specifies the plane mask. XSetPlaneMask can generate -BadAlloc +BadAlloc and -BadGC +BadGC errors. @@ -1912,10 +1912,10 @@ Specifies the line-width you want to set for the specified GC. Specifies the line-style you want to set for the specified GC. You can pass -LineSolid, -LineOnOffDash, +LineSolid, +LineOnOffDash, or -LineDoubleDash. +LineDoubleDash. @@ -1927,11 +1927,11 @@ or Specifies the line-style and cap-style you want to set for the specified GC. You can pass -CapNotLast, -CapButt, -CapRound, +CapNotLast, +CapButt, +CapRound, or -CapProjecting. +CapProjecting. @@ -1943,10 +1943,10 @@ or Specifies the line join-style you want to set for the specified GC. You can pass -JoinMiter, -JoinRound, +JoinMiter, +JoinRound, or -JoinBevel. +JoinBevel. @@ -1957,10 +1957,10 @@ or XSetLineAttributes can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -2045,7 +2045,7 @@ 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 -BadValue +BadValue error results. The initial and alternating elements (second, fourth, and so on) of the dash_list are the even dashes, and @@ -2053,7 +2053,7 @@ the others are the odd dashes. Each element specifies a dash length in pixels. All of the elements must be nonzero, or a -BadValue +BadValue error results. Specifying an odd-length list is equivalent to specifying the same list concatenated with itself to produce an even-length list. @@ -2081,10 +2081,10 @@ For all other lines, the major axis is the y axis. XSetDashes can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -2137,11 +2137,11 @@ Specifies the GC. Specifies the fill-style you want to set for the specified GC. You can pass -FillSolid, -FillTiled, -FillStippled, +FillSolid, +FillTiled, +FillStippled, or -FillOpaqueStippled. +FillOpaqueStippled. @@ -2152,10 +2152,10 @@ or XSetFillStyle can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -2203,9 +2203,9 @@ Specifies the GC. Specifies the fill-rule you want to set for the specified GC. You can pass -EvenOddRule +EvenOddRule or -WindingRule. +WindingRule. @@ -2216,10 +2216,10 @@ or XSetFillRule can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -2275,10 +2275,10 @@ Specifies the connection to the X server. Specifies the class that you are interested in. You can pass -TileShape, -CursorShape, +TileShape, +CursorShape, or -StippleShape. +StippleShape. @@ -2344,41 +2344,41 @@ The XQueryBestSize function returns the best or closest size to the specified size. For -CursorShape, +CursorShape, this is the largest size that can be fully displayed on the screen specified by which_screen. For -TileShape, +TileShape, this is the size that can be tiled fastest. For -StippleShape, +StippleShape, this is the size that can be stippled fastest. For -CursorShape, +CursorShape, the drawable indicates the desired screen. For -TileShape +TileShape and -StippleShape, +StippleShape, the drawable indicates the screen and possibly the window class and depth. An -InputOnly +InputOnly window cannot be used as the drawable for -TileShape +TileShape or -StippleShape, +StippleShape, or a -BadMatch +BadMatch error results. XQueryBestSize can generate -BadDrawable, -BadMatch, +BadDrawable, +BadMatch, and -BadValue +BadValue errors. @@ -2473,18 +2473,18 @@ 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 -InputOnly +InputOnly window is used as the drawable, a -BadMatch +BadMatch error results. XQueryBestTile can generate -BadDrawable +BadDrawable and -BadMatch +BadMatch errors. @@ -2579,18 +2579,18 @@ 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 -InputOnly +InputOnly window is used as the drawable, a -BadMatch +BadMatch error results. XQueryBestStipple can generate -BadDrawable +BadDrawable and -BadMatch +BadMatch errors. @@ -2647,18 +2647,18 @@ Specifies the fill tile you want to set for the specified GC. The tile and GC must have the same depth, or a -BadMatch +BadMatch error results. XSetTile can generate -BadAlloc, -BadGC, -BadMatch, +BadAlloc, +BadGC, +BadMatch, and -BadPixmap +BadPixmap errors. @@ -2715,18 +2715,18 @@ Specifies the stipple you want to set for the specified GC. The stipple must have a depth of one, or a -BadMatch +BadMatch error results. XSetStipple can generate -BadAlloc, -BadGC, -BadMatch, +BadAlloc, +BadGC, +BadMatch, and -BadPixmap +BadPixmap errors. @@ -2800,9 +2800,9 @@ drawable is specified in the graphics request. XSetTSOrigin can generate -BadAlloc +BadAlloc and -BadGC +BadGC errors. @@ -2864,10 +2864,10 @@ Specifies the font. XSetFont can generate -BadAlloc, -BadFont, +BadAlloc, +BadFont, and -BadGC +BadGC errors. @@ -2951,9 +2951,9 @@ destination drawable is specified in the graphics request. XSetClipOrigin can generate -BadAlloc +BadAlloc and -BadGC +BadGC errors. @@ -3000,7 +3000,7 @@ Specifies the GC. Specifies the pixmap or -None. +None. @@ -3010,18 +3010,18 @@ Specifies the pixmap or If the clip-mask is set to -None, +None, the pixels are always drawn (regardless of the clip-origin). XSetClipMask can generate -BadAlloc, -BadGC, -BadMatch, +BadAlloc, +BadGC, +BadMatch, and -BadPixmap +BadPixmap errors. @@ -3113,11 +3113,11 @@ Specifies the number of rectangles. Specifies the ordering relations on the rectangles. You can pass -Unsorted, -YSorted, -YXSorted, +Unsorted, +YSorted, +YXSorted, or -YXBanded. +YXBanded. @@ -3140,7 +3140,7 @@ undefined. Note that the list of rectangles can be empty, which effectively disables output. This is the opposite of passing -None +None as the clip-mask in XCreateGC, XChangeGC, @@ -3154,23 +3154,23 @@ specified with the ordering argument. This may provide faster operation by the server. If an incorrect ordering is specified, the X server may generate a -BadMatch +BadMatch error, but it is not required to do so. If no error is generated, the graphics results are undefined. -Unsorted +Unsorted means the rectangles are in arbitrary order. -YSorted +YSorted means that the rectangles are nondecreasing in their Y origin. -YXSorted +YXSorted additionally constrains -YSorted +YSorted order in that all rectangles with an equal Y origin are nondecreasing in their X origin. -YXBanded +YXBanded additionally constrains -YXSorted +YXSorted by requiring that, for every possible Y scanline, all rectangles that include that scanline have an identical Y origins and Y extents. @@ -3179,11 +3179,11 @@ scanline have an identical Y origins and Y extents. XSetClipRectangles can generate -BadAlloc, -BadGC, -BadMatch, +BadAlloc, +BadGC, +BadMatch, and -BadValue +BadValue errors. @@ -3243,9 +3243,9 @@ Specifies the GC. Specifies the arc mode. You can pass -ArcChord +ArcChord or -ArcPieSlice. +ArcPieSlice. @@ -3256,10 +3256,10 @@ or XSetArcMode can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -3307,9 +3307,9 @@ Specifies the GC. Specifies the subwindow mode. You can pass -ClipByChildren +ClipByChildren or -IncludeInferiors. +IncludeInferiors. @@ -3320,10 +3320,10 @@ or XSetSubwindowMode can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. @@ -3370,9 +3370,9 @@ Specifies the GC. Specifies a Boolean value that indicates whether you want -GraphicsExpose +GraphicsExpose and -NoExpose +NoExpose events to be reported when calling XCopyArea and @@ -3388,10 +3388,10 @@ with this GC. XSetGraphicsExposures can generate -BadAlloc, -BadGC, +BadAlloc, +BadGC, and -BadValue +BadValue errors. diff --git a/specs/libX11/CH08.xml b/specs/libX11/CH08.xml index 6cd6fc66..e4cfb812 100644 --- a/specs/libX11/CH08.xml +++ b/specs/libX11/CH08.xml @@ -124,7 +124,7 @@ Specify the width and height(Wh. Specifies a Boolean value that indicates if -Expose +Expose events are to be generated. @@ -139,7 +139,7 @@ The function paints a rectangular area in the specified window according to the specified dimensions with the window's background pixel or pixmap. The subwindow-mode effectively is -ClipByChildren. +ClipByChildren. If width is zero, it is replaced with the current width of the window minus x. If height is @@ -148,29 +148,29 @@ If the window has a defined background tile, the rectangle clipped by any children is filled with this tile. If the window has background -None, +None, the contents of the window are not changed. In either case, if exposures is -True, +True, one or more -Expose +Expose 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 -InputOnly, +InputOnly, a -BadMatch +BadMatch error results. XClearArea can generate -BadMatch, -BadValue, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -222,28 +222,28 @@ function clears the entire area in the specified window and is equivalent to XClearArea (display, w, 0, 0, 0, 0, -False). +False). If the window has a defined background tile, the rectangle is tiled with a plane-mask of all ones and -GXcopy +GXcopy function. If the window has background -None, +None, the contents of the window are not changed. If you specify a window whose class is -InputOnly, +InputOnly, a -BadMatch +BadMatch error results. XClearWindow can generate -BadMatch +BadMatch and -BadWindow +BadWindow errors. @@ -400,7 +400,7 @@ function combines the specified rectangle of src with the specified rectangle of dest. The drawables must have the same root and depth, or a -BadMatch +BadMatch error results. @@ -413,27 +413,27 @@ Instead, the following occurs on all corresponding destination regions that are either visible or are retained in backing store. If the destination is a window with a background other than -None, +None, corresponding regions of the destination are tiled with that background (with plane-mask of all ones and -GXcopy +GXcopy function). Regardless of tiling or whether the destination is a window or a pixmap, if graphics-exposures is -True, +True, then -GraphicsExpose +GraphicsExpose events for all corresponding destination regions are generated. If graphics-exposures is -True +True but no -GraphicsExpose +GraphicsExpose events are generated, a -NoExpose +NoExpose event is generated. Note that by default graphics-exposures is -True +True in new GCs. @@ -446,10 +446,10 @@ clip-y-origin, and clip-mask. XCopyArea can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -606,11 +606,11 @@ function uses a single bit plane of the specified 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 -BadMatch +BadMatch error results. If plane does not have exactly one bit set to 1 and the value of plane is not less than %2 sup n%, where n is the depth of src, a -BadValue +BadValue error results. @@ -623,11 +623,11 @@ 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 -CopyArea +CopyArea protocol request is performed with all the same exposure semantics. This can also be thought of as using the specified region of the source bit plane as a stipple with a fill-style of -FillOpaqueStippled +FillOpaqueStippled for filling a rectangular area of the destination. @@ -640,11 +640,11 @@ and clip-mask. XCopyPlane can generate -BadDrawable, -BadGC, -BadMatch, +BadDrawable, +BadGC, +BadMatch, and -BadValue +BadValue errors. @@ -908,9 +908,9 @@ Specifies the number of points in the array. Specifies the coordinate mode. You can pass -CoordModeOrigin +CoordModeOrigin or -CoordModePrevious. +CoordModePrevious. @@ -925,10 +925,10 @@ function uses the foreground pixel and function components of the GC to draw a single point into the specified drawable; XDrawPoints draws multiple points this way. -CoordModeOrigin +CoordModeOrigin treats all coordinates as relative to the origin, and -CoordModePrevious +CoordModePrevious treats all coordinates after the first as relative to the previous point. XDrawPoints draws the points in the order listed in the array. @@ -942,18 +942,18 @@ foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. XDrawPoint can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. XDrawPoints can generate -BadDrawable, -BadGC, -BadMatch, +BadDrawable, +BadGC, +BadMatch, and -BadValue +BadValue errors. @@ -1143,9 +1143,9 @@ Specifies the number of points in the array. Specifies the coordinate mode. You can pass -CoordModeOrigin +CoordModeOrigin or -CoordModePrevious. +CoordModePrevious. @@ -1244,7 +1244,7 @@ The 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 -XPoint +XPoint structures. It draws the lines in the order listed in the array. The lines join correctly at all intermediate points, and if the first and last @@ -1256,12 +1256,12 @@ 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 -PolyLine +PolyLine protocol request were a single, filled shape. -CoordModeOrigin +CoordModeOrigin treats all coordinates as relative to the origin, and -CoordModePrevious +CoordModePrevious treats all coordinates after the first as relative to the previous point. @@ -1274,7 +1274,7 @@ For each segment, draws a line between (x1, y1) and (x2, y2). It draws the lines in the order listed in the array of -XSegment +XSegment structures and does not perform joining at coincident endpoints. For any given line, XDrawSegments @@ -1301,14 +1301,14 @@ tile-stipple-y-origin, dash-offset, and dash-list. and XDrawSegments can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. XDrawLines also can generate -BadValue +BadValue errors. @@ -1500,7 +1500,7 @@ and XDrawRectangles functions draw the outlines of the specified rectangle or rectangles as if a five-point -PolyLine +PolyLine protocol request were specified for each rectangle: @@ -1535,10 +1535,10 @@ tile-stipple-y-origin, dash-offset, and dash-list. and XDrawRectangles can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -1866,10 +1866,10 @@ tile-stipple-y-origin, dash-offset, and dash-list. and XDrawArcs can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -2089,7 +2089,7 @@ and XFillRectangles functions fill the specified rectangle or rectangles as if a four-point -FillPolygon +FillPolygon protocol request were specified for each rectangle: @@ -2130,10 +2130,10 @@ and tile-stipple-y-origin. and XFillRectangles can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -2223,10 +2223,10 @@ Specifies the number of points in the array. Specifies a shape that helps the server to improve performance. You can pass -Complex, -Convex, +Complex, +Convex, or -Nonconvex. +Nonconvex. @@ -2238,9 +2238,9 @@ or Specifies the coordinate mode. You can pass -CoordModeOrigin +CoordModeOrigin or -CoordModePrevious. +CoordModePrevious. @@ -2256,10 +2256,10 @@ automatically if the last point in the list does not coincide with the first point. XFillPolygon does not draw a pixel of the region more than once. -CoordModeOrigin +CoordModeOrigin treats all coordinates as relative to the origin, and -CoordModePrevious +CoordModePrevious treats all coordinates after the first as relative to the previous point. @@ -2270,7 +2270,7 @@ Depending on the specified shape, the following occurs: If shape is -Complex, +Complex, the path may self-intersect. Note that contiguous coincident points in the path are not treated as self-intersection. @@ -2279,15 +2279,15 @@ as self-intersection. If shape is -Convex, +Convex, for every pair of points inside the polygon, the line segment connecting them does not intersect the path. If known by the client, specifying -Convex +Convex can improve performance. If you specify -Convex +Convex for a path that is not convex, the graphics results are undefined. @@ -2295,17 +2295,17 @@ the graphics results are undefined. If shape is -Nonconvex, +Nonconvex, the path does not self-intersect, but the shape is not wholly convex. If known by the client, specifying -Nonconvex +Nonconvex instead of -Complex +Complex may improve performance. If you specify -Nonconvex +Nonconvex for a self-intersecting path, the graphics results are undefined. @@ -2328,11 +2328,11 @@ and tile-stipple-y-origin. XFillPolygon can generate -BadDrawable, -BadGC, -BadMatch, +BadDrawable, +BadGC, +BadMatch, and -BadValue +BadValue errors. @@ -2545,10 +2545,10 @@ fills the region closed by the infinitely thin path described by the specified arc and, depending on the arc-mode specified in the GC, one or two line segments. For -ArcChord, +ArcChord, the single line segment joining the endpoints of the arc is used. For -ArcPieSlice, +ArcPieSlice, the two line segments joining the endpoints of the arc with the center point are used. XFillArcs @@ -2576,10 +2576,10 @@ and tile-stipple-y-origin. and XFillArcs can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -2649,18 +2649,18 @@ This means that it makes sense to draw text using stipples or tiles The -XFontStruct +XFontStruct 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 -XCharStruct +XCharStruct structures for the characters contained in the font. The -XFontStruct, -XFontProp, +XFontStruct, +XFontProp, and -XCharStruct +XCharStruct structures contain: @@ -2746,35 +2746,35 @@ specified in the structure defines a range of characters. The bounding box of a character is defined by the -XCharStruct +XCharStruct 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 -XFontStruct +XFontStruct min and max bounds are used. The members of the -XFontStruct +XFontStruct have the following semantics: The direction member can be either -FontLeftToRight +FontLeftToRight or -FontRightToLeft. +FontRightToLeft. It is just a hint as to whether most -XCharStruct +XCharStruct elements have a positive -(FontLeftToRight) +(FontLeftToRight) or a negative -(FontRightToLeft) +(FontRightToLeft) character width metric. The core protocol defines no support for vertical text. @@ -2830,7 +2830,7 @@ as given by both min_bounds and max_bounds. If all_chars_exist is -True, +True, all characters in the per_char array have nonzero bounding boxes. @@ -2850,7 +2850,7 @@ no printing is performed for an undefined or nonexistent character. The min_bounds and max_bounds members contain the most extreme values of each individual -XCharStruct +XCharStruct component over all elements of this array (and ignore nonexistent characters). The bounding box of the font (the smallest @@ -2909,7 +2909,7 @@ For a character origin at [x,y], the bounding box of a character (that is, the smallest rectangle that encloses the character's shape) described in terms of -XCharStruct +XCharStruct components is a rectangle with its upper-left corner at: @@ -2971,7 +2971,7 @@ a nonkerned character. When lbearing is zero, no pixels with X-coordinate less than x are drawn. Any of the -XCharStruct +XCharStruct metric members could be negative. If the width is negative, the next character will be placed to the left of the current origin. @@ -2980,10 +2980,10 @@ 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 -XCharStruct +XCharStruct structure. A nonexistent character is represented with all members of its -XCharStruct +XCharStruct set to zero. @@ -3007,7 +3007,7 @@ unload fonts, and free font information. Fontsunloading Fontsfreeing font information A few font functions use a -GContext +GContext resource ID or a font ID interchangeably. @@ -3069,7 +3069,7 @@ If XLoadFont was unsuccessful at loading the specified font, a -BadName +BadName error results. Fonts are not associated with a particular screen and can be stored as a component @@ -3081,9 +3081,9 @@ When the font is no longer needed, call XLoadFont can generate -BadAlloc +BadAlloc and -BadName +BadName errors. @@ -3119,7 +3119,7 @@ Specifies the connection to the X server. Specifies the font ID or the -GContext +GContext ID. @@ -3132,13 +3132,13 @@ ID. The XQueryFont function returns a pointer to the -XFontStruct +XFontStruct structure, which contains information associated with the font. You can query a font or the font stored in a GC. The font ID stored in the -XFontStruct +XFontStruct structure will be the -GContext +GContext ID, and you need to be careful when using this ID in other functions (see XGContextFromGC). @@ -3200,7 +3200,7 @@ function provides the most common way for accessing a font. XLoadQueryFont both opens (loads) the specified font and returns a pointer to the appropriate -XFontStruct +XFontStruct structure. If the font name is not in the Host Portable Character Encoding, the result is implementation-dependent. @@ -3212,7 +3212,7 @@ returns NULL. XLoadQueryFont can generate a -BadAlloc +BadAlloc error. @@ -3265,7 +3265,7 @@ The XFreeFont function deletes the association between the font resource ID and the specified font and frees the -XFontStruct +XFontStruct structure. The font itself will be freed when no other resource references it. The data and the font should not be referenced again. @@ -3274,7 +3274,7 @@ The data and the font should not be referenced again. XFreeFont can generate a -BadFont +BadFont error. @@ -3335,9 +3335,9 @@ the function returns the value of the specified font property. XGetFontProperty also returns -False +False if the property was not defined or -True +True if it was defined. A set of predefined atoms exists for font properties, which can be found in @@ -3400,7 +3400,7 @@ The font should not be referenced again. XUnloadFont can generate a -BadFont +BadFont error. @@ -3864,7 +3864,7 @@ To compute the bounding box of an 8-bit character string in a given font, use Specifies the -XFontStruct +XFontStruct structure. @@ -3896,9 +3896,9 @@ Specifies the number of characters in the character string. Returns the value of the direction hint -(FontLeftToRight +(FontLeftToRight or -FontRightToLeft). +FontRightToLeft). @@ -3929,7 +3929,7 @@ Returns the font descent. Returns the overall size in the specified -XCharStruct +XCharStruct structure. @@ -3964,7 +3964,7 @@ To compute the bounding box of a 2-byte character string in a given font, use Specifies the -XFontStruct +XFontStruct structure. @@ -3996,9 +3996,9 @@ Specifies the number of characters in the character string. Returns the value of the direction hint -(FontLeftToRight +(FontLeftToRight or -FontRightToLeft). +FontRightToLeft). @@ -4029,7 +4029,7 @@ Returns the font descent. Returns the overall size in the specified -XCharStruct +XCharStruct structure. @@ -4050,7 +4050,7 @@ avoid the round-trip overhead of and XQueryTextExtents16. Both functions return an -XCharStruct +XCharStruct structure, whose members are set to the values as follows. @@ -4072,7 +4072,7 @@ The rbearing member is set to the maximum R. For fonts defined with linear indexing rather than 2-byte matrix indexing, each -XChar2b +XChar2b structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, @@ -4122,7 +4122,7 @@ Specifies the connection to the X server. Specifies either the font ID or the -GContext +GContext ID that contains the font. @@ -4154,9 +4154,9 @@ Specifies the number of characters in the character string. Returns the value of the direction hint -(FontLeftToRight +(FontLeftToRight or -FontRightToLeft). +FontRightToLeft). @@ -4187,7 +4187,7 @@ Returns the font descent. Returns the overall size in the specified -XCharStruct +XCharStruct structure. @@ -4234,7 +4234,7 @@ Specifies the connection to the X server. Specifies either the font ID or the -GContext +GContext ID that contains the font. @@ -4266,9 +4266,9 @@ Specifies the number of characters in the character string. Returns the value of the direction hint -(FontLeftToRight +(FontLeftToRight or -FontRightToLeft). +FontRightToLeft). @@ -4299,7 +4299,7 @@ Returns the font descent. Returns the overall size in the specified -XCharStruct +XCharStruct structure. @@ -4322,7 +4322,7 @@ overhead that is avoided by and XTextExtents16. Both functions return a -XCharStruct +XCharStruct structure, whose members are set to the values as follows. @@ -4344,7 +4344,7 @@ The rbearing member is set to the maximum R. For fonts defined with linear indexing rather than 2-byte matrix indexing, each -XChar2b +XChar2b structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, @@ -4362,9 +4362,9 @@ the undefined characters in the string are also ignored. and XQueryTextExtents16 can generate -BadFont +BadFont and -BadGC +BadGC errors. @@ -4436,7 +4436,7 @@ typedef struct { If the font member is not -None, +None, the font is changed before printing and also is stored in the GC. If an error was generated during text drawing, the previous items may have been drawn. @@ -4451,13 +4451,13 @@ 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 -XFontStruct +XFontStruct structure. If you want the lower-left corner 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 -XFontStruct +XFontStruct structure. @@ -4674,7 +4674,7 @@ Both functions allow complex spacing and font shifts between counted strings. Each text item is processed in turn. A font member other than -None +None in an item causes the font to be stored in the GC and used for subsequent text. A text element delta specifies an additional change @@ -4685,14 +4685,14 @@ 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 -BadFont +BadFont error, the previous text items may have been drawn. For fonts defined with linear indexing rather than 2-byte matrix indexing, each -XChar2b +XChar2b structure is interpreted as a 16-bit number with byte1 as the most significant byte. @@ -4711,11 +4711,11 @@ and tile-stipple-y-origin. and XDrawText16 can generate -BadDrawable, -BadFont, -BadGC, +BadDrawable, +BadFont, +BadGC, and -BadMatch +BadMatch errors. @@ -4942,10 +4942,10 @@ and tile-stipple-y-origin. and XDrawString16 can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -5208,9 +5208,9 @@ are as would be returned by using gc and string. The function and fill-style defined in the GC are ignored for these functions. The effective function is -GXcopy, +GXcopy, and the effective fill-style is -FillSolid. +FillSolid. @@ -5231,10 +5231,10 @@ clip-y-origin, and clip-mask. and XDrawImageString16 can generate -BadDrawable, -BadGC, +BadDrawable, +BadGC, and -BadMatch +BadMatch errors. @@ -5267,7 +5267,7 @@ to an image (see section 16.8). All the image manipulation functions discussed in this section make use of the -XImage +XImage structure, which describes an image as it exists in the client's memory. @@ -5433,7 +5433,7 @@ Specifies the image you want combined with the rectangle. Specifies the offset in X from the left edge of the image defined by the -XImage +XImage structure. @@ -5446,7 +5446,7 @@ structure. Specifies the offset in Y from the top edge of the image defined by the -XImage +XImage structure. and are the coordinates of the subimage @@ -5508,20 +5508,20 @@ 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 -XYBitmap +XYBitmap format is used, the depth of the image must be one, or a -BadMatch +BadMatch 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 -XYPixmap +XYPixmap and -ZPixmap, +ZPixmap, the depth of the image must match the depth of the drawable, or a -BadMatch +BadMatch error results. @@ -5544,11 +5544,11 @@ foreground and background. XPutImage can generate -BadDrawable, -BadGC, -BadMatch, +BadDrawable, +BadGC, +BadMatch, and -BadValue +BadValue errors. @@ -5657,9 +5657,9 @@ Specifies the plane mask. Specifies the format for the image. You can pass -XYPixmap +XYPixmap or -ZPixmap. +ZPixmap. @@ -5671,18 +5671,18 @@ or The XGetImage function returns a pointer to an -XImage +XImage structure. This structure provides you with the contents of the specified rectangle of the drawable in the format you specify. If the format argument is -XYPixmap, +XYPixmap, the image contains only the bit planes you passed to the plane_mask argument. If the plane_mask argument only requests a subset of the planes of the display, the depth of the returned image will be the number of planes requested. If the format argument is -ZPixmap, +ZPixmap, XGetImage returns as zero the bits in all planes not specified in the plane_mask argument. @@ -5693,11 +5693,11 @@ extraneous bits. XGetImage returns the depth of the image to the depth member of the -XImage +XImage structure. The depth of the image is as specified when the drawable was created, except when getting a subset of the planes in -XYPixmap +XYPixmap format, when the depth is given by the number of bits set to 1 in plane_mask. @@ -5705,7 +5705,7 @@ 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 -BadMatch +BadMatch error results. If the drawable is a window, the window must be viewable, @@ -5713,7 +5713,7 @@ and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen and wholly contained within the outside edges of the window, or a -BadMatch +BadMatch error results. Note that the borders of the window can be included and read with this request. @@ -5733,10 +5733,10 @@ returns NULL. XGetImage can generate -BadDrawable, -BadMatch, +BadDrawable, +BadMatch, and -BadValue +BadValue errors. @@ -5846,9 +5846,9 @@ Specifies the plane mask. Specifies the format for the image. You can pass -XYPixmap +XYPixmap or -ZPixmap. +ZPixmap. @@ -5896,10 +5896,10 @@ The function updates dest_image with the specified subimage in the same manner as XGetImage. If the format argument is -XYPixmap, +XYPixmap, the image contains only the bit planes you passed to the plane_mask argument. If the format argument is -ZPixmap, +ZPixmap, XGetSubImage returns as zero the bits in all planes not specified in the plane_mask argument. @@ -5908,20 +5908,20 @@ extraneous bits. As a convenience, XGetSubImage returns a pointer to the same -XImage +XImage structure specified by dest_image. The depth of the destination -XImage +XImage 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 drawable is a pixmap, the given rectangle must be wholly contained within the pixmap, or a -BadMatch +BadMatch error results. If the drawable is a window, the window must be viewable, @@ -5929,7 +5929,7 @@ and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen and wholly contained within the outside edges of the window, or a -BadMatch +BadMatch error results. If the window has backing-store, then the backing-store contents are returned for regions of the window @@ -5946,11 +5946,11 @@ returns NULL. XGetSubImage can generate -BadDrawable, -BadGC, -BadMatch, +BadDrawable, +BadGC, +BadMatch, and -BadValue +BadValue errors. diff --git a/specs/libX11/CH09.xml b/specs/libX11/CH09.xml index 8d32cef6..e182a4b0 100644 --- a/specs/libX11/CH09.xml +++ b/specs/libX11/CH09.xml @@ -102,7 +102,7 @@ Specify the x and y coordinates(Xy. If the specified window is mapped, XReparentWindow automatically performs an -UnmapWindow +UnmapWindow 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 @@ -113,16 +113,16 @@ sibling windows. After reparenting the specified window, XReparentWindow causes the X server to generate a -ReparentNotify +ReparentNotify 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 -True. +True. Finally, if the specified window was originally mapped, the X server automatically performs a -MapWindow +MapWindow request on it. @@ -130,14 +130,14 @@ request on it. The X server performs normal exposure processing on formerly obscured windows. The X server might not generate -Expose +Expose events for regions from the initial -UnmapWindow +UnmapWindow request that are immediately obscured by the final -MapWindow +MapWindow request. A -BadMatch +BadMatch error results if: @@ -156,14 +156,14 @@ specified window. The new parent is -InputOnly, +InputOnly, and the window is not. The specified window has a -ParentRelative +ParentRelative background, and the new parent window is not the same depth as the specified window. @@ -173,9 +173,9 @@ specified window. XReparentWindow can generate -BadMatch +BadMatch and -BadWindow +BadWindow errors. @@ -254,9 +254,9 @@ Specifies the window (Wi. Specifies the mode. You can pass -SetModeInsert +SetModeInsert or -SetModeDelete. +SetModeDelete. @@ -270,17 +270,17 @@ Depending on the specified mode, 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 -BadMatch +BadMatch error results. XChangeSaveSet can generate -BadMatch, -BadValue, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -330,16 +330,16 @@ The function adds the specified window to the client's save-set. The specified window must have been created by some other client, or a -BadMatch +BadMatch error results. XAddToSaveSet can generate -BadMatch +BadMatch and -BadWindow +BadWindow errors. @@ -389,16 +389,16 @@ The function removes the specified window from the client's save-set. The specified window must have been created by some other client, or a -BadMatch +BadMatch error results. XRemoveFromSaveSet can generate -BadMatch +BadMatch and -BadWindow +BadWindow errors. @@ -496,20 +496,20 @@ or If the specified colormap is not already an installed colormap, the X server generates a -ColormapNotify +ColormapNotify event on each window that has that colormap. In addition, for every other colormap that is installed as a result of a call to XInstallColormap, the X server generates a -ColormapNotify +ColormapNotify event on each window that has that colormap. XInstallColormap can generate a -BadColor +BadColor error. @@ -567,20 +567,20 @@ except that the required list must remain installed. If the specified colormap becomes uninstalled, the X server generates a -ColormapNotify +ColormapNotify event on each window that has that colormap. In addition, for every other colormap that is installed or uninstalled as a result of a call to XUninstallColormap, the X server generates a -ColormapNotify +ColormapNotify event on each window that has that colormap. XUninstallColormap can generate a -BadColor +BadColor error. @@ -650,7 +650,7 @@ free it by using XListInstalledColormaps can generate a -BadWindow +BadWindow error. @@ -740,7 +740,7 @@ The meaning of an error from this request is implementation-dependent. XSetFontPath can generate a -BadValue +BadValue error. @@ -962,7 +962,7 @@ Specifies the connection to the X server. Specifies any resource associated with the client that you want to destroy or -AllTemporary. +AllTemporary. @@ -979,19 +979,19 @@ that created the resource if a valid resource is specified. If the client has already terminated in either -RetainPermanent +RetainPermanent or -RetainTemporary +RetainTemporary mode, all of the client's resources are destroyed. If -AllTemporary +AllTemporary is specified, the resources of all clients that have terminated in -RetainTemporary +RetainTemporary are destroyed (see section 2.5). This permits implementation of window manager facilities that aid debugging. A client can set its close-down mode to -RetainTemporary. +RetainTemporary. If the client then crashes, its windows would not be destroyed. The programmer can then inspect the application's window tree @@ -1001,7 +1001,7 @@ and use the window manager to destroy the zombie windows. XKillClient can generate a -BadValue +BadValue error. @@ -1072,10 +1072,10 @@ Specifies the interval, in seconds, between screen saver alterations. Specifies how to enable screen blanking. You can pass -DontPreferBlanking, -PreferBlanking, +DontPreferBlanking, +PreferBlanking, or -DefaultBlanking. +DefaultBlanking. @@ -1087,10 +1087,10 @@ or Specifies the screen save control values. You can pass -DontAllowExposures, -AllowExposures, +DontAllowExposures, +AllowExposures, or -DefaultExposures. +DefaultExposures. @@ -1104,7 +1104,7 @@ 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 -BadValue +BadValue error. If the timeout value is nonzero, XSetScreenSaver @@ -1121,7 +1121,7 @@ if blanking is preferred and the hardware supports video blanking, the screen simply goes blank. Otherwise, if either exposures are allowed or the screen can be regenerated without sending -Expose +Expose events to clients, the screen is tiled with the root window background tile randomly re-origined each interval seconds. @@ -1132,7 +1132,7 @@ and all screen states are restored at the next keyboard or pointer input or at the next call to XForceScreenSaver with mode -ScreenSaverReset. +ScreenSaverReset. @@ -1148,7 +1148,7 @@ periodically. XSetScreenSaver can generate a -BadValue +BadValue error. @@ -1185,9 +1185,9 @@ Specifies the connection to the X server. Specifies the mode that is to be applied. You can pass -ScreenSaverActive +ScreenSaverActive or -ScreenSaverReset. +ScreenSaverReset. @@ -1197,13 +1197,13 @@ or If the specified mode is -ScreenSaverActive +ScreenSaverActive and the screen saver currently is deactivated, XForceScreenSaver activates the screen saver even if the screen saver had been disabled with a timeout of zero. If the specified mode is -ScreenSaverReset +ScreenSaverReset and the screen saver currently is enabled, XForceScreenSaver deactivates the screen saver if it was activated, @@ -1214,7 +1214,7 @@ and the activation timer is reset to its initial state XForceScreenSaver can generate a -BadValue +BadValue error. @@ -1328,10 +1328,10 @@ Returns the interval between screen saver invocations. Returns the current screen blanking preference -(DontPreferBlanking, -PreferBlanking, +(DontPreferBlanking, +PreferBlanking, or -DefaultBlanking). +DefaultBlanking). @@ -1342,10 +1342,10 @@ or Returns the current screen save control value -(DontAllowExposures, -AllowExposures, +(DontAllowExposures, +AllowExposures, or -DefaultExposures). +DefaultExposures). @@ -1405,11 +1405,11 @@ The host the window system is running on. On POSIX-conformant systems, each host listed in the -/etc/X?.hosts +/etc/X?.hosts file. The ? indicates the number of the display. -Files/etc/X?.hosts +Files/etc/X?.hosts This file should consist of host names separated by newlines. DECnet nodes must terminate in :: to distinguish them from Internet hosts. @@ -1442,7 +1442,7 @@ see ``X Window System Protocol.'' 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 -XHostAddress +XHostAddress structure, which contains: @@ -1464,12 +1464,12 @@ typedef struct { The family member specifies which protocol address family to use (for example, TCP/IP or DECnet) and can be -FamilyInternet, -FamilyInternet6, -FamilyServerInterpreted, -FamilyDECnet, +FamilyInternet, +FamilyInternet6, +FamilyServerInterpreted, +FamilyDECnet, or -FamilyChaos. +FamilyChaos. The length member specifies the length of the address in bytes. The address member specifies a pointer to the address. @@ -1494,7 +1494,7 @@ 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 -XServerInterpretedAddress +XServerInterpretedAddress structure, which contains: @@ -1566,16 +1566,16 @@ The XAddHost 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 -BadAccess +BadAccess error results. XAddHost can generate -BadAccess +BadAccess and -BadValue +BadValue errors. @@ -1635,16 +1635,16 @@ The XAddHosts 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 -BadAccess +BadAccess error results. XAddHosts can generate -BadAccess +BadAccess and -BadValue +BadValue errors. @@ -1758,7 +1758,7 @@ The 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 -BadAccess +BadAccess error results. If you remove your machine from the access list, you can no longer connect to that server, @@ -1768,9 +1768,9 @@ and this operation cannot be reversed unless you reset the server. XRemoveHost can generate -BadAccess +BadAccess and -BadValue +BadValue errors. @@ -1831,7 +1831,7 @@ The 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 -BadAccess +BadAccess error results. If you remove your machine from the access list, you can no longer connect to that server, @@ -1841,9 +1841,9 @@ and this operation cannot be reversed unless you reset the server. XRemoveHosts can generate -BadAccess +BadAccess and -BadValue +BadValue errors. @@ -1898,9 +1898,9 @@ Specifies the connection to the X server. Specifies the mode. You can pass -EnableAccess +EnableAccess or -DisableAccess. +DisableAccess. @@ -1918,9 +1918,9 @@ at each connection setup. XSetAccessControl can generate -BadAccess +BadAccess and -BadValue +BadValue errors. @@ -1961,7 +1961,7 @@ function enables the use of the access control list at each connection setup. XEnableAccessControl can generate a -BadAccess +BadAccess error. @@ -2002,7 +2002,7 @@ function disables the use of the access control list at each connection setup. XDisableAccessControl can generate a -BadAccess +BadAccess error. diff --git a/specs/libX11/CH10.xml b/specs/libX11/CH10.xml index db691c72..9852827d 100644 --- a/specs/libX11/CH10.xml +++ b/specs/libX11/CH10.xml @@ -48,7 +48,7 @@ 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, -MappingNotify +MappingNotify events are always sent to all clients. Input Control Output Control @@ -85,67 +85,67 @@ The processing associated with these events is discussed in section 10.5. Keyboard events - KeyPress, - KeyRelease + KeyPress, + KeyRelease Pointer events - ButtonPress, - ButtonRelease, - MotionNotify + ButtonPress, + ButtonRelease, + MotionNotify Window crossing events - EnterNotify, - LeaveNotify + EnterNotify, + LeaveNotify Input focus events - FocusIn, - FocusOut + FocusIn, + FocusOut Keymap state notification event - KeymapNotify + KeymapNotify Exposure events - Expose, - GraphicsExpose, - NoExpose + Expose, + GraphicsExpose, + NoExpose Structure control events - CirculateRequest, - ConfigureRequest, - MapRequest, - ResizeRequest + CirculateRequest, + ConfigureRequest, + MapRequest, + ResizeRequest Window state notification events - CirculateNotify, - ConfigureNotify, - CreateNotify, - DestroyNotify, - GravityNotify, - MapNotify, - MappingNotify, - ReparentNotify, - UnmapNotify, - VisibilityNotify + CirculateNotify, + ConfigureNotify, + CreateNotify, + DestroyNotify, + GravityNotify, + MapNotify, + MappingNotify, + ReparentNotify, + UnmapNotify, + VisibilityNotify Colormap state notification event - ColormapNotify + ColormapNotify Client communication events - ClientMessage, - PropertyNotify, - SelectionClear, - SelectionNotify, - SelectionRequest + ClientMessage, + PropertyNotify, + SelectionClear, + SelectionNotify, + SelectionRequest @@ -196,16 +196,16 @@ typedef struct { The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -GraphicsExpose +GraphicsExpose event to a client application, it sends an -XGraphicsExposeEvent +XGraphicsExposeEvent structure with the type member set to -GraphicsExpose. +GraphicsExpose. The display member is set to a pointer to the display the event was read on. The send_event member is set to -True +True if the event came from a -SendEvent +SendEvent 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. @@ -223,11 +223,11 @@ in the event queue (see section 11.3). In addition to the individual structures declared for each event type, the -XEvent +XEvent structure is a union of the individual structures declared for each event type. Depending on the type, you should access members of each event by using the -XEvent +XEvent union. @@ -279,14 +279,14 @@ typedef union _XEvent { An -XEvent +XEvent 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 -Bool +Bool 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. @@ -323,24 +323,24 @@ 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-exposures in the GC to -False, -GraphicsExpose +False, +GraphicsExpose and -NoExpose +NoExpose are reported by default as a result of XCopyPlane and XCopyArea. -SelectionClear, -SelectionRequest, -SelectionNotify, +SelectionClear, +SelectionRequest, +SelectionNotify, or -ClientMessage +ClientMessage 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, -MappingNotify +MappingNotify is always sent to clients. @@ -367,107 +367,107 @@ event mask: - NoEventMask + NoEventMask No events wanted - KeyPressMask + KeyPressMask Keyboard down events wanted - KeyReleaseMask + KeyReleaseMask Keyboard up events wanted - ButtonPressMask + ButtonPressMask Pointer button down events wanted - ButtonReleaseMask + ButtonReleaseMask Pointer button up events wanted - EnterWindowMask + EnterWindowMask Pointer window entry events wanted - LeaveWindowMask + LeaveWindowMask Pointer window leave events wanted - PointerMotionMask + PointerMotionMask Pointer motion events wanted - PointerMotionHintMask + PointerMotionHintMask Pointer motion hints wanted - Button1MotionMask + Button1MotionMask Pointer motion while button 1 down - Button2MotionMask + Button2MotionMask Pointer motion while button 2 down - Button3MotionMask + Button3MotionMask Pointer motion while button 3 down - Button4MotionMask + Button4MotionMask Pointer motion while button 4 down - Button5MotionMask + Button5MotionMask Pointer motion while button 5 down - ButtonMotionMask + ButtonMotionMask Pointer motion while any button down - KeymapStateMask + KeymapStateMask Keyboard state wanted at window entry and focus in - ExposureMask + ExposureMask Any exposure wanted - VisibilityChangeMask + VisibilityChangeMask Any change in visibility wanted - StructureNotifyMask + StructureNotifyMask Any change in window structure wanted - ResizeRedirectMask + ResizeRedirectMask Redirect resize of this window - SubstructureNotifyMask + SubstructureNotifyMask Substructure notification wanted - SubstructureRedirectMask + SubstructureRedirectMask Redirect structure requests on children - FocusChangeMask + FocusChangeMask Any change in input focus wanted - PropertyChangeMask + PropertyChangeMask Any change in property wanted - ColormapChangeMask + ColormapChangeMask Any change in colormap wanted - OwnerGrabButtonMask + OwnerGrabButtonMask Automatic grabs should activate with owner_events set to True @@ -491,9 +491,9 @@ 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 -ButtonPressMask, +ButtonPressMask, the X server sends back only -ButtonPress +ButtonPress events. CurrentTime Most events contain a time member, @@ -503,17 +503,17 @@ 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 -SubstructureNotifyMask, +SubstructureNotifyMask, the X server can send back -CirculateNotify, -ConfigureNotify, -CreateNotify, -DestroyNotify, -GravityNotify, -MapNotify, -ReparentNotify, +CirculateNotify, +ConfigureNotify, +CreateNotify, +DestroyNotify, +GravityNotify, +MapNotify, +ReparentNotify, or -UnmapNotify +UnmapNotify events. @@ -522,12 +522,12 @@ In another case, two event masks can map to one event type. For example, if you pass either -PointerMotionMask +PointerMotionMask or -ButtonMotionMask, +ButtonMotionMask, the X server sends back a -MotionNotify +MotionNotify event. @@ -925,28 +925,28 @@ with these client passed arguments: pointer_mode - GrabModeAsync + GrabModeAsync keyboard_mode - GrabModeAsync + GrabModeAsync owner_events - True, + True, if the client has selected - OwnerGrabButtonMask + OwnerGrabButtonMask on the event window, otherwise - False + False confine_to - None + None cursor - None + None @@ -977,14 +977,14 @@ and EventsMotionNotify This section discusses the processing that occurs for the keyboard events -KeyPress +KeyPress and -KeyRelease +KeyRelease and the pointer events -ButtonPress, -ButtonRelease, +ButtonPress, +ButtonRelease, and -MotionNotify. +MotionNotify. For information about the keyboard event-handling utilities, see chapter 11. @@ -993,30 +993,30 @@ see chapter 11. KeyPress KeyRelease The X server reports -KeyPress +KeyPress or -KeyRelease +KeyRelease 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. ButtonPress ButtonRelease The X server reports -ButtonPress +ButtonPress or -ButtonRelease +ButtonRelease events to clients wanting information about buttons that logically change state. MotionNotify The X server reports -MotionNotify +MotionNotify 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 -MotionNotify +MotionNotify 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. @@ -1029,23 +1029,23 @@ if device event processing is frozen. To receive -KeyPress, -KeyRelease, -ButtonPress, +KeyPress, +KeyRelease, +ButtonPress, and -ButtonRelease +ButtonRelease events, set -KeyPressMask, -KeyReleaseMask, -ButtonPressMask, +KeyPressMask, +KeyReleaseMask, +ButtonPressMask, and -ButtonReleaseMask +ButtonReleaseMask bits in the event-mask attribute of the window. To receive -MotionNotify +MotionNotify events, set one or more of the following event masks bits in the event-mask attribute of the window. @@ -1053,57 +1053,57 @@ masks bits in the event-mask attribute of the window. Button1MotionMask \ \- -Button5MotionMask +Button5MotionMask The client application receives -MotionNotify +MotionNotify events only when one or more of the specified buttons is pressed. -ButtonMotionMask +ButtonMotionMask The client application receives -MotionNotify +MotionNotify events only when at least one button is pressed. -PointerMotionMask +PointerMotionMask The client application receives -MotionNotify +MotionNotify events independent of the state of the pointer buttons. -PointerMotionHintMask +PointerMotionHintMask If -PointerMotionHintMask +PointerMotionHintMask is selected in combination with one or more of the above masks, the X server is free to send only one -MotionNotify +MotionNotify event (with the is_hint member of the -XPointerMovedEvent +XPointerMovedEvent structure set to -NotifyHint) +NotifyHint) 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 @@ -1111,9 +1111,9 @@ the pointer leaves the event window, or the client calls or XGetMotionEvents. The server still may send -MotionNotify +MotionNotify events without is_hint set to -NotifyHint. +NotifyHint. @@ -1212,14 +1212,14 @@ 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 -True +True or -False. +False. If -True, +True, the event and root windows are on the same screen. If -False, +False, the event and root windows are not on the same screen. @@ -1229,7 +1229,7 @@ the subwindow member of the structure is set to the child of the event window that is the source window or the child of the event window that is an ancestor of the source window. Otherwise, the X server sets the subwindow member to -None. +None. The time member is set to the time when the event was generated and is expressed in milliseconds. @@ -1246,28 +1246,28 @@ The state member is set to indicate the logical state of the pointer buttons and modifier keys just prior to the event, which is the bitwise inclusive OR of one or more of the button or modifier key masks: -Button1Mask, -Button2Mask, -Button3Mask, -Button4Mask, -Button5Mask, -ShiftMask, -LockMask, -ControlMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, +Button1Mask, +Button2Mask, +Button3Mask, +Button4Mask, +Button5Mask, +ShiftMask, +LockMask, +ControlMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, and -Mod5Mask. +Mod5Mask. Each of these structures also has a member that indicates the detail. For the -XKeyPressedEvent +XKeyPressedEvent and -XKeyReleasedEvent +XKeyReleasedEvent 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 @@ -1276,25 +1276,25 @@ The keycode is an arbitrary representation for any key on the keyboard For the -XButtonPressedEvent +XButtonPressedEvent and -XButtonReleasedEvent +XButtonReleasedEvent structures, this member is called button. It represents the pointer button that changed state and can be the -Button1, -Button2, -Button3, -Button4, +Button1, +Button2, +Button3, +Button4, or -Button5 +Button5 value. For the -XPointerMovedEvent +XPointerMovedEvent structure, this member is called is_hint. It can be set to -NotifyNormal +NotifyNormal or -NotifyHint. +NotifyHint. @@ -1313,95 +1313,95 @@ follows: - Button1MotionMask + Button1MotionMask (1L<<8) - Button2MotionMask + Button2MotionMask (1L<<9) - Button3MotionMask + Button3MotionMask (1L<<10) - Button4MotionMask + Button4MotionMask (1L<<11) - Button5MotionMask + Button5MotionMask (1L<<12) - Button1Mask + Button1Mask (1<<8) - Button2Mask + Button2Mask (1<<9) - Button3Mask + Button3Mask (1<<10) - Button4Mask + Button4Mask (1<<11) - Button5Mask + Button5Mask (1<<12) - ShiftMask + ShiftMask (1<<0) - LockMask + LockMask (1<<1) - ControlMask + ControlMask (1<<2) - Mod1Mask + Mod1Mask (1<<3) - Mod2Mask + Mod2Mask (1<<4) - Mod3Mask + Mod3Mask (1<<5) - Mod4Mask + Mod4Mask (1<<6) - Mod5Mask + Mod5Mask (1<<7) - Button1 + Button1 1 - Button2 + Button2 2 - Button3 + Button3 3 - Button4 + Button4 4 - Button5 + Button5 5 @@ -1421,50 +1421,50 @@ follows: EventsLeaveNotify This section describes the processing that occurs for the window crossing events -EnterNotify +EnterNotify and -LeaveNotify. +LeaveNotify. EnterNotify LeaveNotify If a pointer motion or a window hierarchy change causes the pointer to be in a different window than before, the X server reports -EnterNotify +EnterNotify or -LeaveNotify +LeaveNotify events to clients who have selected for these events. All -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events caused by a hierarchy change are generated after any hierarchy event -(UnmapNotify, -MapNotify, -ConfigureNotify, -GravityNotify, -CirculateNotify) +(UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify) caused by that change; however, the X protocol does not constrain the ordering of -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events with respect to -FocusOut, -VisibilityNotify, +FocusOut, +VisibilityNotify, and -Expose +Expose events. This contrasts with -MotionNotify +MotionNotify events, which are also generated when the pointer moves but only when the pointer motion begins and ends in a single window. An -EnterNotify +EnterNotify or -LeaveNotify +LeaveNotify event also can be generated when some client application calls XGrabPointer and @@ -1473,13 +1473,13 @@ and To receive -EnterNotify +EnterNotify or -LeaveNotify +LeaveNotify events, set the -EnterWindowMask +EnterWindowMask or -LeaveWindowMask +LeaveWindowMask bits of the event-mask attribute of the window. @@ -1523,9 +1523,9 @@ typedef XCrossingEvent XLeaveWindowEvent; The window member is set to the window on which the -EnterNotify +EnterNotify or -LeaveNotify +LeaveNotify event was generated and is referred to as the event window. This is the window used by the X server to report the event, and is relative to the root @@ -1536,17 +1536,17 @@ on which the event occurred. For a -LeaveNotify +LeaveNotify event, if a child of the event window contains the initial position of the pointer, the subwindow component is set to that child. Otherwise, the X server sets the subwindow member to -None. +None. For an -EnterNotify +EnterNotify event, if a child of the event window contains the final pointer position, the subwindow component is set to that child or -None. +None. @@ -1567,14 +1567,14 @@ 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 -True +True or -False. +False. If -True, +True, the event and root windows are on the same screen. If -False, +False, the event and root windows are not on the same screen. @@ -1582,14 +1582,14 @@ the event and root windows 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 -True +True or -False. +False. If -True, +True, the event window is the focus window or an inferior of the focus window. If -False, +False, the event window is not the focus window or an inferior of the focus window. @@ -1599,19 +1599,19 @@ 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: -Button1Mask, -Button2Mask, -Button3Mask, -Button4Mask, -Button5Mask, -ShiftMask, -LockMask, -ControlMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, -Mod5Mask. +Button1Mask, +Button2Mask, +Button3Mask, +Button4Mask, +Button5Mask, +ShiftMask, +LockMask, +ControlMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, +Mod5Mask. @@ -1619,20 +1619,20 @@ 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 -NotifyNormal, -NotifyGrab, +NotifyNormal, +NotifyGrab, or -NotifyUngrab. +NotifyUngrab. The detail member is set to indicate the notify detail and can be -NotifyAncestor, -NotifyVirtual, -NotifyInferior, -NotifyNonlinear, +NotifyAncestor, +NotifyVirtual, +NotifyInferior, +NotifyNonlinear, or -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. Normal Entry/Exit Events @@ -1641,17 +1641,17 @@ or -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events are generated when the pointer moves from one window to another window. Normal events are identified by -XEnterWindowEvent +XEnterWindowEvent or -XLeaveWindowEvent +XLeaveWindowEvent structures whose mode member is set to -NotifyNormal. +NotifyNormal. @@ -1664,32 +1664,32 @@ the X server does the following: It generates a -LeaveNotify +LeaveNotify event on window A, with the detail member of the -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyAncestor. +NotifyAncestor. It generates a -LeaveNotify +LeaveNotify event on each window between window A and window B, exclusive, with the detail member of each -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyVirtual. +NotifyVirtual. It generates an -EnterNotify +EnterNotify event on window B, with the detail member of the -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyInferior. +NotifyInferior. @@ -1703,33 +1703,33 @@ the X server does the following: It generates a -LeaveNotify +LeaveNotify event on window A, with the detail member of the -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyInferior. +NotifyInferior. It generates an -EnterNotify +EnterNotify event on each window between window A and window B, exclusive, with the detail member of each -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyVirtual. +NotifyVirtual. It generates an -EnterNotify +EnterNotify event on window B, with the detail member of the -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyAncestor. +NotifyAncestor. @@ -1744,44 +1744,44 @@ the X server does the following: It generates a -LeaveNotify +LeaveNotify event on window A, with the detail member of the -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyNonlinear. +NotifyNonlinear. It generates a -LeaveNotify +LeaveNotify event on each window between window A and window C, exclusive, with the detail member of each -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates an -EnterNotify +EnterNotify event on each window between window C and window B, exclusive, with the detail member of each -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates an -EnterNotify +EnterNotify event on window B, with the detail member of the -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyNonlinear. +NotifyNonlinear. @@ -1795,46 +1795,46 @@ the X server does the following: It generates a -LeaveNotify +LeaveNotify event on window A, with the detail member of the -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyNonlinear. +NotifyNonlinear. If window A is not a root window, it generates a -LeaveNotify +LeaveNotify event on each window above window A up to and including its root, with the detail member of each -XLeaveWindowEvent +XLeaveWindowEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. If window B is not a root window, it generates an -EnterNotify +EnterNotify event on each window from window B's root down to but not including window B, with the detail member of each -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates an -EnterNotify +EnterNotify event on window B, with the detail member of the -XEnterWindowEvent +XEnterWindowEvent structure set to -NotifyNonlinear. +NotifyNonlinear. @@ -1849,24 +1849,24 @@ structure set to Pseudo-motion mode -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events are generated when a pointer grab activates or deactivates. Events in which the pointer grab activates are identified by -XEnterWindowEvent +XEnterWindowEvent or -XLeaveWindowEvent +XLeaveWindowEvent structures whose mode member is set to -NotifyGrab. +NotifyGrab. Events in which the pointer grab deactivates are identified by -XEnterWindowEvent +XEnterWindowEvent or -XLeaveWindowEvent +XLeaveWindowEvent structures whose mode member is set to -NotifyUngrab +NotifyUngrab (see XGrabPointer). @@ -1875,7 +1875,7 @@ structures whose mode member is set to When a pointer grab activates after any initial warp into a confine_to window and before generating any actual -ButtonPress +ButtonPress event that activates the grab, G is the grab_window for the grab, and P is the window the pointer is in, @@ -1886,16 +1886,16 @@ the X server does the following: It generates -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events (see section 10.6.1) with the mode members of the -XEnterWindowEvent +XEnterWindowEvent and -XLeaveWindowEvent +XLeaveWindowEvent structures set to -NotifyGrab. +NotifyGrab. These events are generated as if the pointer were to suddenly warp from its current position in P to some position in G. @@ -1907,7 +1907,7 @@ as both the initial and final positions for the events. When a pointer grab deactivates after generating any actual -ButtonRelease +ButtonRelease event that deactivates the grab, G is the grab_window for the grab, and P is the window the pointer is in, @@ -1918,16 +1918,16 @@ the X server does the following: It generates -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events (see section 10.6.1) with the mode members of the -XEnterWindowEvent +XEnterWindowEvent and -XLeaveWindowEvent +XLeaveWindowEvent structures set to -NotifyUngrab. +NotifyUngrab. These events are generated as if the pointer were to suddenly warp from some position in G to its current position in P. However, the pointer does not warp, and the X server uses the @@ -1949,15 +1949,15 @@ initial and final positions for the events. EventsFocusIn EventsFocusOut This section describes the processing that occurs for the input focus events -FocusIn +FocusIn and -FocusOut. +FocusOut. FocusIn FocusOut The X server can report -FocusIn +FocusIn or -FocusOut +FocusOut events to clients wanting information about when the input focus changes. The keyboard is always attached to some window (typically, the root window or a top-level window), @@ -1970,11 +1970,11 @@ to control highlighting of areas on the screen. To receive -FocusIn +FocusIn or -FocusOut +FocusOut events, set the -FocusChangeMask +FocusChangeMask bit in the event-mask attribute of the window. @@ -2010,9 +2010,9 @@ typedef XFocusChangeEvent XFocusOutEvent; The window member is set to the window on which the -FocusIn +FocusIn or -FocusOut +FocusOut event was generated. This is the window used by the X server to report the event. The mode member is set to indicate whether the focus events @@ -2021,42 +2021,42 @@ focus events while grabbed, focus events when a grab activates, or focus events when a grab deactivates. The X server can set the mode member to -NotifyNormal, -NotifyWhileGrabbed, -NotifyGrab, +NotifyNormal, +NotifyWhileGrabbed, +NotifyGrab, or -NotifyUngrab. +NotifyUngrab. All -FocusOut +FocusOut events caused by a window unmap are generated after any -UnmapNotify +UnmapNotify event; however, the X protocol does not constrain the ordering of -FocusOut +FocusOut events with respect to generated -EnterNotify, -LeaveNotify, -VisibilityNotify, +EnterNotify, +LeaveNotify, +VisibilityNotify, and -Expose +Expose events. Depending on the event mode, the detail member is set to indicate the notify detail and can be -NotifyAncestor, -NotifyVirtual, -NotifyInferior, -NotifyNonlinear, -NotifyNonlinearVirtual, -NotifyPointer, -NotifyPointerRoot, +NotifyAncestor, +NotifyVirtual, +NotifyInferior, +NotifyNonlinear, +NotifyNonlinearVirtual, +NotifyPointer, +NotifyPointerRoot, or -NotifyDetailNone. +NotifyDetailNone. Normal Focus Events and Focus Events While Grabbed @@ -2066,17 +2066,17 @@ or Normal focus events are identified by -XFocusInEvent +XFocusInEvent or -XFocusOutEvent +XFocusOutEvent structures whose mode member is set to -NotifyNormal. +NotifyNormal. Focus events while grabbed are identified by -XFocusInEvent +XFocusInEvent or -XFocusOutEvent +XFocusOutEvent structures whose mode member is set to -NotifyWhileGrabbed. +NotifyWhileGrabbed. The X server processes normal focus and focus events while grabbed according to the following: @@ -2092,32 +2092,32 @@ the X server does the following: It generates a -FocusOut +FocusOut event on window A, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyAncestor. +NotifyAncestor. It generates a -FocusOut +FocusOut event on each window between window A and window B, exclusive, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyVirtual. +NotifyVirtual. It generates a -FocusIn +FocusIn event on window B, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyInferior. +NotifyInferior. @@ -2125,12 +2125,12 @@ structure set to 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 -FocusIn +FocusIn event on each window below window B, down to and including window P, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyPointer. +NotifyPointer. @@ -2147,44 +2147,44 @@ 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 -FocusOut +FocusOut event on each window from window P up to but not including window A, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointer. +NotifyPointer. It generates a -FocusOut +FocusOut event on window A, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyInferior. +NotifyInferior. It generates a -FocusIn +FocusIn event on each window between window A and window B, exclusive, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyVirtual. +NotifyVirtual. It generates a -FocusIn +FocusIn event on window B, with the detail member of the -XFocusInEvent +XFocusInEvent structure set to -NotifyAncestor. +NotifyAncestor. @@ -2201,66 +2201,66 @@ the X server does the following: If window P is an inferior of window A, it generates a -FocusOut +FocusOut event on each window from window P up to but not including window A, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointer. +NotifyPointer. It generates a -FocusOut +FocusOut event on window A, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyNonlinear. +NotifyNonlinear. It generates a -FocusOut +FocusOut event on each window between window A and window C, exclusive, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates a -FocusIn +FocusIn event on each window between C and B, exclusive, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates a -FocusIn +FocusIn event on window B, with the detail member of the -XFocusInEvent +XFocusInEvent structure set to -NotifyNonlinear. +NotifyNonlinear. If window P is an inferior of window B, it generates a -FocusIn +FocusIn event on each window below window B down to and including window P, with the detail member of the -XFocusInEvent +XFocusInEvent structure set to -NotifyPointer. +NotifyPointer. @@ -2275,78 +2275,78 @@ the X server does the following: If window P is an inferior of window A, it generates a -FocusOut +FocusOut event on each window from window P up to but not including window A, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointer. +NotifyPointer. It generates a -FocusOut +FocusOut event on window A, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyNonlinear. +NotifyNonlinear. If window A is not a root window, it generates a -FocusOut +FocusOut event on each window above window A up to and including its root, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. If window B is not a root window, it generates a -FocusIn +FocusIn event on each window from window B's root down to but not including window B, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates a -FocusIn +FocusIn event on window B, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyNonlinear. +NotifyNonlinear. If window P is an inferior of window B, it generates a -FocusIn +FocusIn event on each window below window B down to and including window P, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyPointer. +NotifyPointer. When the focus moves from window A to -PointerRoot +PointerRoot (events sent to the window under the pointer) or -None +None (discard), and the pointer is in window P, the X server does the following: @@ -2355,69 +2355,69 @@ the X server does the following: If window P is an inferior of window A, it generates a -FocusOut +FocusOut event on each window from window P up to but not including window A, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointer. +NotifyPointer. It generates a -FocusOut +FocusOut event on window A, with the detail member of the -XFocusOutEvent +XFocusOutEvent structure set to -NotifyNonlinear. +NotifyNonlinear. If window A is not a root window, it generates a -FocusOut +FocusOut event on each window above window A up to and including its root, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates a -FocusIn +FocusIn event on the root window of all screens, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyPointerRoot +NotifyPointerRoot (or -NotifyDetailNone). +NotifyDetailNone). If the new focus is -PointerRoot, +PointerRoot, it generates a -FocusIn +FocusIn event on each window from window P's root down to and including window P, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyPointer. +NotifyPointer. When the focus moves from -PointerRoot +PointerRoot (events sent to the window under the pointer) or -None +None to window A, and the pointer is in window P, the X server does the following: @@ -2426,71 +2426,71 @@ the X server does the following: If the old focus is -PointerRoot, +PointerRoot, it generates a -FocusOut +FocusOut event on each window from window P up to and including window P's root, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointer. +NotifyPointer. It generates a -FocusOut +FocusOut event on all root windows, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointerRoot +NotifyPointerRoot (or -NotifyDetailNone). +NotifyDetailNone). If window A is not a root window, it generates a -FocusIn +FocusIn event on each window from window A's root down to but not including window A, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyNonlinearVirtual. +NotifyNonlinearVirtual. It generates a -FocusIn +FocusIn event on window A, with the detail member of the -XFocusInEvent +XFocusInEvent structure set to -NotifyNonlinear. +NotifyNonlinear. If window P is an inferior of window A, it generates a -FocusIn +FocusIn event on each window below window A down to and including window P, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyPointer. +NotifyPointer. When the focus moves from -PointerRoot +PointerRoot (events sent to the window under the pointer) to -None +None (or vice versa), and the pointer is in window P, the X server does the following: @@ -2499,53 +2499,53 @@ the X server does the following: If the old focus is -PointerRoot, +PointerRoot, it generates a -FocusOut +FocusOut event on each window from window P up to and including window P's root, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to -NotifyPointer. +NotifyPointer. It generates a -FocusOut +FocusOut event on all root windows, with the detail member of each -XFocusOutEvent +XFocusOutEvent structure set to either -NotifyPointerRoot +NotifyPointerRoot or -NotifyDetailNone. +NotifyDetailNone. It generates a -FocusIn +FocusIn event on all root windows, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyDetailNone +NotifyDetailNone or -NotifyPointerRoot. +NotifyPointerRoot. If the new focus is -PointerRoot, +PointerRoot, it generates a -FocusIn +FocusIn event on each window from window P's root down to and including window P, with the detail member of each -XFocusInEvent +XFocusInEvent structure set to -NotifyPointer. +NotifyPointer. @@ -2561,18 +2561,18 @@ structure set to Focus events in which the keyboard grab activates are identified by -XFocusInEvent +XFocusInEvent or -XFocusOutEvent +XFocusOutEvent structures whose mode member is set to -NotifyGrab. +NotifyGrab. Focus events in which the keyboard grab deactivates are identified by -XFocusInEvent +XFocusInEvent or -XFocusOutEvent +XFocusOutEvent structures whose mode member is set to -NotifyUngrab +NotifyUngrab (see XGrabKeyboard). @@ -2580,7 +2580,7 @@ structures whose mode member is set to When a keyboard grab activates before generating any actual -KeyPress +KeyPress event that activates the grab, G is the grab_window, and F is the current focus, the X server does the following: @@ -2590,15 +2590,15 @@ the X server does the following: It generates -FocusIn +FocusIn and -FocusOut +FocusOut events, with the mode members of the -XFocusInEvent +XFocusInEvent and -XFocusOutEvent +XFocusOutEvent structures set to -NotifyGrab. +NotifyGrab. These events are generated as if the focus were to change from F to G. @@ -2608,7 +2608,7 @@ F to G. When a keyboard grab deactivates after generating any actual -KeyRelease +KeyRelease event that deactivates the grab, G is the grab_window, and F is the current focus, the X server does the following: @@ -2618,15 +2618,15 @@ the X server does the following: It generates -FocusIn +FocusIn and -FocusOut +FocusOut events, with the mode members of the -XFocusInEvent +XFocusInEvent and -XFocusOutEvent +XFocusOutEvent structures set to -NotifyUngrab. +NotifyUngrab. These events are generated as if the focus were to change from G to F. @@ -2646,20 +2646,20 @@ G to F. EventsKeymapNotify KeymapNotify The X server can report -KeymapNotify +KeymapNotify events to clients that want information about changes in their keyboard state. To receive -KeymapNotify +KeymapNotify events, set the -KeymapStateMask +KeymapStateMask bit in the event-mask attribute of the window. The X server generates this event immediately after every -EnterNotify +EnterNotify and -FocusIn +FocusIn event. @@ -2714,7 +2714,7 @@ restoring the contents of an exposed window region. (An exposed window region describes a formerly obscured window whose region becomes visible.) Therefore, the X server sends -Expose +Expose 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. @@ -2729,43 +2729,43 @@ A more sophisticated client application redraws only the exposed region. EventsExpose Expose The X server can report -Expose +Expose events to clients wanting information about when the contents of window regions have been lost. The circumstances in which the X server generates -Expose +Expose events are not as definite as those for other events. However, the X server never generates -Expose +Expose events on windows whose class you specified as -InputOnly. +InputOnly. The X server can generate -Expose +Expose 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 window is not viewable but the server is (perhaps newly) honoring the window's backing-store attribute of -Always +Always or -WhenMapped. +WhenMapped. The regions decompose into an (arbitrary) set of rectangles, and an -Expose +Expose event is generated for each rectangle. For any given window, the X server guarantees to report contiguously all of the regions exposed by some action that causes -Expose +Expose events, such as raising a window. To receive -Expose +Expose events, set the -ExposureMask +ExposureMask bit in the event-mask attribute of the window. @@ -2799,17 +2799,17 @@ 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 -Expose +Expose events that are to follow. If count is zero, no more -Expose +Expose events follow for this window. However, if count is nonzero, at least that number of -Expose +Expose events (and possibly more) follow for this window. Simple applications that do not want to optimize redisplay by distinguishing between subareas of its window can just ignore all -Expose +Expose events with nonzero counts and perform full redisplays on events with zero counts. @@ -2825,7 +2825,7 @@ on events with zero counts. EventsNoExpose GraphicsExpose The X server can report -GraphicsExpose +GraphicsExpose events to clients wanting information about when a destination region could not be computed during certain graphics requests: XCopyArea @@ -2842,26 +2842,26 @@ drawable). NoExpose The X server generates a -NoExpose +NoExpose event whenever a graphics request that might produce a -GraphicsExpose +GraphicsExpose event does not produce any. In other words, the client is really asking for a -GraphicsExpose +GraphicsExpose event but instead receives a -NoExpose +NoExpose event. To receive -GraphicsExpose +GraphicsExpose or -NoExpose +NoExpose events, you must first set the graphics-exposure attribute of the graphics context to -True. +True. You also can set the graphics-expose attribute when creating a graphics context using XCreateGC @@ -2918,16 +2918,16 @@ 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_CopyArea +X_CopyArea or -X_CopyPlane. +X_CopyPlane. If it is -X_CopyArea, +X_CopyArea, a call to XCopyArea initiated the request. If it is -X_CopyPlane, +X_CopyPlane, a call to XCopyPlane initiated the request. @@ -2944,19 +2944,19 @@ although it may be used by an extension. The -XGraphicsExposeEvent +XGraphicsExposeEvent structure has these additional members: x, y, width, height, and count. The x and y members are set to the coordinates relative to the drawable's origin and indicate the upper-left corner of the rectangle. The width and height members are set to the size (extent) of the rectangle. The count member is set to the number of -GraphicsExpose +GraphicsExpose events to follow. If count is zero, no more -GraphicsExpose +GraphicsExpose events follow for this window. However, if count is nonzero, at least that number of -GraphicsExpose +GraphicsExpose events (and possibly more) are to follow for this window. @@ -2973,61 +2973,61 @@ The following sections discuss: -CirculateNotify +CirculateNotify events -ConfigureNotify +ConfigureNotify events -CreateNotify +CreateNotify events -DestroyNotify +DestroyNotify events -GravityNotify +GravityNotify events -MapNotify +MapNotify events -MappingNotify +MappingNotify events -ReparentNotify +ReparentNotify events -UnmapNotify +UnmapNotify events -VisibilityNotify +VisibilityNotify events @@ -3043,7 +3043,7 @@ events EventsCirculateNotify CirculateNotify The X server can report -CirculateNotify +CirculateNotify events to clients wanting information about when a window changes its position in the stack. The X server generates this event type whenever a window is actually restacked @@ -3056,12 +3056,12 @@ or To receive -CirculateNotify +CirculateNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of the parent window (in which case, circulating any child generates an event). @@ -3092,21 +3092,21 @@ typedef struct { The event member is set either to the restacked window or to its parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify 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 -PlaceOnTop +PlaceOnTop or -PlaceOnBottom. +PlaceOnBottom. If it is -PlaceOnTop, +PlaceOnTop, the window is now on top of all siblings. If it is -PlaceOnBottom, +PlaceOnBottom, the window is now below all siblings. @@ -3120,7 +3120,7 @@ the window is now below all siblings. EventsConfigureNotify ConfigureNotify The X server can report -ConfigureNotify +ConfigureNotify 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 @@ -3178,11 +3178,11 @@ A window's border width is changed by calling To receive -ConfigureNotify +ConfigureNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of the parent window (in which case, configuring any child generates an event). @@ -3215,9 +3215,9 @@ typedef struct { The event member is set either to the reconfigured window or to its parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify was selected. The window member is set to the window whose size, position, border, and/or stacking @@ -3237,7 +3237,7 @@ 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 -None, +None, the window whose state was changed is on the bottom of the stack with respect to sibling windows. However, if this member is set to a sibling window, @@ -3250,7 +3250,7 @@ window. Window manager clients normally should ignore this window if the override_redirect member is -True. +True. @@ -3263,7 +3263,7 @@ is EventsCreateNotify CreateNotify The X server can report -CreateNotify +CreateNotify events to clients wanting information about creation of windows. The X server generates this event whenever a client application creates a window by calling @@ -3274,9 +3274,9 @@ or To receive -CreateNotify +CreateNotify events, set the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of the window. Creating any children then generates an event. @@ -3320,7 +3320,7 @@ 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 -True. +True. @@ -3333,7 +3333,7 @@ if the override_redirect member is EventsDestroyNotify DestroyNotify The X server can report -DestroyNotify +DestroyNotify 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 @@ -3344,9 +3344,9 @@ or The ordering of the -DestroyNotify +DestroyNotify events is such that for any given window, -DestroyNotify +DestroyNotify is generated on all inferiors of the window before being generated on the window itself. The X protocol does not constrain the ordering among @@ -3355,11 +3355,11 @@ siblings and across subhierarchies. To receive -DestroyNotify +DestroyNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of the parent window (in which case, destroying any child generates an event). @@ -3389,9 +3389,9 @@ typedef struct { The event member is set either to the destroyed window or to its parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify was selected. The window member is set to the window that is destroyed. @@ -3406,7 +3406,7 @@ The window member is set to the window that is destroyed. EventsGravityNotify GravityNotify The X server can report -GravityNotify +GravityNotify 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 @@ -3419,11 +3419,11 @@ or To receive -GravityNotify +GravityNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask 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). @@ -3455,9 +3455,9 @@ typedef struct { The event member is set either to the window that was moved or to its parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify was selected. The window member is set to the child window that was moved. The x and y members are set to the coordinates relative to the @@ -3476,7 +3476,7 @@ window. EventsMapNotify MapNotify The X server can report -MapNotify +MapNotify 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 calling @@ -3489,11 +3489,11 @@ or as a result of save-set processing. To receive -MapNotify +MapNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of the parent window (in which case, mapping any child generates an event). @@ -3524,16 +3524,16 @@ typedef struct { The event member is set either to the window that was mapped or to its parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify 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 -True, +True, because these events usually are generated from pop-ups, which override structure control. @@ -3548,7 +3548,7 @@ which override structure control. EventsMappingNotify MappingNotify The X server reports -MappingNotify +MappingNotify 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 @@ -3603,22 +3603,22 @@ typedef struct { The request member is set to indicate the kind of mapping change that occurred and can be -MappingModifier, -MappingKeyboard, +MappingModifier, +MappingKeyboard, or -MappingPointer. +MappingPointer. If it is -MappingModifier, +MappingModifier, the modifier mapping was changed. If it is -MappingKeyboard, +MappingKeyboard, the keyboard mapping was changed. If it is -MappingPointer, +MappingPointer, the pointer button mapping was changed. The first_keycode and count members are set only if the request member was set to -MappingKeyboard. +MappingKeyboard. The number in first_keycode represents the first number in the range of the altered mapping, and count represents the number of keycodes altered. @@ -3640,7 +3640,7 @@ you should call EventsReparentNotify ReparentNotify The X server can report -ReparentNotify +ReparentNotify events to clients wanting information about changing a window's parent. The X server generates this event whenever a client application calls @@ -3650,11 +3650,11 @@ and the window is actually reparented. To receive -ReparentNotify +ReparentNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of either the old or the new parent window (in which case, reparenting any child generates an event). @@ -3687,9 +3687,9 @@ typedef struct { The event member is set either to the reparented window or to the old or the new parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify was selected. The window member is set to the window that was reparented. The parent member is set to the new parent window. @@ -3700,7 +3700,7 @@ The override_redirect 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 override_redirect member is -True. +True. @@ -3713,7 +3713,7 @@ if the override_redirect member is EventsUnmapNotify UnmapNotify The X server can report -UnmapNotify +UnmapNotify events to clients wanting information about which windows are unmapped. The X server generates this event type whenever a client application changes the window's state from mapped to unmapped. @@ -3721,11 +3721,11 @@ window's state from mapped to unmapped. To receive -UnmapNotify +UnmapNotify events, set the -StructureNotifyMask +StructureNotifyMask bit in the event-mask attribute of the window or the -SubstructureNotifyMask +SubstructureNotifyMask bit in the event-mask attribute of the parent window (in which case, unmapping any child window generates an event). @@ -3756,17 +3756,17 @@ typedef struct { The event member is set either to the unmapped window or to its parent, depending on whether -StructureNotify +StructureNotify or -SubstructureNotify +SubstructureNotify 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 -True +True 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 -UnmapGravity. +UnmapGravity. @@ -3779,50 +3779,50 @@ the window itself had a win_gravity of EventsVisibilityNotify VisibilityNotify The X server can report -VisibilityNotify +VisibilityNotify events to clients wanting any change in the visibility of the specified window. 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 -InputOnly. +InputOnly. All -VisibilityNotify +VisibilityNotify events caused by a hierarchy change are generated after any hierarchy event -(UnmapNotify, -MapNotify, -ConfigureNotify, -GravityNotify, -CirculateNotify) +(UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify) caused by that change. Any -VisibilityNotify +VisibilityNotify event on a given window is generated before any -Expose +Expose events on that window, but it is not required that all -VisibilityNotify +VisibilityNotify events on all windows be generated before all -Expose +Expose events on all windows. The X protocol does not constrain the ordering of -VisibilityNotify +VisibilityNotify events with respect to -FocusOut, -EnterNotify, +FocusOut, +EnterNotify, and -LeaveNotify +LeaveNotify events. To receive -VisibilityNotify +VisibilityNotify events, set the -VisibilityChangeMask +VisibilityChangeMask bit in the event-mask attribute of the window. @@ -3851,13 +3851,13 @@ typedef struct { 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 -VisibilityUnobscured, -VisibilityPartiallyObscured, +VisibilityUnobscured, +VisibilityPartiallyObscured, or -VisibilityFullyObscured. +VisibilityFullyObscured. The X server ignores all of a window's subwindows when determining the visibility state of the window and processes -VisibilityNotify +VisibilityNotify events according to the following: @@ -3866,9 +3866,9 @@ events according to the following: When the window changes state from partially obscured, fully obscured, or not viewable to viewable and completely unobscured, the X server generates the event with the state member of the -XVisibilityEvent +XVisibilityEvent structure set to -VisibilityUnobscured. +VisibilityUnobscured. @@ -3876,9 +3876,9 @@ structure set to When the window changes state from viewable and completely unobscured or not viewable to viewable and partially obscured, the X server generates the event with the state member of the -XVisibilityEvent +XVisibilityEvent structure set to -VisibilityPartiallyObscured. +VisibilityPartiallyObscured. @@ -3887,9 +3887,9 @@ When the window changes state from viewable and completely 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 -XVisibilityEvent +XVisibilityEvent structure set to -VisibilityFullyObscured. +VisibilityFullyObscured. @@ -3907,25 +3907,25 @@ This section discusses: -CirculateRequest +CirculateRequest events -ConfigureRequest +ConfigureRequest events -MapRequest +MapRequest events -ResizeRequest +ResizeRequest events @@ -3940,7 +3940,7 @@ events EventsCirculateRequest CirculateRequest The X server can report -CirculateRequest +CirculateRequest events to clients wanting information about when another client initiates a circulate window request on a specified window. @@ -3955,9 +3955,9 @@ or To receive -CirculateRequest +CirculateRequest events, set the -SubstructureRedirectMask +SubstructureRedirectMask in the event-mask attribute of the window. Then, in the future, the circulate window request for the specified window is not executed, @@ -3966,9 +3966,9 @@ For example, suppose a client application calls XCirculateSubwindowsUp to raise a subwindow to the top of the stack. If you had selected -SubstructureRedirectMask +SubstructureRedirectMask on the window, the X server reports to you a -CirculateRequest +CirculateRequest event and does not raise the subwindow to the top of the stack. @@ -4000,14 +4000,14 @@ 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 -PlaceOnTop +PlaceOnTop or -PlaceOnBottom. +PlaceOnBottom. If it is -PlaceOnTop, +PlaceOnTop, the subwindow should be on top of all siblings. If it is -PlaceOnBottom, +PlaceOnBottom, the subwindow should be below all siblings. @@ -4021,7 +4021,7 @@ the subwindow should be below all siblings. EventsConfigureRequest ConfigureRequest The X server can report -ConfigureRequest +ConfigureRequest events to clients wanting information about when a different client initiates a configure window request on any child of a specified window. The configure window request attempts to @@ -4042,24 +4042,24 @@ or To receive -ConfigureRequest +ConfigureRequest events, set the -SubstructureRedirectMask +SubstructureRedirectMask bit in the event-mask attribute of the window. -ConfigureRequest +ConfigureRequest events are generated when a -ConfigureWindow +ConfigureWindow protocol request is issued on a child window by another client. For example, suppose a client application calls XLowerWindow to lower a window. If you had selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent window and if the override-redirect attribute of the window is set to -False, +False, the X server reports a -ConfigureRequest +ConfigureRequest event to you and does not lower the specified window. @@ -4096,15 +4096,15 @@ 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 -ConfigureWindow +ConfigureWindow protocol request. The corresponding values are reported as given in the request. The remaining values are filled in from the current geometry of the window, except in the case of above (sibling) and detail (stack-mode), which are reported as -None +None and -Above, +Above, respectively, if they are not given in the request. @@ -4118,14 +4118,14 @@ respectively, if they are not given in the request. EventsMapRequest MapRequest The X server can report -MapRequest +MapRequest events to clients wanting information about a different client's desire to map windows. A window is considered mapped when a map window request completes. The X server generates this event whenever a different client initiates a map window request on an unmapped window whose override_redirect member is set to -False. +False. Clients initiate map window requests by calling XMapWindow, XMapRaised, @@ -4135,24 +4135,24 @@ or To receive -MapRequest +MapRequest events, set the -SubstructureRedirectMask +SubstructureRedirectMask 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 intercepted, and you are sent a -MapRequest +MapRequest instead. For example, suppose a client application calls XMapWindow to map a window. If you (usually a window manager) had selected -SubstructureRedirectMask +SubstructureRedirectMask on the parent window and if the override-redirect attribute of the window is set to -False, +False, the X server reports a -MapRequest +MapRequest event to you and does not map the specified window. Thus, this event gives your window manager client the ability @@ -4196,7 +4196,7 @@ The window member is set to the window to be mapped. EventsResizeRequest ResizeRequest The X server can report -ResizeRequest +ResizeRequest 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 @@ -4209,9 +4209,9 @@ or To receive -ResizeRequest +ResizeRequest events, set the -ResizeRedirect +ResizeRedirect bit in the event-mask attribute of the window. Any attempts to change the size by other clients are then redirected. @@ -4256,7 +4256,7 @@ excluding the border. EventsColormapNotify ColormapNotify The X server can report -ColormapNotify +ColormapNotify events to clients wanting information about when the colormap changes and when a colormap is installed or uninstalled. The X server generates this event type whenever a client application: @@ -4265,7 +4265,7 @@ The X server generates this event type whenever a client application: Changes the colormap member of the -XSetWindowAttributes +XSetWindowAttributes structure by calling XChangeWindowAttributes, @@ -4286,9 +4286,9 @@ or To receive -ColormapNotify +ColormapNotify events, set the -ColormapChangeMask +ColormapChangeMask bit in the event-mask attribute of the window. @@ -4324,24 +4324,24 @@ the colormap member is set to the colormap associated with the window. For a colormap that is changed by a call to XFreeColormap, the colormap member is set to -None. +None. The new member is set to indicate whether the colormap for the specified window was changed or installed or uninstalled and can be -True +True or -False. +False. If it is -True, +True, the colormap was changed. If it is -False, +False, the colormap was installed or uninstalled. The state member is always set to indicate whether the colormap is installed or uninstalled and can be -ColormapInstalled +ColormapInstalled or -ColormapUninstalled. +ColormapUninstalled. @@ -4356,31 +4356,31 @@ This section discusses: -ClientMessage +ClientMessage events -PropertyNotify +PropertyNotify events -SelectionClear +SelectionClear events -SelectionNotify +SelectionNotify events -SelectionRequest +SelectionRequest events @@ -4395,7 +4395,7 @@ events EventsClientMessage ClientMessage The X server generates -ClientMessage +ClientMessage events only when a client calls the function XSendEvent. @@ -4451,16 +4451,16 @@ message_type, or data members. EventsPropertyNotify PropertyNotify The X server can report -PropertyNotify +PropertyNotify events to clients wanting information about property changes for a specified window. To receive -PropertyNotify +PropertyNotify events, set the -PropertyChangeMask +PropertyChangeMask bit in the event-mask attribute of the window. @@ -4496,11 +4496,11 @@ 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 -PropertyNewValue +PropertyNewValue or -PropertyDelete. +PropertyDelete. The state member is set to -PropertyNewValue +PropertyNewValue when a property of the window is changed using XChangeProperty or @@ -4512,11 +4512,11 @@ and when replacing all or part of a property with identical data using or XRotateWindowProperties. The state member is set to -PropertyDelete +PropertyDelete when a property of the window is deleted using XDeleteProperty or, if the delete argument is -True, +True, XGetWindowProperty. @@ -4530,7 +4530,7 @@ or, if the delete argument is EventsSelectionClear SelectionClear The X server reports -SelectionClear +SelectionClear events to the client losing ownership of a selection. The X server generates this event type when another client asserts ownership of the selection by calling @@ -4580,7 +4580,7 @@ call. EventsSelectionRequest SelectionRequest The X server reports -SelectionRequest +SelectionRequest events to the owner of a selection. The X server generates this event whenever a client requests a selection conversion by calling @@ -4625,18 +4625,18 @@ For example, PRIMARY is used to indicate 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 -None. +None. The time member is set to the timestamp or -CurrentTime +CurrentTime value from the -ConvertSelection +ConvertSelection request. The owner should convert the selection based on the specified target type and send a -SelectionNotify +SelectionNotify event back to the requestor. A complete specification for using selections is given in the X Consortium standard Inter-Client Communication Conventions Manual. @@ -4652,7 +4652,7 @@ standard Inter-Client Communication Conventions ManualEventsSelectionNotify SelectionNotify This event is generated by the X server in response to a -ConvertSelection +ConvertSelection protocol request when there is no owner for the selection. When there is an owner, it should be generated by the owner of the selection by using @@ -4661,18 +4661,18 @@ 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 -None). +None). If -None +None is specified as the property in the -ConvertSelection +ConvertSelection protocol request, the owner should choose a property name, store the result as that property on the requestor window, and then send a -SelectionNotify +SelectionNotify giving that actual property name. @@ -4712,10 +4712,10 @@ The property member is set to the atom that indicates which property the result was stored on. If the conversion failed, the property member is set to -None. +None. The time member is set to the time the conversion took place and can be a timestamp or -CurrentTime. +CurrentTime. diff --git a/specs/libX11/CH11.xml b/specs/libX11/CH11.xml index b76ca0ba..8a2caaa6 100644 --- a/specs/libX11/CH11.xml +++ b/specs/libX11/CH11.xml @@ -33,7 +33,7 @@ event. 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 -XSetWindowAttributes +XSetWindowAttributes structure when you call XCreateWindow and @@ -118,32 +118,32 @@ to all interested clients. Only one client at a time can select -CirculateRequest, -ConfigureRequest, +CirculateRequest, +ConfigureRequest, or -MapRequest +MapRequest events, which are associated with the event mask -SubstructureRedirectMask. +SubstructureRedirectMask. Only one client at a time can select a -ResizeRequest +ResizeRequest event, which is associated with the event mask -ResizeRedirectMask. +ResizeRedirectMask. Only one client at a time can select a -ButtonPress +ButtonPress event, which is associated with the event mask -ButtonPressMask. +ButtonPressMask. @@ -155,7 +155,7 @@ The server reports the event to all interested clients. XSelectInput can generate a -BadWindow +BadWindow error. @@ -277,11 +277,11 @@ event queue. Finally, if you passed -False, +False, XSync does not discard the events in the queue. If you passed -True, +True, XSync discards all events in the queue, including those events that were on the queue before @@ -336,10 +336,10 @@ Specifies the connection to the X server. Specifies the mode. You can pass -QueuedAlready, -QueuedAfterFlush, +QueuedAlready, +QueuedAfterFlush, or -QueuedAfterReading. +QueuedAfterReading. @@ -349,12 +349,12 @@ or If mode is -QueuedAlready, +QueuedAlready, XEventsQueued returns the number of events already in the event queue (and never performs a system call). If mode is -QueuedAfterFlush, +QueuedAfterFlush, XEventsQueued returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, @@ -363,7 +363,7 @@ flushes the output buffer, attempts to read more events out of the application's connection, and returns the number read. If mode is -QueuedAfterReading, +QueuedAfterReading, XEventsQueued returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, @@ -378,12 +378,12 @@ always returns immediately without I/O if there are events already in the queue. XEventsQueued with mode -QueuedAfterFlush +QueuedAfterFlush is identical in behavior to XPending. XEventsQueued with mode -QueuedAlready +QueuedAlready is identical to the XQLength function. @@ -426,7 +426,7 @@ X server but have not been removed from the event queue. is identical to XEventsQueued with the mode -QueuedAfterFlush +QueuedAfterFlush specified. @@ -506,7 +506,7 @@ Returns the next event in the queue. The XNextEvent function copies the first event from the event queue into the specified -XEvent +XEvent structure and then removes it from the queue. If the event queue is empty, XNextEvent @@ -561,7 +561,7 @@ If the queue is empty, XPeekEvent flushes the output buffer and blocks until an event is received. It then copies the event into the client-supplied -XEvent +XEvent structure without removing it from the event queue. @@ -591,7 +591,7 @@ The predicate procedure and its associated arguments are: - Bool + Bool Display *display XEvent *event XPointer arg @@ -616,7 +616,7 @@ Specifies the connection to the X server. Specifies the -XEvent +XEvent structure. @@ -644,9 +644,9 @@ 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 -True. +True. If it did not find a match, it must return -False. +False. @@ -717,7 +717,7 @@ The XIfEvent function completes only when the specified predicate procedure returns -True +True for an event, which indicates an event in the queue matches. XIfEvent @@ -725,7 +725,7 @@ flushes the output buffer if it blocks waiting for additional events. XIfEvent removes the matching event from the queue and copies the structure into the client-supplied -XEvent +XEvent structure. @@ -795,14 +795,14 @@ Specifies the user-supplied argument that will be passed to the predicate proced When the predicate procedure finds a match, XCheckIfEvent copies the matched event into the client-supplied -XEvent +XEvent structure and returns -True. +True. (This event is removed from the queue.) If the predicate procedure finds no match, XCheckIfEvent returns -False, +False, and the output buffer will have been flushed. All earlier events stored in the queue are not discarded. @@ -875,12 +875,12 @@ The XPeekIfEvent function returns only when the specified predicate procedure returns -True +True for an event. After the predicate procedure finds a match, XPeekIfEvent copies the matched event into the client-supplied -XEvent +XEvent structure without removing the event from the queue. XPeekIfEvent flushes the output buffer if it blocks waiting for additional events. @@ -967,7 +967,7 @@ window and event mask. When it finds a match, XWindowEvent removes that event from the queue and copies it into the specified -XEvent +XEvent structure. The other events stored in the queue are not discarded. If a matching event is not in the queue, @@ -984,7 +984,7 @@ use This function is similar to XWindowEvent except that it never blocks and it returns a -Bool +Bool indicating if the event was returned. XCheckWindowEvent @@ -1053,14 +1053,14 @@ and event mask. If it finds a match, XCheckWindowEvent removes that event, copies it into the specified -XEvent +XEvent structure, and returns -True. +True. The other events stored in the queue are not discarded. If the event you requested is not available, XCheckWindowEvent returns -False, +False, and the output buffer will have been flushed. @@ -1122,7 +1122,7 @@ specified mask. When it finds a match, XMaskEvent removes that event and copies it into the specified -XEvent +XEvent structure. The other events stored in the queue are not discarded. If the event you requested is not in the queue, @@ -1137,7 +1137,7 @@ To return and remove the next event that matches an event mask (if any), use This function is similar to XMaskEvent except that it never blocks and it returns a -Bool +Bool indicating if the event was returned. XCheckMaskEvent @@ -1193,14 +1193,14 @@ server connection for the first event that matches the specified mask. If it finds a match, XCheckMaskEvent removes that event, copies it into the specified -XEvent +XEvent structure, and returns -True. +True. The other events stored in the queue are not discarded. If the event you requested is not available, XCheckMaskEvent returns -False, +False, and the output buffer will have been flushed. @@ -1263,14 +1263,14 @@ on the server connection for the first event that matches the specified type. If it finds a match, XCheckTypedEvent removes that event, copies it into the specified -XEvent +XEvent structure, and returns -True. +True. The other events in the queue are not discarded. If the event is not available, XCheckTypedEvent returns -False, +False, and the output buffer will have been flushed. @@ -1346,14 +1346,14 @@ type and window. If it finds a match, XCheckTypedWindowEvent removes the event from the queue, copies it into the specified -XEvent +XEvent structure, and returns -True. +True. The other events in the queue are not discarded. If the event is not available, XCheckTypedWindowEvent returns -False, +False, and the output buffer will have been flushed. @@ -1427,7 +1427,7 @@ This function is often used in selection processing. For example, the owner of a selection should use XSendEvent to send a -SelectionNotify +SelectionNotify event to a requestor when a selection has been converted and stored as a property. XSendEvent @@ -1461,9 +1461,9 @@ Specifies the connection to the X server. Specifies the window the event is to be sent to, or -PointerWindow, +PointerWindow, or -InputFocus. +InputFocus. @@ -1516,14 +1516,14 @@ This function uses the w argument to identify the destination window as follows: If w is -PointerWindow, +PointerWindow, the destination window is the window that contains the pointer. If w is -InputFocus +InputFocus and if the focus window contains the pointer, the destination window is the window that contains the pointer; otherwise, the destination window is the focus window. @@ -1548,7 +1548,7 @@ no event is sent. If propagate is -False, +False, the event is sent to every client selecting on destination any of the event types in the event_mask argument. @@ -1556,7 +1556,7 @@ types in the event_mask argument. If propagate is -True +True 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 @@ -1564,7 +1564,7 @@ type 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 -InputFocus +InputFocus 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 @@ -1575,15 +1575,15 @@ destination any of the types specified in event_mask. The event in the -XEvent +XEvent structure must be one of the core events or one of the events defined by an extension (or a -BadValue +BadValue 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 -True +True in the forwarded event and to set the serial number in the event correctly; therefore these fields and the display field are ignored by @@ -1599,9 +1599,9 @@ and returns nonzero otherwise. XSendEvent can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -1632,7 +1632,7 @@ use - unsigned long + unsigned long Display *display @@ -1655,7 +1655,7 @@ 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 -MotionNotify +MotionNotify events. The XGetMotionEvents @@ -1719,7 +1719,7 @@ Specifies the window. Specify the time interval in which the events are returned from the motion history buffer. You can pass a timestamp or -CurrentTime. +CurrentTime. @@ -1751,7 +1751,7 @@ no events are returned; XGetMotionEvents returns NULL. If the stop time is in the future, it is equivalent to specifying -CurrentTime. +CurrentTime. The return type for this function is a structure defined as follows: @@ -1781,7 +1781,7 @@ To free the data returned from this call, use XGetMotionEvents can generate a -BadWindow +BadWindow error. @@ -1811,7 +1811,7 @@ synchronization is enabled. _Xdebug On POSIX-conformant systems, there is also a global variable -_Xdebug +_Xdebug that, if set to nonzero before starting a program under a debugger, will force synchronous library behavior. @@ -1826,7 +1826,7 @@ sets which function is to be called. - int + int Display *display int (*procedure)() @@ -1871,7 +1871,7 @@ To enable or disable synchronization, use - int + int Display *display Bool onoff @@ -1909,11 +1909,11 @@ The function returns the previous after function. If onoff is -True, +True, XSynchronize turns on synchronous behavior. If onoff is -False, +False, XSynchronize turns off synchronous behavior. @@ -1971,16 +1971,16 @@ 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 -BadName +BadName errors from -OpenFont, -LookupColor, +OpenFont, +LookupColor, or -AllocNamedColor +AllocNamedColor protocol requests or on -BadFont +BadFont errors from a -QueryFont +QueryFont protocol request. These errors generally are reflected back to the program through the procedural interface. @@ -1995,7 +1995,7 @@ The previous error handler is returned. The -XErrorEvent +XErrorEvent structure contains: Debuggingerror event @@ -2057,7 +2057,7 @@ chapter: - BadAccess + BadAccess A client attempts to grab a key/button combination already grabbed by another client. @@ -2081,57 +2081,57 @@ chapter: has already selected. - BadAlloc + BadAlloc The server fails to allocate the requested resource. Note that the explicit listing of - BadAlloc + BadAlloc 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 - BadAlloc + BadAlloc error on any request for this reason, and clients should be prepared to receive such errors and handle or discard them. - BadAtom + BadAtom A value for an atom argument does not name a defined atom. - BadColor + BadColor A value for a colormap argument does not name a defined colormap. - BadCursor + BadCursor A value for a cursor argument does not name a defined cursor. - BadDrawable + BadDrawable A value for a drawable argument does not name a defined window or pixmap. - BadFont + BadFont A value for a font argument does not name a defined font (or, in some cases, - GContext). + GContext). - BadGC + BadGC A value for a - GContext + GContext argument does not name a defined - GContext. + GContext. - BadIDChoice + BadIDChoice The value chosen for a resource identifier 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. - BadImplementation + BadImplementation 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, @@ -2139,7 +2139,7 @@ chapter: and handle or discard them. - BadLength + BadLength The length of a request is shorter or longer than that required to contain the arguments. This is an internal Xlib or server error. @@ -2150,13 +2150,13 @@ chapter: The length of a request exceeds the maximum length accepted by the server. - BadMatch + BadMatch In a graphics request, the root and depth of the graphics context do not match those of the drawable. - An InputOnly window is used as a drawable. + An InputOnly window is used as a drawable. @@ -2166,24 +2166,24 @@ chapter: - An InputOnly + An InputOnly window lacks this attribute. - BadName + BadName A font or color of the specified name does not exist. - BadPixmap + BadPixmap A value for a pixmap argument does not name a defined pixmap. - BadRequest + BadRequest The major or minor opcode does not specify a valid request. This usually is an Xlib or server error. - BadValue + BadValue Some numeric value falls outside of the range of values accepted by the request. Unless a specific range is specified for an argument, @@ -2192,7 +2192,7 @@ chapter: this error (due to the encoding). - BadWindow + BadWindow A value for a window argument does not name a defined window. @@ -2212,15 +2212,15 @@ chapter: The -BadAtom, -BadColor, -BadCursor, -BadDrawable, -BadFont, -BadGC, -BadPixmap, +BadAtom, +BadColor, +BadCursor, +BadDrawable, +BadFont, +BadGC, +BadPixmap, and -BadWindow +BadWindow errors are also used when the argument type is extended by a set of fixed alternatives. @@ -2497,7 +2497,7 @@ To handle fatal I/O errors, use - int + int int(*handler)(Display *) diff --git a/specs/libX11/CH12.xml b/specs/libX11/CH12.xml index 14865ffc..3d15f63d 100644 --- a/specs/libX11/CH12.xml +++ b/specs/libX11/CH12.xml @@ -87,7 +87,7 @@ The X server includes a timestamp in various events. One special time, called CurrentTime Time -CurrentTime, +CurrentTime, represents the current server time. The X server maintains the time when the input focus was last changed, when the keyboard was last grabbed, @@ -111,7 +111,7 @@ 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 -CurrentTime, +CurrentTime, is never generated by the server. This value is reserved for use in requests to represent the current server time. @@ -120,32 +120,32 @@ 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: -ButtonPressMask, -ButtonReleaseMask, -EnterWindowMask, -LeaveWindowMask, -PointerMotionMask, -PointerMotionHintMask, -Button1MotionMask, -Button2MotionMask, -Button3MotionMask, -Button4MotionMask, -Button5MotionMask, -ButtonMotionMask, +ButtonPressMask, +ButtonReleaseMask, +EnterWindowMask, +LeaveWindowMask, +PointerMotionMask, +PointerMotionHintMask, +Button1MotionMask, +Button2MotionMask, +Button3MotionMask, +Button4MotionMask, +Button5MotionMask, +ButtonMotionMask, and -KeyMapStateMask. +KeymapStateMask. For other functions in this section, you pass keymask bits. The valid keymask bits are: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, +ShiftMask, +LockMask, +ControlMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, and -Mod5Mask. +Mod5Mask. @@ -222,9 +222,9 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. Specifies further processing of pointer events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -236,9 +236,9 @@ or Specifies further processing of keyboard events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -249,7 +249,7 @@ or Specifies the window to confine the pointer in or -None. +None. @@ -260,7 +260,7 @@ Specifies the window to confine the pointer in or Specifies the cursor that is to be displayed during the grab or -None. +None. @@ -272,7 +272,7 @@ Specifies the cursor that is to be displayed during the grab or Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -284,18 +284,18 @@ You can pass either a timestamp or The XGrabPointer function actively grabs control of the pointer and returns -GrabSuccess +GrabSuccess if the grab was successful. Further pointer events are reported only to the grabbing client. XGrabPointer overrides any active pointer grab by this client. If owner_events is -False, +False, all generated pointer events are reported with respect to grab_window and are reported only if selected by event_mask. If owner_events is -True +True and if a generated pointer event would normally be reported to this client, it is reported as usual. @@ -306,12 +306,12 @@ For either value of owner_events, unreported events are discarded. If the pointer_mode is -GrabModeAsync, +GrabModeAsync, pointer event processing 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 -GrabModeSync, +GrabModeSync, the state of the pointer, as seen by client applications, appears to freeze, and the X server generates no further pointer events @@ -324,10 +324,10 @@ they are simply queued in the server for later processing. If the keyboard_mode is -GrabModeAsync, +GrabModeAsync, keyboard event processing is unaffected by activation of the grab. If the keyboard_mode is -GrabModeSync, +GrabModeSync, the state of the keyboard, as seen by client applications, appears to freeze, and the X server generates no further keyboard events @@ -342,7 +342,7 @@ 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 -None +None is specified, the normal cursor for that window is displayed when the pointer is in grab_window or one of its subwindows; @@ -377,9 +377,9 @@ grabbed the pointer before its request was processed. XGrabPointer generates -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events. @@ -389,28 +389,28 @@ or if the confine_to window lies completely outside the boundaries of the root window, XGrabPointer fails and returns -GrabNotViewable. +GrabNotViewable. If the pointer is actively grabbed by some other client, it fails and returns -AlreadyGrabbed. +AlreadyGrabbed. If the pointer is frozen by an active grab of another client, it fails and returns -GrabFrozen. +GrabFrozen. If the specified time is earlier than the last-pointer-grab time or later than the current X server time, it fails and returns -GrabInvalidTime. +GrabInvalidTime. Otherwise, the last-pointer-grab time is set to the specified time -(CurrentTime +(CurrentTime is replaced by the current X server time). XGrabPointer can generate -BadCursor, -BadValue, +BadCursor, +BadValue, and -BadWindow +BadWindow errors. @@ -449,7 +449,7 @@ Specifies the connection to the X server. Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -470,12 +470,12 @@ 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 -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events. The X server performs an -UngrabPointer +UngrabPointer 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 @@ -529,7 +529,7 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. Specifies the cursor that is to be displayed or -None. +None. @@ -541,7 +541,7 @@ Specifies the cursor that is to be displayed or Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -564,9 +564,9 @@ The interpretation of event_mask and cursor is the same as described in XChangeActivePointerGrab can generate -BadCursor +BadCursor and -BadValue +BadValue errors. @@ -612,7 +612,7 @@ Specifies the connection to the X server. Specifies the pointer button that is to be (Bu or -AnyButton. +AnyButton. @@ -623,7 +623,7 @@ Specifies the pointer button that is to be (Bu or Specifies the set of keymasks or -AnyModifier. +AnyModifier. The mask is the bitwise inclusive OR of the valid keymask bits. @@ -669,9 +669,9 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. Specifies further processing of pointer events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -683,9 +683,9 @@ or Specifies further processing of keyboard events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -696,7 +696,7 @@ or Specifies the window to confine the pointer in or -None. +None. @@ -707,7 +707,7 @@ Specifies the window to confine the pointer in or Specifies the cursor that is to be displayed or -None. +None. @@ -724,9 +724,9 @@ the pointer is actively grabbed (as for XGrabPointer), the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the -ButtonPress +ButtonPress event), and the -ButtonPress +ButtonPress event is reported if all of the following conditions are true: @@ -772,13 +772,13 @@ 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 -AnyModifier +AnyModifier is equivalent to issuing the grab request for all possible modifier combinations (including the combination of no modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. A button of -AnyButton +AnyButton is equivalent to issuing the request for all possible buttons. Otherwise, it is not required that the specified button currently be assigned @@ -789,15 +789,15 @@ to a physical button. If some other client has already issued an XGrabButton with the same button/key combination on the same window, a -BadAccess +BadAccess error results. When using -AnyModifier +AnyModifier or -AnyButton, +AnyButton, the request fails completely, and a -BadAccess +BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. XGrabButton @@ -807,10 +807,10 @@ has no effect on an active grab. XGrabButton can generate -BadCursor, -BadValue, +BadCursor, +BadValue, and -BadWindow +BadWindow errors. @@ -851,7 +851,7 @@ Specifies the connection to the X server. Specifies the pointer button that is to be (Bu or -AnyButton. +AnyButton. @@ -862,7 +862,7 @@ Specifies the pointer button that is to be (Bu or Specifies the set of keymasks or -AnyModifier. +AnyModifier. The mask is the bitwise inclusive OR of the valid keymask bits. @@ -887,13 +887,13 @@ The function releases the passive button/key combination on the specified window if it was grabbed by this client. A modifiers of -AnyModifier +AnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A button of -AnyButton +AnyButton is equivalent to issuing the request for all possible buttons. XUngrabButton @@ -903,9 +903,9 @@ has no effect on an active grab. XUngrabButton can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -924,15 +924,15 @@ as well as allow events. For many functions in this section, you pass keymask bits. The valid keymask bits are: -ShiftMask, -LockMask, -ControlMask, -Mod1Mask, -Mod2Mask, -Mod3Mask, -Mod4Mask, +ShiftMask, +LockMask, +ControlMask, +Mod1Mask, +Mod2Mask, +Mod3Mask, +Mod4Mask, and -Mod5Mask. +Mod5Mask. @@ -994,9 +994,9 @@ are to be reported as usual. Specifies further processing of pointer events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -1008,9 +1008,9 @@ or Specifies further processing of keyboard events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -1022,7 +1022,7 @@ or Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -1034,41 +1034,41 @@ You can pass either a timestamp or The XGrabKeyboard function actively grabs control of the keyboard and generates -FocusIn +FocusIn and -FocusOut +FocusOut events. Further key events are reported only to the grabbing client. XGrabKeyboard overrides any active keyboard grab by this client. If owner_events is -False, +False, all generated key events are reported with respect to grab_window. If owner_events is -True +True and if a generated key event would normally be reported to this client, it is reported normally; otherwise, the event is reported with respect to the grab_window. Both -KeyPress +KeyPress and -KeyRelease +KeyRelease events are always reported, independent of any event selection made by the client. If the keyboard_mode argument is -GrabModeAsync, +GrabModeAsync, 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 -GrabModeSync, +GrabModeSync, the state of the keyboard (as seen by client applications) appears to freeze, and the X server generates no further keyboard events until the grabbing client issues a releasing @@ -1080,11 +1080,11 @@ they are simply queued in the server for later processing. If pointer_mode is -GrabModeAsync, +GrabModeAsync, pointer event processing is unaffected by activation of the grab. If pointer_mode is -GrabModeSync, +GrabModeSync, the state of the pointer (as seen by client applications) appears to freeze, and the X server generates no further pointer events until the grabbing client issues a releasing @@ -1098,28 +1098,28 @@ they are simply queued in the server for later processing. If the keyboard is actively grabbed by some other client, XGrabKeyboard fails and returns -AlreadyGrabbed. +AlreadyGrabbed. If grab_window is not viewable, it fails and returns -GrabNotViewable. +GrabNotViewable. If the keyboard is frozen by an active grab of another client, it fails and returns -GrabFrozen. +GrabFrozen. If the specified time is earlier than the last-keyboard-grab time or later than the current X server time, it fails and returns -GrabInvalidTime. +GrabInvalidTime. Otherwise, the last-keyboard-grab time is set to the specified time -(CurrentTime +(CurrentTime is replaced by the current X server time). XGrabKeyboard can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -1158,7 +1158,7 @@ Specifies the connection to the X server. Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -1180,12 +1180,12 @@ 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 -FocusIn +FocusIn and -FocusOut +FocusOut events. The X server automatically performs an -UngrabKeyboard +UngrabKeyboard request if the event window for an active keyboard grab becomes not viewable. @@ -1228,7 +1228,7 @@ Specifies the connection to the X server. Specifies the KeyCode or -AnyKey. +AnyKey. @@ -1239,7 +1239,7 @@ Specifies the KeyCode or Specifies the set of keymasks or -AnyModifier. +AnyModifier. The mask is the bitwise inclusive OR of the valid keymask bits. @@ -1273,9 +1273,9 @@ are to be reported as usual. Specifies further processing of pointer events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -1287,9 +1287,9 @@ or Specifies further processing of keyboard events. You can pass -GrabModeSync +GrabModeSync or -GrabModeAsync. +GrabModeAsync. @@ -1306,9 +1306,9 @@ the keyboard is actively grabbed (as for XGrabKeyboard), the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the -KeyPress +KeyPress event), and the -KeyPress +KeyPress event is reported if all of the following conditions are true: @@ -1349,21 +1349,21 @@ may lag the physical state if device event processing is frozen. A modifiers argument of -AnyModifier +AnyModifier is equivalent to issuing the 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 keycode argument of -AnyKey +AnyKey is equivalent to issuing the request for all possible KeyCodes. Otherwise, the specified keycode must be in the range specified by min_keycode and max_keycode in the connection setup, or a -BadValue +BadValue error results. @@ -1371,15 +1371,15 @@ error results. If some other client has issued a XGrabKey with the same key combination on the same window, a -BadAccess +BadAccess error results. When using -AnyModifier +AnyModifier or -AnyKey, +AnyKey, the request fails completely, and a -BadAccess +BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. @@ -1387,10 +1387,10 @@ if there is a conflicting grab for any combination. XGrabKey can generate -BadAccess, -BadValue, +BadAccess, +BadValue, and -BadWindow +BadWindow errors. @@ -1430,7 +1430,7 @@ Specifies the connection to the X server. Specifies the KeyCode or -AnyKey. +AnyKey. @@ -1441,7 +1441,7 @@ Specifies the KeyCode or Specifies the set of keymasks or -AnyModifier. +AnyModifier. The mask is the bitwise inclusive OR of the valid keymask bits. @@ -1467,21 +1467,21 @@ function releases the key combination on the specified window if it was grabbed by this client. It has no effect on an active grab. A modifiers of -AnyModifier +AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination of no modifiers). A keycode argument of -AnyKey +AnyKey is equivalent to issuing the request for all possible key codes. XUngrabKey can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -1531,15 +1531,15 @@ Specifies the connection to the X server. Specifies the event mode. You can pass -AsyncPointer, -SyncPointer, -AsyncKeyboard, -SyncKeyboard, -ReplayPointer, -ReplayKeyboard, -AsyncBoth, +AsyncPointer, +SyncPointer, +AsyncKeyboard, +SyncKeyboard, +ReplayPointer, +ReplayKeyboard, +AsyncBoth, or -SyncBoth. +SyncBoth. @@ -1551,7 +1551,7 @@ or Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -1575,41 +1575,41 @@ Depending on the event_mode argument, the following occurs: - AsyncPointer + AsyncPointer 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, - AsyncPointer + AsyncPointer thaws for both. - AsyncPointer + AsyncPointer has no effect if the pointer is not frozen by the client, but the pointer need not be grabbed by the client. - SyncPointer + SyncPointer If the pointer is frozen and actively grabbed by the client, pointer event processing continues as usual until the next - ButtonPress + ButtonPress or - ButtonRelease + ButtonRelease 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. - SyncPointer + SyncPointer has no effect if the pointer is not frozen by the client or if the pointer is not grabbed by the client. - ReplayPointer + ReplayPointer If the pointer is actively grabbed by the client and is frozen as the result of an event having been sent to the client (either from the activation of an XGrabButton or from a previous XAllowEvents with mode - SyncPointer + SyncPointer but not from an XGrabPointer), the pointer grab is released and that event is completely reprocessed. @@ -1619,34 +1619,34 @@ Depending on the event_mode argument, the following occurs: or if the pointer is not frozen as the result of an event. - AsyncKeyboard + AsyncKeyboard If the keyboard is frozen by the client, keyboard event processing continues as usual. If the keyboard is frozen twice by the client on behalf of two separate grabs, - AsyncKeyboard + AsyncKeyboard thaws for both. - AsyncKeyboard + AsyncKeyboard has no effect if the keyboard is not frozen by the client, but the keyboard need not be grabbed by the client. - SyncKeyboard + SyncKeyboard If the keyboard is frozen and actively grabbed by the client, keyboard event processing continues as usual until the next - KeyPress + KeyPress or - KeyRelease + KeyRelease 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. - SyncKeyboard + SyncKeyboard has no effect if the keyboard is not frozen by the client or if the keyboard is not grabbed by the client. - ReplayKeyboard + ReplayKeyboard If the keyboard is actively grabbed by the client and is frozen as the result of an event having been sent to the client (either from the activation of an @@ -1654,7 +1654,7 @@ Depending on the event_mode argument, the following occurs: or from a previous XAllowEvents with mode - SyncKeyboard + SyncKeyboard but not from an XGrabKeyboard), the keyboard grab is released and that event is completely reprocessed. @@ -1665,14 +1665,14 @@ Depending on the event_mode argument, the following occurs: or if the keyboard is not frozen as the result of an event. - SyncBoth + SyncBoth If both pointer and keyboard are frozen by the client, event processing for both devices continues as usual until the next - ButtonPress, - ButtonRelease, - KeyPress, + ButtonPress, + ButtonRelease, + KeyPress, or - KeyRelease + KeyRelease 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. @@ -1680,24 +1680,24 @@ Depending on the event_mode argument, the following occurs: 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). - SyncBoth + SyncBoth 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, - SyncBoth + SyncBoth thaws for both (but a subsequent freeze for - SyncBoth + SyncBoth will only freeze each device once). - AsyncBoth + AsyncBoth 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, - AsyncBoth + AsyncBoth thaws for both. - AsyncBoth + AsyncBoth has no effect unless both pointer and keyboard are frozen by the client. @@ -1707,16 +1707,16 @@ Depending on the event_mode argument, the following occurs: -AsyncPointer, -SyncPointer, +AsyncPointer, +SyncPointer, and -ReplayPointer +ReplayPointer have no effect on the processing of keyboard events. -AsyncKeyboard, -SyncKeyboard, +AsyncKeyboard, +SyncKeyboard, and -ReplayKeyboard +ReplayKeyboard have no effect on the processing of pointer events. It is possible for both a pointer grab and a keyboard grab (by the same @@ -1729,14 +1729,14 @@ 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 -AllowEvents +XAllowEvents releases both. XAllowEvents can generate a -BadValue +BadValue error. @@ -1787,7 +1787,7 @@ Specifies the connection to the X server. Specifies the source window or -None. +None. @@ -1798,7 +1798,7 @@ Specifies the source window or Specifies the destination window or -None. +None. @@ -1872,7 +1872,7 @@ Specify the x and y coordinates within the destination window. If dest_w is -None, +None, XWarpPointer moves the pointer by the offsets (dest_x, dest_y) relative to the current position of the pointer. @@ -1908,7 +1908,7 @@ confine_to window. XWarpPointer can generate a -BadWindow +BadWindow error. @@ -1960,9 +1960,9 @@ Specifies the connection to the X server. Specifies the window, -PointerRoot, +PointerRoot, or -None. +None. @@ -1975,10 +1975,10 @@ or Specifies where the input focus reverts to if the window becomes not viewable. You can pass -RevertToParent, -RevertToPointerRoot, +RevertToParent, +RevertToPointerRoot, or -RevertToNone. +RevertToNone. @@ -1990,7 +1990,7 @@ or Specifies the time. You can pass either a timestamp or -CurrentTime. +CurrentTime. @@ -2005,13 +2005,13 @@ 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 -(CurrentTime +(CurrentTime is replaced by the current X server time). XSetInputFocus causes the X server to generate -FocusIn +FocusIn and -FocusOut +FocusOut events. @@ -2023,7 +2023,7 @@ the following occurs: If focus is -None, +None, all keyboard events are discarded until a new focus window is set, and the revert_to argument is ignored. @@ -2040,7 +2040,7 @@ Otherwise, the event is reported relative to the focus window. If focus is -PointerRoot, +PointerRoot, the focus window is dynamically 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. @@ -2053,7 +2053,7 @@ The specified focus window must be viewable at the time XSetInputFocus is called, or a -BadMatch +BadMatch error results. If the focus window later becomes not viewable, the X server @@ -2063,28 +2063,28 @@ evaluates the revert_to argument to determine the new focus window as follows: If revert_to is -RevertToParent, +RevertToParent, the focus reverts to the parent (or the closest viewable ancestor), and the new revert_to value is taken to be -RevertToNone. +RevertToNone. If revert_to is -RevertToPointerRoot +RevertToPointerRoot or -RevertToNone, +RevertToNone, the focus reverts to -PointerRoot +PointerRoot or -None, +None, respectively. When the focus reverts, the X server generates -FocusIn +FocusIn and -FocusOut +FocusOut events, but the last-focus-change time is not affected. @@ -2093,10 +2093,10 @@ events, but the last-focus-change time is not affected. XSetInputFocus can generate -BadMatch, -BadValue, +BadMatch, +BadValue, and -BadWindow +BadWindow errors. @@ -2133,9 +2133,9 @@ Specifies the connection to the X server. Returns the focus window, -PointerRoot, +PointerRoot, or -None. +None. @@ -2146,10 +2146,10 @@ or Returns the current focus state -(RevertToParent, -RevertToPointerRoot, +(RevertToParent, +RevertToPointerRoot, or -RevertToNone). +RevertToNone). @@ -2194,7 +2194,7 @@ parameters. The XChangeKeyboardControl function changes control of a keyboard and operates on a -XKeyboardControl +XKeyboardControl structure: @@ -2235,7 +2235,7 @@ 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 -BadValue +BadValue error. @@ -2244,18 +2244,18 @@ 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 -BadValue +BadValue error. The bell_pitch member sets the pitch (specified in Hz) of the bell, if possible. A setting of -1 restores the default. Other negative values generate a -BadValue +BadValue 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 -BadValue +BadValue error. @@ -2263,31 +2263,31 @@ 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 -LedModeOn +LedModeOn or -LedModeOff. +LedModeOff. If only led_mode is specified, the state of all LEDs are changed, if possible. At most 32 LEDs numbered from one are supported. No standard interpretation of LEDs is defined. If led is specified without led_mode, a -BadMatch +BadMatch error results. If both the auto_repeat_mode and key members are specified, the auto_repeat_mode of that key is changed (according to -AutoRepeatModeOn, -AutoRepeatModeOff, +AutoRepeatModeOn, +AutoRepeatModeOff, or -AutoRepeatModeDefault), +AutoRepeatModeDefault), 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 settings. If a key is specified without an auto_repeat_mode, a -BadMatch +BadMatch error results. Each key has an individual mode of whether or not it should auto-repeat and a default setting for the mode. @@ -2295,15 +2295,15 @@ 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 -AutoRepeatModeOn, +AutoRepeatModeOn, keys should obey their individual auto-repeat modes. When global mode is -AutoRepeatModeOff, +AutoRepeatModeOff, no keys should auto-repeat. An auto-repeating key generates alternating -KeyPress +KeyPress and -KeyRelease +KeyRelease events. When a key is used as a modifier, it is desirable for the key not to auto-repeat, @@ -2370,7 +2370,7 @@ Specifies one value for each bit set to 1 in the mask. The XChangeKeyboardControl function controls the keyboard characteristics defined by the -XKeyboardControl +XKeyboardControl structure. The value_mask argument specifies which values are to be changed. @@ -2378,9 +2378,9 @@ The value_mask argument specifies which values are to be changed. XChangeKeyboardControl can generate -BadMatch +BadMatch and -BadValue +BadValue errors. @@ -2416,7 +2416,7 @@ Specifies the connection to the X server. Returns the current keyboard controls in the specified -XKeyboardState +XKeyboardState structure. @@ -2429,7 +2429,7 @@ structure. The XGetKeyboardControl function returns the current control values for the keyboard to the -XKeyboardState +XKeyboardState structure. @@ -2457,9 +2457,9 @@ For the LEDs, the least significant bit of led_mask corresponds to LED one, and each bit set to 1 in led_mask indicates an LED that is lit. The global_auto_repeat member can be set to -AutoRepeatModeOn +AutoRepeatModeOn or -AutoRepeatModeOff. +AutoRepeatModeOff. The auto_repeats member is a bit vector. Each bit set to 1 indicates that auto-repeat is enabled for the corresponding key. @@ -2583,7 +2583,7 @@ 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 -BadValue +BadValue error results. The volume at which the bell rings when the percent argument is nonnegative is: @@ -2616,7 +2616,7 @@ To change the base volume of the bell, use XBell can generate a -BadValue +BadValue error. @@ -2731,36 +2731,36 @@ The XSetPointerMapping function sets the mapping of the pointer. If it succeeds, the X server generates a -MappingNotify +MappingNotify event, and XSetPointerMapping returns -MappingSuccess. +MappingSuccess. Element map[i] defines the logical button number for the physical button i+1. The length of the list must be the same as XGetPointerMapping would return, or a -BadValue +BadValue 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 -BadValue +BadValue error results. If any of the buttons to be altered are logically in the down state, XSetPointerMapping returns -MappingBusy, +MappingBusy, and the mapping is not changed. XSetPointerMapping can generate a -BadValue +BadValue error. @@ -2924,11 +2924,11 @@ 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 -True +True for the pointer values to be set, or the parameters are unchanged. Negative values (other than -1) generate a -BadValue +BadValue error, as does a zero value for the accel_denominator argument. @@ -2936,7 +2936,7 @@ for the accel_denominator argument. XChangePointerControl can generate a -BadValue +BadValue error. @@ -3050,22 +3050,22 @@ 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 corresponding key. If the list (ignoring trailing -NoSymbol +NoSymbol entries) 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 -NoSymbol +NoSymbol entries) is a pair of KeySyms ``K1 K2'', then the list is treated as if it were the list ``K1 K2 K1 K2''. If the list (ignoring trailing -NoSymbol +NoSymbol entries) is a triple of KeySyms ``K1 K2 K3'', then the list is treated as if it were the list ``K1 K2 K3 NoSymbol''. When an explicit ``void'' element is desired in the list, the value -VoidSymbol +VoidSymbol can be used. @@ -3075,7 +3075,7 @@ 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 -NoSymbol, +NoSymbol, 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'' @@ -3088,16 +3088,16 @@ the uppercase form of ``K''. The standard rules for obtaining a KeySym from a -KeyPress +KeyPress 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 attaching that KeyCode to any one of the modifiers -Mod1 +Mod1 through -Mod5. +Mod5. This modifier is called the group modifier. For any KeyCode, Group 1 is used when the group modifier is off, @@ -3106,17 +3106,17 @@ and Group 2 is used when the group modifier is on. The -Lock +Lock modifier is interpreted as CapsLock when the KeySym named XK_Caps_Lock is attached to some KeyCode and that KeyCode is attached to the -Lock +Lock modifier. The -Lock +Lock modifier is interpreted as ShiftLock when the KeySym named XK_Shift_Lock is attached to some KeyCode and that KeyCode is attached to the -Lock +Lock modifier. If the -Lock +Lock modifier could be interpreted as both CapsLock and ShiftLock, the CapsLock interpretation is used. @@ -3125,9 +3125,9 @@ CapsLock and ShiftLock, the CapsLock interpretation 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 -Mod1 +Mod1 through -Mod5. +Mod5. This modifier is called the numlock modifier. The standard KeySyms with the prefix ``XK_KP_'' in their @@ -3146,9 +3146,9 @@ 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 -Shift +Shift modifier is on, or if the -Lock +Lock modifier is on and is interpreted as ShiftLock, then the first KeySym is used, otherwise the second KeySym is used. @@ -3157,9 +3157,9 @@ second KeySym is used. The -Shift +Shift and -Lock +Lock modifiers are both off. In this case, the first KeySym is used. @@ -3167,9 +3167,9 @@ KeySym is used. The -Shift +Shift modifier is off, and the -Lock +Lock 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 @@ -3179,9 +3179,9 @@ KeySym is used instead. The -Shift +Shift modifier is on, and the -Lock +Lock modifier is on and is interpreted as CapsLock. In this case, the second KeySym is used, but if that KeySym is lowercase alphabetic, then the corresponding uppercase KeySym is used @@ -3191,9 +3191,9 @@ instead. The -Shift +Shift modifier is on, or the -Lock +Lock modifier is on and is interpreted as ShiftLock, or both. In this case, the second KeySym is used. @@ -3339,11 +3339,11 @@ The value specified in first_keycode must be greater than or equal to min_keycode as returned by XDisplayKeycodes, or a -BadValue +BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by -XDisplayKeycodes : +XDisplayKeycodes: @@ -3354,7 +3354,7 @@ first_keycode + keycode_count - 1 If this is not the case, a -BadValue +BadValue error results. The number of elements in the KeySyms list is: @@ -3377,7 +3377,7 @@ in the list, counting from zero: The X server arbitrarily chooses the keysyms_per_keycode_return value to be large enough to report all requested symbols. A special KeySym value of -NoSymbol +NoSymbol is used to fill in unused elements for individual KeyCodes. To free the storage returned by @@ -3389,7 +3389,7 @@ use XGetKeyboardMapping can generate a -BadValue +BadValue error. @@ -3486,13 +3486,13 @@ The specified first_keycode must be greater than or equal to min_keycode returned by XDisplayKeycodes, or a -BadValue +BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by XDisplayKeycodes, or a -BadValue +BadValue error results: @@ -3517,16 +3517,16 @@ in keysyms, counting from zero: The specified keysyms_per_keycode can be chosen arbitrarily by the client to be large enough to hold all desired symbols. A special KeySym value of -NoSymbol +NoSymbol should be used to fill in unused elements for individual KeyCodes. It is legal for -NoSymbol +NoSymbol to appear in nontrailing positions of the effective list for a KeyCode. XChangeKeyboardMapping generates a -MappingNotify +MappingNotify event. @@ -3538,15 +3538,15 @@ It is merely stored for reading and writing by clients. XChangeKeyboardMapping can generate -BadAlloc +BadAlloc and -BadValue +BadValue errors. The next six functions make use of the -XModifierKeymap +XModifierKeymap data structure, which contains: @@ -3566,7 +3566,7 @@ typedef struct { To create an -XModifierKeymap +XModifierKeymap structure, use XNewModifiermap. XNewModifiermap @@ -3598,14 +3598,14 @@ in the map. The XNewModifiermap function returns a pointer to -XModifierKeymap +XModifierKeymap structure for later use. To add a new entry to an -XModifierKeymap +XModifierKeymap structure, use XInsertModifiermapEntry. XInsertModifiermapEntry @@ -3627,7 +3627,7 @@ structure, use Specifies the -XModifierKeymap +XModifierKeymap structure. @@ -3661,14 +3661,14 @@ The XInsertModifiermapEntry function adds the specified KeyCode to the set that controls the specified modifier and returns the resulting -XModifierKeymap +XModifierKeymap structure (expanded as needed). To delete an entry from an -XModifierKeymap +XModifierKeymap structure, use XDeleteModifiermapEntry. XDeleteModifiermapEntry @@ -3690,7 +3690,7 @@ structure, use Specifies the -XModifierKeymap +XModifierKeymap structure. @@ -3724,14 +3724,14 @@ The XDeleteModifiermapEntry function deletes the specified KeyCode from the set that controls the specified modifier and returns a pointer to the resulting -XModifierKeymap +XModifierKeymap structure. To destroy an -XModifierKeymap +XModifierKeymap structure, use XFreeModifiermap. XFreeModifiermap @@ -3751,7 +3751,7 @@ structure, use Specifies the -XModifierKeymap +XModifierKeymap structure. @@ -3764,7 +3764,7 @@ structure. The XFreeModifiermap function frees the specified -XModifierKeymap +XModifierKeymap structure. @@ -3800,7 +3800,7 @@ Specifies the connection to the X server. Specifies the -XModifierKeymap +XModifierKeymap structure. @@ -3816,41 +3816,41 @@ function specifies the KeyCodes of the keys (if any) that are to be used as modifiers. If it succeeds, the X server generates a -MappingNotify +MappingNotify event, and XSetModifierMapping returns -MappingSuccess. +MappingSuccess. X permits at most 8 modifier keys. If more than 8 are specified in the -XModifierKeymap +XModifierKeymap structure, a -BadLength +BadLength error results. The modifiermap member of the -XModifierKeymap +XModifierKeymap structure contains 8 sets of max_keypermod KeyCodes, one for each modifier in the order -Shift, -Lock, -Control, -Mod1, -Mod2, -Mod3, -Mod4, +Shift, +Lock, +Control, +Mod1, +Mod2, +Mod3, +Mod4, and -Mod5. +Mod5. Only nonzero KeyCodes have meaning in each set, and zero KeyCodes are ignored. In addition, all of the nonzero KeyCodes must be in the range specified by min_keycode and max_keycode in the -Display +Display structure, or a -BadValue +BadValue error results. @@ -3862,23 +3862,23 @@ if auto-repeat cannot be disabled on certain keys, or if multiple modifier keys are not supported. If some such restriction is violated, the status reply is -MappingFailed, +MappingFailed, and none of the modifiers are changed. If the new KeyCodes specified for a modifier differ from those currently defined and any (current or new) keys for that modifier are in the logically down state, XSetModifierMapping returns -MappingBusy, +MappingBusy, and none of the modifiers is changed. XSetModifierMapping can generate -BadAlloc +BadAlloc and -BadValue +BadValue errors. @@ -3914,7 +3914,7 @@ Specifies the connection to the X server. The XGetModifierMapping function returns a pointer to a newly created -XModifierKeymap +XModifierKeymap structure that contains the keys being used as modifiers. The structure should be freed after use by calling XFreeModifiermap. diff --git a/specs/libX11/CH13.xml b/specs/libX11/CH13.xml index cd75496e..26a5d349 100644 --- a/specs/libX11/CH13.xml +++ b/specs/libX11/CH13.xml @@ -105,14 +105,14 @@ To determine if the current locale is supported by X, use The XSupportsLocale function returns -True +True if Xlib functions are capable of operating under the current locale. If it returns -False, +False, Xlib locale-dependent functions for which the -XLocaleNotSupported +XLocaleNotSupported return status is defined will return -XLocaleNotSupported. +XLocaleNotSupported. Other Xlib locale-dependent routines will operate in the ``C'' locale. @@ -321,16 +321,16 @@ the following table describes the locale (and modifiers) dependency: setlocale XrmGetFileDatabase - Locale of XrmDatabase + Locale of XrmDatabase XrmGetStringDatabase - XrmDatabase + XrmDatabase XrmPutFileDatabase - Locale of XrmDatabase + Locale of XrmDatabase @@ -390,7 +390,7 @@ the following table describes the locale (and modifiers) dependency: XIM selection - XIM + XIM XCreateIC XIC input method configuration @@ -400,7 +400,7 @@ the following table describes the locale (and modifiers) dependency: Queried locale - XIC + XIC XmbLookupString Keyboard layout @@ -427,7 +427,7 @@ the following table describes the locale (and modifiers) dependency: Charsets of fonts in XFontSet - XOM + XOM XCreateOC XOC output method configuration @@ -437,7 +437,7 @@ the following table describes the locale (and modifiers) dependency: Queried locale - XFontSet + XFontSet XmbDrawText, Locale of supplied text @@ -520,17 +520,17 @@ to the ANSI C variable argument list calling convention. 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 -XPointer. +XPointer. 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 -XNVaNestedList +XNVaNestedList is specified in place of an argument name, then the following value is interpreted as an -XVaNestedList +XVaNestedList value that specifies a list of values logically inserted into the original list at the point of declaration. A NULL identifies the end of a nested list. @@ -706,14 +706,14 @@ the output method for clients. The abstraction used to communicate with an output method is an opaque data structure represented by the -XOM +XOM data type. The abstraction for representing the state of a particular output thread is called an output context. The Xlib representation of an output context is an -XOC, +XOC, which is compatible with -XFontSet +XFontSet in terms of its functional interface, but is a broader, more generalized abstraction. @@ -1095,19 +1095,19 @@ The following key applies to this table. - XNRequiredCharSet + XNRequiredCharSet G - XNQueryOrientation + XNQueryOrientation G - XNDirectionalDependentDrawing + XNDirectionalDependentDrawing G - XNContextualDrawing + XNContextualDrawing G @@ -1125,16 +1125,16 @@ The following key applies to this table. The -XNRequiredCharSet +XNRequiredCharSet 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 structure of type -XOMCharSetList. +XOMCharSetList. The -XOMCharSetList +XOMCharSetList structure is defined as follows: XOMCharSetList @@ -1163,7 +1163,7 @@ freed by the client. It will be freed by a call to XCloseOM with the associated -XOM. +XOM. Until freed, its contents will not be modified by Xlib. @@ -1178,15 +1178,15 @@ Until freed, its contents will not be modified by Xlib. The -XNQueryOrientation +XNQueryOrientation argument returns the global orientation of text when drawn. Other than -XOMOrientation_LTR_TTB, +XOMOrientation_LTR_TTB, the set of orientations supported is locale-dependent. The value of the argument is a pointer to a structure of type -XOMOrientation. +XOMOrientation. Clients are responsible for freeing the -XOMOrientation +XOMOrientation structure by using XFree; this also frees the contents of the structure. @@ -1219,31 +1219,31 @@ The possible value for XOrientation may be: -XOMOrientation_LTR_TTB +XOMOrientation_LTR_TTB left-to-right, top-to-bottom global orientation -XOMOrientation_RTL_TTB +XOMOrientation_RTL_TTB right-to-left, top-to-bottom global orientation -XOMOrientation_TTB_LTR +XOMOrientation_TTB_LTR top-to-bottom, left-to-right global orientation -XOMOrientation_TTB_RTL +XOMOrientation_TTB_RTL top-to-bottom, right-to-left global orientation -XOMOrientation_Context +XOMOrientation_Context contextual global orientation @@ -1260,15 +1260,15 @@ contextual global orientation The -XNDirectionalDependentDrawing +XNDirectionalDependentDrawing argument indicates whether the text rendering functions implement implicit handling of directional text. If this value is -True, +True, the output method has knowledge of directional dependencies and reorders text as necessary when rendering text. If this value is -False, +False, the output method does not implement any directional text handling, and all character directions are assumed to be left-to-right. @@ -1293,10 +1293,10 @@ function. The -XNContextualDrawing +XNContextualDrawing argument indicates whether the text rendering functions implement implicit context-dependent drawing. If this value is -True, +True, the output method has knowledge of context dependencies and performs character shape editing, combining glyphs to present a single character as necessary. The actual shape editing is @@ -1328,22 +1328,22 @@ It is intended that output methods be controlled by these XOC As new XOC values are created, they should be registered with the X Consortium. An -XOC +XOC can be used anywhere an -XFontSet +XFontSet can be used, and vice versa; -XFontSet +XFontSet is retained for compatibility with previous releases. The concepts of output methods and output contexts include broader, more generalized abstraction than font set, supporting complex and more intelligent text display, and dealing not only with multiple fonts but also with context dependencies. However, -XFontSet +XFontSet is widely used in several interfaces, so -XOC +XOC is defined as an upward compatible type of -XFontSet. +XFontSet. @@ -1428,7 +1428,7 @@ The output method encountered an output method implementation-dependent error. XCreateOC can generate a -BadAtom +BadAtom error. @@ -1586,7 +1586,7 @@ matching the data type imposed by the semantics of the argument. XSetOCValues can generate a -BadAtom +BadAtom error. @@ -1774,7 +1774,7 @@ The following keys apply to this table. The -XNBaseFontName +XNBaseFontName 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 @@ -1817,7 +1817,7 @@ returns NULL. When querying for the -XNBaseFontName +XNBaseFontName XOC value, XGetOCValues returns a null-terminated string identifying the base font names that @@ -1827,7 +1827,7 @@ the client. The string will be freed by a call to XDestroyOC with the associated -XOC. +XOC. Until freed, the string contents will not be modified by Xlib. @@ -1839,11 +1839,11 @@ Until freed, the string contents will not be modified by Xlib. The -XNMissingCharSet +XNMissingCharSet 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 -XOMCharSetList. +XOMCharSetList. @@ -1864,7 +1864,7 @@ freed by the client. It will be freed by a call to XDestroyOC with the associated -XOC. +XOC. Until freed, its contents will not be modified by Xlib. @@ -1876,14 +1876,14 @@ Until freed, its contents will not be modified by Xlib. When a drawing or measuring function is called with an -XOC +XOC that has missing charsets, some characters in the locale will not be drawable. The -XNDefaultString +XNDefaultString argument returns a pointer to a string that represents the glyphs that are drawn with this -XOC +XOC 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 @@ -1891,12 +1891,12 @@ 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 -XOC. +XOC. If the -XNDefaultString +XNDefaultString argument returned the empty string (""), no glyphs are drawn and the escapement is zero. The returned string is null-terminated. @@ -1904,7 +1904,7 @@ It is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to XDestroyOC with the associated -XOC. +XOC. Until freed, its contents will not be modified by Xlib. @@ -1916,39 +1916,39 @@ Until freed, its contents will not be modified by Xlib. The -XNOrientation +XNOrientation argument specifies the current orientation of text when drawn. The value of this argument is one of the values returned by the XGetOMValues function with the -XNQueryOrientation +XNQueryOrientation argument specified in the -XOrientation +XOrientation list. The value of the argument is of type -XOrientation. +XOrientation. When -XNOrientation +XNOrientation is queried, the value specifies the current orientation. When -XNOrientation +XNOrientation is set, a value is used to set the current orientation. When -XOMOrientation_Context +XOMOrientation_Context 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 -XOMOrientation_LTR_TTB. +XOMOrientation_LTR_TTB. The -XNOrientation +XNOrientation value does not change the prime drawing direction for Xlib drawing functions. @@ -1961,9 +1961,9 @@ for Xlib drawing functions. The -XNResourceName +XNResourceName and -XNResourceClass +XNResourceClass 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 @@ -1979,9 +1979,9 @@ set as resources. When querying for the -XNResourceName +XNResourceName or -XNResourceClass +XNResourceClass XOC value, XGetOCValues returns a null-terminated string. @@ -1990,7 +1990,7 @@ the client. The string will be freed by a call to XDestroyOC with the associated -XOC +XOC or when the associated value is changed via XSetOCValues. Until freed, the string contents will not be modified by Xlib. @@ -2004,13 +2004,13 @@ Until freed, the string contents will not be modified by Xlib. The -XNFontInfo +XNFontInfo argument specifies a list of one or more -XFontStruct +XFontStruct structures and font names for the fonts used for drawing by the given output context. The value of the argument is a pointer to a structure of type -XOMFontInfo. +XOMFontInfo. @@ -2029,13 +2029,13 @@ typedef struct { A list of pointers to the -XFontStruct +XFontStruct structures is returned to font_struct_list. A list of pointers to null-terminated, fully-specified font name strings in the locale of the output context is returned to font_name_list. The font_name_list order corresponds to the font_struct_list order. The number of -XFontStruct +XFontStruct structures and font names is returned to num_font. @@ -2046,31 +2046,31 @@ there is no provision for mapping a character or default string to the font properties, font ID, or direction hint for the font for the character. The client may access the -XFontStruct +XFontStruct 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 -XOC. +XOC. 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 -XFontStruct +XFontStruct structures in the -XFontStructSet +XFontStructSet is undefined. Also, note that all properties in the -XFontStruct +XFontStruct structures are in the STRING encoding. The client must not free the -XOMFontInfo +XOMFontInfo struct itself; it will be freed when the -XOC +XOC is closed. @@ -2082,7 +2082,7 @@ is closed. The -XNOMAutomatic +XNOMAutomatic argument returns whether the associated output context was created by XCreateFontSet or not. Because the @@ -2096,7 +2096,7 @@ However, it is possible that a client does not know how the output context was created. Before a client destroys the output context, it can query whether -XNOMAutomatic +XNOMAutomatic is set to determine whether XFreeFontSet or @@ -2117,10 +2117,10 @@ 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 -XFontSet +XFontSet is an opaque type representing the state of a particular output thread and is equivalent to the type -XOC. +XOC. @@ -2129,15 +2129,15 @@ The XCreateFontSet function is a convenience function for creating an output context using only default values. The returned -XFontSet +XFontSet has an implicitly created -XOM. +XOM. This -XOM +XOM has an OM value -XNOMAutomatic +XNOMAutomatic automatically set to -True +True so that the output context self indicates whether it was created by XCreateOC or @@ -2256,7 +2256,7 @@ function will return this XLFD name instead of the client-sup Xlib uses the following algorithm to select the fonts that will be used to display text with the -XFontSet. +XFontSet. @@ -2269,9 +2269,9 @@ 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 -CharSetRegistry +CharSetRegistry and -CharSetEncoding +CharSetEncoding fields. The implementation may use a base font name whose specified charset is a superset of the required charset, for example, @@ -2297,9 +2297,9 @@ if a JIS Roman font is not available. 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 -CharSetRegistry +CharSetRegistry and -CharSetEncoding +CharSetEncoding fields in the XLFD font name). As in case 1, the implementation may use a charset that is a superset @@ -2384,7 +2384,7 @@ is set to zero. If fonts exist for all of the charsets required by the current locale, XCreateFontSet returns a valid -XFontSet, +XFontSet, missing_charset_list_return is set to NULL, and missing_charset_count_return is set to zero. @@ -2409,20 +2409,20 @@ returns NULL. Otherwise, XCreateFontSet returns a valid -XFontSet +XFontSet to font_set. When an Xmb/wc drawing or measuring function is called with an -XFontSet +XFontSet that has missing charsets, some characters in the locale will not be drawable. If def_string_return is non-NULL, XCreateFontSet returns a pointer to a string that represents the glyphs that are drawn with this -XFontSet +XFontSet when the charsets of the available fonts do not include all font glyphs required to draw a codepoint. The string does not necessarily consist of valid characters @@ -2430,7 +2430,7 @@ 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 -XFontSet. +XFontSet. @@ -2441,7 +2441,7 @@ It is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to XFreeFontSet with the associated -XFontSet. +XFontSet. Until freed, its contents will not be modified by Xlib. @@ -2453,7 +2453,7 @@ operation in the case that some fonts did not exist. The returned -XFontSet +XFontSet and missing charset list should be freed with XFreeFontSet and @@ -2467,9 +2467,9 @@ by the client after calling To obtain a list of -XFontStruct +XFontStruct structures and full font names given an -XFontSet, +XFontSet, use XFontsOfFontSet. XFontsOfFontSet @@ -2522,17 +2522,17 @@ Returns the list of font names. The XFontsOfFontSet function returns a list of one or more -XFontStructs +XFontStructs and font names for the fonts used by the Xmb and Xwc layers for the given font set. A list of pointers to the -XFontStruct +XFontStruct structures is returned to font_struct_list_return. A list of pointers to null-terminated, fully specified font name strings in the locale of 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 -XFontStruct +XFontStruct structures and font names is returned as the value of the function. @@ -2543,42 +2543,42 @@ there is no provision for mapping a character or default string to the font properties, font ID, or direction hint for the font for the character. The client may access the -XFontStruct +XFontStruct 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 -XFontSet. +XFontSet. 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 -XFontStruct +XFontStruct structures in the -XFontStructSet +XFontStructSet is undefined. Also, note that all properties in the -XFontStruct +XFontStruct structures are in the STRING encoding. The -XFontStruct +XFontStruct 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 XFreeFontSet with the associated -XFontSet. +XFontSet. 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 -XFontSet, +XFontSet, use XBaseFontNameListOfFontSet. XBaseFontNameListOfFontSet @@ -2610,7 +2610,7 @@ The XBaseFontNameListOfFontSet function returns the original base font name list supplied by the client when the -XFontSet +XFontSet was created. A null-terminated string containing a list of comma-separated font names is returned @@ -2633,14 +2633,14 @@ freed by the client. It will be freed by a call to XFreeFontSet with the associated -XFontSet. +XFontSet. Until freed, its contents will not be modified by Xlib. To obtain the locale name given an -XFontSet, +XFontSet, use XLocaleOfFontSet. XLocaleOfFontSet @@ -2672,7 +2672,7 @@ The XLocaleOfFontSet function returns the name of the locale bound to the specified -XFontSet, +XFontSet, as a null-terminated string. @@ -2682,7 +2682,7 @@ and should not be modified or freed by the client. It may be freed by a call to XFreeFontSet with the associated -XFontSet. +XFontSet. Until freed, it will not be modified by Xlib. @@ -2693,7 +2693,7 @@ The function is a convenience function for freeing an output context. XFreeFontSet also frees its associated -XOM +XOM if the output context was created by XCreateFontSet. XFreeFontSet @@ -2736,9 +2736,9 @@ The XFreeFontSet function frees the specified font set. The associated base font name list, font name list, -XFontStruct +XFontStruct list, and -XFontSetExtents, +XFontSetExtents, if any, are freed. @@ -2828,10 +2828,10 @@ Specifies the font set. The XDirectionalDependentDrawing function returns -True +True if the drawing functions implement implicit text directionality; otherwise, it returns -False. +False. @@ -2866,10 +2866,10 @@ Specifies the font set. The XContextualDrawing function returns -True +True if text drawn with the font set might include context-dependent drawing; otherwise, it returns -False. +False. @@ -2904,11 +2904,11 @@ Specifies the font set. The XContextDependentDrawing function returns -True +True if the drawing functions implement implicit text directionality or if text drawn with the font_set might include context-dependent drawing; otherwise, it returns -False. +False. @@ -2923,7 +2923,7 @@ in a text stream. The maximum character extents for the fonts that are used by the text drawing layers can be accessed by the -XFontSetExtents +XFontSetExtents structure: XFontSetExtents @@ -2941,7 +2941,7 @@ typedef struct { The -XRectangle +XRectangle structures used to return font set metrics are the usual Xlib screen-oriented rectangles with x, y giving the upper left corner, and width and height always positive. @@ -2979,15 +2979,15 @@ individual extent. The rectangles for a given character in a string can be obtained from -XmbPerCharExtents +XmbTextPerCharExtents or -XwcPerCharExtents. +XwcTextPerCharExtents. To obtain the maximum extents structure given an -XFontSet, +XFontSet, use XExtentsOfFontSet. XExtentsOfFontSet @@ -3018,20 +3018,20 @@ Specifies the font set. The XExtentsOfFontSet function returns an -XFontSetExtents +XFontSetExtents structure for the fonts used by the Xmb and Xwc layers for the given font set. The -XFontSetExtents +XFontSetExtents structure is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to XFreeFontSet with the associated -XFontSet. +XFontSet. Until freed, its contents will not be modified by Xlib. @@ -3265,7 +3265,7 @@ should not intersect this rectangle. When the -XFontSet +XFontSet has missing charsets, metrics for each unavailable character are taken from the default string returned by @@ -3462,19 +3462,19 @@ logical_array_return rectangles. Note that an -XRectangle +XRectangle 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 -XRectangles +XRectangles of those characters are the same. When the -XFontSet +XFontSet has missing charsets, metrics for each unavailable character are taken from the default string returned by XCreateFontSet @@ -3521,7 +3521,7 @@ 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 -BadFont +BadFont error is generated, characters prior to the offending character may have been drawn. @@ -3692,11 +3692,11 @@ 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 -None +None in an item causes the font set to be used for this and subsequent text items in the text_items list. Leading text items with a font_set member set to -None +None will not be drawn. @@ -3714,7 +3714,7 @@ or and XwcTextPerCharExtents. When the -XFontSet +XFontSet has missing charsets, each unavailable character is drawn with the default string returned by XCreateFontSet. @@ -3860,7 +3860,7 @@ and XwcDrawString functions draw the specified text with the foreground pixel. When the -XFontSet +XFontSet has missing charsets, each unavailable character is drawn with the default string returned by XCreateFontSet. @@ -4011,12 +4011,12 @@ The filled rectangle is the rectangle returned to overall_logical_return by or XwcTextExtents for the same text and -XFontSet. +XFontSet. When the -XFontSet +XFontSet has missing charsets, each unavailable character is drawn with the default string returned by XCreateFontSet. @@ -4387,7 +4387,7 @@ 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 -XIM +XIM data type. This data structure is returned by the XOpenIM @@ -4403,7 +4403,7 @@ 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 -XIM +XIM object. @@ -4421,7 +4421,7 @@ and the user possibly switching among them at any time. The abstraction for representing the state of a particular input thread is called an input context. The Xlib representation of an input context is an -XIC. +XIC. @@ -4440,11 +4440,11 @@ One input context belongs to exactly one input method. Different input contexts may be associated with the same input method, possibly with the same client window. An -XIC +XIC is created with the XCreateIC function, providing an -XIM +XIM argument and affiliating the input context to the input method for its lifetime. When an input method is closed with @@ -4606,19 +4606,19 @@ 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 -XIMPreeditArea +XIMPreeditArea or -XIMStatusArea +XIMStatusArea in its -XIMStyles +XIMStyles value returned by XGetIMValues. When a client has decided that it will provide geometry management for an input method, it indicates that decision by setting the -XNInputStyle +XNInputStyle value in the -XIC. +XIC. @@ -4631,7 +4631,7 @@ The geometry is negotiated by the following steps: The client suggests an area to the input method by setting the -XNAreaNeeded +XNAreaNeeded 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. @@ -4641,7 +4641,7 @@ Otherwise, it will set one of the values. The client will get the XIC value -XNAreaNeeded. +XNAreaNeeded. The input method will return its suggested size in this value. The input method should pay attention to any constraints suggested by the client. @@ -4650,7 +4650,7 @@ by the client. The client sets the XIC value -XNArea +XNArea 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. @@ -4662,9 +4662,9 @@ 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, -XNFontSet +XNFontSet and -XNLineSpacing +XNLineSpace may change the geometry desired by the input method. @@ -4729,7 +4729,7 @@ to translations such as those the X Toolkit Intrinsics library provides. Clients are expected to get the XIC value -XNFilterEvents +XNFilterEvents and augment the event mask for the client window with that event mask. This mask may be zero. @@ -4793,7 +4793,7 @@ 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 visible position feedback masks of -XIMText +XIMText help resolve this 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 @@ -4919,16 +4919,16 @@ functions. String conversion support is dependent on the availability of the -XNStringConversion +XNStringConversion or -XNStringConversionCallback +XNStringConversionCallback 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 XGetIMValues with the -XNQueryICValuesList +XNQueryICValuesList IM value. @@ -4936,7 +4936,7 @@ IM value. The difference between these two values is whether the conversion is invoked by the client or the input method. The -XNStringConversion +XNStringConversion XIC value is used by clients to request a string conversion from the input method. The client is responsible for determining which events are used @@ -4945,14 +4945,14 @@ 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 -XNStringConversionCallback +XNStringConversionCallback will be issued when this value is set; thus, the client need only set one of these values. The -XNStringConversionCallback +XNStringConversionCallback 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, @@ -4963,13 +4963,13 @@ 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 provided with hints as to the amount of text needed. The -XIMStringConversionCallbackStruct +XIMStringConversionCallbackStruct specifies which text should be passed back to the input method. Finally, the input method may call the client's -XNStringConversionCallback +XNStringConversionCallback procedure multiple times if the string returned from the callback is not sufficient to perform a successful conversion. The arguments to the client's procedure allow the input method to define a @@ -5048,9 +5048,9 @@ functions are provided: being called. - XSetIMValue, XSetICValue + XSetIMValues, XSetICValues These functions use the XIM and XIC values, - XNDestroyCallback, + XNDestroyCallback, 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 @@ -5115,7 +5115,7 @@ Therefore, clients have to query support of hot keys by checking the supported XIC values list by calling XGetIMValues with the -XNQueryICValuesList +XNQueryICValuesList 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 @@ -5142,20 +5142,20 @@ retrieving the preedit state of an input context. One method is to query the state by calling XGetICValues with the -XNPreeditState +XNPreeditState 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 XSetICValues with the -XNPreeditStateNotifyCallback +XNPreeditStateNotifyCallback XIC value. In order to change the preedit state programmatically, an application needs to call XSetICValues with -XNPreeditState. +XNPreeditState. @@ -5166,7 +5166,7 @@ query availability of preedit state operations by checking the supported XIC values list by calling XGetIMValues with the -XNQueryICValuesList +XNQueryICValuesList IM value. @@ -5608,9 +5608,9 @@ locale and modifiers. The function returns -True +True if it succeeds; otherwise, it returns -False. +False. @@ -5619,7 +5619,7 @@ The generic prototype is as follows: - void IMInstantiateCallback + void IMInstantiateCallback Display *display XPointer client_data XPointer call_data @@ -5749,9 +5749,9 @@ The function removes an input method instantiation callback previously registered. The function returns -True +True if it succeeds; otherwise, it returns -False. +False. @@ -5817,35 +5817,35 @@ The following keys apply to this table. - XNQueryInputStyle + XNQueryInputStyle G - XNResourceName + XNResourceName D-S-G - XNResourceClass + XNResourceClass D-S-G - XNDestroyCallback + XNDestroyCallback D-S-G - XNQueryIMValuesList + XNQueryIMValuesList G - XNQueryICValuesList + XNQueryICValuesList G - XNVisiblePosition + XNVisiblePosition G - XNR6PreeditCallbackBehavior + XNR6PreeditCallback D-S-G @@ -5854,7 +5854,7 @@ The following keys apply to this table. -XNR6PreeditCallbackBehavior +XNR6PreeditCallback is obsolete and its use is not recommended (see section 13.5.4.6). @@ -5880,9 +5880,9 @@ it should negotiate with the user the continuation of the program 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 -XIMStyles. +XIMStyles. Clients are responsible for freeing the -XIMStyles +XIMStyles structure. To do so, use XFree. @@ -5890,7 +5890,7 @@ To do so, use The -XIMStyles +XIMStyles structure is defined as follows: @@ -5934,7 +5934,7 @@ typedef struct { An -XIMStyles +XIMStyles structure contains the number of input styles supported in its count_styles field. This is also the size of the supported_styles array. @@ -5965,41 +5965,41 @@ by the input method for preedit information. - XIMPreeditArea + XIMPreeditArea If chosen, the input method would require the client to provide some area values for it to do its preediting. Refer to XIC values - XNArea + XNArea and - XNAreaNeeded. + XNAreaNeeded. - XIMPreeditPosition + XIMPreeditPosition If chosen, the input method would require the client to provide positional values. Refer to XIC values - XNSpotLocation + XNSpotLocation and - XNFocusWindow. + XNFocusWindow. - XIMPreeditCallbacks + XIMPreeditCallbacks If chosen, the input method would require the client to define the set of preedit callbacks. Refer to XIC values - XNPreeditStartCallback, - XNPreeditDoneCallback, - XNPreeditDrawCallback, + XNPreeditStartCallback, + XNPreeditDoneCallback, + XNPreeditDrawCallback, and - XNPreeditCaretCallback. + XNPreeditCaretCallback. - XIMPreeditNothing + XIMPreeditNothing If chosen, the input method can function without any preedit values. - XIMPreeditNone + XIMPreeditNone The input method does not provide any preedit feedback. Any preedit value is ignored. This style is mutually exclusive with the other preedit styles. @@ -6023,28 +6023,28 @@ by the input method for status information. - XIMStatusArea + XIMStatusArea The input method requires the client to provide some area values for it to do its status feedback. See - XNArea + XNArea and - XNAreaNeeded. + XNAreaNeeded. - XIMStatusCallbacks + XIMStatusCallbacks The input method requires the client to define the set of status callbacks, - XNStatusStartCallback, - XNStatusDoneCallback, + XNStatusStartCallback, + XNStatusDoneCallback, and - XNStatusDrawCallback. + XNStatusDrawCallback. - XIMStatusNothing + XIMStatusNothing The input method can function without any status values. - XIMStatusNone + XIMStatusNone The input method does not provide any status feedback. If chosen, any status value is ignored. This style is mutually exclusive with the other status styles. @@ -6062,9 +6062,9 @@ by the input method for status information. The -XNResourceName +XNResourceName and -XNResourceClass +XNResourceClass 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 @@ -6089,10 +6089,10 @@ set as resources. The -XNDestroyCallback +XNDestroyCallback argument is a pointer to a structure of type -XIMCallback. -XNDestroyCallback +XIMCallback. +XNDestroyCallback 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. @@ -6108,7 +6108,7 @@ The generic prototype of this callback function is as follows: - void DestroyCallback + void DestroyCallback XIM im XPointer client_data XPointer call_data @@ -6164,9 +6164,9 @@ A DestroyCallback is always called with a NULL call_data argument. -XNQueryIMValuesList +XNQueryIMValuesList and -XNQueryICValuesList +XNQueryICValuesList are used to query about XIM and XIC values supported by the input method. @@ -6174,9 +6174,9 @@ are used to query about XIM and XIC values 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 -XIMValuesList. +XIMValuesList. Clients are responsible for freeing the -XIMValuesList +XIMValuesList structure. To do so, use XFree. @@ -6184,7 +6184,7 @@ To do so, use The -XIMValuesList +XIMValuesList structure is defined as follows: @@ -6209,24 +6209,24 @@ typedef struct { The -XNVisiblePosition +XNVisiblePosition argument indicates whether the visible position masks of -XIMFeedback +XIMFeedback in -XIMText +XIMText 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 -Bool. +Bool. If the returned value is -True, +True, the input method uses the visible position masks of -XIMFeedback +XIMFeedback in -XIMText; +XIMText; otherwise, the input method does not use the masks. @@ -6234,16 +6234,16 @@ otherwise, the input method does not use the masks. Because this XIM value is optional, a client should call XGetIMValues with argument -XNQueryIMValues +XNQueryIMValuesList before using this argument. If the -XNVisiblePosition +XNVisiblePosition does not exist in the IM values list returned from -XNQueryIMValues, +XNQueryIMValuesList, the visible position masks of -XIMFeedback +XIMFeedback in -XIMText +XIMText are not used to indicate the visible position. @@ -6258,7 +6258,7 @@ are not used to indicate the visible position. The -XNR6PreeditCallbackBehavior +XNR6PreeditCallback argument originally included in the X11R6 specification has been deprecated.\(dg @@ -6269,7 +6269,7 @@ the R6 PreeditDrawCallbacks was going to differ significantly from that of the R5 callbacks. Late changes to the specification converged the R5 and R6 behaviors, eliminating the need for -XNR6PreeditCallbackBehavior. +XNR6PreeditCallback. Unfortunately, this argument was not removed from the R6 specification before it was published. @@ -6277,39 +6277,39 @@ before it was published. The -XNR6PreeditCallbackBehavior +XNR6PreeditCallback argument indicates whether the behavior of preedit callbacks regarding -XIMPreeditDrawCallbackStruct +XIMPreeditDrawCallbackStruct values follows Release 5 or Release 6 semantics. The value is of type -Bool. +Bool. When querying for -XNR6PreeditCallbackBehavior, +XNR6PreeditCallback, if the returned value is -True, +True, the input method uses the Release 6 behavior; otherwise, it uses the Release 5 behavior. The default value is -False. +False. In order to use Release 6 semantics, the value of -XNR6PreeditCallbackBehavior +XNR6PreeditCallback must be set to -True. +True. Because this XIM value is optional, a client should call XGetIMValues with argument -XNQueryIMValues +XNQueryIMValuesList before using this argument. If the -XNR6PreeditCallbackBehavior +XNR6PreeditCallback does not exist in the IM values list returned from -XNQueryIMValues, +XNQueryIMValuesList, the PreeditCallback behavior is Release 5 semantics. @@ -6403,7 +6403,7 @@ A required argument was not set. A read-only argument was set (for example, -XNFilterEvents). +XNFilterEvents). @@ -6421,11 +6421,11 @@ The input method encountered an input method implementation-dependent error. XCreateIC can generate -BadAtom, -BadColor, -BadPixmap, +BadAtom, +BadColor, +BadPixmap, and -BadWindow +BadWindow errors. @@ -6593,17 +6593,17 @@ Specifies the input context. When -XNResetState +XNResetState is set to -XIMInitialState, +XIMInitialState, XmbResetIC and XwcResetIC reset an input context to its initial state; when -XNResetState +XNResetState is set to -XIMPreserveState, +XIMPreserveState, the current input context state is preserved. In both cases, any input pending on that context is deleted. The input method is required to clear the preedit area, if any, @@ -6727,7 +6727,7 @@ An argument might not be set for any of the following reasons: The argument is read-only (for example, -XNFilterEvents). +XNFilterEvents). @@ -6750,12 +6750,12 @@ matching the data type imposed by the semantics of the argument. XSetICValues can generate -BadAtom, -BadColor, -BadCursor, -BadPixmap, +BadAtom, +BadColor, +BadCursor, +BadPixmap, and -BadWindow +BadWindow errors. @@ -6831,10 +6831,10 @@ and the client is responsible for freeing this data by calling XFree with the returned pointer. The exception to this rule is for an IC value of type -XVaNestedList +XVaNestedList (for preedit and status attributes). In this case, the argument must also be of type -XVaNestedList. +XVaNestedList. Then, the rule of changing type T to T* and freeing the allocated data applies to each element of the nested list. @@ -7263,7 +7263,7 @@ The following keys apply to these tables. G - Status + Status Area @@ -7356,12 +7356,12 @@ The following keys apply to these tables. The -XNInputStyle +XNInputStyle argument specifies the input style to be used. The value of this argument must be one of the values returned by the XGetIMValues function with the -XNQueryInputStyle +XNQueryInputStyle argument specified in the supported_styles list. @@ -7379,7 +7379,7 @@ and cannot be changed. XNClientWindow The -XNClientWindow +XNClientWindow argument specifies to the input method the client window in which the input method can display data or create subwindows. @@ -7396,7 +7396,7 @@ the input method may not operate correctly. If an attempt is made to set this value a second time with XSetICValues, the string -XNClientWindow +XNClientWindow will be returned by XSetICValues, and the client window will not be changed. @@ -7406,7 +7406,7 @@ 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 -BadWindow +BadWindow error can be generated when this value is used by the input method. @@ -7419,10 +7419,10 @@ error can be generated when this value is used by the input method. XNFocusWindow The -XNFocusWindow +XNFocusWindow argument specifies the focus window. The primary purpose of the -XNFocusWindow +XNFocusWindow is to identify the window that will receive the key event when input is composed. In addition, the input method may possibly affect the focus window @@ -7453,11 +7453,11 @@ Grab the keyboard within that window The associated value must be of type -Window. +Window. If the focus window is not a valid window ID on the display attached to the input method, a -BadWindow +BadWindow error can be generated when this value is used by the input method. @@ -7476,9 +7476,9 @@ the input method will use the client window as the default focus window. XNResourceName XNResourceClass The -XNResourceName +XNResourceName and -XNResourceClass +XNResourceClass 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 @@ -7501,15 +7501,15 @@ set as resources. XNGeometryCallback The -XNGeometryCallback +XNGeometryCallback argument is a structure of type -XIMCallback +XIMCallback (see section 13.5.6.13.12). The -XNGeometryCallback +XNGeometryCallback argument specifies the geometry callback that a client can set. This callback is not required for correct operation of either an input method or a client. @@ -7529,7 +7529,7 @@ events that it uses to initiate the change. XNFilterEvents The -XNFilterEvents +XNFilterEvents argument returns the event mask that an input method needs to have selected for. The client is expected to augment its own event mask @@ -7543,8 +7543,8 @@ and is never changed. The type of this argument is -unsigned -long. +unsigned +long. Setting this value will cause an error. @@ -7556,9 +7556,9 @@ Setting this value will cause an error. The -XNDestroyCallback +XNDestroyCallback argument is a pointer to a structure of type -XIMCallback +XIMCallback (see section 13.5.6.13.12). This callback 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, @@ -7580,15 +7580,15 @@ and The -XNStringConversionCallback +XNStringConversionCallback argument is a structure of type -XIMCallback +XIMCallback (see section 13.5.6.13.12). The -XNStringConversionCallback +XNStringConversionCallback argument specifies a string conversion callback. This callback is not required for correct operation of either the input method or the client. It can be set by a client @@ -7601,7 +7601,7 @@ will filter any events that it uses to initiate the conversion. Because this XIC value is optional, a client should call XGetIMValues with argument -XNQueryICValuesList +XNQueryICValuesList before using this argument. @@ -7616,14 +7616,14 @@ before using this argument. The -XNStringConversion +XNStringConversion argument is a structure of type -XIMStringConversionText. +XIMStringConversionText. The -XNStringConversion +XNStringConversion 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. @@ -7641,13 +7641,13 @@ reconversion, or transliteration conversion on it. Because this XIC value is optional, a client should call XGetIMValues with argument -XNQueryICValuesList +XNQueryICValuesList before using this argument. The -XIMStringConversionText +XIMStringConversionText structure is defined as follows: @@ -7689,7 +7689,7 @@ element to NULL. The -XNResetState +XNResetState argument specifies the state the input context will return to after calling XmbResetIC or @@ -7698,7 +7698,7 @@ or The XIC state may be set to its initial state, as specified by the -XNPreeditState +XNPreeditState value when XCreateIC was called, or it may be set to preserve the current state. @@ -7706,7 +7706,7 @@ was called, or it may be set to preserve the current state. The valid masks for -XIMResetState +XIMResetState are as follows: @@ -7727,19 +7727,19 @@ typedef unsigned long XIMResetState; If -XIMInitialState +XIMInitialState is set, then XmbResetIC and XwcResetIC will return to the initial -XNPreeditState +XNPreeditState state of the XIC. If -XIMPreserveState +XIMPreserveState is set, then XmbResetIC and @@ -7749,22 +7749,22 @@ will preserve the current state of the XIC. If -XNResetState +XNResetState is left unspecified, the default is -XIMInitialState. +XIMInitialState. -XIMResetState +XIMResetState values other than those specified above will default to -XIMInitialState. +XIMInitialState. Because this XIC value is optional, a client should call XGetIMValues with argument -XNQueryICValuesList +XNQueryICValuesList before using this argument. @@ -7779,30 +7779,30 @@ before using this argument. The -XNHotKey +XNHotKey argument specifies the hot key list to the XIC. The hot key list is a pointer to the structure of type -XIMHotKeyTriggers, +XIMHotKeyTriggers, 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 -XNHotKeyState +XNHotKeyState to -XIMHotKeyStateON. +XIMHotKeyStateON. Because this XIC value is optional, a client should call XGetIMValues with argument -XNQueryICValuesList +XNQueryICValuesList before using this functionality. The value of the argument is a pointer to a structure of type -XIMHotKeyTriggers. +XIMHotKeyTriggers. @@ -7882,7 +7882,7 @@ is ignored when evaluating whether the key is hot or not. The -XNHotKeyState +XNHotKeyState 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 processing. @@ -7907,7 +7907,7 @@ typedef unsigned long XIMHotKeyState; If not specified, the default is -XIMHotKeyStateOFF. +XIMHotKeyStateOFF. @@ -7923,9 +7923,9 @@ If not specified, the default is XNPreeditAttributes XNStatusAttributes The -XNPreeditAttributes +XNPreeditAttributes and -XNStatusAttributes +XNStatusAttributes arguments specify to an input method the attributes to be used for the preedit and status areas, if any. @@ -7945,18 +7945,18 @@ The names to be used in these lists are described in the following sections. XNArea The value of the -XNArea +XNArea argument must be a pointer to a structure of type -XRectangle. +XRectangle. The interpretation of the -XNArea +XNArea argument is dependent on the input method style that has been set. If the input method style is -XIMPreeditPosition, -XNArea +XIMPreeditPosition, +XNArea specifies the clipping region within which preediting will take place. If the focus window has been set, the coordinates are assumed to be relative to the focus window. @@ -7967,33 +7967,33 @@ the results are undefined. If -XNArea +XNArea is not specified, is set to NULL, or is invalid, the input method will default the clipping region to the geometry of the -XNFocusWindow. +XNFocusWindow. If the area specified is NULL or invalid, the results are undefined. If the input style is -XIMPreeditArea +XIMPreeditArea or -XIMStatusArea, -XNArea +XIMStatusArea, +XNArea 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 -XNArea. +XNArea. 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 -XNArea +XNArea is not specified, is set to NULL, or is invalid, the results are undefined. @@ -8007,12 +8007,12 @@ the results are undefined. XNAreaNeeded When set, the -XNAreaNeeded +XNAreaNeeded 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 -XRectangle. +XRectangle. 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. @@ -8020,16 +8020,16 @@ that the client wishes the input method to respect. When read, the -XNAreaNeeded +XNAreaNeeded argument specifies the preferred geometry desired by the input method for the area. This argument is only valid if the input style is -XIMPreeditArea +XIMPreeditArea or -XIMStatusArea. +XIMStatusArea. It is used for geometry negotiation between the client and the input method and has no other effect on the input method (see section 13.5.1.5). @@ -8044,14 +8044,14 @@ and has no other effect on the input method XNSpotLocation The -XNSpotLocation +XNSpotLocation argument specifies to the input method the coordinates of the spot to be used by an input method executing with -XNInputStyle +XNInputStyle set to -XIMPreeditPosition. +XIMPreeditPosition. When specified to any input method other than -XIMPreeditPosition, +XIMPreeditPosition, this XIC value is ignored. @@ -8068,7 +8068,7 @@ the results are undefined. The value of the argument is a pointer to a structure of type -XPoint. +XPoint. @@ -8085,27 +8085,27 @@ should use to allocate colors, a colormap ID, or a standard colormap name. XNColormap The -XNColormap +XNColormap argument is used to specify a colormap ID. The argument value is of type -Colormap. +Colormap. An invalid argument may generate a -BadColor +BadColor error when it is used by the input method. XNStdColormap The -XNStdColormap +XNStdColormap argument is used to indicate the name of the standard colormap in which the input method should allocate colors. The argument value is an -Atom +Atom that should be a valid atom for calling XGetRGBColormaps. An invalid argument may generate a -BadAtom +BadAtom error when it is used by the input method. @@ -8124,13 +8124,13 @@ the client window colormap becomes the default. XNForeground XNBackground The -XNForeground +XNForeground and -XNBackground +XNBackground arguments specify the foreground and background pixel, respectively. The argument value is of type -unsigned -long. +unsigned +long. It must be a valid pixel in the input method colormap. @@ -8147,13 +8147,13 @@ the default is determined by the input method. The -XNBackgroundPixmap +XNBackgroundPixmap argument specifies a background pixmap to be used as the background of the window. The value must be of type -Pixmap. +Pixmap. An invalid argument may generate a -BadPixmap +BadPixmap error when it is used by the input method. @@ -8171,10 +8171,10 @@ the default is determined by the input method. XNFontSet The -XNFontSet +XNFontSet argument specifies to the input method what font set is to be used. The argument value is of type -XFontSet. +XFontSet. @@ -8190,11 +8190,11 @@ the default is determined by the input method. The -XNLineSpace +XNLineSpace 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 -int. +int. @@ -8211,16 +8211,16 @@ the default is determined by the input method. XNCursor The -XNCursor +XNCursor argument specifies to the input method what cursor is to be used in the specified window. This argument is of type -Cursor. +Cursor. An invalid argument may generate a -BadCursor +BadCursor error when it is used by the input method. If this value is left unspecified, the default is determined by the input method. @@ -8234,14 +8234,14 @@ the default is determined by the input method. The -XNPreeditState +XNPreeditState argument specifies the state of input preediting for the input method. Input preediting can be on or off. The valid mask names for -XNPreeditState +XNPreeditState are as follows: @@ -8265,29 +8265,29 @@ typedef unsigned long XIMPreeditState; If a value of -XIMPreeditEnable +XIMPreeditEnable is set, then input preediting is turned on by the input method. If a value of -XIMPreeditDisable +XIMPreeditDisable is set, then input preediting is turned off by the input method. If -XNPreeditState +XNPreeditState is left unspecified, then the state will be implementation-dependent. When -XNResetState +XNResetState is set to -XIMInitialState, +XIMInitialState, the -XNPreeditState +XNPreeditState value specified at the creation time will be reflected as the initial state for XmbResetIC and @@ -8298,7 +8298,7 @@ and Because this XIC value is optional, a client should call XGetIMValues with argument -XNQueryICValuesList +XNQueryICValuesList before using this argument. @@ -8312,15 +8312,15 @@ before using this argument. The preedit state notify callback is triggered by the input method when the preediting state has changed. The value of the -XNPreeditStateNotifyCallback +XNPreeditStateNotifyCallback argument is a pointer to a structure of type -XIMCallback. +XIMCallback. The generic prototype is as follows: PreeditStateNotifyCallback - void PreeditStateNotifyCallback + void PreeditStateNotifyCallback XIC ic XPointer client_data XIMPreeditStateNotifyCallbackStruct *call_data @@ -8364,7 +8364,7 @@ Specifies the current preedit state. The -XIMPreeditStateNotifyCallbackStruct +XIMPreeditStateNotifyCallbackStruct structure is defined as follows: @@ -8388,7 +8388,7 @@ typedef struct _XIMPreeditStateNotifyCallbackStruct { Because this XIC value is optional, a client should call XGetIMValues with argument -XNQueryICValuesList +XNQueryICValuesList before using this argument. @@ -8400,7 +8400,7 @@ before using this argument. A client that wants to support the input style -XIMPreeditCallbacks +XIMPreeditCallbacks must provide a set of preedit callbacks to the input method. The set of preedit callbacks is as follows: @@ -8414,19 +8414,19 @@ The set of preedit callbacks is as follows: - XNPreeditStartCallback + XNPreeditStartCallback This is called when the input method starts preedit. - XNPreeditDoneCallback + XNPreeditDoneCallback This is called when the input method stops preedit. - XNPreeditDrawCallback + XNPreeditDrawCallback This is called when a number of preedit keystrokes should be echoed. - XNPreeditCaretCallback + XNPreeditCaretCallback This is called to move the text insertion point within the preedit string. @@ -8436,7 +8436,7 @@ The set of preedit callbacks is as follows: A client that wants to support the input style -XIMStatusCallbacks +XIMStatusCallbacks must provide a set of status callbacks to the input method. The set of status callbacks is as follows: @@ -8450,15 +8450,15 @@ The set of status callbacks is as follows: - XNStatusStartCallback + XNStatusStartCallback This is called when the input method initializes the status area. - XNStatusDoneCallback + XNStatusDoneCallback This is called when the input method no longer needs the status area. - XNStatusDrawCallback + XNStatusDrawCallback This is called when updating of the status area is required. @@ -8468,7 +8468,7 @@ The set of status callbacks is as follows: The value of any status or preedit argument is a pointer to a structure of type -XIMCallback. +XIMCallback. XIMProc XIMCallback @@ -8538,7 +8538,7 @@ All callback procedures follow the generic prototype: - void CallbackPrototype + void CallbackPrototype XIC ic XPointer client_data SomeType call_data @@ -8610,7 +8610,7 @@ The generic prototype is as follows: - void GeometryCallback + void GeometryCallback XIC ic XPointer client_data XPointer call_data @@ -8671,7 +8671,7 @@ The generic prototype is as follows: - void DestroyCallback + void DestroyCallback XIC ic XPointer client_data XPointer call_data @@ -8733,7 +8733,7 @@ The callback prototype is as follows: - void StringConversionCallback + void StringConversionCallback XIC ic XPointer client_data XIMStringConversionCallbackStruct *call_data @@ -8777,15 +8777,15 @@ Specifies the amount of the string to be converted. The callback is passed an -XIMStringConversionCallbackStruct +XIMStringConversionCallbackStruct structure in the call_data argument. The text member is an -XIMStringConversionText +XIMStringConversionText 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 -XIMStringConversionText +XIMStringConversionText structure will be freed using XFree by the input method @@ -8798,7 +8798,7 @@ freeing memory at some random location due to an uninitialized pointer. The -XIMStringConversionCallbackStruct +XIMStringConversionCallbackStruct structure is defined as follows: @@ -8828,10 +8828,10 @@ typedef unsigned short XIMStringConversionOperation; -XIMStringConversionPosition +XIMStringConversionPosition specifies the starting position of the string to be returned in the -XIMStringConversionText +XIMStringConversionText structure. The value identifies a position, in units of characters, relative to the client's cursor position in the client's buffer. @@ -8840,36 +8840,36 @@ 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 character position relative to the starting point as defined by the -XIMCaretDirection. +XIMCaretDirection. The factor member of -XIMStringConversionCallbackStruct +XIMStringConversionCallbackStruct specifies the number of -XIMCaretDirection +XIMCaretDirection positions to be applied. For example, if the direction specifies -XIMLineEnd +XIMLineEnd 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 -XIMForwardChar +XIMForwardChar or -XIMBackwardChar, +XIMBackwardChar, then the factor specifies a relative position, indicated in characters, from the starting position. -XIMStringConversionOperation +XIMStringConversionOperation specifies whether the string to be converted should be deleted (substitution) or copied (retrieval) from the client's buffer. When the -XIMStringConversionOperation +XIMStringConversionOperation is -XIMStringConversionSubstitution, +XIMStringConversionSubstitution, the client must delete the string to be converted from its own buffer. When the -XIMStringConversionOperation +XIMStringConversionOperation is -XIMStringConversionRetrieval, +XIMStringConversionRetrieval, the client must not delete the string to be converted from its buffer. The substitute operation is typically used for reconversion and transliteration conversion, @@ -8885,16 +8885,16 @@ conversion. When the input method turns preediting on or off, a -PreeditStartCallback +PreeditStartCallback or -PreeditDoneCallback +PreeditDoneCallback callback is triggered to let the toolkit do the setup or the cleanup for the preedit region. PreeditStartCallback - int PreeditStartCallback + int PreeditStartCallback XIC ic XPointer client_data XPointer call_data @@ -8939,7 +8939,7 @@ 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. -PreeditStartCallback +PreeditStartCallback will return the maximum size of the preedit string. A positive number indicates the maximum number of bytes allowed in the preedit string, @@ -8948,7 +8948,7 @@ and a value of -1 indicates there is no limit. - void PreeditDoneCallback + void PreeditDoneCallback XIC ic XPointer client_data XPointer call_data @@ -8994,19 +8994,19 @@ Not used for this callback and always passed as NULL. When preedit stops on the specified input context, the callback is called with a NULL call_data argument. The client can release the data allocated by -PreeditStartCallback. +PreeditStartCallback. -PreeditStartCallback +PreeditStartCallback should initialize appropriate data needed for displaying preedit information and for handling further -PreeditDrawCallback +PreeditDrawCallback calls. Once -PreeditStartCallback +PreeditStartCallback is called, it will not be called again before -PreeditDoneCallback +PreeditDoneCallback has been called. @@ -9029,7 +9029,7 @@ is as follows: - void PreeditDrawCallback + void PreeditDrawCallback XIC ic XPointer client_data XIMPreeditDrawCallbackStruct *call_data @@ -9073,7 +9073,7 @@ Specifies the preedit drawing information. The callback is passed an -XIMPreeditDrawCallbackStruct +XIMPreeditDrawCallbackStruct structure in the call_data argument. The text member of this structure contains the text to be drawn. After the string has been drawn, @@ -9082,7 +9082,7 @@ the caret should be moved to the specified location. The -XIMPreeditDrawCallbackStruct +XIMPreeditDrawCallbackStruct structure is defined as follows: @@ -9132,7 +9132,7 @@ 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 -XIMText +XIMText structure. @@ -9148,7 +9148,7 @@ A value of zero for chg_first specifies the first character in the buffer. chg_length and chg_first combine to identify the modification required to the preedit buffer; beginning at chg_first, replace chg_length number of characters with the text in the supplied -XIMText +XIMText structure. For example, suppose the preedit buffer contains the string "ABCDE". @@ -9171,7 +9171,7 @@ 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 -XIMText +XIMText structure. Hence, BCD would be replaced by the value in the structure. @@ -9264,25 +9264,25 @@ 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 -XIMVisibleToForward, -XIMVisibleToBackward, +XIMVisibleToForward, +XIMVisibleToBackword, and -XIMVisibleCenter +XIMVisibleToCenter masks are exclusively used for these visibility hints. The -XIMVisibleToForward +XIMVisibleToForward mask indicates that the preedit text is preferably displayed in the primary draw direction from the caret position in the preedit area forward. The -XIMVisibleToBackward +XIMVisibleToBackword mask indicates that the preedit text is preferably displayed from the caret position in the preedit area backward, relative to the primary draw direction. The -XIMVisibleCenter +XIMVisibleToCenter mask indicates that the preedit text is preferably displayed with the caret position in the preedit area centered. @@ -9296,7 +9296,7 @@ masks is valid for the entire preedit string, and only one character can hold one of these feedbacks for a given input context at one time. This feedback may be OR'ed together with another highlight (such as -XIMReverse). +XIMReverse). 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. @@ -9318,17 +9318,17 @@ character of the string, and the length of the array is thus length. If an input method wants to indicate that it is only updating the feedback of the preedit text without changing the content of it, the -XIMText +XIMText 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 -XIMFeedback. +XIMFeedback. Each element in the feedback array is a bitmask represented by a value of type -XIMFeedback. +XIMFeedback. The valid mask names are as follows: @@ -9341,7 +9341,7 @@ The valid mask names are as follows: XIMTertiary XIMVisibleToForward XIMVisibleToBackward -XIMVisibleCenter +XIMVisibleToCenter @@ -9355,7 +9355,7 @@ typedef unsigned long XIMFeedback; #define XIMTertiary (1L<<7)* #define XIMVisibleToForward (1L<<8) #define XIMVisibleToBackward (1L<<9) -#define XIMVisibleCenter (1L<<10) +#define XIMVisibleToCenter (1L<<10) *† The values for XIMPrimary, XIMSecondary, and XIMTertiary were incorrectly defined in the R5 specification. The X Consortium’s X11R5 implementation correctly implemented the val- @@ -9367,29 +9367,29 @@ agree with the values in the Consortium’s X11R5 and X11R6 implementations. Characters drawn with the -XIMReverse +XIMReverse highlight should be drawn by swapping the foreground and background colors used to draw normal, unhighlighted characters. Characters drawn with the -XIMUnderline +XIMUnderline highlight should be underlined. Characters drawn with the -XIMHighlight, -XIMPrimary, -XIMSecondary, +XIMHighlight, +XIMPrimary, +XIMSecondary, and -XIMTertiary +XIMTertiary highlights should be drawn in some unique manner that must be different from -XIMReverse +XIMReverse and -XIMUnderline. +XIMUnderline. The values for -XIMPrimary, -XIMSecondary, +XIMPrimary, +XIMSecondary, and -XIMTertiary +XIMTertiary were incorrectly defined in the R5 specification. The X Consortium's X11R5 implementation correctly implemented the values for these highlights. @@ -9415,7 +9415,7 @@ It then calls the PreeditCaretCallback. - void PreeditCaretCallback + void PreeditCaretCallback XIC ic XPointer client_data XIMPreeditCaretCallbackStruct *call_data @@ -9461,7 +9461,7 @@ 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 -XIMPreeditCaretCallbackStruct +XIMPreeditCaretCallbackStruct structure, which indicates where the caret should be moved. The callback must move the insertion point to its new location @@ -9470,7 +9470,7 @@ and return, in field position, the new offset value from the initial position. The -XIMPreeditCaretCallbackStruct +XIMPreeditCaretCallbackStruct structure is defined as follows: XIMPreeditCaretCallbackStruct @@ -9491,7 +9491,7 @@ typedef struct _XIMPreeditCaretCallbackStruct { The -XIMCaretStyle +XIMCaretStyle structure is defined as follows: @@ -9512,7 +9512,7 @@ typedef enum { The -XIMCaretDirection +XIMCaretDirection structure is defined as follows: XIMCaretDirection @@ -9550,54 +9550,54 @@ These values are defined as follows: - XIMForwardChar + XIMForwardChar Move the caret forward one character position. - XIMBackwardChar + XIMBackwardChar Move the caret backward one character position. - XIMForwardWord + XIMForwardWord Move the caret forward one word. - XIMBackwardWord + XIMBackwardWord Move the caret backward one word. - XIMCaretUp + XIMCaretUp Move the caret up one line keeping the current horizontal offset. - XIMCaretDown + XIMCaretDown Move the caret down one line keeping the current horizontal offset. - XIMPreviousLine + XIMPreviousLine Move the caret to the beginning of the previous line. - XIMNextLine + XIMNextLine Move the caret to the beginning of the next line. - XIMLineStart + XIMLineStart Move the caret to the beginning of the current display line that contains the caret. - XIMLineEnd + XIMLineEnd Move the caret to the end of the current display line that contains the caret. - XIMAbsolutePosition + XIMAbsolutePosition The callback must move to the location 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. - XIMDontChange + XIMDontChange The caret position does not change. @@ -9631,7 +9631,7 @@ the input method calls the StatusStartCallback callback. - void StatusStartCallback + void StatusStartCallback XIC ic XPointer client_data XPointer call_data @@ -9688,7 +9688,7 @@ is destroyed or when it loses focus, the input method calls StatusDoneCallback. - void StatusDoneCallback + void StatusDoneCallback XIC ic XPointer client_data XPointer call_data @@ -9743,7 +9743,7 @@ StatusDrawCallback. - void StatusDrawCallback + void StatusDrawCallback XIC ic XPointer client_data XIMStatusDrawCallbackStruct *call_data @@ -9792,9 +9792,9 @@ or imaging a bitmap in the status area. The -XIMStatusDataType +XIMStatusDataType and -XIMStatusDrawCallbackStruct +XIMStatusDrawCallbackStruct structures are defined as follows: XIMStatusDataType XIMStatusDrawCallbackStruct @@ -9826,14 +9826,14 @@ typedef struct _XIMStatusDrawCallbackStruct { The feedback styles -XIMVisibleToForward, -XIMVisibleToBackward, +XIMVisibleToForward, +XIMVisibleToBackword, and -XIMVisibleToCenter +XIMVisibleToCenter are not relevant and will not appear in the -XIMFeedback +XIMFeedback element of the -XIMText +XIMText structure. @@ -9855,7 +9855,7 @@ This filter is called by a client (or toolkit) by calling after calling XNextEvent. Any client that uses the -XIM +XIM interface should call XFilterEvent to allow input methods to process their events without knowledge @@ -9916,10 +9916,10 @@ Specifies the window (Wi. If the window argument is -None, +None, XFilterEvent applies the filter to the window specified in the -XEvent +XEvent structure. The window argument is provided so that layers above Xlib that do event redirection can indicate to which window an event @@ -9930,13 +9930,13 @@ has been redirected. If XFilterEvent returns -True, +True, then some input method has filtered the event, and the client should discard the event. If XFilterEvent returns -False, +False, then the client should continue processing the event. @@ -9944,7 +9944,7 @@ then the client should continue processing the event. If a grab has occurred in the client and XFilterEvent returns -True, +True, the client should ungrab the keyboard. @@ -10108,13 +10108,13 @@ begins in the initial state of the encoding of the locale To insure proper input processing, it is essential that the client pass only -KeyPress +KeyPress events to XmbLookupString and XwcLookupString. Their behavior when a client passes a -KeyRelease +KeyRelease event is undefined. @@ -10134,7 +10134,7 @@ The possible values returned are: - XBufferOverflow + XBufferOverflow The input string to be returned is too large for the supplied buffer_return. The required size (XmbLookupString @@ -10146,13 +10146,13 @@ The possible values returned are: and a buffer of adequate size to obtain the string. - XLookupNone + XLookupNone No consistent input has been composed so far. The contents of buffer_return and keysym_return are not modified, and the function returns zero. - XLookupChars + XLookupChars Some input characters have been composed. They are placed in the buffer_return argument, and the string length is returned as the value of the function. @@ -10160,18 +10160,18 @@ The possible values returned are: The content of the keysym_return argument is not modified. - XLookupKeySym + XLookupKeySym 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. - XLookupBoth + XLookupBoth Both a KeySym and a string are returned; - XLookupChars + XLookupChars and - XLookupKeySym + XLookupKeySym occur simultaneously. @@ -10228,14 +10228,14 @@ or raise an exception or error of some sort. A -KeyPress +KeyPress event with a KeyCode of zero is used exclusively as a signal that an input method has composed input that can be returned by XmbLookupString or XwcLookupString. No other use is made of a -KeyPress +KeyPress event with KeyCode of zero. @@ -10259,7 +10259,7 @@ onto a client's event queue A -KeyPress +KeyPress event whose KeyCode value is modified by an input method filter diff --git a/specs/libX11/CH14.xml b/specs/libX11/CH14.xml index d2c5f9c8..b60b0101 100644 --- a/specs/libX11/CH14.xml +++ b/specs/libX11/CH14.xml @@ -304,16 +304,16 @@ Specifies the appropriate screen number on the host server. The XIconifyWindow function sends a WM_CHANGE_STATE -ClientMessage +ClientMessage event with a format of 32 and a first data element of -IconicState +IconicState (as described in section 4.1.4 of the Inter-Client Communication Conventions Manual) and a window of w to the root window of the specified screen with an event mask set to -SubstructureNotifyMask | -SubstructureRedirectMask. +SubstructureNotifyMask | +SubstructureRedirectMask. 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. @@ -379,14 +379,14 @@ The XWithdrawWindow function unmaps the specified window and sends a synthetic -UnmapNotify +UnmapNotify 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 window's state to withdrawn. When a window is in the withdrawn state, neither its normal nor its iconic representations is visible. It returns a nonzero status if the -UnmapNotify +UnmapNotify event is successfully sent; otherwise, it returns a zero status. @@ -394,7 +394,7 @@ otherwise, it returns a zero status. XWithdrawWindow can generate a -BadWindow +BadWindow error. @@ -465,7 +465,7 @@ This mask is the bitwise inclusive OR of the valid configure window values bits. Specifies the -XWindowChanges +XWindowChanges structure. @@ -478,13 +478,13 @@ structure. The XReconfigureWMWindow function issues a -ConfigureWindow +ConfigureWindow request on the specified top-level window. If the stacking mode is changed and the request fails with a -BadMatch +BadMatch error, the error is trapped by Xlib and a synthetic -ConfigureRequestEvent +ConfigureRequestEvent containing the same configuration parameters is sent to the root of the specified window. Window managers may elect to receive this event @@ -496,9 +496,9 @@ otherwise, it returns a zero status. XReconfigureWMWindow can generate -BadValue +BadValue and -BadWindow +BadWindow errors. @@ -512,11 +512,11 @@ errors. 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 -XTextProperty +XTextProperty structure is used to describe the encoding, type, and length of the text as well as its value. The -XTextProperty +XTextProperty structure contains: XTextProperty @@ -543,7 +543,7 @@ to character strings and text properties in the STRING encoding. The functions for localized text return a signed integer error status that encodes -Success +Success as zero, specific error conditions as negative numbers, and partial conversion as a count of unconvertible characters. @@ -570,7 +570,7 @@ typedef enum { To convert a list of text strings to an -XTextProperty +XTextProperty structure, use XmbTextListToTextProperty or @@ -648,7 +648,7 @@ Specifies the manner in which the property is encoded. Returns the -XTextProperty +XTextProperty structure. @@ -663,7 +663,7 @@ The and XwcTextListToTextProperty functions set the specified -XTextProperty +XTextProperty 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 @@ -672,23 +672,23 @@ of text_prop_return but is not included in the nitems member. The functions set the encoding field of text_prop_return to an -Atom +Atom for the specified display naming the encoding determined 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 -XStringStyle +XStringStyle or -XCompoundTextStyle +XCompoundTextStyle is specified, this encoding is ``STRING'' or ``COMPOUND_TEXT'', respectively. If the style -XTextStyle +XTextStyle is specified, this encoding is the encoding of the current locale. If the style -XStdICCTextStyle +XStdICCTextStyle is specified, this encoding is ``STRING'' if the text is fully convertible to STRING, else ``COMPOUND_TEXT''. @@ -697,17 +697,17 @@ else ``COMPOUND_TEXT''. If insufficient memory is available for the new value string, the functions return -XNoMemory. +XNoMemory. If the current locale is not supported, the functions return -XLocaleNotSupported. +XLocaleNotSupported. In both of these error cases, the functions do not set text_prop_return. To determine if the functions are guaranteed not to return -XLocaleNotSupported, +XLocaleNotSupported, use XSupportsLocale. @@ -718,9 +718,9 @@ the functions return the number of unconvertible characters. Each unconvertible character is converted to an implementation-defined and encoding-specific default string. Otherwise, the functions return -Success. +Success. Note that full convertibility to all styles except -XStringStyle +XStringStyle is guaranteed. @@ -732,7 +732,7 @@ To free the storage for the value field, use To obtain a list of text strings from an -XTextProperty +XTextProperty structure, use XmbTextPropertyToTextList or @@ -778,7 +778,7 @@ Specifies the connection to the X server. Specifies the -XTextProperty +XTextProperty structure to be used. @@ -815,7 +815,7 @@ and XwcTextPropertyToTextList functions return a list of text strings in the current locale representing the null-separated elements of the specified -XTextProperty +XTextProperty structure. The data in text_prop must be format 8. @@ -833,20 +833,20 @@ If insufficient memory is available for the list and its elements, and XwcTextPropertyToTextList return -XNoMemory. +XNoMemory. If the current locale is not supported, the functions return -XLocaleNotSupported. +XLocaleNotSupported. Otherwise, if the encoding field of text_prop is not convertible to the encoding of the current locale, the functions return -XConverterNotFound. +XConverterNotFound. For supported locales, existence of a converter from COMPOUND_TEXT, STRING or the encoding of the current locale is guaranteed if XSupportsLocale returns -True +True for the current locale (but the actual text may contain unconvertible characters). Conversion of other encodings is implementation-dependent. @@ -877,7 +877,7 @@ Otherwise, and XwcTextPropertyToTextList return -Success. +Success. @@ -959,7 +959,7 @@ is independent of the default string for text drawing; see XCreateFontSet to obtain the default string for an -XFontSet. +XFontSet. @@ -977,7 +977,7 @@ Until freed, it will not be modified by Xlib. To set the specified list of strings in the STRING encoding to a -XTextProperty +XTextProperty structure, use XStringListToTextProperty. XStringListToTextProperty @@ -1020,7 +1020,7 @@ Specifies the number of (Cn. Returns the -XTextProperty +XTextProperty structure. @@ -1033,7 +1033,7 @@ structure. The XStringListToTextProperty function sets the specified -XTextProperty +XTextProperty 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) @@ -1042,7 +1042,7 @@ The strings are assumed (without verification) to be in the STRING encoding. If insufficient memory is available for the new value string, XStringListToTextProperty does not set any fields in the -XTextProperty +XTextProperty structure and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the value field, use @@ -1052,7 +1052,7 @@ To free the storage for the value field, use To obtain a list of strings from a specified -XTextProperty +XTextProperty structure in the STRING encoding, use XTextPropertyToStringList. XTextPropertyToStringList @@ -1074,7 +1074,7 @@ structure in the STRING encoding, use Specifies the -XTextProperty +XTextProperty structure to be used. @@ -1109,7 +1109,7 @@ The XTextPropertyToStringList function returns a list of strings representing the null-separated elements of the specified -XTextProperty +XTextProperty structure. The data in text_prop must be of type STRING and format 8. Multiple elements of the property @@ -1225,7 +1225,7 @@ Specifies the window. Specifies the -XTextProperty +XTextProperty structure to be used. @@ -1251,7 +1251,7 @@ function replaces the existing specified property for the named window with the data, type, format, and number of items determined by the value field, the encoding field, the format field, and the nitems field, respectively, of the specified -XTextProperty +XTextProperty structure. If the property does not already exist, XSetTextProperty @@ -1261,11 +1261,11 @@ sets it for the specified window. XSetTextProperty can generate -BadAlloc, -BadAtom, -BadValue, +BadAlloc, +BadAtom, +BadValue, and -BadWindow +BadWindow errors. @@ -1313,7 +1313,7 @@ Specifies the window. Returns the -XTextProperty +XTextProperty structure. @@ -1337,7 +1337,7 @@ The XGetTextProperty function reads the specified property from the window and stores the data in the returned -XTextProperty +XTextProperty structure. It stores the data in the value field, the type of the data in the encoding field, @@ -1351,14 +1351,14 @@ If the specified property does not exist on the window, XGetTextProperty sets the value field to NULL, the encoding field to -None, +None, the format field to zero, and the nitems field to zero. If it was able to read and store the data in the -XTextProperty +XTextProperty structure, XGetTextProperty returns a nonzero status; @@ -1368,9 +1368,9 @@ otherwise, it returns a zero status. XGetTextProperty can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. @@ -1428,7 +1428,7 @@ Specifies the window. Specifies the -XTextProperty +XTextProperty structure to be used. @@ -1488,7 +1488,7 @@ Specifies the window. Returns the -XTextProperty +XTextProperty structure. @@ -1585,9 +1585,9 @@ the result is implementation-dependent. XStoreName can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -1663,7 +1663,7 @@ the window name string using XFetchName can generate a -BadWindow +BadWindow error. @@ -1722,7 +1722,7 @@ Specifies the window. Specifies the -XTextProperty +XTextProperty structure to be used. @@ -1783,7 +1783,7 @@ Specifies the window. Returns the -XTextProperty +XTextProperty structure. @@ -1870,9 +1870,9 @@ If the string is not in the Host Portable Character Encoding, the result is implementation-dependent. XSetIconName can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -1948,7 +1948,7 @@ the icon name string using XGetIconName can generate a -BadWindow +BadWindow error. @@ -1962,7 +1962,7 @@ error. 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 -XWMHints +XWMHints structure, as defined in the header file. @@ -1971,7 +1971,7 @@ header file. To allocate an -XWMHints +XWMHints structure, use XAllocWMHints. @@ -1986,10 +1986,10 @@ structure, use The XAllocWMHints function allocates and returns a pointer to an -XWMHints +XWMHints structure. Note that all fields in the -XWMHints +XWMHints structure are initially set to zero. If insufficient memory is available, XAllocWMHints @@ -2001,7 +2001,7 @@ use The -XWMHints +XWMHints structure contains: @@ -2045,32 +2045,32 @@ Applications that expect input but never explicitly set focus to any of their subwindows (that is, use the push model of focus management), such as X Version 10 style applications that use real-estate driven focus, should set this member to -True. +True. Similarly, applications that set input focus to their subwindows only when it is given to their top-level window by a window manager should also set this member to -True. +True. Applications that manage their own input focus by explicitly setting focus to one of their subwindows whenever they want keyboard input (that is, use the pull model of focus management) should set this member to -False. +False. Applications that never expect any keyboard input also should set this member to -False. +False. 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 -True. +True. Push model window managers should make sure that pull model applications do not break them by resetting input focus to -PointerRoot +PointerRoot when it is appropriate (for example, whenever an application whose input member is -False +False sets input focus to one of its subwindows). @@ -2101,7 +2101,7 @@ rather than just the one window. The -UrgencyHint +UrgencyHint 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 manager will make some effort to draw the user's attention to this @@ -2154,7 +2154,7 @@ Specifies the window. Specifies the -XWMHints +XWMHints structure to be used. @@ -2174,9 +2174,9 @@ window manager to get keyboard input. XSetWMHints can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -2225,7 +2225,7 @@ The 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 -XWMHints +XWMHints structure if it succeeds. When finished with the data, free the space used for it by calling @@ -2235,7 +2235,7 @@ free the space used for it by calling XGetWMHints can generate a -BadWindow +BadWindow error. @@ -2249,7 +2249,7 @@ error. 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 -XSizeHints +XSizeHints structure, as defined in the header file. @@ -2257,7 +2257,7 @@ header file. The size of the -XSizeHints +XSizeHints structure may grow in future releases, as new components are added to support new ICCCM features. Passing statically allocated instances of this structure into @@ -2270,7 +2270,7 @@ instances of the structure be used. To allocate an -XSizeHints +XSizeHints structure, use XAllocSizeHints. @@ -2284,10 +2284,10 @@ XSizeHints *XAllocSizeHints() The XAllocSizeHints function allocates and returns a pointer to an -XSizeHints +XSizeHints structure. Note that all fields in the -XSizeHints +XSizeHints structure are initially set to zero. If insufficient memory is available, XAllocSizeHints @@ -2299,7 +2299,7 @@ use The -XSizeHints +XSizeHints structure contains: @@ -2370,7 +2370,7 @@ in the absence of a window manager. Note that use of the -PAllHints +PAllHints macro is highly discouraged. @@ -2438,9 +2438,9 @@ The property is stored with a type of WM_SIZE_HINTS and a format of 32. XSetWMNormalHints can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -2515,7 +2515,7 @@ and is long enough to contain either an old (pre-ICCCM) or new size hints structure, XGetWMNormalHints sets the various fields of the -XSizeHints +XSizeHints structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. @@ -2551,7 +2551,7 @@ PBaseSize|PWinGravity XGetWMNormalHints can generate a -BadWindow +BadWindow error. @@ -2599,7 +2599,7 @@ Specifies the window. Specifies the -XSizeHints +XSizeHints structure to be used. @@ -2637,10 +2637,10 @@ function. XSetWMSizeHints can generate -BadAlloc, -BadAtom, +BadAlloc, +BadAtom, and -BadWindow +BadWindow errors. @@ -2689,7 +2689,7 @@ Specifies the window. Returns the -XSizeHints +XSizeHints structure. @@ -2728,7 +2728,7 @@ and is long enough to contain either an old (pre-ICCCM) or new size hints structure, XGetWMSizeHints sets the various fields of the -XSizeHints +XSizeHints structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), @@ -2769,9 +2769,9 @@ PBaseSize|PWinGravity XGetWMSizeHints can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. @@ -2785,7 +2785,7 @@ errors. Xlib provides functions that you can use to set and get the WM_CLASS property for a given window. These functions use the -XClassHint +XClassHint structure, which is defined in the header file. @@ -2794,7 +2794,7 @@ header file. To allocate an -XClassHint +XClassHint structure, use XAllocClassHint. XAllocClassHint @@ -2811,10 +2811,10 @@ structure, use The XAllocClassHint function allocates and returns a pointer to an -XClassHint +XClassHint structure. Note that the pointer fields in the -XClassHint +XClassHint structure are initially set to NULL. If insufficient memory is available, XAllocClassHint @@ -2826,7 +2826,7 @@ use The -XClassHint +XClassHint contains: @@ -2900,7 +2900,7 @@ Specifies the window. Specifies the -XClassHint +XClassHint structure that is to be used. @@ -2920,9 +2920,9 @@ the result is implementation-dependent. XSetClassHint can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -2969,7 +2969,7 @@ Specifies the window. Returns the -XClassHint +XClassHint structure. @@ -2997,7 +2997,7 @@ on each individually. XGetClassHint can generate a -BadWindow +BadWindow error. @@ -3072,9 +3072,9 @@ specified prop_window. XSetTransientForHint can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -3139,7 +3139,7 @@ otherwise, it returns a zero status. XGetTransientForHint can generate a -BadWindow +BadWindow error. @@ -3235,9 +3235,9 @@ Otherwise, it returns a nonzero status. XSetWMProtocols can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -3325,7 +3325,7 @@ To release the list of atoms, use XGetWMProtocols can generate a -BadWindow +BadWindow error. @@ -3421,9 +3421,9 @@ Otherwise, it returns a nonzero status. XSetWMColormapWindows can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -3511,7 +3511,7 @@ To release the list of window identifiers, use XGetWMColormapWindows can generate a -BadWindow +BadWindow error. @@ -3525,7 +3525,7 @@ error. Xlib provides functions that you can use to set and read the WM_ICON_SIZE property for a given window. These functions use the -XIconSize +XIconSize XIconSize structure, which is defined in the @@ -3535,7 +3535,7 @@ header file. To allocate an -XIconSize +XIconSize structure, use XAllocIconSize. @@ -3550,10 +3550,10 @@ structure, use The XAllocIconSize function allocates and returns a pointer to an -XIconSize +XIconSize structure. Note that all fields in the -XIconSize +XIconSize structure are initially set to zero. If insufficient memory is available, XAllocIconSize @@ -3565,7 +3565,7 @@ use The -XIconSize +XIconSize structure contains: @@ -3659,9 +3659,9 @@ function is used only by window managers to set the supported icon sizes. XSetIconSizes can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -3747,7 +3747,7 @@ To free the data allocated in size_list_return, use XGetIconSizes can generate a -BadWindow +BadWindow error. @@ -3863,7 +3863,7 @@ Specifies the size hints for the window in its normal state. Specifies the -XWMHints +XWMHints structure to be used. @@ -3875,7 +3875,7 @@ structure to be used. Specifies the -XClassHint +XClassHint structure to be used. @@ -3939,7 +3939,7 @@ If the class_hints argument is non-NULL, XmbSetWMProperties sets the WM_CLASS property. If the res_name member in the -XClassHint +XClassHint 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. @@ -3970,9 +3970,9 @@ and is converted to STRING for storage in the property. XmbSetWMProperties can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -4081,7 +4081,7 @@ Specifies the size hints for the window in its normal state. Specifies the -XWMHints +XWMHints structure to be used. @@ -4093,7 +4093,7 @@ structure to be used. Specifies the -XClassHint +XClassHint structure to be used. @@ -4153,7 +4153,7 @@ calls XSetClassHint, which sets the WM_CLASS property (see section 14.1.8). If the res_name member in the -XClassHint +XClassHint structure is set to the NULL pointer and the RESOURCE_NAME environment variable is set, then the value of the environment variable is substituted for res_name. @@ -4167,9 +4167,9 @@ any directory prefixes, is substituted for res_name. XSetWMProperties can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -4280,9 +4280,9 @@ the result is implementation-dependent. XSetCommand can generate -BadAlloc +BadAlloc and -BadWindow +BadWindow errors. @@ -4420,7 +4420,7 @@ Specifies the window. Specifies the -XTextProperty +XTextProperty structure to be used. @@ -4480,7 +4480,7 @@ Specifies the window. Returns the -XTextProperty +XTextProperty structure. @@ -4605,7 +4605,7 @@ Applications should use the standard colormaps if they already exist. To allocate an -XStandardColormap +XStandardColormap structure, use XAllocStandardColormap. @@ -4619,10 +4619,10 @@ XStandardColormap *XAllocStandardColormap() The XAllocStandardColormap function allocates and returns a pointer to an -XStandardColormap +XStandardColormap structure. Note that all fields in the -XStandardColormap +XStandardColormap structure are initially set to zero. If insufficient memory is available, XAllocStandardColormap @@ -4634,7 +4634,7 @@ use The -XStandardColormap +XStandardColormap structure contains: @@ -4707,13 +4707,13 @@ using the following expression: For -GrayScale +GrayScale colormaps, only the colormap, red_max, red_mult, and base_pixel members are defined. The other members are ignored. To compute a -GrayScale +GrayScale pixel value, use the following expression: @@ -4748,7 +4748,7 @@ function on the indicated resource. The properties containing the -XStandardColormap +XStandardColormap information have the type RGB_COLOR_MAP. @@ -4786,7 +4786,7 @@ which are prefixed with XA_. This atom names a property. The value of the property is an array of -XStandardColormap +XStandardColormap structures. Each entry in the array describes an RGB subset of the default color map for the Visual specified by visual_id. @@ -4813,7 +4813,7 @@ for text, borders, and so on. This atom names a property. The value of the property is an -XStandardColormap. +XStandardColormap. The property defines the best RGB colormap available on @@ -4827,11 +4827,11 @@ red, as well as more green or red than blue. For an 8-plane -PseudoColor +PseudoColor visual, RGB_BEST_MAP is likely to be a 3/3/2 allocation. For a 24-plane -DirectColor +DirectColor visual, RGB_BEST_MAP is normally an 8/8/8 allocation. @@ -4843,7 +4843,7 @@ RGB_BEST_MAP is normally an 8/8/8 allocation. These atoms name properties. The value of each property is an -XStandardColormap. +XStandardColormap. The properties define all-red, all-green, and all-blue @@ -4863,17 +4863,17 @@ and once with blue) and by multiply exposing a single frame in a camera. This atom names a property. The value of the property is an -XStandardColormap. +XStandardColormap. The property describes the best -GrayScale +GrayScale colormap available on the screen. As previously mentioned, only the colormap, red_max, red_mult, and base_pixel members of the -XStandardColormap +XStandardColormap structure are used for -GrayScale +GrayScale colormaps. @@ -4890,14 +4890,14 @@ colormaps. Xlib provides functions that you can use to set and obtain an -XStandardColormap +XStandardColormap structure. To set an -XStandardColormap +XStandardColormap structure, use XSetRGBColormaps. XSetRGBColormaps @@ -4941,7 +4941,7 @@ Specifies the window. Specifies the -XStandardColormap +XStandardColormap structure to be used. @@ -5027,7 +5027,7 @@ Determine the color characteristics of the visual. Allocate cells in the colormap (or create it with -AllocAll). +AllocAll). @@ -5040,7 +5040,7 @@ to store appropriate color values in the colormap. Fill in the descriptive members in the -XStandardColormap +XStandardColormap structure. @@ -5067,17 +5067,17 @@ Ungrab the server. XSetRGBColormaps can generate -BadAlloc, -BadAtom, +BadAlloc, +BadAtom, and -BadWindow +BadWindow errors. To obtain the -XStandardColormap +XStandardColormap structure associated with the specified property, use XGetRGBColormaps. XGetRGBColormaps @@ -5121,7 +5121,7 @@ Specifies the window. Returns the -XStandardColormap +XStandardColormap structure. @@ -5165,7 +5165,7 @@ If the visualid is not present, XGetRGBColormaps assumes the default visual for the screen on which the window is located; if the killid is not present, -None +None is assumed, which indicates that the resources cannot be released. Otherwise, none of the fields are set, and @@ -5178,9 +5178,9 @@ restriction that only RGB_DEFAULT_MAP contain more than one definition. XGetRGBColormaps can generate -BadAtom +BadAtom and -BadWindow +BadWindow errors. diff --git a/specs/libX11/CH15.xml b/specs/libX11/CH15.xml index 7cf78edc..50b1eae6 100644 --- a/specs/libX11/CH15.xml +++ b/specs/libX11/CH15.xml @@ -337,7 +337,7 @@ in many of the resource manager functions. Simple comparisons can be performed rather than string comparisons. The shorthand name for a string is called a quark and is the type -XrmQuark. +XrmQuark. On some occasions, you may want to allocate a quark that has no string equivalent. @@ -368,7 +368,7 @@ is known to the resource manager. Each name, class, and representation type is typedef'd as an -XrmQuark. +XrmQuark. @@ -567,7 +567,7 @@ the conversion is implementation-dependent. A binding list is a list of type -XrmBindingList +XrmBindingList and indicates if components of name or class lists are bound tightly or loosely (that is, if wildcarding of intermediate components is specified). @@ -579,9 +579,9 @@ typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList; -XrmBindTightly +XrmBindTightly indicates that a period separates the components, and -XrmBindLoosely +XrmBindLoosely indicates that an asterisk separates the components. @@ -668,9 +668,9 @@ bindings: loose tight loose XrmDatabase A resource database is an opaque type, -XrmDatabase. +XrmDatabase. Each database value is stored in an -XrmValue +XrmValue structure. This structure consists of a size, an address, and a representation type. The size is specified in bytes. @@ -678,7 +678,7 @@ The representation 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 -XrmValue +XrmValue structure is defined as: @@ -1163,7 +1163,7 @@ If the same specifier is used for an entry in both the file and the database, the entry in the file will replace the entry in the database if override is -True; +True; otherwise, the entry in the file is discarded. The file is parsed in the current locale. If the file cannot be read, @@ -1235,7 +1235,7 @@ function merges the contents of one database into another. If the same specifier is used for an entry in both databases, the entry in the source_db will replace the entry in the target_db if override is -True; +True; otherwise, the entry in source_db is discarded. If target_db contains NULL, XrmCombineDatabase @@ -1293,7 +1293,7 @@ Calling the function is equivalent to calling the XrmCombineDatabase function with an override argument of -True. +True. @@ -1477,9 +1477,9 @@ If a resource was found, both and XrmQGetResource return -True; +True; otherwise, they return -False. +False. @@ -1586,9 +1586,9 @@ for determining precedence. If list_return was large enough for the search list, XrmQGetSearchList returns -True; +True; otherwise, it returns -False. +False. @@ -1688,10 +1688,10 @@ that is fully identified by the specified name and class. The search stops with the first match. XrmQGetSearchResource returns -True +True if the resource was found; otherwise, it returns -False. +False. @@ -2015,7 +2015,7 @@ If database contains NULL, creates a new database and returns a pointer to it. XrmQPutStringResource is a convenience routine that constructs an -XrmValue +XrmValue for the value string (by calling strlen to compute the size) and @@ -2077,7 +2077,7 @@ 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 -ResourceName +ResourceName is not in the Host Portable Character Encoding, the result is implementation-dependent. Note that comment lines are not stored. @@ -2185,20 +2185,20 @@ function calls the specified procedure for each resource in the database that would match some completion of the given name/class resource prefix. The order in which resources are found is implementation-dependent. If mode is -XrmEnumOneLevel, +XrmEnumOneLevel, a resource must match the given name/class prefix with just a single name and class appended. If mode is -XrmEnumAllLevels, +XrmEnumAllLevels, the resource must match the given name/class prefix with one or more names and classes appended. If the procedure returns -True, +True, the enumeration terminates and the function returns -True. +True. If the procedure always returns -False, +False, all matching resources are enumerated and the function returns -False. +False. @@ -2223,7 +2223,7 @@ The procedure is called with the following arguments: The bindings and quarks lists are terminated by -NULLQUARK. +NULLQUARK. Note that pointers to the database and type are passed, but these values should not be modified. @@ -2271,14 +2271,14 @@ typedef enum { Note that -XrmoptionSkipArg +XrmoptionSkipArg is equivalent to -XrmoptionSkipNArgs +XrmoptionSkipNArgs with the -XrmOptionDescRec.value +XrmOptionDescRec.value field containing the value one. Note also that the value zero for -XrmoptionSkipNArgs +XrmoptionSkipNArgs indicates that only the option itself is to be skipped. @@ -2404,7 +2404,7 @@ in the order they occur in argv. The table entries contain information on the option string, the option name, the style of option, and a value to provide if the option kind is -XrmoptionNoArg. +XrmoptionNoArg. 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 diff --git a/specs/libX11/CH16.xml b/specs/libX11/CH16.xml index 6857a85a..bfc01ca1 100644 --- a/specs/libX11/CH16.xml +++ b/specs/libX11/CH16.xml @@ -113,9 +113,9 @@ To obtain a KeySym for the KeyCode of an event, use Specifies the -KeyPress +KeyPress or -KeyRelease +KeyRelease event. @@ -139,14 +139,14 @@ The XLookupKeysym 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 -XKeyPressedEvent +XKeyPressedEvent or -XKeyReleasedEvent +XKeyReleasedEvent structure. If no KeySym is defined for the KeyCode of the event, XLookupKeysym returns -NoSymbol. +NoSymbol. @@ -208,7 +208,7 @@ the element of the KeyCode vector. If no symbol is defined, XKeycodeToKeysym returns -NoSymbol. +NoSymbol. @@ -292,11 +292,11 @@ The XRefreshKeyboardMapping function refreshes the stored modifier and keymap information. You usually call this function when a -MappingNotify +MappingNotify event with a request member of -MappingKeyboard +MappingKeyboard or -MappingModifier +MappingModifier occurs. The result is to update Xlib's knowledge of the keyboard. @@ -408,7 +408,7 @@ the result is implementation-dependent. If the specified string does not match a valid KeySym, XStringToKeysym returns -NoSymbol. +NoSymbol. @@ -479,7 +479,7 @@ Specifies the KeySym that is to be tested. IsCursorKey Returns -True +True if the specified KeySym is a cursor key. @@ -506,7 +506,7 @@ Specifies the KeySym that is to be tested. IsFunctionKey Returns -True +True if the specified KeySym is a function key. @@ -533,7 +533,7 @@ Specifies the KeySym that is to be (Fn. IsKeypadKey Returns -True +True if the specified KeySym is a standard keypad key. @@ -559,7 +559,7 @@ Specifies the KeySym that is to be (Fn. IsPrivateKeypadKey Returns -True +True if the specified KeySym is a vendor-private keypad key. @@ -587,7 +587,7 @@ Specifies the KeySym that is to be (Fn. IsMiscFunctionKey Returns -True +True if the specified KeySym is a miscellaneous function key. @@ -613,7 +613,7 @@ Specifies the KeySym that is to be tested. IsModifierKey Returns -True +True if the specified KeySym is a modifier key. @@ -637,7 +637,7 @@ Specifies the KeySym that is to be tested. IsPFKey Returns -True +True if the specified KeySym is a PF key. @@ -685,9 +685,9 @@ To map a key event to an ISO Latin-1 string, use Specifies the key event structure to be used. You can pass -XKeyPressedEvent +XKeyPressedEvent or -XKeyReleasedEvent. +XKeyReleasedEvent. @@ -729,7 +729,7 @@ Returns the KeySym computed from the event if this argument is not NULL. Specifies or returns the -XComposeStatus +XComposeStatus structure or NULL. @@ -743,8 +743,8 @@ The XLookupString function translates a key event to a KeySym and a string. The KeySym is obtained by using the standard interpretation of the -Shift, -Lock, +Shift, +Lock, group, and numlock modifiers as defined in the X Protocol specification. If the KeySym has been rebound (see XRebindKeysym), @@ -759,14 +759,14 @@ returns the number of characters that are stored in the buffer. If present (non-NULL), the -XComposeStatus +XComposeStatus structure records the state, which is private to Xlib, that needs preservation across calls to XLookupString to implement compose processing. The creation of -XComposeStatus +XComposeStatus structures is implementation-dependent; a portable program must pass NULL for this argument. @@ -1029,13 +1029,13 @@ 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 -XValue, -YValue, -WidthValue, -HeightValue, -XNegative, +XValue, +YValue, +WidthValue, +HeightValue, +XNegative, or -YNegative +YNegative and are defined in They will be set whenever one of the values is defined @@ -1044,9 +1044,9 @@ or one of the signs is set. If the function returns either the -XValue +XValue or -YValue +YValue flag, you should place the window at the requested position. @@ -1198,14 +1198,14 @@ function combines any geometry information (given in the format used by 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 -(NorthWestGravity, -NorthEastGravity, -SouthEastGravity, +(NorthWestGravity, +NorthEastGravity, +SouthEastGravity, or -SouthWestGravity) +SouthWestGravity) that describe the window. If the base size is not set in the -XSizeHints +XSizeHints structure, the minimum size is used if set. Otherwise, a base size of zero is assumed. @@ -1237,7 +1237,7 @@ as gravity_return to update the hints directly. Regions are arbitrary sets of pixel locations. Xlib provides functions for manipulating regions. The opaque type -Region +Region is defined in Xlib provides functions that you can use to manipulate regions. @@ -1331,9 +1331,9 @@ Specifies the number of points in the polygon. Specifies the fill-rule you want to set for the specified GC. You can pass -EvenOddRule +EvenOddRule or -WindingRule. +WindingRule. @@ -1906,7 +1906,7 @@ Specifies the region. The XEmptyRegion function returns -True +True if the region is empty. @@ -1953,7 +1953,7 @@ Specify the two regions. The XEqualRegion function returns -True +True if the two regions have the same offset, size, and shape. @@ -2017,7 +2017,7 @@ Specify the x and y coordinates(Xy. The XPointInRegion function returns -True +True if the point (x, y) is contained in the region r. @@ -2099,12 +2099,12 @@ Specify the width and height(Wh. The XRectInRegion function returns -RectangleIn +RectangleIn if the rectangle is entirely in the specified region, -RectangleOut +RectangleOut if the rectangle is entirely out of the specified region, and -RectanglePart +RectanglePart if the rectangle is partially in the specified region. @@ -2194,7 +2194,7 @@ any client calling XStoreBytes can generate a -BadAlloc +BadAlloc error. @@ -2269,7 +2269,7 @@ and need not be null-terminated. XStoreBuffer can generate a -BadAlloc +BadAlloc error. @@ -2433,7 +2433,7 @@ This cut buffer numbering is global to the display. Note that XRotateBuffers generates -BadMatch +BadMatch errors if any of the eight buffers have not been created. @@ -2453,7 +2453,7 @@ which visual to use for your application. The functions in this section use the visual information masks and the -XVisualInfo +XVisualInfo structure, which is defined in @@ -2672,7 +2672,7 @@ returns zero. Xlib provides several functions that perform basic operations on images. All operations on images are defined using an -XImage +XImage structure, as defined in @@ -2701,7 +2701,7 @@ to and from disk files. The -XImage +XImage structure describes an image as it exists in the client's memory. The user can request that some of the members such as height, width, and xoffset be changed when the image is sent to the server. @@ -2716,7 +2716,7 @@ 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 -XImage +XImage structure, see section 8.7. @@ -2724,7 +2724,7 @@ see section 8.7. To allocate an -XImage +XImage structure and initialize it with image format values from a display, use XCreateImage. XCreateImage @@ -2763,7 +2763,7 @@ Specifies the connection to the X server. Specifies the -Visual +Visual structure. @@ -2786,10 +2786,10 @@ Specifies the depth of the image. Specifies the format for the image. You can pass -XYBitmap, -XYPixmap, +XYBitmap, +XYPixmap, or -ZPixmap. +ZPixmap. @@ -2864,16 +2864,16 @@ the start of one scanline and the start of the next. The XCreateImage function allocates the memory needed for an -XImage +XImage 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 -XImage +XImage structure. The red, green, and blue mask values are defined for Z format images only and are derived from the -Visual +Visual structure passed in. Other values also are passed in. The offset permits the rapid displaying of the image without requiring each @@ -3114,7 +3114,7 @@ The XSubImage function creates a new image that is a subsection of an existing one. It allocates the memory necessary for the new -XImage +XImage structure and returns a pointer to the new image. The data is copied from the source image, @@ -3203,7 +3203,7 @@ Specifies the image. The XDestroyImage function deallocates the memory associated with the -XImage +XImage structure. @@ -3375,16 +3375,16 @@ is implementation-dependent. If the file cannot be opened, XReadBitmapFile returns -BitmapOpenFailed. +BitmapOpenFailed. If the file can be opened but does not contain valid bitmap data, it returns -BitmapFileInvalid. +BitmapFileInvalid. If insufficient working storage is allocated, it returns -BitmapNoMemory. +BitmapNoMemory. If the file is readable and valid, it returns -BitmapSuccess. +BitmapSuccess. @@ -3406,10 +3406,10 @@ otherwise, it returns \-1,\-1. XReadBitmapFile can generate -BadAlloc, -BadDrawable, +BadAlloc, +BadDrawable, and -BadGC +BadGC errors. @@ -3615,14 +3615,14 @@ by deleting the directory prefix. The file is written in the encoding of the current locale. If the file cannot be opened for writing, it returns -BitmapOpenFailed. +BitmapOpenFailed. If insufficient memory is allocated, XWriteBitmapFile returns -BitmapNoMemory; +BitmapNoMemory; otherwise, on no error, it returns -BitmapSuccess. +BitmapSuccess. If x_hot and y_hot are not \-1, \-1, XWriteBitmapFile writes them out as the hotspot coordinates for the bitmap. @@ -3631,9 +3631,9 @@ writes them out as the hotspot coordinates for the bitmap. XWriteBitmapFile can generate -BadDrawable +BadDrawable and -BadMatch +BadMatch errors. @@ -3751,18 +3751,18 @@ function creates a pixmap of the given depth and then does a bitmap-format of the data into it. The depth must be supported by the screen of the specified drawable, or a -BadMatch +BadMatch error results. XCreatePixmapFromBitmapData can generate -BadAlloc, -BadDrawable, -BadGC, +BadAlloc, +BadDrawable, +BadGC, and -BadValue +BadValue errors. @@ -3846,7 +3846,7 @@ Specify the width and height. The XCreateBitmapFromData function allows you to include in your C program (using -#include) +#include) a bitmap file that was written out by XWriteBitmapFile (X version 11 format only) without reading in the bitmap file. @@ -3866,7 +3866,7 @@ bitmap = XCreateBitmapFromData(display, window, gray_bits, gray_width, gray_heig If insufficient working storage was allocated, XCreateBitmapFromData returns -None. +None. It is your responsibility to free the bitmap using XFreePixmap @@ -3876,9 +3876,9 @@ when finished. XCreateBitmapFromData can generate -BadAlloc +BadAlloc and -BadGC +BadGC errors. @@ -3982,7 +3982,7 @@ The function returns a nonzero error code if an error has occurred and zero otherwise. Possible errors are -XCNOMEM +XCNOMEM (out of memory). @@ -4055,7 +4055,7 @@ The function returns a nonzero error code if an error has occurred and zero otherwise. Possible errors are -XCNOENT +XCNOENT (context-not-found). diff --git a/specs/libX11/glossary.xml b/specs/libX11/glossary.xml index 517f359b..69142d61 100644 --- a/specs/libX11/glossary.xml +++ b/specs/libX11/glossary.xml @@ -52,7 +52,7 @@ Atoms are used to identify properties, types, and selections. Background An -InputOutput +InputOutput window can have a background, which is defined as a pixmap. When regions of the window have their contents lost or invalidated, @@ -78,20 +78,20 @@ the pixels saved off-screen are known as a backing store. A font name used to select a family of fonts whose members may be encoded in various charsets. The -CharSetRegistry +CharSetRegistry and -CharSetEncoding +CharSetEncoding 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 -CharSetRegistry, +CharSetRegistry, with or without the thirteenth '-', or a non-XLFD name. Any XLFD fields may contain wild cards. When creating an -XFontSet, +XFontSet, 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 @@ -138,7 +138,7 @@ A bitmap is a pixmap of depth o Border An -InputOutput +InputOutput window can have a border of equal thickness 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. @@ -413,7 +413,7 @@ and the pointer. DirectColor -DirectColor +DirectColor 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 produce red intensity values. @@ -431,7 +431,7 @@ changed dynamically. A server, together with its screens and input devices, is called a display. The Xlib -Display +Display Displaystructure structure contains all information about the particular display and its screens as well as the state that Xlib needs to communicate with the display over a @@ -448,7 +448,7 @@ 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 -InputOnly +InputOnly window cannot be used as a source or destination in a graphics operation. @@ -471,9 +471,9 @@ sets, and the X Compound Text encoding. In X, encodings are identified by a string which appears as: the -CharSetRegistry +CharSetRegistry and -CharSetEncoding +CharSetEncoding 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 @@ -688,9 +688,9 @@ See Bit gravity and GrayScale -GrayScale +GrayScale can be viewed as a degenerate case of -PseudoColor, +PseudoColor, 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. @@ -775,14 +775,14 @@ client, which usually is part of a window manager. WindowInputOnly An -InputOnly +InputOnly window is a window that cannot be used for graphics requests. -InputOnly +InputOnly windows are invisible and are used to control such things as cursors, input event generation, and grabbing. -InputOnly +InputOnly windows cannot have -InputOutput +InputOutput windows as inferiors. @@ -793,13 +793,13 @@ windows as inferiors. WindowInputOutput An -InputOutput +InputOutput window is the normal kind of window that is used for both input and output. -InputOutput +InputOutput windows can have both -InputOutput +InputOutput and -InputOnly +InputOnly windows as inferiors. @@ -964,7 +964,7 @@ ShiftLock, and similar keys are called modifier keys. Monochrome Monochrome is a special case of -StaticGray +StaticGray in which there are only two colormap entries. @@ -991,7 +991,7 @@ imply only that the strings may contain multibyte 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 -InputOutput +InputOutput 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. @@ -1013,7 +1013,7 @@ 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 -InputOnly +InputOnly windows never obscure other windows but can occlude other windows. @@ -1186,7 +1186,7 @@ been defined for the window. PseudoColor -PseudoColor +PseudoColor is a class of colormap in which a pixel value indexes the colormap entry to produce an independent RGB value; that is, the colormap is viewed as an array of triples (RGB values). @@ -1341,11 +1341,11 @@ 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 -Screen +Screen Screenstructure structure contains the information about that screen and is linked to the -Display +Display Displaystructure structure. @@ -1474,9 +1474,9 @@ this means use of at most single shifts, not locking shifts. StaticColor -StaticColor +StaticColor can be viewed as a degenerate case of -PseudoColor +PseudoColor in which the RGB values are predefined and read-only. @@ -1486,9 +1486,9 @@ in which the RGB values are predefined and read-only. StaticGray -StaticGray +StaticGray can be viewed as a degenerate case of -GrayScale +GrayScale in which the gray values are predefined and read-only. The values are typically linear or near-linear increasing ramps. @@ -1565,7 +1565,7 @@ always interprets timestamps from clients by treating half of the timestamp space as being earlier in time than T and half of the timestamp space as being later in time than T. One timestamp value, represented by the constant -CurrentTime, +CurrentTime, is never generated by the server. This value is reserved for use in requests to represent the current server time. @@ -1576,9 +1576,9 @@ This value is reserved for use in requests to represent the current server time. TrueColor -TrueColor +TrueColor can be viewed as a degenerate case of -DirectColor +DirectColor in which the subfields in the pixel value directly encode the corresponding RGB values. That is, the colormap has predefined read-only RGB values.