diff --git a/specs/libX11/AppC.xml b/specs/libX11/AppC.xml index 420d7f90..35f9bac5 100644 --- a/specs/libX11/AppC.xml +++ b/specs/libX11/AppC.xml @@ -41,7 +41,7 @@ Basic Protocol Support Routines The basic protocol requests for extensions are XQueryExtension and -XListExtensions . +XListExtensions. XQueryExtension @@ -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; @@ -198,7 +198,7 @@ Specifies the list of extension names. The XFreeExtensionList function frees the memory allocated by -XListExtensions . +XListExtensions. Hooking into Xlib @@ -801,15 +801,15 @@ functions allow you to define new events to the library. An 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 ) +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 protocol request. @@ -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 @@ -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. @@ -1173,9 +1173,9 @@ If the error is to be completely ignored by Xlib (for example, several protocol error structures will be combined into one Xlib error), then the function should return -False ; +False; otherwise, it should return -True . +True. XESetError @@ -1232,7 +1232,7 @@ case, and are typically programmed to be synchronous). When Xlib detects a protocol error in -_XReply , +_XReply, it calls your procedure with these arguments: @@ -1425,7 +1425,7 @@ The structure pointed at by ev is guaranteed to be as large as an structure and so can be cast to a type larger than an XErrorEvent to obtain additional values set by using -XESetWireToError . +XESetWireToError. The underlying type of the fp argument is system dependent; on a POSIX-compliant system, fp should be cast to type FILE*. XESetFlushGC @@ -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. @@ -1650,11 +1650,11 @@ The function returns a pointer to the list of extension structures attached to the specified object. In concert with -XAddToExtensionList , +XAddToExtensionList, XEHeadOfExtensionList allows an extension to attach arbitrary data to any of the structures of types contained in -XEDataObject . +XEDataObject. @@ -1726,7 +1726,7 @@ Specifies the extension list. Specifies the extension number from -XInitExtension . +XInitExtension. @@ -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 @@ -2174,16 +2174,16 @@ Instead, such requests use the 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. @@ -2280,9 +2280,9 @@ The reply structure is longer than 32 bytes. Only -GetWindowAttributes , -QueryFont , -QueryKeymap , +GetWindowAttributes, +QueryFont, +QueryKeymap, and GetKeyboardControl have reply structures longer than 32 bytes in the core protocol. @@ -2383,11 +2383,11 @@ Sending the Protocol Request and Arguments After the variable declarations, a stub procedure should call one of four macros defined in <X11/Xlibint.h>: -GetReq , -GetReqExtra , -GetResReq , +GetReq, +GetReqExtra, +GetResReq, or -GetEmptyReq . +GetEmptyReq. All of these macros take, as their first argument, the name of the protocol request as declared in <X11/Xproto.h> @@ -2404,7 +2404,7 @@ fills in its type and length field, and sets req to point to it. If the protocol request has no arguments (for instance, X_GrabServer), then use -GetEmptyReq . +GetEmptyReq. @@ -2413,13 +2413,13 @@ 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 . +GetResReq. The second argument to the macro is the 32-bit object. X_MapWindow is a good example. @@ -2431,17 +2431,17 @@ is a good example. GetResReq (DoSomething, rid, req); The rid argument is the -Pixmap , -Window , +Pixmap, +Window, or other resource ID. If the protocol request takes any other argument list, then call -GetReq . +GetReq. After the -GetReq , +GetReq, you need to set all the other fields in the request structure, usually from arguments to the stub procedure. @@ -2458,7 +2458,7 @@ req->arg2 = arg2; A few stub procedures (such as XCreateGC and -XCreatePixmap ) +XCreatePixmap) return a resource ID to the caller but pass a resource ID as an argument to the protocol request. Such procedures use the macro @@ -2479,13 +2479,13 @@ data after the request. Typically, these procedures (such as XMoveWindow and -XSetBackground ) +XSetBackground) are special cases of more general functions like XMoveResizeWindow and -XChangeGC . +XChangeGC. These procedures use -GetReqExtra , +GetReqExtra, which is the same as GetReq except that it takes an additional argument (the number of @@ -2528,7 +2528,7 @@ If it does not fit, however, the Data macro calls -_XSend , +_XSend, which transmits first the contents of the buffer and then your data. The Data @@ -2548,8 +2548,8 @@ and the number of bytes to be sent. -Data , -Data16 , +Data, +Data16, and Data32 are macros that may use their last argument @@ -2571,7 +2571,7 @@ macro. takes the same arguments, but because it sends your data immediately instead of copying it into the output buffer (which would later be flushed anyway by the following call on -_XReply ), +_XReply), it is faster. Replies @@ -2676,7 +2676,7 @@ A pointer to a reply structure (which must be cast to an The number of additional 32-bit words (beyond -sizeof( xReply ) +sizeof( xReply) = 32 bytes) in the reply structure @@ -2695,11 +2695,11 @@ beyond those it was told to read Because most reply structures are 32 bytes long, the third argument is usually 0. The only core protocol exceptions are the replies to -GetWindowAttributes , -QueryFont , -QueryKeymap , +GetWindowAttributes, +QueryFont, +QueryKeymap, and -GetKeyboardControl , +GetKeyboardControl, which have longer replies. @@ -2752,7 +2752,7 @@ If there is variable-length data after the reply, change the True to -False , +False, and use the appropriate _XRead function to read the variable-length data. @@ -3041,9 +3041,9 @@ 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 ), +XSynchronize), the request is sent immediately. The library, however, waits until any error the procedure could generate at the server has been handled. @@ -3120,7 +3120,7 @@ or Data families of macros, after any use of -_XReply , +_XReply, or after any use of the _XSend or @@ -3219,7 +3219,7 @@ Specifies the size of the buffer. You must pass back the same pointer and size that were returned by -_XAllocTemp . +_XAllocTemp. Portability Considerations @@ -3255,7 +3255,7 @@ in the protocol, be sure to declare it as unsigned int and not as -int . +int. (This, of course, does not apply to Booleans or enumerations.) @@ -3270,11 +3270,11 @@ declare it as an and not as int or -long . +long. This also goes for any internal variables that may take on values larger than the maximum 16-bit unsigned -int . +int. @@ -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. @@ -3327,7 +3327,7 @@ Call your initialization procedure and pass to it the display pointer. Once in your initialization procedure, call -XInitExtension ; +XInitExtension; if it succeeds, store the pointer returned into this array. Make sure to establish a close display handler to allow you to zero the entry. Do whatever other initialization your extension requires. diff --git a/specs/libX11/AppD.xml b/specs/libX11/AppD.xml index 7d358f98..25e23cae 100644 --- a/specs/libX11/AppD.xml +++ b/specs/libX11/AppD.xml @@ -47,7 +47,7 @@ Setting Standard Properties To specify a minimum set of properties describing the simplest application, use -XSetStandardProperties . +XSetStandardProperties. This function has been superseded by XSetWMProperties and sets all or portions of the @@ -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. @@ -167,7 +167,7 @@ should be used to give a window manager some information about your program's preferences. It should not be used by applications that need to communicate more information than is possible with -XSetStandardProperties . +XSetStandardProperties. (Typically, argv is the argv array of your main program.) If the strings are not in the Host Portable Character Encoding, the result is implementation-dependent. @@ -198,9 +198,9 @@ header file and use the WM_NORMAL_HINTS property. To set the size hints for a given window in its normal state, use -XSetNormalHints . +XSetNormalHints. This function has been superseded by -XSetWMNormalHints . +XSetWMNormalHints. XSetNormalHints @@ -287,9 +287,9 @@ errors. To return the size hints for a window in its normal state, use -XGetNormalHints . +XGetNormalHints. This function has been superseded by -XGetWMNormalHints . +XGetWMNormalHints. XGetNormalHints @@ -358,7 +358,7 @@ The next two functions set and read the WM_ZOOM_HINTS property. To set the zoom hints for a window, use -XSetZoomHints . +XSetZoomHints. This function is no longer supported by the Inter-Client Communication Conventions Manual. XSetZoomHints @@ -428,7 +428,7 @@ errors. To read the zoom hints for a window, use -XGetZoomHints . +XGetZoomHints. This function is no longer supported by the Inter-Client Communication Conventions Manual. XGetZoomHints @@ -495,9 +495,9 @@ error. To set the value of any property of type WM_SIZE_HINTS, use -XSetSizeHints . +XSetSizeHints. This function has been superseded by -XSetWMSizeHints . +XSetWMSizeHints. XSetSizeHints @@ -572,8 +572,8 @@ Thus, it may be useful if other properties of that type get defined. XSetSizeHints can generate -BadAlloc , -BadAtom , +BadAlloc, +BadAtom, and BadWindow errors. @@ -582,9 +582,9 @@ errors. To read the value of any property of type WM_SIZE_HINTS, use -XGetSizeHints . +XGetSizeHints. This function has been superseded by -XGetWMSizeHints . +XGetWMSizeHints. XGetSizeHints @@ -651,7 +651,7 @@ structure for the named property and the specified window. This is used by XGetNormalHints and -XGetZoomHints . +XGetZoomHints. It also can be used to retrieve the value of any property of type WM_SIZE_HINTS. Thus, it may be useful if other properties of that type get defined. @@ -675,9 +675,9 @@ Getting and Setting an XStandardColormap Structure To get the XStandardColormap structure associated with one of the described atoms, use -XGetStandardColormap . +XGetStandardColormap. This function has been superseded by -XGetRGBColormap . +XGetRGBColormap. XGetStandardColormap @@ -777,9 +777,9 @@ errors. To set a standard colormap, use -XSetStandardColormap . +XSetStandardColormap. This function has been superseded by -XSetRGBColormap . +XSetRGBColormap. XSetStandardColormap @@ -846,9 +846,9 @@ function usually is only used by window or session managers. XSetStandardColormap can generate -BadAlloc , -BadAtom , -BadDrawable , +BadAlloc, +BadAtom, +BadDrawable, and BadWindow errors. @@ -859,9 +859,9 @@ Parsing Window Geometry To parse window geometry given a user-specified position and a default position, use -XGeometry . +XGeometry. This function has been superseded by -XWMGeometry . +XWMGeometry. Windowdetermining location XGeometry @@ -1121,7 +1121,7 @@ function returns the value of the resource prog.< where prog is the program argument with the directory prefix removed and option must be a single component. Note that multilevel resources cannot be used with -XGetDefault . +XGetDefault. The class "Program.Name" is always used for the resource lookup. If the specified option name does not exist for this program, XGetDefault @@ -1133,11 +1133,11 @@ are owned by Xlib and should not be modified or freed by the client. If a database has been set with -XrmSetDatabase , +XrmSetDatabase, that database is used for the lookup. Otherwise, a database is created and is set in the display (as if by calling -XrmSetDatabase ). +XrmSetDatabase). The database is created in the current locale. To create a database, XGetDefault @@ -1147,7 +1147,7 @@ If no such property exists, a resource file in the user's home directory is used. On a POSIX-conformant system, this file is -"$HOME/.Xdefaults" . +"$HOME/.Xdefaults". Files$HOME/.Xdefaults After loading these defaults, XGetDefault @@ -1201,16 +1201,16 @@ is much faster. The functions discussed here provide all the functionality of the X Version 10 functions -XDraw , +XDraw, X10 compatibilityXDraw -XDrawFilled , +XDrawFilled, X10 compatibilityXDrawFilled -XDrawPatterned , +XDrawPatterned, X10 compatibilityXDrawPatterned -XDrawDashed , +XDrawDashed, X10 compatibilityXDrawDashed and -XDrawTiled . +XDrawTiled. X10 compatibilityXDrawTiled They are as compatible as possible given X Version 11's new line-drawing functions. @@ -1230,7 +1230,7 @@ Just how the graphics context you use is set up actually determines whether you get dashes or not, and so on. Lines are properly joined if they connect and include the closing of a closed figure (see -XDrawLines ). +XDrawLines). The functions discussed here fail (return zero) only if they run out of memory or are passed a Vertex @@ -1248,15 +1248,15 @@ set. To achieve the effects of the X Version 10 -XDraw , +XDraw, X10 compatibilityXDraw -XDrawDashed , +XDrawDashed, X10 compatibilityXDrawDashed and -XDrawPatterned , +XDrawPatterned, X10 compatibilityXDrawPatterned use -XDraw . +XDraw. @@ -1466,10 +1466,10 @@ To achieve the effects of the X Version 10 XDrawTiled X10 compatibilityXDrawTiled and -XDrawFilled , +XDrawFilled, X10 compatibilityXDrawFilled use -XDrawFilled . +XDrawFilled. #include <X11/X10.h> @@ -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). @@ -1623,9 +1623,9 @@ bucket. To return a pointer to a new -XAssocTable , +XAssocTable, use -XCreateAssocTable . +XCreateAssocTable. XCreateAssocTable @@ -1644,7 +1644,7 @@ use Specifies the number of buckets in the hash system of -XAssocTable . +XAssocTable. @@ -1655,7 +1655,7 @@ Specifies the number of buckets in the hash system of The size argument specifies the number of buckets in the hash system of -XAssocTable . +XAssocTable. For reasons of efficiency the number of buckets should be a power of two. Some size suggestions might be: use 32 buckets per 100 objects, @@ -1669,9 +1669,9 @@ a NULL pointer is returned. To create an entry in a given -XAssocTable , +XAssocTable, use -XMakeAssoc . +XMakeAssoc. XMakeAssoc @@ -1744,9 +1744,9 @@ the highest XID. To obtain data from a given -XAssocTable , +XAssocTable, use -XLookUpAssoc . +XLookUpAssoc. XLookUpAssoc @@ -1809,9 +1809,9 @@ it returns NULL. To delete an entry from a given -XAssocTable , +XAssocTable, use -XDeleteAssoc . +XDeleteAssoc. XDeleteAssoc @@ -1866,15 +1866,15 @@ function deletes an association in an keyed on its XID. Redundant deletes (and deletes of nonexistent XIDs) are ignored. Deleting associations in no way impairs the performance of an -XAssocTable . +XAssocTable. To free the memory associated with a given -XAssocTable , +XAssocTable, use -XDestroyAssocTable . +XDestroyAssocTable. XDestroyAssocTable diff --git a/specs/libX11/CH01.xml b/specs/libX11/CH01.xml index ed69c793..37dee914 100644 --- a/specs/libX11/CH01.xml +++ b/specs/libX11/CH01.xml @@ -153,7 +153,7 @@ which will be called when the error is reported. XSync If a client does not want a request to execute asynchronously, it can follow the request with a call to -XSync , +XSync, which blocks until all previously buffered asynchronous events have been sent and acted on. As an important side effect, @@ -171,13 +171,13 @@ that returns a value from the server or waits for input. Many Xlib functions will return an integer resource ID, which allows you to refer to objects stored on the X server. These can be of type -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 @@ -209,10 +209,10 @@ arrive asynchronously from the server and are queued until they are requested by an explicit call (for example, XNextEvent or -XWindowEvent ). +XWindowEvent). In addition, some library functions (for example, -XRaiseWindow ) +XRaiseWindow) generate Expose and @@ -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.) @@ -377,7 +377,7 @@ prior to inclusion of the file to obtain the associated values. The preprocessor symbols are XK_MISCELLANY, XK_XKB_KEYS, XK_3270, XK_LATIN1, XK_LATIN2, XK_LATIN3, XK_LATIN4, XK_KATAKANA, XK_ARABIC, XK_CYRILLIC, XK_GREEK, XK_TECHNICAL, XK_SPECIAL, XK_PUBLISHING, XK_APL, -XK_HEBREW, XK_THAI, and XK_KOREAN. +XK_HEBREW, XK_THAI, and XK_KOREAN. @@ -463,7 +463,7 @@ Xlib defines the type and the Boolean values True and -False . +False. None @@ -770,7 +770,7 @@ a..z A..Z 0..9 ._- Global symbols are printed in this special -font . +font. These can be either function names, symbols defined in include files, or structure names. When declared and defined, diff --git a/specs/libX11/CH02.xml b/specs/libX11/CH02.xml index 6c0321f5..0391ac2d 100644 --- a/specs/libX11/CH02.xml +++ b/specs/libX11/CH02.xml @@ -60,7 +60,7 @@ Use internal connections To open a connection to the X server that controls a display, use -XOpenDisplay . +XOpenDisplay. XOpenDisplay @@ -224,7 +224,7 @@ If XOpenDisplay does not succeed, it returns NULL. After a successful call to -XOpenDisplay , +XOpenDisplay, all of the screens in the display can be used by the client. The screen number specified in the display_name argument is returned by the @@ -293,11 +293,11 @@ Applications must never directly modify or inspect these private members of the structure. The -XDisplayWidth , -XDisplayHeight , -XDisplayCells , -XDisplayPlanes , -XDisplayWidthMM , +XDisplayWidth, +XDisplayHeight, +XDisplayCells, +XDisplayPlanes, +XDisplayWidthMM, and XDisplayHeightMM functions in the next sections are misnamed. @@ -566,14 +566,14 @@ Specifies the appropriate screen number on the host server. Both return the depth (number of planes) of the default root window for the specified screen. Other depths may also be supported on this screen (see -XMatchVisualInfo ). +XMatchVisualInfo). XListDepths To determine the number of depths that are available on a given screen, use -XListDepths . +XListDepths. @@ -634,7 +634,7 @@ can be allocated, sets count_return to the number of available depths. Otherwise, it does not set count_return and returns NULL. To release the memory allocated for the array of depths, use -XFree . +XFree. @@ -1061,22 +1061,22 @@ extended-length protocol encoding; otherwise, it returns the maximum request size (in 4-byte units) supported by the server using the extended-length encoding. The Xlib functions -XDrawLines , -XDrawArcs , -XFillPolygon , -XChangeProperty , -XSetClipRectangles , +XDrawLines, +XDrawArcs, +XFillPolygon, +XChangeProperty, +XSetClipRectangles, and XSetRegion will use the extended-length encoding as necessary, if supported by the server. Use of the extended-length encoding in other Xlib functions (for example, -XDrawPoints , -XDrawRectangles , -XDrawSegments , -XFillArcs , -XFillRectangles , -XPutImage ) +XDrawPoints, +XDrawRectangles, +XDrawSegments, +XFillArcs, +XFillRectangles, +XPutImage) is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead. @@ -1121,13 +1121,13 @@ The protocol guarantees the size to be no smaller than 4096 units (16384 bytes). Xlib automatically breaks data up into multiple protocol requests as necessary for the following functions: -XDrawPoints , -XDrawRectangles , -XDrawSegments , -XFillArcs , -XFillRectangles , +XDrawPoints, +XDrawRectangles, +XDrawSegments, +XFillArcs, +XFillRectangles, and -XPutImage . +XPutImage. @@ -1306,7 +1306,7 @@ Specifies the connection to the X server. Both return the length of the event queue for the connected display. Note that there may be more events that have not been read into the queue yet (see -XEventsQueued ). +XEventsQueued). @@ -1503,7 +1503,7 @@ typedef struct { To obtain the pixmap format information for a given display, use -XListPixmapFormats . +XListPixmapFormats. XListPixmapFormats @@ -1556,7 +1556,7 @@ returns NULL. To free the allocated storage for the XPixmapFormatValues structures, use -XFree . +XFree. @@ -1603,7 +1603,7 @@ Z format. The macro or function can return either LSBFirst or -MSBFirst . +MSBFirst. @@ -1678,7 +1678,7 @@ unit. This macro or function can return LSBFirst or -MSBFirst . +MSBFirst. @@ -2204,8 +2204,8 @@ 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 (see section 3.2.4). @@ -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). @@ -2665,7 +2665,7 @@ Both return the root window of the specified screen. To execute a NoOperation protocol request, use -XNoOp . +XNoOp. XNoOp @@ -2703,7 +2703,7 @@ thereby exercising the connection. To free in-memory data that was created by an Xlib function, use -XFree . +XFree. XFree @@ -2746,7 +2746,7 @@ A NULL pointer cannot be passed to this function. To close a display or disconnect from the X server, use -XCloseDisplay . +XCloseDisplay. XCloseDisplay @@ -2781,17 +2781,17 @@ The function closes the connection to the X server for the display specified in the 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 -XSetCloseDownMode ). +XSetCloseDownMode). Therefore, these windows, resource IDs, and other resources should never be referenced again or an error will be generated. Before exiting, you should call @@ -2817,7 +2817,7 @@ error. Xlib provides a function to permit the resources owned by a client to survive after the client's connection is closed. To change a client's close-down mode, use -XSetCloseDownMode . +XSetCloseDownMode. XSetCloseDownMode @@ -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. @@ -2869,7 +2869,7 @@ For information on what happens to the client's resources when the close_mode argument is RetainPermanent or -RetainTemporary , +RetainTemporary, see section 2.6. @@ -2898,7 +2898,7 @@ automatic operations: It disowns all selections owned by the client (see -XSetSelectionOwner ). +XSetSelectionOwner). @@ -2930,17 +2930,17 @@ by the client either as permanent or temporary, depending on whether the close-down mode is RetainPermanent or -RetainTemporary . +RetainTemporary. However, this does not prevent other client applications from explicitly destroying the resources (see -XSetCloseDownMode ). +XSetCloseDownMode). When the close-down mode is -DestroyAll , +DestroyAll, the X server destroys all of a client's resources as follows: @@ -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: @@ -3042,7 +3042,7 @@ It restores the default font path. It restores the input focus to state -PointerRoot . +PointerRoot. @@ -3052,7 +3052,7 @@ However, the X server does not reset if you close a connection with a close-down mode set to RetainPermanent or -RetainTemporary . +RetainTemporary. @@ -3069,7 +3069,7 @@ multiple threads to use Xlib concurrently. To initialize support for concurrent threads, use -XInitThreads . +XInitThreads. XInitThreads @@ -3102,7 +3102,7 @@ It is recommended that single-threaded programs not call this function. To lock a display across several Xlib calls, use -XLockDisplay . +XLockDisplay. XLockDisplay @@ -3138,16 +3138,16 @@ Nested calls to work correctly; the display will not actually be unlocked until XUnlockDisplay has been called the same number of times as -XLockDisplay . +XLockDisplay. This function has no effect unless Xlib was successfully initialized for threads using -XInitThreads . +XInitThreads. To unlock a display, use -XUnlockDisplay . +XUnlockDisplay. XUnlockDisplay @@ -3185,7 +3185,7 @@ must be called an equal number of times before the display is actually unlocked. This function has no effect unless Xlib was successfully initialized for threads using -XInitThreads . +XInitThreads. @@ -3208,7 +3208,7 @@ facilities. To track internal connections for a display, use -XAddConnectionWatch . +XAddConnectionWatch. @@ -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. @@ -3299,13 +3299,13 @@ If Xlib has been initialized for threads, the procedure is called with the display locked and the result of a call by the procedure to any Xlib function that locks the display is not defined unless the executing thread has externally locked the display using -XLockDisplay . +XLockDisplay. To stop tracking internal connections for a display, use -XRemoveConnectionWatch . +XRemoveConnectionWatch. XRemoveConnectionWatch @@ -3367,7 +3367,7 @@ was initially registered. To process input on an internal connection, use -XProcessInternalConnection . +XProcessInternalConnection. XProcessInternalConnection @@ -3414,7 +3414,7 @@ This function should be called for an internal connection only after an operating system facility (for example, select or -poll ) +poll) has indicated that input is available; otherwise, the effect is not defined. @@ -3422,7 +3422,7 @@ the effect is not defined. To obtain all of the current internal connections for a display, use -XInternalConnectionNumbers . +XInternalConnectionNumbers. XInternalConnectionNumbers @@ -3480,7 +3480,7 @@ function returns a list of the file descriptors for all internal connections currently open for the specified display. When the allocated list is no longer needed, free it by using -XFree . +XFree. This functions returns a nonzero status if the list is successfully allocated; otherwise, it returns zero. diff --git a/specs/libX11/CH03.xml b/specs/libX11/CH03.xml index 83cbc35d..e9760993 100644 --- a/specs/libX11/CH03.xml +++ b/specs/libX11/CH03.xml @@ -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,7 +89,7 @@ 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. @@ -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. @@ -150,7 +150,7 @@ colormap can be thought of as monochrome. The red_mask, green_mask, and blue_mask members are only defined for 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 @@ -161,16 +161,16 @@ in a newly created colormap. For 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. XVisualIDFromVisual @@ -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. @@ -322,7 +322,7 @@ An application may wish to create a window long before it is mapped to the screen. When a window is eventually mapped to the screen (using -XMapWindow ), +XMapWindow), XMapWindow the X server generates an Expose @@ -350,7 +350,7 @@ set the appropriate member of the structure and OR in the corresponding value bitmask in your subsequent calls to XCreateWindow and -XChangeWindowAttributes , +XChangeWindowAttributes, or use one of the other convenience functions that set the appropriate attribute. The symbols for the value mask bits and the @@ -553,7 +553,7 @@ a window's background in a single color. You can set the background-pixmap to a pixmap, 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 @@ -572,7 +572,7 @@ or a 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 : @@ -591,9 +591,9 @@ 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,9 +630,9 @@ When no valid contents are available for regions of a window and either the regions are visible or the server is maintaining backing store, the server automatically tiles the regions with the window's background unless the window has a background of -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. @@ -685,7 +685,7 @@ or a 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. @@ -727,14 +727,14 @@ retained when an 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 or InputOnly window should be repositioned if its parent is resized. The default value for the win-gravity attribute is -NorthWestGravity . +NorthWestGravity. @@ -885,9 +885,9 @@ with the contents of a window. The backing-store attribute can be set to NotUseful (default), -WhenMapped , +WhenMapped, or -Always . +Always. @@ -955,7 +955,7 @@ or 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. @@ -1015,18 +1015,18 @@ or 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 (default). @@ -1084,7 +1084,7 @@ error results. X servers capable of supporting multiple hardware colormaps can use this information, and window managers can use it for calls to -XInstallColormap . +XInstallColormap. You can set the colormap attribute to a colormap or to CopyFromParent (default). @@ -1092,14 +1092,14 @@ You can set the colormap attribute to a colormap or to 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 error results. The parent window must not have a colormap of -None , +None, or a BadMatch error results. @@ -1129,7 +1129,7 @@ You can set the cursor to a cursor or If you set the cursor to -None , +None, the parent's cursor is used when the pointer is in the InputOutput @@ -1138,7 +1138,7 @@ or window, and any change in the parent's cursor will cause an immediate change in the displayed cursor. By calling -XFreeCursor , +XFreeCursor, the cursor can be freed immediately as long as no further explicit reference to it is made. @@ -1235,7 +1235,7 @@ Extension packages can define other classes of windows. To create an unmapped window and set its window attributes, use -XCreateWindow . +XCreateWindow. XCreateWindow @@ -1356,10 +1356,10 @@ 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 means the class @@ -1442,14 +1442,14 @@ window must be zero, or a BadMatch error results. For class -InputOutput , +InputOutput, the visual type and depth must be a combination supported for the screen, or a 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 error results. @@ -1470,11 +1470,11 @@ error results. The created window is not yet displayed (mapped) on the user's display. To display the window, call -XMapWindow . +XMapWindow. The new window initially uses the same cursor as its parent. A new cursor can be defined for the new window by calling -XDefineCursor . +XDefineCursor. CursorInitial State XDefineCursor The window will not be visible on the screen unless it and all of its @@ -1484,12 +1484,12 @@ ancestors are mapped and it is not obscured by any of its ancestors. XCreateWindow can generate -BadAlloc , -BadColor , -BadCursor , -BadMatch , -BadPixmap , -BadValue , +BadAlloc, +BadColor, +BadCursor, +BadMatch, +BadPixmap, +BadValue, and BadWindow errors. @@ -1500,7 +1500,7 @@ errors. To create an unmapped InputOutput subwindow of a given parent window, use -XCreateSimpleWindow . +XCreateSimpleWindow. XCreateSimpleWindow @@ -1648,9 +1648,9 @@ have their default values. XCreateSimpleWindow can generate -BadAlloc , -BadMatch , -BadValue , +BadAlloc, +BadMatch, +BadValue, and BadWindow errors. @@ -1670,7 +1670,7 @@ subwindows of a window. To destroy a window and all of its subwindows, use -XDestroyWindow . +XDestroyWindow. XDestroyWindow @@ -1740,7 +1740,7 @@ error. To destroy all subwindows of a specified window, use -XDestroySubwindows . +XDestroySubwindows. XDestroySubwindows @@ -1867,7 +1867,7 @@ reparent the child into a frame first. For further information, see sections 3.2.8 and 10.10. Only a single client at a time can select for -SubstructureRedirectMask . +SubstructureRedirectMask. @@ -1883,7 +1883,7 @@ event. To map a given window, use -XMapWindow . +XMapWindow. XMapWindow @@ -2009,7 +2009,7 @@ error. To map and raise a window, use -XMapRaised . +XMapRaised. XMapRaised @@ -2056,7 +2056,7 @@ subwindows that have had map requests. However, it also raises the specified window to the top of the stack. For additional information, see -XMapWindow . +XMapWindow. @@ -2069,7 +2069,7 @@ errors. To map all subwindows for a specified window, use -XMapSubwindows . +XMapSubwindows. XMapSubwindows @@ -2139,7 +2139,7 @@ Xlib provides functions that you can use to unmap a window or all subwindows. To unmap a window, use -XUnmapWindow . +XUnmapWindow. XUnmapWindow @@ -2206,7 +2206,7 @@ error. To unmap all subwindows for a specified window, use -XUnmapSubwindows . +XUnmapSubwindows. XUnmapSubwindows @@ -2282,7 +2282,7 @@ To change one of these parameters, set the appropriate member of the XWindowChanges structure and OR in the corresponding value mask in subsequent calls to -XConfigureWindow . +XConfigureWindow. The symbols for the value mask bits and the XWindowChanges structure are: @@ -2343,12 +2343,12 @@ error results. The sibling member is used to set the sibling window for stacking operations. The stack_mode member is used to set how the window is to be restacked and can be set to -Above , -Below , -TopIf , -BottomIf , +Above, +Below, +TopIf, +BottomIf, or -Opposite . +Opposite. @@ -2409,10 +2409,10 @@ 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, @@ -2511,7 +2511,7 @@ Attempts to configure a root window have no effect. To configure a window's size, location, stacking, or border, use -XConfigureWindow . +XConfigureWindow. XConfigureWindow @@ -2590,13 +2590,13 @@ a BadMatch error results. Note that the computations for -BottomIf , -TopIf , +BottomIf, +TopIf, and Opposite are performed with respect to the window's final geometry (as controlled by the other arguments passed to -XConfigureWindow ), +XConfigureWindow), not its initial geometry. Any backing store contents of the window, its inferiors, and other newly visible windows are either discarded or @@ -2607,8 +2607,8 @@ changed to reflect the current screen contents XConfigureWindow can generate -BadMatch , -BadValue , +BadMatch, +BadValue, and BadWindow errors. @@ -2617,7 +2617,7 @@ errors. To move a window without changing its size, use -XMoveWindow . +XMoveWindow. XMoveWindow @@ -2719,7 +2719,7 @@ error. To change a window's size without changing the upper-left coordinate, use -XResizeWindow . +XResizeWindow. XResizeWindow @@ -2822,7 +2822,7 @@ errors. To change the size and location of a window, use -XMoveResizeWindow . +XMoveResizeWindow. XMoveResizeWindow @@ -2943,7 +2943,7 @@ errors. To change the border width of a given window, use -XSetWindowBorderWidth . +XSetWindowBorderWidth. XSetWindowBorderWidth @@ -3020,7 +3020,7 @@ or restack windows. To raise a window so that no sibling window obscures it, use -XRaiseWindow . +XRaiseWindow. XRaiseWindow @@ -3093,7 +3093,7 @@ error. To lower a window so that it does not obscure any sibling windows, use -XLowerWindow . +XLowerWindow. XLowerWindow @@ -3167,7 +3167,7 @@ error. To circulate a subwindow up or down, use -XCirculateSubwindows . +XCirculateSubwindows. XCirculateSubwindows @@ -3211,7 +3211,7 @@ the window. You can pass RaiseLowest or -LowerHighest . +LowerHighest. @@ -3225,12 +3225,12 @@ 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. @@ -3259,7 +3259,7 @@ errors. To raise the lowest mapped child of a window that is partially or completely occluded by another child, use -XCirculateSubwindowsUp . +XCirculateSubwindowsUp. XCirculateSubwindowsUp @@ -3321,7 +3321,7 @@ error. To lower the highest mapped child of a window that partially or completely occludes another child, use -XCirculateSubwindowsDown . +XCirculateSubwindowsDown. XCirculateSubwindowsDown @@ -3380,7 +3380,7 @@ error. To restack a set of windows from top to bottom, use -XRestackWindows . +XRestackWindows. XRestackWindows @@ -3486,7 +3486,7 @@ window attribute, such as a window's background. To change one or more attributes for a given window, use -XChangeWindowAttributes . +XChangeWindowAttributes. XChangeWindowAttributes @@ -3533,7 +3533,7 @@ If valuemask is zero, the attributes are ignored and are not referenced. The values and restrictions are the same as for -XCreateWindow . +XCreateWindow. @@ -3574,7 +3574,7 @@ structure to change the specified window attributes. Changing the background does not cause the window contents to be changed. To repaint the window and its background, use -XClearWindow . +XClearWindow. Setting the border or changing the background such that the border tile origin changes causes the border to be repainted. Changing the background of a root window to @@ -3590,7 +3590,7 @@ window. Changing the backing-store of an obscured window to 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 @@ -3600,7 +3600,7 @@ event. Changing the colormap of a visible window may have no immediate effect on the screen because the map may not be installed (see -XInstallColormap ). +XInstallColormap). Changing the cursor of a root window to None restores the default @@ -3614,10 +3614,10 @@ Their event masks are maintained separately. When an event is generated, it is reported to all interested clients. However, only one client at a time can select for -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 @@ -3630,12 +3630,12 @@ not one per client. XChangeWindowAttributes can generate -BadAccess , -BadColor , -BadCursor , -BadMatch , -BadPixmap , -BadValue , +BadAccess, +BadColor, +BadCursor, +BadMatch, +BadPixmap, +BadValue, and BadWindow errors. @@ -3644,7 +3644,7 @@ errors. To set the background of a window to a given pixel, use -XSetWindowBackground . +XSetWindowBackground. XSetWindowBackground @@ -3720,7 +3720,7 @@ errors. To set the background of a window to a given pixmap, use -XSetWindowBackgroundPixmap . +XSetWindowBackgroundPixmap. Windowbackground XSetWindowBackgroundPixmap @@ -3761,9 +3761,9 @@ Specifies the window. Specifies the background pixmap, -ParentRelative , +ParentRelative, or -None . +None. @@ -3790,15 +3790,15 @@ window, a 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 errors. @@ -3813,7 +3813,7 @@ do not change the current contents of the window. To change and repaint a window's border to a given pixel, use -XSetWindowBorder . +XSetWindowBorder. XSetWindowBorder @@ -3883,7 +3883,7 @@ errors. To change and repaint the border tile of a given window, use -XSetWindowBorderPixmap . +XSetWindowBorderPixmap. XSetWindowBorderPixmap @@ -3923,7 +3923,7 @@ Specifies the window. Specifies the border pixmap or -CopyFromParent . +CopyFromParent. @@ -3938,7 +3938,7 @@ function sets the border pixmap of the window to the pixmap you specify. The border pixmap can be freed immediately if no further explicit references to it are to be made. If you specify -CopyFromParent , +CopyFromParent, a copy of the parent window's border pixmap is used. If you attempt to perform this on an InputOnly @@ -3952,8 +3952,8 @@ error results. XSetWindowBorderPixmap can generate -BadMatch , -BadPixmap , +BadMatch, +BadPixmap, and BadWindow errors. @@ -3962,7 +3962,7 @@ errors. To set the colormap of a given window, use -XSetWindowColormap . +XSetWindowColormap. XSetWindowColormap @@ -4022,8 +4022,8 @@ error results. XSetWindowColormap can generate -BadColor , -BadMatch , +BadColor, +BadMatch, and BadWindow errors. @@ -4032,7 +4032,7 @@ errors. To define which cursor will be used in a window, use -XDefineCursor . +XDefineCursor. Windowdefining the cursor XDefineCursor @@ -4073,7 +4073,7 @@ Specifies the window. Specifies the cursor that is to be displayed or -None . +None. @@ -4084,9 +4084,9 @@ 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 . +XUndefineCursor. @@ -4101,7 +4101,7 @@ errors. To undefine the cursor in a given window, use -XUndefineCursor . +XUndefineCursor. Windowundefining the cursor XUndefineCursor diff --git a/specs/libX11/CH04.xml b/specs/libX11/CH04.xml index e29c5ff1..381cc0a7 100644 --- a/specs/libX11/CH04.xml +++ b/specs/libX11/CH04.xml @@ -32,7 +32,7 @@ exists. To obtain the parent, a list of children, and number of children for a given window, use -XQueryTree . +XQueryTree. Child Window Parent Window XQueryTree @@ -128,7 +128,7 @@ The children are listed in current stacking order, from bottom-most XQueryTree returns zero if it fails and nonzero if it succeeds. To free a non-NULL children list when it is no longer needed, use -XFree . +XFree. @@ -141,7 +141,7 @@ error. To obtain the current attributes of a given window, use -XGetWindowAttributes . +XGetWindowAttributes. XGetWindowAttributes @@ -247,7 +247,7 @@ The root member is set to the root window of the screen containing the window. The class member is set to the window's class and can be either InputOutput or -InputOnly . +InputOnly. @@ -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. @@ -345,20 +345,20 @@ for planes not set in backing_planes. The save_under member is set to 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 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 . +IsViewable. IsUnviewable is used if the window is mapped but some ancestor is unmapped. @@ -377,9 +377,9 @@ The override_redirect member is set to indicate whether this window overrides structure control facilities and can be True or -False . +False. Window manager clients should ignore the window if this member is -True . +True. @@ -401,7 +401,7 @@ errors. To obtain the current geometry of a given drawable, use -XGetGeometry . +XGetGeometry. XGetGeometry @@ -530,7 +530,7 @@ The geometry of the drawable includes the x and y coordinates, width and height, border width, and depth. These are described in the argument list. It is legal to pass to this function a window whose class is -InputOnly . +InputOnly. @@ -562,7 +562,7 @@ asking the X server to perform these operations. To translate a coordinate in one window to the coordinate space of another window, use -XTranslateCoordinates . +XTranslateCoordinates. XTranslateCoordinates @@ -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,13 +676,13 @@ 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. @@ -696,7 +696,7 @@ error. To obtain the screen coordinates of the pointer or to determine the pointer coordinates relative to a specified window, use -XQueryPointer . +XQueryPointer. XQueryPointer @@ -817,7 +817,7 @@ 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 @@ -826,7 +826,7 @@ 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, @@ -1183,7 +1183,7 @@ see section 8.5. To return an atom for a given name, use -XInternAtom . +XInternAtom. Atominterning XInternAtom @@ -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; @@ -1265,7 +1265,7 @@ errors. To return atoms for an array of names, use -XInternAtoms . +XInternAtoms. Atominterning XInternAtoms @@ -1366,7 +1366,7 @@ errors. To return a name for a given atom identifier, use -XGetAtomName . +XGetAtomName. Atomgetting name XGetAtomName @@ -1412,7 +1412,7 @@ then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the resulting string, call -XFree . +XFree. @@ -1425,7 +1425,7 @@ error. To return the names for an array of atom identifiers, use -XGetAtomNames . +XGetAtomNames. Atomgetting name XGetAtomNames @@ -1539,7 +1539,7 @@ communication (see chapter 14). To obtain the type, format, and value of a property of a given window, use -XGetWindowProperty . +XGetWindowProperty. Propertygetting @@ -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. @@ -1806,14 +1806,14 @@ The function returns if it executes successfully. To free the resulting data, use -XFree . +XFree. XGetWindowProperty can generate -BadAtom , -BadValue , +BadAtom, +BadValue, and BadWindow errors. @@ -1822,7 +1822,7 @@ errors. To obtain a given window's property list, use -XListProperties . +XListProperties. Propertylisting XListProperties @@ -1877,7 +1877,7 @@ The function returns a pointer to an array of atom properties that are defined for the specified window or returns NULL if no properties were found. To free the memory allocated by this function, use -XFree . +XFree. @@ -1890,7 +1890,7 @@ error. To change a property of a given window, use -XChangeProperty . +XChangeProperty. Propertychanging Propertyappending Propertyprepending @@ -1953,7 +1953,7 @@ Specifies the property name. Specifies the type of the property. The X server does not interpret the type but simply passes it back to an application that later calls -XGetWindowProperty . +XGetWindowProperty. @@ -1971,7 +1971,7 @@ byte-swap operations as necessary. If the format is 16-bit or 32-bit, you must explicitly cast your data pointer to an (unsigned char *) in the call to -XChangeProperty . +XChangeProperty. @@ -1984,10 +1984,10 @@ to Specifies the mode of the operation. You can pass -PropModeReplace , -PropModePrepend , +PropModeReplace, +PropModePrepend, or -PropModeAppend . +PropModeAppend. @@ -2029,7 +2029,7 @@ performs the following: If mode is -PropModeReplace , +PropModeReplace, XChangeProperty discards the previous property value and stores the new data. @@ -2039,7 +2039,7 @@ discards the previous property value and stores the new data. If mode is 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. @@ -2082,10 +2082,10 @@ error results.) XChangeProperty can generate -BadAlloc , -BadAtom , -BadMatch , -BadValue , +BadAlloc, +BadAtom, +BadMatch, +BadValue, and BadWindow errors. @@ -2094,7 +2094,7 @@ errors. To rotate a window's property list, use -XRotateWindowProperties . +XRotateWindowProperties. @@ -2200,8 +2200,8 @@ no properties are changed. XRotateWindowProperties can generate -BadAtom , -BadMatch , +BadAtom, +BadMatch, and BadWindow errors. @@ -2210,7 +2210,7 @@ errors. To delete a property on a given window, use -XDeleteProperty . +XDeleteProperty. Propertydeleting XDeleteProperty @@ -2333,7 +2333,7 @@ The protocol does not constrain the semantics. To set the selection owner, use -XSetSelectionOwner . +XSetSelectionOwner. Selectionsetting the owner XSetSelectionOwner @@ -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. @@ -2408,7 +2408,7 @@ with CurrentTime replaced by the current server time. If the owner window is specified as -None , +None, then the owner of the selection becomes None (that is, no owner). @@ -2418,11 +2418,11 @@ 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 event. @@ -2432,7 +2432,7 @@ or if the owner window it has specified in the request is later destroyed, the owner of the selection automatically reverts to -None , +None, but the last-change time is not affected. The selection atom is uninterpreted by the X server. XGetSelectionOwner @@ -2456,7 +2456,7 @@ errors. To return the selection owner, use -XGetSelectionOwner . +XGetSelectionOwner. Selectiongetting the owner XGetSelectionOwner @@ -2501,7 +2501,7 @@ function returns the window ID associated with the window that currently owns the specified selection. If no selection was specified, the function returns the constant -None . +None. If None is returned, @@ -2518,7 +2518,7 @@ error. To request conversion of a selection, use -XConvertSelection . +XConvertSelection. Selectionconverting XConvertSelection @@ -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. @@ -2622,7 +2622,7 @@ selection exists, the X server generates a SelectionNotify event to the requestor with property -None . +None. diff --git a/specs/libX11/CH05.xml b/specs/libX11/CH05.xml index 73b6c579..9faa197b 100644 --- a/specs/libX11/CH05.xml +++ b/specs/libX11/CH05.xml @@ -18,7 +18,7 @@ A bitmap is a single bit-plane pixmap. To create a pixmap of a given size, use -XCreatePixmap . +XCreatePixmap. XCreatePixmap @@ -120,8 +120,8 @@ The initial contents of the pixmap are undefined. XCreatePixmap can generate -BadAlloc , -BadDrawable , +BadAlloc, +BadDrawable, and BadValue errors. @@ -130,7 +130,7 @@ errors. To free all storage associated with a specified pixmap, use -XFreePixmap . +XFreePixmap. XFreePixmap @@ -217,7 +217,7 @@ from an arbitrary font or from bitmaps. To create a cursor from the standard cursor font, use -XCreateFontCursor . +XCreateFontCursor. #include <X11/cursorfont.h> @@ -272,7 +272,7 @@ to use. The hotspot comes from the information stored in the cursor font. The initial colors of a cursor are a black foreground and a white background (see -XRecolorCursor ). +XRecolorCursor). For further information about cursor shapes, see appendix B. @@ -289,7 +289,7 @@ errors. To create a cursor from font glyphs, use -XCreateGlyphCursor . +XCreateGlyphCursor. XCreateGlyphCursor @@ -331,7 +331,7 @@ Specifies the font for the source glyph. Specifies the font for the mask glyph or -None . +None. @@ -417,8 +417,8 @@ least significant byte. XCreateGlyphCursor can generate -BadAlloc , -BadFont , +BadAlloc, +BadFont, and BadValue errors. @@ -428,7 +428,7 @@ errors. To create a cursor from two bitmaps, use -XCreatePixmapCursor . +XCreatePixmapCursor. XCreatePixmapCursor @@ -472,7 +472,7 @@ Specifies the shape of the source cursor. Specifies the cursor's source bits to be displayed or -None . +None. @@ -575,7 +575,7 @@ errors. To determine useful cursor sizes, use -XQueryBestCursor . +XQueryBestCursor. XQueryBestCursor @@ -680,7 +680,7 @@ error. To change the color of a given cursor, use -XRecolorCursor . +XRecolorCursor. XRecolorCursor @@ -758,7 +758,7 @@ error. To free (destroy) a given cursor, use -XFreeCursor . +XFreeCursor. XFreeCursor diff --git a/specs/libX11/CH06.xml b/specs/libX11/CH06.xml index 6464457f..cd3e0a83 100644 --- a/specs/libX11/CH06.xml +++ b/specs/libX11/CH06.xml @@ -131,7 +131,7 @@ windows using other colormaps generally display with incorrect colors. You can control the set of installed colormaps by using XInstallColormap and -XUninstallColormap . +XUninstallColormap. @@ -156,11 +156,11 @@ 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 (see section 3.1). @@ -204,10 +204,10 @@ 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. @@ -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. @@ -294,7 +294,7 @@ then reference should be made by color space string prefix (see XcmsFormatOfPrefix and -XcmsPrefixOfFormat ). +XcmsPrefixOfFormat). @@ -431,7 +431,7 @@ The device-dependent formats provided allow color specification in: RGB Intensity -( XcmsRGBi ) +(XcmsRGBi) @@ -444,7 +444,7 @@ where 1.0 indicates full intensity, 0.5 half intensity, and so on. RGB Device -( XcmsRGB ) +(XcmsRGB) @@ -802,7 +802,7 @@ or in the CCC indirectly specified by means of the colormap argument. To create a colormap for a screen, use -XCreateColormap . +XCreateColormap. XCreateColormap @@ -861,7 +861,7 @@ Specifies the colormap entries to be allocated. You can pass 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 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 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, @@ -933,15 +933,15 @@ and blue_mask values containing the same bits as the corresponding masks in the specified visual. However, in all cases, none of these entries can be freed by using -XFreeColors . +XFreeColors. XCreateColormap can generate -BadAlloc , -BadMatch , -BadValue , +BadAlloc, +BadMatch, +BadValue, and BadWindow errors. @@ -951,7 +951,7 @@ errors. To create a new colormap when the allocation out of a previously shared colormap has failed because of resource exhaustion, use -XCopyColormapAndFree . +XCopyColormapAndFree. XCopyColormapAndFree @@ -998,18 +998,18 @@ 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 , -XAllocNamedColor , -XAllocColorCells , +XAllocColor, +XAllocNamedColor, +XAllocColorCells, or XAllocColorPlanes and that have not been freed since they were allocated. @@ -1027,7 +1027,7 @@ errors. To destroy a colormap, use -XFreeColormap . +XFreeColormap. XFreeColormap @@ -1073,12 +1073,12 @@ and the colormap and frees the colormap storage. However, this function has no effect on the default colormap for a screen. If the specified colormap is an installed map for a screen, it is uninstalled (see -XUninstallColormap ). +XUninstallColormap). If the specified colormap is defined as the colormap for a window (by -XCreateWindow , -XSetWindowColormap , +XCreateWindow, +XSetWindowColormap, or -XChangeWindowAttributes ), +XChangeWindowAttributes), XFreeColormap changes the colormap associated with the window to None @@ -1086,7 +1086,7 @@ and generates a ColormapNotify event. X does not define the colors displayed for a window with a colormap of -None . +None. @@ -1105,7 +1105,7 @@ error. To map a color name to an RGB value, use -XLookupColor . +XLookupColor. Colornaming XLookupColor @@ -1202,7 +1202,7 @@ error. To map a color name to the exact RGB value, use -XParseColor . +XParseColor. Colornaming XParseColor @@ -1256,8 +1256,8 @@ case is ignored. Returns the exact color value for later use and sets the -DoRed , -DoGreen , +DoRed, +DoGreen, and DoBlue flags. @@ -1292,7 +1292,7 @@ error. To map a color name to a value in an arbitrary color space, use -XcmsLookupColor . +XcmsLookupColor. Colornaming XcmsLookupColor @@ -1405,7 +1405,7 @@ returns or XcmsSuccessWithCompression if the name is resolved; otherwise, it returns -XcmsFailure . +XcmsFailure. If XcmsSuccessWithCompression is returned, the color specification returned in @@ -1446,7 +1446,7 @@ times, the server counts each such allocation, not just the first one. To allocate a read-only color cell with an RGB value, use -XAllocColor . +XAllocColor. Allocationread-only colormap cells Read-only colormap cellsallocating @@ -1536,7 +1536,7 @@ delim %% To allocate a read-only color cell with a color in arbitrary format, use -XcmsAllocColor . +XcmsAllocColor. Allocationread-only colormap cells Read-only colormap cellsallocating @@ -1612,7 +1612,7 @@ to allocate a read-only color cell (colormap entry) with the specified color. XcmsAllocColor first converts the color specified to an RGB value and then passes this to -XAllocColor . +XAllocColor. XcmsAllocColor returns the pixel value of the color cell and the color specification actually allocated. @@ -1622,10 +1622,10 @@ 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. @@ -1640,7 +1640,7 @@ error. To allocate a read-only color cell using a color name and return the closest color supported by the hardware in RGB format, use -XAllocNamedColor . +XAllocNamedColor. Allocationread-only colormap cells Read-only colormap cellsallocating @@ -1745,7 +1745,7 @@ error. To allocate a read-only color cell using a color name and return the closest color supported by the hardware in an arbitrary format, use -XcmsAllocNamedColor . +XcmsAllocNamedColor. Allocationread-only colormap cells Read-only colormap cellsallocating @@ -1858,10 +1858,10 @@ the color specified by a color string. The color string is parsed into an XcmsColor structure (see -XcmsLookupColor ), +XcmsLookupColor), converted to an RGB value, and finally passed to -XAllocColor . +XAllocColor. 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. @@ -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. @@ -1895,7 +1895,7 @@ error. To allocate read/write color cell and color plane combinations for a PseudoColor model, use -XAllocColorCells . +XAllocColorCells. Read/write colormap cellsallocating Allocationread/write colormap cells @@ -2016,10 +2016,10 @@ allocated writable by the request. For 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 @@ -2030,7 +2030,7 @@ or 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 @@ -2051,7 +2051,7 @@ errors. To allocate read/write color resources for a DirectColor model, use -XAllocColorPlanes . +XAllocColorPlanes. Read/write colormap planesallocating Allocationread/write colormap planes @@ -2209,13 +2209,13 @@ 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,13 +2227,13 @@ 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 , -XStoreColor , +XStoreColors, +XStoreColor, or -XStoreNamedColor ), +XStoreNamedColor), the pixel is decomposed according to the masks, and the corresponding independent entries are updated. XAllocColorPlanes @@ -2253,7 +2253,7 @@ errors. Freeingcolors To free colormap cells, use -XFreeColors . +XFreeColors. XFreeColors Colordeallocation @@ -2340,11 +2340,11 @@ were allocated by the client (using XAllocNamedColor XAllocColorCells XAllocColorPlanes -XAllocColor , -XAllocNamedColor , -XAllocColorCells , +XAllocColor, +XAllocNamedColor, +XAllocColorCells, and -XAllocColorPlanes ). +XAllocColorPlanes). Note that freeing an individual pixel obtained from XAllocColorPlanes @@ -2367,7 +2367,7 @@ 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 to -XCreateColormap ), +XCreateColormap), a BadAccess error results. @@ -2378,8 +2378,8 @@ the one that gets reported is arbitrary. XFreeColors can generate -BadAccess , -BadColor , +BadAccess, +BadColor, and BadValue errors. @@ -2394,7 +2394,7 @@ errors. To store an RGB value in a single colormap cell, use -XStoreColor . +XStoreColor. Colorstoring XStoreColor @@ -2462,8 +2462,8 @@ 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 in the flags member of the @@ -2476,8 +2476,8 @@ the changes are visible immediately. XStoreColor can generate -BadAccess , -BadColor , +BadAccess, +BadColor, and BadValue errors. @@ -2486,7 +2486,7 @@ errors. To store multiple RGB values in multiple colormap cells, use -XStoreColors . +XStoreColors. Colorstoring XStoreColors @@ -2557,8 +2557,8 @@ specified in the pixel members of the XColor structures. You specify which color components are to be changed by setting -DoRed , -DoGreen , +DoRed, +DoGreen, and/or DoBlue in the flags member of the @@ -2582,8 +2582,8 @@ the one that gets reported is arbitrary. XStoreColors can generate -BadAccess , -BadColor , +BadAccess, +BadColor, and BadValue errors. @@ -2592,7 +2592,7 @@ errors. To store a color of arbitrary format in a single colormap cell, use -XcmsStoreColor . +XcmsStoreColor. Colorstoring XcmsStoreColor @@ -2653,10 +2653,10 @@ structure into RGB values. It then uses this RGB specification in an 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 @@ -2684,7 +2684,7 @@ to RGB succeeded and the call to XStoreColor was made. To obtain the actual color stored, use -XcmsQueryColor . +XcmsQueryColor. Because of the screen's hardware limitations or gamut compression, the color stored in the colormap may not be identical to the color specified. @@ -2693,8 +2693,8 @@ to the color specified. XcmsStoreColor can generate -BadAccess , -BadColor , +BadAccess, +BadColor, and BadValue errors. @@ -2703,7 +2703,7 @@ errors. To store multiple colors of arbitrary format in multiple colormap cells, use -XcmsStoreColors . +XcmsStoreColors. Colorstoring XcmsStoreColors @@ -2795,10 +2795,10 @@ function converts the colors specified in the array of structures into RGB values and then uses these RGB specifications in 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 @@ -2828,7 +2828,7 @@ to RGB succeeded and the call to XStoreColors was made. To obtain the actual colors stored, use -XcmsQueryColors . +XcmsQueryColors. Because of the screen's hardware limitations or gamut compression, the colors stored in the colormap may not be identical to the colors specified. @@ -2837,8 +2837,8 @@ to the colors specified. XcmsStoreColors can generate -BadAccess , -BadColor , +BadAccess, +BadColor, and BadValue errors. @@ -2847,7 +2847,7 @@ errors. To store a color specified by name in a single colormap cell, use -XStoreNamedColor . +XStoreNamedColor. Colorstoring Colornaming @@ -2929,10 +2929,10 @@ 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. @@ -2947,9 +2947,9 @@ error results. XStoreNamedColor can generate -BadAccess , -BadColor , -BadName , +BadAccess, +BadColor, +BadName, and BadValue errors. @@ -2978,7 +2978,7 @@ the one that gets reported is arbitrary. To query the RGB value of a single colormap cell, use -XQueryColor . +XQueryColor. Colorquerying XQueryColor @@ -3033,8 +3033,8 @@ The function returns the current RGB value for the pixel in the XColor structure and sets the -DoRed , -DoGreen , +DoRed, +DoGreen, and DoBlue flags. @@ -3052,7 +3052,7 @@ errors. To query the RGB values of multiple colormap cells, use -XQueryColors . +XQueryColors. Colorquerying XQueryColors @@ -3122,8 +3122,8 @@ The function returns the RGB value for each pixel in each XColor structure and sets the -DoRed , -DoGreen , +DoRed, +DoGreen, and DoBlue flags in each structure. @@ -3142,7 +3142,7 @@ errors. To query the color of a single colormap cell in an arbitrary format, use -XcmsQueryColor . +XcmsQueryColor. Colorquerying XcmsQueryColor @@ -3231,7 +3231,7 @@ errors. To query the color of multiple colormap cells in an arbitrary format, use -XcmsQueryColors . +XcmsQueryColors. Colorquerying XcmsQueryColors @@ -3388,7 +3388,7 @@ There is a default CCC associated with each screen. To obtain the CCC associated with a colormap, use -XcmsCCCOfColormap . +XcmsCCCOfColormap. XcmsCCCOfColormap ColormapCCC of @@ -3435,7 +3435,7 @@ function returns the CCC associated with the specified colormap. Once obtained, the CCC attributes can be queried or modified. Unless the CCC associated with the specified colormap is changed with -XcmsSetCCCOfColormap , +XcmsSetCCCOfColormap, this CCC is used when the specified colormap is used as an argument to color functions. @@ -3443,7 +3443,7 @@ to color functions. To change the CCC associated with a colormap, use -XcmsSetCCCOfColormap . +XcmsSetCCCOfColormap. XcmsSetCCCOfColormap ColormapCCC of @@ -3501,7 +3501,7 @@ function changes the CCC associated with the specified colormap. It returns the CCC previously associated with the colormap. If they are not used again in the application, CCCs should be freed by calling -XcmsFreeCCC . +XcmsFreeCCC. Several colormaps may share the same CCC without restriction; this includes the CCCs generated by Xlib with each colormap. Xlib, however, creates a new CCC with each new colormap. @@ -3524,7 +3524,7 @@ A default CCC is associated with each screen. To obtain the default CCC for a screen, use -XcmsDefaultCCC . +XcmsDefaultCCC. XcmsDefaultCCC Color Conversion Contextdefault @@ -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. @@ -3781,7 +3781,7 @@ Both return the Client White Point of the specified CCC. To set the Client White Point in the CCC, use -XcmsSetWhitePoint . +XcmsSetWhitePoint. XcmsSetWhitePoint Client White Pointof Color Conversion Context @@ -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. @@ -3850,7 +3850,7 @@ otherwise, it returns zero. To set the gamut compression procedure and corresponding client data in a specified CCC, use -XcmsSetCompressionProc . +XcmsSetCompressionProc. XcmsSetCompressionProc Gamut compressionsetting in Color Conversion Context @@ -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. @@ -3920,7 +3920,7 @@ and then returns the old procedure. To set the white point adjustment procedure and corresponding client data in a specified CCC, use -XcmsSetWhiteAdjustProc . +XcmsSetWhiteAdjustProc. XcmsSetWhiteAdjustProc White point adjustmentsetting in Color Conversion Context @@ -3987,17 +3987,17 @@ and then returns the old procedure. You can explicitly create a CCC within your application by calling -XcmsCreateCCC . +XcmsCreateCCC. These created CCCs can then be used by those functions that explicitly call for a CCC argument. Old CCCs that will not be used by the application should be freed using -XcmsFreeCCC . +XcmsFreeCCC. To create a CCC, use -XcmsCreateCCC . +XcmsCreateCCC. XcmsCreateCCC Color Conversion Contextcreation @@ -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. @@ -4124,7 +4124,7 @@ function creates a CCC for the specified display, screen, and visual. To free a CCC, use -XcmsFreeCCC . +XcmsFreeCCC. XcmsFreeCCC Color Conversion Contextfreeing @@ -4171,7 +4171,7 @@ are ignored. To convert an array of color specifications in arbitrary color formats to a single destination format, use -XcmsConvertColors . +XcmsConvertColors. Color conversion Colorconversion @@ -4264,7 +4264,7 @@ function converts the color specifications in the specified array of 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. @@ -4296,7 +4296,7 @@ The gamut compression procedure specified in the CCC is called when an attempt to convert a color specification from 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. @@ -4323,7 +4323,7 @@ following: - typedef Status(*XcmsCompressionProc) + typedef Status(*XcmsCompressionProc) XcmsCCC ccc XcmsColor colors_in_out[] unsignedint ncolors @@ -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,7 +4438,7 @@ 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 @@ -4509,7 +4509,7 @@ then while maintaining the same Psychometric Hue Angle, the color will be clipped to the CIE L*a*b* coordinates of maximum Psychometric Chroma. See -XcmsCIELabQueryMaxC . +XcmsCIELabQueryMaxC. No client data is necessary. @@ -4558,7 +4558,7 @@ then, while maintaining the same Psychometric Hue Angle, the color will be clipped to the CIE L*u*v* coordinates of maximum Psychometric Chroma. See -XcmsCIELuvQueryMaxC . +XcmsCIELuvQueryMaxC. No client data is necessary. @@ -4650,7 +4650,7 @@ The white point adjustment procedure interface must adhere to the following: - typedef Status (*XcmsWhiteAdjustProc) + typedef Status (*XcmsWhiteAdjustProc) XcmsCCC ccc XcmsColor *initial_white_point XcmsColor *target_white_point @@ -4860,9 +4860,9 @@ A second time to convert from For example, assume the specification is in XcmsCIEuvY and the adjustment procedure is -XcmsCIELuvWhiteShiftColors . +XcmsCIELuvWhiteShiftColors. During conversion to -XcmsRGB , +XcmsRGB, the call to XcmsAllocColor results in the following series of color specification conversions: @@ -4916,7 +4916,7 @@ to The resulting RGB specification is passed to -XAllocColor , +XAllocColor, and the RGB specification returned by XAllocColor @@ -5007,7 +5007,7 @@ is given a fixed Hue and Value for which maximum Chroma is found. To obtain the color specification for black (zero-intensity red, green, and blue), use -XcmsQueryBlack . +XcmsQueryBlack. XcmsQueryBlack @@ -5073,7 +5073,7 @@ for zero-intensity red, green, and blue. To obtain the color specification for blue (full-intensity blue while red and green are zero), use -XcmsQueryBlue . +XcmsQueryBlue. XcmsQueryBlue @@ -5139,7 +5139,7 @@ for full-intensity blue while red and green are zero. To obtain the color specification for green (full-intensity green while red and blue are zero), use -XcmsQueryGreen . +XcmsQueryGreen. XcmsQueryGreen @@ -5205,7 +5205,7 @@ for full-intensity green while red and blue are zero. To obtain the color specification for red (full-intensity red while green and blue are zero), use -XcmsQueryRed . +XcmsQueryRed. XcmsQueryRed @@ -5271,7 +5271,7 @@ for full-intensity red while green and blue are zero. To obtain the color specification for white (full-intensity red, green, and blue), use -XcmsQueryWhite . +XcmsQueryWhite. XcmsQueryWhite @@ -5359,7 +5359,7 @@ delim %% To obtain the CIE L*a*b* coordinates of maximum Psychometric Chroma for a given Psychometric Hue Angle and CIE metric lightness (L*), use -XcmsCIELabQueryMaxC . +XcmsCIELabQueryMaxC. XcmsCIELabQueryMaxC @@ -5440,7 +5440,7 @@ It returns this point in CIE L*a*b* coordinates. To obtain the CIE L*a*b* coordinates of maximum CIE metric lightness (L*) for a given Psychometric Hue Angle and Psychometric Chroma, use -XcmsCIELabQueryMaxL . +XcmsCIELabQueryMaxL. Psychometric Hue Angle CIE metric lightness @@ -5529,7 +5529,7 @@ is beyond maximum for the given hue angle. To obtain the CIE L*a*b* coordinates of maximum Psychometric Chroma for a given Psychometric Hue Angle, use -XcmsCIELabQueryMaxLC . +XcmsCIELabQueryMaxLC. Psychometric Hue Angle Psychometric Chroma @@ -5603,7 +5603,7 @@ It returns this point in CIE L*a*b* coordinates. To obtain the CIE L*a*b* coordinates of minimum CIE metric lightness (L*) for a given Psychometric Hue Angle and Psychometric Chroma, use -XcmsCIELabQueryMinL . +XcmsCIELabQueryMinL. Psychometric Hue Angle CIE metric lightness @@ -5716,7 +5716,7 @@ delim %% To obtain the CIE L*u*v* coordinates of maximum Psychometric Chroma for a given Psychometric Hue Angle and CIE metric lightness (L*), use -XcmsCIELuvQueryMaxC . +XcmsCIELuvQueryMaxC. XcmsCIELuvQueryMaxC @@ -5797,7 +5797,7 @@ It returns this point in CIE L*u*v* coordinates. To obtain the CIE L*u*v* coordinates of maximum CIE metric lightness (L*) for a given Psychometric Hue Angle and Psychometric Chroma, use -XcmsCIELuvQueryMaxL . +XcmsCIELuvQueryMaxL. Psychometric Hue Angle CIE metric lightness @@ -5886,7 +5886,7 @@ is beyond maximum for the given hue angle. To obtain the CIE L*u*v* coordinates of maximum Psychometric Chroma for a given Psychometric Hue Angle, use -XcmsCIELuvQueryMaxLC . +XcmsCIELuvQueryMaxLC. Psychometric Hue Angle Psychometric Chroma @@ -5960,7 +5960,7 @@ It returns this point in CIE L*u*v* coordinates. To obtain the CIE L*u*v* coordinates of minimum CIE metric lightness (L*) for a given Psychometric Hue Angle and Psychometric Chroma, use -XcmsCIELuvQueryMinL . +XcmsCIELuvQueryMinL. Psychometric Hue Angle CIE metric lightness @@ -6052,7 +6052,7 @@ is beyond maximum for the given hue angle. To obtain the maximum Chroma for a given Hue and Value, use -XcmsTekHVCQueryMaxC . +XcmsTekHVCQueryMaxC. Chroma Chromamaximum @@ -6135,7 +6135,7 @@ and Value at which the maximum Chroma was found. To obtain the maximum Value for a given Hue and Chroma, use -XcmsTekHVCQueryMaxV . +XcmsTekHVCQueryMaxV. Value Valuemaximum @@ -6220,7 +6220,7 @@ at which the maximum Value was found. To obtain the maximum Chroma and Value at which it is reached for a specified Hue, use -XcmsTekHVCQueryMaxVC . +XcmsTekHVCQueryMaxVC. Chroma Value @@ -6298,7 +6298,7 @@ and the actual Hue for which the maximum Chroma was found. To obtain a specified number of TekHVC specifications such that they contain maximum Values for a specified Hue and the Chroma at which the maximum Values are reached, use -XcmsTekHVCQueryMaxVSamples . +XcmsTekHVCQueryMaxVSamples. Chroma Value @@ -6381,7 +6381,7 @@ space. To obtain the minimum Value for a given Hue and Chroma, use -XcmsTekHVCQueryMinV . +XcmsTekHVCQueryMinV. Value Valueminimum @@ -6541,7 +6541,7 @@ thus bypassing conversion between CIE u*v*Y and CIE< To add a device-independent color space, use -XcmsAddColorSpace . +XcmsAddColorSpace. XcmsAddColorSpace @@ -6582,7 +6582,7 @@ then reference should be made by color space prefix (see XcmsFormatOfPrefix and -XcmsPrefixOfFormat ). +XcmsPrefixOfFormat). @@ -6591,7 +6591,7 @@ If the structure is already accessible in the color management system, XcmsAddColorSpace returns -XcmsSuccess . +XcmsSuccess. @@ -6609,7 +6609,7 @@ must be retained for reference by Xlib. To obtain the format associated with the color space associated with a specified color string prefix, use -XcmsFormatOfPrefix . +XcmsFormatOfPrefix. XcmsFormatOfPrefix @@ -6644,14 +6644,14 @@ The prefix is case-insensitive. If the color space is not accessible in the color management system, XcmsFormatOfPrefix returns -XcmsUndefinedFormat . +XcmsUndefinedFormat. To obtain the color string prefix associated with the color space specified by a color format, use -XcmsPrefixOfFormat . +XcmsPrefixOfFormat. XcmsPrefixOfFormat @@ -6718,7 +6718,7 @@ unregistered color space), then reference should be made by color space prefix (see XcmsFormatOfPrefix and -XcmsPrefixOfFormat ). +XcmsPrefixOfFormat). @@ -7117,7 +7117,7 @@ its corresponding data may be stored on different root window properties. To add a function set, use -XcmsAddFunctionSet . +XcmsAddFunctionSet. XcmsAddFunctionSet @@ -7165,7 +7165,7 @@ then reference should be made by color space prefix (see XcmsFormatOfPrefix and -XcmsPrefixOfFormat ). +XcmsPrefixOfFormat). @@ -7198,7 +7198,7 @@ This data is stored in an structure. A handle to this structure (that is, by means of global variable) is usually made accessible to the client program for use with -XcmsAddFunctionSet . +XcmsAddFunctionSet. @@ -7253,7 +7253,7 @@ interface specification: - typedef Status (*XcmsScreenInitProc) + typedef Status (*XcmsScreenInitProc) Display *display int screen_number ScmsPerScrnInfo *screen_info @@ -7339,7 +7339,7 @@ structure. It then sets the state member to XcmsInitSuccess and finally returns -XcmsSuccess . +XcmsSuccess. @@ -7348,7 +7348,7 @@ and finally returns If unsuccessful, the procedure sets the state member to XcmsInitFailure and returns -XcmsFailure . +XcmsFailure. diff --git a/specs/libX11/CH07.xml b/specs/libX11/CH07.xml index 73232d76..308487bd 100644 --- a/specs/libX11/CH07.xml +++ b/specs/libX11/CH07.xml @@ -60,7 +60,7 @@ To set an attribute of a GC, set the appropriate member of the XGCValues structure and OR in the corresponding value bitmask in your subsequent calls to -XCreateGC . +XCreateGC. The symbols for the value mask bits and the XGCValues structure are: @@ -523,7 +523,7 @@ all internal ends of the individual dashes, except CapNotLast is treated as -CapButt . +CapButt. @@ -647,13 +647,13 @@ the semantics depends on the line-width and the cap-style: CapRound thin The results are the same as for - CapButt /thin. + CapButt /thin. CapProjecting thin The results are the same as for - CapButt /thin. + CapButt /thin. CapButt @@ -707,7 +707,7 @@ error results. For stipple operations where the fill-style is 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, @@ -719,24 +719,24 @@ any size pixmap can be used for tiling or stippling. The fill-style defines the contents of the source for line, text, and fill requests. For all text and fill requests (for example, -XDrawText , -XDrawText16 , -XFillRectangle , -XFillPolygon , +XDrawText, +XDrawText16, +XFillRectangle, +XFillPolygon, and -XFillArc ); +XFillArc); for line requests with line-style LineSolid (for example, -XDrawLine , -XDrawSegments , -XDrawRectangle , -XDrawArc ); +XDrawLine, +XDrawSegments, +XDrawRectangle, +XDrawArc); and for the even dashes for line requests with line-style LineOnOffDash or -LineDoubleDash , +LineDoubleDash, the following apply: @@ -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: @@ -824,10 +824,10 @@ of GCs. The dashes value is actually a simplified form of the more general patterns that can be set with -XSetDashes . +XSetDashes. Specifying a value of N is equivalent to specifying the two-element list [N, N] in -XSetDashes . +XSetDashes. The value must be nonzero, or a BadValue @@ -842,7 +842,7 @@ or a 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 @@ -862,15 +862,15 @@ destination drawable is specified in a graphics request. You can set the subwindow-mode to ClipByChildren or -IncludeInferiors . +IncludeInferiors. For -ClipByChildren , +ClipByChildren, both source and destination windows are additionally clipped by all viewable 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. @@ -888,14 +888,14 @@ paths given in requests and can be set to 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. @@ -912,7 +912,7 @@ coincident with a segment. For both 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 @@ -931,12 +931,12 @@ The arc-mode controls filling in the function and can be set to ArcPieSlice or -ArcChord . +ArcChord. For -ArcPieSlice , +ArcPieSlice, the arcs are pie-slice filled. For -ArcChord , +ArcChord, the arcs are chord filled. @@ -955,7 +955,7 @@ requests (and any similar requests defined by extensions). To create a new GC that is usable on a given screen with a depth of drawable, use -XCreateGC . +XCreateGC. Graphics contextinitializing XCreateGC @@ -1031,11 +1031,11 @@ error. XCreateGC can generate -BadAlloc , -BadDrawable , -BadFont , -BadMatch , -BadPixmap , +BadAlloc, +BadDrawable, +BadFont, +BadMatch, +BadPixmap, and BadValue errors. @@ -1044,7 +1044,7 @@ errors. To copy components from a source GC to a destination GC, use -XCopyGC . +XCopyGC. XCopyGC @@ -1114,14 +1114,14 @@ or a BadMatch error results. The valuemask specifies which component to copy, as for -XCreateGC . +XCreateGC. XCopyGC can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadMatch errors. @@ -1130,7 +1130,7 @@ errors. To change the components in a given GC, use -XChangeGC . +XChangeGC. XChangeGC @@ -1198,7 +1198,7 @@ function changes the components specified by valuemask for the specified GC. The values argument contains the values to be set. The values and restrictions are the same as for -XCreateGC . +XCreateGC. Changing the clip-mask overrides any previous XSetClipRectangles request on the context. @@ -1213,11 +1213,11 @@ 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 errors. @@ -1226,7 +1226,7 @@ errors. To obtain components of a given GC, use -XGetGCValues . +XGetGCValues. XGetGCValues @@ -1294,28 +1294,28 @@ 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. @@ -1328,8 +1328,8 @@ bits, respectively, in the valuemask) cannot be requested. Also note that an invalid resource ID (with one or more of the three most significant bits set to 1) will be returned for -GCFont , -GCTile , +GCFont, +GCTile, and GCStipple if the component has never been explicitly set by the client. @@ -1338,7 +1338,7 @@ if the component has never been explicitly set by the client. To free a given GC, use -XFreeGC . +XFreeGC. XFreeGC @@ -1392,7 +1392,7 @@ error. To obtain the GContext resource ID for a given GC, use -XGContextFromGC . +XGContextFromGC. XGContextFromGC @@ -1428,7 +1428,7 @@ to explicitly force sending the changes to the server. An example might be when a protocol extension uses the GC indirectly, in such a way that the extension interface cannot know what GC will be used. To force sending GC component changes, use -XFlushGC . +XFlushGC. XFlushGC @@ -1522,7 +1522,7 @@ Arc mode, subwindow mode, and graphics exposure components To set the foreground, background, plane mask, and function components for a given GC, use -XSetState . +XSetState. XSetState @@ -1605,8 +1605,8 @@ Specifies the plane mask. XSetState can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -1615,7 +1615,7 @@ errors. To set the foreground of a given GC, use -XSetForeground . +XSetForeground. XSetForeground @@ -1674,7 +1674,7 @@ errors. To set the background of a given GC, use -XSetBackground . +XSetBackground. XSetBackground @@ -1733,7 +1733,7 @@ errors. To set the display function in a given GC, use -XSetFunction . +XSetFunction. XSetFunction @@ -1783,8 +1783,8 @@ Specifies the function you want to set for the specified GC. XSetFunction can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -1793,7 +1793,7 @@ errors. To set the plane mask of a given GC, use -XSetPlaneMask . +XSetPlaneMask. XSetPlaneMask @@ -1858,7 +1858,7 @@ errors. To set the line drawing components of a given GC, use -XSetLineAttributes . +XSetLineAttributes. XSetLineAttributes @@ -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,8 +1957,8 @@ or XSetLineAttributes can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -1967,7 +1967,7 @@ errors. To set the dash-offset and dash-list for dashed line styles of a given GC, use -XSetDashes . +XSetDashes. XSetDashes @@ -2081,8 +2081,8 @@ For all other lines, the major axis is the y axis. XSetDashes can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -2096,7 +2096,7 @@ errors. To set the fill-style of a given GC, use -XSetFillStyle . +XSetFillStyle. XSetFillStyle @@ -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,8 +2152,8 @@ or XSetFillStyle can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -2162,7 +2162,7 @@ errors. To set the fill-rule of a given GC, use -XSetFillRule . +XSetFillRule. XSetFillRule @@ -2205,7 +2205,7 @@ Specifies the fill-rule you want to set for the specified GC. You can pass EvenOddRule or -WindingRule . +WindingRule. @@ -2216,8 +2216,8 @@ or XSetFillRule can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -2242,7 +2242,7 @@ as well as to set the tile or stipple shape and the tile or stipple origin. To obtain the best size of a tile, stipple, or cursor, use -XQueryBestSize . +XQueryBestSize. XQueryBestSize @@ -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,29 +2344,29 @@ 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 and -StippleShape , +StippleShape, the drawable indicates the screen and possibly the window class and depth. An InputOnly window cannot be used as the drawable for TileShape or -StippleShape , +StippleShape, or a BadMatch error results. @@ -2375,8 +2375,8 @@ error results. XQueryBestSize can generate -BadDrawable , -BadMatch , +BadDrawable, +BadMatch, and BadValue errors. @@ -2385,7 +2385,7 @@ errors. To obtain the best fill tile shape, use -XQueryBestTile . +XQueryBestTile. XQueryBestTile @@ -2491,7 +2491,7 @@ errors. To obtain the best stipple shape, use -XQueryBestStipple . +XQueryBestStipple. XQueryBestStipple @@ -2597,7 +2597,7 @@ errors. To set the fill tile of a given GC, use -XSetTile . +XSetTile. XSetTile @@ -2654,9 +2654,9 @@ error results. XSetTile can generate -BadAlloc , -BadGC , -BadMatch , +BadAlloc, +BadGC, +BadMatch, and BadPixmap errors. @@ -2665,7 +2665,7 @@ errors. To set the stipple of a given GC, use -XSetStipple . +XSetStipple. XSetStipple @@ -2722,9 +2722,9 @@ error results. XSetStipple can generate -BadAlloc , -BadGC , -BadMatch , +BadAlloc, +BadGC, +BadMatch, and BadPixmap errors. @@ -2733,7 +2733,7 @@ errors. To set the tile or stipple origin of a given GC, use -XSetTSOrigin . +XSetTSOrigin. XSetTSOrigin @@ -2814,7 +2814,7 @@ errors. To set the current font of a given GC, use -XSetFont . +XSetFont. XSetFont @@ -2864,8 +2864,8 @@ Specifies the font. XSetFont can generate -BadAlloc , -BadFont , +BadAlloc, +BadFont, and BadGC errors. @@ -2885,7 +2885,7 @@ and the clip-mask or set the clip-mask to a list of rectangles. To set the clip-origin of a given GC, use -XSetClipOrigin . +XSetClipOrigin. XSetClipOrigin @@ -2960,7 +2960,7 @@ errors. To set the clip-mask of a given GC to the specified pixmap, use -XSetClipMask . +XSetClipMask. XSetClipMask @@ -3000,7 +3000,7 @@ Specifies the GC. Specifies the pixmap or -None . +None. @@ -3010,16 +3010,16 @@ 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 errors. @@ -3028,7 +3028,7 @@ errors. To set the clip-mask of a given GC to the specified list of rectangles, use -XSetClipRectangles . +XSetClipRectangles. XSetClipRectangles @@ -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. @@ -3142,10 +3142,10 @@ which effectively disables output. This is the opposite of passing None as the clip-mask in -XCreateGC , -XChangeGC , +XCreateGC, +XChangeGC, and -XSetClipMask . +XSetClipMask. @@ -3179,9 +3179,9 @@ scanline have an identical Y origins and Y extents. XSetClipRectangles can generate -BadAlloc , -BadGC , -BadMatch , +BadAlloc, +BadGC, +BadMatch, and BadValue errors. @@ -3202,7 +3202,7 @@ see section 16.5. To set the arc mode of a given GC, use -XSetArcMode . +XSetArcMode. XSetArcMode @@ -3245,7 +3245,7 @@ Specifies the arc mode. You can pass ArcChord or -ArcPieSlice . +ArcPieSlice. @@ -3256,8 +3256,8 @@ or XSetArcMode can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -3266,7 +3266,7 @@ errors. To set the subwindow mode of a given GC, use -XSetSubwindowMode . +XSetSubwindowMode. XSetSubwindowMode @@ -3309,7 +3309,7 @@ Specifies the subwindow mode. You can pass ClipByChildren or -IncludeInferiors . +IncludeInferiors. @@ -3320,8 +3320,8 @@ or XSetSubwindowMode can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. @@ -3330,7 +3330,7 @@ errors. To set the graphics-exposures flag of a given GC, use -XSetGraphicsExposures . +XSetGraphicsExposures. XSetGraphicsExposures @@ -3388,8 +3388,8 @@ with this GC. XSetGraphicsExposures can generate -BadAlloc , -BadGC , +BadAlloc, +BadGC, and BadValue errors. diff --git a/specs/libX11/CH08.xml b/specs/libX11/CH08.xml index b093545e..7174884e 100644 --- a/specs/libX11/CH08.xml +++ b/specs/libX11/CH08.xml @@ -28,14 +28,14 @@ Because pixmaps do not have defined backgrounds, they cannot be filled by using the functions described in this section. Instead, to accomplish an analogous operation on a pixmap, you should use -XFillRectangle , +XFillRectangle, which sets the pixmap to a known value. To clear a rectangular area of a given window, use -XClearArea . +XClearArea. Areasclearing Clearingareas XClearArea @@ -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,17 +148,17 @@ If the window has a defined background tile, the rectangle clipped by any children is filled with this tile. If the window has background -None , +None, the contents of the window are not changed. In either case, if exposures is -True , +True, one or more 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 error results. @@ -167,8 +167,8 @@ error results. XClearArea can generate -BadMatch , -BadValue , +BadMatch, +BadValue, and BadWindow errors. @@ -177,7 +177,7 @@ errors. To clear the entire area in a given window, use -XClearWindow . +XClearWindow. Windowclearing Clearingwindows XClearWindow @@ -222,17 +222,17 @@ 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 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 error results. @@ -261,7 +261,7 @@ Xlib provides functions that you can use to copy an area or a bit plane. To copy an area between drawables of the same root and depth, use -XCopyArea . +XCopyArea. Areascopying Copyingareas XCopyArea @@ -413,7 +413,7 @@ Instead, the following occurs on all corresponding destination regions that are either visible or are retained in backing store. If the destination is a window with a background other than -None , +None, corresponding regions of the destination are tiled with that background (with plane-mask of all ones and @@ -421,7 +421,7 @@ of the destination are tiled with that background function). Regardless of tiling or whether the destination is a window or a pixmap, if graphics-exposures is -True , +True, then GraphicsExpose events for all corresponding destination regions are generated. @@ -446,8 +446,8 @@ clip-y-origin, and clip-mask. XCopyArea can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -456,7 +456,7 @@ errors. To copy a single bit plane of a given drawable, use -XCopyPlane . +XCopyPlane. Planecopying Copyingplanes XCopyPlane @@ -640,9 +640,9 @@ and clip-mask. XCopyPlane can generate -BadDrawable , -BadGC , -BadMatch , +BadDrawable, +BadGC, +BadMatch, and BadValue errors. @@ -762,7 +762,7 @@ for these values. To draw a single point in a given drawable, use -XDrawPoint . +XDrawPoint. XDrawPoint @@ -834,7 +834,7 @@ Specify the x and y coordinates where you want the point drawn. To draw multiple points in a given drawable, use -XDrawPoints . +XDrawPoints. XDrawPoints @@ -910,7 +910,7 @@ Specifies the coordinate mode. You can pass CoordModeOrigin or -CoordModePrevious . +CoordModePrevious. @@ -942,16 +942,16 @@ foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. XDrawPoint can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. XDrawPoints can generate -BadDrawable , -BadGC , -BadMatch , +BadDrawable, +BadGC, +BadMatch, and BadValue errors. @@ -975,7 +975,7 @@ errors. To draw a single line between two points in a given drawable, use -XDrawLine . +XDrawLine. XDrawLine @@ -1069,7 +1069,7 @@ Specify the points (x1, y1) and (x2, y2) to be connected. To draw multiple lines in a given drawable, use -XDrawLines . +XDrawLines. XDrawLines @@ -1145,7 +1145,7 @@ Specifies the coordinate mode. You can pass CoordModeOrigin or -CoordModePrevious . +CoordModePrevious. @@ -1157,7 +1157,7 @@ or To draw multiple, unconnected lines in a given drawable, use -XDrawSegments . +XDrawSegments. XDrawSegments @@ -1296,13 +1296,13 @@ tile-stipple-y-origin, dash-offset, and dash-list. -XDrawLine , -XDrawLines , +XDrawLine, +XDrawLines, and XDrawSegments can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -1327,7 +1327,7 @@ errors. To draw the outline of a single rectangle in a given drawable, use -XDrawRectangle . +XDrawRectangle. XDrawRectangle @@ -1424,7 +1424,7 @@ Specify the width and height(Wh. To draw the outline of multiple rectangles in a given drawable, use -XDrawRectangles . +XDrawRectangles. XDrawRectangles @@ -1535,8 +1535,8 @@ tile-stipple-y-origin, dash-offset, and dash-list. and XDrawRectangles can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -1558,7 +1558,7 @@ errors. To draw a single arc in a given drawable, use -XDrawArc . +XDrawArc. XDrawArc @@ -1678,7 +1678,7 @@ arc, in units of degrees * 64. To draw multiple arcs in a given drawable, use -XDrawArcs . +XDrawArcs. XDrawArcs @@ -1866,8 +1866,8 @@ tile-stipple-y-origin, dash-offset, and dash-list. and XDrawArcs can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -1916,7 +1916,7 @@ A single arc or multiple arcs To fill a single rectangular area in a given drawable, use -XFillRectangle . +XFillRectangle. XFillRectangle @@ -2013,7 +2013,7 @@ Specify the width and height(Wh. To fill multiple rectangular areas in a given drawable, use -XFillRectangles . +XFillRectangles. XFillRectangles @@ -2130,8 +2130,8 @@ and tile-stipple-y-origin. and XFillRectangles can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -2146,7 +2146,7 @@ errors. To fill a polygon area in a given drawable, use -XFillPolygon . +XFillPolygon. Polygonsfilling Fillingpolygon XFillPolygon @@ -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. @@ -2240,7 +2240,7 @@ Specifies the coordinate mode. You can pass CoordModeOrigin or -CoordModePrevious . +CoordModePrevious. @@ -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,7 +2279,7 @@ 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, @@ -2295,7 +2295,7 @@ 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, @@ -2328,9 +2328,9 @@ and tile-stipple-y-origin. XFillPolygon can generate -BadDrawable , -BadGC , -BadMatch , +BadDrawable, +BadGC, +BadMatch, and BadValue errors. @@ -2347,7 +2347,7 @@ errors. Arcsfilling Fillingarcs To fill a single arc in a given drawable, use -XFillArc . +XFillArc. XFillArc @@ -2467,7 +2467,7 @@ arc, in units of degrees * 64. To fill multiple arcs in a given drawable, use -XFillArcs . +XFillArcs. XFillArcs @@ -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,8 +2576,8 @@ and tile-stipple-y-origin. and XFillArcs can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -2657,8 +2657,8 @@ a pointer to an array of structures for the characters contained in the font. The -XFontStruct , -XFontProp , +XFontStruct, +XFontProp, and XCharStruct structures contain: @@ -2767,14 +2767,14 @@ have the following semantics: The direction member can be either FontLeftToRight or -FontRightToLeft . +FontRightToLeft. It is just a hint as to whether most 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. @@ -3014,7 +3014,7 @@ resource ID or a font ID interchangeably. To load a given font, use -XLoadFont . +XLoadFont. XLoadFont @@ -3075,7 +3075,7 @@ Fonts are not associated with a particular screen and can be stored as a component of any GC. When the font is no longer needed, call -XUnloadFont . +XUnloadFont. @@ -3090,7 +3090,7 @@ errors. To return information about an available font, use -XQueryFont . +XQueryFont. XQueryFont @@ -3141,12 +3141,12 @@ structure will be the GContext ID, and you need to be careful when using this ID in other functions (see -XGContextFromGC ). +XGContextFromGC). If the font does not exist, XQueryFont returns NULL. To free this data, use -XFreeFontInfo . +XFreeFontInfo. @@ -3156,7 +3156,7 @@ To perform a and XQueryFont in a single operation, use -XLoadQueryFont . +XLoadQueryFont. XLoadQueryFont @@ -3222,9 +3222,9 @@ To unload the font and free the storage used by the font structure that was allocated by XQueryFont or -XLoadQueryFont , +XLoadQueryFont, use -XFreeFont . +XFreeFont. XFreeFont @@ -3281,7 +3281,7 @@ error. To return a given font property, use -XGetFontProperty . +XGetFontProperty. XGetFontProperty @@ -3351,9 +3351,9 @@ it is likely that the predefined font properties will be present. To unload a font that was loaded by -XLoadFont , +XLoadFont, use -XUnloadFont . +XUnloadFont. XUnloadFont @@ -3418,7 +3418,7 @@ when querying a font type for a list of available sizes and so on. To return a list of the available font names, use -XListFonts . +XListFonts. XListFonts @@ -3482,7 +3482,7 @@ The XListFonts function returns an array of available font names (as controlled by the font search path; see -XSetFontPath ) +XSetFontPath) that match the string you passed to the pattern argument. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, @@ -3505,7 +3505,7 @@ when finished with the result to free the memory. To free a font name array, use -XFreeFontNames . +XFreeFontNames. XFreeFontNames @@ -3536,13 +3536,13 @@ The function frees the array and strings returned by XListFonts or -XListFontsWithInfo . +XListFontsWithInfo. To obtain the names and information about available fonts, use -XListFontsWithInfo . +XListFontsWithInfo. XListFontsWithInfo @@ -3639,17 +3639,17 @@ returns NULL. To free only the allocated name array, the client should call -XFreeFontNames . +XFreeFontNames. To free both the name array and the font information array or to free just the font information array, the client should call -XFreeFontInfo . +XFreeFontInfo. To free font structures and font names, use -XFreeFontInfo . +XFreeFontInfo. XFreeFontInfo @@ -3706,7 +3706,7 @@ function frees a font structure or an array of font structures and optionally an array of font names. If NULL is passed for names, no font names are freed. If a font structure for an open font (returned by -XLoadQueryFont ) +XLoadQueryFont) is passed, the structure is freed, but the font is not closed; use XUnloadFont @@ -3733,7 +3733,7 @@ These functions return the sum of the character metrics in pixels. To determine the width of an 8-bit character string, use -XTextWidth . +XTextWidth. XTextWidth @@ -3783,7 +3783,7 @@ Specifies the character count in the specified string. To determine the width of a 2-byte character string, use -XTextWidth16 . +XTextWidth16. XTextWidth16 @@ -3841,7 +3841,7 @@ Specifies the character count in the specified string. To compute the bounding box of an 8-bit character string in a given font, use -XTextExtents . +XTextExtents. XTextExtents @@ -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). @@ -3941,7 +3941,7 @@ structure. To compute the bounding box of a 2-byte character string in a given font, use -XTextExtents16 . +XTextExtents16. XTextExtents16 @@ -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). @@ -4048,7 +4048,7 @@ perform the size computation locally and, thereby, avoid the round-trip overhead of XQueryTextExtents and -XQueryTextExtents16 . +XQueryTextExtents16. Both functions return an XCharStruct structure, whose members are set to the values as follows. @@ -4088,7 +4088,7 @@ undefined characters in the string are taken to have all zero metrics. To query the server for the bounding box of an 8-bit character string in a given font, use -XQueryTextExtents . +XQueryTextExtents. XQueryTextExtents @@ -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). @@ -4200,7 +4200,7 @@ structure. To query the server for the bounding box of a 2-byte character string in a given font, use -XQueryTextExtents16 . +XQueryTextExtents16. XQueryTextExtents16 @@ -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). @@ -4320,7 +4320,7 @@ These functions query the X server and, therefore, suffer the round-trip overhead that is avoided by XTextExtents and -XTextExtents16 . +XTextExtents16. Both functions return a XCharStruct structure, whose members are set to the values as follows. @@ -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. @@ -4446,7 +4446,7 @@ coordinates that you pass in the text drawing functions. For example, consider the background rectangle drawn by -XDrawImageString . +XDrawImageString. If you want the upper-left corner of the background rectangle to be at pixel coordinate (x,y), pass the (x,y + ascent) as the baseline origin coordinates to the text functions. @@ -4473,7 +4473,7 @@ structure. To draw 8-bit characters in a given drawable, use -XDrawText . +XDrawText. XDrawText @@ -4569,7 +4569,7 @@ Specifies the number of text items in the array. To draw 2-byte characters in a given drawable, use -XDrawText16 . +XDrawText16. XDrawText16 @@ -4711,9 +4711,9 @@ and tile-stipple-y-origin. and XDrawText16 can generate -BadDrawable , -BadFont , -BadGC , +BadDrawable, +BadFont, +BadGC, and BadMatch errors. @@ -4729,7 +4729,7 @@ errors. Stringsdrawing Drawingstrings To draw 8-bit characters in a given drawable, use -XDrawString . +XDrawString. XDrawString @@ -4825,7 +4825,7 @@ Specifies the number of characters in the string argument. To draw 2-byte characters in a given drawable, use -XDrawString16 . +XDrawString16. XDrawString16 @@ -4924,7 +4924,7 @@ additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. For fonts defined with 2-byte matrix indexing and used with -XDrawString16 , +XDrawString16, each byte is used as a byte2 with a byte1 of zero. @@ -4942,8 +4942,8 @@ and tile-stipple-y-origin. and XDrawString16 can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -4969,7 +4969,7 @@ This prevents annoying flicker on many displays. To draw 8-bit image text characters in a given drawable, use -XDrawImageString . +XDrawImageString. XDrawImageString @@ -5065,7 +5065,7 @@ Specifies the number of characters in the string argument. To draw 2-byte image text characters in a given drawable, use -XDrawImageString16 . +XDrawImageString16. XDrawImageString16 @@ -5208,15 +5208,15 @@ are as would be returned by using gc and string. The function and fill-style defined in the GC are ignored for these functions. The effective function is -GXcopy , +GXcopy, and the effective fill-style is -FillSolid . +FillSolid. For fonts defined with 2-byte matrix indexing and used with -XDrawImageString , +XDrawImageString, each byte is used as a byte2 with a byte1 of zero. @@ -5231,8 +5231,8 @@ clip-y-origin, and clip-mask. and XDrawImageString16 can generate -BadDrawable , -BadGC , +BadDrawable, +BadGC, and BadMatch errors. @@ -5310,7 +5310,7 @@ typedef struct _XImage { To initialize the image manipulation routines of an image structure, use -XInitImage . +XInitImage. XInitImage @@ -5368,7 +5368,7 @@ or inconsistency in the structure, in which case the image is not changed. To combine an image with a rectangle of a drawable on the display, use -XPutImage . +XPutImage. XPutImage @@ -5518,7 +5518,7 @@ and the background pixel defines the source for the zero bits. For XYPixmap and -ZPixmap , +ZPixmap, the depth of the image must match the depth of the drawable, or a BadMatch @@ -5544,9 +5544,9 @@ foreground and background. XPutImage can generate -BadDrawable , -BadGC , -BadMatch , +BadDrawable, +BadGC, +BadMatch, and BadValue errors. @@ -5556,7 +5556,7 @@ errors. To return the contents of a rectangle in a given drawable on the display, use -XGetImage . +XGetImage. This function specifically supports rudimentary screen dumps. XGetImage @@ -5659,7 +5659,7 @@ Specifies the format for the image. You can pass XYPixmap or -ZPixmap . +ZPixmap. @@ -5676,13 +5676,13 @@ structure. This structure provides you with the contents of the specified rectangle of the drawable in the format you specify. If the format argument is -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. @@ -5733,8 +5733,8 @@ returns NULL. XGetImage can generate -BadDrawable , -BadMatch , +BadDrawable, +BadMatch, and BadValue errors. @@ -5744,7 +5744,7 @@ errors. To copy the contents of a rectangle on the display to a location within a preexisting image structure, use -XGetSubImage . +XGetSubImage. XGetSubImage @@ -5848,7 +5848,7 @@ Specifies the format for the image. You can pass XYPixmap or -ZPixmap . +ZPixmap. @@ -5894,12 +5894,12 @@ Specify the x and y coordinates(Dx. The XGetSubImage function updates dest_image with the specified subimage in the same manner as -XGetImage . +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. @@ -5946,9 +5946,9 @@ returns NULL. XGetSubImage can generate -BadDrawable , -BadGC , -BadMatch , +BadDrawable, +BadGC, +BadMatch, and BadValue errors. diff --git a/specs/libX11/CH09.xml b/specs/libX11/CH09.xml index 2f2d1e35..9b0778d8 100644 --- a/specs/libX11/CH09.xml +++ b/specs/libX11/CH09.xml @@ -27,7 +27,7 @@ programs. Xlib provides management functions to: To change a window's parent to another window on the same screen, use -XReparentWindow . +XReparentWindow. There is no way to move a window between screens. XReparentWindow @@ -119,7 +119,7 @@ The override_redirect member returned in this event is set to the window's corresponding attribute. Window manager clients usually should ignore this window if this member is set to -True . +True. Finally, if the specified window was originally mapped, the X server automatically performs a MapWindow @@ -156,7 +156,7 @@ specified window. The new parent is -InputOnly , +InputOnly, and the window is not. @@ -212,7 +212,7 @@ when they are destroyed. To add or remove a window from the client's save-set, use -XChangeSaveSet . +XChangeSaveSet. XChangeSaveSet @@ -256,7 +256,7 @@ Specifies the mode. You can pass SetModeInsert or -SetModeDelete . +SetModeDelete. @@ -277,8 +277,8 @@ error results. XChangeSaveSet can generate -BadMatch , -BadValue , +BadMatch, +BadValue, and BadWindow errors. @@ -287,7 +287,7 @@ errors. To add a window to the client's save-set, use -XAddToSaveSet . +XAddToSaveSet. XAddToSaveSet @@ -346,7 +346,7 @@ errors. To remove a window from the client's save-set, use -XRemoveFromSaveSet . +XRemoveFromSaveSet. XRemoveFromSaveSet @@ -426,7 +426,7 @@ where M is the minimum number of installed colormaps specified for the screen in the connection setup. The required list is maintained as follows. When a colormap is specified to -XInstallColormap , +XInstallColormap, it is added to the head of the list; the list is truncated at the tail, if necessary, to keep its length to at most M. @@ -443,7 +443,7 @@ required list. To install a colormap, use -XInstallColormap . +XInstallColormap. XInstallColormap @@ -486,11 +486,11 @@ function installs the specified colormap for its associated screen. All windows associated with this colormap immediately display with true colors. You associated the windows with this colormap when you created them by calling -XCreateWindow , -XCreateSimpleWindow , -XChangeWindowAttributes , +XCreateWindow, +XCreateSimpleWindow, +XChangeWindowAttributes, or -XSetWindowColormap . +XSetWindowColormap. @@ -500,7 +500,7 @@ the X server generates a event on each window that has that colormap. In addition, for every other colormap that is installed as a result of a call to -XInstallColormap , +XInstallColormap, the X server generates a ColormapNotify event on each window that has that colormap. @@ -516,7 +516,7 @@ error. To uninstall a colormap, use -XUninstallColormap . +XUninstallColormap. XUninstallColormap @@ -571,7 +571,7 @@ the X server generates a event on each window that has that colormap. In addition, for every other colormap that is installed or uninstalled as a result of a call to -XUninstallColormap , +XUninstallColormap, the X server generates a ColormapNotify event on each window that has that colormap. @@ -587,7 +587,7 @@ error. To obtain a list of the currently installed colormaps for a given screen, use -XListInstalledColormaps . +XListInstalledColormaps. XListInstalledColormaps @@ -644,7 +644,7 @@ The order of the colormaps in the list is not significant and is no explicit indication of the required list. When the allocated list is no longer needed, free it by using -XFree . +XFree. @@ -669,7 +669,7 @@ search path for a server. To set the font search path, use -XSetFontPath . +XSetFontPath. XSetFontPath @@ -747,7 +747,7 @@ error. To get the current font search path, use -XGetFontPath . +XGetFontPath. XGetFontPath @@ -791,15 +791,15 @@ The contents of these strings are implementation-dependent and are not intended to be interpreted by client applications. When it is no longer needed, the data in the font path should be freed by using -XFreeFontPath . +XFreeFontPath. To free data returned by -XGetFontPath , +XGetFontPath, use -XFreeFontPath . +XFreeFontPath. XFreeFontPath @@ -829,7 +829,7 @@ The XFreeFontPath function frees the data allocated by -XGetFontPath . +XGetFontPath. @@ -853,7 +853,7 @@ Although grabbing the server is highly discouraged, it is sometimes necessary. To grab the server, use -XGrabServer . +XGrabServer. Servergrabbing Grabbingserver XGrabServer @@ -891,7 +891,7 @@ You should not grab the X server any more than is absolutely necessary. To ungrab the server, use -XUngrabServer . +XUngrabServer. XUngrabServer @@ -933,7 +933,7 @@ You should avoid grabbing the X server as much as possible. Xlib provides a function to cause the connection to a client to be closed and its resources to be destroyed. To destroy a client, use -XKillClient . +XKillClient. XKillClient @@ -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. @@ -991,7 +991,7 @@ is specified, the resources of all clients that have terminated in are destroyed (see section 2.5). This permits implementation of window manager facilities that aid debugging. A client can set its close-down mode to -RetainTemporary . +RetainTemporary. If the client then crashes, its windows would not be destroyed. The programmer can then inspect the application's window tree @@ -1020,7 +1020,7 @@ or to obtain the current screen saver values. To set the screen saver mode, use -XSetScreenSaver . +XSetScreenSaver. XSetScreenSaver @@ -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. @@ -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. @@ -1155,7 +1155,7 @@ error. To force the screen saver on or off, use -XForceScreenSaver . +XForceScreenSaver. XForceScreenSaver @@ -1187,7 +1187,7 @@ Specifies the mode that is to be applied. You can pass ScreenSaverActive or -ScreenSaverReset . +ScreenSaverReset. @@ -1221,7 +1221,7 @@ error. To activate the screen saver, use -XActivateScreenSaver . +XActivateScreenSaver. XActivateScreenSaver @@ -1249,7 +1249,7 @@ Specifies the connection to the X server. To reset the screen saver, use -XResetScreenSaver . +XResetScreenSaver. XResetScreenSaver @@ -1277,7 +1277,7 @@ Specifies the connection to the X server. To get the current screen saver values, use -XGetScreenSaver . +XGetScreenSaver. XGetScreenSaver @@ -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). @@ -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. @@ -1524,7 +1524,7 @@ specify the length in byte of the type and value strings. To add a single host, use -XAddHost . +XAddHost. XAddHost @@ -1582,7 +1582,7 @@ errors. To add multiple hosts at one time, use -XAddHosts . +XAddHosts. XAddHosts @@ -1651,7 +1651,7 @@ errors. To obtain a host list, use -XListHosts . +XListHosts. XListHosts @@ -1709,13 +1709,13 @@ It also returns a pointer to a list of host structures that were allocated by the function. When no longer needed, this memory should be freed by calling -XFree . +XFree. To remove a single host, use -XRemoveHost . +XRemoveHost. XRemoveHost @@ -1777,7 +1777,7 @@ errors. To remove multiple hosts at one time, use -XRemoveHosts . +XRemoveHosts. XRemoveHosts @@ -1868,7 +1868,7 @@ at connection setup. To change access control, use -XSetAccessControl . +XSetAccessControl. XSetAccessControl @@ -1900,7 +1900,7 @@ Specifies the mode. You can pass EnableAccess or -DisableAccess . +DisableAccess. @@ -1927,7 +1927,7 @@ errors. To enable access control, use -XEnableAccessControl . +XEnableAccessControl. XEnableAccessControl @@ -1968,7 +1968,7 @@ error. To disable access control, use -XDisableAccessControl . +XDisableAccessControl. XDisableAccessControl diff --git a/specs/libX11/CH10.xml b/specs/libX11/CH10.xml index 749d29ec..95cb3ae8 100644 --- a/specs/libX11/CH10.xml +++ b/specs/libX11/CH10.xml @@ -85,23 +85,23 @@ The processing associated with these events is discussed in section 10.5. Keyboard events - KeyPress , + KeyPress, KeyRelease Pointer events - ButtonPress , - ButtonRelease , + ButtonPress, + ButtonRelease, MotionNotify Window crossing events - EnterNotify , + EnterNotify, LeaveNotify Input focus events - FocusIn , + FocusIn, FocusOut @@ -110,29 +110,29 @@ The processing associated with these events is discussed in section 10.5. Exposure events - Expose , - GraphicsExpose , + Expose, + GraphicsExpose, NoExpose Structure control events - CirculateRequest , - ConfigureRequest , - MapRequest , + CirculateRequest, + ConfigureRequest, + MapRequest, ResizeRequest Window state notification events - CirculateNotify , - ConfigureNotify , - CreateNotify , - DestroyNotify , - GravityNotify , - MapNotify , - MappingNotify , - ReparentNotify , - UnmapNotify , + CirculateNotify, + ConfigureNotify, + CreateNotify, + DestroyNotify, + GravityNotify, + MapNotify, + MappingNotify, + ReparentNotify, + UnmapNotify, VisibilityNotify @@ -141,10 +141,10 @@ The processing associated with these events is discussed in section 10.5. Client communication events - ClientMessage , - PropertyNotify , - SelectionClear , - SelectionNotify , + ClientMessage, + PropertyNotify, + SelectionClear, + SelectionNotify, SelectionRequest @@ -200,7 +200,7 @@ For example, when the X server reports a event to a client application, it sends an 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 @@ -323,17 +323,17 @@ 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 , +False, GraphicsExpose and NoExpose are reported by default as a result of XCopyPlane and -XCopyArea . -SelectionClear , -SelectionRequest , -SelectionNotify , +XCopyArea. +SelectionClear, +SelectionRequest, +SelectionNotify, or ClientMessage cannot be masked. @@ -491,7 +491,7 @@ 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 events. @@ -503,15 +503,15 @@ 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 events. @@ -524,7 +524,7 @@ For example, if you pass either PointerMotionMask or -ButtonMotionMask , +ButtonMotionMask, the X server sends back a MotionNotify @@ -933,7 +933,7 @@ with these client passed arguments: owner_events - True , + True, if the client has selected OwnerGrabButtonMask on the event window, @@ -959,7 +959,7 @@ the logical state of the pointer has all buttons released. Clients can modify the active grab by calling XUngrabPointer and -XChangeActivePointerGrab . +XChangeActivePointerGrab. @@ -981,10 +981,10 @@ keyboard events and KeyRelease and the pointer events -ButtonPress , -ButtonRelease , +ButtonPress, +ButtonRelease, and -MotionNotify . +MotionNotify. For information about the keyboard event-handling utilities, see chapter 11. @@ -1029,15 +1029,15 @@ if device event processing is frozen. To receive -KeyPress , -KeyRelease , -ButtonPress , +KeyPress, +KeyRelease, +ButtonPress, and ButtonRelease events, set -KeyPressMask , -KeyReleaseMask , -ButtonPressMask , +KeyPressMask, +KeyReleaseMask, +ButtonPressMask, and ButtonReleaseMask bits in the event-mask attribute of the window. @@ -1103,17 +1103,17 @@ the X server is free to send only one event (with the is_hint member of the 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 XQueryPointer or -XGetMotionEvents . +XGetMotionEvents. The server still may send MotionNotify events without is_hint set to -NotifyHint . +NotifyHint. @@ -1214,12 +1214,12 @@ window is on the same screen as the root window and can be either 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,20 +1246,20 @@ 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. @@ -1281,10 +1281,10 @@ and 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 value. @@ -1294,7 +1294,7 @@ structure, this member is called is_hint. It can be set to NotifyNormal or -NotifyHint . +NotifyHint. @@ -1423,7 +1423,7 @@ This section describes the processing that occurs for the window crossing events EnterNotify and -LeaveNotify . +LeaveNotify. EnterNotify LeaveNotify If a pointer motion or a window hierarchy change causes the @@ -1438,19 +1438,19 @@ and 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 and LeaveNotify events with respect to -FocusOut , -VisibilityNotify , +FocusOut, +VisibilityNotify, and Expose events. @@ -1468,7 +1468,7 @@ or event also can be generated when some client application calls XGrabPointer and -XUngrabPointer . +XUngrabPointer. @@ -1541,12 +1541,12 @@ 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 event, if a child of the event window contains the final pointer position, the subwindow component is set to that child or -None . +None. @@ -1569,12 +1569,12 @@ The same_screen member is set to indicate whether the event window is on the sam as the root window and can be either 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. @@ -1584,12 +1584,12 @@ inferior of the focus window. The X server can set this member to either 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 @@ -1651,7 +1651,7 @@ Normal events are identified by or XLeaveWindowEvent structures whose mode member is set to -NotifyNormal . +NotifyNormal. @@ -1668,7 +1668,7 @@ It generates a event on window A, with the detail member of the XLeaveWindowEvent structure set to -NotifyAncestor . +NotifyAncestor. @@ -1679,7 +1679,7 @@ event on each window between window A and window B, exclusive, with the detail member of each XLeaveWindowEvent structure set to -NotifyVirtual . +NotifyVirtual. @@ -1689,7 +1689,7 @@ It generates an event on window B, with the detail member of the XEnterWindowEvent structure set to -NotifyInferior . +NotifyInferior. @@ -1708,7 +1708,7 @@ event on window A, with the detail member of the XLeaveWindowEvent structure set to -NotifyInferior . +NotifyInferior. @@ -1719,7 +1719,7 @@ event on each window between window A and window B, exclusive, with the detail member of each XEnterWindowEvent structure set to -NotifyVirtual . +NotifyVirtual. @@ -1729,7 +1729,7 @@ It generates an event on window B, with the detail member of the XEnterWindowEvent structure set to -NotifyAncestor . +NotifyAncestor. @@ -1749,7 +1749,7 @@ event on window A, with the detail member of the XLeaveWindowEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -1760,7 +1760,7 @@ event on each window between window A and window C, exclusive, with the detail member of each XLeaveWindowEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -1771,7 +1771,7 @@ event on each window between window C and window B, exclusive, with the detail member of each XEnterWindowEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -1781,7 +1781,7 @@ It generates an event on window B, with the detail member of the XEnterWindowEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -1800,7 +1800,7 @@ event on window A, with the detail member of the XLeaveWindowEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -1812,7 +1812,7 @@ event on each window above window A up to and including its root, with the detail member of each XLeaveWindowEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -1824,7 +1824,7 @@ event on each window from window B's root down to but not including window B, with the detail member of each XEnterWindowEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -1834,7 +1834,7 @@ It generates an event on window B, with the detail member of the XEnterWindowEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -1859,7 +1859,7 @@ are identified by or XLeaveWindowEvent structures whose mode member is set to -NotifyGrab . +NotifyGrab. Events in which the pointer grab deactivates are identified by XEnterWindowEvent @@ -1868,7 +1868,7 @@ or structures whose mode member is set to NotifyUngrab (see -XGrabPointer ). +XGrabPointer). @@ -1895,7 +1895,7 @@ with the mode members of the and 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. @@ -1927,7 +1927,7 @@ with the mode members of the and 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 @@ -1951,7 +1951,7 @@ initial and final positions for the events. This section describes the processing that occurs for the input focus events FocusIn and -FocusOut . +FocusOut. FocusIn FocusOut The X server can report @@ -2021,11 +2021,11 @@ 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. @@ -2037,9 +2037,9 @@ event; however, the X protocol does not constrain the ordering of FocusOut events with respect to generated -EnterNotify , -LeaveNotify , -VisibilityNotify , +EnterNotify, +LeaveNotify, +VisibilityNotify, and Expose events. @@ -2048,15 +2048,15 @@ 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 @@ -2070,13 +2070,13 @@ Normal focus events are identified by or XFocusOutEvent structures whose mode member is set to -NotifyNormal . +NotifyNormal. Focus events while grabbed are identified by XFocusInEvent or 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: @@ -2096,7 +2096,7 @@ It generates a event on window A, with the detail member of the XFocusOutEvent structure set to -NotifyAncestor . +NotifyAncestor. @@ -2107,7 +2107,7 @@ event on each window between window A and window B, exclusive, with the detail member of each XFocusOutEvent structure set to -NotifyVirtual . +NotifyVirtual. @@ -2117,7 +2117,7 @@ It generates a event on window B, with the detail member of the XFocusOutEvent structure set to -NotifyInferior . +NotifyInferior. @@ -2130,7 +2130,7 @@ event on each window below window B, down to and including window P, with the detail member of each XFocusInEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2152,7 +2152,7 @@ event on each window from window P up to but not including window A, with the detail member of each XFocusOutEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2163,7 +2163,7 @@ event on window A, with the detail member of the XFocusOutEvent structure set to -NotifyInferior . +NotifyInferior. @@ -2174,7 +2174,7 @@ event on each window between window A and window B, exclusive, with the detail member of each XFocusInEvent structure set to -NotifyVirtual . +NotifyVirtual. @@ -2184,7 +2184,7 @@ It generates a event on window B, with the detail member of the XFocusInEvent structure set to -NotifyAncestor . +NotifyAncestor. @@ -2206,7 +2206,7 @@ event on each window from window P up to but not including window A, with the detail member of the XFocusOutEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2217,7 +2217,7 @@ event on window A, with the detail member of the XFocusOutEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -2228,7 +2228,7 @@ event on each window between window A and window C, exclusive, with the detail member of each XFocusOutEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -2239,7 +2239,7 @@ event on each window between C and B, exclusive, with the detail member of each XFocusInEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -2249,7 +2249,7 @@ It generates a event on window B, with the detail member of the XFocusInEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -2260,7 +2260,7 @@ event on each window below window B down to and including window P, with the detail member of the XFocusInEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2280,7 +2280,7 @@ event on each window from window P up to but not including window A, with the detail member of each XFocusOutEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2291,7 +2291,7 @@ event on window A, with the detail member of the XFocusOutEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -2303,7 +2303,7 @@ event on each window above window A up to and including its root, with the detail member of each XFocusOutEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -2315,7 +2315,7 @@ event on each window from window B's root down to but not including window B, with the detail member of each XFocusInEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -2325,7 +2325,7 @@ It generates a event on window B, with the detail member of each XFocusInEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -2336,7 +2336,7 @@ event on each window below window B down to and including window P, with the detail member of each XFocusInEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2360,7 +2360,7 @@ event on each window from window P up to but not including window A, with the detail member of each XFocusOutEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2370,7 +2370,7 @@ It generates a event on window A, with the detail member of the XFocusOutEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -2382,7 +2382,7 @@ event on each window above window A up to and including its root, with the detail member of each XFocusOutEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -2394,20 +2394,20 @@ event on the root window of all screens, with the detail member of each structure set to NotifyPointerRoot (or -NotifyDetailNone ). +NotifyDetailNone). If the new focus is -PointerRoot , +PointerRoot, it generates a FocusIn event on each window from window P's root down to and including window P, with the detail member of each XFocusInEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2426,14 +2426,14 @@ the X server does the following: If the old focus is -PointerRoot , +PointerRoot, it generates a FocusOut event on each window from window P up to and including window P's root, with the detail member of each XFocusOutEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2446,7 +2446,7 @@ with the detail member of each structure set to NotifyPointerRoot (or -NotifyDetailNone ). +NotifyDetailNone). @@ -2458,7 +2458,7 @@ event on each window from window A's root down to but not including window A, with the detail member of each XFocusInEvent structure set to -NotifyNonlinearVirtual . +NotifyNonlinearVirtual. @@ -2469,7 +2469,7 @@ event on window A, with the detail member of the XFocusInEvent structure set to -NotifyNonlinear . +NotifyNonlinear. @@ -2480,7 +2480,7 @@ event on each window below window A down to and including window P, with the detail member of each XFocusInEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2499,14 +2499,14 @@ the X server does the following: If the old focus is -PointerRoot , +PointerRoot, it generates a FocusOut event on each window from window P up to and including window P's root, with the detail member of each XFocusOutEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2519,7 +2519,7 @@ with the detail member of each structure set to either NotifyPointerRoot or -NotifyDetailNone . +NotifyDetailNone. @@ -2532,20 +2532,20 @@ with the detail member of each structure set to NotifyDetailNone or -NotifyPointerRoot . +NotifyPointerRoot. If the new focus is -PointerRoot , +PointerRoot, it generates a FocusIn event on each window from window P's root down to and including window P, with the detail member of each XFocusInEvent structure set to -NotifyPointer . +NotifyPointer. @@ -2565,7 +2565,7 @@ are identified by or XFocusOutEvent structures whose mode member is set to -NotifyGrab . +NotifyGrab. Focus events in which the keyboard grab deactivates are identified by XFocusInEvent @@ -2574,7 +2574,7 @@ or structures whose mode member is set to NotifyUngrab (see -XGrabKeyboard ). +XGrabKeyboard). @@ -2598,7 +2598,7 @@ events, with the mode members of the and XFocusOutEvent structures set to -NotifyGrab . +NotifyGrab. These events are generated as if the focus were to change from F to G. @@ -2626,7 +2626,7 @@ events, with the mode members of the and XFocusOutEvent structures set to -NotifyUngrab . +NotifyUngrab. These events are generated as if the focus were to change from G to F. @@ -2738,7 +2738,7 @@ events are not as definite as those for other events. However, the X server never generates Expose events on windows whose class you specified as -InputOnly . +InputOnly. The X server can generate Expose events when no valid contents are available for regions of a window @@ -2749,7 +2749,7 @@ or the window is not viewable but the server is (perhaps newly) honoring the window's backing-store attribute of Always or -WhenMapped . +WhenMapped. The regions decompose into an (arbitrary) set of rectangles, and an Expose @@ -2830,7 +2830,7 @@ events to clients wanting information about when a destination region could not be computed during certain graphics requests: XCopyArea or -XCopyPlane . +XCopyPlane. The X server generates this event whenever a destination region could not be computed because of an obscured or out-of-bounds source region. In addition, the X server guarantees to report contiguously all of the regions exposed by @@ -2861,12 +2861,12 @@ or 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 or by calling -XSetGraphicsExposures . +XSetGraphicsExposures. @@ -2920,14 +2920,14 @@ The major_code member is set to the graphics request initiated by the client and can be either 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. @@ -3048,10 +3048,10 @@ 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 as a result of a client application calling -XCirculateSubwindows , -XCirculateSubwindowsUp , +XCirculateSubwindows, +XCirculateSubwindowsUp, or -XCirculateSubwindowsDown . +XCirculateSubwindowsDown. @@ -3101,12 +3101,12 @@ The place member is set to the window's position after the restack occurs and is either 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. @@ -3131,47 +3131,47 @@ window requests made by a client application actually completes: A window's size, position, border, and/or stacking order is reconfigured by calling -XConfigureWindow . +XConfigureWindow. The window's position in the stacking order is changed by calling -XLowerWindow , -XRaiseWindow , +XLowerWindow, +XRaiseWindow, or -XRestackWindows . +XRestackWindows. A window is moved by calling -XMoveWindow . +XMoveWindow. A window's size is changed by calling -XResizeWindow . +XResizeWindow. A window's size and location is changed by calling -XMoveResizeWindow . +XMoveResizeWindow. A window is mapped and its position in the stacking order is changed by calling -XMapRaised . +XMapRaised. A window's border width is changed by calling -XSetWindowBorderWidth . +XSetWindowBorderWidth. @@ -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. @@ -3269,7 +3269,7 @@ The X server generates this event whenever a client application creates a window by calling XCreateWindow or -XCreateSimpleWindow . +XCreateSimpleWindow. @@ -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. @@ -3339,7 +3339,7 @@ The X server generates this event whenever a client application destroys a window by calling XDestroyWindow or -XDestroySubwindows . +XDestroySubwindows. @@ -3411,10 +3411,10 @@ events to clients wanting information about when a window is moved because of a change in the size of its parent. The X server generates this event whenever a client application actually moves a child window as a result of resizing its parent by calling -XConfigureWindow , -XMoveResizeWindow , +XConfigureWindow, +XMoveResizeWindow, or -XResizeWindow . +XResizeWindow. @@ -3480,10 +3480,10 @@ The X server can report 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 -XMapWindow , -XMapRaised , -XMapSubwindows , -XReparentWindow , +XMapWindow, +XMapRaised, +XMapSubwindows, +XReparentWindow, or as a result of save-set processing. @@ -3533,7 +3533,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 attribute is -True , +True, because these events usually are generated from pop-ups, which override structure control. @@ -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. @@ -3627,7 +3627,7 @@ and count represents the number of keycodes altered. To update the client application's knowledge of the keyboard, you should call -XRefreshKeyboardMapping . +XRefreshKeyboardMapping. @@ -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. @@ -3766,7 +3766,7 @@ The from_configure member is set to 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. @@ -3785,7 +3785,7 @@ 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. @@ -3793,11 +3793,11 @@ All 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 event on a given window is generated before any @@ -3811,8 +3811,8 @@ The X protocol does not constrain the ordering of VisibilityNotify events with respect to -FocusOut , -EnterNotify , +FocusOut, +EnterNotify, and LeaveNotify events. @@ -3851,10 +3851,10 @@ 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 @@ -3868,7 +3868,7 @@ or not viewable to viewable and completely unobscured, the X server generates the event with the state member of the XVisibilityEvent structure set to -VisibilityUnobscured . +VisibilityUnobscured. @@ -3878,7 +3878,7 @@ not viewable to viewable and partially obscured, the X server generates the event with the state member of the XVisibilityEvent structure set to -VisibilityPartiallyObscured . +VisibilityPartiallyObscured. @@ -3889,7 +3889,7 @@ fully obscured, the X server generates the event with the state member of the XVisibilityEvent structure set to -VisibilityFullyObscured . +VisibilityFullyObscured. @@ -3947,10 +3947,10 @@ on a specified window. The X server generates this event type whenever a client initiates a circulate window request on a window and a subwindow actually needs to be restacked. The client initiates a circulate window request on the window by calling -XCirculateSubwindows , -XCirculateSubwindowsUp , +XCirculateSubwindows, +XCirculateSubwindowsUp, or -XCirculateSubwindowsDown . +XCirculateSubwindowsDown. @@ -4002,12 +4002,12 @@ The place member is set to what the new position in the stacking order should be and is either 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. @@ -4028,16 +4028,16 @@ The configure window request attempts to reconfigure a window's size, position, border, and stacking order. The X server generates this event whenever a different client initiates a configure window request on a window by calling -XConfigureWindow , -XLowerWindow , -XRaiseWindow , -XMapRaised , -XMoveResizeWindow , -XMoveWindow , -XResizeWindow , -XRestackWindows , +XConfigureWindow, +XLowerWindow, +XRaiseWindow, +XMapRaised, +XMoveResizeWindow, +XMoveWindow, +XResizeWindow, +XRestackWindows, or -XSetWindowBorderWidth . +XSetWindowBorderWidth. @@ -4057,7 +4057,7 @@ If you had selected 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 event to you and does not lower the specified window. @@ -4104,7 +4104,7 @@ except in the case of above (sibling) and detail (stack-mode), which are reported as None and -Above , +Above, respectively, if they are not given in the request. @@ -4125,12 +4125,12 @@ 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 , +XMapWindow, +XMapRaised, or -XMapSubwindows . +XMapSubwindows. @@ -4150,7 +4150,7 @@ If you (usually a window manager) had selected 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 event to you @@ -4201,10 +4201,10 @@ events to clients wanting information about another client's attempts to change size of a window. The X server generates this event whenever some other client attempts to change the size of the specified window by calling -XConfigureWindow , -XResizeWindow , +XConfigureWindow, +XResizeWindow, or -XMoveResizeWindow . +XMoveResizeWindow. @@ -4268,8 +4268,8 @@ Changes the colormap member of the XSetWindowAttributes structure by calling -XChangeWindowAttributes , -XFreeColormap , +XChangeWindowAttributes, +XFreeColormap, or XSetWindowColormap @@ -4322,26 +4322,26 @@ colormap is changed, installed, or uninstalled. For a colormap that is changed, installed, or uninstalled, the colormap member is set to the colormap associated with the window. For a colormap that is changed by a call to -XFreeColormap , +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 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 or -ColormapUninstalled . +ColormapUninstalled. @@ -4397,7 +4397,7 @@ events The X server generates ClientMessage events only when a client calls the function -XSendEvent . +XSendEvent. @@ -4498,7 +4498,7 @@ The state member is set to indicate whether the property was changed to a new value or deleted and can be PropertyNewValue or -PropertyDelete . +PropertyDelete. The state member is set to PropertyNewValue when a property of the window is changed using @@ -4506,18 +4506,18 @@ when a property of the window is changed using or XRotateWindowProperties (even when adding zero-length data using -XChangeProperty ) +XChangeProperty) and when replacing all or part of a property with identical data using XChangeProperty or -XRotateWindowProperties . +XRotateWindowProperties. The state member is set to PropertyDelete when a property of the window is deleted using XDeleteProperty or, if the delete argument is -True , -XGetWindowProperty . +True, +XGetWindowProperty. @@ -4534,7 +4534,7 @@ The X server reports 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 -XSetSelectionOwner . +XSetSelectionOwner. @@ -4625,7 +4625,7 @@ 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 value from the @@ -4656,12 +4656,12 @@ This event is generated by the X server in response to a 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 -XSendEvent . +XSendEvent. 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). @@ -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 9ab88c4f..a92ba637 100644 --- a/specs/libX11/CH11.xml +++ b/specs/libX11/CH11.xml @@ -37,9 +37,9 @@ One way is to set the event_mask member of the structure when you call XCreateWindow and -XChangeWindowAttributes . +XChangeWindowAttributes. Another way is to use -XSelectInput . +XSelectInput. XSelectInput @@ -118,13 +118,13 @@ to all interested clients. Only one client at a time can select -CirculateRequest , -ConfigureRequest , +CirculateRequest, +ConfigureRequest, or MapRequest events, which are associated with the event mask -SubstructureRedirectMask . +SubstructureRedirectMask. @@ -134,7 +134,7 @@ a ResizeRequest event, which is associated with the event mask -ResizeRedirectMask . +ResizeRedirectMask. @@ -143,7 +143,7 @@ Only one client at a time can select a ButtonPress event, which is associated with the event mask -ButtonPressMask . +ButtonPressMask. @@ -177,7 +177,7 @@ These functions differ in the additional tasks they might perform. To flush the output buffer, use -XFlush . +XFlush. XFlush @@ -209,10 +209,10 @@ function flushes the output buffer. Most client applications need not use this function because the output buffer is automatically flushed as needed by calls to -XPending , -XNextEvent , +XPending, +XNextEvent, and -XWindowEvent . +XWindowEvent. XPending XNextEvent XWindowEvent @@ -223,7 +223,7 @@ Events generated by the server may be enqueued into the library's event queue. To flush the output buffer and then wait until all requests have been processed, use -XSync . +XSync. XSync @@ -277,18 +277,18 @@ 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 XSync was called. Client applications seldom need to call -XSync . +XSync. @@ -306,7 +306,7 @@ in its network connection that is not yet read into the event queue. To check the number of events in the event queue, use -XEventsQueued . +XEventsQueued. XEventsQueued @@ -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, @@ -380,7 +380,7 @@ queue. with mode QueuedAfterFlush is identical in behavior to -XPending . +XPending. XEventsQueued with mode QueuedAlready @@ -392,7 +392,7 @@ function. To return the number of events that are pending, use -XPending . +XPending. XPending @@ -466,7 +466,7 @@ predicate procedures that you provide To get the next event and remove it from the queue, use -XNextEvent . +XNextEvent. XNextEvent @@ -516,7 +516,7 @@ flushes the output buffer and blocks until an event is received. To peek at the event queue, use -XPeekEvent . +XPeekEvent. XPeekEvent @@ -583,7 +583,7 @@ If Xlib has been initialized for threads, the predicate is called with the display locked and the result of a call by the predicate to any Xlib function that locks the display is not defined unless the caller has first called -XLockDisplay . +XLockDisplay. @@ -628,8 +628,8 @@ structure. Specifies the argument passed in from the -XIfEvent , -XCheckIfEvent , +XIfEvent, +XCheckIfEvent, or XPeekIfEvent function. @@ -644,16 +644,16 @@ function. The predicate procedure is called once for each event in the queue until it finds a match. After finding a match, the predicate procedure must return -True . +True. If it did not find a match, it must return -False . +False. To check the event queue for a matching event and, if found, remove the event from the queue, use -XIfEvent . +XIfEvent. XIfEvent @@ -732,7 +732,7 @@ structure. To check the event queue for a matching event without blocking, use -XCheckIfEvent . +XCheckIfEvent. XCheckIfEvent @@ -797,12 +797,12 @@ When the predicate procedure finds a match, copies the matched event into the client-supplied 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. @@ -811,7 +811,7 @@ All earlier events stored in the queue are not discarded. To check the event queue for a matching event without removing the event from the queue, use -XPeekIfEvent . +XPeekIfEvent. XPeekIfEvent @@ -900,7 +900,7 @@ or event types, allowing you to process events out of order. To remove the next event that matches both a window and an event mask, use -XWindowEvent . +XWindowEvent. XWindowEvent @@ -979,7 +979,7 @@ flushes the output buffer and blocks until one is received. To remove the next event that matches both a window and an event mask (if any), use -XCheckWindowEvent . +XCheckWindowEvent. XCheckWindowEvent This function is similar to XWindowEvent @@ -1055,19 +1055,19 @@ If it finds a match, removes that event, copies it into the specified 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. To remove the next event that matches an event mask, use -XMaskEvent . +XMaskEvent. XMaskEvent @@ -1133,7 +1133,7 @@ flushes the output buffer and blocks until one is received. To return and remove the next event that matches an event mask (if any), use -XCheckMaskEvent . +XCheckMaskEvent. This function is similar to XMaskEvent except that it never blocks and it returns a @@ -1195,19 +1195,19 @@ If it finds a match, removes that event, copies it into the specified 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. To return and remove the next event in the queue that matches an event type, use -XCheckTypedEvent . +XCheckTypedEvent. XCheckTypedEvent @@ -1265,12 +1265,12 @@ If it finds a match, removes that event, copies it into the specified 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. @@ -1278,7 +1278,7 @@ and the output buffer will have been flushed. To return and remove the next event in the queue that matches an event type and a window, use -XCheckTypedWindowEvent . +XCheckTypedWindowEvent. XCheckTypedWindowEvent @@ -1348,12 +1348,12 @@ If it finds a match, removes the event from the queue, copies it into the specified 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. @@ -1366,7 +1366,7 @@ and the output buffer will have been flushed. To push an event back into the event queue, use -XPutBackEvent . +XPutBackEvent. XPutBackEvent @@ -1410,7 +1410,7 @@ by copying the event into the queue. This can be useful if you read an event and then decide that you would rather deal with it later. There is no limit to the number of times in succession that you can call -XPutBackEvent . +XPutBackEvent. @@ -1421,7 +1421,7 @@ There is no limit to the number of times in succession that you can call To send an event to a specified window, use -XSendEvent . +XSendEvent. XSendEvent This function is often used in selection processing. For example, the owner of a selection should use @@ -1461,9 +1461,9 @@ Specifies the connection to the X server. Specifies the window the event is to be sent to, or -PointerWindow , +PointerWindow, or -InputFocus . +InputFocus. @@ -1516,7 +1516,7 @@ 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. @@ -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. @@ -1587,7 +1587,7 @@ otherwise unaltered and unchecked by the X server except to force send_event to in the forwarded event and to set the serial number in the event correctly; therefore these fields and the display field are ignored by -XSendEvent . +XSendEvent. @@ -1627,7 +1627,7 @@ However, this historical information is highly excessive for most applications. To determine the approximate maximum number of elements in the motion buffer, use -XDisplayMotionBufferSize . +XDisplayMotionBufferSize. XDisplayMotionBufferSize @@ -1665,7 +1665,7 @@ function makes this history available. To get the motion history for a specified window and time, use -XGetMotionEvents . +XGetMotionEvents. 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: @@ -1775,7 +1775,7 @@ The x and y members are set to the coordinates of the pointer and are reported relative to the origin of the specified window. To free the data returned from this call, use -XFree . +XFree. @@ -1865,7 +1865,7 @@ returns the previous after function. To enable or disable synchronization, use -XSynchronize . +XSynchronize. Debuggingsynchronous mode XSynchronize @@ -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. @@ -1942,7 +1942,7 @@ message and exit. To set the error handler, use -XSetErrorHandler . +XSetErrorHandler. XSetErrorHandler @@ -1973,8 +1973,8 @@ supplied error handler whenever an error is received. It is not called on BadName errors from -OpenFont , -LookupColor , +OpenFont, +LookupColor, or AllocNamedColor protocol requests or on @@ -2114,14 +2114,14 @@ chapter: BadFont A value for a font argument does not name a defined font (or, in some cases, - GContext ). + GContext). BadGC A value for a GContext argument does not name a defined - GContext . + GContext. BadIDChoice @@ -2212,13 +2212,13 @@ chapter: The -BadAtom , -BadColor , -BadCursor , -BadDrawable , -BadFont , -BadGC , -BadPixmap , +BadAtom, +BadColor, +BadCursor, +BadDrawable, +BadFont, +BadGC, +BadPixmap, and BadWindow errors are also used when the argument type is extended by a set of @@ -2231,7 +2231,7 @@ fixed alternatives. To obtain textual descriptions of the specified error code, use -XGetErrorText . +XGetErrorText. XGetErrorText Debuggingerror message strings @@ -2304,7 +2304,7 @@ and error strings. To obtain error messages from the error database, use -XGetErrorDatabaseText . +XGetErrorDatabaseText. XGetErrorDatabaseText @@ -2435,7 +2435,7 @@ For a core protocol request, the major request protocol number is used for the message argument. For an extension request, the extension name (as given by -InitExtension ) +InitExtension) followed by a period (\.) and the minor request protocol number is used for the message argument. If no string is found in the error database, @@ -2449,7 +2449,7 @@ the default_string is returned to the buffer argument. To report an error to the user when the requested display does not exist, use -XDisplayName . +XDisplayName. XDisplayName @@ -2492,7 +2492,7 @@ program attempted to open when the initial connection attempt failed. To handle fatal I/O errors, use -XSetIOErrorHandler . +XSetIOErrorHandler. XSetIOErrorHandler diff --git a/specs/libX11/CH12.xml b/specs/libX11/CH12.xml index 961f2e40..6c870270 100644 --- a/specs/libX11/CH12.xml +++ b/specs/libX11/CH12.xml @@ -44,7 +44,7 @@ further mouse and keyboard events will continue to be processed. If the keyboard or pointer is in synchronous mode, no further events are processed until the grabbing client allows them (see -XAllowEvents ). +XAllowEvents). The keyboard or pointer is considered frozen during this interval. The event that triggered the grab can also be replayed. @@ -63,7 +63,7 @@ An active grab occurs when a single client grabs the keyboard and/or pointer explicitly (see XGrabPointer and -XGrabKeyboard ). +XGrabKeyboard). Passive grab A passive grab occurs when clients grab a particular keyboard key or pointer button in a window, @@ -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,38 +120,38 @@ 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. To grab the pointer, use -XGrabPointer . +XGrabPointer. Grabbingpointer Pointergrabbing XGrabPointer @@ -224,7 +224,7 @@ Specifies further processing of pointer events. You can pass GrabModeSync or -GrabModeAsync . +GrabModeAsync. @@ -238,7 +238,7 @@ Specifies further processing of keyboard events. You can pass 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. @@ -290,7 +290,7 @@ 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. @@ -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 @@ -389,26 +389,26 @@ 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 errors. @@ -417,7 +417,7 @@ errors. To ungrab the pointer, use -XUngrabPointer . +XUngrabPointer. Ungrabbingpointer Pointerungrabbing XUngrabPointer @@ -449,7 +449,7 @@ Specifies the connection to the X server. Specifies the time. You can pass either a timestamp or -CurrentTime . +CurrentTime. @@ -462,8 +462,8 @@ The XUngrabPointer function releases the pointer and any queued events if this client has actively grabbed the pointer from -XGrabPointer , -XGrabButton , +XGrabPointer, +XGrabButton, or from a normal button press. XUngrabPointer does not release the pointer if the specified @@ -485,7 +485,7 @@ outside the boundaries of the root window. To change an active pointer grab, use -XChangeActivePointerGrab . +XChangeActivePointerGrab. Pointergrabbing Changingpointer grab XChangeActivePointerGrab @@ -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. @@ -556,9 +556,9 @@ function changes the specified dynamic parameters if the pointer is actively grabbed by the client and if the specified time is no earlier than the last-pointer-grab time and no later than the current X server time. This function has no effect on the passive parameters of an -XGrabButton . +XGrabButton. The interpretation of event_mask and cursor is the same as described in -XGrabPointer . +XGrabPointer. @@ -573,7 +573,7 @@ errors. To grab a pointer button, use -XGrabButton . +XGrabButton. Grabbingbuttons Buttongrabbing XGrabButton @@ -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. @@ -671,7 +671,7 @@ Specifies further processing of pointer events. You can pass GrabModeSync or -GrabModeAsync . +GrabModeAsync. @@ -685,7 +685,7 @@ Specifies further processing of keyboard events. You can pass 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. @@ -721,7 +721,7 @@ The function establishes a passive grab. In the future, the pointer is actively grabbed (as for -XGrabPointer ), +XGrabPointer), the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the ButtonPress @@ -757,7 +757,7 @@ on any ancestor of grab_window. The interpretation of the remaining arguments is as for -XGrabPointer . +XGrabPointer. The active grab is terminated automatically when the logical state of the pointer has all buttons released (independent of the state of the logical modifier keys). @@ -794,7 +794,7 @@ error results. When using AnyModifier or -AnyButton , +AnyButton, the request fails completely, and a BadAccess @@ -807,8 +807,8 @@ has no effect on an active grab. XGrabButton can generate -BadCursor , -BadValue , +BadCursor, +BadValue, and BadWindow errors. @@ -817,7 +817,7 @@ errors. To ungrab a pointer button, use -XUngrabButton . +XUngrabButton. Ungrabbingbuttons Buttonungrabbing XUngrabButton @@ -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. @@ -924,21 +924,21 @@ 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. To grab the keyboard, use -XGrabKeyboard . +XGrabKeyboard. Keyboardgrabbing Grabbingkeyboard XGrabKeyboard @@ -996,7 +996,7 @@ Specifies further processing of pointer events. You can pass GrabModeSync or -GrabModeAsync . +GrabModeAsync. @@ -1010,7 +1010,7 @@ Specifies further processing of keyboard events. You can pass GrabModeSync or -GrabModeAsync . +GrabModeAsync. @@ -1022,7 +1022,7 @@ or Specifies the time. You can pass either a timestamp or -CurrentTime . +CurrentTime. @@ -1043,7 +1043,7 @@ 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 @@ -1062,13 +1062,13 @@ 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,19 +1098,19 @@ 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). @@ -1126,7 +1126,7 @@ errors. To ungrab the keyboard, use -XUngrabKeyboard . +XUngrabKeyboard. Keyboardungrabbing Ungrabbingkeyboard XUngrabKeyboard @@ -1158,7 +1158,7 @@ Specifies the connection to the X server. Specifies the time. You can pass either a timestamp or -CurrentTime . +CurrentTime. @@ -1174,7 +1174,7 @@ releases the keyboard and any queued events if this client has it actively grabb either XGrabKeyboard or -XGrabKey . +XGrabKey. XUngrabKeyboard does not release the keyboard and any queued events if the specified time is earlier than @@ -1193,7 +1193,7 @@ active keyboard grab becomes not viewable. To passively grab a single key of the keyboard, use -XGrabKey . +XGrabKey. Keygrabbing Grabbingkeys XGrabKey @@ -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. @@ -1275,7 +1275,7 @@ Specifies further processing of pointer events. You can pass GrabModeSync or -GrabModeAsync . +GrabModeAsync. @@ -1289,7 +1289,7 @@ Specifies further processing of keyboard events. You can pass GrabModeSync or -GrabModeAsync . +GrabModeAsync. @@ -1303,7 +1303,7 @@ The function establishes a passive grab on the keyboard. In the future, the keyboard is actively grabbed (as for -XGrabKeyboard ), +XGrabKeyboard), the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the KeyPress @@ -1336,7 +1336,7 @@ on any ancestor of grab_window. The interpretation of the remaining arguments is as for -XGrabKeyboard . +XGrabKeyboard. The active grab is terminated automatically when the logical state of the keyboard has the specified key released (independent of the logical state of the modifier keys). @@ -1376,7 +1376,7 @@ error results. When using AnyModifier or -AnyKey , +AnyKey, the request fails completely, and a BadAccess @@ -1387,8 +1387,8 @@ if there is a conflicting grab for any combination. XGrabKey can generate -BadAccess , -BadValue , +BadAccess, +BadValue, and BadWindow errors. @@ -1397,7 +1397,7 @@ errors. To ungrab a key, use -XUngrabKey . +XUngrabKey. Keyungrabbing Ungrabbingkeys XUngrabKey @@ -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. @@ -1500,7 +1500,7 @@ describes the mechanism for resuming event processing. To allow further events to be processed when the device has been frozen, use -XAllowEvents . +XAllowEvents. XAllowEvents @@ -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. @@ -1611,7 +1611,7 @@ Depending on the event_mode argument, the following occurs: with mode SyncPointer but not from an - XGrabPointer ), + XGrabPointer), the pointer grab is released and that event is completely reprocessed. This time, however, the function ignores any passive grabs at or above (toward the root of) the grab_window of the grab just released. @@ -1656,7 +1656,7 @@ Depending on the event_mode argument, the following occurs: with mode SyncKeyboard but not from an - XGrabKeyboard ), + XGrabKeyboard), the keyboard grab is released and that event is completely reprocessed. This time, however, the function ignores any passive grabs at or above (toward the root of) @@ -1668,9 +1668,9 @@ Depending on the event_mode argument, the following occurs: 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 event is reported to the client for a grabbed device @@ -1707,14 +1707,14 @@ Depending on the event_mode argument, the following occurs: -AsyncPointer , -SyncPointer , +AsyncPointer, +SyncPointer, and ReplayPointer have no effect on the processing of keyboard events. -AsyncKeyboard , -SyncKeyboard , +AsyncKeyboard, +SyncKeyboard, and ReplayKeyboard have no effect on the @@ -1755,7 +1755,7 @@ pointer to a new position under program control. To move the pointer to an arbitrary point in a window, use -XWarpPointer . +XWarpPointer. XWarpPointer @@ -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. @@ -1929,7 +1929,7 @@ for input focus policy. To set the input focus, use -XSetInputFocus . +XSetInputFocus. XSetInputFocus @@ -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,7 +2005,7 @@ 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 @@ -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. @@ -2063,10 +2063,10 @@ 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. @@ -2074,11 +2074,11 @@ and the new revert_to value is taken to be If revert_to is RevertToPointerRoot or -RevertToNone , +RevertToNone, the focus reverts to PointerRoot or -None , +None, respectively. When the focus reverts, the X server generates @@ -2093,8 +2093,8 @@ events, but the last-focus-change time is not affected. XSetInputFocus can generate -BadMatch , -BadValue , +BadMatch, +BadValue, and BadWindow errors. @@ -2103,7 +2103,7 @@ errors. To obtain the current input focus, use -XGetInputFocus . +XGetInputFocus. XGetInputFocus @@ -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). @@ -2265,7 +2265,7 @@ the state of that LED is changed, if possible. The led_mode member can be set to 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. @@ -2278,10 +2278,10 @@ 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 @@ -2295,10 +2295,10 @@ 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 @@ -2387,7 +2387,7 @@ errors. To obtain the current control values for the keyboard, use -XGetKeyboardControl . +XGetKeyboardControl. XGetKeyboardControl @@ -2459,7 +2459,7 @@ and each bit set to 1 in led_mask indicates an LED that is li The global_auto_repeat member can be set to 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. @@ -2471,7 +2471,7 @@ with the least significant bit in the byte representing key 8N. To turn on keyboard auto-repeat, use -XAutoRepeatOn . +XAutoRepeatOn. XAutoRepeatOn @@ -2505,7 +2505,7 @@ function turns on auto-repeat for the keyboard on the specified display. To turn off keyboard auto-repeat, use -XAutoRepeatOff . +XAutoRepeatOff. XAutoRepeatOff @@ -2539,7 +2539,7 @@ function turns off auto-repeat for the keyboard on the specified display. To ring the bell, use -XBell . +XBell. XBell @@ -2610,7 +2610,7 @@ base + [(base * percent) / 100] To change the base volume of the bell, use -XChangeKeyboardControl . +XChangeKeyboardControl. @@ -2623,7 +2623,7 @@ error. To obtain a bit vector that describes the state of the keyboard, use -XQueryKeymap . +XQueryKeymap. XQueryKeymap @@ -2679,7 +2679,7 @@ may lag the physical state if device event processing is frozen. To set the mapping of the pointer buttons, use -XSetPointerMapping . +XSetPointerMapping. XSetPointerMapping @@ -2735,7 +2735,7 @@ If it succeeds, the X server generates a 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 @@ -2753,7 +2753,7 @@ 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. @@ -2767,7 +2767,7 @@ error. To get the pointer mapping, use -XGetPointerMapping . +XGetPointerMapping. XGetPointerMapping @@ -2830,7 +2830,7 @@ in map_return. To control the pointer's interactive feel, use -XChangePointerControl . +XChangePointerControl. XChangePointerControl @@ -2943,7 +2943,7 @@ error. To get the current pointer parameters, use -XGetPointerControl . +XGetPointerControl. XGetPointerControl @@ -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'' @@ -3097,7 +3097,7 @@ by attaching that KeySym to some KeyCode and attaching that KeyCode to any one of the modifiers Mod1 through -Mod5 . +Mod5. This modifier is called the group modifier. For any KeyCode, Group 1 is used when the group modifier is off, @@ -3127,7 +3127,7 @@ by attaching that KeySym to some KeyCode and attaching that KeyCode to any one of the modifiers Mod1 through -Mod5 . +Mod5. This modifier is called the numlock modifier. The standard KeySyms with the prefix ``XK_KP_'' in their @@ -3212,7 +3212,7 @@ Rather, it merely stores it for reading and writing by clients. To obtain the legal KeyCodes for a display, use -XDisplayKeycodes . +XDisplayKeycodes. XDisplayKeycodes @@ -3271,7 +3271,7 @@ Not all KeyCodes in this range are required to have corresponding keys. To obtain the symbols for the specified KeyCodes, use -XGetKeyboardMapping . +XGetKeyboardMapping. XGetKeyboardMapping @@ -3337,7 +3337,7 @@ function returns the symbols for the specified number of KeyCodes starting with first_keycode. The value specified in first_keycode must be greater than or equal to min_keycode as returned by -XDisplayKeycodes , +XDisplayKeycodes, or a BadValue error results. @@ -3381,9 +3381,9 @@ A special KeySym value of is used to fill in unused elements for individual KeyCodes. To free the storage returned by -XGetKeyboardMapping , +XGetKeyboardMapping, use -XFree . +XFree. @@ -3396,7 +3396,7 @@ error. To change the keyboard mapping, use -XChangeKeyboardMapping . +XChangeKeyboardMapping. XChangeKeyboardMapping @@ -3484,13 +3484,13 @@ num_codes * keysyms_per_keycode The specified first_keycode must be greater than or equal to min_keycode returned by -XDisplayKeycodes , +XDisplayKeycodes, or a BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by -XDisplayKeycodes , +XDisplayKeycodes, or a BadValue error results: @@ -3568,7 +3568,7 @@ typedef struct { To create an XModifierKeymap structure, use -XNewModifiermap . +XNewModifiermap. XNewModifiermap @@ -3607,7 +3607,7 @@ structure for later use. To add a new entry to an XModifierKeymap structure, use -XInsertModifiermapEntry . +XInsertModifiermapEntry. XInsertModifiermapEntry @@ -3670,7 +3670,7 @@ structure (expanded as needed). To delete an entry from an XModifierKeymap structure, use -XDeleteModifiermapEntry . +XDeleteModifiermapEntry. XDeleteModifiermapEntry @@ -3733,7 +3733,7 @@ structure. To destroy an XModifierKeymap structure, use -XFreeModifiermap . +XFreeModifiermap. XFreeModifiermap @@ -3771,7 +3771,7 @@ structure. To set the KeyCodes to be used as modifiers, use -XSetModifierMapping . +XSetModifierMapping. XSetModifierMapping @@ -3820,7 +3820,7 @@ the X server generates a event, and XSetModifierMapping returns -MappingSuccess . +MappingSuccess. X permits at most 8 modifier keys. If more than 8 are specified in the XModifierKeymap @@ -3834,15 +3834,15 @@ The modifiermap member of the 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 @@ -3862,14 +3862,14 @@ 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. @@ -3885,7 +3885,7 @@ errors. To obtain the KeyCodes used as modifiers, use -XGetModifierMapping . +XGetModifierMapping. XGetModifierMapping @@ -3917,7 +3917,7 @@ function returns a pointer to a newly created XModifierKeymap structure that contains the keys being used as modifiers. The structure should be freed after use by calling -XFreeModifiermap . +XFreeModifiermap. If only zero values appear in the set for any modifier, that modifier is disabled. diff --git a/specs/libX11/CH13.xml b/specs/libX11/CH13.xml index 4c6fc408..b1f5195e 100644 --- a/specs/libX11/CH13.xml +++ b/specs/libX11/CH13.xml @@ -70,14 +70,14 @@ The remainder of this chapter discusses: X supports one or more of the locales defined by the host environment. On implementations that conform to the ANSI C library, the locale announcement method is -setlocale . +setlocale. This function configures the locale operation of both the host C library and Xlib. The operation of Xlib is governed by the LC_CTYPE category; this is called the current locale. An implementation is permitted to provide implementation-dependent mechanisms for announcing the locale in addition to -setlocale . +setlocale. @@ -94,7 +94,7 @@ for a specific locale is implementation-dependent. X is not required to support all the locales supported by the host. To determine if the current locale is supported by X, use -XSupportsLocale . +XSupportsLocale. Bool XSupportsLocale() @@ -108,11 +108,11 @@ function returns 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 return status is defined will return -XLocaleNotSupported . +XLocaleNotSupported. Other Xlib locale-dependent routines will operate in the ``C'' locale. @@ -124,9 +124,9 @@ Most single-display X clients operate in a single locale for both X and the host processing environment. They will configure the locale by calling three functions: the host locale configuration function, -XSupportsLocale , +XSupportsLocale, and -XSetLocaleModifiers . +XSetLocaleModifiers. @@ -140,7 +140,7 @@ is selecting one of several styles of keyboard input method. To configure Xlib locale modifiers for the current locale, use -XSetLocaleModifiers . +XSetLocaleModifiers. XSetLocaleModifiers @@ -396,7 +396,7 @@ the following table describes the locale (and modifiers) dependency: - XLocaleOfIM , and so on + XLocaleOfIM, and so on Queried locale @@ -433,31 +433,31 @@ the following table describes the locale (and modifiers) dependency: - XLocaleOfOM , and so on + XLocaleOfOM, and so on Queried locale XFontSet - XmbDrawText , + XmbDrawText, Locale of supplied text - XwcDrawText , and so on + XwcDrawText, and so on Locale of supplied text - XExtentsOfFontSet , and so on + XExtentsOfFontSet, and so on Locale-dependent metrics - XmbTextExtents , + XmbTextExtents, - XwcTextExtents , and so on + XwcTextExtents, and so on @@ -501,11 +501,11 @@ with a non-NULL argument, they must save and restore the current state on entry and exit.) Also, Xlib functions on implementations that conform to the ANSI C library do not alter the global state associated with the ANSI C functions -mblen , -mbtowc , -wctomb , +mblen, +mbtowc, +wctomb, and -strtok . +strtok. @@ -520,7 +520,7 @@ 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. @@ -539,7 +539,7 @@ A NULL identifies the end of a nested list. To allocate a nested variable argument list dynamically, use -XVaCreateNestedList . +XVaCreateNestedList. XVaCreateNestedList @@ -711,7 +711,7 @@ 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 in terms of its functional interface, but is @@ -726,7 +726,7 @@ a broader, more generalized abstraction. To open an output method, use -XOpenOM . +XOpenOM. XOpenOM @@ -831,7 +831,7 @@ if res_name or res_class is NULL. The res_name and res_class arguments are not assumed to exist beyond the call to -XOpenOM . +XOpenOM. The specified resource database is assumed to exist for the lifetime of the output method. @@ -844,7 +844,7 @@ returns NULL if no output method could be opened. To close an output method, use -XCloseOM . +XCloseOM. XCloseOM @@ -878,7 +878,7 @@ function closes the specified output method. To set output method attributes, use -XSetOMValues . +XSetOMValues. XSetOMValues @@ -931,7 +931,7 @@ No standard arguments are currently defined by Xlib. To query an output method, use -XGetOMValues . +XGetOMValues. XGetOMValues @@ -979,7 +979,7 @@ it returns the name of the first argument that could not be obtained. To obtain the display associated with an output method, use -XDisplayOfOM . +XDisplayOfOM. XDisplayOfOM @@ -1013,7 +1013,7 @@ function returns the display associated with the specified output method. To get the locale associated with an output method, use -XLocaleOfOM . +XLocaleOfOM. XLocaleOfOM @@ -1077,7 +1077,7 @@ The following key applies to this table. G - This value may be read using XGetOMValues . + This value may be read using XGetOMValues. @@ -1129,7 +1129,7 @@ The 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. @@ -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. @@ -1181,14 +1181,14 @@ The 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 structure by using -XFree ; +XFree; this also frees the contents of the structure. @@ -1264,11 +1264,11 @@ The 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. @@ -1296,7 +1296,7 @@ The 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 @@ -1343,13 +1343,13 @@ However, is widely used in several interfaces, so XOC is defined as an upward compatible type of -XFontSet . +XFontSet. To create an output context, use -XCreateOC . +XCreateOC. XCreateOC @@ -1435,7 +1435,7 @@ error. To destroy an output context, use -XDestroyOC . +XDestroyOC. XDestroyOC @@ -1469,7 +1469,7 @@ function destroys the specified output context. To get the output method associated with an output context, use -XOMOfOC . +XOMOfOC. XOMOfOC @@ -1507,7 +1507,7 @@ Xlib provides two functions for setting and reading output context values, respectively, XSetOCValues and -XGetOCValues . +XGetOCValues. Both functions have a variable-length argument list. In that argument list, any XOC value's name must be denoted with a character string using the X Portable Character Set. @@ -1516,7 +1516,7 @@ with a character string using the X Portable Character Set. To set XOC values, use -XSetOCValues . +XSetOCValues. XSetOCValues @@ -1593,7 +1593,7 @@ error. To obtain XOC values, use -XGetOCValues . +XGetOCValues. XGetOCValues @@ -1686,20 +1686,20 @@ The following keys apply to this table. C - This value must be set with XCreateOC . + This value must be set with XCreateOC. D - This value may be set using XCreateOC . + This value may be set using XCreateOC. If it is not set,a default is provided. G - This value may be read using XGetOCValues . + This value may be read using XGetOCValues. S - This value must be set using XSetOCValues . + This value must be set using XSetOCValues. @@ -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. @@ -1843,7 +1843,7 @@ The 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. @@ -1891,7 +1891,7 @@ 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. @@ -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. @@ -1926,7 +1926,7 @@ argument specified in the XOrientation list. The value of the argument is of type -XOrientation . +XOrientation. When XNOrientation is queried, the value specifies the current orientation. @@ -1943,7 +1943,7 @@ 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. @@ -1992,7 +1992,7 @@ The string will be freed by a call to with the associated XOC or when the associated value is changed via -XSetOCValues . +XSetOCValues. Until freed, the string contents will not be modified by Xlib. @@ -2010,7 +2010,7 @@ argument specifies a list of one or more 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. @@ -2053,7 +2053,7 @@ 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 @@ -2091,7 +2091,7 @@ function not only destroys the output context but also closes the implicit output method associated with it, XFreeFontSet should be used with any output context created by -XCreateFontSet . +XCreateFontSet. However, it is possible that a client does not know how the output context was created. Before a client destroys the output context, @@ -2120,7 +2120,7 @@ The XFontSet is an opaque type representing the state of a particular output thread and is equivalent to the type -XOC . +XOC. @@ -2131,7 +2131,7 @@ function is a convenience function for creating an output context using only default values. The returned XFontSet has an implicitly created -XOM . +XOM. This XOM has an OM value @@ -2141,7 +2141,7 @@ automatically set to so that the output context self indicates whether it was created by XCreateOC or -XCreateFontSet . +XCreateFontSet. XCreateFontSet @@ -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. @@ -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. @@ -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. @@ -2457,11 +2457,11 @@ The returned and missing charset list should be freed with XFreeFontSet and -XFreeStringList , +XFreeStringList, respectively. The client-supplied base_font_name_list may be freed by the client after calling -XCreateFontSet . +XCreateFontSet. @@ -2469,9 +2469,9 @@ by the client after calling To obtain a list of XFontStruct structures and full font names given an -XFontSet , +XFontSet, use -XFontsOfFontSet . +XFontsOfFontSet. XFontsOfFontSet @@ -2550,7 +2550,7 @@ 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 @@ -2571,16 +2571,16 @@ 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. XBaseFontNameListOfFontSet @@ -2633,16 +2633,16 @@ 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. 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. @@ -2695,7 +2695,7 @@ function is a convenience function for freeing an output context. also frees its associated XOM if the output context was created by -XCreateFontSet . +XCreateFontSet. XFreeFontSet @@ -2738,7 +2738,7 @@ function frees the specified font set. The associated base font name list, font name list, XFontStruct list, and -XFontSetExtents , +XFontSetExtents, if any, are freed. @@ -2778,7 +2778,7 @@ of the drawing origin. The screen location of a particular character image may be determined with XmbTextPerCharExtents or -XwcTextPerCharExtents . +XwcTextPerCharExtents. @@ -2789,7 +2789,7 @@ A string of two characters drawn with XmbDrawString may render differently than if the two characters were drawn with separate calls to -XmbDrawString . +XmbDrawString. If the client appends or inserts a character in a previously drawn string, the client may need to redraw some adjacent characters @@ -2799,7 +2799,7 @@ to obtain proper rendering. To find out about direction-dependent rendering, use -XDirectionalDependentDrawing . +XDirectionalDependentDrawing. XDirectionalDependentDrawing @@ -2831,13 +2831,13 @@ function returns True if the drawing functions implement implicit text directionality; otherwise, it returns -False . +False. To find out about context-dependent rendering, use -XContextualDrawing . +XContextualDrawing. XContextualDrawing @@ -2869,13 +2869,13 @@ function returns True if text drawn with the font set might include context-dependent drawing; otherwise, it returns -False . +False. To find out about context-dependent or direction-dependent rendering, use -XContextDependentDrawing . +XContextDependentDrawing. XContextDependentDrawing @@ -2908,7 +2908,7 @@ function returns 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. @@ -2981,15 +2981,15 @@ individual extent. The rectangles for a given character in a string can be obtained from XmbPerCharExtents or -XwcPerCharExtents . +XwcPerCharExtents. To obtain the maximum extents structure given an -XFontSet , +XFontSet, use -XExtentsOfFontSet . +XExtentsOfFontSet. XExtentsOfFontSet @@ -3031,7 +3031,7 @@ 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. @@ -3041,7 +3041,7 @@ To obtain the escapement in pixels of the specified text as a value, use XmbTextEscapement or -XwcTextEscapement . +XwcTextEscapement. XmbTextEscapement XwcTextEscapement @@ -3133,7 +3133,7 @@ the overall bounding box of the string's image, and a logical bounding box, use XmbTextExtents or -XwcTextExtents . +XwcTextExtents. XmbTextExtents XwcTextExtents @@ -3237,7 +3237,7 @@ and a logical bounding box for spacing purposes, respectively. They return the value returned by XmbTextEscapement or -XwcTextEscapement . +XwcTextEscapement. These metrics are relative to the drawing origin of the string, using the fonts loaded for the specified font set. @@ -3293,7 +3293,7 @@ To obtain per-character information for a text string, use XmbTextPerCharExtents or -XwcTextPerCharExtents . +XwcTextPerCharExtents. XmbTextPerCharExtents XwcTextPerCharExtents @@ -3498,7 +3498,7 @@ return the maximum extent of the string's metrics to overall_ink_return or overall_logical_return, as returned by XmbTextExtents or -XwcTextExtents . +XwcTextExtents. @@ -3511,8 +3511,8 @@ or The functions defined in this section draw text at a specified location in a drawable. They are similar to the functions -XDrawText , -XDrawString , +XDrawText, +XDrawString, and XDrawImageString except that they work with font sets instead of single fonts @@ -3575,7 +3575,7 @@ typedef struct { To draw text using multiple font sets in a given drawable, use XmbDrawText or -XwcDrawText . +XwcDrawText. XmbDrawText XwcDrawText @@ -3712,12 +3712,12 @@ and or XmbTextPerCharExtents and -XwcTextPerCharExtents . +XwcTextPerCharExtents. When the XFontSet has missing charsets, each unavailable character is drawn with the default string returned by -XCreateFontSet . +XCreateFontSet. The behavior for an invalid codepoint is undefined. @@ -3726,7 +3726,7 @@ The behavior for an invalid codepoint is undefined. To draw text using a single font set in a given drawable, use XmbDrawString or -XwcDrawString . +XwcDrawString. XmbDrawString XwcDrawString @@ -3863,7 +3863,7 @@ When the XFontSet has missing charsets, each unavailable character is drawn with the default string returned by -XCreateFontSet . +XCreateFontSet. The behavior for an invalid codepoint is undefined. @@ -3872,7 +3872,7 @@ The behavior for an invalid codepoint is undefined. To draw image text using a single font set in a given drawable, use XmbDrawImageString or -XwcDrawImageString . +XwcDrawImageString. XmbDrawImageString XwcDrawImageString @@ -4011,7 +4011,7 @@ The filled rectangle is the rectangle returned to overall_logical_return by or XwcTextExtents for the same text and -XFontSet . +XFontSet. @@ -4019,7 +4019,7 @@ When the XFontSet has missing charsets, each unavailable character is drawn with the default string returned by -XCreateFontSet . +XCreateFontSet. The behavior for an invalid codepoint is undefined. @@ -4317,7 +4317,7 @@ Often, this type of window is placed at the bottom of the application window. Root-window preediting refers to input methods that use a preedit window that is the child of -RootWindow . +RootWindow. @@ -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. @@ -4448,7 +4448,7 @@ function, providing an argument and affiliating the input context to the input method for its lifetime. When an input method is closed with -XCloseIM , +XCloseIM, all of its affiliated input contexts should not be used any more (and should preferably be destroyed before closing the input method). @@ -4531,7 +4531,7 @@ with the appropriate input context. Also, when the application focus moves out of a text entry area, the application should unset the focus for the associated input context by calling -XUnsetICFocus . +XUnsetICFocus. As an optimization, if XSetICFocus is called successively on two different input contexts, @@ -4612,13 +4612,13 @@ or in its XIMStyles value returned by -XGetIMValues . +XGetIMValues. When a client has decided that it will provide geometry management for an input method, it indicates that decision by setting the XNInputStyle value in the -XIC . +XIC. @@ -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. @@ -4753,7 +4753,7 @@ When the user enters a keystroke, the client calls XmbLookupString or -XwcLookupString . +XwcLookupString. At this point, in the on-the-spot case, the echo of the keystroke in the preedit has not yet been done. Before returning to the client logic that handles the input characters, @@ -4813,7 +4813,7 @@ In this case, composition consists of interpreting a sequence of key events and returning a committed string via XmbLookupString or -XwcLookupString . +XwcLookupString. This provides the basics for input methods. @@ -4899,7 +4899,7 @@ For this reason, an input method supporting this type of conversion should take notice of when the client calls XmbResetIC or -XwcResetIC , +XwcResetIC, which is usually an indication of a context change. @@ -4992,9 +4992,9 @@ additional text. The interface to input methods might appear to be simply creating an input method -( XOpenIM ) +(XOpenIM) and freeing an input method -( XCloseIM ). +(XCloseIM). However, input methods may require complex communication with input method servers (IM servers), for example: @@ -5050,7 +5050,7 @@ functions are provided: XSetIMValue, XSetICValue 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 @@ -5155,7 +5155,7 @@ In order to change the preedit state programmatically, an application needs to call XSetICValues with -XNPreeditState. +XNPreeditState. @@ -5179,7 +5179,7 @@ IM value. To open a connection, use -XOpenIM . +XOpenIM. XOpenIM @@ -5247,7 +5247,7 @@ The locale associated with an input method cannot be changed dynamically. This implies that the strings returned by XmbLookupString or -XwcLookupString , +XwcLookupString, for any input context affiliated with a given input method, will be encoded in the locale current at the time the input method is opened. @@ -5287,7 +5287,7 @@ if res_name or res_class is NULL. The res_name and res_class arguments are not assumed to exist beyond the call to -XOpenIM . +XOpenIM. The specified resource database is assumed to exist for the lifetime of the input method. @@ -5300,7 +5300,7 @@ returns NULL if no input method could be opened. To close a connection, use -XCloseIM . +XCloseIM. XCloseIM @@ -5334,7 +5334,7 @@ function closes the specified input method. To set input method attributes, use -XSetIMValues . +XSetIMValues. XSetIMValues @@ -5387,7 +5387,7 @@ correctly. To query an input method, use -XGetIMValues . +XGetIMValues. XGetIMValues @@ -5450,7 +5450,7 @@ with the returned pointer. To obtain the display associated with an input method, use -XDisplayOfIM . +XDisplayOfIM. XDisplayOfIM @@ -5484,7 +5484,7 @@ function returns the display associated with the specified input method. To get the locale associated with an input method, use -XLocaleOfIM . +XLocaleOfIM. XLocaleOfIM @@ -5518,7 +5518,7 @@ function returns the locale associated with the specified input method. To register an input method instantiate callback, use -XRegisterIMInstantiateCallback . +XRegisterIMInstantiateCallback. XRegisterIMInstantiateCallback @@ -5610,7 +5610,7 @@ locale and modifiers. The function returns True if it succeeds; otherwise, it returns -False . +False. @@ -5663,7 +5663,7 @@ Not used for this callback and always passed as NULL. To unregister an input method instantiation callback, use -XUnregisterIMInstantiateCallback . +XUnregisterIMInstantiateCallback. XUnregisterIMInstantiateCallback @@ -5751,7 +5751,7 @@ registered. The function returns True if it succeeds; otherwise, it returns -False . +False. @@ -5788,17 +5788,17 @@ The following keys apply to this table. D This value may be set using - XSetIMValues . + XSetIMValues. If it is not set, a default is provided. S - This value may be set using XSetIMValues . + This value may be set using XSetIMValues. G - This value may be read using XGetIMValues . + This value may be read using XGetIMValues. @@ -5880,12 +5880,12 @@ 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 structure. To do so, use -XFree . +XFree. @@ -5972,7 +5972,7 @@ by the input method for preedit information. Refer to XIC values XNArea and - XNAreaNeeded . + XNAreaNeeded. XIMPreeditPosition @@ -5981,18 +5981,18 @@ by the input method for preedit information. Refer to XIC values XNSpotLocation and - XNFocusWindow . + XNFocusWindow. 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 @@ -6029,15 +6029,15 @@ by the input method for status information. See XNArea and - XNAreaNeeded . + XNAreaNeeded. XIMStatusCallbacks The input method requires the client to define the set of status callbacks, - XNStatusStartCallback , - XNStatusDoneCallback , + XNStatusStartCallback, + XNStatusDoneCallback, and - XNStatusDrawCallback . + XNStatusDrawCallback. XIMStatusNothing @@ -6091,7 +6091,7 @@ set as resources. The XNDestroyCallback argument is a pointer to a structure of type -XIMCallback . +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 @@ -6099,7 +6099,7 @@ associated input context(s) are destroyed by Xlib. Therefore, the client should not call XCloseIM or -XDestroyIC . +XDestroyIC. @@ -6174,12 +6174,12 @@ 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 structure. To do so, use -XFree . +XFree. @@ -6220,13 +6220,13 @@ 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 in -XIMText ; +XIMText; otherwise, the input method does not use the masks. @@ -6239,7 +6239,7 @@ before using this argument. If the XNVisiblePosition does not exist in the IM values list returned from -XNQueryIMValues , +XNQueryIMValues, the visible position masks of XIMFeedback in @@ -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 . +XNR6PreeditCallbackBehavior. Unfortunately, this argument was not removed from the R6 specification before it was published. @@ -6285,19 +6285,19 @@ values follows Release 5 or Release 6 semantics. The value is of type -Bool . +Bool. When querying for -XNR6PreeditCallbackBehavior , +XNR6PreeditCallbackBehavior, 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 must be set to -True . +True. @@ -6309,7 +6309,7 @@ before using this argument. If the XNR6PreeditCallbackBehavior does not exist in the IM values list returned from -XNQueryIMValues , +XNQueryIMValues, the PreeditCallback behavior is Release 5 semantics. @@ -6339,7 +6339,7 @@ they should be registered with the X Consortium. To create an input context, use -XCreateIC . +XCreateIC. XCreateIC @@ -6403,7 +6403,7 @@ A required argument was not set. A read-only argument was set (for example, -XNFilterEvents ). +XNFilterEvents). @@ -6421,9 +6421,9 @@ The input method encountered an input method implementation-dependent error. XCreateIC can generate -BadAtom , -BadColor , -BadPixmap , +BadAtom, +BadColor, +BadPixmap, and BadWindow errors. @@ -6432,7 +6432,7 @@ errors. To destroy an input context, use -XDestroyIC . +XDestroyIC. XDestroyIC @@ -6469,7 +6469,7 @@ for any changes in keyboard focus from the client side, use XSetICFocus and -XUnsetICFocus . +XUnsetICFocus. XSetICFocus @@ -6558,7 +6558,7 @@ events from the input method that are directed to the focus window. To reset the state of an input context to its initial state, use XmbResetIC or -XwcResetIC . +XwcResetIC. XmbResetIC XwcResetIC @@ -6595,7 +6595,7 @@ Specifies the input context. When XNResetState is set to -XIMInitialState , +XIMInitialState, XmbResetIC and XwcResetIC @@ -6603,7 +6603,7 @@ reset an input context to its initial state; when 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, @@ -6628,13 +6628,13 @@ whether these procedures return a non-NULL string or NULL. The client should free the returned string by calling -XFree . +XFree. To get the input method associated with an input context, use -XIMOfIC . +XIMOfIC. XIMOfIC @@ -6670,7 +6670,7 @@ function returns the input method associated with the specified input context. Xlib provides two functions for setting and reading XIC values, respectively, XSetICValues and -XGetICValues . +XGetICValues. Both functions have a variable-length argument list. In that argument list, any XIC value's name must be denoted with a character string using the X Portable Character Set. @@ -6679,7 +6679,7 @@ with a character string using the X Portable Character Set. To set XIC values, use -XSetICValues . +XSetICValues. XSetICValues @@ -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,10 +6750,10 @@ matching the data type imposed by the semantics of the argument. XSetICValues can generate -BadAtom , -BadColor , -BadCursor , -BadPixmap , +BadAtom, +BadColor, +BadCursor, +BadPixmap, and BadWindow errors. @@ -6762,7 +6762,7 @@ errors. To obtain XIC values, use -XGetICValues . +XGetICValues. XGetICValues @@ -6834,7 +6834,7 @@ The exception to this rule is for an IC value of type 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. @@ -6877,26 +6877,26 @@ The following keys apply to these tables. C - This value must be set with XCreateIC . + This value must be set with XCreateIC. D This value may be set using - XCreateIC .> + XCreateIC.> If it is not set,> a default is provided. G This value may be read using - XGetICValues . + XGetICValues. GN This value may cause geometry negotiation when its value is set by means of XCreateIC or - XSetICValues . + XSetICValues. GR @@ -6915,7 +6915,7 @@ The following keys apply to these tables. S This value may be set with - XSetICValues . + XSetICValues. Ignored @@ -7394,11 +7394,11 @@ the input method may not operate correctly. If an attempt is made to set this value a second time with -XSetICValues , +XSetICValues, the string XNClientWindow will be returned by -XSetICValues , +XSetICValues, and the client window will not be changed. @@ -7453,7 +7453,7 @@ 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 @@ -7544,7 +7544,7 @@ and is never changed. The type of this argument is unsigned -long . +long. Setting this value will cause an error. @@ -7566,7 +7566,7 @@ the input context is destroyed and the input method is closed. Therefore, the client should not call XDestroyIC and -XCloseIM . +XCloseIM. @@ -7618,7 +7618,7 @@ before using this argument. The XNStringConversion argument is a structure of type -XIMStringConversionText . +XIMStringConversionText. @@ -7693,7 +7693,7 @@ The argument specifies the state the input context will return to after calling XmbResetIC or -XwcResetIC . +XwcResetIC. @@ -7751,13 +7751,13 @@ will preserve the current state of the XIC. If XNResetState is left unspecified, the default is -XIMInitialState . +XIMInitialState. XIMResetState values other than those specified above will default to -XIMInitialState . +XIMInitialState. @@ -7782,14 +7782,14 @@ The 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 to -XIMHotKeyStateON . +XIMHotKeyStateON. @@ -7802,7 +7802,7 @@ before using this functionality. The value of the argument is a pointer to a structure of type -XIMHotKeyTriggers . +XIMHotKeyTriggers. @@ -7907,7 +7907,7 @@ typedef unsigned long XIMHotKeyState; If not specified, the default is -XIMHotKeyStateOFF . +XIMHotKeyStateOFF. @@ -7947,7 +7947,7 @@ The names to be used in these lists are described in the following sections. The value of the XNArea argument must be a pointer to a structure of type -XRectangle. +XRectangle. The interpretation of the XNArea argument is dependent on the input method style that has been set. @@ -7955,7 +7955,7 @@ argument is dependent on the input method style that has been set. If the input method style is -XIMPreeditPosition , +XIMPreeditPosition, XNArea specifies the clipping region within which preediting will take place. If the focus window has been set, @@ -7971,7 +7971,7 @@ If 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. @@ -7980,14 +7980,14 @@ the results are undefined. If the input style is XIMPreeditArea or -XIMStatusArea , +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 @@ -8012,7 +8012,7 @@ 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. @@ -8029,7 +8029,7 @@ for the area. This argument is only valid if the input style is 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). @@ -8049,9 +8049,9 @@ argument specifies to the input method the coordinates of the spot to be used by an input method executing with 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. @@ -8088,7 +8088,7 @@ The XNColormap argument is used to specify a colormap ID. The argument value is of type -Colormap . +Colormap. An invalid argument may generate a BadColor error when it is used by the input method. @@ -8103,7 +8103,7 @@ in which the input method should allocate colors. The argument value is an Atom that should be a valid atom for calling -XGetRGBColormaps . +XGetRGBColormaps. An invalid argument may generate a BadAtom error when it is used by the input method. @@ -8130,7 +8130,7 @@ and arguments specify the foreground and background pixel, respectively. The argument value is of type unsigned -long . +long. It must be a valid pixel in the input method colormap. @@ -8151,7 +8151,7 @@ The 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 error when it is used by the input method. @@ -8174,7 +8174,7 @@ The XNFontSet argument specifies to the input method what font set is to be used. The argument value is of type -XFontSet . +XFontSet. @@ -8194,7 +8194,7 @@ The 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. @@ -8215,7 +8215,7 @@ The argument specifies to the input method what cursor is to be used in the specified window. This argument is of type -Cursor . +Cursor. @@ -8285,13 +8285,13 @@ is left unspecified, then the state will be implementation-dependent. When XNResetState is set to -XIMInitialState , +XIMInitialState, the XNPreeditState value specified at the creation time will be reflected as the initial state for XmbResetIC and -XwcResetIC . +XwcResetIC. @@ -8314,7 +8314,7 @@ when the preediting state has changed. The value of the XNPreeditStateNotifyCallback argument is a pointer to a structure of type -XIMCallback . +XIMCallback. The generic prototype is as follows: PreeditStateNotifyCallback @@ -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 @@ -8840,7 +8840,7 @@ 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 specifies the number of @@ -8852,7 +8852,7 @@ the end of the current display line are returned. If the direction specifies XIMForwardChar or -XIMBackwardChar , +XIMBackwardChar, then the factor specifies a relative position, indicated in characters, from the starting position. @@ -8864,12 +8864,12 @@ deleted (substitution) or copied (retrieval) from the client's buffer. When the XIMStringConversionOperation is -XIMStringConversionSubstitution , +XIMStringConversionSubstitution, the client must delete the string to be converted from its own buffer. When the 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, @@ -8994,7 +8994,7 @@ 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. @@ -9264,8 +9264,8 @@ 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, +XIMVisibleToBackward, and XIMVisibleCenter masks are exclusively used for these visibility hints. @@ -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. @@ -9323,12 +9323,12 @@ 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: @@ -9374,20 +9374,20 @@ Characters drawn with the XIMUnderline highlight should be underlined. Characters drawn with the -XIMHighlight , -XIMPrimary , -XIMSecondary , +XIMHighlight, +XIMPrimary, +XIMSecondary, and XIMTertiary highlights should be drawn in some unique manner that must be different from XIMReverse and -XIMUnderline . +XIMUnderline. The values for -XIMPrimary , -XIMSecondary , +XIMPrimary, +XIMSecondary, and XIMTertiary were incorrectly defined in the R5 specification. @@ -9732,7 +9732,7 @@ Not used for this callback and always passed as NULL. The callback may release any data allocated on -StatusStart . +StatusStart. @@ -9826,8 +9826,8 @@ typedef struct _XIMStatusDrawCallbackStruct { The feedback styles -XIMVisibleToForward , -XIMVisibleToBackward , +XIMVisibleToForward, +XIMVisibleToBackward, and XIMVisibleToCenter are not relevant and will not appear in the @@ -9853,7 +9853,7 @@ to register a filter internal to Xlib. This filter is called by a client (or toolkit) by calling XFilterEvent after calling -XNextEvent . +XNextEvent. Any client that uses the XIM interface should call @@ -9869,14 +9869,14 @@ of event filters with respect to other event-handling mechanisms Clients may not know how many filters there are, if any, and what they do. They may only know if an event has been filtered on return of -XFilterEvent . +XFilterEvent. Clients should discard filtered events. To filter an event, use -XFilterEvent . +XFilterEvent. XFilterEvent @@ -9916,7 +9916,7 @@ Specifies the window (Wi. If the window argument is -None , +None, XFilterEvent applies the filter to the window specified in the XEvent @@ -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. @@ -9959,7 +9959,7 @@ To get composed input from an input method, use XmbLookupString or -XwcLookupString . +XwcLookupString. XmbLookupString XwcLookupString @@ -10112,7 +10112,7 @@ it is essential that the client pass only events to XmbLookupString and -XwcLookupString . +XwcLookupString. Their behavior when a client passes a KeyRelease event is undefined. @@ -10137,7 +10137,7 @@ The possible values returned are: XBufferOverflow The input string to be returned is too large for the supplied buffer_return. The required size - ( XmbLookupString + (XmbLookupString in bytes; XwcLookupString in characters) is returned as the value of the function, @@ -10233,7 +10233,7 @@ 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 . +XwcLookupString. No other use is made of a KeyPress event with KeyCode of zero. diff --git a/specs/libX11/CH14.xml b/specs/libX11/CH14.xml index 04e88a09..5b25ca43 100644 --- a/specs/libX11/CH14.xml +++ b/specs/libX11/CH14.xml @@ -253,7 +253,7 @@ to manipulate your application's subwindows. To request that a top-level window be iconified, use -XIconifyWindow . +XIconifyWindow. XIconifyWindow @@ -313,7 +313,7 @@ and a window of w to the root window of the specified screen with an event mask set to SubstructureNotifyMask | -SubstructureRedirectMask . +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. @@ -327,7 +327,7 @@ otherwise, it returns a zero status. To request that a top-level window be withdrawn, use -XWithdrawWindow . +XWithdrawWindow. XWithdrawWindow @@ -401,7 +401,7 @@ error. To request that a top-level window be reconfigured, use -XReconfigureWMWindow . +XReconfigureWMWindow. XReconfigureWMWindow @@ -574,7 +574,7 @@ To convert a list of text strings to an structure, use XmbTextListToTextProperty or -XwcTextListToTextProperty . +XwcTextListToTextProperty. XmbTextListToTextProperty XwcTextListToTextProperty @@ -697,19 +697,19 @@ 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 . +XSupportsLocale. @@ -718,7 +718,7 @@ the functions return the number of unconvertible characters. Each unconvertible character is converted to an implementation-defined and encoding-specific default string. Otherwise, the functions return -Success . +Success. Note that full convertibility to all styles except XStringStyle is guaranteed. @@ -726,7 +726,7 @@ is guaranteed. To free the storage for the value field, use -XFree . +XFree. @@ -736,7 +736,7 @@ To obtain a list of text strings from an structure, use XmbTextPropertyToTextList or -XwcTextPropertyToTextList . +XwcTextPropertyToTextList. XmbTextPropertyToTextList XwcTextPropertyToTextList @@ -833,14 +833,14 @@ 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 @@ -871,31 +871,31 @@ Each unconvertible character is converted to a string in the current locale that is specific to the current locale. To obtain the value of this string, use -XDefaultString . +XDefaultString. Otherwise, XmbTextPropertyToTextList and XwcTextPropertyToTextList return -Success . +Success. To free the storage for the list and its contents returned by -XmbTextPropertyToTextList , +XmbTextPropertyToTextList, use -XFreeStringList . +XFreeStringList. To free the storage for the list and its contents returned by -XwcTextPropertyToTextList , +XwcTextPropertyToTextList, use -XwcFreeStringList . +XwcFreeStringList. To free the in-memory data associated with the specified wide character string list, use -XwcFreeStringList . +XwcFreeStringList. XwcFreeStringList @@ -924,7 +924,7 @@ Specifies the list of strings to be freed. The XwcFreeStringList function frees memory allocated by -XwcTextPropertyToTextList . +XwcTextPropertyToTextList. @@ -941,7 +941,7 @@ The XDefaultString function returns the default string used by Xlib for text conversion (for example, in -XmbTextPropertyToTextList ). +XmbTextPropertyToTextList). The default string is the string in the current locale that is output when an unconvertible character is found during text conversion. If the string returned by @@ -959,7 +959,7 @@ is independent of the default string for text drawing; see XCreateFontSet to obtain the default string for an -XFontSet . +XFontSet. @@ -979,7 +979,7 @@ Until freed, it will not be modified by Xlib. To set the specified list of strings in the STRING encoding to a XTextProperty structure, use -XStringListToTextProperty . +XStringListToTextProperty. XStringListToTextProperty @@ -1046,7 +1046,7 @@ does not set any fields in the structure and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the value field, use -XFree . +XFree. @@ -1054,7 +1054,7 @@ To free the storage for the value field, use To obtain a list of strings from a specified XTextProperty structure in the STRING encoding, use -XTextPropertyToStringList . +XTextPropertyToStringList. XTextPropertyToStringList @@ -1121,13 +1121,13 @@ If insufficient memory is available for the list and its elements, sets no return values and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the list and its contents, use -XFreeStringList . +XFreeStringList. To free the in-memory data associated with the specified string list, use -XFreeStringList . +XFreeStringList. XFreeStringList @@ -1160,7 +1160,7 @@ function releases memory allocated by and XTextPropertyToStringList and the missing charset list allocated by -XCreateFontSet . +XCreateFontSet. @@ -1184,7 +1184,7 @@ see sections 14.1.4, 14.1.5, 14.2.1, and 14.2.2, respectively. To set one of a window's text properties, use -XSetTextProperty . +XSetTextProperty. XSetTextProperty @@ -1261,9 +1261,9 @@ sets it for the specified window. XSetTextProperty can generate -BadAlloc , -BadAtom , -BadValue , +BadAlloc, +BadAtom, +BadValue, and BadWindow errors. @@ -1272,7 +1272,7 @@ errors. To read one of a window's text properties, use -XGetTextProperty . +XGetTextProperty. XGetTextProperty @@ -1351,7 +1351,7 @@ 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. @@ -1388,7 +1388,7 @@ the WM_NAME property for a given window. To set a window's WM_NAME property with the supplied convenience function, use -XSetWMName . +XSetWMName. XSetWMName @@ -1448,7 +1448,7 @@ to set the WM_NAME property. To read a window's WM_NAME property with the supplied convenience function, use -XGetWMName . +XGetWMName. XGetWMName @@ -1511,7 +1511,7 @@ otherwise, it returns a zero status. The following two functions have been superseded by XSetWMName and -XGetWMName , +XGetWMName, respectively. You can use these additional convenience functions for window names that are encoded as STRING properties. @@ -1520,7 +1520,7 @@ for window names that are encoded as STRING properties. To assign a name to a window, use -XStoreName . +XStoreName. Windowname XStoreName @@ -1594,7 +1594,7 @@ errors. To get the name of a window, use -XFetchName . +XFetchName. XFetchName @@ -1657,7 +1657,7 @@ then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the window name string using -XFree . +XFree. @@ -1682,7 +1682,7 @@ the WM_ICON_NAME property for a given window. To set a window's WM_ICON_NAME property, use -XSetWMIconName . +XSetWMIconName. XSetWMIconName @@ -1743,7 +1743,7 @@ to set the WM_ICON_NAME property. To read a window's WM_ICON_NAME property, use -XGetWMIconName . +XGetWMIconName. XGetWMIconName @@ -1806,7 +1806,7 @@ otherwise, it returns a zero status. The next two functions have been superseded by XSetWMIconName and -XGetWMIconName , +XGetWMIconName, respectively. You can use these additional convenience functions for window names that are encoded as STRING properties. @@ -1816,7 +1816,7 @@ for window names that are encoded as STRING properties. To set the name to be displayed in a window's icon, use -XSetIconName . +XSetIconName. Windowicon name XSetIconName @@ -1879,7 +1879,7 @@ errors. To get the name a window wants displayed in its icon, use -XGetIconName . +XGetIconName. XGetIconName @@ -1942,7 +1942,7 @@ then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the icon name string using -XFree . +XFree. @@ -1973,7 +1973,7 @@ header file. To allocate an XWMHints structure, use -XAllocWMHints . +XAllocWMHints. @@ -1996,7 +1996,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree . +XFree. @@ -2045,25 +2045,25 @@ Applications that expect input but never explicitly set focus to any of their subwindows (that is, use the push model of focus management), such as X Version 10 style applications that use real-estate driven focus, should set this member to -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 @@ -2114,7 +2114,7 @@ or the window to be withdrawn. To set a window's WM_HINTS property, use -XSetWMHints . +XSetWMHints. XSetWMHints @@ -2183,7 +2183,7 @@ errors. To read a window's WM_HINTS property, use -XGetWMHints . +XGetWMHints. XGetWMHints @@ -2229,7 +2229,7 @@ or returns a pointer to an structure if it succeeds. When finished with the data, free the space used for it by calling -XFree . +XFree. @@ -2272,7 +2272,7 @@ instances of the structure be used. To allocate an XSizeHints structure, use -XAllocSizeHints . +XAllocSizeHints. @@ -2294,7 +2294,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree . +XFree. @@ -2377,7 +2377,7 @@ macro is highly discouraged. To set a window's WM_NORMAL_HINTS property, use -XSetWMNormalHints . +XSetWMNormalHints. XSetWMNormalHints @@ -2447,7 +2447,7 @@ errors. To read a window's WM_NORMAL_HINTS property, use -XGetWMNormalHints . +XGetWMNormalHints. XGetWMNormalHints @@ -2558,7 +2558,7 @@ error. To set a window's WM_SIZE_HINTS property, use -XSetWMSizeHints . +XSetWMSizeHints. XSetWMSizeHints @@ -2637,8 +2637,8 @@ function. XSetWMSizeHints can generate -BadAlloc , -BadAtom , +BadAlloc, +BadAtom, and BadWindow errors. @@ -2647,7 +2647,7 @@ errors. To read a window's WM_SIZE_HINTS property, use -XGetWMSizeHints . +XGetWMSizeHints. XGetWMSizeHints @@ -2796,7 +2796,7 @@ header file. To allocate an XClassHint structure, use -XAllocClassHint . +XAllocClassHint. XAllocClassHint @@ -2821,7 +2821,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree . +XFree. @@ -2860,7 +2860,7 @@ resource database. To set a window's WM_CLASS property, use -XSetClassHint . +XSetClassHint. XSetClassHint @@ -2929,7 +2929,7 @@ errors. To read a window's WM_CLASS property, use -XGetClassHint . +XGetClassHint. XGetClassHint @@ -3015,7 +3015,7 @@ the WM_TRANSIENT_FOR property for a given window. To set a window's WM_TRANSIENT_FOR property, use -XSetTransientForHint . +XSetTransientForHint. XSetTransientForHint @@ -3081,7 +3081,7 @@ errors. To read a window's WM_TRANSIENT_FOR property, use -XGetTransientForHint . +XGetTransientForHint. XGetTransientForHint @@ -3157,7 +3157,7 @@ the WM_PROTOCOLS property for a given window. To set a window's WM_PROTOCOLS property, use -XSetWMProtocols . +XSetWMProtocols. XSetWMProtocols @@ -3244,7 +3244,7 @@ errors. To read a window's WM_PROTOCOLS property, use -XGetWMProtocols . +XGetWMProtocols. XGetWMProtocols @@ -3319,7 +3319,7 @@ and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of atoms, use -XFree . +XFree. @@ -3343,7 +3343,7 @@ the WM_COLORMAP_WINDOWS property for a given window. To set a window's WM_COLORMAP_WINDOWS property, use -XSetWMColormapWindows . +XSetWMColormapWindows. XSetWMColormapWindows @@ -3430,7 +3430,7 @@ errors. To read a window's WM_COLORMAP_WINDOWS property, use -XGetWMColormapWindows . +XGetWMColormapWindows. XGetWMColormapWindows @@ -3505,7 +3505,7 @@ and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of window identifiers, use -XFree . +XFree. @@ -3537,7 +3537,7 @@ header file. To allocate an XIconSize structure, use -XAllocIconSize . +XAllocIconSize. @@ -3560,7 +3560,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree . +XFree. @@ -3592,7 +3592,7 @@ sizes (minimum to maximum) that represent the supported icon sizes. To set a window's WM_ICON_SIZE property, use -XSetIconSizes . +XSetIconSizes. XSetIconSizes @@ -3668,7 +3668,7 @@ errors. To read a window's WM_ICON_SIZE property, use -XGetIconSizes . +XGetIconSizes. XGetIconSizes @@ -3741,7 +3741,7 @@ should then use to supply the window manager with an icon pixmap or window in one of the supported sizes. To free the data allocated in size_list_return, use -XFree . +XFree. @@ -3912,12 +3912,12 @@ and the properties are created with type ``COMPOUND_TEXT''. If the normal_hints argument is non-NULL, XmbSetWMProperties calls -XSetWMNormalHints , +XSetWMNormalHints, which sets the WM_NORMAL_HINTS property (see section 14.1.7). If the wm_hints argument is non-NULL, XmbSetWMProperties calls -XSetWMHints , +XSetWMHints, which sets the WM_HINTS property (see section 14.1.6). @@ -3980,7 +3980,7 @@ errors. To set a window's standard window manager properties with strings in client-specified encodings, use -XSetWMProperties . +XSetWMProperties. The standard window manager properties for a given window are WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE. @@ -4115,17 +4115,17 @@ managers). If the window_name argument is non-NULL, XSetWMProperties calls -XSetWMName , +XSetWMName, which, in turn, sets the WM_NAME property (see section 14.1.4). If the icon_name argument is non-NULL, XSetWMProperties calls -XSetWMIconName , +XSetWMIconName, which sets the WM_ICON_NAME property (see section 14.1.5). If the argv argument is non-NULL, XSetWMProperties calls -XSetCommand , +XSetCommand, which sets the WM_COMMAND property (see section 14.2.1). Note that an argc of zero is allowed to indicate a zero-length command. Note also that the hostname of this machine is stored using @@ -4137,12 +4137,12 @@ Note also that the hostname of this machine is stored using If the normal_hints argument is non-NULL, XSetWMProperties calls -XSetWMNormalHints , +XSetWMNormalHints, which sets the WM_NORMAL_HINTS property (see section 14.1.7). If the wm_hints argument is non-NULL, XSetWMProperties calls -XSetWMHints , +XSetWMHints, which sets the WM_HINTS property (see section 14.1.6). @@ -4150,7 +4150,7 @@ which sets the WM_HINTS property (see section 14.1.6). If the class_hints argument is non-NULL, XSetWMProperties calls -XSetClassHint , +XSetClassHint, which sets the WM_CLASS property (see section 14.1.8). If the res_name member in the XClassHint @@ -4209,7 +4209,7 @@ the WM_COMMAND property for a given window. To set a window's WM_COMMAND property, use -XSetCommand . +XSetCommand. XSetCommand @@ -4289,7 +4289,7 @@ errors. To read a window's WM_COMMAND property, use -XGetCommand . +XGetCommand. XGetCommand @@ -4363,7 +4363,7 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the memory allocated to the string list, use -XFreeStringList . +XFreeStringList. @@ -4380,7 +4380,7 @@ the WM_CLIENT_MACHINE property for a given window. To set a window's WM_CLIENT_MACHINE property, use -XSetWMClientMachine . +XSetWMClientMachine. XSetWMClientMachine @@ -4440,7 +4440,7 @@ to set the WM_CLIENT_MACHINE property. To read a window's WM_CLIENT_MACHINE property, use -XGetWMClientMachine . +XGetWMClientMachine. XGetWMClientMachine @@ -4607,7 +4607,7 @@ Applications should use the standard colormaps if they already exist. To allocate an XStandardColormap structure, use -XAllocStandardColormap . +XAllocStandardColormap. @@ -4629,7 +4629,7 @@ If insufficient memory is available, returns NULL. To free the memory allocated to this structure, use -XFree . +XFree. @@ -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 @@ -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,7 +4863,7 @@ 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 @@ -4899,7 +4899,7 @@ structure. To set an XStandardColormap structure, use -XSetRGBColormaps . +XSetRGBColormaps. XSetRGBColormaps @@ -5027,7 +5027,7 @@ Determine the color characteristics of the visual. Allocate cells in the colormap (or create it with -AllocAll ). +AllocAll). @@ -5067,8 +5067,8 @@ Ungrab the server. XSetRGBColormaps can generate -BadAlloc , -BadAtom , +BadAlloc, +BadAtom, and BadWindow errors. @@ -5079,7 +5079,7 @@ errors. To obtain the XStandardColormap structure associated with the specified property, use -XGetRGBColormaps . +XGetRGBColormaps. XGetRGBColormaps diff --git a/specs/libX11/CH15.xml b/specs/libX11/CH15.xml index 3cf50b84..7f3de6e9 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. @@ -350,7 +350,7 @@ but its use is entirely local to your application. To allocate a new quark, use -XrmUniqueQuark . +XrmUniqueQuark. XrmUniqueQuark @@ -368,7 +368,7 @@ is known to the resource manager. Each name, class, and representation type is typedef'd as an -XrmQuark . +XrmQuark. @@ -402,7 +402,7 @@ typedef XrmQuarkList XrmClassList; To convert a string to a quark, use XrmStringToQuark or -XrmPermStringToQuark . +XrmPermStringToQuark. #define XrmStringToName(string) XrmStringToQuark(string) @@ -444,11 +444,11 @@ The string argument to need not be permanently allocated storage. XrmPermStringToQuark is just like -XrmStringToQuark , +XrmStringToQuark, except that Xlib is permitted to assume the string argument is permanently allocated, and, hence, that it can be used as the value to be returned by -XrmQuarkToString . +XrmQuarkToString. @@ -461,7 +461,7 @@ all future calls will return the same value (identical address). To convert a quark to a string, use -XrmQuarkToString . +XrmQuarkToString. @@ -508,7 +508,7 @@ all future calls will return the same value (identical address). To convert a string with one or more components to a quark list, use -XrmStringToQuarkList . +XrmStringToQuarkList. @@ -546,7 +546,7 @@ Specifies the string for which a quark(Ql is to be allocated. Returns the list of quarks. The caller must allocate sufficient space for the quarks list before calling -XrmStringToQuarkList . +XrmStringToQuarkList. @@ -589,7 +589,7 @@ indicates that an asterisk separates the components. To convert a string with one or more components to a binding list and a quark list, use -XrmStringToBindingQuarkList . +XrmStringToBindingQuarkList. XrmStringToBindingQuarkList @@ -621,7 +621,7 @@ Specifies the string for which a quark(Ql is to be allocated. Returns the binding list. The caller must allocate sufficient space for the binding list before calling -XrmStringToBindingQuarkList . +XrmStringToBindingQuarkList. @@ -633,7 +633,7 @@ The caller must allocate sufficient space for the binding list before calling Returns the list of quarks. The caller must allocate sufficient space for the quarks list before calling -XrmStringToBindingQuarkList . +XrmStringToBindingQuarkList. @@ -668,7 +668,7 @@ bindings: loose tight loose XrmDatabase A resource database is an opaque type, -XrmDatabase . +XrmDatabase. Each database value is stored in an XrmValue structure. @@ -699,7 +699,7 @@ typedef struct { To initialize the resource manager, use -XrmInitialize . +XrmInitialize. XrmInitialize @@ -714,7 +714,7 @@ To initialize the resource manager, use To retrieve a database from disk, use -XrmGetFileDatabase . +XrmGetFileDatabase. XrmGetFileDatabase @@ -758,7 +758,7 @@ returns NULL. To store a copy of a database to disk, use -XrmPutFileDatabase . +XrmPutFileDatabase. XrmPutFileDatabase @@ -811,7 +811,7 @@ Entries with representation types other than ``String'' are ignored. To obtain a pointer to the screen-independent resources of a display, use -XResourceManagerString . +XResourceManagerString. XResourceManagerString @@ -841,21 +841,21 @@ The XResourceManagerString function returns the RESOURCE_MANAGER property from the server's root window of screen zero, which was returned when the connection was opened using -XOpenDisplay . +XOpenDisplay. The property is converted from type STRING to the current locale. The conversion is identical to that produced by XmbTextPropertyToTextList for a single element STRING property. The returned string is owned by Xlib and should not be freed by the client. The property value must be in a format that is acceptable to -XrmGetStringDatabase . +XrmGetStringDatabase. If no property exists, NULL is returned. To obtain a pointer to the screen-specific resources of a screen, use -XScreenResourceString . +XScreenResourceString. XScreenResourceString @@ -890,16 +890,16 @@ The conversion is identical to that produced by XmbTextPropertyToTextList for a single element STRING property. The property value must be in a format that is acceptable to -XrmGetStringDatabase . +XrmGetStringDatabase. If no property exists, NULL is returned. The caller is responsible for freeing the returned string by using -XFree . +XFree. To create a database from a string, use -XrmGetStringDatabase . +XrmGetStringDatabase. XrmGetStringDatabase @@ -944,7 +944,7 @@ and the database is created in the current locale. To obtain the locale name of a database, use -XrmLocaleOfDatabase . +XrmLocaleOfDatabase. XrmLocaleOfDatabase @@ -984,7 +984,7 @@ it will not be modified by Xlib. To destroy a resource database and free its allocated memory, use -XrmDestroyDatabase . +XrmDestroyDatabase. XrmDestroyDatabase @@ -1018,7 +1018,7 @@ returns immediately. To associate a resource database with a display, use -XrmSetDatabase . +XrmSetDatabase. XrmSetDatabase @@ -1067,7 +1067,7 @@ once it is constructed. To get the resource database associated with a display, use -XrmGetDatabase . +XrmGetDatabase. XrmGetDatabase @@ -1107,7 +1107,7 @@ It returns NULL if a database has not yet been set. To merge the contents of a resource file into a database, use -XrmCombineFileDatabase . +XrmCombineFileDatabase. XrmCombineFileDatabase @@ -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, @@ -1181,7 +1181,7 @@ The locale of the target database is not modified. To merge the contents of one database into another database, use -XrmCombineDatabase . +XrmCombineDatabase. XrmCombineDatabase @@ -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 @@ -1251,7 +1251,7 @@ The locale of the target database is not modified. To merge the contents of one database into another database with override semantics, use -XrmMergeDatabases . +XrmMergeDatabases. XrmMergeDatabases @@ -1293,7 +1293,7 @@ Calling the function is equivalent to calling the XrmCombineDatabase function with an override argument of -True . +True. @@ -1304,10 +1304,10 @@ function with an override argument of To retrieve a resource from a resource database, use -XrmGetResource , -XrmQGetResource , +XrmGetResource, +XrmQGetResource, or -XrmQGetSearchResource . +XrmQGetSearchResource. @@ -1465,10 +1465,10 @@ therefore, you must not modify the data. The database only frees or overwrites entries on -XrmPutResource , -XrmQPutResource , +XrmPutResource, +XrmQPutResource, or -XrmMergeDatabases . +XrmMergeDatabases. A client that is not storing new values into the database or is not merging the database should be safe using the address passed back at any time until it exits. @@ -1477,9 +1477,9 @@ If a resource was found, both and XrmQGetResource return -True ; +True; otherwise, they return -False . +False. @@ -1503,7 +1503,7 @@ of database levels that might match the first part of a name/class list. To obtain a list of database levels, use -XrmQGetSearchList . +XrmQGetSearchList. XrmQGetSearchList @@ -1556,7 +1556,7 @@ Specifies a list of resource classes. Returns a search list for further use. The caller must allocate sufficient space for the list before calling -XrmQGetSearchList . +XrmQGetSearchList. @@ -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. @@ -1604,13 +1604,13 @@ When using XrmQGetSearchList followed by multiple probes for resources with a common name and class prefix, only the common prefix should be specified in the name and class list to -XrmQGetSearchList . +XrmQGetSearchList. To search resource database levels for a given resource, use -XrmQGetSearchResource . +XrmQGetSearchResource. XrmQGetSearchResource @@ -1632,7 +1632,7 @@ To search resource database levels for a given resource, use Specifies the search list returned by -XrmQGetSearchList . +XrmQGetSearchList. @@ -1691,7 +1691,7 @@ returns True if the resource was found; otherwise, it returns -False . +False. @@ -1717,7 +1717,7 @@ with the fully qualified name and class. To store resources into the database, use XrmPutResource or -XrmQPutResource . +XrmQPutResource. Both functions take a partial resource specification, a representation type, and a value. This value is copied into the specified database. @@ -1884,7 +1884,7 @@ The value is stored in the database without modification. To add a resource that is specified as a string, use -XrmPutStringResource . +XrmPutStringResource. XrmPutStringResource @@ -1941,7 +1941,7 @@ adds a resource with the specified value to the specified database. is a convenience function that first calls XrmStringToBindingQuarkList on the specifier and then calls -XrmQPutResource , +XrmQPutResource, using a ``String'' representation type. If the specifier is not in the Host Portable Character Encoding, the result is implementation-dependent. @@ -1951,7 +1951,7 @@ The value is stored in the database without modification. To add a string resource using quarks as a specification, use -XrmQPutStringResource . +XrmQPutStringResource. XrmQPutStringResource @@ -2020,7 +2020,7 @@ for the value string (by calling strlen to compute the size) and then calls -XrmQPutResource , +XrmQPutResource, using a ``String'' representation type. The value is stored in the database without modification. @@ -2029,7 +2029,7 @@ The value is stored in the database without modification. To add a single resource entry that is specified as a string that contains both a name and a value, use -XrmPutLineResource . +XrmPutLineResource. XrmPutLineResource @@ -2091,7 +2091,7 @@ Note that comment lines are not stored. To enumerate the entries of a database, use -XrmEnumerateDatabase . +XrmEnumerateDatabase. XrmEnumerateDatabase @@ -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. @@ -2302,7 +2302,7 @@ typedef struct { To load a resource database from a C command line, use -XrmParseCommand . +XrmParseCommand. XrmParseCommand @@ -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 d7e6dc2f..5fa2cd07 100644 --- a/specs/libX11/CH16.xml +++ b/specs/libX11/CH16.xml @@ -94,7 +94,7 @@ use the functions described in section 12.7. To obtain a KeySym for the KeyCode of an event, use -XLookupKeysym . +XLookupKeysym. XLookupKeysym @@ -146,13 +146,13 @@ structure. If no KeySym is defined for the KeyCode of the event, XLookupKeysym returns -NoSymbol . +NoSymbol. To obtain a KeySym for a specific KeyCode, use -XKeycodeToKeysym . +XKeycodeToKeysym. XKeycodeToKeysym @@ -208,13 +208,13 @@ the element of the KeyCode vector. If no symbol is defined, XKeycodeToKeysym returns -NoSymbol . +NoSymbol. To obtain a KeyCode for a key having a specific KeySym, use -XKeysymToKeycode . +XKeysymToKeycode. XKeysymToKeycode @@ -262,7 +262,7 @@ The mapping between KeyCodes and KeySyms is cached internal to Xlib. When this information is changed at the server, an Xlib function must be called to refresh the cache. To refresh the stored modifier and keymap information, use -XRefreshKeyboardMapping . +XRefreshKeyboardMapping. XRefreshKeyboardMapping @@ -304,7 +304,7 @@ The result is to update Xlib's knowledge of the keyboard. To obtain the uppercase and lowercase forms of a KeySym, use -XConvertCase . +XConvertCase. XConvertCase @@ -367,7 +367,7 @@ implementation-dependent. KeySyms have string names as well as numeric codes. To convert the name of the KeySym to the KeySym code, use -XStringToKeysym . +XStringToKeysym. XStringToKeysym @@ -408,13 +408,13 @@ the result is implementation-dependent. If the specified string does not match a valid KeySym, XStringToKeysym returns -NoSymbol . +NoSymbol. To convert a KeySym code to the name of the KeySym, use -XKeysymToString . +XKeysymToString. XKeysymToString @@ -662,7 +662,7 @@ described in chapter 13 and does not depend on the current locale. To map a key event to an ISO Latin-1 string, use -XLookupString . +XLookupString. XLookupString @@ -687,7 +687,7 @@ Specifies the key event structure to be used. You can pass XKeyPressedEvent or -XKeyReleasedEvent . +XKeyReleasedEvent. @@ -743,11 +743,11 @@ 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 ), +XRebindKeysym), the bound string will be stored in the buffer. Otherwise, the KeySym is mapped, if possible, to an ISO Latin-1 character or (if the Control modifier is on) to an ASCII control character, @@ -782,9 +782,9 @@ to keep this information up-to-date. To rebind the meaning of a KeySym for -XLookupString , +XLookupString, use -XRebindKeysym . +XRebindKeysym. XRebindKeysym @@ -848,7 +848,7 @@ Specifies the number of modifiers in the modifier list. Specifies the string that is copied and will be returned by -XLookupString . +XLookupString. @@ -889,7 +889,7 @@ Note that you can rebind a KeySym that may not exist. To allocate some memory you will never give back, use -Xpermalloc . +Xpermalloc. Xpermalloc @@ -919,7 +919,7 @@ the standard operating system memory allocator. To parse standard window geometry strings, use -XParseGeometry . +XParseGeometry. Windowdetermining location XParseGeometry @@ -1029,11 +1029,11 @@ be able to say ``position the window relative to the right or bottom edge.'' For each value found, the corresponding argument is updated. For each value not found, the argument is left unchanged. The bits are represented by -XValue , -YValue , -WidthValue , -HeightValue , -XNegative , +XValue, +YValue, +WidthValue, +HeightValue, +XNegative, or YNegative and are defined in @@ -1054,7 +1054,7 @@ you should place the window at the requested position. To construct a window's geometry information, use -XWMGeometry . +XWMGeometry. XWMGeometry @@ -1194,15 +1194,15 @@ Returns the window gravity. The XWMGeometry function combines any geometry information (given in the format used by -XParseGeometry ) +XParseGeometry) specified by the user and by the calling program with size hints (usually the ones to be stored in WM_NORMAL_HINTS) and returns the position, 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 @@ -1212,7 +1212,7 @@ Otherwise, a base size of zero is assumed. If no minimum size is set in the hints structure, the base size is used. A mask (in the form returned by -XParseGeometry ) +XParseGeometry) that describes which values came from the user specification and whether or not the position coordinates are relative to the right and bottom edges is returned. @@ -1280,7 +1280,7 @@ Locate a point or rectangle in a region To create a new empty region, use -XCreateRegion . +XCreateRegion. Region XCreateRegion() @@ -1289,7 +1289,7 @@ To create a new empty region, use To generate a region from a polygon, use -XPolygonRegion . +XPolygonRegion. XPolygonRegion @@ -1333,7 +1333,7 @@ Specifies the fill-rule you want to set for the specified GC. You can pass EvenOddRule or -WindingRule . +WindingRule. @@ -1347,13 +1347,13 @@ The function returns a region for the polygon defined by the points array. For an explanation of fill_rule, see -XCreateGC . +XCreateGC. To set the clip-mask of a GC to a region, use -XSetRegion . +XSetRegion. XSetRegion @@ -1413,7 +1413,7 @@ the region can be destroyed. To deallocate the storage associated with a specified region, use -XDestroyRegion . +XDestroyRegion. XDestroyRegion @@ -1449,7 +1449,7 @@ Specifies the region. To move a region by a specified amount, use -XOffsetRegion . +XOffsetRegion. XOffsetRegion @@ -1501,7 +1501,7 @@ which define the amount you want to (Dy the specified region. To reduce a region by a specified amount, use -XShrinkRegion . +XShrinkRegion. XShrinkRegion @@ -1564,7 +1564,7 @@ and negative values expand the region. To generate the smallest rectangle enclosing a region, use -XClipBox . +XClipBox. XClipBox @@ -1609,7 +1609,7 @@ function returns the smallest rectangle enclosing the specified region. To compute the intersection of two regions, use -XIntersectRegion . +XIntersectRegion. XIntersectRegion @@ -1658,7 +1658,7 @@ Returns the result of the computation. To compute the union of two regions, use -XUnionRegion . +XUnionRegion. XUnionRegion @@ -1707,7 +1707,7 @@ Returns the result of the computation. To create a union of a source region and a rectangle, use -XUnionRectWithRegion . +XUnionRectWithRegion. XUnionRectWithRegion @@ -1764,7 +1764,7 @@ and the specified source region. To subtract two regions, use -XSubtractRegion . +XSubtractRegion. XSubtractRegion @@ -1820,7 +1820,7 @@ function subtracts srb from sra and stores the results in dr_return. To calculate the difference between the union and intersection of two regions, use -XXorRegion . +XXorRegion. XXorRegion @@ -1877,7 +1877,7 @@ Returns the result of the computation. To determine if the specified region is empty, use -XEmptyRegion . +XEmptyRegion. XEmptyRegion @@ -1913,7 +1913,7 @@ if the region is empty. To determine if two regions have the same offset, size, and shape, use -XEqualRegion . +XEqualRegion. XEqualRegion @@ -1965,7 +1965,7 @@ if the two regions have the same offset, size, and shape. To determine if a specified point resides in a specified region, use -XPointInRegion . +XPointInRegion. XPointInRegion @@ -2024,7 +2024,7 @@ if the point (x, y) is contained in the region r. To determine if a specified rectangle is inside a region, use -XRectInRegion . +XRectInRegion. XRectInRegion @@ -2136,7 +2136,7 @@ and can be accessed as a ring or as explicit buffers (numbered 0 through 7). To store data in cut buffer 0, use -XStoreBytes . +XStoreBytes. XStoreBytes @@ -2188,7 +2188,7 @@ The data can have embedded null characters and need not be null-terminated. The cut buffer's contents can be retrieved later by any client calling -XFetchBytes . +XFetchBytes. @@ -2201,7 +2201,7 @@ error. To store data in a specified cut buffer, use -XStoreBuffer . +XStoreBuffer. XStoreBuffer @@ -2276,7 +2276,7 @@ error. To return data from cut buffer 0, use -XFetchBytes . +XFetchBytes. XFetchBytes @@ -2322,13 +2322,13 @@ Otherwise, the function returns NULL and sets nbytes to 0. The appropriate amount of storage is allocated and the pointer returned. The client must free this storage when finished with it by calling -XFree . +XFree. To return data from a specified cut buffer, use -XFetchBuffer . +XFetchBuffer. XFetchBuffer @@ -2387,7 +2387,7 @@ buffer is specified. To rotate the cut buffers, use -XRotateBuffers . +XRotateBuffers. XRotateBuffers @@ -2504,7 +2504,7 @@ typedef struct { To obtain a list of visual information structures that match a specified template, use -XGetVisualInfo . +XGetVisualInfo. XGetVisualInfo @@ -2572,14 +2572,14 @@ If no visual structures match the template using the specified vinfo_mask, XGetVisualInfo returns a NULL. To free the data returned by this function, use -XFree . +XFree. To obtain the visual information that matches the specified depth and class of the screen, use -XMatchVisualInfo . +XMatchVisualInfo. XMatchVisualInfo @@ -2691,7 +2691,7 @@ images. The basic operations for getting and putting images are XGetImage and -XPutImage . +XPutImage. @@ -2726,7 +2726,7 @@ see section 8.7. To allocate an XImage structure and initialize it with image format values from a display, use -XCreateImage . +XCreateImage. XCreateImage @@ -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. @@ -2885,10 +2885,10 @@ in memory and calculates the value of bytes_per_line itself. Note that when the image is created using -XCreateImage , -XGetImage , +XCreateImage, +XGetImage, or -XSubImage , +XSubImage, the destroy procedure that the XDestroyImage function calls frees both the image structure @@ -2906,7 +2906,7 @@ in the image object and are defined in To obtain a pixel value in an image, use -XGetPixel . +XGetPixel. XGetPixel @@ -2967,7 +2967,7 @@ The image must contain the x and y coordinates. To set a pixel value in an image, use -XPutPixel . +XPutPixel. XPutPixel @@ -3039,7 +3039,7 @@ The image must contain the x and y coordinates. To create a subimage, use -XSubImage . +XSubImage. XSubImage @@ -3125,7 +3125,7 @@ and subimage_height. To increment each pixel in an image by a constant value, use -XAddPixel . +XAddPixel. XAddPixel @@ -3172,9 +3172,9 @@ color resources and need to manipulate the image to that form. To deallocate the memory allocated in a previous call to -XCreateImage , +XCreateImage, use -XDestroyImage . +XDestroyImage. XDestroyImage @@ -3209,10 +3209,10 @@ structure. Note that when the image is created using -XCreateImage , -XGetImage , +XCreateImage, +XGetImage, or -XSubImage , +XSubImage, the destroy procedure that this macro calls frees both the image structure and the data pointed to by the image structure. @@ -3261,7 +3261,7 @@ The bitmap unit is 8. To read a bitmap from a file and store it in a pixmap, use -XReadBitmapFile . +XReadBitmapFile. XReadBitmapFile @@ -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,8 +3406,8 @@ otherwise, it returns \-1,\-1. XReadBitmapFile can generate -BadAlloc , -BadDrawable , +BadAlloc, +BadDrawable, and BadGC errors. @@ -3416,7 +3416,7 @@ errors. To read a bitmap from a file and return it as data, use -XReadBitmapFileData . +XReadBitmapFileData. XReadBitmapFileData @@ -3501,19 +3501,19 @@ Return the hotspot coordinates. The XReadBitmapFileData function reads in a file containing a bitmap, in the same manner as -XReadBitmapFile , +XReadBitmapFile, but returns the data directly rather than creating a pixmap in the server. The bitmap data is returned in data_return; the client must free this storage when finished with it by calling -XFree . +XFree. The status and other return values are the same as for -XReadBitmapFile . +XReadBitmapFile. To write out a bitmap from a pixmap to a file, use -XWriteBitmapFile . +XWriteBitmapFile. XWriteBitmapFile @@ -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. @@ -3640,7 +3640,7 @@ errors. To create a pixmap and then store bitmap-format data into it, use -XCreatePixmapFromBitmapData . +XCreatePixmapFromBitmapData. XCreatePixmapFromBitmapData @@ -3758,9 +3758,9 @@ error results. XCreatePixmapFromBitmapData can generate -BadAlloc , -BadDrawable , -BadGC , +BadAlloc, +BadDrawable, +BadGC, and BadValue errors. @@ -3772,7 +3772,7 @@ To include a bitmap written out by XWriteBitmapFile XWriteBitmapFile in a program directly, as opposed to reading it in every time at run time, use -XCreateBitmapFromData . +XCreateBitmapFromData. XCreateBitmapFromData @@ -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 @@ -3915,7 +3915,7 @@ The symbols used are in To save a data value that corresponds to a resource ID and context type, use -XSaveContext . +XSaveContext. XSaveContext @@ -3989,7 +3989,7 @@ Possible errors are To get the data associated with a resource ID and type, use -XFindContext . +XFindContext. XFindContext @@ -4062,7 +4062,7 @@ Possible errors are To delete an entry for a given resource ID and type, use -XDeleteContext . +XDeleteContext. XDeleteContext @@ -4126,9 +4126,9 @@ does not free the data whose address was saved. To create a unique context type that may be used in subsequent calls to XSaveContext and -XFindContext , +XFindContext, use -XUniqueContext . +XUniqueContext. XContext XuniqueContext() diff --git a/specs/libX11/glossary.xml b/specs/libX11/glossary.xml index c912737f..037ea8d0 100644 --- a/specs/libX11/glossary.xml +++ b/specs/libX11/glossary.xml @@ -91,13 +91,13 @@ 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 @@ -741,7 +741,7 @@ See Bit gravity and Window gravity. 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. @@ -1683,7 +1683,7 @@ always interprets timestamps from clients by treating half of the timestamp space as being earlier in time than T and half of the timestamp space as being later in time than T. One timestamp value, represented by the constant -CurrentTime , +CurrentTime, is never generated by the server. This value is reserved for use in requests to represent the current server time.