Xlib Reference Manual for Version 11 Volume 2, 5th Editon

typedef struct {

short x, y;

unsigned short width, height;

short anglel, angle2; } XArc;

XChar2b

XChar2b specifies a character in a two-byte font A list of structures of this type is an argu ment to XDrawImageSt ringl 6, XDrawStringl 6, XDrawText 16, XQueryText-Extentsl6, XTextExtentsl6, and XTextWidthl6. The only two-byte font cur rently available is Kanji (Japanese).

typedef struct { /* normal 16 bit characters are two bytes */

unsigned char bytel;

unsigned char byte2; } XChar2b;

F.3.3 XCharStruct

XCharStruct describes the metrics of a single character in a font or the overall character istics of a font This structure is the type of several of members of XFontStruct and is used to return the overall characteristics of a string in XQueryTextExtents* and XTextExtents*.

typedef struct {

short Ibearing; /* origin to left edge of raster */

short rbearing; /* origin to right edge of raster */

short width; /* advance to next char's origin */

short ascent; /* baseline to top edge of raster */

short descent; /* baseline to bottom edge of raster *,

unsigned short attributes; /* per char flags (not predefined) */

} XCharStruct;

F.3.4 XCIassHint

XClassHint is used to set or get the XA_WM_CLASS_HINT property for an application's top-level window, as arguments toXSetClassHint or XGetClassHint.

typedef struct {

char *res_name;

char *res_class; } XClassHint;

F.3.5 XColor

XColor describes a single colorcell. This structure is used to specify and return the pixel value and RGB values for a colorcell. The flags indicate which of the RGB values should be changed when used in XStoreColors, XAllocNamedColor, or XAllocColor. Also used in XCreateGlyphCursor, XCreatePixmapCursor, XLookupColor, XParseColor, XQueryColor, XQueryColors, and XRecolorCursor.

typedef struct {

unsigned long pixel;

unsigned short red, green, blue;

char flags;

char pad; } XColor;

DoRed, DoGreen, DoBlue */

F.3.6 XComposeStatus

XCoxnposeStatus describes the current state of a multikey character sequence. Used in calling XLookupString. This processing is not implemented in the MIT sample servers.

typedef struct _XComposeStatus {

char *compose_ptr;

int chars matched; } XComposeStatus;

/* state table pointer */ /* match state */

F.3.7 XExtCodes

XExtCodes is a structure used by the extension mechanism. This structure is returned by xinitExtension which is not a standard Xlib routine but should be called within the extension code. Its contents are not normally accessible to the application.

typedef struct {

int extension;

int major_opcode;

int first_event;

int first_error; } XExtCodes;

/* public to extension, cannot be changed */

/* extension number */

/* major opcode assigned by server */

/* first event number for the extension */

/* first error number for the extension */

F.3.8 XExtData

XExtData provides a way for extensions to attach private data to the existing structure types GC, visual, Screen, Display, and XFontStruct. This structure is not used in normal Xlib programming.

typedef struct _XExtData {

int number;

struct _XExtData *next;

int (*free_private){);

char *private_data; } XExtData;

/* number returned by XRegisterExtension */

/* next item on list of data for structure */

/* called to free private storage */

/* data private to this extension */

654

Xlib Reference Manual

F.3.9 XFontProp

XFontProp is used in XFontStruct. This structure allows the application to find out the names of additional font properties beyond the predefined set, so that they too can be accessed with XGet Font Property. This structure is not used as an argument or return value for any core Xlib function.

typedef struct {

Atom name;

unsigned long card32; } XFontProp;

F.3.10 XFontStruct

XFont Struct specifies metric information for an entire font This structure is filled with the XLoadQueryFont and XQueryFont routines. ListFontsWithlnf o also fills it but with metric information for the entire font only, not for each character. A pointer to this structure is used in the routines XFreeFont, XFreeFontlnfo, XGetFontProp, XTextExtents*, and XTextwidth*.

typedef struct {

XExtData *ext_data; /*

Font fid; /*

unsigned direction; /* unsigned min_char_or_byte2; /* unsigned max_char_or_byte2; /*

unsigned min_bytel; /*

unsigned max_bytel; /*

Bool all_chars_exist; /*

unsigned default_char; /*

int n_properties; /*

XFontProp *properties; /*

XCharStruct min_bounds; /*

XCharStruct max_bounds; /*

XCharStruct *per_char; /*

int ascent; /*

int descent; /*

} XFontStruct;

hook for extension to hang data */

font ID for this font */

direction the font is painted */

first character */

last character */

first row that exists */

last row that exists */

flag if all characters have nonzero size*/

char to print for undefined character */

how many properties there are */

pointer to array of additional properties*/

minimum bounds over all existing char*/

maximum bounds over all existing char*/

first_char to last_char information */

logical extent above baseline for spacing */

logical descent below baseline for spacing */

F.3.11 XGCValues

XGCValues is used to set or change members of the GC by the routines XGreateGC and XChangeGC.

typedef struct { int function; unsigned long plane_mask; unsigned long foreground;

/* logical operation */

/* plane mask */

/* foreground pixel */

Appendix F: Structure Reference

unsigned long background; int line_width; int line_style; int cap_style; int join_style; int fill_style; int fill_rule; int arc mode; Pixmap tile; Pixmap stipple; int ts_x_origin; int ts_y_origin; Font font; int subwindow_mode; Bool graphics_exposures; int clip_x_origin; int clip_y_origin; Pixmap clip_mask; int dash_offset; char dashes; XGCValue.;

/* background pixel */

/* line width */

/* LineSolid, LineOnOffDash, LineDoubleDash */

/* CapNotLast, CapButt, CapRound, CapProjecting */

/* JoinMiter, JoinRound, JoinBevel */

/* FillSolid, FillTiled, FillStippled */

/* EvenOddRule, WindingRule */

/* ArcPieSlice, ArcChord */

/* tile pixmap for tiling operations */

/* stipple 1 plane pixmap for stippling */

/* offset for tile or stipple operations */

/* default text font for text operations */ /* ClipByChildren, Includelnferiors */ /* Boolean, should exposures be generated */ /* origin for clipping */

/* bitmap clipping; other calls for rects */ /* patterned/dashed line information */

F.3.12 XHostAddress

XHostAddress specifies the address of a host machine that is to be added or removed from the host access list for a server. Used in XAddHost, XAddHosts, XListHosts, XRemoveHost, and XRemoveHosts.

typedef struct { int family; int length; char *address;

} XHostAddress;

/* for example FAMILY_INTERNET */ /* length of address, in bytes */ /* pointer to where to find the bytes */

F.3.13 XlconSize

XlconSize is Used to set or read the XA_WM_ICON SIZE property. This i

XSetIconSizes «*'"« by each application

typedef struct {

int min_width, min_height;

int max_width, max_height;

int width_inc, height_inc; } XlconSize;

656

Xlib Reference Manual

F.3.14 Xlmage

Xlmage describes an area of the screen; is used in XCreatelmage, XDestroylmage, XGetPixel, XPutPixel, XSublmage, XAddPixel, XGetlmage, XGetSub-Image, and XPut Image.

typedef struct _XImage {

int width, height;

int xoffset;

int format;

char *data;

int byte_order;

int bitmap_unit;

int bitmap_bit_order;

int bitmap_pad;

int depth;

int bytes_per_line;

int bits_per_pixel;

unsigned long red_mask;

unsigned long green_mask;

unsigned long blue_mask;

char *obdata;

struct funcs {

struct _XImage *(*create_image)() int (*destroy_image){); unsigned long (*get_pixel)(); int (*put_pixel)(); struct _XImage *(*sub_image)(); int (*add_pixel){);

} f; } Xlmage;

/* size of image */

/* number of pixels offset in X direction */

/* XYBitmap, XYPixmap, ZPixmap */

/* pointer to image data */

/* data byte order, LSBFirst, MSBFirst */

/* quant, of scan line 8, 16, 32 */

/* LSBFirst, MSBFirst */

/* 8, 16, 32 either XY or ZPixmap */

/* depth of image */

/* accelerator to next line */

/* bits per pixel (ZPixmap) */

/* bits in z arrangement */

/* hook for the object routines to hang on */ /* image manipulation routines */

F.3.15 XKeyboardControl

XKeyboardControl is used to set user preferences with XChangeKeyboard-Control.

typedef struct {

int key_click_percent;

int bell_percent;

int bell_pitch;

int bell_duration;

int led;

int led_mode;

int key;

int auto repeat mode;

AutoRepeatModeOn, AutoRepeatModeOff, AutoRepeatModeDefault */

} XKeyboardControl;

Appendix F: Structure Reference

F.3.16 XKeyboardState

XKeyboardState is used to return the current settings of user preferences with XGet KeyboardControl.

typedef struct {

int key_click_percent;

int bell_percent;

unsigned int bell_pitch, bell_duration;

unsigned long led_mask;

int global_auto_repeat;

char auto_repeats[32]; } XKeyboardState;

F.3.17 XModifierKeymap

XModif ierKeymap specifies which physical keys are mapped to modifier functions. This structure is returned by XGetModif ierMapping and is an argument to XDelete-ModifiermapEntry, XFreeModifiermap, XInsertModifiermapEntry, XNewModif iermap, and XSetModif ierMapping.

typedef struct {

int maxjceypermod; /* server's max f of keys per modifier */

KeyCode *modifiermap; /* an 8 by max_keypermod array of modifiers

} XModifi«rK«ym*p;

F.3.18 XPixmapFormatValues

XPixmapFonnatValues describes one pixmap format that is supported on the server. A list of these structures is returned by XListPixmapFormat s.

typedef struct {

int depth;

int bits_per_pixel;

int scanline_pad; } XPixmapFormatValues;

F.3.19 XPoint

XPoint specifies the coordinates of a point. Used in XDrawPoints, XDrawLines XFillPolygon, and XPolygonRegion.

typedef struct {

short x, y; } XPoint;

CCO

Xlib Reference Manual

F.3.20 XRectangle

XRectangle specifies a rectangle. Used in XClipBox, XDrawRectangles, XFill-Rectangles, XSetClipRectangles, and XUnionRectWithRegion.

typedef struct {

short x, y;

unsigned short width, height; } XRectangle;

F.3.21 XSegment

XSegment specifies two points. Used in XDrawSegments.

typedef struct {

short xl, yl, x2, y2; } XSegment;

F.3.22 XSetWIndowAttributes

XSetwindowAttributes contains all the attributes that can be set without window man ager intervention. Used in XChangeWindowAttributes and XCreateWindow.

typedef struct {

Pixmap background_pixmap; /' unsigned long background_pixel;

Pixmap border_pixmap; / i

unsigned long border_pixel; / i

int bit_gravity; / i

int win_gravity; / i

int backing_store; / i unsigned long backing_planes; / i

unsigned long backing_pixel; / i

Bool save_under; / i

long event mask; / i

long do_not_propagate_mask; / i

Bool override_redirect; / i

Colormap colormap; / 1

Cursor cursor; / j } XSetwindowAttributes;

background or None or ParentRelative */ '* background pixel */ border of the window */ border pixel value */ one of bit gravity values */ one of the window gravity values */ NotUseful, WhenMapped, Always */ planes to be preserved if possible */ value to use in restoring planes */ should bits under be saved? (popups) */ set of events that should be saved */ set of events that should not */ propagate */

Boolean value for override-redirect */ colormap to be associated with window */ cursor to be displayed (or None) */

Appendix F: Structure Reference

F.3.23 XSizeHints

XSizeHints describes a range of preferred sizes and aspect ratios. Used to set the XA_WM_NORMAL_HINTS and XA_WM_ZOOM_HINTS properties for the window manager with XSetStandardProperties, XSetNormalHints, XSetSizeHints, or XSet-ZoomHints in R3, and XSetWMProperties, XSetWMNormalHints, and XSet-WMSizeHints in R4. Also used in reading these properties with XGetNormalHints, XGetSizeHints, or XGetZoomHints in R3, and XGetWMNormalHints and XGetWMSizeHints.

typedef struct {

long flags; /* marks defined fields in structure */

int x, y; /* obsolete in R4 */

int width, height; /* obsolete in R4 */

int min_width, min_height;

int max_width, max_height;

int width_inc, height_inc;

struct {

int x; /* numerator */

int y; /* denominator */

} min_aspect, max_aspect;

int base_width, base_height; /* Added in R4 */ int win_gravity; /* Added in R4 */

} XSizeHints;

F.3.24 XStandardColormap

XStandardColormap describes a standard colormap, giving its ID and its color character istics. This is the format of the standard colormap properties set on the root window which can be changed with XSetRGBColormaps (XSetStandardProperties in R3) and read with XGetRGBColormaps (XGetStandardProperties in R3).

typedef struct {

Colormap colormap; unsigned long red_max; unsigned long red mult; unsigned long green_max; unsigned long green_mult; unsigned long blue_max; unsigned long blue_mult; unsigned long base_pixel;

ra"mi£' ualid; '* added in R4 *'

/* added in R4 */ } XStandardColormap;

660

Xlib Reference Manual

XTextltem

XTextltem describes a string, the font to print it in, and the horizontal offset from the pre vious string drawn or from the location specified by the drawing command. Used in XDrawText.

typedef struct {

char *chars;

int nchars;

int delta;

Font font; } XTextltem;

/* pointer to string */

/* number of characters */

/* delta between strings */

/* font to print it in, None don't change */

F.3.26 XTextltem16

XTextlteml6 describes a string in a two-byte font, the font to print it in, and the horizontal offset from the previous string drawn or from the location specified by the drawing com mand. Used in XDrawText 16.

typedef struct {

XChar2b *chars;

int nchars;

int delta;

Font font; } XTextltemlS;

/* two-byte characters */

/* number of characters */

/* delta between strings */

/* font to print it in. None don't change */

F.3.27 XTextProperty

XTextProperty holds the information necessary to write or read a TEXT property, which contains a list of strings. This structure is used by many of the R4 routines that write and read window manager hints that are in string format. The purpose of this structure is to allow these properties to be processed in non-european languages where more than 8 bits might be needed. These structures are also used in XGetTextProperty, XSetTextProperty, XStringListToTextProperty, and XTextPropertyToStringList.

typedef struct {

unsigned char *value;

Atom encoding;

int format;

unsigned long nitems; } XTextProperty;

/* same as Property routines */

/* prop type */

/* prop data format: 8, 16, or 32 */

/* number of data items in value */

Appendix F: Structure Reference

F.3.28 XTimeCoord

XTineCoord specifies a time and position pair, for use in tracking the pointer with XGet MotionEvents. This routine is not supported on all systems.

typedef struct { Time time; short x, y;

} XTimaCoord;

F.3.29 XVisuallnfo

XVisuallnfo contains all the information about a particular visual. It is used in XGet-visuallnfo and XMatchVisuallnfo to specify the desired visual type. The visual member of XVisuallnfo is used for the visual argument of XCreate-Colormap or XCreateWindow.

typedef struct {

Visual *visual;

VisuallD visualid;

int screen;

unsigned int depth;

int class;

unsigned long red_mask;

unsigned long green_mask;

unsigned long blue_mask;

int colormap_size;

int bits_per_rgb; } XVisuallnfo;

F.3.30 XWindowAttributes

XWindowAttributes describes the complete set of window attributes, including those that cannot be set without window manager interaction. This structure is returned by XGet-

WindowAttributes. It is not used by XChangeWindowAttributes or XCreateWindow.

typedef struct {

int x, y; /* location of window */

int width, height; /* width and height of window */

int border_width; /* border width of window */

int depth; /* depth of window */

Visual *visual; /* the associated visual structure */

Window root; /* root of screen containing window */

int class; /* InputOutput, InputOnly*/

int bit_gravity; /* one of bit gravity values */

int win_gravity; /* one of the window gravity values */

int backing_store; /* NotUseful, WhenMapped, Always */

Xlib Reference Manual

unsigned long backing_planes; unsigned long backing_pixel; Bool save_under; Colormap colormap; Bool map_installed; int map_state; long all_event_masks; long your_event_mask; long do_not_propagate_mask; Bool override_redirect; Screen *screen; XWindowAttributes;

/* planes to be preserved if possible */

/* value to be used when restoring planes */

/* Boolean, should bits under be saved */

/* colormap to be associated with window */

/* Boolean, is colormap currently installed*/

/* IsUnmapped, IsUnviewable, IsViewable */

/* events all people have interest in*/

/* my event mask */

/* set of events that should not propagate */

/* Boolean value for override-redirect */

F.3.31 XWindowChanges

XWindowChanges describes a configuration for a window. Used in XConf igure-window, which can change the screen layout and therefore can be intercepted by the win dow manager. This sets some of the remaining members of xwindowAttributes that cannot be set with XChangeWindowAttributes or XCreateWindow.

typedef struct {

int x, y;

int width, height;

int border_width;

Window sibling;

int stack_mode; } XWi ndowChange•;

F.3.32 XWMHints

xwMHints describes various application preferences for communication to the window manager via the XA_WM_HINTS property. Used in xsetWMHints and XGetWMHints.

typedef struct { long flags; Bool input;

/* marks defined fields in structure */

/* does application need window manager for

* keyboard input */

/* see below */

/* pixmap to be used as icon

int initial_state; Pixmap icon_pixmap; Window icon_window; int icon x, icon y; Pixmap icon_mask; XID window_group; /* ID of related window group */ /* this structure may be extended in the future */ } XWMHints;

window to be used as icon initial position of icon ' icon mask bitmap */

Appendix F: Structure Reference

Symbol Reference

This appendix presents an alphabetical listing of the symbols used in Xlib. The routines in parentheses following the descriptions indicate the routines associated with those symbols.

A

Above Specifies that the indicated window is placed above the indi

cated Sibling window. (XConf igureWindow)

AllHints XA_WM_HINTS property, stores optional information for the

window manager. If AllHints is set, all members of

XA_WM_HINTS are Set (XGetWMHints, XSetWMHints)

AllocAll Creates a colormap and allocates all of its entries. Available

for the DirectColor, Grayscale, and Pseudocolor visual Classes only. (XCreateColormap)

AllocNone Creates a colormap and allocates none of its entries.

(XCreateColormap)

AllowExposures Specifies that exposures are generated when the screen is

restored after blanking. (XGetScreenSaver, XSetScreen-Saver)

AllTemporary Specifies that the resources of all clients that have terminated

in RetainTemporary (see XSetCloseDownMode) should be killed. (XKillClient)

AllValues Mask used by xparseGeometry; returns those set by user.

AlreadyGrabbed Specifies that the pointer or keyboard is actively grabbed by

another client. (XGrabKeyboard, XGrabPointer)

Always Advises the server to maintain contents even when the window

is unmapped. (XChangeWindowAttributes, XCreate-Window)

AnyButton Specifies that any button is to be grabbed (XGrabButton) or

ungrabbed (xungrabButton) or that any button will trigger a ButtonPress or ButtonRelease event

AnyKey Specifies that any key is to be grabbed or ungrabbed. (XGrab-

Key,XUngrabKey)

AnyModifier Specifies a modifier keymask for XGrabButton, XGrabKey,

and XUngrabKey, and for the results of XQueryPointer.

Appendix G: Symbol Reference

AnyPropertyType ArcChord

ArcPieSlice AsyncBoth

AsyncKeyboard

AsyncPointer

AutoRepeatModeDefault

AutoRepeatModeOff

AutoRepeatModeOn

B

BadAccess

BadAlloc BadAtom BadColor BadCursor

BadDrawable

BadFont

BadGC

BadlDChoice

Badlmplementation

BadLength

BadMatch

Specifies that the property from a specified window should be returned regardless of its type. (xcetwindowProperty)

Value of the arc_mode member of the GC: specifies that the area between the arc and a line segment joining the endpoints

Of the arc is filled. (XSetArcMode)

Value of the arc_mode member of the GC: specifies that the area filled is delineated by the arc and two line segments con necting the ends of the arc to the center point of the rectangle defining the arc. (XSetArcMode)

Specifies that pointer and keyboard event processing resume normally if both the pointer and the keyboard are frozen by the client when XAliowEvents is called with AsyncBoth.

(XAllowEvents)

Specifies that keyboard event processing resumes normally if the keyboard is frozen by the client when XAllowEvents is called with AsyncPointer. (XAllowEvents) Specifies that pointer event processing resumes normally if the pointer is frozen by the client when XAllowEvents is called with AsyncPointer. (XAllowEvents)

Value of auto_repeat_mode: specifies that the key or key

board is set to the default setting for the server, (xchange-

KeyboardControl.XGetKeyboardControl)

Value of auto_repeat_mode: specifies that no keys will

repeat. (XChangeKeyboardControl, XGetKeyboard-

Control)

Value of auto_repeat_mode: specifies that keys that are set

to auto_repeat will do SO. (XChangeKeyboardControl XGetKeyboardControl)

Used by non-fatal error handlers only, meaning depends on

Used by non-fatal error handlers only, insufficient resources. Used by non-fatal error handlers only, parameter not an Atom. Used by non-fatal error handlers only, no such colormap.

Used by non-fatal error handlers only, parameter not a Cur-sor.

Used by non-fatal error handlers only, parameter not a Font Used by non-fatal error handlers only, parameter not a GC

n0t in

or

Used by non-fatal error handlers only, server is defective d by non-fatal error handlers only, request length incorrect. 1 by non-fatal error handlers only, parameter mismatch

666

Xlib Reference Manual

BadName BadPixmap

BadRequest BadValue

BadWindow

Below

BitmapFileInvalid

BitmapNoMemory

BitmapOpenFailed

BitmapSuccess

Bottomlf

Buttonl

ButtonlMask ButtonlMotionMask

Button2

Button2Mask Button2MotionMask

Buttons

ButtonSMask Button3MotionMask

Button4 Button4Mask

Used by non-fatal error handlers only, font or color name does not exist.

Used by non-fatal error handlers only, parameter not a Fix-map. Used by non-fatal error handlers only, bad request code.

Used by non-fatal error handlers only, integer parameter out of range.

Used by non-fatal error handlers only, parameter not a win dow.

Specifies that the indicated window is placed below the indi cated sibling window. (XConf igureWindow)

Specifies that a file does not contain valid bitmap data.

(XReadBitmapFile.XWriteBitmapFile)

Specifies that insufficient working storage is allocated.

(XReadBitmapFile,XWriteBitmapFile)

Specifies that a file cannot be opened. (XReadBitmapFile, XWriteBitmapFile)

Specifies that a file is readable and valid. (XReadBitmap File, XWriteBitmapFile)

Specifies that the indicated window is placed at the bottom of the stack if it is obscured by the indicated sibling window. (XConfigureWindow)

Specifies that buttonl is to be grabbed (XGrabButton) or

ungrabbed (XUngrabButton).

Returns the current state of buttonl. (XQueryPointer)

Specifies that any buttonl MotionNotify events are to be selected for this window. A MotionNotify event reports pointer movement, (xselectlnput)

Specifies that button2 is to be grabbed (XGrabButton) or

ungrabbed (XUngrabButton).

Returns the current state of button2. (XQueryPointer)

Specifies that any button2 MotionNotify events are to be selected for this window. A MotionNotify event reports pointer movement, (xselectlnput)

Specifies that button3 is to be grabbed (XGrabButton) or

ungrabbed (XUngrabButton).

Returns the current state of buttons. (XQueryPointer)

Specifies that any buttons MotionNotify events are to be selected for this window. A MotionNotify event reports pointer movement, (xselectlnput)

Specifies that button4 is to be grabbed (XGrabButton) or

ungrabbed (XUngrabButton).

Returns the current state of button4. (XQueryPointer)

Appendix G: Symbol Reference

Button4MotionMask

Buttons

Button5Mask Button5MotionMask

ButtonMotionMask

ButtonPress ButtonPressMask

ButtonRelease ButtonReleaseMask

c

CapButt

CapNotLast

CapProjecting

CapRound CenterGravity

CirculateNotify

CirculateRequest

ClientlconState

ClientMessage ClipByChildren

Specifies that any button4 MotionNotify events are to be

selected for this window. A MotionNotify event reports

pointer movement. (XSelectlnput)

Specifies that button5 is to be grabbed (XGrabButton) or

ungrabbed (XUngrabButton).

Returns the current state of buttons. (XQueryPointer)

Specifies that any buttons MotionNotify events are to be

selected for this window. A MotionNotify event reports

pointer movement. (XSelectlnput)

Specifies that any button MotionNotify events are to be selected for this window. A MotionNotify event reports pointer movement. (XSelectlnput)

Event type.

Specifies that any ButtonPress events are to be selected for this window. A ButtonPress event reports that a pointing device button has been pressed. (XSelectlnput)

Event type.

Specifies that any ButtonRelease events are to be selected for this window. A ButtonRelease event reports that a pointing device button has been released. (XSelectlnput)

Value of the cap_sty le member of a GC: specifies that lines will be square at the endpoint with no projection beyond.

(XSetLineAttributes)

Value of the cap_styie member of a GC: equivalent to CapButt except that, for a line_width of 0 or 1, the final endpoint is not drawn. (XSetLineAttributes) Value of the ca P _styie member of a GC: specifies that lines will be square at the end but with the path continuing beyond the endpoint for a distance equal to half the line_width.

(XSetLineAttributes)

Value of the cap_sty le member of a GC: specifies that lines will be terminated by a circular arc. (XSetLineAttributes) When a window is resized, specifies the new location of the contents or the children of the window. (xchangeWindow-Attributes,XCreateWindow) Event type. Event type.

Indicates that the client wants its icon_window to be visible. If an icon_window is not available, it wants its top-level win dow visible. (Value for initial_state member of

XWMHints.)

Event type.

Value of the subwindow_mode member of the GC: specifies Ujat graphics requests will not draw through viewable children (XSetSubwindowMode)

Xlib Reference Manual

ColormapChangeMask

ColormapInstailed

ColormapNotify ColormapUninstalled

Complex

ConfigureNotify ConfigureRequest ControlMapIndex

ControlMask

Convex

CoordModeOrigin

CoordModePrevious

CopyFromParent

CreateNotify

CurrentTime

CursorShape

CWBackingPixel CWBackingPlanes CWBackingStore CWBackPixel CWBackPixmap

CWBitGravity CWBorderPixel

Specifies that ColormapNotify events are to be selected for the window. A ColormapNotify event reports colormap changes. (XSelectInput)

In a ColormapNotify event, specifies that the colormap is installed.

Event type.

In a ColormapNotify event, specifies that the colormap is uninstalled.

Specifies that paths may self-intersect in polygon shapes. (XFillPolygon)

Event type. Event type.

Identifies one of eight modifiers to which keycodes can be mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym, XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey, XUngrabButton, and XUngrabKey, and for the results of XQueryPointer.

Specifies that a polygon's path is wholly convex. (XF ill-Polygon)

Specifies that all coordinates are relative to the origin of the drawable. (XDrawLines, XDrawPoints, XFillPolygon)

Specifies that all coordinates are relative to the previous point (the first point is relative to the origin). (XDrawLines, XDrawPoints,XFillPolygon)

Specifies that a window's border pixmap, visual ID, or class should be copied from the window's parent (xchange-WindowAttributes,XCreateWindow)

Event type.

Specifies time in most time arguments.

Specifies the "best" supported cursor size available on the dis play hardware. (XQueryBestSize)

Mask to set the backing_pixel window attribute. (XChangeWindowAttributes,XCreateWindow)

Mask to set the backing_pianes window attribute. (XChangeWindowAttributes, XCreateWindow)

Mask to set the backing_store window attribute. (XChangeWindowAttributes, XCreateWindow)

Mask to set the background_pixei window attribute. (XChangeWindowAttributes,XCreateWindow)

Mask to set the background_pixmap window attribute. (XChangeWindowAttributes, XCreateWindow)

Mask to set the bit_gravity window attribute. Mask to set the border_pixel window attribute.

Appendix G: Symbol Reference

CWBorderPixmap CWBorderWidth

CWColormap

CWCursor

CWDontPropagate

CWEventMask

CWHeight

CWOverrideRedirect

CWSaveUnder

CWSibling

CWStackMode

CWWidth

CWWinGravity

CWX

CWY

DEF

DefaultBlanking DefaultExposures

DestroyAll

DestroyNotify DirectColor

DisableAccess DisableScreenlnterval Internal to Xlib.

Mask to set the border_pixmap window attribute.

Mask to set a new width for the window's border.

(XConfigureWindow)

Mask to set the colormap window attribute, (xchange-WindowAttributes, XCreateWindow)

Mask to set the cursor window attribute, (xchange-

WindowAttributes, XCreateWindow)

Mask to set the do_not_propagate_mask window attribute. (XChangeWindowAttributes, XCreateWindow)

Mask to set the event_mask window attribute. (XChange-WindowAttributes, XCreateWindow)

Mask to set a new height for the window, (xconf igure-Window)

Mask to set the override_redirect window attribute.

(XChangeWindowAttributes, XCreateWindow)

Mask to set the save_under window attribute. (XChange WindowAttributes, XCreateWindow)

Mask to specify a sibling of the window, used in stacking operations. (XConfigureWindow)

Mask to set a new stack mode for the window. (XConfigure

Mask to set a new width for the window. (XConfigure

Mask to set the win_gravity window attribute. (XChange WindowAttributes, XCreateWindow) Mask to set a new X value for the window's position

(XConfigureWindow)

Mask to set a new Y value for the window's position

(XConfigureWindow)

Specifies default screen saver screen blanking, (xcet-

ScreenSaver,XSetScreenSaver)

Specifies that the default <??what default??> will govern whether or not exposures are generated when the screen is restored after blanking. (XGetScreenSaver, XSetScreen Saver)

Specifies that all resources associated with a client/server con nection will be freed when the client process dies, (xset-

CloseDownMode)

Event type.

670

Xlib Reference Manual

DisableScreenSaver DoBlue

DoGreen

DontAllowExposures DontCareState

DontPreferBlanking DoRed

EastGravity EnableAccess

EnterNotify EnterWindowMask

EvenOddRule

Expose ExposureMask

FamilyChaos FamilyDECnet FamilyInternet FillOpaqueStippled

Internal to Xlib.

Sets or changes the read/write colormap cell that corresponds to the specified pixel value to the hardware color that most closely matches the specified blue value. (xstoreCoior, XStoreColors,XStoreNamedColor)

Sets or changes the read/write colormap cell that corresponds to the specified pixel value to the hardware color that most closely matches the specified green value. (xstoreCoior, XStoreColors,XStoreNamedColor)

Specifies that exposures are not generated when the screen is restored after blanking. (XGetScreenSaver, XSetScreen-Saver)

Indicates that the client does not know or care what the initial state of the client is when the top-level window is mapped. Obsolete in R4. (Value for initial_state member of

XWMHints.)

Specifies no screen saver screen blanking, (xcetScreen-Saver, XSetScreenSaver)

Sets or changes the read/write colormap cell that corresponds to the specified pixel value to the hardware color that most closely matches the specified red value. (xstoreCoior,

XStoreColors,XStoreNamedColor)

When a window is resized, specifies the new location of the contents or the children of the window. (xchangeWindow-Attributes,XCreateWindow)

Specifies that the host access list should be checked before allowing access to clients running on remote hosts (access con trol is enabled). (XSetAccessControl)

Event type.

Specifies that any EnterNotify events are to be selected for this window. An EnterNotify event reports pointer window entry. (XSelectlnput)

Value of the f ill_rule member of a GC: specifies that areas overlapping an odd number of times should not be part of the

region. (XPolygonRegion, XSetFillRule)

Event type.

Specifies that any exposure event except GraphicsExpose or NoExpose is to be selected for the window. An Expose event reports when a window or a previously invisible part of a win dow becomes visible, (xseiectinput)

Specifies an address in the ChaosNet network. (XAddHost) Specifies an address in the DECnet network. (XAddHost) Specifies an address in the Internet network. (XAddHost)

Value of the fill_style member of a GC: specifies that graphics should be drawn using stipple, using the fore ground pixel value for set bits in stipple and the background pixel value for unset bits in pixel. (xsetFiiistyle)

Appendix G: Symbol Reference

FillSolid

FillStippled

FillTiled

FirstExtensionError FocusChangeMask

Focusln FocusOut FontChange FontLeftToRight

FontRightToLeft ForgetGravity

G

GCArcMode

GCBackground

GCCapStyle

GCClipMask

GCClipXOrigin

GCClipYOrigin

GCDashList

Value of the f iii_styie member of a GC: specifies that graphics should be drawn using the foreground pixel value. (XSetFillStyle)

Value of the fill_style member of a GC: specifies that graphics should be drawn using the foreground pixel value masked by stipple. (XSetFillStyle)

Value of the f ill_style member of a GC: specifies that graphics should be drawn using the tile pixmap. (xset-FillStyle)

Use if writing extension.

Specifies that any Focusln and FocusOut events are to be

selected for this window. Focusln and FocusOut events

report changes in keyboard focus, (xselect input)

Event type.

Event type.

Internal to Xlib.

Reports that, using the specified font, the string would be

drawn left to right. (XQueryFont, XQueryTextExtents, XQueryTextExtentslG, XTextExtents, XText-

ExtentslG)

Reports that, using the specified font, the string would be

drawn right to left. (XQueryFont, XQueryTextExtents, XQueryTextExtentslG, XTextExtents, XText-

Extentsl6)

Specifies that window contents should always be discarded after a size change. (XChangeWindowAttributes, XCreateWindow)

Mask to set the arc_mode component Of a GC. (XChangeGC XCopyGC.XCreateGC)

Mask to set the background component of a GC. (xchange-

GC,XCopyGC, XCreateGC)

Mask to set the ca P _styie component of a GC. (xchanqe-

GC,XCopyGC, XCreateGC)

Mask to set the cli p _mask component of a GC. (xchanqe-

GC,XCopyGC, XCreateGC)

Mask to set the clip_ x _origin of the clip mask. (.XChangeGC, XCopyGC, XCreateGC)

Mask to set the cii p _y_ 0 rigin of the clip mask.

(.XChangeGC, XCopyGC, XCreateGC)

Mask to set the dashes component of a GC. (XChangeGC,

XCopyGC.XCreateGC)

672

Xlib Reference Manual

GCDashOffset

GCFillRule

GCFillStyle

GCFont

GCForeground

GCFunction

GCGraphicsExposures

GCJoinStyle

GCLastBit GCLineStyle

GCLineWidth

GCPlaneMask

GCStipple

GCSubwindowMode

GCTile

GCTileStipXOrigin

GCTileStipYOrigin

GrabFrozen

GrablnvalidTime

GrabModeAsync

GrabModeSync

GrabNotViewable

Mask to set the dash_offset component of a GC.

(XChangeGC,XCopyGC,XCreateGC)

Mask to set the f ill_rule component of a GC. (xchange-

GC, XCopyGC, XCreateGC)

Mask to set the f ill_style component of a GC. (xchange-GC,XCopyGC,XCreateGC)

Mask to set the font component of a GC. (XChangeGC,

XCopyGC,XCreateGC)

Mask to set the foreground component of a GC. (XChange-GC,XCopyGC,XCreateGC)

Mask to set the function component of a GC. (XChangeGC,

XCopyGC,XCreateGC)

Mask to set the graphics_exposures component of a GC.

(XChangeGC, XCopyGC, XCreateGC)

Mask to set the join_style component of a GC. (xchange-GC,XCopyGC,XCreateGC)

Higher than last GC mask value.

Mask to set the line_style component Of a GC. (XChange-GC,XCopyGC,XCreateGC)

Mask to set the line_width component of a GC. (xchange-GC,XCopyGC, XCreateGC)

Mask to set the plane_mask component of a GC. (XChange-GC,XCopyGC, XCreateGC)

Mask to set the stipple component of a GC. (XChangeGC,

XCopyGC,XCreateGC)

Mask to set the subwindow_mode component of a GC. (XChangeGC,XCopyGC,XCreateGC)

Mask to set the tile component of a GC. (XChangeGC,

XCopyGC,XCreateGC)

Mask to set the ts_x_origin component of a GC.

(XChangeGC,XCopyGC,XCreateGC)

Mask to set the ts_y_origin component of a GC.

(XChangeGC, XCopyGC, XCreateGC)

Specifies that the pointer is frozen by an active grab of another Client. (XGrabKeyboard, XGrabPointer)

Specifies that the indicated grab time is involved (earlier than the last keyboard grab time or later than the current server time). (XGrabKeyboard, XGrabPointer)

Specifies the pointer or keyboard mode. (XGrabButton, XGrabKey,XGrabKeyboard, XGrabPointer)

Specifies the pointer or keyboard mode. (XGrabButton,

XGrabKey,XGrabKeyboard,XGrabPointer)

Specifies that the grab_window is not viewable. (XGrab Keyboard, XGrabPointer)

Appendix G: Symbol Reference

GrabSuccess

GraphicsExpose

GravityNotify

Grayscale

GXand

GXandlnverted GXandReverse

GXclear

GXcopy

GXcopyInverted

GXequiv

GXinvert GXnand

GXnoop GXnor

GXor GXorlnverted

GXorReverse

GXset GXxor

HU

HeightValue

HostDelete Hostlnsert IconicState

IconMaskHint

Specifies a successful pointer or keyboard grab. (XGrab-

Keyboard,XGrabPointer) Event type. Event type.

Visual class, read/write. (XGetvisualinfo, XMat< Visuallnfo)

Value of the function member of the GC: used with source and destination pixels to generate final destination pixel val ues: STC AND dst. (XChangeGC, XCreateGC, XSet-Function)

(NOT src) AND dst. (XChangeGC, XCreateGC, XSet-Function)

src AND (NOT dst). (XChangeGC, XCreateGC, XSet-Function)

Set dst 10 0. (XChangeGC, XCreateGC, XSetFunction) src. (XChangeGC, XCreateGC, XSetFunction) (NOT src). (XChangeGC, XCreateGC, XSetFunction) (NOT src) XOR dst. (XChangeGC, XCreateGC, XSet Function)

(NOT dst). (XChangeGC, XCreateGC, XSetFunction) (NOT src) OR (NOT dst). (XChangeGC, XCreateGC, XSet Function)

dst. (XChangeGC, XCreateGC, XSetFunction) (NOT src) AND (NOT dst). (XChangeGC, XCreateGC, XSetFunction)

src OR dst. (XChangeGC, XCreateGC, XSetFunction) (NOT src) OR dst. (XChangeGC, XCreateGC, XSet Function)

STC OR (NOT dst). (XChangeGC, XCreateGC, XSet Function)

set pixel. (XChangeGC, XCreateGC, XSetFunction) src XOR dst. (XChangeGC, XCreateGC, XSetFunction)

Represents a user-specified window height in the standard window geometry string. (XParseGeometry) Used internally to distinguish XAddHost and XRemoveHost. Used internally to distinguish XAddHost and XRemoveHost.

Indicates that the client wants to be iconified when the top-level window is mapped. (Value for initial_state mem ber Of XWMHints.)

In the XA WM HINTS property, the icon pixmap mask mask communicates to the window manager a bitmap that deter mines which pixels in icon_pixmap are drawn on the icon

vvMUk-W. (v::--3tWMHints, XSetWMHints)

674

Xlib Reference Manual

IconPixmapHint

IconPositionHint

IconWindowHint

IgnoreState InactiveState IncludeInferiors

InputFocus InputHint

InputOnly InputOutput

IsCursorKey

IsFunctionKey

IsKeypadKey

IsMiscFunctionKey

IsModifierKey

IsPFKey

IsUnmapped

IsUnviewable

IsViewable

JoinBevel

In the XA_WM_HINTS property, the icon pixmap mask commu nicates to the window manager the pattern used to distinguish this icon from other clients. (xcetWMHints, xsetWMHints)

In the XA_WM_HINTS property, the position mask communi cates to the window manager the preferred initial position of the icon. (XGetWMHints, XSetWMHints)

In the XA_WM_HINTS property, the icon window mask commu nicates to the window manager that icon_window contains a window that should be used instead of creating a new one.

(XGetWMHints,XSetWMHints)

Indicates that the client wants the window manager to ignore this window. (Value for initial_state member of

XWMHints.)

Indicates that the client wants to be inactive when the top-level window is mapped. Obsolete in R4. (Value for ini-tial_state member of XWMHints.)

Value of the subwindow_mode member of the GC: specifies that graphics requests will draw through viewable children.

(XSetSubwindowMode)

Specifies that the event will be sent to the focus window, regardless of the position of the pointer. (xsendEvent)

In the XA_WM_HINTS property, the input member mask com municates to the window manager the keyboard focus model used by the application. (XGetWMHints, XSetWMHints)

InputOnly is a window class in which windows may receive input but may not be used to display output (xcreate-Window)

InputOutput is a window class in which windows may receive input and may be used to display output (xcreate-

Window)

Keysym class macro. Keysym class macro. Keysym class macro. Keysym class macro. Keysym class macro. Keysym class macro.

Means that the window is unmapped. (XGetwindow-Attributes)

Means that the window is mapped but is unviewable because some ancestor is unmapped. (XGetwindowAttributes)

Means that the window is currently viewable. (XGetwindow Attributes)

Value of the join_style member of a GC: specifies Cap-Butt enpoint styles, with the triangular notch filled, (xset-LineAttributes)

Appendix G: Symbol Reference

JoinMiter JoinRound

KL

KBAutoRepeatMode

KBBellDuration

KBBellPercent

KBBellPitch

KBKey

KBKeyClickPercent

KBLed

KBLedMode

KeymapNotify KeymapStateMask

KeyPress KeyPressMask

KeyRelease KeyReleaseMask

LASTEvent

LastExtensionError

LeaveNotify

LeaveWindowMask

Value of the join_styie member of a GC: specifies that the outer edges of the two lines should extend to meet at an angle. (XSetLineAttributes)

Value of the join_style member of a GC: specifies that the lines should be joined by a circular arc with diameter equal to

the line_width, centered On the join point. (XSetLine Attributes)

Mask to specify keyboard auto-repeat preferences.

(XChangeKeyboardControl, XGetKeyboardControl)

Mask to specify keyboard bell-duration preferences.

(XChangeKeyboardControl, XGetKeyboardControl)

Mask to specify keyboard base-volume preferences. (XChangeKeyboardControl, XGetKeyboardControl) Mask to specify keyboard bell-pitch preferences. (XChange KeyboardControl, XGetKeyboardControl) Mask to specify the keycode of the key whose auto-repeat sta tus will be changed to the setting specified by auto_repeat_mode. (XChangeKeyboardControl, XGet KeyboardControl)

Mask to set keyboard key click-volume preferences.

(XChangeKeyboardControl, XGetKeyboardControl) Mask to specify keyboard led preferences. (XChange KeyboardControl, XGetKeyboardControl) Mask to specify keyboard led_mode preferences. (XChange KeyboardControl, XGetKeyboardControl) Event type.

Specifies that any KeymapNotify events are to be selected for this window. A KeymapNotify event notifies the client about the state of the keyboard when the pointer or keyboard focus enters a window, (xselect Input) Event type.

Specifies that any KeyPress events are to be selected for this window. A KeyPress event reports that a keyboard key has been pressed, (xselectinput) Event type.

Specifies that any KeyRelease events are to be selected for this window. A KeyRelease event reports that a keyboard key has been released, (xselectinput) Bigger than any event type value. For extensions. Use if writing extension. Event type.

Specifies that any LeaveNotify events are to be selected for ^window. A LeaveNotify event reports when the pointer leaves the window, (xselectinput)

576

Xlib Reference Manual

LedModeOf f Value of ied_mode: specifies that the states of all the lights

are not changed. (XChangeKeyboardControl, XGet-KeyboardControl)

LedModeOn Value of ied_mode: specifies that the states of all the lights

are changed. (XChangeKeyboardControl, XGet-KeyboardControl)

LineDoubieDash Value of the line_style member of a GC: specifies that

dashes are drawn with the foreground pixel value and gaps with the background pixel value. (xsetLineAttributes)

LineOnOffDash Value of the line_style member of a GC: specifies that

only the dashes are drawn with the foreground pixel value, and cap_style applies to each dash. (XSetLineAttributes)

LineSolid Value of the iine_style member of a GC: specifies that the

full path of the line is drawn using the foreground pixel value. (XSetLineAttributes)

LockMapindex Identifies one of eight modifiers to which keycodes can be

mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym, XSetModifierMapping)

LockMask Specifies a modifier keymask for XGrabButton, XGrabKey,

XUngrabButton, and XUngrabKey, and for the results of XQueryPointer.

LowerHighest Specifies that the stacking order of children should be circu

lated down. (XCirculateSubwindows)

LSBFirst In image structure, specifies the byte order used by VAXes.

(XCreatelmage)

M

MapNot i f y Event type.

MappingBusy Specifies that, in pointer or modifier mapping, no modifiers

were changed because new keycodes for a modifier differ from those currently defined and any (current or new) keys for that modifier are in a down state. (XSetModifierMapping,

XSetPointerMapping)

MappingFaiied Specifies that pointer or modifier mapping failed. (XSet

ModifierMapping, XSetPointerMapping)

MappingKeyboard In a MappingNotify event, reports that keyboard mapping

was changed.

MappingModif ier In a MappingNotify event, reports that keycodes were set to

be used as modifiers. MappingNotify Event type.

MappingPointer In a MappingNotify event, reports that pointer button map

ping was set

MappingSuccess Specifies that pointer or modifier mapping succeeded. (XSet

ModifierMapping, XSetPointerMapping) MapReguest Event type.

Appendix G: Symbol Reference

MessageHint ModlMapIndex

ModlMask Mod2MapIndex

Mod2Mask Mod3MapIndex

Mod3Mask Mod4MapIndex

Mod4Mask ModSMapIndex

ModSMask

MotionNotify MSBFirst

N NoEventMask

NoExpose Nonconvex

In the XA_WM_HINTS property, the message member mask communicates to the window manager the <??what??>.

(XGetWMHints,XSetWMHints)

Identifies one of eight modifiers to which keycodes can be

mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym, XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey, xungrabButton, and xungrabKey, and for the results of

XQueryPointer.

Identifies one of eight modifiers to which keycodes can be

mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym, XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey, XUngrabButton, and XUngrabKey, and for the results of XQueryPointer.

Identifies one of eight modifiers to which keycodes can be mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym, XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey, XUngrabButton, and XUngrabKey, and for the results of XQueryPointer.

Identifies one of eight modifiers to which keycodes can be mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym, XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey, XUngrabButton, and XUngrabKey, and for the results of

XQueryPointer.

Identifies one of eight modifiers to which keycodes can be

mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey, XUngrabButton, and XUngrabKey, and for the results of

XQueryPointer. Event type.

In image structure, specifies the byte order used by 68000-fam-ily systems. (XCreatelmage)

Specifies that no events are to be selected for this window

(XSelectlnput) Event type.

Specifies that a polygon's path does not self-intersect but that the polygon is not wholly convex. (XFiiiPolygon)

675

Xlib Reference Manual

None NormalState

NorthEastGravity

NorthGravity

NorthWestGravity

NoSymbol NotifyAncestor

NotifyDetailNone

NotifyGrab NotifyHint Notifylnferior

NotifyNone

NotifyNonlinear

NotifyNonlinear-Virtual

Specifies a universal null resource or null atom.

Indicates that the client wants its top-level window visible. (Value for initial_state member of XWMHints.)

When a window is resized, specifies the new location of the contents or the children of the window, (xchangewindow-

Attributes,XCreateWindow)

When a window is resized, specifies the new location of the contents or the children of the window. (xchangeWindow-

Attributes,XCreateWindow)

When a window is resized, specifies the new location of the contents or the children of the window, (xchangewindow-

Attributes,XCreateWindow)

Specifies the keysym for no symbol.

In EnterNotify, Focusln, FocusOut, and LeaveNotify events, specifies the hierarchical relationship of the origin and destination windows.

In EnterNotify, Focusln, FocusOut, and LeaveNotify

events, specifies the hierarchical relationship of the origin and destination windows.

In EnterNotify, Focusln, FocusOut, and LeaveNotify

events, specifies that the keyboard or pointer was grabbed. In a MotionNotify event, a hint that specifies that

PointerMotionHintMask was selected.

In EnterNotify, Focusln, FocusOut, and LeaveNotify events, specifies the hierarchical relationship of the origin and destination windows.

In EnterNotify, Focusln, FocusOut, and LeaveNotify events, specifies the hierarchical relationship of the origin and destination windows.

In EnterNotify, Focusln, FocusOut,and LeaveNotify events, specifies the hierarchical relationship of the origin and destination windows.

In EnterNotify, Focusln, FocusOut, and LeaveNotify

events, specifies the hierarchical relationship of the origin and destination windows.

NotifyNormal

NotifyPointer

NotifyPointerRoot

NotifyUngrab

In a MotionNotify event, a hint that specifies that the event is real but may not be up to date since there may be many more later motion events on the queue. In EnterNotify, Focus-in, FocusOut, and LeaveNotify events, specifies that the keyboard was not grabbed at the time the event was generated.

In Focusln and FocusOut events, specifies the hierarchical relationship of the origin and destination windows.

In Focusln and FocusOut events, specifies the hierarchical relationship of the origin and destination windows.

In EnterNotify, Focusln, FocusOut, and LeaveNotify events, specifies that the keyboard or pointer was ungrabbed.

Appendix G: Symbol Reference

NotifyVirtual

NotifyWhileGrabbed NotUseful

NoValue

OP

Opposite

OwnerGrabButtonMask

PAllHints

ParentRelative

PAspect

PBaseSize

PlaceOnBottom

PlaceOnTop

PMaxSize

PMinSize

PointerMotionHintMask

PointerMotionMask

PointerRoot

PointerWindow

PPosition

In EnterNotify, Focusln, FocusOut, and LeaveNotify events, specifies the hierarchical relationship of the origin and destination windows. EnterNotify, Focusln, FocusOut, LeaveNotify mode.

Specifies that maintaining the contents of an unmapped win dow is unnecessary. (xchangeWindowAttributes, XCreateWindow)

Mask used by XP arse Geometry; returns those set by user.

Specifies that, if the indicated sibling occludes the indicated window, the window is placed at the top of the stack; if the window occludes the sibling, the window is placed at the bot tom of the stack. (XConfigureWindow)

Controls the distribution of button events to a client between ButtonPress and ButtonRelease events. (XSelect-Input)

Specifies that the program determined the window hints.

(XGetNormalHints, XSetNormalHints)

Specifies that a window's background will be repainted when

it is moved. (XSetWindowBackgroundPixmap)

Specifies that the program determined the min and max aspect

ratio. (XGetNormalHints, XSetNormalHints)

Specifies that the program determined the base window size.

(XGetNormalHints, XSetNormalHints)

In a circulateNotify event, specifies that the window will be placed on the bottom of the stack.

In a circulateNotify event, specifies that the window will be placed on the top of the stack.

Specifies that the program determined the maximum desired

Window Size. (XGetNormalHints, XSetNormalHints)

Specifies that the program determined the minimum desired Window size. (XGetNormalHints, XSetNormalHints) Specifies that the server should send only one MotionNotif y event when the pointer moves. Used in concert with other pointer motion masks to reduce the number of events gen erated. (XSelectInput)

Specifies that any pointer MotionNotify events are to be selected for this window. A MotionNotify event reports pointer movement, (xselectinput)

Specifies the ID of the window that is the current keyboard tOCUS. (XGetlnputFocus, XSetlnputFocus)

Specifies that the event will be sent to the window that the pointer is in. (XSendEvent)

Specifies that the program determined the window position

itNormalHints,XSetNormalHints)

680

Xlib Reference Manual

PreferBlanking

PResizelnc

PropertyChangeMask

PropertyDelete PropertyNewValue

PropertyNotify P ropModeAppend

PropModePrepend

PropModeReplace

Pseudocolor

PSize

PWinGravity

R

RaiseLowest Rectangleln RectangleOut RectanglePart

ReleaseByFreeing Colormap

ReparentNotify ReplayKeyboard

ReplayPointer

Specifies screen saver screen blanking. (XGetScreenSaver,

XSetScreenSaver)

Specifies that the program determined the window resize increments. (XGetNormalHints, XSetNormalHints)

Specifies that any PropertyNotify events are to be selected for this window. A PropertyNotify event indicates that a property of a certain window was changed or deleted. (XSelectlnput)

In a PropertyNotify event, specifies that a property of a window was deleted.

In a PropertyNotify event, specifies that a property of a window was changed.

Event type.

Appends the data onto the end of the existing data.

(XChangeProperty)

Inserts the data before the beginning of the existing data.

(XChangeProperty)

Discards the previous property and stores the new data.

(XChangeProperty)

Visual class, read/write. (XGetvisualinfo, XMatch-

Visuallnfo)

Specifies that the program determined the window size.

(XGetNormalHints, XSetNormalHints)

Specifies that the program determined the window gravity.

(XGetNormalHints, XSetNormalHints)

Specifies that the stacking order of children should be circu lated up. (XCirculateSubwindows)

Specifies that the rectangle is inside the region. (XRect-InRegion)

Specifies that the rectangle is completely outside the region.

(XRectlnRegion)

Specifies that the rectangle is partly inside the region.

(XRectlnRegion)

Value for the killid field of XStandardColormap. (XSetRGBColormap and XGetRGBColormap)

Event type.

Specifies the conditions under which queued events are released: ReplayKeyboard has an effect only if the key board is grabbed by the client and thereby frozen as the result of an event. (XAllowEvents)

Specifies the conditions under which queued events are released: ReplayPointer has an effect only if the pointer is grabbed by the client and thereby frozen as the result of an event (XAIIOWE vents)

Appendix G: Symbol Reference

ResizeRedirectMask

ResizeRequest RetainPermanent

RetainTemporary

RevertToNone

RevertToParent

RevertToPointerRoot

s

ScreenSaverActive ScreenSaverReset

SelectionClear SelectionNotify SelectionRequest SetModeDelete

SetModelnsert ShiftMapIndex

ShiftMask SouthEastGravity

Specifies that any ResizeRequest events should be selected for this window when some other client (usually the window manager) attempts to resize the window on which this mask is selected. (XSelectInput) Event type.

Specifies that resources associated with a client/server connec tion live on until a call to XKillClient. If AllTemporary is specified in XKillClient, the resources of all clients that have terminated in RetainTemporary are destroyed. <??vo!2 unclear -- XKillClient doc??> (XSetClose-DownMode)

Specifies that resources associated with a client/server connec tion live on until a call to XKillClient. If AllTemporary is specified in XKillClient, the resources of all clients that have terminated in RetainTemporary are destroyed, (xset-

CloseDownMode)

Specifies that there is no backup keyboard focus window.

(XGetlnputFocus,XSetlnputFocus)

Specifies that the backup keyboard focus window is the parent

window. (XGetlnputFocus, XSetlnputFocus)

Specifies that the backup keyboard focus window is the

pointer root window. (XGetlnputFocus, XSetlnputFocus)

Specifies that the screen saver is to be activated. (xForce-

ScreenSaver)

Specifies that the screen saver is to be turned off. (XForce-ScreenSaver)

Event type. Event type. Event type. Specifies that a subwindow is to be deleted from the client's

save-set. (XChangeSaveSet)

Specifies that a subwindow is to be added to the client's save-set. (XChangeSaveSet)

Identifies one of eight modifiers to which keycodes can be

mapped. (XDeleteModifiermapEntry, XGetModifier-Mapping, XInsertModifiermapEntry, XLookupKeysym XSetModifierMapping)

Specifies a modifier keymask for XGrabButton, XGrabKey xungrabButton, and xungrabKey, and for the results of XQueryPointer.

When a window is resized, specifies the new location of the contents or the children of the window, (xchangewindow-Attributes,XCreateWindow)

682

Xlib Reference Manual

SouthGravity SouthWestGravity StateHint

StaticColor StaticGravity

StaticGray

StippleShape

StructureNotifyMask

SubstructureNotify-Mask

SubstructureRedirect-Mask

When a window is resized, specifies the new location of the contents or the children of the window, (xchangewindow-

Attributes,XCreateWindow)

When a window is resized, specifies the new location of the contents or the children of the window. (xchangeWindow-Attributes,XCreateWindow)

In the XA_WM_HINTS property, the window state mask commu nicates to the window manager whether the client prefers to be in iconified, zoomed, normal, or inactive state. (XGet-

WMHints,XSetWMHints)

Visual class, read-only. (XGetVisuallnfo, XMatch-Visuallnfo)

Specifies that window contents should not move relative to the origin of the root window. (XChangeWindowAttribute, XCreateWindow)

Visual class, read-only. (XGetVisuallnfo, XMatch-Visuallnfo)

Specifies the "best" supported stipple size available on the dis play hardware. (XQueryBestSize)

Selects a group of event types (circuiateNotify,

ConfigureNotify, DestroyNotify, GravityNotify, MapNotify, ReparentNotify, UnmapNotify) that report when the state of a window has changed, (xselect input)

Selects a group of event types (circuiateNotify, ConfigureNotify, DestroyNotify, GravityNotify, MapNotify, ReparentNotify, UnmapNotify) that report

when the state of a window has changed, plus an event that indicates that a window has been created. It monitors all the subwindows of the window specified in the xselect Input call that used this mask.

The three event types selected by this mask (circuiate-

Request, ConfigureRequest, and MapRequest) can be used by the window manager to intercept and cancel window-configuration-changing requests made by other clients. (XSelectlnput)

Success SyncBoth

SyncKeyboard

SyncPointer

Indicates that everything is okay.

Specifies that pointer and keyboard event processing resumes

normally, until the next ButtonPress, ButtonRelease,

Keypress, or KeyRelease event, if the pointer and the key board are both frozen by the client when XAllowEvents is

called with SyncBoth. (XAllowEvents)

Specifies that key event processing resumes normally, until the next ButtonPress or ButtonRelease event, if the key board is frozen by the client when XAllowEvents is called with SyncPointer. (XAllowEvents)

Specifies that pointer event processing resumes normally, until the next ButtonPress or ButtonRelease event, if the

Appendix G: Symbol Reference

TU

TileShape Top If

TrueColor UnmapGravity

UnmapNotify Unsorted

USPosition USSize

vw

VisibilityChangeMask

VisibilityFully-Obscured

VisibilityNotify

VisibilityPartially-Obscured

VisibilityUnobscured

VisualAllMask

VisualBitsPerRGBMask

VisualBlueMaskMask

VisualClassMask

pointer is frozen by the client when XAllowEvents is called

with SyncPointer. (XAllowEvents)

Specifies the "best" supported tile size available on the display hardware. (XQueryBestSize)

Specifies that the indicated window is placed on top of the stack if it is obscured by the indicated sibling window.

(XConfigureWindow)

Visual class, read-only. (XGetVisuallnfo, XMatch-Visuallnfo)

Specifies that the child is unmapped when the parent is resized and an UnmapNotify event is generated. (xchangeWindow-Attributes,XCreateWindow)

Event type.

Specifies that the ordering of rectangles specified for a particu lar GC is arbitrary. (XSetClipRectangles)

Specifies that the user provided a position value for the win dow. (XGetNormalHints,XSetNormalHints)

Specifies that the user provided a size value for the window.

(XGetNormalHints,XSetNormalHints)

Specifies that any VisibilityNotify events are to be selected for this window, except when the window becomes not viewable. A VisibilityNotify event reports any changes in the window's visibility, (xselect input)

In a VisibilityNotify event, specifies that the window is fully obscured.

Event type.

In a VisibilityNotify event, specifies that the window is partially obscured.

In a VisibilityNotify event, specifies that the window is unobscured.

Determines which elements in a template are to be matched

(XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched

(XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched.

(XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched

(XGetVisuallnfo,XMatchVisuallnfo)

684

Xlib Reference Manual

VisualColormapSize-

Mask VisualDepthMask

VisualGreenMaskMask

VisuallDMask

VisualNoMask

VisualRedMaskMask

VisualScreenMask

WestGravity

WhenMapped

WidthValue WindingRule

WindowGroupHint WithdrawnState

X

XA_ARC

XA_ATOM

XA_BITMAP

XA_CAP_HEIGHT XA_CARDINAL

XA_COLORMAP

XA_COPYRIGHT XA CURSOR

Determines which elements in a template are to be matched.

(XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched. (XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched.

(XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched. (XGetVisuallnfo, XMatchVisuallnfo)

Determines which elements in a template are to be matched.

(XGetVisuallnfo, XMatchVisuallnfo)

Determines which elements in a template are to be matched.

(XGetVisuallnfo,XMatchVisuallnfo)

Determines which elements in a template are to be matched.

(XGetVisuallnfo,XMatchVisuallnfo)

When a window is resized, specifies the new location of the contents or the children of the window, (xchangewindow-Attributes,XCreateWindow)

Advises the server to maintain contents of obscured regions when the window is unmapped, (xchangewindow-Attributes,XCreateWindow)

Represents a user-specified window width in the standard win dow geometry string. (XParseGeometry)

Value of the f ill_rule member of a GC: specifies that areas overlapping an odd number of times should be part of the

region. (XPolygonRegion, XSetFillRule)

In the XA_WM_HINTS property, the group property mask com municates to the window manager that the client has multiple

top-level windows. (XGetWMHints.XSetWMHints)

Indicates that the client wants neither its top-level nor its icon visible. (Value for initial state member of xwMHints.)

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Predefined type atom.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Predefined font atom.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Appendix G: Symbol Reference

XA_CUT_BUFFERO XA_CUT_BUFFER1 XA_CUT_BUFFER2 XA_CUT_BUFFER3 XA_CUT_BUFFER4 XA_CUT_BUFFER5 XA_CUT_BUFFER6 XA_CUT_BUFFER7 XA_DRAWABLE

XA_END_SPACE

XA_FAMILY_NAME

XA_FONT

XA_FONT_NAME XA_FULL_NAME XA_INTEGER

XA_ITALIC_ANGLE

XA_LAST_PREDEFINED

XA_MAX_SPACE

XA_MIN_SPACE

XA_NORM_SPACE

XA_NOTICE

XA_PIXMAP

XA_POINT

XA_POINT_SIZE

XA_PRIMARY

XA_QUAD_WIDTH XA_RECTANGLE XA_RESOLUTION XA_RESOURCE MANAGER

Represents a predefined cut buffer atom. Represents a predefined cut buffer atom. Represents a predefined cut buffer atom. Represents a predefined cut buffer atom. Represents a predefined cut buffer atom. Represents a predefined cut buffer atom. Represents a predefined cut buffer atom. Represents a predefined cut buffer atom.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertselection)

Specifies the additional spacing at the end of sentences. Predefined font atom.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertselection) Predefined font atom. Predefined font atom.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertselection)

Specifies the angle of the dominant staffs of characters in the font

Predefined font atom. Specifies the maximum interword spacing. Specifies the minimum interword spacing. Specifies the normal interword spacing. Predefined font atom.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertselection) Specifies the atom of the type property that specifies the desired format for the data, (xconvertselection) Specifies the point size of this font at the ideal resolution expressed in tenths of a point.

Specifies the primary built-in selection atom used in transfer ring data between clients.

"1 em" as in TeX but expressed in units of pixels. The width of an m in the current font and point size. Specifies the atom of the type property that specifies the desired format for the data, (xconvertselection)

i per point at which this font was

Specifies a predefined resource manager property containing default values for user preferences.

686

Xlib Reference Manual

Specifies a predefined colormap atom that defines the "best" RGB colormap available on the display.

Specifies a predefined colormap atom that defines an all-blue

colormap.

Specifies the atom of the type property that specifies the

desired format for the data, (xconvertseiection)

Specifies a predefined colormap atom that defines part of the system default colormap.

Specifies a predefined colormap atom that defines the "best" gray-scale colormap available on the display.

Specifies a predefined colormap atom that defines an all-green

colormap.

Specifies a predefined colormap atom that defines an all-red

colormap.

Specifies the secondary built-in selection atom used in transferring data between clients.

Specifies the vertical extents (in pixels) for boxing or voiding

characters.

Specifies the vertical extents (in pixels) for boxing or voiding

characters.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

XA_SUBSCRIPT_X Specifies the X offset (in pixels) from the character origin

where subscripts should begin.

XA_SUBSCRIPT_Y Specifies the Y offset (in pixels) from the character origin

where subscripts should begin.

XA_SUPERSCRIPT_X Specifies the X offset (in pixels) from the character origin

where superscripts should begin.

XA_SUPERSCRIPT_Y Specifies the Y offset (in pixels) from the character origin

where superscripts should begin.

XA_UNDERLINE_POSITION Specifies the Y offset (in pixels) from the baseline to the top of the underline.

XA_UNDERLINE_THICKNESS Specifies the thickness (in pixels) from the baseline to the top of the underline.

XA RGB BEST MAP

XA RGB BLUE MAP

XA RGB COLOR MAP

XA RGB DEFAULT MAP

XA RGB GRAY MAP

XA RGB GREEN MAP

XA RGB RED MAP

XA SECONDARY

XA STRIKEOUT ASCENT

XA STRIKEOUT DESCENT

XA STRING

XA VISUALID

XA WEIGHT

XA WINDOW

XA WM CLASS

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

Specifies the weight or boldness of the font, expressed as a value between 0 and 1000.

Specifies the atom of the type property that specifies the desired format for the data, (xconvertseiection)

The XA_WM_CLASS property is a string containing two null-separated elements, res_class and res_name, that are meant to be used by clients both as a means of permanent iden tification and as the handles by which both the client and the window manager obtain resources related to the window.

Appendix G: Symbol Reference

XA_WM_CLIENT_MACHINE

XA_WM_COMMAND XA_WM_HINTS

XA_WM_ICON_NAME

XA_WM_ICON_SIZE XA_WM_NAME

XA_WM_NORMAL_HINTS

XA_WM_SIZE_HINTS XA_WM_TRANSIENT_FOR

XA_WM_ZOOM_HINTS

XA_X_HEIGHT

XCNOENT

XCNOMEM

XCSUCCESS

XK_*

XNegative

XValue XYBitmap

XYPixmap X_PROTOCOL X_PROTOCOL REVISION

The XA_WM_CLIENT_MACHINE property is a string forming the name of the machine running the client, as seen from the machine running the server.

The XA_WM_COMMAND property stores the shell command and arguments used to invoke the application.

The XA_WM_HINTS property contains hints stored by the win dow manager that provide a means of communicating optional information from the client to the window manager.

The XA_WM_ICON_NAME property is an uninterpreted string that the client wishes displayed in association with the window when it is iconified (for example, in an icon label).

The window manager may set the XA_WM_ICON_SIZE prop erty on the root window to specify the icon sizes it allows.

The XA_WM_NAME property is an uninterpreted string that the client wishes displayed in association with the window (for example, a window headline bar).

The XA_WM_NORMAL_HINTS property is an XSizeHints

structure describing the desired position and range of sizes that are preferable for each top-level window in normal state. The XA_WM_SIZE_HINTS property contains hints stored..

The XA_WM_TRANSIENT_FOR property is the ID of another top-level window.

The XA_WM_ZOOM_HINTS property is an XSizeHints struc ture describing the desired position and range of sizes that are preferable for each top-level window in a zoomed state.

"1 ex" as in TeX but expressed in units of pixels, often the height of lower case x.

Association table lookup return codes, No entry in table.

Association table lookup return codes, Out of memory.

Association table lookup return codes, No error.

Keysyms, see Appendix H, Keysym Reference.

Represents a user-specified negative X offset in the standard

window geometry string. (XParseGeometry)

Represents a user-specified positive X offset in the standard

window geometry string. (XParseGeometry)

XYBitmap specified the format for an image. The data for an mage is said to be in XYBitmap format if the bitmap is repre-ented in scan line order, with each scan line made up of multi ples of the bitma P _unit and padded with meaningless bits

(XGetlmage,XPutlmage)

Depth = drawable depth. (XGetlmage, XPutImage)

Current protocol version.

Current minor revision.

688

Xlib Reference Manual

YZ

YNegative YSorted YValue YXBanded

YXSorted

ZoomState ZPixmap

Represents a user-specified negative Y offset in the standard window geometry String. (XParseGeometry)

Specifies that rectangles specified for a particular GC are non-decreasing in their Y origin. (XSetClipRectangles)

Represents a user-specified positive Y offset in the standard window geometry String. (XParseGeometry)

Specifies that, in addition to the constraints of YXS or ted, for every possible horizontal Y scan line, all rectangles that include that scan line have identical Y origins and X extents. (XSetClipRectangles)

Specifies that rectangles specified for a particular GC are non-decreasing in their Y origin and that all rectangles with an equal Y origin are nondecreasing in their X origin. (XSet ClipRectangles)

Indicates that the client wants to be in zoomed state when the top-level window is mapped. Obsolete in R4. (Value for ini-

tial_state member of XWMHints.)

Depth = drawable depth. (XGet Image, XPut Image)

Appendix G: Symbol Reference

H

Keysyms

This appendix provides a list of keysyms and a brief description of each keysym. Keysyms, as you may remember, are the portable representation of the symbols on the caps of keys.

The normal way to process a keyboard event is to use XLookupKeysym to determine the keysym or, if the application allows remapping of keys to strings, it may use XLookup-String to get the ASCH string mapped to the key or keys pressed. This allows the applica tion to treat keys in a simple and portable manner, and places the responsibility of tailoring the mapping between keys and keysyms on the server vendor.*

Many keysyms do not have obvious counterparts on the keyboard, but may be generated with certain key combinations. You will need a table for each particular model of hardware you intend the program to work on, to tell you what key combination results in each keysym that is not present on the caps of the keyboard. For real portability, you will want to use only the keysyms that are supported on all vendors equipment you intend the program to be displayed on.

The keysyms are defined in two standard include files: <Xlllkeysym.h> and <Xlllkeysym-def.h>. There are several families of keysyms defined in <Xlllkeysymdef.h>; LATTN1, LATIN2, LATIN3, LATIN4, KATAKANA, ARABIC, CYRILLIC, GREEK, TECHNICAL, SPECIAL, PUBLISHING, APL, HEBREW, and MISCELLANY. The <Xlllkeysym.h> file specifies which families are enabled. Only the LATESfl, LATIN2, LATINS, LATIN4, GREEK, and MISCELLANY families are enabled in the standard <Xlllkeysym.h> file, proba bly because some compilers have an upper limit on the number of defined symbols that are allowed.

The developers of X at MIT say that to the best of their knowledge the Latin, Kana, Arabic, Cyrillic, Greek, Technical, APL, and Hebrew keysym sets are from the appropriate ISO (International Standards Organization) and/or ECMA international standards. There are no Technical, Special nor Publishing international standards, so these sets are based on Digital Equipment Corporation standards.

* While keycode information is not necessary for normal application programming, it may be necessary for writing certain programs that change the keycode to keysym mapping. If you are writing such an application, you will need to obtain a list of keycodes and their normal mappings from the system manufacturer. Any program lhat uses this mapping is not fully portable.

Keysyms are four byte long values. In the standard keysyms, the least significant 8 bits indi cate a particular character within a set and the next 8 bits indicate a particular keysym set The order of the sets is important since not all the sets are complete. Each character set con tains gaps where codes have been removed that were duplicates with codes in previous (that is, with lesser keysym set) character sets.

The 94 and 96 character code sets have been moved to occupy the right hand quadrant (deci mal 129 - 256), so the ASCH subset has a unique encoding across the least significant byte which corresponds to the ASCII character code. However, this cannot be guaranteed in the keysym sets of future releases and does not apply to all of the MISCELLANY set

As far as possible, keysym codes are the same as the character code. In the LATIN1 to LATIN4 sets, all duplicate glyphs occupy the same position. However, duplicates between GREEK and TECHNICAL do not occupy the same code position. Thus, applications wishing to use the TECHNICAL character set must transform the keysym using an array.

The MISCELLANY set is a miscellaneous collection of commonly occurring keys on key boards. Within this set, the keypad symbols are generally duplicates of symbols found on keys on the alphanumeric part of the keyboard but are distinguished here because they often have distinguishable keycodes associated with them.

There is a difference between European and US usage of the names Pilcrow, Paragraph, and Section, as shown in Table H-l.

Table H-1. European vs. US usage of Pilcrow, Paragraph, and Section symbol names

X has adopted the names used by both the ISO and ECMA standards. Thus, XK_j>ara-graph is what Europeans call the pilcrow sign, and XK_section is what they would call the paragraph sign. This favors the US usage.

H.1 Keysyms and Description

Tables H-2 through H-7 list the six commonly available sets of keysyms (MISCELLANY, LATIN1 through LATIN4, and GREEK) and describe each keysym briefly. When necessary and possible, these tables show a representative character or characters that might appear on the cap of the key or on the screen when the key or keys corresponding to the keysym were typed.

Table H-2. MISCELLANY

Keysym

Description

XK_BackSpace

XK_Tab

XK_Linefeed

XK_Clear

XK_Return

XK_Pause

XK_Escape

XK_Delete

XK_Multi_key

XK_Kanji

XK_Home

XK_Left

XK_Up

XK_Right

XK_Down

XK_Prior

XK_Next

XK_End

XK_Begin

XK_Select

XK_Print

XK_Execute

XK_Insert

XK_Undo

XK_Redo

XK_Menu

XK_Find

XK_Cancel

XK_Help

XK_Break

XK_Mode_switch

XK_script_switch

XK_Num_Lock

XK_KP_Space

XK_KP_Tab

XK_KP_Enter

XK_KP_F1

XK_KP_F2

XK_KP_F3

XK_KP_F4

XK_KP_Equal

XK_KP_Multiply

XK KP Add

Backspace, Back Space, Back Char

Tab

Linefeed, LF

Clear

Return, Enter

Pause, Hold, Scroll Lock

Escape

Delete, Rubout

Multi-key character preface

Kanji, Kanji convert

Home

Left, move left, left arrow

Up, move up, up arrow

Right, move right, right arrow

Down, move down, down arrow

Prior, previous

Next

End,EOL

Begin, BOL

Select, mark

Print

Execute, run, do

Insert, insert here

Undo, oops

Redo, again

Menu

Find, search

Cancel, stop, abort, exit

Help, question mark

Break

Mode switch, script switch,

character set switch

Alias for mode switch, script switch,

character set switch

NumLock

Keypad Space

Keypad Tab

Keypad Enter

Keypad F1.PF1, a

Keypad F2,PF2,b

Keypad F3,PF3,c

Keypad F4, PF4, d

Keypad equals sign

Keypad multiplication sign, asterisk

Keypad plus sign

Appendix H: Keysyms

Table H-2. MISCELLANY (continued)

Keysym

Description

XK_KP_Separator

XK_KP_Subtract

XK_KP_Decimal

XK_KP_Divide

XK_KP_0

XK_KP_1

XK_KP_2

XK_KP_3

XK_KP_4

XK_KP_5

XK_KP_6

XK_KP_7

XK_KP_8

XK_KP_9

XK_F1

XK_F2

XK_F3

XK_F4

XK_F5

XK_F6

XK_F7

XK_F8

XK_F9

XK_F10

XK_F11

XK_L1

XK_F12

XK_L2

XK_F13

XK_L3

XK_F14

XK_L4

XK_F15

XK_L5

XK_F16

XK_L6

XK_F17

XK_L7

XK_F18

XK_L8

XK_F19

XK_L9

XK_F20

XK_L10

XK F21

Keypad separator, comma

Keypad minus sign, hyphen

Keypad decimal point, full stop

Keypad division sign, solidus

Keypad digit zero

Keypad digit one

Keypad digit two

Keypad digit three

Keypad digit four

Keypad digit five

Keypad digit six

Keypad digit seven

Keypad digit eight

Keypad digit nine

Fl function key

F2 function key

F3 function key

F4 function key

F5 function key

F6 function key

F7 function key

F8 function key

F9 function key

F10 function key

Fll function key

LI function key

F12 function key

L2 function key

F13 function key

L3 function key

F14 function key

L4 function key

F15 function key

L5 function key

F16 function key

L6 function key

F17 function key

L7 function key

F18 function key

L8 function key

F19 function key

L9 function key

F20 function key

L10 function key

F21 function key

694

Xlib Reference Manual

Table H-2. MISCELLANY (continued)

Appendix H: Keysyms

Table H-3. LATIN1

696

Xlib Reference Manual

Table H-3. LATIN1 (continued)

Appendix H: Keysyms

Table H-3. LATIN1 (continued)

698

Xlib Reference Manual

Table H-3. LATIN1 (continued)

Keysym

Description

Character

XK_plusminus

XK_twosuperior

XK_threesuperior

XK_acute

XK_mu

XK_paragraph

XK_periodcentered

XK_cedilla

XK_onesuperior

XK_masculine

XK_gu illemotright

XK_onequarter

XK_onehalf

XK_threequarters

XK_questiondown

XK_Agrave

XK_Aacute

XK_Acircumflex

XK_Atilde

XK_Adiaeresis

XK_Aring

XK_AE

XK_Ccedilla

XK_Egrave

XK_Eacute

XK_Ecircumflex

XK_Ediaeresis

XK_Igrave

XK_Iacute

XK_Icircumflex

XK_Idiaeresis

XK_Eth

XK_Ntilde

XK_Ograve

XK_Oacute

XK_Ocircumflex

XK_Otilde

XK Odiaeresis

Plus-minus sign

Superscript two

Superscript three

Acute accent

Micro sign

Pilcrow sign

Middle dot

Cedilla

Superscript one

Masculine ordinal indicator

Right angle quotation mark

Vulgar fraction one quarter

Vulgar fraction one half

Vulgar fraction three quarters

Inverted question mark

Latin capital A with grave accent

Latin capital A with acute accent

Latin capital A with circumflex accent

Latin capital A with tilde

Latin capital A with diaeresis

Latin capital A with ring above

Latin capital diphthong AE

Latin capital C with cedilla

Latin capital E with grave accent

Latin capital E with acute accent

Latin capital E with circumflex accent

Latin capital E with diaeresis

Latin capital I with grave accent

Latin capital I with acute accent

Latin capital I with circumflex accent

Latin capital I with diaeresis

Icelandic capital ETH

Latin capital N with tilde

Latin capital O with grave accent

Latin capital O with acute accent

Latin capital O with circumflex accent

Latin capital O with tilde

Latin capital O with diaeresis

A A

A A A

A JE

C

E E E E I I I I

N

6 6 6 6 6

Appendix H: Keysyms

Table H-3. LATIN1 (continued)

700

Xlib Reference Manual

Table H-3. LATIN1 (continued)

Appendix H: Keysyms

Table H-4. LATIN2

702

Xlib Reference Manual

Table H-4. LATIN2 (continued)

Appendix H: Keysyms

Table H-5. LATINS

704

Xlib Reference Manual

Table H-6. LATIN4

Appendix H: Keysyms

Table H-7. GREEK

Keysym

Description

Character

XK_Greek_ALPHAaccent

XK_Greek_EPSILONaccent

XK_Greek_ETAaccent

XK_Greek_IOTAaccent

XK_Greek_IOTAdiaeresis

XK_Greek_IOTAaccentdiaeresis

XK_Greek_OMICRONaccent

XK_Greek_UPSILONaccent

XK_Greek_UPSILONdieresis

XK_Greek_UPSILONaccentdieresis

XK_Greek_OMEGAaccent

XK_Greek_alphaaccent

XK_Greek_epsilonaccent

XK_Greek_etaaccent

XK_Greek_iotaaccent

XK_Greek_iotadieresis

XK_Greek_iotaaccentdieresis

XK_Greek_omicronaccent

XK_Greek_upsilonaccent

XK_Greek_upsilondieresis

XK_Greek_upsilonaccentdieresis

XK_Greek_omegaaccent

XK_Greek_ALPHA

XK_Greek_BETA

XK_Greek_GAMMA

XK_Greek_DELTA

XK_Greek_EPSILON

XK_Greek_ZETA

XK_Greek_ETA

XK_Greek_THETA

XK_Greek_IOTA

XK_Greek_KAPPA

XK_Greek_LAMBDA

XK_Greek_MU

XK_Greek_NU

XK_Greek_XI

XK_Greek_OMICRON

XK Greek PI

Greek capital alpha with accent

Greek capital epsilon with accent

Greek capital eta with accent

Greek capital iota with accent

Greek capital iota with diaeresis

Greek capital iota with accent+dieresis

Greek capital omicron with accent

Greek capital upsilon with accent

Greek capital upsilon with dieresis

Greek capital upsilon with accent-i-dieresis

Greek capital omega with accent

Greek small alpha with accent

Greek small epsilon with accent

Greek small eta with accent

Greek small iota with accent

Greek small iota with dieresis

Greek small iota with accent+dieresis

Greek small omicron with accent

Greek small upsilon with accent

Greek small upsilon with dieresis

Greek small upsilon with accent+dieresis

Greek small omega with accent

Greek capital alpha

Greek capital beta

Greek capital gamma

Greek capital delta

Greek capital epsilon

Greek capital zeta

Greek capital eta

Greek capital theta

Greek capital iota

Greek capital kappa

Greek capital lambda

Greek capital mu

Greek capital nu

Greek capital xi

Greek capital omicron

Greek capital pi

706

Xlib Reference Manual

Table H-7. GREEK (continued)

Appendix H: Keysyms

The Cursor Font

A standard font consisting of a number of cursor shapes is available. This font is loaded automatically when XCreateFontCursor, the routine used to create a standard cursor, is called. To specify a cursor shape from the standard font, use one of the symbols defined in the file <Xll/cursorfont.h>, by including it in your source code. The symbols for the avail able cursors and an illustration of their shapes is provided here. The technique used for creating a cursor is described in Volume One, Section 6.6.

You may notice that the symbol values skip the odd numbers; there are really two font char acters for each shape but we are only showing you one. Each odd-numbered character (not shown) is a mask that selects which pixels in the screen around the cursor are modified.

The standard cursor shapes are shown in Figure 1-1. The mask shapes have been removed. Each row in Figure 1-1 contains twelve cursor shapes (except the last one). Table 1-1 shows the symbol definitions from <Xlllcursorfont.h> grouped by rows corresponding to the rows in Figure I-1.

JH

t*

*

m

V

m

*

4

¥?

r

F

T

Figure 1-1. The Standard Cursors

Appendix I: The Cursor Font

709

Table 1-1. Standard Cursor Symbols

770

Xlib Reference Manual

J

The Xmu Library

The Xmu Library is a collection of miscellaneous utility functions that have been useful in building various applications and Xt toolkit widgets. Though not defined by any X consor tium standard, this library is written and supported by MIT in the core distribution, and there fore should be available on virtually all machines.

This appendix presents reference pages for each Xmu function available in R4. For a sum mary of the contents of Xmu, see Volume One, Appendix H, The Xmu Library. For a list of which functions are available in R3, see Volume One, Appendix G, Release Notes. At each release the number and variety of functions in this library has increased dramatically. It is worthwhile skimming this appendix to see what is available in R4, even if you are familiar with the R3 Xmu library.

Each group of Xmu functions designed around a particular task has its own header file, listed in the Synopsis section of each reference page. Note that the location of the header files of Xmu has changed in R4. In R3 and earlier, the header files for all X libraries were stored in lusrlincludelXll. In R4, the header files for Xmu and Xaw are located in subdirectories of this directory, named after each library. In other words, the Xmu header files are now located (by default, on UNIX-based systems) in lusrlincludelXllIXmu.

ACtCreat8 v__xmu - Compound Text Functions—-

Name

XctCreate — create a XctData structure for parsing a Compound Text string.

Synopsis

#include <Xll/Xmu/Xct.h>

XctData XctCreate (string, length, flags)

XctString string;

int length;

XctFlags flags;

Arguments

string Specifies the Compound Text string.

length Specifies the number of bytes in string.

flags Specifies parsing control flags.

Description

XctCreate creates an XctData structure for parsing a Compound Text string. The string need not be null terminated. The following flags are defined to control parsing of the string:

XctSingleSetSegments

This means that returned segments should contain characters from only one set (CO, Cl, GL, GR). When this is requested, XctSegment is never returned by XctNextltem, instead XctCOSegment, XctClSegment, XctGlSegment, and XctGRSegment are returned. CO and Cl segments are always returned as singleton characters.

XctProvideExtensions

This means that if the Compound Text string is from a higher version than this code is implemented to, then syntactically correct but unknown control sequences should be returned as Xct Ext ens ion items by XctNextltem. If this flag is not set, and the Compound Text string version indicates that extensions cannot be ignored, then each unknown control sequence will be reported asanXctError.

XctAcceptCOExtensions

This means that if the Compound Text string is from a higher version than this code is implemented to, then unknown CO characters should be treated as if they were legal, and returned as CO characters (regardless of how XctProvideExtensions is set) by Xct Nextltem. If this flag is not set, then all unknown CO characters are treated according to XctProvideExtensions.

XctAcceptClExtensions

This means that if the Compound Text string is from a higher version than this code is implemented to, then unknown Cl characters should be treated as if they were legal, and returned as Cl characters (regardless of how XctProvideExtensions is set) by Xct Nextltem. If this flag is not set, then all unknown Cl characters are treated according to XctProvideExtensions.

Xmu - Compound Text Functions (continued) XctCreate

XctHideDirection

This means that horizontal direction changes should be reported as XctHorizontal items by XctNext item. If this flag is not set, then direction changes are not returned as items, but the current direction is still maintained and reported for other items. The current direction is given as an enumeration, with the values XctUnspecifled, XctLeft-ToRight, and XctRightToLef t.

XctFreeString

This means that XctFree should free the Compound Text string that is passed to Xct Create. If this flag is not set, the string is not freed.

XctShiftMultiGRToGL

This means that XctNextltem should translate GR segments on-the-fly into GL seg ments for the GR sets: GB2312.1980-1, JISX0208.1983-1, and KSC5601.1987-1.

Related Commands

XctFree,XctNextltem, XctReset.

XctFree

" -Xmu - Compound Text Functions—

Name

XctFree — free an XctData structure.

Synopsis

#include <Xll/Xmu/Xct.h> void XctFree(data) XctData data;

Arguments

da t a Specifies the Compound Text structure.

Description

XctFree frees all data associated with the XctData structure.

Related Commands

XctNextltem, XctReset.

J XctNextltem

—Xmu - Compound Text Functions— '

Name

XctNextltem — parse the next item in a Compound Text string.

Synopsis

tinclude <Xll/Xmu/Xct.h> XctResult XctNextltem(data) XctData data;

Arguments

data Specifies the Compound Text structure.

Description

XctNextltem parses the next item in the Compound Text string. The return value indicates what kind of item is returned. The item itself, it's length, and the current contextual state, are reported as components of the XctData structure. XctResult is an enumeration, with the following values:

XctSegment

The item contains some mixture of CO, GL, GR, and Cl characters.

XctCOSegment

The item contains only CO characters.

XctGLSegment

The item contains only GL characters.

XctClSegment

the item contains only Cl characters.

XctGRSegment

the item contains only GR characters.

XctExtendedSegment

The item contains an extended segment.

XctExtension

The item is an unknown extension control sequence.

XctHorizontal

The item indicates a change in horizontal direction or depth. The new direction and depth are recorded in the XctData structure.

XctEndOfText

The end of the Compound Text string has been reached.

XctError

The string contains a syntactic or semantic error; no further parsing should be performed.

Structures

typedef struct {

XctString item; /* the action item */

XctNextltem

(continued)

Xmu - Compound Text Functions

int item_length; int char_size;

char *encoding;

XctHDirection horizontal,

int horz_depth;

char *GL;

char *GL_encoding;

int GL_set_size;

int GL_char_size;

char *GR;

char *GR_encoding;

int GR_set_size;

int GR_char_size;

char *GLGR_encoding;

/* the length of item in bytes */

/* the number of bytes per character in

* item, with zero meaning variable */ /* the XLFD encoding name for item */ /* the direction of item */

/* the current direction nesting depth */

/* the "{1} F" string for the current GL */

/* the XLFD encoding name for the current GL

/* 94 or 96 */

/* the number of bytes per GL character */

/* the "{1} F" string for the current GR */

/* the XLFD encoding name the for current GR

/* 94 or 96 */

/* the number of bytes per GR character */

/* the XLFD encoding name for the current

* GL+GR, if known */

} XctData;

Related Commands

XctCreate,XctFree, XctReset.

716

Xlib Reference Manual

—Xmu - Compound Text Functions

J XctReset

Name

XctReset — reset an XctData structure for reparsing a Compound Text string.

Synopsis

tfinclude <Xll/Xmu/Xct.h> void XctReset(data) XctData data;

Arguments

data Specifies the Compound Text structure.

Description

XctReset resets the XctData structure to reparse the Compound Text string from the begin ning.

Related Commands

XctCreate,XctFree, XctNextItern.

XmuAddCloseDisplayHook

•Xmu - CloseDisplay Hook—

Name

XmuAddCloseDisplayHook — add callback function to be called when display connection is closed.

Synopsis

tinclude <Xll/Xmu/CloseHook.h>

CloseHook XmuAddCloseDisplayHook(display, func, arg)

Display * display;

int (*func) () ;

caddr_t arg;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

func Specifies the function to call at display close.

arg Specifies arbitrary data to pass to func.

Description

XmuAddCloseDisplayHook registers a callback for the given display. When the display is closed, the given function will be called with the given display and argument as:

(*func)(display, arg)

The function is declared to return int even though the value is ignored, because some com pilers have problems with functions returning void.

This routine returns NULL if it was unable to add the callback, otherwise it returns an opaque handle that can be used to remove or lookup the callback.

Related Commands

XmuAddCloseDisplayHook, XmuLookupCloseDisplayHook, XmuRemoveClose-DisplayHook.

—Xmu - Standard Colormaps '

Name

XmuAIIStandardColormaps — create all supported standard colormaps and set standard color-map properties.

Synopsis

#include <Xll/Xmu/StdCmap.h> Status XmuAIIStandardColormaps (display) Display * display;

Arguments

display Specifies a connection to an X server; returned from XQpenDisplay.

Description

XmuAIIStandardColormaps creates all of the appropriate standard colormaps for every visual of every screen on a given display.

XmuAIIStandardColormaps defines and retains as permanent resources all these standard colormaps. It returns zero on failure, non-zero on success. If the property of any standard colormap is already defined, this function will redefine it.

This function is intended to be used by window managers or a special client at the start of a ses sion.

The standard colormaps of a screen are defined by properties associated with the screen's root window. The property names of standard colormaps are predefined, and each property name except RGB_DEFAULT_MAP may describe at most one colormap.

The standard colormaps are: RGB_BEST_MAP, RGB_RED_MAP, RGB_GREEN_MAP, RGB_BLUE_MAP, RGB_DEFAULT_MAP, and RGB_GRAY_MAP. Therefore a screen may have at most 6 standard colormap properties defined.

A standard colormap is associated with a particular visual of the screen. A screen may have multiple visuals defined, including visuals of the same class at different depths. Note that a visual ID might be repeated for more than one depth, so the visual ID and the depth of a visual identify the visual. The characteristics of the visual will determine which standard colormaps are meaningful under that visual, and will determine how the standard colormap is defined. Because a standard colormap is associated with a specific visual, there must be a method of determining which visuals take precedence in defining standard colormaps.

The method used here is: for the visual of greatest depth, define all standard colormaps mean ingful to that visual class, according to this order of (descending) precedence: DirectColor;

Pseudocolor; TrueColor; and Grayscale; and finally StaticColor and Static-Gray.

This function allows success on a per screen basis. For example, if a map on screen 1 fails, the maps on screen 0, created earlier, will remain. However, none on screen 1 will remain. If a map on screen 0 fails, none will remain.

Xlib Reference Manual 719

XmuAllStandardColormaps (continued) Xmu - Standard Colormaps

Related Commands

XmuCreateColormap, XmuDeleteStandardColormap, XmuGetColormap-Allocation, XmuLookupStdCmp, XmuStandardColormap, XmuVisualStandard-Colormaps.

Xlib Reference Manual

XmuClientWindow

—Xmu -Window Utility Functions-Name

XmuClientWindow — find a window which has a WM_STATE property.

Synopsis

^include <Xll/Xmu/WinUtil.h>

Window XmuClientWindow (display, win)

Display *display;

Window win;

Arguments

display Specifies a connection to an X server; returned from XQpenDisplay.

win Specifies the window.

Description

XmuClientWindow finds a window, at or below the specified window, which

WM STATE property. If such a window is found, it is returned, otherwise the argument window

is returned.

Related Commands

XmuScreenOfWindow,XmuUpdateMapHints.

XmuComparelSOLatinl

•Xmu - Character Set Functions-

Name

XmuComparelSOLatinl — compare and determine order of two strings, ignoring case.

Synopsis

#include <Xll/Xmu/CharSet.h> int XmuComparelSOLatinl (first, second) char * first f * second;

Arguments

fi rst Specifies a string to compare.

second Specifies a string to compare.

Description

XmuComparelSOLatinl compares two NULL terminated Latin-1 strings, ignoring case dif ferences, and returns an integer greater than, equal to, or less than zero, according to whether first is lexicographically greater than, equal to, or less than second. The two strings are assumed to be encoded using ISO 8859-1 (Latin-1).

Related Commands

XmuCopylSOLatinlLowered,XmuCopylSOLatinlUppered,XmuLookup.

79?

Xlib Reference Manual

/ XmuCopylSOLatim Lowered

—Xmu - Character Set Functions '

Name

XmuCopylSOLatinlLowered — copy string, changing upper case to lower case.

Synopsis

^include <Xll/Xmu/CharSet.h> void XmuCopylSOLatinlLowered (dst, src) char *o!st, *src;

Arguments

dst Returns the string copy.

src

Specifies the string to copy.

Description

XmuCopylSOLatinlLowered copies a null terminated string from src to dst

the NULL), changing all Latin-1 upper-case letters to lower-case. The string is assumed to be

encoded using ISO 8859-1 (Latin-1).

Related Commands

XmuComparelSOLatinl,XmuCopylSOLatinlUppered, XmuLookup.

XmuCopylSOLatinl Uppered

•Xmu - Character Set Functions—

Name

XmuCopylSOLatinlUppered — copy string, changing lower case to upper case.

Synopsis

#include <Xll/Xmu/CharSet.h> void XmuCopylSOLatinlUppered (dst f src) char *dst, *src;

Arguments

dst Returns the string copy.

src Specifies the string to copy.

Description

XmuCopylSOLatinlUppered copies a null terminated string from src to dst (including the NULL), changing all Latin-1 lower-case letters to upper-case. The string is assumed to be encoded using ISO 8859-1 (Latin-1).

Related Commands

XmuComparelSOLatinl,XmuCopylSOLatinlLowered,XmuLookup.

724

Xlib Reference Manual

. XmuCreateColormap

—Xmu - Standard Colormaps '

Name

XmuCreateColormap — create a standard colormap from information in an XStandard-Colormap structure.

Synopsis

#include <Xll/Xmu/StdCmap.h>

Status XmuCreateColormap(display, colormap)

Display * display;

XStandardColormap * colormap;

Arguments

display Specifies the connection under which the map is created.

col ormap Specifies the map to be created.

Description

XmuCreateColormap creates any one colormap which is described by an XStandard Colormap structure.

XmuCreateColormap returns zero on failure, and non-zero on success. The base_pixel field of the XStandardColormap structure is set on success. Resources created by this function are not made permanent. No argument error checking is provided; use at your own risk.

All colormaps are created with read-only allocations, with the exception of read-only alloca tions of colors which fail to return the expected pixel value, and these are individually defined as read/write allocations. This is done so that all the cells defined in the colormap are contigu ous, for use in image processing. This typically happens with White and Black in the default map.

Colormaps of static visuals are considered to be successfully created if the map of the static visual matches the definition given in the standard colormap structure.

Related Commands

XmuAllStandardColormaps, XmuDeleteStandardColormap, XmuGet-ColormapAllocation,XmuLookupStdCmp, XmuStandardColormap,XmuVisual-StandardColormaps.

XmuCreatePixmapFromBitmap \ Xmu _ Graphics Functions _

Name

XmuCreatePixmapFromBitmap — create multi-plane pixmap and copy data from one-plane

pixmap.

Synopsis

#include <Xll/Xmu/Drawing.h>

Pixmap XmuCreatePixmapFromBitmap (display, d, bitmap, width, height, depth, fore, back)

Display * display;

Drawable d;

Pixmap bitmap;

unsigned int width, height;

unsigned int depth;

unsigned long fore, back;

Arguments

di spl ay Specifies a connection to an X server; returned from XOpenD isp 1 ay.

d Specifies the screen the pixmap is created on.

bi tmap Specifies the bitmap source.

wi dth Specifies the width of the pixmap.

height Specifies the height of the pixmap.

depth Specifies the depth of the pixmap.

fore Specifies the foreground pixel value.

back Specifies the background pixel value.

Description

XmuCreatePixmapFromBitmap creates a pixmap of the specified width, height, and depth, on the same screen as the specified drawable, and then performs an XCopyPlane from the specified bitmap to the pixmap, using the specified foreground and background pixel values. The created pixmap is returned. The original bitmap is not destroyed.

Related Commands

XmuCreateStippledPixmap, XmuDrawLogo, XmuDrawRoundedRectangle, Xmu-FillRoundedRectangle, XmuLocateBitmapFile, XmuReadBitmapData, Xmu-ReadBitmapDataFromFile,XmuReleaseStippledPixmap.

—Xmu - Graphics Functions-

XmuCreateStippledPixmap

Name

XmuCreateStippledPixmap — create two pixel by two pixel gray pixmap.

Synopsis

#include <Xll/Xmu/Drawing.h>

Pixmap XmuCreateStippledPixmap (screen

Screen * screen;

Pixel fore, back;

unsigned int depth;

fore, back, depth)

Arguments

screen fore back depth

Specifies the screen the pixmap is created on. Specifies the foreground pixel value. Specifies the background pixel value. Specifies the depth of the pixmap.

Description

XmuCreateStippledPixmap creates a two pixel by two pixel stippled pixmap of specified depth on the specified screen. The pixmap is cached so that multiple requests share the same pixmap. The pixmap should be freed with XmuReleaseStippledPixmap to maintain cor rect reference counts.

Related Commands

XmuCreatePixmapFromBitmap, XmuDrawLogo, XmuDrawRoundedRectangle, XmuFillRoundedRectangle, XmuLocateBitmapFile, XmuReadBitmapData, XmuReadBitmapDataFromFile,XmuReleaseStippledPixmap.

Xlib Reference Manual

_ Xmu - Cursor Utl.lty Functions-Name

XmuCursorNameToIndex — return index in cursor font given string name.

Synopsis

#include <Xll/Xmu/CurUtil.h> int XmuCursorNameToIndex (name) char *name;

Arguments

name Specifies the name of the cursor.

Description

XmuCursorNameToIndex takes the name of a standard cursor and returns its index in the standard cursor font The cursor names are formed by removing the xc_ prefix from the cur sor defines listed in Appendix I, The Cursor Font.

_T XmuDQAddDisplay

—Xmu - Display Queue Functions '

Name

XmuDQAddDisplay — add a display connection to a display queue.

Synopsis

#include <Xll/Xmu/DisplayQue.h>

XmuDisplayQueueEntry *XmuDQAddDisplay (q, display, data)

XmuDisplayQueue *g;

Display *display;

caddr_t data;

Arguments

q Specifies the queue.

display Specifies the display connection to add.

data Specifies private data for the free callback function.

Description

XmuDQAddDisplay adds the specified display to the queue. If successful, the queue entry is returned, otherwise NULL is returned. The data value is simply stored in the queue entry for use by the queue's free callback. This function does not attempt to prevent duplicate entries in the queue; the caller should use XmuDQLookupDisplay to determine if a display has already been added to a queue.

Related Commands

XmuDQCreate, XmuDQDestroy, XmuDQLookupDisplay, XmuDQNDisplays, Xmu-DQRemoveDisplay.

Name

XmuDQCreate — creates an empty display queue.

Synopsis

#include <Xll/Xmu/DisplayQue.h>

XmuDisplayQueue *XmuDQCreate (closefunc, freefunc, data)

int(* closefunc) () ;

int(* freefunc) ();

caddr_t data;

Arguments

closefunc Specifies the close function.

freefunc Specifies the free function.

data Specifies private data for the functions.

Description

XmuDQCreate creates and returns an empty XmuDisplayQueue (which is really just a set of displays, but is called a queue for historical reasons). The queue is initially empty, but dis plays can be added using XmuAddDisplay. The data value is simply stored in the queue for use by the display close and free callbacks. Whenever a display in the queue is closed using XCloseDisplay, the display close callback (if non-NULL) is called with the queue and the display's XmuDisplayQueueEntry as follows:

(*closefunc)(queue, entry)

The free callback (if non-NULL) is called whenever the last display in the queue is closed, as follows:

(*freefunc)(queue) The application is responsible for actually freeing the queue, by calling XmuDQDestroy.

Related Commands

XmuDQAddDisplay, XmuDQDestroy, XmuDQLookupDisplay, XmuDQNDisplays, XmuDQRemoveDisplay.

730

Xlib Reference Manual

/ XmuDQDestroy

—Xmu - Display Queue Functions '

Name

XmuDQDestroy — destroy a display queue, and optionally call callbacks.

Synopsis

tfinclude <Xll/Xmu/DisplayQue.h> Bool XmuDQDestroy (q, docallbacks)

XmuDisplayQueue *q;

Bool docallbacks;

Arguments

q Specifies the queue to destroy.

docallbacks Specifies whether the close callback functions should be called.

Description

XmuDQDestroy releases all memory associated with the specified queue. If docallbacks is True, then the queue's close callback (if non-NULL) is first called for each display in the queue, even though xcioseDisplay is not called on the display.

Related Commands

XmuDQAddDisplay, XmuDQCreate, XmuDQLookupDisplay, XmuDQNDisplays, XmuDQRemoveDisplay.

XmuDQLookupDisplay

•Xmu - Display Queue Functions-

Name

XmuDQLookupDisplay — determine display queue entry for specified display connection.

Synopsis

#include <Xll/Xmu/DisplayQue.h> XmuDisplayQueueEntry *XmuDQLookupDisplay (q, display)

XmuDisplayQueue *q;

Display *display;

Arguments

q Specifies the queue.

di spl ay Specifies the display to lookup.

Description

XmuDQLookupDisplay returns the queue entry for the specified display, or NULL if the dis play is not in the queue.

Related Commands

XmuDQAddDisplay, XmuDQCreate, XmuDQDestroy, XmuDQNDisplays, Xmu-DQRemoveDisplay.

Xlib Reference Manual

/ XmuDQNDisplays

—Xmu - Display Queue Functions ' *

Name

XmuDQNDisplays — return the number of display connections in a display queue.

Synopsis

#include <Xll/Xmu/DisplayQue.h> XmuDQNDisplays (q)

Description

XmuDQNDisplays returns the number of displays in the specified queue.

Related Commands

XmuDQAddDisplay,XmuDQCreate, XmuDQDestroy, XmuDQLookupDisplay, Xmu-DQRemoveDisplay.

XmuDQRemoveDisplay

Xmu - Display Queue Functions —

Name

XmuDQRemoveDisplay — remove a display connection from a display queue.

Synopsis

#include <Xll/Xmu/DisplayQue.h> Bool XmuDQRemoveDisplay (q, display)

XmuDisplayQueue *g;

Display ^display;

Arguments

g Specifies the queue.

di spl ay Specifies the display to remove.

Description

XmuDQNDisplays removes the specified display connection from the specified queue. No callbacks are performed. If the display is not found in the queue, False is returned, otherwise True is returned.

Related Commands

XmuDQAddDisplay, XmuDQCreate, XmuDQDestroy, XmuDQLookupDisplay, Xmu DQNDisplays.

—Xmu - Standard Colormaps-

XmuDeieteStandardColormap

Name

XmuDeleteStandardColormap — remove any standard colormap property.

Synopsis

void XmuDeleteStandardColormap ( display, screen, property) Display *display; int screen ; Atom property;

Arguments

display

scree/1 property

Specifies a connection to an X server; returned from XOpenDisplay. Specifies the screen of the display. Specifies the standard colormap property.

Description

XmuDeleteStandardColormap will remove the specified property from the specified screen, releasing any resources used by the colormap(s) of the property, if possible.

Related Commands

XmuAllStandardColormaps, XmuCreateColormap, XmuGetColormap-Allocation,XmuLookupStdCmp, XmuStandardColormap, XmuVisualStandard-Colormaps.

Xlib Reference Manual

XmuDrawLogo

•Xmu - Graphics Functions—

Name

XmuDrawLogo — draws the standard X logo.

Synopsis

#include <Xll/Xmu/Drawing.h>

XmuDrawLogo(display, drawable, gcFore, gcBack, x, y, width, height)

Display *display;

Drawable drawable;

GC grcFore, gcBack;

int x r y;

unsigned int width, height;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

dra wabl e Specifies the drawable.

gcFore Specifies the foreground GC.

gcBack Specifies the background GC.

x Specifies the upper left x coordinate,

y Specifies the upper left y coordinate.

width Specifies the logo width.

height Specifies the logo height

Description

XmuDrawLogo draws the "official" X Window System logo. The bounding box of the logo in the drawable is given by x, y, width, and height. The logo itself is filled using gcFore, and the rest of the rectangle is filled using gcBack.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDraw-RoundedRectangle, XmuFillRoundedRectangle, XmuLocateBitmapFile,Xmu-ReadBitmapData, XmuReadBitmapDataFromFile, XmuReleaseStippled-Pixmap.

Xlib Reference Manual

—Xmu - Graphics Functions-

XmuDrawRoundedRectangle

Name

XmuDrawRoundedRectangle — draws a rectangle with rounded corners.

Synopsis

#include <Xll/Xmu/Drawing.h>

void XmuDrawRoundedRectangle (display, draw, gc, x, y, w r h, ew f eh)

Display * display;

Drawable draw;

GC gc;

int x, y, w, h f ew, eh;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

draw Specifies the drawable.

gc Specifies the GC.

x Specifies the upper left x coordinate,

y Specifies the upper left y coordinate.

w Specifies the rectangle width.

h Specifies the rectangle height

ew Specifies the corner width.

eh Specifies the corner height

Description

XmuDrawRoundedRectangle draws a rounded rectangle, where x, y, w, h are the dimen sions of the overall rectangle, and ew and eh are the sizes of a bounding box that the corners are drawn inside of; ew should be no more than half of w, and eh should be no more than half of h. The current GC line attributes control all attributes of the line.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDrawLogo, XmuFillRoundedRectangle, XmuLocateBitmapFile, XmuReadBitmapData, XmuReadBitmapDataFromFile, XmuReleaseStippledPixmap.

Xlib Reference Manual

XmuFillRoundedRectangle

•Xmu - Graphics Functions—

Name

XmuFillRoundedRectangle — fill a rectangle with rounded corners.

Synopsis

#include <Xll/Xmu/Drawing.h>

void XmuFillRoundedRectangle (display, draw, gc, x, y, w, h, ew, eh)

Display *display;

Drawable draw;

GC gc;

int x, y, v, h, ew, eh;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

draw Specifies the drawable.

gc Specifies the GC.

x Specifies the upper left x coordinate,

y Specifies the upper left y coordinate.

w Specifies the rectangle width.

h Specifies the rectangle height

ew Specifies the corner width.

eh Specifies the corner height

Description

XmuFillRoundedRectangle draws a filled rounded rectangle, where x, y, w, h are the dimensions of the overall rectangle, and e w and eh are the sizes of a bounding box that the cor ners are drawn inside of; ew should be no more than half of w, and eh should be no more than half of h. The current GC fill settings control all attributes of the fill contents.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDrawLogo, XmuDrawRoundedRectangle, XmuLocateBitmapFile, XmuReadBitmapData, XmuReadBitmapDataFromFile.XmuReleaseStippledPixmap.

738

Xlib Reference Manual

— Xmu - Atom Functions

J XmuGetAtomName

Name

XmuGetAtomName — returns the property name string corresponding to the specified atom.

Synopsis

tinclude <X11/Xmu/Atoms.h> char * XmuGetAtomName ( d, atom)

Display *d;

Atom atom;

Arguments

d Specifies a connection to an X server; returned from XOpenDisplay.

a t om Specifies the atom whose name is desired.

Description

XmuGetAtomName returns the property name string corresponding to the specified atom. The result is cached, such that subsequent requests do not cause another round-trip to the server. If the atom is zero, XmuGetAtomName returns "(BadAtom)".

Related Commands

XmuInternAtom, XmuInternStrings, XmuMakeAtom, XmuNameof Atom.

XmuGetColormapAllocation

•Xmu - Standard Colormaps—

Name

XmuGetColormapAllocation — determine best allocation of reds, greens, and blues in a stan dard colormap.

Synopsis

^include <Xll/Xmu/StdCmap.h>

Status XmuGetColormapAllocation( vinfo, property, red_max, green_max, blue_max)

XVisuallnfo * vinfo;

Atom property;

unsigned long *red_max, *green_max f *blue_max;

Arguments

vinfo Specifies visual information for a chosen visual.

property Specifies one of the standard colormap property names.

red_max Returns maximum red value.

green_max Returns maximum green value.

bl ue_max Returns maximum blue value.

Description

XmuGetColormapAllocation determines the best allocation of reds, greens, and blues in a standard colormap.

XmuGetColormapAllocation returns zero on failure, non-zero on success. It is assumed that the visual is appropriate for the colormap property.

Related Commands

XmuAllStandardColormaps, XmuCreateColormap, XmuDeleteStandard-Colormap, XmuLookupStdCmp, XmuStandardColormap, XmuVisualStandard-Colormaps.

740

Xlib Reference Manual

-x™ -system u,i,,«y Functions^ XmuGetHostname

Name

XmuGetHostname — operating system independent routine to get machine name.

Synopsis

#include <Xll/Xmu/SysUtil.h> int XmuGetHostname (buf , maxlen)

char *buf;

int maxlen;

Arguments

buf Returns the host name.

maxl en Specifies the length of buf .

Description

XmuGetHostname stores the null terminated name of the local host in buf, and returns the length of the name. This function hides operating system differences, such as whether to call gethostname or uname.

Name

XmulnternAtom — get an atom from the server and load it into an AtomPt r.

Synopsis

Atom XmulnternAtom (d, atom_jptr) Display *d; AtomPtr atom_ptr;

Arguments

d Specifies a connection to an X server; returned from XOpenDisplay.

atom_ptr Specifies the AtomPtr.

Description

XmulnternAtom gets an atom from the server (for the string stored in AtomPtr) and stores the atom in the specified AtomPtr. The atom is cached such that subsequent requests do not cause another round-trip to the server.

Related Commands

XmuGetAtomName, XmuInternStrings, XmuMakeAtom, XmuNameof Atom.

742 Xlib Reference Manual

—Xmu - Atom Function

XmulnternStrings

Name

XmulnternStrings — get the atoms for several property name strings.

Synopsis

tfinclude <Xll/Xmu/Atoms.h> void XmulnternStrings (d, names ,

Display *d;

String * names;

Cardinal count;

Atom * atoms;

count r atoms)

Arguments

d

names count atoms

Specifies a connection to an X server; returned from XQpenDisplay. Specifies the strings to intern. Specifies the number of strings. Returns the list of Atoms value.

Description

XmulnternStrings converts a list of property name strings into a list of atoms, possibly by querying the server. The results are cached, such that subsequent requests do not cause further round-trips to the server. The caller is responsible for preallocating the array of atoms.

Related Commands

XmuGetAtomName, XmuInternAtom, XmuMakeAtom, XmuNameof Atom.

Xlib Reference Manual

Name

XmuLocateBitmapFUe — creates a one-plane pixmap from a bitmap file in a standard location. Synopsis

#include <Xll/Xmu/Drawing.h>

XmuLocateBitmapFile(screen, name, srcname, srcnamelen, widthp, heightp, xhotp, yhotp)

Screen * screen;

char *name;

char * srcname;

int srcnamelen;

int *widthp, *heightp, *xhotp, *yhotp;

Arguments

name Specifies the file to read from.

srcname Returns the full filename of the bitmap.

srcn amel en Specifies the length of the srcname buffer.

wi dth Returns the width of the bitmap.

height Returns the height of the bitmap.

xhotp Returns the x coordinate of the hotspot.

yhotp Returns the y coordinate of the hotspot.

Description

XmuLocateBitmapFile reads a file in standard bitmap file format, using XReadBitmap-File, and returns the created bitmap. The filename may be absolute, or relative to the global resource named bitmapFilePath with class BitmapFilePath. If the resource is not defined, the default value is the build symbol BITMAPDIR, which is typically lusrlindudelX11 /bitmaps. If srcnamelen is greater than zero and srcname is not NULL, the null terminated filename will be copied into srcname. The size and hotspot of the bitmap are also returned.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDrawLogo, XmuDrawRoundedRectangle, XmuFillRoundedRectangle, XmuReadBitmap-Data, XmuReadBitmapDataFromFile, XmuReleaseStippledPixmap.

Xlib Reference Manual

—Xmu - Character Set Functions-

XmuLookup*

Name

XmuLookup* — translate a key event into a keysym and string, using various keysym sets.

Synopsis

#include <Xll/Xmu/CharSet .h>

int XmuLookupLatinl (event , buffer, nbytes , keysym, status) int XmuLookupLatin2 (event , buffer, nbytes, keysym, status) int XmuLookupLatin3 (event, buffer, nbytes, keysym, status) int XmuLookupLatin4 (event , buffer, nbytes, keysym, status) int XmuLookupKana ( event , buffer, nbytes, keysym, status) int XmuLookup JISX02 01 (event , buffer, nbytes, keysym, status) int XmuLookupArabic (event , buffer, nbytes, keysym, status) int XmuLookupCyrillic ( eve/it , buffer, nbytes, keysym, status) int XmuLookupGreek ( event , buffer, nbytes, keysym, status) int XmuLookupHebrew ( event , buffer, nbytes, keysym, status) int XmuLookupAPL ( event , buffer, nbytes, keysym, status)

XKeyE vent * even t ;

char *buffer;

int nbytes;

KeySym * keysym;

XComposeStatus *status;

Arguments

event

buffer nbytes keysym status

Specifies the key event Returns the translated characters. Specifies the length of the buffer. Returns the computed KeySym, or None. Specifies or returns the compose state.

Description

These functions translate a key event into a keysym and string, using a keysym set other than Latin- 1, as shown in the following table.

Xlib Reference Manual

XmuLookup*

Function

(continued)

Xmu - Character Set Functions

XmuLookupLatinl

XmuLookupLat in2 XmuLookupLat in3 XmuLookupLatin4 XmuLookupKana

XmuLookupJISXO2 01

XmuLookupArabic

XmuLookupCyrillic

XmuLookupGreek

XmuLookupHebrew

XmuLookupAPL

Converts To

Latin-1 (ISO 8859-1), or ASCII control (Synonym

for XLookupString)

Latin-2 (ISO 8859-2), or ASCII control.

Latin-3 (ISO 8859-3), or ASCII control.

Latin-4 (ISO 8859^), or ASCII control.

Latin-1 (ISO 8859-1) and ASCII control in the

Graphics Left half (values 0 to 127), and Katakana

in the Graphics Right half (values 128 to 255), using

the values from JIS X201-1976.

JIS X0201-1976 encoding, including ASCII control.

Latin/Arabic (ISO 8859-6), or ASCII control.

Latin/Cyrillic (ISO 8859-5), or ASCII control.

Latin/Greek (ISO 8859-7), or ASCII control.

Latin/Hebrew (ISO 8859-8), or ASCII control string.

APL string

XmuLookupLatinl is identical to XLookupString, and exists only for naming symmetry with other functions covered on this page.

Related Commands

XmuComparelSOLatinl, XmuCopylSOLatinlLowered, XmuCopylSOLatinl-Uppered.

746

Xlib Reference Manual

—Xmu - CloseDisplay Hook-

XmuLookupCloseDisplayHook

Name

XmuLookupCloseDisplayHook — get currently registered close display callback function.

Synopsis

#include <Xll/Xmu/CloseHook.h>

Bool XmuLookupCloseDisplayHook( display, handle,

Display * display;

CloseHook handle;

int (*func) () ;

caddr t arg;

func, arg)

Arguments

isplay

handle

func

arg

Specifies a connection to an X server; returned from XOpenDisplay. Specifies the callback by ID, or NULL. Specifies the callback by function. Specifies the function data to match.

Description

XmuLookupCloseDisplayHook determines if a callback is registered. If handle is not NULL, it specifies the callback to look for, and the func and arg parameters are ignored. If handle is NULL, the function will look for any callback that matches the specified func and arg. This function returns True if a matching callback exists, or otherwise False.

Related Commands

XmuAddCloseDisplayHook,XmuRemoveCloseDisplayHook.

Xlib Reference Manual

Name

XmuLookupStandardColormap — create a standard colormap if not already created.

Synopsis

#include <Xll/Xmu/StdCmap.h>

XmuLookupStandardColormap(display, screen, visualid, depth, property, replace, retain)

Display *display;

int screen;

VisuallD visualid;

unsigned int depth;

Atom property;

Bool replace;

Bool retain;

Arguments

display Specifies a connection to an X server; returned from XQpenDisplay.

screen Specifies the screen of the display.

visualid Specifies the visual type.

depth Specifies the visual depth.

property Specifies the standard colormap property,

replace Specifies whether or not to replace,

retain Specifies whether or not to retain.

Description

XmuLookupStandardColormap creates a standard colormap if one does not currently exist, or replaces the currently existing standard colormap.

Given a screen, a visual, and a property, this function will determine the best allocation for the property under the specified visual, and determine whether to create a new colormap or to use the default colormap of the screen.

If replace is True, any previous definition of the property will be replaced. If retain is True, the property and the colormap will be made permanent for the duration of the server ses sion. However, pre-existing property definitions which are not replaced cannot be made perma nent by a call to this function; a request to retain resources pertains to newly created resources.

XmuLookupStandardColormap returns zero on failure, non-zero on success. A request to create a standard colormap upon a visual which cannot support such a map is considered a fail ure. An example of this would be requesting any standard colormap property on a mono chrome visual, or, requesting an RGB_BEST_MAP on a display whose colormap size is 16.

748 xiib Reference Manual

Xmu - Standard Colormaps

(continued) XmuLookupStandardColormap

Related Commands

XmuAllStandardColormaps, XmuCreateColormap, XmuDeleteStandard-Colormap, XmuGetColormapAllocation, XmuStandardColormap, XmuVisual-StandardColormaps.

Xlib Reference Manual

XmuMakeAtom V.

v Xmu - Atom Functions—

Name

XmuMakeAtom — create AtomPtr to hold atom list for a property name string.

Synopsis

#include <X1I/Xmu/Atoms.h> AtomPtr XmuMakeAtom (name) char* name;

Arguments

name Specifies the atom name.

Description

XmuMakeAtom creates and initializes an AtomPtr, which is an opaque object that contains a property name string and a list of atoms for that string—one for each display. Xmu Intern-Atom is used to fill in the atom for each display.

Related Commands

XmuGetAtomName, XmuInternAtom, XmuInternStrings, XmuNameof Atom.

750

Xlib Reference Manual

j XmuNameOfAtom

—Xmu - Atom Functions '

Name

XmuNameOfAtom — return property name string represented by an AtomPt r.

Synopsis

tinclude <X1I/Xmu/Atoms.h> char *XmuNameOfAtom(atom_jDtr) AtomPtr atom_ptr;

Arguments

atomjptr Specifies the AtomPtr.

Description

XmuNameOfAtom returns the property name string represented by the specified AtomPtr.

Related Commands

XmuGetAtomName, XmuInternAtom, XmuInternStrings, XmuMakeAtom.

XmuPrintDefaultErrorMessage \

•Xmu - Error Handler—

Name

XmuPrintDefaultErrorMessage — print the standard protocol error message.

Synopsis

#include <Xll/Xmu/Error.h>

int XmuPrintDefaultErrorMessage (display, event, fp)

Display *display;

XErrorEvent * event;

FILE *fp;

Arguments

display Specifies a connection to an X server; returned from XQpenDisplay.

event Specifies the error event whose contents will be printed.

fp Specifies where to print the error message.

Description

XmuPrintDefaultErrorMessage prints an error message, equivalent to Xlib's default error message for protocol errors. It returns a non-zero value if the caller should consider exit ing, otherwise it returns zero. This function can be used when you need to write your own error handler, but need to print out an error from within that handler.

Related Commands

XmuSimpleErrorHandler.

Xlib Reference Manual

. XmuReadBitmapData

—Xmu - Graphics Functions '

Name

XmuReadBitmapData — read and check bitmap data from any stream source.

Synopsis

^include <Xll/Xmu/Drawing.h>

int XmuReadBitmapData (fstream, width, height, datap, x_hot, y_hot )

FILE * fstream;

unsigned int * width, * height;

unsigned char ** datap;

int *x_hot, *y_hot;

Arguments

stream Specifies the stream to read from.

wi dth Returns the width of the bitmap.

height Returns the height of the bitmap.

da t ap Returns the parsed bitmap data.

x_hot Returns the x coordinate of the hotspot.

y_hot Returns the y coordinate of the hotspot.

Description

XmuReadBitmapData reads a standard bitmap file description from the specified stream, and returns the parsed data in a format suitable for passing to XCreatePixmapFromBitmap-Data. The return value of the function has the same meaning as the return value for XRead-BitmapFile.

XmuReadBitmapData is equivalent to XReadBitmapFile, except that this routine processes any type of stream input, and it does not create a pixmap containing the resulting data. This is useful when you want to create a multi-plane pixmap from the data, and don't want to create an intermediate one-plane pixmap.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDrawLogo, XmuDrawRoundedRectangle, XmuFillRoundedRectangle, XmuLocateBitmap-File,XmuReadBitmapDataFromFile, XmuReleaseStippledPixmap.

XmuReadBitmapDataFromFile \ X mu-Graphics Functions-Name

XmuReadBitmapDataFromFile — read and check bitmap data from a file. Synopsis

#include <Xll/Xmu/Drawing.h>

int XmuReadBitmapDataFromFile ( filename, width, height, datap, x_hot, y_hot)

char * filename;

unsigned int * width, *height;

unsigned char **datap;

int *x_hot, *y_hot;

Arguments

fi 1 ename Specifies the file to read from.

wi dth Returns the width of the bitmap.

height Returns the height of the bitmap.

da t ap Returns the parsed bitmap data.

x_hot Returns the x coordinate of the hotspot.

y_h o t Returns the y coordinate of the hotspot.

Description

XmuReadBitmapDataFromFile reads a standard bitmap file description from the specified file, and returns the parsed data in a format suitable for passing to XCreatePixmapFrom-BitmapData. The return value of the function has the same meaning as the return value for

XReadBitmapFile.

Unlike XReadBitmapFile, this function does not create a pixmap. This function is useful when you want to create a multi-plane pixmap without creating an intermediate one-plane pix map.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDrawLogo, XmuDrawRoundedRectangle, XmuFillRoundedRectangle, XmuLocateBitmap-File, XmuReadBitmapData, XmuReleaseStippledPixmap.

—Xmu - Graphics Functions '

Name

XmuReleaseStippledPixmap —release pixmap created with XmuCreateStippled-Pixmap.

Synopsis

#include <Xll/Xmu/Drawing.h>

void XmuReleaseStippledPixmap (screen, pixmap)

Screen * scree/2;

Pixmap pixmap;

Arguments

screen Specifies the screen the pixmap was created on.

pixmap Specifies the pixmap to free.

Description

XmuReleaseStippledPixmap frees a pixmap created with XmuCreateStippled-Pixmap, to maintain correct cache reference counts.

Related Commands

XmuCreatePixmapFromBitmap, XmuCreateStippledPixmap, XmuDrawLogo, XmuDrawRoundedRectangle, XmuFillRoundedRectangle, XmuLocateBitmap-File,XmuReadBitmapData,XmuReadBitmapDataFromFile.

Xlib Reference Manual 755

XmuRemoveCloseDisplayHook

•Xmu - CloseDisplay Hook-

Name

XmuRemoveCloseDisplayHook — remove registered close display callback function.

Synopsis

^include <Xll/Xmu/CloseHook.h>

Bool XmuRemoveCloseDisplayHook ( display, handle, func, arg)

Display ^display;

CloseHook handle;

int (*func) () ;

caddr_t arg;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

handl e Specifies the callback by ID, or NULL.

func Specifies the callback by function.

arg Specifies the function data to match.

Description

XmuRemoveCloseDisplayHook unregisters a callback that has been registered with Xmu-AddCloseDisplayHook. If handle is not NULL, it specifies the ID of the callback to remove, and the func and arg parameters are ignored. If handle is NULL, the first callback found to match the specified func and arg will be removed. Returns True if a callback was removed, else returns False.

Related Commands

XmuAddCloseDisplayHook, XmuLookupCloseDisplayHook.

/ XmuScreenOfWindow

—Xmu -Window Utility Functions '

Name

XmuScreenOfWindow — returns a pointer to the Screen structure for the specified window.

Synopsis

#include <Xll/Xmu/WinUtil.h>

Screen *XmuScreenOfWindow(display, w)

Display *display;

Window w;

Arguments

di spl ay Specifies a connection to an X server; returned from XOpenD i sp 1 ay.

w Specifies the window.

Description

XmuScreenOfWindow returns a pointer to the Screen structure that describes the screen on which the specified window was created.

Related Commands

XmuClientWindow,XmuUpdateMapHints.

XmuSimpleErrorHandler

•Xmu - Error Handler Functions—

Name

XmuSimpleErrorHandler — an error handler that ignores certain errors.

Synopsis

tinclude <Xll/Xmu/Error.h>

int XmuSimpleErrorHandler ( display, error)

Display *display;

XErrorEvent *error;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

error Specifies the error event

Description

XmuSimpleErrorHandler ignores BadWindow errors for XQueryTree and XGet-WindowAttributes, and ignores BadDrawable errors for XGetGeometry; it returns zero in those cases. Otherwise, it prints the default error message, and returns a non-zero value if the caller should consider exiting, and zero if the caller should not exit.

Related Commands

XmuPrintDefaultErrorMessage.

—Xmu - Standard Co lor maps-

Name

XmuStandardColormap

XmuStandardColormap — create one standard colormap. Synopsis

#include <Xll/Xmu/StdCmap.h>

XmuStandardColormap (display, screen, visualid, depth, property, cmapf red_max r green_max, blue_max)

Display display;

int screen;

VisuallD visualid;

unsigned int depth;

Atom property;

Colormap cmap;

unsigned long red_max, green_max, blue_max;

Arguments

display Specifies a connection to an X server; returned from XOpenDisplay.

screen Specifies the screen of the display,

visualid Specifies the visual type,

depth Specifies the visual depth,

property Specifies the standard colormap property.

cmap Specifies the colormap ID, or None.

red_max Specifies the red allocation.

green_max Specifies the green allocation.

bl ue_max Specifies the blue allocation.

Description

XmuStandardColormap creates one standard colormap for the given screen, visualid, and visual depth, with the given red, green, and blue maximum values, with the given standard property name. Upon success, it returns a pointer to an XStandardColormap structure which describes the newly created colormap. Upon failure, it returns NULL. If cmap is the default colormap of the screen, the standard colormap will be defined on the default colormap; otherwise a new colormap is created.

Resources created by this function are not made permanent; that is the caller's responsibility. Related Commands

XmuAllStandardColormaps, XmuCreateColormap, XmuDeleteStandard-Colormap, XmuGetColormapAllocation, XmuLookupStdCmp, XmuVisual-StandardColormaps.

Xlib Reference Manual

XmuUpdateMapHints V_ Xmu _ Wlndo « utuity Functions-

Name

XmuUpdateMapHints — set WM_HINTS flags to US Size and usPosition.

Synopsis

#include <Xll/Xmu/WinUtil.h>

Bool XmuUpdateMapHints(display, w, hints)

Display *display;

Window w;

XSizeHints *hints;

Arguments

di spl ay Specifies a connection to an X server; returned from XOpenD i sp 1 ay.

win Specifies the window.

hints Specifies the new hints, or NULL.

Description

XmuUpdateMapHints clears the PPosition and PSize flags and sets the USPosition and USSize flags in the hints structure, and then stores the hints for the window using XSet-WMNormalHints and returns True. If NULL is passed for the hints structure, then the current hints are read back from the window using XGetWMNormalHints the flags are set as described above, the property is reset, and True is returned. XmuUpdateMapHints returns False if it was unable to allocate memory or, when NULL is passed, if the existing hints could not be read.

Related Commands

XmuClientWindow, XmuScreenOfWindow.

760

Xlib Reference Manual

—Xmu - Standard Co lor maps-

XmuVisualStandardColormaps

Name

XmuVisualStandardColormaps — create all standard colormaps for given visual and screen.

Synopsis

#include <Xll/Xmu/StdCmap.h>

XmuVisualStandardColormaps( display, screen, visualid, depth, replace, retain)

Display *display;

int screen;

VisuallD visualid;

unsigned int depth;

Bool replace;

Bool retain;

Arguments

display Specifies a connection to an X server; returned from xopenDisplay.

screen Specifies the screen of the display.

visualid Specifies the visual type.

depth Specifies the visual depth.

replace Specifies whether or not to replace the standard colormap property.

retain Specifies whether or not to retain the colormap resource permanently.

Description

XmuVisualStandardColormaps creates all of the appropriate standard colormaps for a given visual on a given screen, and optionally redefines the corresponding standard colormap properties.

If replace is True, any previous definition will be removed. If retain is True, new pro perties will be retained for the duration of the server session. This function returns zero on fail ure, non-zero on success. On failure, no new properties will be defined, but old ones may have been removed if replace was True.

Not all standard colormaps are meaningful to all visual classes. This routine will check and define the following properties for the following classes, provided that the size of the colormap is not too small. For DirectColor and Pseudocolor: RGB_DEFAULT_MAP,

RGB_BEST_MAP, RGB_RED_MAP, RGB_GREEN_MAP, RGB_BLUE_MAP, and RGB_GRAY_MAP. For TrueColor and StaticColor: RGB_BEST_MAP . For Grayscale and StaticGray: RGB_GRAY_MAP.

Related Commands

XmuAllStandardColormaps, XmuCreateColormap, XmuDeleteStandard-Colormap, XmuGetColormapAllocation, XmuLookupStdCmp, XmuStandard-Colormap.

ft

O

03

T3

CO 0)

-i—•

_Q

I

O

I §£

a) >: g

J ss

«. i^ O

^ CO W

•S §^

" < ~ l ^H

^ o >;

§ li S S5?

CQ »«••-!

2 -H »i

rH S

C (U

.

s ^

>i W H-l fl

X O X -H

32 X3 M O

E " ^

III

* o o

4-1 w

££

TJ CJ

<D a

C CD C

> C 4J PL] -H 4-> 003

Z CM OQ

At-a-glance

763

LineOnOffDash

LineDoubleDash

cap_style

CapNotLast

CapButt

CapRound

:apProjecting

join_style

:

JoinMiter

JoinBevel

fill_style

Tile GC foreground

illSolid

Stipple

GC background Q Undrawn Pixels [~~|

iled FillStippled FillOpaqueStippled

I

' I . „..

fill rule

Outline of polygon to fill

EvenOddRule

ArcPieSlice

WindingRule

subwindow mode

inciudeinf eriors Graphics drawn with this setting will appear through all mapped

subwindows, but not through siblings. :iipByChiidren Graphics drawn will not draw through any other window that has

a background.

graphics_exposures

True Generate GraphicsExpose Or NoExpose events when XCopyArea Or

:copyFiane is called with this GC. False Don't generate GraphicsExpose or NoExpose events.

754

Xlib Reference Manual

At-a-glance

About the Editor

Adrian Nye is a senior technical writer at O'Reilly and Associates. In addition to the X Window System programming manuals, he has written user's manuals for data acquisition products, and customized UNIX documentation for Sun Microsystems and Prime. Adrian has also worked as a programmer writing educational software in C, and as a mechanical engineer designing offshore oil-spill cleanup equipment. He has long-term interests in using his technical writing skills to promote recycling and other environmentally-sound technologies. He graduated from the Massachusetts Institute of Technology in 1984 with a B.S. in Mechanical Engineering.

NAME

COMPANY ADDRESS CITY

STATE ZIP

BUSINESS REPLY MAIL

FIRST CLASS MAIL PERMIT NO. 80 SEBASTOPOL, CA

POSTAGE WILL BE PAID BY ADDRESSEE

O'Reilly & Associates, Inc.

632 Petaluma Avenue Sebastopol, CA 95472-9902

NAME

COMPANY ADDRESS CITY

STATE ZIP

BUSINESS REPLY MAIL

FIRST CLASS MAIL PERMIT NO. 80 SEBASTOPOL, CA

POSTAGE WILL BE PAID BY ADDRESSEE

O'Reilly & Associates, Inc.

632 Petaluma Avenue Sebastopol, CA 95472-9902

O'Reilly & Associates, Inc.

Creators and Publishers of Nutshell Handbooks, concise, down-to-earth guides on selected UNIX topics

The X Window System series:

Vol. 0 X Protocol Reference Manual Xlib Programming Manual Xlih Reference Manual X Window User's Guide X Toolkit Intrinsics Progamming Manual X Toolkit Intrinsics Reference Manual XView Programming Manual

Vol. 1 Vol.2 Vol. 3 Vol.4 Vol. 5 Vol.7

Send me more information on:

Q O'Reilly catalog and newsletter

Q Placing a standing order for new titles

Q Retail sales

Q Corporate sales

Q Bookstore locations

Q Overseas distributors

Q Upcoming books on the subject:

and The X Window System in a Nutshell, a quick reference

Writing a Nutshell Handbook

O'Reilly & Associates, Inc.

Creators and Publishers of Nutshell Handbooks, concise, down-to-earth guides on selected UNIX topics

The X Window System series:

Vol. 0 X Protocol Reference Manual Xlib Programming Manual Xlib Reference Manual X Window User's Guide X Toolkit Intrinsics Progamming Manual X Toolkit Intrinsics Reference Manual XView Programming Manual

Vol. 1 Vol.2 Vol. 3 Vol.4 Vol.5 Vol.7

Send me more information on:

Q O'Reilly catalog and newsletter

Q Placing a standing order for new titles

Q Retail sales

Q Corporate sales

Q Bookstore locations

Q Overseas distributors

Q Upcoming books on the subject:

and The X Window System in a Nutshell, a quick reference

Q Writing a Nutshell Handbook

Overseas Distributors

Effective January 1, 1990, customers outside the U.S. and Canada will be able to order Nutshell Hand books, the Pick Series, and the X Window System Series through distributors near them. These overseas locations offer international customers faster order processing, more local bookstores and local distribu tors, and increased representation at trade shows worldwide, as well as the high level, quality service our customers have always received.

AUSTRALIA & NEW ZEALAND

(orders and inquiries)

Addison-Wesley Publishers, Pty. Ltd.

6 Byfield Street

NorthRyde,N.S.W.2113

AUSTRALIA

Telephone: [phone]

FAX: [phone]

UNITED KINGDOM & AFRICA (orders and inquiries) Addison-Wesley Publishers, Ltd. Finchampstead Road Wokingham, Berkshire RG11 2NZ ENGLAND

Telephone: [phone] FAX: [phone]

EUROPE & THE MIDDLE EAST (orders and inquiries) Addison-Wesley Publishers B.V. De Lairessestraat 90 1071 PJ Amsterdam THE NETHERLANDS Telephone: [phone] FAX: [phone]

ASIA inquiries (excluding Japan) Addison-Wesley Singapore Pte. Ltd. 15 Beach Road #05-09/10 Beach Centre Singapore 0718 SINGAPORE Telephone: [phone] FAX: [phone]

ASIA orders (excluding Japan) Addison-Wesley Publishing Co., Inc. International Order Department Route 128

Reading, Massachusetts 01867 U.S.A. Telephone: [phone] FAX: [phone]

JAPAN

(orders and inquiries)

Toppan Company, Ltd.

Ochanomizu Square B, 1-6

Kanda Surugadai

Chiyoda-ku, Tokyo 101

JAPAN

Telephone: [phone]

FAX: [phone]

Maruzen Company, Ltd.

3-10 Nihonbashi 2-Chome

Chuo-Ku, Tokyo, 103

JAPAN

Telephone: [phone]

FAX: [phone]