diff options
Diffstat (limited to 'libX11/specs')
| -rw-r--r-- | libX11/specs/libX11/AppA.xml | 2618 | ||||
| -rw-r--r-- | libX11/specs/libX11/AppC.xml | 358 | ||||
| -rw-r--r-- | libX11/specs/libX11/AppD.xml | 166 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH01.xml | 49 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH02.xml | 284 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH03.xml | 800 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH04.xml | 308 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH05.xml | 70 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH06.xml | 652 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH07.xml | 582 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH08.xml | 520 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH09.xml | 226 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH10.xml | 1400 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH11.xml | 286 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH12.xml | 724 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH13.xml | 1120 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH14.xml | 508 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH15.xml | 142 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH16.xml | 298 | ||||
| -rw-r--r-- | libX11/specs/libX11/glossary.xml | 502 | ||||
| -rw-r--r-- | libX11/specs/xmlrules.in | 5 |
21 files changed, 6526 insertions, 5092 deletions
diff --git a/libX11/specs/libX11/AppA.xml b/libX11/specs/libX11/AppA.xml index 8c71b269d..a59bda63b 100644 --- a/libX11/specs/libX11/AppA.xml +++ b/libX11/specs/libX11/AppA.xml @@ -1,540 +1,2102 @@ <appendix id="xlib_functions_and_protocol_requests">
<title>Xlib Functions and Protocol Requests</title>
<para>
-This appendix provides two tables that relate to Xlib functions
+This appendix provides two tables that relate to Xlib functions
and the X protocol.
The following table lists each Xlib function (in alphabetical order)
and the corresponding protocol request that it generates.
</para>
-<literallayout class="monospaced">
---------------------------------------------------------------------------
-Xlib Function Protocol Request
---------------------------------------------------------------------------
-XActivateScreenSaver ForceScreenSaver
-XAddHost ChangeHosts
-XAddHosts ChangeHosts
-XAddToSaveSet ChangeSaveSet
-XAllocColor AllocColor
-XAllocColorCells AllocColorCells
-XAllocColorPlanes AllocColorPlanes
-XAllocNamedColor AllocNamedColor
-XAllowEvents AllowEvents
-XAutoRepeatOff ChangeKeyboardControl
-XAutoRepeatOn ChangeKeyboardControl
-XBell Bell
-XChangeActivePointerGrab ChangeActivePointerGrab
-XChangeGC ChangeGC
-XChangeKeyboardControl ChangeKeyboardControl
-XChangeKeyboardMapping ChangeKeyboardMapping
-XChangePointerControl ChangePointerControl
-XChangeProperty ChangeProperty
-XChangeSaveSet ChangeSaveSet
-XChangeWindowAttributes ChangeWindowAttributes
-XCirculateSubwindows CirculateWindow
-XCirculateSubwindowsDown CirculateWindow
-XCirculateSubwindowsUp CirculateWindow
-XClearArea ClearArea
-XClearWindow ClearArea
-XConfigureWindow ConfigureWindow
-XConvertSelection ConvertSelection
-XCopyArea CopyArea
-XCopyColormapAndFree CopyColormapAndFree
-XCopyGC CopyGC
-XCopyPlane CopyPlane
-XCreateBitmapFromData CreateGC
- CreatePixmap
- FreeGC
- PutImage
-XCreateColormap CreateColormap
-XCreateFontCursor CreateGlyphCursor
-XCreateGC CreateGC
-XCreateGlyphCursor CreateGlyphCursor
-XCreatePixmap CreatePixmap
-XCreatePixmapCursor CreateCursor
-XCreatePixmapFromData CreateGC
- CreatePixmap
- FreeGC
- PutImage
-XCreateSimpleWindow CreateWindow
-XCreateWindow CreateWindow
-XDefineCursor ChangeWindowAttributes
-XDeleteProperty DeleteProperty
-XDestroySubwindows DestroySubwindows
-XDestroyWindow DestroyWindow
-XDisableAccessControl SetAccessControl
-XDrawArc PolyArc
-XDrawArcs PolyArc
-XDrawImageString ImageText8
-XDrawImageString16 ImageText16
-XDrawLine PolySegment
-XDrawLines PolyLine
-XDrawPoint PolyPoint
-XDrawPoints PolyPoint
-XDrawRectangle PolyRectangle
-XDrawRectangles PolyRectangle
-XDrawSegments PolySegment
-XDrawString PolyText8
-XDrawString16 PolyText16
-XDrawText PolyText8
-XDrawText16 PolyText16
-XEnableAccessControl SetAccessControl
-XFetchBytes GetProperty
-XFetchName GetProperty
-XFillArc PolyFillArc
-XFillArcs PolyFillArc
-XFillPolygon FillPoly
-XFillRectangle PolyFillRectangle
-XFillRectangles PolyFillRectangle
-XForceScreenSaver ForceScreenSaver
-XFreeColormap FreeColormap
-XFreeColors FreeColors
-XFreeCursor FreeCursor
-XFreeFont CloseFont
-XFreeGC FreeGC
-XFreePixmap FreePixmap
-XGetAtomName GetAtomName
-XGetClassHint GetProperty
-XGetFontPath GetFontPath
-XGetGeometry GetGeometry
-XGetIconName GetProperty
-XGetIconSizes GetProperty
-XGetImage GetImage
-XGetInputFocus GetInputFocus
-XGetKeyboardControl GetKeyboardControl
-XGetKeyboardMapping GetKeyboardMapping
-XGetModifierMapping GetModifierMapping
-XGetMotionEvents GetMotionEvents
-XGetNormalHints GetProperty
-XGetPointerControl GetPointerControl
-XGetPointerMapping GetPointerMapping
-XGetRGBColormaps GetProperty
-XGetScreenSaver GetScreenSaver
-XGetSelectionOwner GetSelectionOwner
-XGetSizeHints GetProperty
-XGetTextProperty GetProperty
-XGetTransientForHint GetProperty
-XGetWMClientMachine GetProperty
-XGetWMColormapWindows GetProperty
- InternAtom
-XGetWMHints GetProperty
-XGetWMIconName GetProperty
-XGetWMName GetProperty
-XGetWMNormalHints GetProperty
-XGetWMProtocols GetProperty
- InternAtom
-XGetWMSizeHints GetProperty
-XGetWindowAttributes GetWindowAttributes
- GetGeometry
-XGetWindowProperty GetProperty
-XGetZoomHints GetProperty
-XGrabButton GrabButton
-XGrabKey GrabKey
-XGrabKeyboard GrabKeyboard
-XGrabPointer GrabPointer
-XGrabServer GrabServer
-XIconifyWindow InternAtom
- SendEvent
-XInitExtension QueryExtension
-XInstallColormap InstallColormap
-XInternAtom InternAtom
-XKillClient KillClient
-XListExtensions ListExtensions
-XListFonts ListFonts
-XListFontsWithInfo ListFontsWithInfo
-XListHosts ListHosts
-XListInstalledColormaps ListInstalledColormaps
-XListProperties ListProperties
-XLoadFont OpenFont
-XLoadQueryFont OpenFont
- QueryFont
-XLookupColor LookupColor
-XLowerWindow ConfigureWindow
-XMapRaised ConfigureWindow
- MapWindow
-XMapSubwindows MapSubwindows
-XMapWindow MapWindow
-XMoveResizeWindow ConfigureWindow
-XMoveWindow ConfigureWindow
-XNoOp NoOperation
-XOpenDisplay CreateGC
-XParseColor LookupColor
-XPutImage PutImage
-XQueryBestCursor QueryBestSize
-XQueryBestSize QueryBestSize
-XQueryBestStipple QueryBestSize
-XQueryBestTile QueryBestSize
-XQueryColor QueryColors
-XQueryColors QueryColors
-XQueryExtension QueryExtension
-XQueryFont QueryFont
-XQueryKeymap QueryKeymap
-XQueryPointer QueryPointer
-XQueryTextExtents QueryTextExtents
-XQueryTextExtents16 QueryTextExtents
-XQueryTree QueryTree
-XRaiseWindow ConfigureWindow
-XReadBitmapFile CreateGC
- CreatePixmap
- FreeGC
- PutImage
-XRecolorCursor RecolorCursor
-XReconfigureWMWindow ConfigureWindow
- SendEvent
-XRemoveFromSaveSet ChangeSaveSet
-XRemoveHost ChangeHosts
-XRemoveHosts ChangeHosts
-XReparentWindow ReparentWindow
-XResetScreenSaver ForceScreenSaver
-XResizeWindow ConfigureWindow
-XRestackWindows ConfigureWindow
-XRotateBuffers RotateProperties
-XRotateWindowProperties RotateProperties
-XSelectInput ChangeWindowAttributes
-XSendEvent SendEvent
-XSetAccessControl SetAccessControl
-XSetArcMode ChangeGC
-XSetBackground ChangeGC
-XSetClassHint ChangeProperty
-XSetClipMask ChangeGC
-XSetClipOrigin ChangeGC
-XSetClipRectangles SetClipRectangles
-XSetCloseDownMode SetCloseDownMode
-XSetCommand ChangeProperty
-XSetDashes SetDashes
-XSetFillRule ChangeGC
-XSetFillStyle ChangeGC
-XSetFont ChangeGC
-XSetFontPath SetFontPath
-XSetForeground ChangeGC
-XSetFunction ChangeGC
-XSetGraphicsExposures ChangeGC
-XSetIconName ChangeProperty
-XSetIconSizes ChangeProperty
-XSetInputFocus SetInputFocus
-XSetLineAttributes ChangeGC
-XSetModifierMapping SetModifierMapping
-XSetNormalHints ChangeProperty
-XSetPlaneMask ChangeGC
-XSetPointerMapping SetPointerMapping
-XSetRGBColormaps ChangeProperty
-XSetScreenSaver SetScreenSaver
-XSetSelectionOwner SetSelectionOwner
-XSetSizeHints ChangeProperty
-XSetStandardProperties ChangeProperty
-XSetState ChangeGC
-XSetStipple ChangeGC
-XSetSubwindowMode ChangeGC
-XSetTextProperty ChangeProperty
-XSetTile ChangeGC
-XSetTransientForHint ChangeProperty
-XSetTSOrigin ChangeGC
-XSetWMClientMachine ChangeProperty
-XSetWMColormapWindows ChangeProperty
- InternAtom
-XSetWMHints ChangeProperty
-XSetWMIconName ChangeProperty
-XSetWMName ChangeProperty
-XSetWMNormalHints ChangeProperty
-XSetWMProperties ChangeProperty
-XSetWMProtocols ChangeProperty
- InternAtom
-XSetWMSizeHints ChangeProperty
-XSetWindowBackground ChangeWindowAttributes
-XSetWindowBackgroundPixmap ChangeWindowAttributes
-XSetWindowBorder ChangeWindowAttributes
-XSetWindowBorderPixmap ChangeWindowAttributes
-XSetWindowBorderWidth ConfigureWindow
-XSetWindowColormap ChangeWindowAttributes
-XSetZoomHints ChangeProperty
-XStoreBuffer ChangeProperty
-XStoreBytes ChangeProperty
-XStoreColor StoreColors
-XStoreColors StoreColors
-XStoreName ChangeProperty
-XStoreNamedColor StoreNamedColor
-XSync GetInputFocus
-XSynchronize GetInputFocus
-XTranslateCoordinates TranslateCoordinates
-XUndefineCursor ChangeWindowAttributes
-XUngrabButton UngrabButton
-XUngrabKey UngrabKey
-XUngrabKeyboard UngrabKeyboard
-XUngrabPointer UngrabPointer
-XUngrabServer UngrabServer
-XUninstallColormap UninstallColormap
-XUnloadFont CloseFont
-XUnmapSubwindows UnmapSubwindows
-XUnmapWindow UnmapWindow
-XWarpPointer WarpPointer
-XWithdrawWindow SendEvent
- UnmapWindow
-</literallayout>
+<table>
+ <title>Protocol requests made by each Xlib function</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Xlib Function</entry>
+ <entry>Protocol Request</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><function>XActivateScreenSaver</function></entry>
+ <entry><systemitem>ForceScreenSaver</systemitem></entry></row>
+ <row>
+ <entry><function>XAddHost</function></entry>
+ <entry><systemitem>ChangeHosts</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAddHosts</function></entry>
+ <entry><systemitem>ChangeHosts</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAddToSaveSet</function></entry>
+ <entry><systemitem>ChangeSaveSet</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAllocColor</function></entry>
+ <entry><systemitem>AllocColor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAllocColorCells</function></entry>
+ <entry><systemitem>AllocColorCells</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAllocColorPlanes</function></entry>
+ <entry><systemitem>AllocColorPlanes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAllocNamedColor</function></entry>
+ <entry><systemitem>AllocNamedColor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAllowEvents</function></entry>
+ <entry><systemitem>AllowEvents</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAutoRepeatOff</function></entry>
+ <entry><systemitem>ChangeKeyboardControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XAutoRepeatOn</function></entry>
+ <entry><systemitem>ChangeKeyboardControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XBell</function></entry>
+ <entry><systemitem>Bell</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeActivePointerGrab</function></entry>
+ <entry><systemitem>ChangeActivePointerGrab</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeGC</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeKeyboardControl</function></entry>
+ <entry><systemitem>ChangeKeyboardControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeKeyboardMapping</function></entry>
+ <entry><systemitem>ChangeKeyboardMapping</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangePointerControl</function></entry>
+ <entry><systemitem>ChangePointerControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeProperty</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeSaveSet</function></entry>
+ <entry><systemitem>ChangeSaveSet</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XChangeWindowAttributes</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCirculateSubwindows</function></entry>
+ <entry><systemitem>CirculateWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCirculateSubwindowsDown</function></entry>
+ <entry><systemitem>CirculateWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCirculateSubwindowsUp</function></entry>
+ <entry><systemitem>CirculateWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XClearArea</function></entry>
+ <entry><systemitem>ClearArea</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XClearWindow</function></entry>
+ <entry><systemitem>ClearArea</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XConfigureWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XConvertSelection</function></entry>
+ <entry><systemitem>ConvertSelection</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCopyArea</function></entry>
+ <entry><systemitem>CopyArea</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCopyColormapAndFree</function></entry>
+ <entry><systemitem>CopyColormapAndFree</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCopyGC</function></entry>
+ <entry><systemitem>CopyGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCopyPlane</function></entry>
+ <entry><systemitem>CopyPlane</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="3"><function>XCreateBitmapFromData</function></entry>
+ <entry><systemitem>CreateGC</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>CreatePixmap</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>FreeGC</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>PutImage</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreateColormap</function></entry>
+ <entry><systemitem>CreateColormap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreateFontCursor</function></entry>
+ <entry><systemitem>CreateGlyphCursor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreateGC</function></entry>
+ <entry><systemitem>CreateGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreateGlyphCursor</function></entry>
+ <entry><systemitem>CreateGlyphCursor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreatePixmap</function></entry>
+ <entry><systemitem>CreatePixmap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreatePixmapCursor</function></entry>
+ <entry><systemitem>CreateCursor</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="3"><function>XCreatePixmapFromData</function></entry>
+ <entry><systemitem>CreateGC</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>CreatePixmap</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>FreeGC</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>PutImage</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreateSimpleWindow</function></entry>
+ <entry><systemitem>CreateWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XCreateWindow</function></entry>
+ <entry><systemitem>CreateWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDefineCursor</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDeleteProperty</function></entry>
+ <entry><systemitem>DeleteProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDestroySubwindows</function></entry>
+ <entry><systemitem>DestroySubwindows</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDestroyWindow</function></entry>
+ <entry><systemitem>DestroyWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDisableAccessControl</function></entry>
+ <entry><systemitem>SetAccessControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawArc</function></entry>
+ <entry><systemitem>PolyArc</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawArcs</function></entry>
+ <entry><systemitem>PolyArc</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawImageString</function></entry>
+ <entry><systemitem>ImageText8</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawImageString16</function></entry>
+ <entry><systemitem>ImageText16</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawLine</function></entry>
+ <entry><systemitem>PolySegment</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawLines</function></entry>
+ <entry><systemitem>PolyLine</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawPoint</function></entry>
+ <entry><systemitem>PolyPoint</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawPoints</function></entry>
+ <entry><systemitem>PolyPoint</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawRectangle</function></entry>
+ <entry><systemitem>PolyRectangle</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawRectangles</function></entry>
+ <entry><systemitem>PolyRectangle</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawSegments</function></entry>
+ <entry><systemitem>PolySegment</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawString</function></entry>
+ <entry><systemitem>PolyText8</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawString16</function></entry>
+ <entry><systemitem>PolyText16</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawText</function></entry>
+ <entry><systemitem>PolyText8</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XDrawText16</function></entry>
+ <entry><systemitem>PolyText16</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XEnableAccessControl</function></entry>
+ <entry><systemitem>SetAccessControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFetchBytes</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFetchName</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFillArc</function></entry>
+ <entry><systemitem>PolyFillArc</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFillArcs</function></entry>
+ <entry><systemitem>PolyFillArc</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFillPolygon</function></entry>
+ <entry><systemitem>FillPoly</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFillRectangle</function></entry>
+ <entry><systemitem>PolyFillRectangle</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFillRectangles</function></entry>
+ <entry><systemitem>PolyFillRectangle</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XForceScreenSaver</function></entry>
+ <entry><systemitem>ForceScreenSaver</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFreeColormap</function></entry>
+ <entry><systemitem>FreeColormap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFreeColors</function></entry>
+ <entry><systemitem>FreeColors</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFreeCursor</function></entry>
+ <entry><systemitem>FreeCursor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFreeFont</function></entry>
+ <entry><systemitem>CloseFont</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFreeGC</function></entry>
+ <entry><systemitem>FreeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XFreePixmap</function></entry>
+ <entry><systemitem>FreePixmap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetAtomName</function></entry>
+ <entry><systemitem>GetAtomName</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetClassHint</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetFontPath</function></entry>
+ <entry><systemitem>GetFontPath</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetGeometry</function></entry>
+ <entry><systemitem>GetGeometry</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetIconName</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetIconSizes</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetImage</function></entry>
+ <entry><systemitem>GetImage</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetInputFocus</function></entry>
+ <entry><systemitem>GetInputFocus</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetKeyboardControl</function></entry>
+ <entry><systemitem>GetKeyboardControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetKeyboardMapping</function></entry>
+ <entry><systemitem>GetKeyboardMapping</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetModifierMapping</function></entry>
+ <entry><systemitem>GetModifierMapping</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetMotionEvents</function></entry>
+ <entry><systemitem>GetMotionEvents</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetNormalHints</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetPointerControl</function></entry>
+ <entry><systemitem>GetPointerControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetPointerMapping</function></entry>
+ <entry><systemitem>GetPointerMapping</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetRGBColormaps</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetScreenSaver</function></entry>
+ <entry><systemitem>GetScreenSaver</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetSelectionOwner</function></entry>
+ <entry><systemitem>GetSelectionOwner</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetSizeHints</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetTextProperty</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetTransientForHint</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWMClientMachine</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XGetWMColormapWindows</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>InternAtom</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWMHints</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWMIconName</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWMName</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWMNormalHints</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XGetWMProtocols</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>InternAtom</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWMSizeHints</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XGetWindowAttributes</function></entry>
+ <entry><systemitem>GetWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>GetGeometry</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetWindowProperty</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGetZoomHints</function></entry>
+ <entry><systemitem>GetProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGrabButton</function></entry>
+ <entry><systemitem>GrabButton</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGrabKey</function></entry>
+ <entry><systemitem>GrabKey</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGrabKeyboard</function></entry>
+ <entry><systemitem>GrabKeyboard</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGrabPointer</function></entry>
+ <entry><systemitem>GrabPointer</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XGrabServer</function></entry>
+ <entry><systemitem>GrabServer</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XIconifyWindow</function></entry>
+ <entry><systemitem>InternAtom</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>SendEvent</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XInitExtension</function></entry>
+ <entry><systemitem>QueryExtension</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XInstallColormap</function></entry>
+ <entry><systemitem>InstallColormap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XInternAtom</function></entry>
+ <entry><systemitem>InternAtom</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XKillClient</function></entry>
+ <entry><systemitem>KillClient</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XListExtensions</function></entry>
+ <entry><systemitem>ListExtensions</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XListFonts</function></entry>
+ <entry><systemitem>ListFonts</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XListFontsWithInfo</function></entry>
+ <entry><systemitem>ListFontsWithInfo</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XListHosts</function></entry>
+ <entry><systemitem>ListHosts</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XListInstalledColormaps</function></entry>
+ <entry><systemitem>ListInstalledColormaps</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XListProperties</function></entry>
+ <entry><systemitem>ListProperties</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XLoadFont</function></entry>
+ <entry><systemitem>OpenFont</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XLoadQueryFont</function></entry>
+ <entry><systemitem>OpenFont</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>QueryFont</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XLookupColor</function></entry>
+ <entry><systemitem>LookupColor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XLowerWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XMapRaised</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>MapWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XMapSubwindows</function></entry>
+ <entry><systemitem>MapSubwindows</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XMapWindow</function></entry>
+ <entry><systemitem>MapWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XMoveResizeWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XMoveWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XNoOp</function></entry>
+ <entry><systemitem>NoOperation</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XOpenDisplay</function></entry>
+ <entry><systemitem>CreateGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XParseColor</function></entry>
+ <entry><systemitem>LookupColor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XPutImage</function></entry>
+ <entry><systemitem>PutImage</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryBestCursor</function></entry>
+ <entry><systemitem>QueryBestSize</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryBestSize</function></entry>
+ <entry><systemitem>QueryBestSize</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryBestStipple</function></entry>
+ <entry><systemitem>QueryBestSize</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryBestTile</function></entry>
+ <entry><systemitem>QueryBestSize</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryColor</function></entry>
+ <entry><systemitem>QueryColors</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryColors</function></entry>
+ <entry><systemitem>QueryColors</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryExtension</function></entry>
+ <entry><systemitem>QueryExtension</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryFont</function></entry>
+ <entry><systemitem>QueryFont</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryKeymap</function></entry>
+ <entry><systemitem>QueryKeymap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryPointer</function></entry>
+ <entry><systemitem>QueryPointer</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryTextExtents</function></entry>
+ <entry><systemitem>QueryTextExtents</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryTextExtents16</function></entry>
+ <entry><systemitem>QueryTextExtents</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XQueryTree</function></entry>
+ <entry><systemitem>QueryTree</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRaiseWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="3"><function>XReadBitmapFile</function></entry>
+ <entry><systemitem>CreateGC</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>CreatePixmap</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>FreeGC</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>PutImage</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRecolorCursor</function></entry>
+ <entry><systemitem>RecolorCursor</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XReconfigureWMWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>SendEvent</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRemoveFromSaveSet</function></entry>
+ <entry><systemitem>ChangeSaveSet</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRemoveHost</function></entry>
+ <entry><systemitem>ChangeHosts</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRemoveHosts</function></entry>
+ <entry><systemitem>ChangeHosts</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XReparentWindow</function></entry>
+ <entry><systemitem>ReparentWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XResetScreenSaver</function></entry>
+ <entry><systemitem>ForceScreenSaver</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XResizeWindow</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRestackWindows</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRotateBuffers</function></entry>
+ <entry><systemitem>RotateProperties</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XRotateWindowProperties</function></entry>
+ <entry><systemitem>RotateProperties</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSelectInput</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSendEvent</function></entry>
+ <entry><systemitem>SendEvent</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetAccessControl</function></entry>
+ <entry><systemitem>SetAccessControl</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetArcMode</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetBackground</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetClassHint</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetClipMask</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetClipOrigin</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetClipRectangles</function></entry>
+ <entry><systemitem>SetClipRectangles</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetCloseDownMode</function></entry>
+ <entry><systemitem>SetCloseDownMode</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetCommand</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetDashes</function></entry>
+ <entry><systemitem>SetDashes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetFillRule</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetFillStyle</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetFont</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetFontPath</function></entry>
+ <entry><systemitem>SetFontPath</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetForeground</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetFunction</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetGraphicsExposures</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetIconName</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetIconSizes</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetInputFocus</function></entry>
+ <entry><systemitem>SetInputFocus</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetLineAttributes</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetModifierMapping</function></entry>
+ <entry><systemitem>SetModifierMapping</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetNormalHints</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetPlaneMask</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetPointerMapping</function></entry>
+ <entry><systemitem>SetPointerMapping</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetRGBColormaps</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetScreenSaver</function></entry>
+ <entry><systemitem>SetScreenSaver</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetSelectionOwner</function></entry>
+ <entry><systemitem>SetSelectionOwner</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetSizeHints</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetStandardProperties</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetState</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetStipple</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetSubwindowMode</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetTextProperty</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetTile</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetTransientForHint</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetTSOrigin</function></entry>
+ <entry><systemitem>ChangeGC</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMClientMachine</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XSetWMColormapWindows</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>InternAtom</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMHints</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMIconName</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMName</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMNormalHints</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMProperties</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XSetWMProtocols</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>InternAtom</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWMSizeHints</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWindowBackground</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWindowBackgroundPixmap</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWindowBorder</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWindowBorderPixmap</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWindowBorderWidth</function></entry>
+ <entry><systemitem>ConfigureWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetWindowColormap</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSetZoomHints</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XStoreBuffer</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XStoreBytes</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XStoreColor</function></entry>
+ <entry><systemitem>StoreColors</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XStoreColors</function></entry>
+ <entry><systemitem>StoreColors</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XStoreName</function></entry>
+ <entry><systemitem>ChangeProperty</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XStoreNamedColor</function></entry>
+ <entry><systemitem>StoreNamedColor</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSync</function></entry>
+ <entry><systemitem>GetInputFocus</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XSynchronize</function></entry>
+ <entry><systemitem>GetInputFocus</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XTranslateCoordinates</function></entry>
+ <entry><systemitem>TranslateCoordinates</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUndefineCursor</function></entry>
+ <entry><systemitem>ChangeWindowAttributes</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUngrabButton</function></entry>
+ <entry><systemitem>UngrabButton</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUngrabKey</function></entry>
+ <entry><systemitem>UngrabKey</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUngrabKeyboard</function></entry>
+ <entry><systemitem>UngrabKeyboard</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUngrabPointer</function></entry>
+ <entry><systemitem>UngrabPointer</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUngrabServer</function></entry>
+ <entry><systemitem>UngrabServer</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUninstallColormap</function></entry>
+ <entry><systemitem>UninstallColormap</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUnloadFont</function></entry>
+ <entry><systemitem>CloseFont</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUnmapSubwindows</function></entry>
+ <entry><systemitem>UnmapSubwindows</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XUnmapWindow</function></entry>
+ <entry><systemitem>UnmapWindow</systemitem></entry>
+ </row>
+ <row>
+ <entry><function>XWarpPointer</function></entry>
+ <entry><systemitem>WarpPointer</systemitem></entry>
+ </row>
+ <row>
+ <entry morerows="1"><function>XWithdrawWindow</function></entry>
+ <entry><systemitem>SendEvent</systemitem></entry>
+ </row>
+ <row>
+
+ <entry><systemitem>UnmapWindow</systemitem></entry>
+ </row>
+ </tbody>
+ </tgroup>
+</table>
<para>
The following table lists each X protocol request (in alphabetical
order) and the Xlib functions that reference it.
</para>
-<literallayout class="monospaced">
---------------------------------------------------------------------------
-Protocol Request Xlib Function
---------------------------------------------------------------------------
-AllocColor XAllocColor
-AllocColorCells XAllocColorCells
-AllocColorPlanes XAllocColorPlanes
-AllocNamedColor XAllocNamedColor
-AllowEvents XAllowEvents
-Bell XBell
-ChangeActivePointerGrab XChangeActivePointerGrab
-ChangeGC XChangeGC
- XSetArcMode
- XSetBackground
- XSetClipMask
- XSetClipOrigin
- XSetFillRule
- XSetFillStyle
- XSetFont
- XSetForeground
- XSetFunction
- XSetGraphicsExposures
- XSetLineAttributes
- XSetPlaneMask
- XSetState
- XSetStipple
- XSetSubwindowMode
- XSetTile
- XSetTSOrigin
-ChangeHosts XAddHost
- XAddHosts
- XRemoveHost
- XRemoveHosts
-ChangeKeyboardControl XAutoRepeatOff
- XAutoRepeatOn
- XChangeKeyboardControl
-ChangeKeyboardMapping XChangeKeyboardMapping
-ChangePointerControl XChangePointerControl
-ChangeProperty XChangeProperty
- XSetClassHint
- XSetCommand
- XSetIconName
- XSetIconSizes
- XSetNormalHints
- XSetRGBColormaps
- XSetSizeHints
- XSetStandardProperties
- XSetTextProperty
- XSetTransientForHint
- XSetWMClientMachine
- XSetWMColormapWindows
- XSetWMHints
- XSetWMIconName
- XSetWMName
- XSetWMNormalHints
- XSetWMProperties
- XSetWMProtocols
- XSetWMSizeHints
- XSetZoomHints
- XStoreBuffer
- XStoreBytes
- XStoreName
-ChangeSaveSet XAddToSaveSet
- XChangeSaveSet
- XRemoveFromSaveSet
-ChangeWindowAttributes XChangeWindowAttributes
- XDefineCursor
- XSelectInput
- XSetWindowBackground
- XSetWindowBackgroundPixmap
- XSetWindowBorder
- XSetWindowBorderPixmap
- XSetWindowColormap
- XUndefineCursor
-CirculateWindow XCirculateSubwindowsDown
- XCirculateSubwindowsUp
- XCirculateSubwindows
-ClearArea XClearArea
- XClearWindow
-CloseFont XFreeFont
- XUnloadFont
-ConfigureWindow XConfigureWindow
- XLowerWindow
- XMapRaised
- XMoveResizeWindow
- XMoveWindow
- XRaiseWindow
- XReconfigureWMWindow
- XResizeWindow
- XRestackWindows
- XSetWindowBorderWidth
-ConvertSelection XConvertSelection
-CopyArea XCopyArea
-CopyColormapAndFree XCopyColormapAndFree
-CopyGC XCopyGC
-CopyPlane XCopyPlane
-CreateColormap XCreateColormap
-CreateCursor XCreatePixmapCursor
-CreateGC XCreateGC
- XCreateBitmapFromData
- XCreatePixmapFromData
- XOpenDisplay
- XReadBitmapFile
-CreateGlyphCursor XCreateFontCursor
- XCreateGlyphCursor
-CreatePixmap XCreatePixmap
- XCreateBitmapFromData
- XCreatePixmapFromData
- XReadBitmapFile
-CreateWindow XCreateSimpleWindow
- XCreateWindow
-DeleteProperty XDeleteProperty
-DestroySubwindows XDestroySubwindows
-DestroyWindow XDestroyWindow
-FillPoly XFillPolygon
-ForceScreenSaver XActivateScreenSaver
- XForceScreenSaver
- XResetScreenSaver
-FreeColormap XFreeColormap
-FreeColors XFreeColors
-FreeCursor XFreeCursor
-FreeGC XFreeGC
- XCreateBitmapFromData
- XCreatePixmapFromData
- XReadBitmapFile
-FreePixmap XFreePixmap
-GetAtomName XGetAtomName
-GetFontPath XGetFontPath
-GetGeometry XGetGeometry
- XGetWindowAttributes
-GetImage XGetImage
-GetInputFocus XGetInputFocus
- XSync
- XSynchronize
-GetKeyboardControl XGetKeyboardControl
-GetKeyboardMapping XGetKeyboardMapping
-GetModifierMapping XGetModifierMapping
-GetMotionEvents XGetMotionEvents
-GetPointerControl XGetPointerControl
-GetPointerMapping XGetPointerMapping
-GetProperty XFetchBytes
- XFetchName
- XGetClassHint
- XGetIconName
- XGetIconSizes
- XGetNormalHints
- XGetRGBColormaps
- XGetSizeHints
- XGetTextProperty
- XGetTransientForHint
- XGetWMClientMachine
- XGetWMColormapWindows
- XGetWMHints
- XGetWMIconName
- XGetWMName
- XGetWMNormalHints
- XGetWMProtocols
- XGetWMSizeHints
- XGetWindowProperty
- XGetZoomHints
-GetSelectionOwner XGetSelectionOwner
-GetWindowAttributes XGetWindowAttributes
-GrabButton XGrabButton
-GrabKey XGrabKey
-GrabKeyboard XGrabKeyboard
-GrabPointer XGrabPointer
-GrabServer XGrabServer
-ImageText8 XDrawImageString
-ImageText16 XDrawImageString16
-InstallColormap XInstallColormap
-InternAtom XGetWMColormapWindows
- XGetWMProtocols
- XIconifyWindow
- XInternAtom
- XSetWMColormapWindows
- XSetWMProtocols
-KillClient XKillClient
-ListExtensions XListExtensions
-ListFonts XListFonts
-ListFontsWithInfo XListFontsWithInfo
-ListHosts XListHosts
-ListInstalledColormaps XListInstalledColormaps
-ListProperties XListProperties
-LookupColor XLookupColor
- XParseColor
-MapSubwindows XMapSubwindows
-MapWindow XMapRaised
- XMapWindow
-NoOperation XNoOp
-OpenFont XLoadFont
- XLoadQueryFont
-PolyArc XDrawArc
- XDrawArcs
-PolyFillArc XFillArc
- XFillArcs
-PolyFillRectangle XFillRectangle
- XFillRectangles
-PolyLine XDrawLines
-PolyPoint XDrawPoint
- XDrawPoints
-PolyRectangle XDrawRectangle
- XDrawRectangles
-PolySegment XDrawLine
- XDrawSegments
-PolyText8 XDrawString
- XDrawText
-PolyText16 XDrawString16
- XDrawText16
-PutImage XPutImage
- XCreateBitmapFromData
- XCreatePixmapFromData
- XReadBitmapFile
-QueryBestSize XQueryBestCursor
- XQueryBestSize
- XQueryBestStipple
- XQueryBestTile
-QueryColors XQueryColor
- XQueryColors
-QueryExtension XInitExtension
- XQueryExtension
-QueryFont XLoadQueryFont
- XQueryFont
-QueryKeymap XQueryKeymap
-QueryPointer XQueryPointer
-QueryTextExtents XQueryTextExtents
- XQueryTextExtents16
-QueryTree XQueryTree
-RecolorCursor XRecolorCursor
-ReparentWindow XReparentWindow
-RotateProperties XRotateBuffers
- XRotateWindowProperties
-SendEvent XIconifyWindow
- XReconfigureWMWindow
- XSendEvent
- XWithdrawWindow
-SetAccessControl XDisableAccessControl
- XEnableAccessControl
- XSetAccessControl
-SetClipRectangles XSetClipRectangles
-SetCloseDownMode XSetCloseDownMode
-SetDashes XSetDashes
-SetFontPath XSetFontPath
-SetInputFocus XSetInputFocus
-SetModifierMapping XSetModifierMapping
-SetPointerMapping XSetPointerMapping
-SetScreenSaver XGetScreenSaver
- XSetScreenSaver
-SetSelectionOwner XSetSelectionOwner
-StoreColors XStoreColor
- XStoreColors
-StoreNamedColor XStoreNamedColor
-TranslateCoordinates XTranslateCoordinates
-UngrabButton XUngrabButton
-UngrabKey XUngrabKey
-UngrabKeyboard XUngrabKeyboard
-UngrabPointer XUngrabPointer
-UngrabServer XUngrabServer
-UninstallColormap XUninstallColormap
-UnmapSubwindows XUnmapSubWindows
-UnmapWindow XUnmapWindow
- XWithdrawWindow
-WarpPointer XWarpPointer
-
-</literallayout>
+<table>
+ <title>Xlib functions which use each Protocol Request</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Protocol Request</entry>
+ <entry>Xlib Function</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><systemitem>AllocColor</systemitem></entry>
+ <entry><function>XAllocColor</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>AllocColorCells</systemitem></entry>
+ <entry><function>XAllocColorCells</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>AllocColorPlanes</systemitem></entry>
+ <entry><function>XAllocColorPlanes</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>AllocNamedColor</systemitem></entry>
+ <entry><function>XAllocNamedColor</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>AllowEvents</systemitem></entry>
+ <entry><function>XAllowEvents</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>Bell</systemitem></entry>
+ <entry><function>XBell</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ChangeActivePointerGrab</systemitem></entry>
+ <entry><function>XChangeActivePointerGrab</function></entry>
+ </row>
+ <row>
+ <entry morerows="17"><systemitem>ChangeGC</systemitem></entry>
+ <entry><function>XChangeGC</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetArcMode</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetBackground</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetClipMask</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetClipOrigin</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetFillRule</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetFillStyle</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetFont</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetForeground</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetFunction</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetGraphicsExposures</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetLineAttributes</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetPlaneMask</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetState</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetStipple</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetSubwindowMode</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetTile</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetTSOrigin</function></entry>
+ </row>
+ <row>
+ <entry morerows="3"><systemitem>ChangeHosts</systemitem></entry>
+ <entry><function>XAddHost</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XAddHosts</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XRemoveHost</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XRemoveHosts</function></entry>
+ </row>
+ <row>
+ <entry morerows="2"><systemitem>ChangeKeyboardControl</systemitem></entry>
+ <entry><function>XAutoRepeatOff</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XAutoRepeatOn</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XChangeKeyboardControl</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ChangeKeyboardMapping</systemitem></entry>
+ <entry><function>XChangeKeyboardMapping</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ChangePointerControl</systemitem></entry>
+ <entry><function>XChangePointerControl</function></entry>
+ </row>
+ <row>
+ <entry morerows="23"><systemitem>ChangeProperty</systemitem></entry>
+ <entry><function>XChangeProperty</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetClassHint</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetCommand</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetIconName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetIconSizes</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetNormalHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetRGBColormaps</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetSizeHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetStandardProperties</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetTextProperty</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetTransientForHint</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMClientMachine</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMColormapWindows</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMIconName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMNormalHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMProperties</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMProtocols</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMSizeHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetZoomHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XStoreBuffer</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XStoreBytes</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XStoreName</function></entry>
+ </row>
+ <row>
+ <entry morerows="2"><systemitem>ChangeSaveSet</systemitem></entry>
+ <entry><function>XAddToSaveSet</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XChangeSaveSet</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XRemoveFromSaveSet</function></entry>
+ </row>
+ <row>
+ <entry morerows="8"><systemitem>ChangeWindowAttributes</systemitem></entry>
+ <entry><function>XChangeWindowAttributes</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDefineCursor</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSelectInput</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWindowBackground</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWindowBackgroundPixmap</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWindowBorder</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWindowBorderPixmap</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWindowColormap</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XUndefineCursor</function></entry>
+ </row>
+ <row>
+ <entry morerows="2"><systemitem>CirculateWindow</systemitem></entry>
+ <entry><function>XCirculateSubwindowsDown</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCirculateSubwindowsUp</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCirculateSubwindows</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>ClearArea</systemitem></entry>
+ <entry><function>XClearArea</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XClearWindow</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>CloseFont</systemitem></entry>
+ <entry><function>XFreeFont</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XUnloadFont</function></entry>
+ </row>
+ <row>
+ <entry morerows="9"><systemitem>ConfigureWindow</systemitem></entry>
+ <entry><function>XConfigureWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XLowerWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XMapRaised</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XMoveResizeWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XMoveWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XRaiseWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XReconfigureWMWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XResizeWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XRestackWindows</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWindowBorderWidth</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ConvertSelection</systemitem></entry>
+ <entry><function>XConvertSelection</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>CopyArea</systemitem></entry>
+ <entry><function>XCopyArea</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>CopyColormapAndFree</systemitem></entry>
+ <entry><function>XCopyColormapAndFree</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>CopyGC</systemitem></entry>
+ <entry><function>XCopyGC</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>CopyPlane</systemitem></entry>
+ <entry><function>XCopyPlane</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>CreateColormap</systemitem></entry>
+ <entry><function>XCreateColormap</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>CreateCursor</systemitem></entry>
+ <entry><function>XCreatePixmapCursor</function></entry>
+ </row>
+ <row>
+ <entry morerows="4"><systemitem>CreateGC</systemitem></entry>
+ <entry><function>XCreateGC</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreateBitmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreatePixmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XOpenDisplay</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XReadBitmapFile</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>CreateGlyphCursor</systemitem></entry>
+ <entry><function>XCreateFontCursor</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreateGlyphCursor</function></entry>
+ </row>
+ <row>
+ <entry morerows="3"><systemitem>CreatePixmap</systemitem></entry>
+ <entry><function>XCreatePixmap</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreateBitmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreatePixmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XReadBitmapFile</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>CreateWindow</systemitem></entry>
+ <entry><function>XCreateSimpleWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreateWindow</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>DeleteProperty</systemitem></entry>
+ <entry><function>XDeleteProperty</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>DestroySubwindows</systemitem></entry>
+ <entry><function>XDestroySubwindows</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>DestroyWindow</systemitem></entry>
+ <entry><function>XDestroyWindow</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>FillPoly</systemitem></entry>
+ <entry><function>XFillPolygon</function></entry>
+ </row>
+ <row>
+ <entry morerows="2"><systemitem>ForceScreenSaver</systemitem></entry>
+ <entry><function>XActivateScreenSaver</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XForceScreenSaver</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XResetScreenSaver</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>FreeColormap</systemitem></entry>
+ <entry><function>XFreeColormap</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>FreeColors</systemitem></entry>
+ <entry><function>XFreeColors</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>FreeCursor</systemitem></entry>
+ <entry><function>XFreeCursor</function></entry>
+ </row>
+ <row>
+ <entry morerows="3"><systemitem>FreeGC</systemitem></entry>
+ <entry><function>XFreeGC</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreateBitmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreatePixmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XReadBitmapFile</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>FreePixmap</systemitem></entry>
+ <entry><function>XFreePixmap</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetAtomName</systemitem></entry>
+ <entry><function>XGetAtomName</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetFontPath</systemitem></entry>
+ <entry><function>XGetFontPath</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>GetGeometry</systemitem></entry>
+ <entry><function>XGetGeometry</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWindowAttributes</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetImage</systemitem></entry>
+ <entry><function>XGetImage</function></entry>
+ </row>
+ <row>
+ <entry morerows="2"><systemitem>GetInputFocus</systemitem></entry>
+ <entry><function>XGetInputFocus</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSync</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSynchronize</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetKeyboardControl</systemitem></entry>
+ <entry><function>XGetKeyboardControl</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetKeyboardMapping</systemitem></entry>
+ <entry><function>XGetKeyboardMapping</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetModifierMapping</systemitem></entry>
+ <entry><function>XGetModifierMapping</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetMotionEvents</systemitem></entry>
+ <entry><function>XGetMotionEvents</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetPointerControl</systemitem></entry>
+ <entry><function>XGetPointerControl</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetPointerMapping</systemitem></entry>
+ <entry><function>XGetPointerMapping</function></entry>
+ </row>
+ <row>
+ <entry morerows="19"><systemitem>GetProperty</systemitem></entry>
+ <entry><function>XFetchBytes</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XFetchName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetClassHint</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetIconName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetIconSizes</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetNormalHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetRGBColormaps</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetSizeHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetTextProperty</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetTransientForHint</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMClientMachine</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMColormapWindows</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMIconName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMName</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMNormalHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMProtocols</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMSizeHints</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWindowProperty</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetZoomHints</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetSelectionOwner</systemitem></entry>
+ <entry><function>XGetSelectionOwner</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GetWindowAttributes</systemitem></entry>
+ <entry><function>XGetWindowAttributes</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GrabButton</systemitem></entry>
+ <entry><function>XGrabButton</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GrabKey</systemitem></entry>
+ <entry><function>XGrabKey</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GrabKeyboard</systemitem></entry>
+ <entry><function>XGrabKeyboard</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GrabPointer</systemitem></entry>
+ <entry><function>XGrabPointer</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>GrabServer</systemitem></entry>
+ <entry><function>XGrabServer</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ImageText8</systemitem></entry>
+ <entry><function>XDrawImageString</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ImageText16</systemitem></entry>
+ <entry><function>XDrawImageString16</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>InstallColormap</systemitem></entry>
+ <entry><function>XInstallColormap</function></entry>
+ </row>
+ <row>
+ <entry morerows="5"><systemitem>InternAtom</systemitem></entry>
+ <entry><function>XGetWMColormapWindows</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XGetWMProtocols</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XIconifyWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XInternAtom</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMColormapWindows</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetWMProtocols</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>KillClient</systemitem></entry>
+ <entry><function>XKillClient</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ListExtensions</systemitem></entry>
+ <entry><function>XListExtensions</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ListFonts</systemitem></entry>
+ <entry><function>XListFonts</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ListFontsWithInfo</systemitem></entry>
+ <entry><function>XListFontsWithInfo</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ListHosts</systemitem></entry>
+ <entry><function>XListHosts</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ListInstalledColormaps</systemitem></entry>
+ <entry><function>XListInstalledColormaps</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ListProperties</systemitem></entry>
+ <entry><function>XListProperties</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>LookupColor</systemitem></entry>
+ <entry><function>XLookupColor</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XParseColor</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>MapSubwindows</systemitem></entry>
+ <entry><function>XMapSubwindows</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>MapWindow</systemitem></entry>
+ <entry><function>XMapRaised</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XMapWindow</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>NoOperation</systemitem></entry>
+ <entry><function>XNoOp</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>OpenFont</systemitem></entry>
+ <entry><function>XLoadFont</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XLoadQueryFont</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyArc</systemitem></entry>
+ <entry><function>XDrawArc</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDrawArcs</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyFillArc</systemitem></entry>
+ <entry><function>XFillArc</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XFillArcs</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyFillRectangle</systemitem></entry>
+ <entry><function>XFillRectangle</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XFillRectangles</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>PolyLine</systemitem></entry>
+ <entry><function>XDrawLines</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyPoint</systemitem></entry>
+ <entry><function>XDrawPoint</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDrawPoints</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyRectangle</systemitem></entry>
+ <entry><function>XDrawRectangle</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDrawRectangles</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolySegment</systemitem></entry>
+ <entry><function>XDrawLine</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDrawSegments</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyText8</systemitem></entry>
+ <entry><function>XDrawString</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDrawText</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>PolyText16</systemitem></entry>
+ <entry><function>XDrawString16</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XDrawText16</function></entry>
+ </row>
+ <row>
+ <entry morerows="3"><systemitem>PutImage</systemitem></entry>
+ <entry><function>XPutImage</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreateBitmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XCreatePixmapFromData</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XReadBitmapFile</function></entry>
+ </row>
+ <row>
+ <entry morerows="3"><systemitem>QueryBestSize</systemitem></entry>
+ <entry><function>XQueryBestCursor</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryBestSize</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryBestStipple</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryBestTile</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>QueryColors</systemitem></entry>
+ <entry><function>XQueryColor</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryColors</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>QueryExtension</systemitem></entry>
+ <entry><function>XInitExtension</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryExtension</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>QueryFont</systemitem></entry>
+ <entry><function>XLoadQueryFont</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryFont</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>QueryKeymap</systemitem></entry>
+ <entry><function>XQueryKeymap</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>QueryPointer</systemitem></entry>
+ <entry><function>XQueryPointer</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>QueryTextExtents</systemitem></entry>
+ <entry><function>XQueryTextExtents</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XQueryTextExtents16</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>QueryTree</systemitem></entry>
+ <entry><function>XQueryTree</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>RecolorCursor</systemitem></entry>
+ <entry><function>XRecolorCursor</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>ReparentWindow</systemitem></entry>
+ <entry><function>XReparentWindow</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>RotateProperties</systemitem></entry>
+ <entry><function>XRotateBuffers</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XRotateWindowProperties</function></entry>
+ </row>
+ <row>
+ <entry morerows="3"><systemitem>SendEvent</systemitem></entry>
+ <entry><function>XIconifyWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XReconfigureWMWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSendEvent</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XWithdrawWindow</function></entry>
+ </row>
+ <row>
+ <entry morerows="2"><systemitem>SetAccessControl</systemitem></entry>
+ <entry><function>XDisableAccessControl</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XEnableAccessControl</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetAccessControl</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetClipRectangles</systemitem></entry>
+ <entry><function>XSetClipRectangles</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetCloseDownMode</systemitem></entry>
+ <entry><function>XSetCloseDownMode</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetDashes</systemitem></entry>
+ <entry><function>XSetDashes</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetFontPath</systemitem></entry>
+ <entry><function>XSetFontPath</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetInputFocus</systemitem></entry>
+ <entry><function>XSetInputFocus</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetModifierMapping</systemitem></entry>
+ <entry><function>XSetModifierMapping</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetPointerMapping</systemitem></entry>
+ <entry><function>XSetPointerMapping</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>SetScreenSaver</systemitem></entry>
+ <entry><function>XGetScreenSaver</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XSetScreenSaver</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>SetSelectionOwner</systemitem></entry>
+ <entry><function>XSetSelectionOwner</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>StoreColors</systemitem></entry>
+ <entry><function>XStoreColor</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XStoreColors</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>StoreNamedColor</systemitem></entry>
+ <entry><function>XStoreNamedColor</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>TranslateCoordinates</systemitem></entry>
+ <entry><function>XTranslateCoordinates</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UngrabButton</systemitem></entry>
+ <entry><function>XUngrabButton</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UngrabKey</systemitem></entry>
+ <entry><function>XUngrabKey</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UngrabKeyboard</systemitem></entry>
+ <entry><function>XUngrabKeyboard</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UngrabPointer</systemitem></entry>
+ <entry><function>XUngrabPointer</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UngrabServer</systemitem></entry>
+ <entry><function>XUngrabServer</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UninstallColormap</systemitem></entry>
+ <entry><function>XUninstallColormap</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>UnmapSubwindows</systemitem></entry>
+ <entry><function>XUnmapSubWindows</function></entry>
+ </row>
+ <row>
+ <entry morerows="1"><systemitem>UnmapWindow</systemitem></entry>
+ <entry><function>XUnmapWindow</function></entry>
+ </row>
+ <row>
+
+ <entry><function>XWithdrawWindow</function></entry>
+ </row>
+ <row>
+ <entry><systemitem>WarpPointer</systemitem></entry>
+ <entry><function>XWarpPointer</function></entry>
+ </row>
+ </tbody>
+ </tgroup>
+</table>
</appendix>
diff --git a/libX11/specs/libX11/AppC.xml b/libX11/specs/libX11/AppC.xml index 4af2de3fd..69838dc8b 100644 --- a/libX11/specs/libX11/AppC.xml +++ b/libX11/specs/libX11/AppC.xml @@ -47,7 +47,7 @@ and <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XQueryExtension</function></funcdef>
+ <funcdef>Bool <function>XQueryExtension</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *name</parameter></paramdef>
<paramdef>int<parameter> *major_opcode_return</parameter></paramdef>
@@ -98,9 +98,9 @@ function determines if the named extension is present. If the extension is not present,
<function>XQueryExtension</function>
returns
-<function>False</function>;
+<symbol>False</symbol>;
otherwise, it returns
-<function>True</function>.
+<symbol>True</symbol>.
If the extension is present,
<function>XQueryExtension</function>
returns the major opcode for the extension to major_opcode_return;
@@ -132,7 +132,7 @@ are all considered different names. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> **XListExtensions</function></funcdef>
+ <funcdef>char **<function>XListExtensions</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> *nextensions_return</parameter></paramdef>
</funcprototype>
@@ -165,7 +165,7 @@ Returns the number of extensions listed. <!-- .LP -->
<!-- .eM -->
The
-<function>XListExtensions </function>
+<function>XListExtensions</function>
function returns a list of all extensions supported by the server.
If the data returned by the server is in the Latin Portable Character Encoding,
then the returned strings are in the Host Portable Character Encoding.
@@ -174,7 +174,7 @@ Otherwise, the result is implementation-dependent. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeExtensionList</function></funcdef>
+ <funcdef><function>XFreeExtensionList</function></funcdef>
<paramdef>char<parameter> **list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -216,7 +216,7 @@ called stubs. In extensions, stubs first should check to see if they have initialized
themselves on a connection.
If they have not, they then should call
-<function>XInitExtension </function>
+<function>XInitExtension</function>
to attempt to initialize themselves on the connection.
</para>
<para>
@@ -229,9 +229,9 @@ called when these events occur. <para>
<!-- .LP -->
The
-<function>XExtCodes</function>
+<structname>XExtCodes</structname>
structure returns the information from
-<function>XInitExtension </function>
+<function>XInitExtension</function>
and is defined in
<X11/Xlib.h> :
</para>
@@ -257,7 +257,7 @@ typedef struct _XExtCodes { /* public to extension, cannot be changed */ <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XExtCodes<function> *XInitExtension</function></funcdef>
+ <funcdef>XExtCodes *<function>XInitExtension</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *name</parameter></paramdef>
</funcprototype>
@@ -312,7 +312,7 @@ are all considered different names. <para>
<!-- .LP -->
The extension number in the
-<function>XExtCodes </function>
+<structname>XExtCodes</structname>
structure is
needed in the other calls that follow.
This extension number is unique only to a single connection.
@@ -323,7 +323,7 @@ This extension number is unique only to a single connection. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XExtCodes<function> *XAddExtension</function></funcdef>
+ <funcdef>XExtCodes *<function>XAddExtension</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -347,7 +347,7 @@ Specifies the connection to the X server. For local Xlib extensions, the
<function>XAddExtension</function>
function allocates the
-<function>XExtCodes</function>
+<structname>XExtCodes</structname>
structure, bumps the extension number count,
and chains the extension onto the extension list.
(This permits extensions to Xlib without requiring server extensions.)
@@ -371,7 +371,7 @@ extension. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XESetCloseDisplay</function></funcdef>
+ <funcdef>int <function>XESetCloseDisplay</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -417,14 +417,14 @@ Specifies the procedure to call when the display is closed. The
<function>XESetCloseDisplay</function>
function defines a procedure to be called whenever
-<function>XCloseDisplay </function>
+<function>XCloseDisplay</function>
is called.
It returns any previously defined procedure, usually NULL.
</para>
<para>
<!-- .LP -->
When
-<function>XCloseDisplay </function>
+<function>XCloseDisplay</function>
is called,
your procedure is called
with these arguments:
@@ -439,7 +439,7 @@ with these arguments: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetCreateGC</function></funcdef>
+ <funcdef>int *<function>XESetCreateGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -507,7 +507,7 @@ your procedure is called with these arguments: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetCopyGC</function></funcdef>
+ <funcdef>int *<function>XESetCopyGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -568,7 +568,7 @@ your procedure is called with these arguments: </literallayout>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> *XESetFreeGC</function></funcdef>
+ <funcdef>int *<function>XESetFreeGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -640,7 +640,7 @@ your procedure is called with these arguments: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetCreateFont</function></funcdef>
+ <funcdef>int *<function>XESetCreateFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -686,7 +686,7 @@ Specifies the procedure to call when a font is created. The
<function>XESetCreateFont</function>
function defines a procedure to be called whenever
-<function>XLoadQueryFont </function>
+<function>XLoadQueryFont</function>
and
<function>XQueryFont</function>
are called.
@@ -695,7 +695,7 @@ It returns any previously defined procedure, usually NULL. <para>
<!-- .LP -->
When
-<function>XLoadQueryFont </function>
+<function>XLoadQueryFont</function>
or
<function>XQueryFont</function>
is called,
@@ -721,7 +721,7 @@ your procedure is called with these arguments: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetFreeFont</function></funcdef>
+ <funcdef>int *<function>XESetFreeFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -767,14 +767,14 @@ Specifies the procedure to call when a font is freed. The
<function>XESetFreeFont</function>
function defines a procedure to be called whenever
-<function>XFreeFont </function>
+<function>XFreeFont</function>
is called.
It returns any previously defined procedure, usually NULL.
</para>
<para>
<!-- .LP -->
When
-<function>XFreeFont </function>
+<function>XFreeFont</function>
is called, your procedure is called with these arguments:
</para>
<para>
@@ -799,19 +799,19 @@ and <function>XESetEventToWire</function>
functions allow you to define new events to the library.
An
-<function>XEvent</function>
+<structname>XEvent</structname>
structure always has a type code (type
-<function>int</function>)
+<type>int</type>)
as the first component.
This uniquely identifies what kind of event it is.
The second component is always the serial number (type
-<function>unsigned</function>
-<function>long</function>)
+<type>unsigned</type>
+<type>long</type>)
of the last request processed by the server.
The third component is always a Boolean (type
-<function>Bool</function>)
+<type>Bool</type>)
indicating whether the event came from a
-<function>SendEvent</function>
+<systemitem>SendEvent</systemitem>
protocol request.
The fourth component is always a pointer to the display
the event was read from.
@@ -824,7 +824,7 @@ from the protocol to put in this component, initialize it to zero. <!-- .NT -->
There is an implementation limit such that your host event
structure size cannot be bigger than the size of the
-<function>XEvent </function>
+<structname>XEvent</structname>
union of structures.
There also is no way to guarantee that more than 24 elements or 96 characters
in the structure will be fully portable between machines.
@@ -833,7 +833,7 @@ in the structure will be fully portable between machines. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetWireToEvent</function></funcdef>
+ <funcdef>int *<function>XESetWireToEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> event_number</parameter></paramdef>
<paramdef>Status<parameter> (*proc)()</parameter></paramdef>
@@ -880,9 +880,9 @@ The <function>XESetWireToEvent</function>
function defines a procedure to be called when an event
needs to be converted from wire format
-(<function>xEvent</function>)
+(<structname>xEvent</structname>)
to host format
-(<function>XEvent</function>).
+(<structname>XEvent</structname>).
The event number defines which protocol event number to install a
conversion procedure for.
<function>XESetWireToEvent</function>
@@ -916,21 +916,21 @@ Your procedure must return status to indicate if the conversion succeeded. The re argument is a pointer to where the host format event should be stored,
and the event argument is the 32-byte wire event structure.
In the
-<function>XEvent </function>
+<structname>XEvent</structname>
structure you are creating,
you must fill in the five required members of the event structure.
You should fill in the type member with the type specified for the
-<function>xEvent </function>
+<structname>xEvent</structname>
structure.
You should copy all other members from the
-<function>xEvent </function>
+<structname>xEvent</structname>
structure (wire format) to the
-<function>XEvent </function>
+<structname>XEvent</structname>
structure (host format).
Your conversion procedure should return
-<function>True</function>
+<symbol>True</symbol>
if the event should be placed in the queue or
-<function>False</function>
+<symbol>False</symbol>
if it should not be placed in the queue.
</para>
<para>
@@ -945,7 +945,7 @@ with the event and use the return value. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long<function> _XSetLastRequestRead</function></funcdef>
+ <funcdef>unsigned long<function>_XSetLastRequestRead</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>xGenericReply<parameter> *rep</parameter></paramdef>
</funcprototype>
@@ -989,7 +989,7 @@ serial number in the event. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> *XESetEventToWire</function></funcdef>
+ <funcdef>Status *<function>XESetEventToWire</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> event_number</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -1036,9 +1036,9 @@ The <function>XESetEventToWire</function>
function defines a procedure to be called when an event
needs to be converted from host format
-(<function>XEvent</function>)
+(<structname>XEvent</structname>)
to wire format
-(<function>xEvent</function>)
+(<structname>xEvent</structname>)
form.
The event number defines which protocol event number to install a
conversion procedure for.
@@ -1074,16 +1074,16 @@ The re argument is a pointer to the host format event, and the event argument is a pointer to where the 32-byte wire event
structure should be stored.
You should fill in the type with the type from the
-<function>XEvent </function>
+<structname>XEvent</structname>
structure.
All other members then should be copied from the host format to the
-<function>xEvent </function>
+<structname>xEvent</structname>
structure.
<indexterm significance="preferred"><primary>XESetWireToError</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> *XESetWireToError</function></funcdef>
+ <funcdef>Bool *<function>XESetWireToError</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> error_number</parameter></paramdef>
<paramdef>Bool<parameter> (*proc)()</parameter></paramdef>
@@ -1165,22 +1165,22 @@ Bool (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasi <!-- .eM -->
The he argument is a pointer to where the host format error should be stored.
The structure pointed at by he is guaranteed to be as large as an
-<function>XEvent</function>
+<structname>XEvent</structname>
structure and so can be cast to a type larger than an
-<function>XErrorEvent</function>
+<structname>XErrorEvent</structname>
to store additional values.
If the error is to be completely ignored by Xlib
(for example, several protocol error structures will be combined into
one Xlib error),
then the function should return
-<function>False</function>;
+<symbol>False</symbol>;
otherwise, it should return
-<function>True</function>.
+<symbol>True</symbol>.
<indexterm significance="preferred"><primary>XESetError</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetError</function></funcdef>
+ <funcdef>int *<function>XESetError</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> (*proc)()</parameter></paramdef>
@@ -1255,7 +1255,7 @@ int (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis The err argument is a pointer to the 32-byte wire format error.
The codes argument is a pointer to the extension codes structure.
The ret_code argument is the return code you may want
-<function>_XReply </function>
+<function>_XReply</function>
returned to.
</para>
<para>
@@ -1266,13 +1266,13 @@ the client's error handler is called. (For further information, see section 11.8.2.)
If your procedure returns nonzero,
the error is suppressed, and
-<function>_XReply </function>
+<function>_XReply</function>
returns the value of ret_code.
<indexterm significance="preferred"><primary>XESetErrorString</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XESetErrorString</function></funcdef>
+ <funcdef>char *<function>XESetErrorString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>char<parameter> *(*proc)()</parameter></paramdef>
@@ -1316,7 +1316,7 @@ Specifies the procedure to call to obtain an error string. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetErrorText </function>
+<function>XGetErrorText</function>
function returns a string to the user for an error.
<function>XESetErrorString</function>
allows you to define a procedure to be called that
@@ -1348,7 +1348,7 @@ error message into buffer. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> *XESSetPrintErrorValues</function></funcdef>
+ <funcdef>void *<function>XESetPrintErrorValues</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>void<parameter> (*proc)()</parameter></paramdef>
@@ -1421,9 +1421,9 @@ void (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasi <!-- .LP -->
<!-- .eM -->
The structure pointed at by ev is guaranteed to be as large as an
-<function>XEvent</function>
+<structname>XEvent</structname>
structure and so can be cast to a type larger than an
-<function>XErrorEvent</function>
+<structname>XErrorEvent</structname>
to obtain additional values set by using
<function>XESetWireToError</function>.
The underlying type of the fp argument is system dependent;
@@ -1432,7 +1432,7 @@ on a <acronym>POSIX</acronym>-compliant system, fp should be cast to type FILE*. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetFlushGC</function></funcdef>
+ <funcdef>int *<function>XESetFlushGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> *(*proc)()</parameter></paramdef>
@@ -1484,7 +1484,7 @@ function, but is called when a GC cache needs to be updated in the server. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XESetCopyGC</function></funcdef>
+ <funcdef>int *<function>XESetCopyGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> extension</parameter></paramdef>
<paramdef>int<parameter> *(*proc)()</parameter></paramdef>
@@ -1562,13 +1562,13 @@ Hooks onto Xlib Data Structures Various Xlib data structures have provisions for extension procedures
to chain extension supplied data onto a list.
These structures are
-<function>GC</function>,
-<function>Visual</function>,
-<function>Screen</function>,
-<function>ScreenFormat</function>,
-<function>Display</function>,
+<structname>GC</structname>,
+<structname>Visual</structname>,
+<type>Screen</type>,
+<structname>ScreenFormat</structname>,
+<type>Display</type>,
and
-<function>XFontStruct</function>.
+<structname>XFontStruct</structname>.
Because the list pointer is always the first member in the structure,
a single set of procedures can be used to manipulate the data
on these lists.
@@ -1624,7 +1624,7 @@ union { Display *display; <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XExtData<function> **XEHeadOfExtensionList</function></funcdef>
+ <funcdef>XExtData **<function>XEHeadOfExtensionList</function></funcdef>
<paramdef>XEDataObject<parameter> object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1654,7 +1654,7 @@ In concert with <function>XEHeadOfExtensionList</function>
allows an extension to attach arbitrary data to any of the structures
of types contained in
-<function>XEDataObject</function>.
+<structname>XEDataObject</structname>.
</para>
<para>
<!-- .LP -->
@@ -1662,7 +1662,7 @@ of types contained in <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAddToExtensionList</function></funcdef>
+ <funcdef><function>XAddToExtensionList</function></funcdef>
<paramdef>XExtData<parameter> **structure</parameter></paramdef>
<paramdef>XExtData<parameter> *ext_data</parameter></paramdef>
</funcprototype>
@@ -1702,7 +1702,7 @@ before calling this function. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XExtData<function> *XFindOnExtensionList</function></funcdef>
+ <funcdef>XExtData *<function>XFindOnExtensionList</function></funcdef>
<paramdef>struct_XExtData<parameter> **structure</parameter></paramdef>
<paramdef>int<parameter> number</parameter></paramdef>
</funcprototype>
@@ -1746,14 +1746,14 @@ There is no way to find additional structures. <para>
<!-- .LP -->
The
-<function>XAllocID </function>
+<function>XAllocID</function>
macro, which allocates and returns a resource ID, is defined in
<X11/Xlib.h>.
<indexterm significance="preferred"><primary>XAllocID</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAllocID</function></funcdef>
+ <funcdef><function>XAllocID</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1775,7 +1775,7 @@ Specifies the connection to the X server. <!-- .LP -->
<!-- .eM -->
This macro is a call through the
-<function>Display</function>
+<type>Display</type>
structure to an internal resource ID allocator.
It returns a resource ID that you can use when creating new resources.
</para>
@@ -1788,7 +1788,7 @@ macro allocates and returns an array of resource ID. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAllocIDs</function></funcdef>
+ <funcdef><function>XAllocIDs</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> *ids_return</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -1832,7 +1832,7 @@ Specifies the number of resource IDs requested. <!-- .LP -->
<!-- .eM -->
This macro is a call through the
-<function>Display</function>
+<type>Display</type>
structure to an internal resource ID allocator.
It returns resource IDs to the array supplied by the caller.
To correctly handle automatic reuse of resource IDs, you must call
@@ -1856,7 +1856,7 @@ in its GC. The
<function>FlushGC</function>
macro checks the dirty bits in the library's GC structure and calls
-<function>_XFlushGCCache </function>
+<function>_XFlushGCCache</function>
if any elements have changed.
The
<function>FlushGC</function>
@@ -1865,7 +1865,7 @@ macro is defined as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> FlushGC</function></funcdef>
+ <funcdef><function>FlushGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
</funcprototype>
@@ -1904,18 +1904,18 @@ using it, so if you only stored the value in the cache without forcing a protocol request, the resource might be destroyed before being
set into the GC.
You can use the
-<function>_XFlushGCCache </function>
+<function>_XFlushGCCache</function>
procedure
to force the cache to be flushed.
The
-<function>_XFlushGCCache </function>
+<function>_XFlushGCCache</function>
procedure
is defined as follows:
<indexterm significance="preferred"><primary>_XFlushGCCache</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> _XFlushGCCache</function></funcdef>
+ <funcdef><function>_XFlushGCCache</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
</funcprototype>
@@ -1958,7 +1958,7 @@ single calls to be transformed into poly requests. This may dramatically improve performance of programs that are not
written using poly requests.
A pointer to an
-<function>xReq</function>,
+<structname>xReq</structname>,
called last_req in the display structure, is the last request being processed.
By checking that the last request
type, drawable, gc, and other options are the same as the new one
@@ -1967,7 +1967,7 @@ to just extend the previous graphics request by extending the length field of the request and appending the data to the buffer.
This can improve performance by five times or more in naive programs.
For example, here is the source for the
-<function>XDrawPoint </function>
+<function>XDrawPoint</function>
stub.
(Writing extension stubs is discussed in the next section.)
</para>
@@ -2034,7 +2034,7 @@ there is a symbol defined in of EPERBATCH on the number of requests batched.
Most of the performance benefit occurs in the first few merged requests.
Note that
-<function>FlushGC </function>
+<function>FlushGC</function>
is called <emphasis remap='I'>before</emphasis> picking up the value of last_req,
because it may modify this field.
<!-- .SH -->
@@ -2110,7 +2110,7 @@ The length field in a request must equal the minimum length required to contain the request.
If the specified length is smaller or larger than the required length,
the server should generate a
-<function>BadLength </function>
+<errorname>BadLength</errorname>
error.
Unused bytes in a request are not required to be zero.
Extensions should be designed in such a way that long protocol requests
@@ -2133,9 +2133,9 @@ used in replies, errors, and events. <para>
<!-- .LP -->
To help but not cure portability problems to certain machines, the
-<function>B16</function>
+<symbol>B16</symbol>
and
-<function>B32</function>
+<symbol>B32</symbol>
macros have been defined so that they can become bitfield specifications
on some machines.
For example, on a Cray,
@@ -2170,20 +2170,20 @@ typedef struct _DoSomethingReq { If a core protocol request has a single 32-bit argument,
you need not declare a request structure in your extension header file.
Instead, such requests use the
-<function>xResourceReq</function>
+<structname>xResourceReq</structname>
structure in
<X11/Xproto.h>.
This structure is used for any request whose single argument is a
-<function>Window</function>,
-<function>Pixmap</function>,
-<function>Drawable</function>,
-<function>GContext</function>,
-<function>Font</function>,
-<function>Cursor</function>,
-<function>Colormap</function>,
-<function>Atom</function>,
+<type>Window</type>,
+<type>Pixmap</type>,
+<type>Drawable</type>,
+<type>GContext</type>,
+<type>Font</type>,
+<type>Cursor</type>,
+<type>Colormap</type>,
+<type>Atom</type>,
or
-<function>VisualID</function>.
+<type>VisualID</type>.
</para>
<para>
<!-- .LP -->
@@ -2223,7 +2223,7 @@ but all requests are padded to be multiples of four bytes long. <!-- .LP -->
A few protocol requests take no arguments at all.
Instead, they use the
-<function>xReq </function>
+<structname>xReq</structname>
structure in
<X11/Xproto.h>,
which contains only a reqType and a length (and a pad byte).
@@ -2280,11 +2280,11 @@ The reply structure is longer than 32 bytes. <para>
<!-- .LP -->
Only
-<function>GetWindowAttributes</function>,
-<function>QueryFont</function>,
-<function>QueryKeymap</function>,
+<systemitem>GetWindowAttributesl</systemitem>,
+<systemitem>QueryFont</systemitem>,
+<systemitem>QueryKeymap</systemitem>,
and
-<function>GetKeyboardControl </function>
+<systemitem>GetKeyboardControl</systemitem>
have reply structures longer than 32 bytes in the core protocol.
</para>
<para>
@@ -2293,7 +2293,7 @@ A few protocol requests return replies that contain no data. <X11/Xproto.h>
does not define reply structures for these.
Instead, they use the
-<function>xGenericReply</function>
+<structname>xGenericReply</structname>
structure, which contains only a type, length,
and sequence number (and sufficient padding to make it 32 bytes long).
<!-- .SH -->
@@ -2343,7 +2343,7 @@ Two calls, which are generally implemented as macros, have been provided. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> LockDisplay</function></funcdef>
+ <funcdef><function>LockDisplay</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2354,7 +2354,7 @@ Two calls, which are generally implemented as macros, have been provided. <indexterm significance="preferred"><primary>UnlockDisplay</primary></indexterm>
<funcsynopsis>
<funcprototype>
- <funcdef><function> UnlockDisplay</function></funcdef>
+ <funcdef><function>UnlockDisplay</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2393,7 +2393,7 @@ the name of the protocol request as declared in <X11/Xproto.h>
except with X_ removed.
Each one declares a
-<function>Display </function>
+<type>Display</type>
structure pointer,
called dpy, and a pointer to a request structure, called req,
which is of the appropriate type.
@@ -2413,15 +2413,15 @@ then use GetEmptyReq (DoSomething, req);
</literallayout>
If the protocol request has a single 32-bit argument (such as a
-<function>Pixmap</function>,
-<function>Window</function>,
-<function>Drawable</function>,
-<function>Atom</function>,
+<type>Pixmap</type>,
+<type>Window</type>,
+<type>Drawable</type>,
+<type>Atom</type>,
and so on),
then use
<function>GetResReq</function>.
The second argument to the macro is the 32-bit object.
-<function>X_MapWindow </function>
+<symbol>X_MapWindow</symbol>
is a good example.
</para>
<para>
@@ -2431,8 +2431,8 @@ is a good example. GetResReq (DoSomething, rid, req);
</literallayout>
The rid argument is the
-<function>Pixmap</function>,
-<function>Window</function>,
+<type>Pixmap</type>,
+<type>Window</type>,
or other resource ID.
</para>
<para>
@@ -2456,13 +2456,13 @@ req->arg2 = arg2; ...
</literallayout>
A few stub procedures (such as
-<function>XCreateGC </function>
+<function>XCreateGC</function>
and
<function>XCreatePixmap</function>)
return a resource ID to the caller but pass a resource ID as an argument
to the protocol request.
Such procedures use the macro
-<function>XAllocID </function>
+<function>XAllocID</function>
to allocate a resource ID from the range of IDs
that were assigned to this client when it opened the connection.
</para>
@@ -2477,11 +2477,11 @@ return (rid); Finally, some stub procedures transmit a fixed amount of variable-length
data after the request.
Typically, these procedures (such as
-<function>XMoveWindow </function>
+<function>XMoveWindow</function>
and
<function>XSetBackground</function>)
are special cases of more general functions like
-<function>XMoveResizeWindow </function>
+<function>XMoveResizeWindow</function>
and
<function>XChangeGC</function>.
These procedures use
@@ -2498,7 +2498,7 @@ Variable Length Arguments <!-- .LP -->
Some protocol requests take additional variable-length data that
follow the
-<function>xDoSomethingReq </function>
+<type>xDoSomethingReq</type>
structure.
The format of this data varies from request to request.
Some requests require a sequence of 8-bit bytes,
@@ -2520,25 +2520,25 @@ then you must round the length up and shift it before adding: req->length += (nbytes+3)>>2;
</literallayout>
To transmit variable-length data, use the
-<function>Data </function>
+<function>Data</function>
macros.
If the data fits into the output buffer,
then this macro copies it to the buffer.
If it does not fit, however,
the
-<function>Data </function>
+<function>Data</function>
macro calls
<function>_XSend</function>,
which transmits first the contents of the buffer and then your data.
The
-<function>Data </function>
+<function>Data</function>
macros take three arguments:
the display, a pointer to the beginning of the data,
and the number of bytes to be sent.
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> Data</function></funcdef>
+ <funcdef><function>Data</function></funcdef>
<paramdef><parameter> display</parameter></paramdef>
<paramdef>(char<parameter> *</parameter></paramdef>
</funcprototype>
@@ -2563,11 +2563,11 @@ Use the appropriate macro when sending byte, short, or long data. <!-- .LP -->
If the protocol request requires a reply,
then call the procedure
-<function>_XSend </function>
+<function>_XSend</function>
instead of the
-<function>Data </function>
+<function>Data</function>
macro.
-<function>_XSend </function>
+<function>_XSend</function>
takes the same arguments, but because it sends your data immediately instead of
copying it into the output buffer (which would later be flushed
anyway by the following call on
@@ -2580,21 +2580,21 @@ Replies <!-- .LP -->
If the protocol request has a reply,
then call
-<function>_XReply </function>
+<function>_XReply</function>
after you have finished dealing with
all the fixed-length and variable-length arguments.
-<function>_XReply </function>
+<function>_XReply</function>
flushes the output buffer and waits for an
-<function>xReply </function>
+<structname>xReply</structname>
packet to arrive.
If any events arrive in the meantime,
-<function>_XReply </function>
+<function>_XReply</function>
places them in the queue for later use.
<indexterm significance="preferred"><primary>_XReply</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> _XReply</function></funcdef>
+ <funcdef>Status <function>_XReply</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>xReply<parameter> *rep</parameter></paramdef>
<paramdef>int<parameter> extra</parameter></paramdef>
@@ -2650,26 +2650,26 @@ should be discarded. <!-- .LP -->
<!-- .eM -->
The
-<function>_XReply </function>
+<function>_XReply</function>
function waits for a reply packet and copies its contents into the
specified rep.
-<function>_XReply </function>
+<function>_XReply</function>
handles error and event packets that occur before the reply is received.
-<function>_XReply </function>
+<function>_XReply</function>
takes four arguments:
</para>
<itemizedlist>
<listitem>
<para>
A
-<function>Display </function>
+<type>Display</type>
* structure
</para>
</listitem>
<listitem>
<para>
A pointer to a reply structure (which must be cast to an
-<function>xReply </function>
+<structname>xReply</structname>
*)
</para>
</listitem>
@@ -2684,7 +2684,7 @@ in the reply structure <listitem>
<para>
A Boolean that indicates whether
-<function>_XReply </function>
+<function>_XReply</function>
is to discard any additional bytes
beyond those it was told to read
</para>
@@ -2695,38 +2695,38 @@ beyond those it was told to read Because most reply structures are 32 bytes long,
the third argument is usually 0.
The only core protocol exceptions are the replies to
-<function>GetWindowAttributes</function>,
-<function>QueryFont</function>,
-<function>QueryKeymap</function>,
+<systemitem>GetWindowAttributesl</systemitem>,
+<systemitem>QueryFont</systemitem>,
+<systemitem>QueryKeymap</systemitem>,
and
-<function>GetKeyboardControl</function>,
+<systemitem>GetKeyboardControl</systemitem>,
which have longer replies.
</para>
<para>
<!-- .LP -->
The last argument should be
-<function>False </function>
+<symbol>False</symbol>
if the reply structure is followed
by additional variable-length data (such as a list or string).
It should be
-<function>True </function>
+<symbol>True</symbol>
if there is not any variable-length data.
<!-- .NT -->
This last argument is provided for upward-compatibility reasons
to allow a client to communicate properly with a hypothetical later
version of the server that sends more data than the client expected.
For example, some later version of
-<function>GetWindowAttributes </function>
+<systemitem>GetWindowAttributesl</systemitem>
might use a
larger, but compatible,
-<function>xGetWindowAttributesReply </function>
+<structname>xGetWindowAttributesReply</structname>
that contains additional attribute data at the end.
<!-- .NE -->
-<function>_XReply </function>
+<function>_XReply</function>
returns
-<function>True</function>
+<symbol>True</symbol>
if it received a reply successfully or
-<function>False </function>
+<symbol>False</symbol>
if it received any sort of error.
</para>
<para>
@@ -2750,11 +2750,11 @@ return (rep.ret4); </literallayout>
If there is variable-length data after the reply,
change the
-<function>True </function>
+<symbol>True</symbol>
to
-<function>False</function>,
+<symbol>False</symbol>,
and use the appropriate
-<function>_XRead </function>
+<function>_XRead</function>
function to read the variable-length data.
</para>
<para>
@@ -2762,7 +2762,7 @@ function to read the variable-length data. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> _XRead</function></funcdef>
+ <funcdef><function>_XRead</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *data_return</parameter></paramdef>
<paramdef>long<parameter> nbytes</parameter></paramdef>
@@ -2814,7 +2814,7 @@ function reads the specified number of bytes into data_return. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> _XRead16</function></funcdef>
+ <funcdef><function>_XRead16</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>short<parameter> *data_return</parameter></paramdef>
<paramdef>long<parameter> nbytes</parameter></paramdef>
@@ -2868,7 +2868,7 @@ into the specified array as shorts. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> _XRead32</function></funcdef>
+ <funcdef><function>_XRead32</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>long<parameter> *data_return</parameter></paramdef>
<paramdef>long<parameter> nbytes</parameter></paramdef>
@@ -2922,7 +2922,7 @@ into the specified array as longs. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> _XRead16Pad</function></funcdef>
+ <funcdef><function>_XRead16Pad</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>short<parameter> *data_return</parameter></paramdef>
<paramdef>long<parameter> nbytes</parameter></paramdef>
@@ -2979,7 +2979,7 @@ reads and discards up to two additional pad bytes. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> _XReadPad</function></funcdef>
+ <funcdef><function>_XReadPad</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *data_return</parameter></paramdef>
<paramdef>long<parameter> nbytes</parameter></paramdef>
@@ -3041,7 +3041,7 @@ Synchronous Calling <!-- .LP -->
Each procedure should have a call, just before returning to the user,
to a macro called
-<function>SyncHandle</function>.
+<systemitem>SyncHandle</systemitem>.
If synchronous mode is enabled (see
<function>XSynchronize</function>),
the request is sent immediately.
@@ -3079,7 +3079,7 @@ critical section: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *_XAllocScratch</function></funcdef>
+ <funcdef>char *<function>_XAllocScratch</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedlong<parameter> nbytes</parameter></paramdef>
</funcprototype>
@@ -3136,7 +3136,7 @@ critical sections: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *_XAllocTemp</function></funcdef>
+ <funcdef>char *<function>_XAllocTemp</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedlong<parameter> nbytes</parameter></paramdef>
</funcprototype>
@@ -3175,7 +3175,7 @@ The following function returns the storage: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> _XFreeTemp</function></funcdef>
+ <funcdef>void <function>_XFreeTemp</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *buf</parameter></paramdef>
<paramdef>unsignedlong<parameter> nbytes</parameter></paramdef>
@@ -3250,45 +3250,45 @@ avoided completely if at all possible. This code may run on machines with 16-bit ints.
So, if any integer argument, variable, or return value either can take
only nonnegative values or is declared as a
-<function>CARD16</function>
+<type>CARD16</type>
in the protocol, be sure to declare it as
-<function>unsigned</function>
-<function>int</function>
+<type>unsigned</type>
+<type>int</type>
and not as
-<function>int</function>.
+<type>int</type>.
(This, of course, does not apply to Booleans or enumerations.)
</para>
<para>
<!-- .LP -->
Similarly,
if any integer argument or return value is declared
-<function>CARD32</function>
+<type>CARD32</type>
in the protocol,
declare it as an
-<function>unsigned</function>
-<function>long</function>
+<type>unsigned</type>
+<type>long</type>
and not as
-<function>int</function>
+<type>int</type>
or
-<function>long</function>.
+<type>long</type>.
This also goes for any internal variables that may
take on values larger than the maximum 16-bit
-<function>unsigned</function>
-<function>int</function>.
+<type>unsigned</type>
+<type>int</type>.
</para>
<para>
<!-- .LP -->
The library currently assumes that a
-<function>char</function>
+<type>char</type>
is 8 bits, a
-<function>short</function>
+<type>short</type>
is 16 bits, an
-<function>int</function>
+<type>int</type>
is 16 or 32 bits, and a
-<function>long</function>
+<type>long</type>
is 32 bits.
The
-<function>PackData </function>
+<function>PackData</function>
macro is a half-hearted attempt to deal with the possibility of 32 bit shorts.
However, much more work is needed to make this work properly.
<!-- .SH -->
@@ -3310,7 +3310,7 @@ in <stdio.h>
and is the number of file descriptors supported on the system)
of type
-<function>XExtCodes</function>.
+<structname>XExtCodes</structname>.
Make sure these are all initialized to NULL.
</para>
</listitem>
@@ -3333,7 +3333,7 @@ Make sure to establish a close display handler to allow you to zero the entry. Do whatever other initialization your extension requires.
(For example, install event handlers and so on.)
Your initialization procedure would normally return a pointer to the
-<function>XExtCodes </function>
+<structname>XExtCodes</structname>
structure for this extension, which is what would normally
be found in your array of pointers.
</para>
@@ -3343,7 +3343,7 @@ be found in your array of pointers. After returning from your initialization procedure,
the stub can now continue normally, because it has its major opcode safely
in its hand in the
-<function>XExtCodes </function>
+<structname>XExtCodes</structname>
structure.
<!-- .bp -->
</para>
diff --git a/libX11/specs/libX11/AppD.xml b/libX11/specs/libX11/AppD.xml index 57d60a219..40778f124 100644 --- a/libX11/specs/libX11/AppD.xml +++ b/libX11/specs/libX11/AppD.xml @@ -26,7 +26,7 @@ Set and get window sizing hints <listitem>
<para>
Set and get an
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure
</para>
</listitem>
@@ -57,7 +57,7 @@ and WM_NORMAL_HINTS properties. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetStandardProperties</function></funcdef>
+ <funcdef><function>XSetStandardProperties</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> *window_name</parameter></paramdef>
@@ -119,7 +119,7 @@ which should be a null-terminated string. <listitem>
<para>
Specifies the bitmap that is to be used for the icon or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -176,9 +176,9 @@ the result is implementation-dependent. <!-- .LP -->
<function>XSetStandardProperties</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .SH -->
</para>
@@ -189,9 +189,9 @@ Setting and Getting Window Sizing Hints <!-- .LP -->
Xlib provides functions that you can use to set or get window sizing hints.
The functions discussed in this section use the flags and the
-<function>XSizeHints </function>
+<structname>XSizeHints</structname>
structure, as defined in the
-<!-- .hN X11/Xutil.h -->
+<<filename class="headerfile">X11/Xutil.h</filename>>
header file and use the WM_NORMAL_HINTS property.
</para>
<para>
@@ -205,7 +205,7 @@ This function has been superseded by <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetNormalHints</function></funcdef>
+ <funcdef><function>XSetNormalHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints</parameter></paramdef>
@@ -278,9 +278,9 @@ the structure have been assigned values. <!-- .LP -->
<function>XSetNormalHints</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -294,7 +294,7 @@ This function has been superseded by <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetNormalHints</function></funcdef>
+ <funcdef>Status <function>XGetNormalHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints_return</parameter></paramdef>
@@ -347,7 +347,7 @@ the application specified no normal size hints for this window. <!-- .LP -->
<function>XGetNormalHints</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -365,7 +365,7 @@ This function is no longer supported by the <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetZoomHints</function></funcdef>
+ <funcdef><function>XSetZoomHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *zhints</parameter></paramdef>
@@ -419,9 +419,9 @@ zoomed state. <!-- .LP -->
<function>XSetZoomHints</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -435,7 +435,7 @@ This function is no longer supported by the <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetZoomHints</function></funcdef>
+ <funcdef>Status <function>XGetZoomHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *zhints_return</parameter></paramdef>
@@ -488,7 +488,7 @@ the application specified no zoom size hints for this window. <!-- .LP -->
<function>XGetZoomHints</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -502,7 +502,7 @@ This function has been superseded by <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetSizeHints</function></funcdef>
+ <funcdef><function>XSetSizeHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints</parameter></paramdef>
@@ -559,7 +559,7 @@ Specifies the property name. The
<function>XSetSizeHints</function>
function sets the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure for the named property and the specified window.
This is used by
<function>XSetNormalHints</function>
@@ -572,10 +572,10 @@ Thus, it may be useful if other properties of that type get defined. <!-- .LP -->
<function>XSetSizeHints</function>
can generate
-<function>BadAlloc</function>,
-<function>BadAtom</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadAtom</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -589,7 +589,7 @@ This function has been superseded by <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetSizeHints</function></funcdef>
+ <funcdef>Status <function>XGetSizeHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints_return</parameter></paramdef>
@@ -646,7 +646,7 @@ Specifies the property name. The
<function>XGetSizeHints</function>
function returns the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure for the named property and the specified window.
This is used by
<function>XGetNormalHints</function>
@@ -663,9 +663,9 @@ or zero otherwise. <!-- .LP -->
<function>XGetSizeHints</function>
can generate
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .SH -->
Getting and Setting an XStandardColormap Structure
@@ -673,16 +673,16 @@ Getting and Setting an XStandardColormap Structure <para>
<!-- .LP -->
To get the
-<function>XStandardColormap </function>
+<structname>XStandardColormap</structname>
structure associated with one of the described atoms, use
<function>XGetStandardColormap</function>.
This function has been superseded by
-<function>XGetRGBColormap</function>.
+<function>XGetRGBColormaps</function>.
<indexterm significance="preferred"><primary>XGetStandardColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetStandardColormap</function></funcdef>
+ <funcdef>Status <function>XGetStandardColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XStandardColormap<parameter> *colormap_return</parameter></paramdef>
@@ -744,7 +744,7 @@ as the property argument. returns a nonzero status if successful and zero otherwise.
For example,
to fetch the standard
-<function>GrayScale</function>
+<symbol>GrayScale</symbol>
colormap for a display,
you use
<function>XGetStandardColormap</function>
@@ -768,9 +768,9 @@ See section 14.3 for the semantics of standard colormaps. <!-- .LP -->
<function>XGetStandardColormap</function>
can generate
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -779,12 +779,12 @@ errors. To set a standard colormap, use
<function>XSetStandardColormap</function>.
This function has been superseded by
-<function>XSetRGBColormap</function>.
+<function>XSetRGBColormaps</function>.
<indexterm significance="preferred"><primary>XSetStandardColormap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetStandardColormap</function></funcdef>
+ <funcdef><function>XSetStandardColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XStandardColormap<parameter> *colormap</parameter></paramdef>
@@ -846,11 +846,11 @@ function usually is only used by window or session managers. <!-- .LP -->
<function>XSetStandardColormap</function>
can generate
-<function>BadAlloc</function>,
-<function>BadAtom</function>,
-<function>BadDrawable</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadAtom</errorname>,
+<errorname>BadDrawable</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .SH -->
Parsing Window Geometry
@@ -867,7 +867,7 @@ This function has been superseded by <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XGeometry</function></funcdef>
+ <funcdef>int <function>XGeometry</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen</parameter></paramdef>
<paramdef>char*position,<parameter> *default_position</parameter></paramdef>
@@ -1026,13 +1026,13 @@ size of the increments fwidth and fheight and any additional interior space (xadder and yadder)
to make it easy to compute the resulting size.
The
-<function>XGeometry </function>
+<function>XGeometry</function>
function returns the position the window should be placed given a position and
a default position.
<function>XGeometry</function>
determines the placement of
a window using a geometry specification as specified by
-<function>XParseGeometry </function>
+<function>XParseGeometry</function>
and the additional information about the window.
Given a fully qualified default geometry specification and
an incomplete geometry specification,
@@ -1071,7 +1071,7 @@ It is only useful in very simple applications. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XGetDefault</function></funcdef>
+ <funcdef>char *<function>XGetDefault</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *program</parameter></paramdef>
<paramdef>char<parameter> *option</parameter></paramdef>
@@ -1148,7 +1148,7 @@ a resource file in the user's home directory is used. On a <acronym>POSIX</acronym>-conformant system,
this file is
<function>"$HOME/.Xdefaults"</function>.
-<indexterm><primary>Files</primary><secondary>$HOME/.Xdefaults</secondary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename>$HOME/.Xdefaults</filename></secondary></indexterm>
After loading these defaults,
<function>XGetDefault</function>
merges additional defaults specified by the XENVIRONMENT
@@ -1158,8 +1158,8 @@ it contains a full path name for the additional resource file. If XENVIRONMENT is not defined,
<function>XGetDefault</function>
looks for
-"$HOME/.Xdefaults-<emphasis remap='I'>name</emphasis>" ,
-where <emphasis remap='I'>name</emphasis> specifies the name of the machine on which the application
+"<filename>$HOME/.Xdefaults-<replaceable>name</replaceable></filename>" ,
+where <replaceable>name</replaceable> specifies the name of the machine on which the application
is running.
<!-- .SH -->
X Version 10 Compatibility Functions
@@ -1190,10 +1190,10 @@ These functions are provided mainly for compatibility with X Version 10 and have no server support.
That is, they call other Xlib functions, not the server directly.
Thus, if you just have straight lines to draw, using
-<function>XDrawLines </function>
+<function>XDrawLines</function>
<indexterm><primary>XDrawLines</primary></indexterm>
or
-<function>XDrawSegments </function>
+<function>XDrawSegments</function>
<indexterm><primary>XDrawSegments</primary></indexterm>
is much faster.
</para>
@@ -1215,13 +1215,13 @@ and They are as compatible as possible given X Version 11's new line-drawing
functions.
One thing to note, however, is that
-<function>VertexDrawLastPoint </function>
+<function>VertexDrawLastPoint</function>
is no longer supported.
Also, the error status returned is the opposite of what it was under
X Version 10 (this is the X Version 11 standard error status).
-<function>XAppendVertex </function>
+<function>XAppendVertex</function>
and
-<function>XClearVertexFlag </function>
+<function>XClearVertexFlag</function>
from X Version 10 also are not supported.
</para>
<para>
@@ -1233,15 +1233,15 @@ the closing of a closed figure (see <function>XDrawLines</function>).
The functions discussed here fail (return zero) only if they run out of memory
or are passed a
-<function>Vertex </function>
+<structname>Vertex</structname>
list that has a
-<function>Vertex </function>
+<structname>Vertex</structname>
with
-<function>VertexStartClosed</function>
+<symbol>VertexStartClosed</symbol>
set that is not followed by a
-<function>Vertex </function>
+<structname>Vertex</structname>
with
-<function>VertexEndClosed </function>
+<symbol>VertexEndClosed</symbol>
set.
</para>
<para>
@@ -1265,7 +1265,7 @@ use <funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XDraw</function></funcdef>
+ <funcdef>Status <function>XDraw</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1330,7 +1330,7 @@ Specifies how many vertices are in vlist. <!-- .LP -->
<!-- .eM -->
The
-<function>XDraw </function>
+<function>XDraw</function>
function draws an arbitrary polygon or curve.
The figure drawn is defined by the specified list of vertices (vlist).
The points are connected by lines as specified in the flags in the
@@ -1339,7 +1339,7 @@ vertex structure. <para>
<!-- .LP -->
Each Vertex, as defined in
-<!-- .hN X11/X10.h , -->
+<<filename class="headerfile">X11/X10.h</filename>>,
is a structure with the following members:
</para>
<para>
@@ -1361,15 +1361,15 @@ typedef struct _Vertex { The x and y members are the coordinates of the vertex
that are relative to either the upper left inside corner of the drawable
(if
-<function>VertexRelative </function>
+<symbol>VertexRelative</symbol>
is zero) or the previous vertex (if
-<function>VertexRelative </function>
+<symbol>VertexRelative</symbol>
is one).
</para>
<para>
<!-- .LP -->
The flags, as defined in
-<!-- .hN X11/X10.h , -->
+<<filename class="headerfile">X11/X10.h</filename>>,
are as follows:
<indexterm significance="preferred"><primary>VertexRelative</primary></indexterm>
<indexterm significance="preferred"><primary>VertexDontDraw</primary></indexterm>
@@ -1391,7 +1391,7 @@ VertexEndClosed 0x0010 /* else not */ <listitem>
<para>
If
-<function>VertexRelative </function>
+<symbol>VertexRelative</symbol>
is not set,
the coordinates are absolute (that is, relative to the drawable's origin).
The first vertex must be an absolute vertex.
@@ -1400,7 +1400,7 @@ The first vertex must be an absolute vertex. <listitem>
<para>
If
-<function>VertexDontDraw </function>
+<symbol>VertexDontDraw</symbol>
is one,
no line or curve is drawn from the previous vertex to this one.
This is analogous to picking up the pen and moving to another place
@@ -1410,13 +1410,13 @@ before drawing another line. <listitem>
<para>
If
-<function>VertexCurved </function>
+<symbol>VertexCurved</symbol>
is one,
a spline algorithm is used to draw a smooth curve from the previous vertex
through this one to the next vertex.
Otherwise, a straight line is drawn from the previous vertex to this one.
It makes sense to set
-<function>VertexCurved </function>
+<symbol>VertexCurved</symbol>
to one only if a previous and next vertex are both defined
(either explicitly in the array or through the definition of a closed
curve).
@@ -1425,9 +1425,9 @@ curve). <listitem>
<para>
It is permissible for
-<function>VertexDontDraw </function>
+<symbol>VertexDontDraw</symbol>
bits and
-<function>VertexCurved</function>
+<symbol>VertexCurved</symbol>
bits both to be one.
This is useful if you want to define the previous point for the smooth curve
but do not want an actual curve drawing to start until this point.
@@ -1436,13 +1436,13 @@ but do not want an actual curve drawing to start until this point. <listitem>
<para>
If
-<function>VertexStartClosed </function>
+<symbol>VertexStartClosed</symbol>
is one,
then this point marks the beginning of a closed curve.
This vertex must be followed later in the array by another vertex
whose effective coordinates are identical
and that has a
-<function>VertexEndClosed </function>
+<symbol>VertexEndClosed</symbol>
bit of one.
The points in between form a cycle to determine predecessor
and successor vertices for the spline algorithm.
@@ -1463,7 +1463,7 @@ tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. <!-- .LP -->
<!-- .sp -->
To achieve the effects of the X Version 10
-<function>XDrawTiled </function>
+<function>XDrawTiled</function>
<indexterm><primary>X10 compatibility</primary><secondary>XDrawTiled</secondary></indexterm>
and
<function>XDrawFilled</function>,
@@ -1476,7 +1476,7 @@ use <funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XDrawFilled</function></funcdef>
+ <funcdef>Status <function>XDrawFilled</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1542,7 +1542,7 @@ Specifies how many vertices are in vlist. <!-- .LP -->
<!-- .eM -->
The
-<function>XDrawFilled </function>
+<function>XDrawFilled</function>
function draws arbitrary polygons or curves and then fills them.
</para>
<para>
@@ -1564,7 +1564,7 @@ These functions have been superseded by the context management functions (see section 16.10).
It is often necessary to associate arbitrary information with resource IDs.
Xlib provides the
-<function>XAssocTable </function>
+<function>XAssocTable</function>
functions that you can use to make such an association.
<indexterm><primary>Hash Lookup</primary></indexterm>
<indexterm><primary>Window</primary><secondary>IDs</secondary></indexterm>
@@ -1575,9 +1575,9 @@ The <function>XAssocTable</function>
system provides users of the X library with a method
for associating their own data structures with X resources
-(<function>Pixmaps</function>,
-<function>Fonts</function>,
-<function>Windows</function>,
+(<type>Pixmap</type>s,
+<type>Font</type>s,
+<type>Window</type>s,
and so on).
</para>
<para>
@@ -1597,7 +1597,7 @@ It is called an XID. <para>
<!-- .LP -->
There are a few guidelines that should be observed when using an
-<function>XAssocTable :</function>
+<function>XAssocTable</function> :
</para>
<itemizedlist>
<listitem>
@@ -1631,7 +1631,7 @@ use </para>
<funcsynopsis>
<funcprototype>
- <funcdef>XAssocTable<function> *XCreateAssocTable</function></funcdef>
+ <funcdef>XAssocTable *<function>XCreateAssocTable</function></funcdef>
<paramdef>int<parameter> size</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1661,7 +1661,7 @@ should be a power of two. Some size suggestions might be: use 32 buckets per 100 objects,
and a reasonable maximum number of objects per buckets is 8.
If an error allocating memory for the
-<function>XAssocTable </function>
+<function>XAssocTable</function>
occurs,
a NULL pointer is returned.
</para>
@@ -1677,7 +1677,7 @@ use </para>
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMakeAssoc</function></funcdef>
+ <funcdef><function>XMakeAssoc</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XAssocTable<parameter> *table</parameter></paramdef>
<paramdef>XID<parameter> x_id</parameter></paramdef>
@@ -1751,7 +1751,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XLookUpAssoc</function></funcdef>
+ <funcdef>char *<function>XLookUpAssoc</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XAssocTable<parameter> *table</parameter></paramdef>
<paramdef>XID<parameter> x_id</parameter></paramdef>
@@ -1816,7 +1816,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDeleteAssoc</function></funcdef>
+ <funcdef><function>XDeleteAssoc</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XAssocTable<parameter> *table</parameter></paramdef>
<paramdef>XID<parameter> x_id</parameter></paramdef>
@@ -1880,7 +1880,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDestroyAssocTable</function></funcdef>
+ <funcdef><function>XDestroyAssocTable</function></funcdef>
<paramdef>XAssocTable<parameter> *table</parameter></paramdef>
</funcprototype>
</funcsynopsis>
diff --git a/libX11/specs/libX11/CH01.xml b/libX11/specs/libX11/CH01.xml index 0e86e7496..523eedad0 100644 --- a/libX11/specs/libX11/CH01.xml +++ b/libX11/specs/libX11/CH01.xml @@ -121,7 +121,7 @@ X does not guarantee to preserve the contents of windows. When part or all of a window is hidden and then brought back onto the screen,
its contents may be lost.
The server then sends the client program an
-<function>Expose</function>
+<symbol>Expose</symbol>
event to notify it that part or all of the window needs to be repainted.
Programs must be prepared to regenerate the contents of windows on demand.
</para>
@@ -171,15 +171,15 @@ that returns a value from the server or waits for input. Many Xlib functions will return an integer resource ID,
which allows you to refer to objects stored on the X server.
These can be of type
-<function>Window</function>,
-<function>Font</function>,
-<function>Pixmap</function>,
-<function>Colormap</function>,
-<function>Cursor</function>,
+<type>Window</type>,
+<type>Font</type>,
+<type>Pixmap</type>,
+<type>Colormap</type>,
+<type>Cursor</type>,
and
-<function>GContext</function>,
+<type>GContext</type>,
as defined in the file
-<!-- .hN X11/X.h . -->
+<<filename class="headerfile">X11/X.h</filename>>.
These resources are created by requests and are destroyed
(or freed) by requests or when connections are closed.
Most of these resources are potentially sharable between
@@ -196,7 +196,7 @@ Xlib provides no support for sharing graphics contexts between applications. Client programs are informed of events.
Events may either be side effects of a request (for example, restacking windows
generates
-<function>Expose </function>
+<symbol>Expose</symbol>
events) or completely asynchronous (for example, from the keyboard).
A client program asks to be informed of events.
Because other applications can send events to your application,
@@ -214,9 +214,9 @@ In addition, some library functions (for example,
<function>XRaiseWindow</function>)
generate
-<function>Expose</function>
+<symbol>Expose</symbol>
and
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
events.
These events also arrive asynchronously, but the client may
<indexterm><primary>XSync</primary></indexterm>
@@ -233,7 +233,7 @@ after calling a function that can cause the server to generate events. <para>
<!-- .LP -->
Some functions return
-<function>Status</function>,
+<type>Status</type>,
an integer error indication.
If the function fails, it returns a zero.
If the function returns a status of zero,
@@ -282,19 +282,16 @@ the error is printed, and your program terminates. <!-- .LP -->
The following include files are part of the Xlib standard:
</para>
-<!-- .IP \(bu 5 -->
-<!-- .hN X11/Xlib.h -->
-<!-- .IP -->
<variablelist>
<varlistentry>
- <term></X11/Xlib.h></term>
+ <term><<filename class="headerfile">X11/Xlib.h</filename>></term>
<listitem>
<para>
This is the main header file for Xlib.
The majority of all Xlib symbols are declared by including this file.
This file also contains the preprocessor symbol
-<function>XlibSpecificationRelease</function>.
+<symbol>XlibSpecificationRelease</symbol>.
<indexterm significance="preferred"><primary>XlibSpecificationRelease</primary></indexterm>
This symbol is defined to have the 6 in this release of the standard.
(Release 5 of Xlib was the first release to have this symbol.)
@@ -459,17 +456,17 @@ The following symbols are defined by Xlib and used throughout the manual: <listitem>
<para>
Xlib defines the type
-<function>Bool</function>
+<type>Bool</type>
and the Boolean values
-<function>True</function>
+<symbol>True</symbol>
and
-<function>False</function>.
+<symbol>False</symbol>.
<indexterm significance="preferred"><primary>None</primary></indexterm>
</para>
</listitem>
<listitem>
<para>
-<function>None</function>
+<symbol>None</symbol>
is the universal null resource ID or atom.
<indexterm significance="preferred"><primary>XID</primary></indexterm>
</para>
@@ -477,7 +474,7 @@ is the universal null resource ID or atom. <listitem>
<para>
The type
-<function>XID</function>
+<type>XID</type>
is used for generic resource IDs.
<indexterm significance="preferred"><primary>XPointer</primary></indexterm>
</para>
@@ -485,7 +482,7 @@ is used for generic resource IDs. <listitem>
<para>
The type
-<function>XPointer</function>
+<type>XPointer</type>
is defined to be char\^* and is used as a generic opaque pointer to data.
</para>
</listitem>
@@ -611,7 +608,7 @@ Coordinates and sizes in X are actually 16-bit quantities. This decision was made to minimize the bandwidth required for a
given level of performance.
Coordinates usually are declared as an
-<function>int </function>
+<type>int</type>
in the interface.
Values larger than 16 bits are truncated silently.
Sizes (width and height) are declared as unsigned quantities.
@@ -768,8 +765,8 @@ a..z A..Z 0..9 ._- <listitem>
<para>
Global symbols are printed in
-<function>this </function>
-<function>special </function>
+<function>this</function>
+<function>special</function>
<function>font</function>.
These can be either function names,
symbols defined in include files, or structure names.
diff --git a/libX11/specs/libX11/CH02.xml b/libX11/specs/libX11/CH02.xml index 23f9f1ce2..b6623cbcc 100644 --- a/libX11/specs/libX11/CH02.xml +++ b/libX11/specs/libX11/CH02.xml @@ -22,7 +22,7 @@ Obtain information about the display, image formats, or screens <listitem>
<para>
Generate a
-<function>NoOperation</function>
+<systemitem>NoOperation</systemitem>
protocol request
</para>
</listitem>
@@ -157,7 +157,7 @@ Specifies the screen to be used on that server. Multiple screens can be controlled by a single X server.
The screen_number sets an internal variable that can be accessed by
using the
-<function>DefaultScreen </function>
+<function>DefaultScreen</function>
macro or the
<function>XDefaultScreen</function>
function if you are using languages other than C (see section 2.2.1).
@@ -182,7 +182,7 @@ dual-headed:0.1 The
<function>XOpenDisplay</function>
function returns a
-<function>Display </function>
+<type>Display</type>
structure that serves as the
connection to the X server and that contains all the information
about that X server.
@@ -214,14 +214,14 @@ mechanisms. <!-- .LP -->
<indexterm><primary>Display</primary></indexterm>
If successful,
-<function>XOpenDisplay </function>
+<function>XOpenDisplay</function>
returns a pointer to a
-<function>Display </function>
+<type>Display</type>
structure,
which is defined in
-<!-- .hN X11/Xlib.h . -->
+<<filename class="headerfile">X11/Xlib.h</filename>>.
If
-<function>XOpenDisplay </function>
+<function>XOpenDisplay</function>
does not succeed, it returns NULL.
After a successful call to
<function>XOpenDisplay</function>,
@@ -233,13 +233,13 @@ macro (or the <function>XDefaultScreen</function>
function).
You can access elements of the
-<function>Display</function>
+<type>Display</type>
and
-<function>Screen</function>
+<type>Screen</type>
structures only by using the information macros or functions.
For information about using macros and functions to obtain information from
the
-<function>Display </function>
+<type>Display</type>
structure,
see section 2.2.1.
</para>
@@ -258,7 +258,7 @@ X servers may implement various types of access control mechanisms <!-- .LP -->
The Xlib library provides a number of useful macros
and corresponding functions that return data from the
-<function>Display </function>
+<type>Display</type>
structure.
The macros are used for C programming,
and their corresponding function equivalents are for other language bindings.
@@ -285,11 +285,11 @@ Screen information macros <!-- .LP -->
<indexterm ><primary>Display</primary><secondary>data structure</secondary></indexterm>
All other members of the
-<function>Display </function>
+<type>Display</type>
structure (that is, those for which no macros are defined) are private to Xlib
and must not be used.
Applications must never directly modify or inspect these private members of the
-<function>Display </function>
+<type>Display</type>
structure.
<!-- .NT Note -->
The
@@ -314,9 +314,9 @@ Our apologies for the resulting confusion. <para>
<!-- .LP -->
Applications should not directly modify any part of the
-<function>Display</function>
+<type>Display</type>
and
-<function>Screen</function>
+<type>Screen</type>
structures.
The members should be considered read-only,
although they may change as the result of other operations on the display.
@@ -341,9 +341,9 @@ a procedure. <!-- .LP -->
<!-- .sp -->
Both
-<function>BlackPixel </function>
+<function>BlackPixel</function>
and
-<function>WhitePixel </function>
+<function>WhitePixel</function>
can be used in implementing a monochrome application.
These pixel values are for permanently allocated entries in the default
colormap.
@@ -357,7 +357,7 @@ BlackPixel(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_nu </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XBlackPixel</function></funcdef>
+ <funcdef>unsigned long <function>XBlackPixel</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -402,7 +402,7 @@ WhitePixel(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_nu </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XWhitePixel</function></funcdef>
+ <funcdef>unsigned long <function>XWhitePixel</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -447,7 +447,7 @@ ConnectionNumber(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XConnectionNumber</function></funcdef>
+ <funcdef>int <function>XConnectionNumber</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -484,7 +484,7 @@ DefaultColormap(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>scre </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Colormap <function> XDefaultColormap</function></funcdef>
+ <funcdef>Colormap <function>XDefaultColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -530,7 +530,7 @@ DefaultDepth(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_ </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDefaultDepth</function></funcdef>
+ <funcdef>int <function>XDefaultDepth</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -581,7 +581,7 @@ DefaultGC(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_num </para>
<funcsynopsis>
<funcprototype>
- <funcdef>GC <function> XDefaultGC</function></funcdef>
+ <funcdef>GC <function>XDefaultGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
<paramdef>int<parameter> *count_return</parameter></paramdef>
@@ -646,7 +646,7 @@ DefaultGC(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_num </para>
<funcsynopsis>
<funcprototype>
- <funcdef>GC <function> XDefaultGC</function></funcdef>
+ <funcdef>GC <function>XDefaultGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -699,7 +699,7 @@ DefaultRootWindow(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Window <function> XDefaultRootWindow</function></funcdef>
+ <funcdef>Window <function>XDefaultRootWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -733,7 +733,7 @@ DefaultScreenOfDisplay(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Screen *<function> XDefaultScreenOfDisplay</function></funcdef>
+ <funcdef>Screen *<function>XDefaultScreenOfDisplay</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -767,7 +767,7 @@ ScreenOfDisplay(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>scre </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Screen *<function> XScreenOfDisplay</function></funcdef>
+ <funcdef>Screen *<function>XScreenOfDisplay</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -812,7 +812,7 @@ DefaultScreen(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDefaultScreen</function></funcdef>
+ <funcdef>int <function>XDefaultScreen</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -850,7 +850,7 @@ DefaultVisual(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Visual *<function> XDefaultVisual</function></funcdef>
+ <funcdef>Visual *<function>XDefaultVisual</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -897,7 +897,7 @@ DisplayCells(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_ </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDisplayCells</function></funcdef>
+ <funcdef>int <function>XDisplayCells</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -942,7 +942,7 @@ DisplayPlanes(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDisplayPlanes</function></funcdef>
+ <funcdef>int <function>XDisplayPlanes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -989,7 +989,7 @@ DisplayString(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XDisplayString</function></funcdef>
+ <funcdef>char *<function>XDisplayString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1033,7 +1033,7 @@ LastKnownRequestProcessed(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XLastKnownRequestProcessed</function></funcdef>
+ <funcdef>unsigned long <function>XLastKnownRequestProcessed</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1090,7 +1090,7 @@ LastKnownRequestProcessed(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XLastKnownRequestProcessed</function></funcdef>
+ <funcdef>unsigned long <function>XLastKnownRequestProcessed</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1139,7 +1139,7 @@ LastKnownRequestProcessed(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XLastKnownRequestProcessed</function></funcdef>
+ <funcdef>unsigned long <function>XLastKnownRequestProcessed</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1176,7 +1176,7 @@ NextRequest(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XNextRequest</function></funcdef>
+ <funcdef>unsigned long <function>XNextRequest</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1212,7 +1212,7 @@ ProtocolVersion(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XProtocolVersion</function></funcdef>
+ <funcdef>int <function>XProtocolVersion</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1247,7 +1247,7 @@ ProtocolRevision(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XProtocolRevision</function></funcdef>
+ <funcdef>int <function>XProtocolRevision</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1281,7 +1281,7 @@ QLength(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XQLength</function></funcdef>
+ <funcdef>int <function>XQLength</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1318,7 +1318,7 @@ RootWindow(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_nu </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Window <function> XRootWindow</function></funcdef>
+ <funcdef>Window <function>XRootWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -1367,7 +1367,7 @@ ScreenCount(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XScreenCount</function></funcdef>
+ <funcdef>int <function>XScreenCount</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1401,7 +1401,7 @@ ServerVendor(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XServerVendor</function></funcdef>
+ <funcdef>char *<function>XServerVendor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1439,7 +1439,7 @@ VendorRelease(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XVendorRelease</function></funcdef>
+ <funcdef>int <function>XVendorRelease</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1480,7 +1480,7 @@ most of the work required to convert the data is provided by Xlib <para>
<!-- .LP -->
The
-<function>XPixmapFormatValues</function>
+<structname>XPixmapFormatValues</structname>
structure provides an interface to the pixmap format information
that is returned at the time of a connection setup.
It contains:
@@ -1512,7 +1512,7 @@ ImageByteOrder(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XImageByteOrder</function></funcdef>
+ <funcdef>int <function>XImageByteOrder</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> *count_return</parameter></paramdef>
</funcprototype>
@@ -1547,14 +1547,14 @@ Returns the number of (Cn. The
<function>XListPixmapFormats</function>
function returns an array of
-<function>XPixmapFormatValues</function>
+<structname>XPixmapFormatValues</structname>
structures that describe the types of Z format images supported
by the specified display.
If insufficient memory is available,
<function>XListPixmapFormats</function>
returns NULL.
To free the allocated storage for the
-<function>XPixmapFormatValues</function>
+<structname>XPixmapFormatValues</structname>
structures, use
<function>XFree</function>.
</para>
@@ -1575,7 +1575,7 @@ ImageByteOrder(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XImageByteOrder</function></funcdef>
+ <funcdef>int <function>XImageByteOrder</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1601,9 +1601,9 @@ Both specify the required byte order for images for each scanline unit in XY format (bitmap) or for each pixel value in
Z format.
The macro or function can return either
-<function>LSBFirst </function>
+<symbol>LSBFirst</symbol>
or
-<function>MSBFirst</function>.
+<symbol>MSBFirst</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1615,7 +1615,7 @@ BitmapUnit(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XBitmapUnit</function></funcdef>
+ <funcdef>int <function>XBitmapUnit</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1650,7 +1650,7 @@ BitmapBitOrder(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XBitmapBitOrder</function></funcdef>
+ <funcdef>int <function>XBitmapBitOrder</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1676,9 +1676,9 @@ Within each bitmap unit, the left-most bit in the bitmap as displayed on the screen is either the least significant or most significant bit in the
unit.
This macro or function can return
-<function>LSBFirst</function>
+<symbol>LSBFirst</symbol>
or
-<function>MSBFirst</function>.
+<symbol>MSBFirst</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1690,7 +1690,7 @@ BitmapPad(<emphasis remap='I'>display</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XBitmapPad</function></funcdef>
+ <funcdef>int <function>XBitmapPad</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1725,7 +1725,7 @@ DisplayHeight(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDisplayHeight</function></funcdef>
+ <funcdef>int <function>XDisplayHeight</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -1771,7 +1771,7 @@ DisplayHeightMM(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>scre </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDisplayHeightMM</function></funcdef>
+ <funcdef>int <function>XDisplayHeightMM</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -1816,7 +1816,7 @@ DisplayWidth(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>screen_ </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDisplayWidth</function></funcdef>
+ <funcdef>int <function>XDisplayWidth</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -1861,7 +1861,7 @@ DisplayWidthMM(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>scree </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDisplayWidthMM</function></funcdef>
+ <funcdef>int <function>XDisplayWidthMM</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
</funcprototype>
@@ -1920,7 +1920,7 @@ BlackPixelOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XBlackPixelOfScreen</function></funcdef>
+ <funcdef>unsigned long <function>XBlackPixelOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1933,7 +1933,7 @@ BlackPixelOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -1956,7 +1956,7 @@ WhitePixelOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XWhitePixelOfScreen</function></funcdef>
+ <funcdef>unsigned long <function>XWhitePixelOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1969,7 +1969,7 @@ WhitePixelOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -1992,7 +1992,7 @@ CellsOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XCellsOfScreen</function></funcdef>
+ <funcdef>int <function>XCellsOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2005,7 +2005,7 @@ CellsOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2029,7 +2029,7 @@ DefaultColormapOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Colormap <function> XDefaultColormapOfScreen</function></funcdef>
+ <funcdef>Colormap <function>XDefaultColormapOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2042,7 +2042,7 @@ DefaultColormapOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2065,7 +2065,7 @@ DefaultDepthOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDefaultDepthOfScreen</function></funcdef>
+ <funcdef>int <function>XDefaultDepthOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2078,7 +2078,7 @@ DefaultDepthOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2101,7 +2101,7 @@ DefaultGCOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>GC <function> XDefaultGCOfScreen</function></funcdef>
+ <funcdef>GC <function>XDefaultGCOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2114,7 +2114,7 @@ DefaultGCOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2139,7 +2139,7 @@ DefaultVisualOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Visual *<function> XDefaultVisualOfScreen</function></funcdef>
+ <funcdef>Visual *<function>XDefaultVisualOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2152,7 +2152,7 @@ DefaultVisualOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2177,7 +2177,7 @@ DoesBackingStore(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDoesBackingStore</function></funcdef>
+ <funcdef>int <function>XDoesBackingStore</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2190,7 +2190,7 @@ DoesBackingStore(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2204,10 +2204,10 @@ structure. Both return a value indicating whether the screen supports backing
stores.
The value returned can be one of
-<function>WhenMapped</function>,
-<function>NotUseful</function>,
+<symbol>WhenMapped</symbol>,
+<symbol>NotUseful</symbol>,
or
-<function>Always </function>
+<symbol>Always</symbol>
(see section 3.2.4).
</para>
<para>
@@ -2220,7 +2220,7 @@ DoesSaveUnders(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XDoesSaveUnders</function></funcdef>
+ <funcdef>Bool <function>XDoesSaveUnders</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2233,7 +2233,7 @@ DoesSaveUnders(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2247,10 +2247,10 @@ structure. Both return a Boolean value indicating whether the
screen supports save unders.
If
-<function>True</function>,
+<symbol>True</symbol>,
the screen supports save unders.
If
-<function>False</function>,
+<symbol>False</symbol>,
the screen does not support save unders (see section 3.2.5).
</para>
<para>
@@ -2263,7 +2263,7 @@ DisplayOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Display *<function> XDisplayOfScreen</function></funcdef>
+ <funcdef>Display *<function>XDisplayOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2276,7 +2276,7 @@ DisplayOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2300,7 +2300,7 @@ EventMaskOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>long <function> XEventMaskOfScreen</function></funcdef>
+ <funcdef>long <function>XEventMaskOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2313,7 +2313,7 @@ EventMaskOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2336,7 +2336,7 @@ EventMaskOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>long <function> XEventMaskOfScreen</function></funcdef>
+ <funcdef>long <function>XEventMaskOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2349,7 +2349,7 @@ EventMaskOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2373,7 +2373,7 @@ WidthOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XWidthOfScreen</function></funcdef>
+ <funcdef>int <function>XWidthOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2386,7 +2386,7 @@ WidthOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2409,7 +2409,7 @@ HeightOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XHeightOfScreen</function></funcdef>
+ <funcdef>int <function>XHeightOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2422,7 +2422,7 @@ HeightOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2445,7 +2445,7 @@ WidthMMOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XWidthMMOfScreen</function></funcdef>
+ <funcdef>int <function>XWidthMMOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2458,7 +2458,7 @@ WidthMMOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2481,7 +2481,7 @@ HeightMMOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XHeightMMOfScreen</function></funcdef>
+ <funcdef>int <function>XHeightMMOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2494,7 +2494,7 @@ HeightMMOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2517,7 +2517,7 @@ MaxCmapsOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XMaxCmapsOfScreen</function></funcdef>
+ <funcdef>int <function>XMaxCmapsOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2530,7 +2530,7 @@ MaxCmapsOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2554,7 +2554,7 @@ MinCmapsOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XMinCmapsOfScreen</function></funcdef>
+ <funcdef>int <function>XMinCmapsOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2567,7 +2567,7 @@ MinCmapsOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2591,7 +2591,7 @@ PlanesOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XPlanesOfScreen</function></funcdef>
+ <funcdef>int <function>XPlanesOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2604,7 +2604,7 @@ PlanesOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2627,7 +2627,7 @@ RootWindowOfScreen(<emphasis remap='I'>screen</emphasis>) </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Window <function> XRootWindowOfScreen</function></funcdef>
+ <funcdef>Window <function>XRootWindowOfScreen</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2640,7 +2640,7 @@ RootWindowOfScreen(<emphasis remap='I'>screen</emphasis>) <listitem>
<para>
Specifies the appropriate
-<function>Screen</function>
+<type>Screen</type>
structure.
</para>
</listitem>
@@ -2663,7 +2663,7 @@ Both return the root window of the specified screen. <para>
<!-- .LP -->
To execute a
-<function>NoOperation </function>
+<systemitem>NoOperation</systemitem>
protocol request, use
<function>XNoOp</function>.
<indexterm significance="preferred"><primary>XNoOp</primary></indexterm>
@@ -2690,7 +2690,7 @@ protocol request, use The
<function>XNoOp</function>
function sends a
-<function>NoOperation </function>
+<systemitem>NoOperation</systemitem>
protocol request to the X server,
thereby exercising the connection.
</para>
@@ -2779,15 +2779,15 @@ Specifies the connection to the X server. The
<function>XCloseDisplay</function>
function closes the connection to the X server for the display specified in the
-<function>Display</function>
+<type>Display</type>
structure and destroys all windows, resource IDs
-(<function>Window</function>,
-<function>Font</function>,
-<function>Pixmap</function>,
-<function>Colormap</function>,
-<function>Cursor</function>,
+(<type>Window</type>,
+<type>Font</type>,
+<type>Pixmap</type>,
+<type>Colormap</type>,
+<type>Cursor</type>,
and
-<function>GContext</function>),
+<type>GContext</type>),
or other resources that the client has created
on this display, unless the close-down mode of the resource has been changed
(see
@@ -2808,7 +2808,7 @@ operation. <!-- .LP -->
<function>XCloseDisplay</function>
can generate a
-<function>BadGC</function>
+<errorname>BadGC</errorname>
error.
<!-- .sp -->
</para>
@@ -2848,10 +2848,10 @@ Specifies the connection to the X server. <para>
Specifies the client close-down mode.
You can pass
-<function>DestroyAll</function>,
-<function>RetainPermanent</function>,
+<symbol>DestroyAll</symbol>,
+<symbol>RetainPermanent</symbol>,
or
-<function>RetainTemporary</function>.
+<symbol>RetainTemporary</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2863,20 +2863,20 @@ The <function>XSetCloseDownMode</function>
defines what will happen to the client's resources at connection close.
A connection starts in
-<function>DestroyAll</function>
+<symbol>DestroyAll</symbol>
mode.
For information on what happens to the client's resources when the
close_mode argument is
-<function>RetainPermanent</function>
+<symbol>RetainPermanent</symbol>
or
-<function>RetainTemporary</function>,
+<symbol>RetainTemporary</symbol>,
see section 2.6.
</para>
<para>
<!-- .LP -->
<function>XSetCloseDownMode</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
</sect1>
@@ -2906,7 +2906,7 @@ It disowns all selections owned by the client It performs an
<function>XUngrabPointer</function>
and
-<function>XUngrabKeyboard </function>
+<function>XUngrabKeyboard</function>
if the client has actively grabbed the pointer
or the keyboard.
</para>
@@ -2914,7 +2914,7 @@ or the keyboard. <listitem>
<para>
It performs an
-<function>XUngrabServer </function>
+<function>XUngrabServer</function>
if the client has grabbed the server.
</para>
</listitem>
@@ -2928,9 +2928,9 @@ It releases all passive grabs made by the client. It marks all resources (including colormap entries) allocated
by the client either as permanent or temporary,
depending on whether the close-down mode is
-<function>RetainPermanent</function>
+<symbol>RetainPermanent</symbol>
or
-<function>RetainTemporary</function>.
+<symbol>RetainTemporary</symbol>.
However, this does not prevent other client applications from explicitly
destroying the resources (see
<function>XSetCloseDownMode</function>).
@@ -2940,7 +2940,7 @@ destroying the resources (see <para>
<!-- .LP -->
When the close-down mode is
-<function>DestroyAll</function>,
+<symbol>DestroyAll</symbol>,
the X server destroys all of a client's resources as follows:
</para>
<itemizedlist>
@@ -2960,7 +2960,7 @@ window. <listitem>
<para>
It performs a
-<function>MapWindow</function>
+<systemitem>MapWindow</systemitem>
request on the save-set window if the save-set window is unmapped.
The X server does this even if the save-set window was not an inferior of
a window created by the client.
@@ -2975,12 +2975,12 @@ It destroys all windows created by the client. <para>
It performs the appropriate free request on each nonwindow resource created by
the client in the server (for example,
-<function>Font</function>,
-<function>Pixmap</function>,
-<function>Cursor</function>,
-<function>Colormap</function>,
+<type>Font</type>,
+<type>Pixmap</type>,
+<type>Cursor</type>,
+<type>Colormap</type>,
and
-<function>GContext</function>).
+<type>GContext</type>).
</para>
</listitem>
<listitem>
@@ -2996,7 +2996,7 @@ An X server goes through a cycle of having no connections and having some connections.
When the last connection to the X server closes as a result of a connection
closing with the close_mode of
-<function>DestroyAll</function>,
+<symbol>DestroyAll</symbol>,
the X server does the following:
</para>
<itemizedlist>
@@ -3006,9 +3006,9 @@ It resets its state as if it had just been started.
The X server begins by destroying all lingering resources from
clients that have terminated in
-<function>RetainPermanent</function>
+<symbol>RetainPermanent</symbol>
or
-<function>RetainTemporary</function>
+<symbol>RetainTemporary</symbol>
mode.
</para>
</listitem>
@@ -3042,7 +3042,7 @@ It restores the default font path. <listitem>
<para>
It restores the input focus to state
-<function>PointerRoot</function>.
+<symbol>PointerRoot</symbol>.
</para>
</listitem>
</itemizedlist>
@@ -3050,9 +3050,9 @@ It restores the input focus to state <!-- .LP -->
However, the X server does not reset if you close a connection with a close-down
mode set to
-<function>RetainPermanent</function>
+<symbol>RetainPermanent</symbol>
or
-<function>RetainTemporary</function>.
+<symbol>RetainTemporary</symbol>.
</para>
</sect1>
<sect1 id="Using_Xlib_with_Threads">
@@ -3272,11 +3272,11 @@ internal connection for the specified display. The procedure is passed the display, the specified client_data, the file descriptor for the connection,
a Boolean indicating whether the connection is being opened or closed, and a
pointer to a location for private watch data. If opening is
-<function>True</function>,
+<symbol>True</symbol>,
the procedure can store a pointer to private data in the location pointed
to by watch_data;
when the procedure is later called for this same connection and opening is
-<function>False</function>,
+<symbol>False</symbol>,
the location pointed to by watch_data will hold this same private data pointer.
</para>
<para>
@@ -3314,7 +3314,7 @@ To stop tracking internal connections for a display, use </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Status <function>XRemoveConnectionWatch </function></funcdef>
+ <funcdef>Status <function>XRemoveConnectionWatch</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XWatchProc<parameter> procedure</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
@@ -3431,7 +3431,7 @@ To obtain all of the current internal connections for a display, use </para>
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XInternalConnectionNumbers </function></funcdef>
+ <funcdef>Status <function>XInternalConnectionNumbers</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int **<parameter> fd</parameter></paramdef>
<paramdef>int *<parameter> count_return</parameter></paramdef>
diff --git a/libX11/specs/libX11/CH03.xml b/libX11/specs/libX11/CH03.xml index a90a06821..8b6fb3478 100644 --- a/libX11/specs/libX11/CH03.xml +++ b/libX11/specs/libX11/CH03.xml @@ -25,11 +25,11 @@ the default depth of the default root window, and the default visual type <para>
<!-- .LP -->
Xlib uses an opaque
-<function>Visual </function>
+<structname>Visual</structname>
<indexterm significance="preferred"><primary>Visual</primary></indexterm>
structure that contains information about the possible color mapping.
The visual utility functions (see section 16.7) use an
-<function>XVisualInfo</function>
+<structname>XVisualInfo</structname>
structure to return this information to an application.
The members of this structure pertinent to this discussion are class, red_mask,
green_mask, blue_mask, bits_per_rgb, and colormap_size.
@@ -41,13 +41,13 @@ and can be <indexterm><primary>Visual Classes</primary><secondary>StaticColor</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>GrayScale</secondary></indexterm>
<indexterm><primary>Visual Classes</primary><secondary>PseudoColor</secondary></indexterm>
-<function>StaticGray</function>,
-<function>StaticColor</function>,
-<function>TrueColor</function>,
-<function>GrayScale</function>,
-<function>PseudoColor</function>,
+<symbol>StaticGray</symbol>,
+<symbol>StaticColor</symbol>,
+<symbol>TrueColor</symbol>,
+<symbol>GrayScale</symbol>,
+<symbol>PseudoColor</symbol>,
or
-<function>DirectColor</function>.
+<symbol>DirectColor</symbol>.
</para>
<para>
<!-- .LP -->
@@ -89,16 +89,16 @@ the <acronym>RGB</acronym> values in the following ways: <listitem>
<para>
For
-<function>PseudoColor</function>,
+<symbol>PseudoColor</symbol>,
a pixel value indexes a colormap to produce
independent <acronym>RGB</acronym> values, and the <acronym>RGB</acronym> values can be changed dynamically.
</para>
</listitem>
<listitem>
<para>
-<function>GrayScale </function>
+<symbol>GrayScale</symbol>
is treated the same way as
-<function>PseudoColor </function>
+<symbol>PseudoColor</symbol>
except that the primary that drives the screen is undefined.
Thus, the client should always store the
same value for red, green, and blue in the colormaps.
@@ -107,7 +107,7 @@ same value for red, green, and blue in the colormaps. <listitem>
<para>
For
-<function>DirectColor</function>,
+<symbol>DirectColor</symbol>,
a pixel value is decomposed into separate <acronym>RGB</acronym> subfields, and each
subfield separately indexes the colormap for the corresponding value.
The <acronym>RGB</acronym> values can be changed dynamically.
@@ -115,9 +115,9 @@ The <acronym>RGB</acronym> values can be changed dynamically. </listitem>
<listitem>
<para>
-<function>TrueColor</function>
+<symbol>TrueColor</symbol>
is treated the same way as
-<function>DirectColor </function>
+<symbol>DirectColor</symbol>
except that the colormap has predefined, read-only <acronym>RGB</acronym> values.
These <acronym>RGB</acronym> values are server dependent but provide linear or near-linear
ramps in each primary.
@@ -125,21 +125,21 @@ ramps in each primary. </listitem>
<listitem>
<para>
-<function>StaticColor</function>
+<symbol>StaticColor</symbol>
is treated the same way as
-<function>PseudoColor </function>
+<symbol>PseudoColor</symbol>
except that the colormap has predefined,
read-only, server-dependent <acronym>RGB</acronym> values.
</para>
</listitem>
<listitem>
<para>
-<function>StaticGray </function>
+<symbol>StaticGray</symbol>
is treated the same way as
-<function>StaticColor </function>
+<symbol>StaticColor</symbol>
except that the <acronym>RGB</acronym> values are equal for any single pixel
value, thus resulting in shades of gray.
-<function>StaticGray </function>
+<symbol>StaticGray</symbol>
with a two-entry
colormap can be thought of as monochrome.
</para>
@@ -148,9 +148,9 @@ colormap can be thought of as monochrome. <para>
<!-- .LP -->
The red_mask, green_mask, and blue_mask members are only defined for
-<function>DirectColor</function>
+<symbol>DirectColor</symbol>
and
-<function>TrueColor</function>.
+<symbol>TrueColor</symbol>.
Each has one contiguous set of bits with no
intersections.
The bits_per_rgb member specifies the log base 2 of the
@@ -159,23 +159,23 @@ Actual <acronym>RGB</acronym> values are unsigned 16-bit numbers. The colormap_size member defines the number of available colormap entries
in a newly created colormap.
For
-<function>DirectColor </function>
+<symbol>DirectColor</symbol>
and
-<function>TrueColor</function>,
+<symbol>TrueColor</symbol>,
this is the size of an individual pixel subfield.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To obtain the visual ID from a
-<function>Visual</function>,
+<structname>Visual</structname>,
use
<function>XVisualIDFromVisual</function>.
<indexterm significance="preferred"><primary>XVisualIDFromVisual</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>VisualID<function> XVisualIDFromVisual</function></funcdef>
+ <funcdef>VisualID <function>XVisualIDFromVisual</function></funcdef>
<paramdef>Visual<parameter> *\^visual</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -211,7 +211,7 @@ function returns the visual ID for the specified visual type. <indexterm><primary>Window</primary></indexterm>
<indexterm><primary>Window</primary><secondary>attributes</secondary></indexterm>
All
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows have a border width of zero or more pixels, an optional background,
an event suppression mask (which suppresses propagation of events from
children), and a property list (see section 4.3).
@@ -233,12 +233,12 @@ Windows also have associated property lists (see section 4.3). <para>
<!-- .LP -->
Both
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
and
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
windows have the following common attributes,
which are the only attributes of an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window:
</para>
<itemizedlist>
@@ -271,26 +271,26 @@ cursor <para>
<!-- .LP -->
If you specify any other attributes for an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
windows are used for controlling input events in situations where
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows are unnecessary.
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
windows are invisible; can only be used to control such things as
cursors, input event generation, and grabbing;
and cannot be used in any graphics requests.
Note that
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
windows cannot have
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows as inferiors.
</para>
<para>
@@ -308,7 +308,7 @@ are to be made. The pattern can either be relative to the parent
or absolute.
If
-<function>ParentRelative</function>,
+<symbol>ParentRelative</symbol>,
the parent's background is used.
</para>
<para>
@@ -325,7 +325,7 @@ When a window is eventually mapped to the screen <function>XMapWindow</function>),
<indexterm><primary>XMapWindow</primary></indexterm>
the X server generates an
-<function>Expose </function>
+<symbol>Expose</symbol>
event for the window if backing store has not been maintained.
</para>
<para>
@@ -346,7 +346,7 @@ for window managers. <!-- .LP -->
To set an attribute of a window,
set the appropriate member of the
-<function>XSetWindowAttributes</function>
+<structname>XSetWindowAttributes</structname>
structure and OR in the corresponding value bitmask in your subsequent calls to
<function>XCreateWindow</function>
and
@@ -354,7 +354,7 @@ and or use one of the other convenience functions that set the appropriate
attribute.
The symbols for the value mask bits and the
-<function>XSetWindowAttributes</function>
+<structname>XSetWindowAttributes</structname>
structure are:
<!-- .sM -->
</para>
@@ -412,9 +412,9 @@ typedef struct { <!-- .eM -->
The following lists the defaults for each window attribute and indicates
whether the attribute is applicable to
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
and
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
windows:
</para>
<informaltable>
@@ -434,7 +434,7 @@ windows: <tbody>
<row>
<entry>background-pixmap</entry>
- <entry><function>None</function></entry>
+ <entry><symbol>None</symbol></entry>
<entry>Yes</entry>
<entry>No</entry>
</row>
@@ -446,7 +446,7 @@ windows: </row>
<row>
<entry>border-pixmap</entry>
- <entry><function>CopyFromParent</function></entry>
+ <entry><symbol>CopyFromParent</symbol></entry>
<entry>Yes</entry>
<entry>No</entry>
</row>
@@ -458,19 +458,19 @@ windows: </row>
<row>
<entry>bit-gravity</entry>
- <entry><function>ForgetGravity</function></entry>
+ <entry><symbol>ForgetGravity</symbol></entry>
<entry>Yes</entry>
<entry>No</entry>
</row>
<row>
<entry>win-gravity</entry>
- <entry><function>NorthWestGravity</function></entry>
+ <entry><symbol>NorthWestGravity</symbol></entry>
<entry>Yes</entry>
<entry>Yes</entry>
</row>
<row>
<entry>backing-store</entry>
- <entry><function>NotUseful</function></entry>
+ <entry><symbol>NotUseful</symbol></entry>
<entry>Yes</entry>
<entry>No</entry>
</row>
@@ -488,7 +488,7 @@ windows: </row>
<row>
<entry>save-under</entry>
- <entry><function>False</function></entry>
+ <entry><symbol>False</symbol></entry>
<entry>Yes</entry>
<entry>No</entry>
</row>
@@ -506,19 +506,19 @@ windows: </row>
<row>
<entry>override-redirect</entry>
- <entry><function>False</function></entry>
+ <entry><symbol>False</symbol></entry>
<entry>Yes</entry>
<entry>Yes</entry>
</row>
<row>
<entry>colormap</entry>
- <entry><function>CopyFromParent</function></entry>
+ <entry><symbol>CopyFromParent</symbol></entry>
<entry>Yes</entry>
<entry>No</entry>
</row>
<row>
<entry>cursor</entry>
- <entry><function>None</function></entry>
+ <entry><symbol>None</symbol></entry>
<entry>Yes</entry>
<entry>Yes</entry>
</row>
@@ -534,10 +534,10 @@ windows: <para>
<!-- .LP -->
Only
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows can have a background.
You can set the background of an
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window by using a pixel or a pixmap.
</para>
<para>
@@ -551,9 +551,9 @@ a window's background in a single color. <para>
<!-- .LP -->
You can set the background-pixmap to a pixmap,
-<function>None </function>
+<symbol>None</symbol>
(default), or
-<function>ParentRelative</function>.
+<symbol>ParentRelative</symbol>.
You can set the background-pixel of a window to any pixel value (no default).
If you specify a background-pixel,
it overrides either the default background-pixmap
@@ -569,13 +569,13 @@ If you set the background-pixmap, it overrides the default.
The background-pixmap and the window must have the same depth,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If you set background-pixmap to
-<function>None</function>,
+<symbol>None</symbol>,
the window has no defined background.
If you set the background-pixmap to
-<function>ParentRelative :</function>
+<symbol>ParentRelative</symbol>:
</para>
<itemizedlist>
<listitem>
@@ -584,16 +584,16 @@ The parent window's background-pixmap is used. The child window, however, must have the same depth as
its parent,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
</listitem>
<listitem>
<para>
If the parent window has a background-pixmap of
-<function>None</function>,
+<symbol>None</symbol>,
the window also has a background-pixmap of
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
<listitem>
@@ -608,7 +608,7 @@ background-pixmap is required. The background tile origin always aligns with the parent window's
background tile origin.
If the background-pixmap is not
-<function>ParentRelative</function>,
+<symbol>ParentRelative</symbol>,
the background tile origin is the child window's origin.
</para>
</listitem>
@@ -630,17 +630,17 @@ When no valid contents are available for regions of a window and either the regions are visible or the server is maintaining backing store,
the server automatically tiles the regions with the window's background
unless the window has a background of
-<function>None</function>.
+<symbol>None</symbol>.
If the background is
-<function>None</function>,
+<symbol>None</symbol>,
the previous screen contents from other windows of the same depth as the window
are simply left in place as long as the contents come from the parent of the
window or an inferior of the parent.
Otherwise, the initial contents of the exposed regions are undefined.
-<function>Expose </function>
+<symbol>Expose</symbol>
events are then generated for the regions, even if the background-pixmap
is
-<function>None </function>
+<symbol>None</symbol>
(see section 10.9).
</para>
</sect2>
@@ -652,10 +652,10 @@ is <para>
<!-- .LP -->
Only
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows can have a border.
You can set the border of an
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window by using a pixel or a pixmap.
</para>
<para>
@@ -672,7 +672,7 @@ The border tile origin is always the same as the background tile origin. <!-- .LP -->
You can also set the border-pixmap to a pixmap of any size (some may be faster
than others) or to
-<function>CopyFromParent </function>
+<symbol>CopyFromParent</symbol>
(default).
You can set the border-pixel to any pixel value (no default).
</para>
@@ -682,16 +682,16 @@ If you set a border-pixmap, it overrides the default.
The border-pixmap and the window must have the same depth,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If you set the border-pixmap to
-<function>CopyFromParent</function>,
+<symbol>CopyFromParent</symbol>,
the parent window's border-pixmap is copied.
Subsequent changes to the parent window's border attribute do not affect
the child window.
However, the child window must have the same depth as the parent window,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
@@ -724,17 +724,17 @@ Therefore, graphics operations never affect the window border. <!-- .LP -->
The bit gravity of a window defines which region of the window should be
retained when an
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window is resized.
The default value for the bit-gravity attribute is
-<function>ForgetGravity</function>.
+<symbol>ForgetGravity</symbol>.
The window gravity of a window allows you to define how the
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window should be repositioned if its parent is resized.
The default value for the win-gravity attribute is
-<function>NorthWestGravity</function>.
+<symbol>NorthWestGravity</symbol>.
</para>
<para>
<!-- .LP -->
@@ -761,39 +761,39 @@ change of width and height, the (x, y) pairs are defined: </thead>
<tbody>
<row>
- <entry><function>NorthWestGravity</function></entry>
+ <entry><symbol>NorthWestGravity</symbol></entry>
<entry>(0, 0)</entry>
</row>
<row>
- <entry><function>NorthGravity</function></entry>
+ <entry><symbol>NorthGravity</symbol></entry>
<entry>(Width/2, 0)</entry>
</row>
<row>
- <entry><function>NorthEastGravity</function></entry>
+ <entry><symbol>NorthEastGravity</symbol></entry>
<entry>(Width, 0)</entry>
</row>
<row>
- <entry><function>WestGravity</function></entry>
+ <entry><symbol>WestGravity</symbol></entry>
<entry>(0, Height/2)</entry>
</row>
<row>
- <entry><function>CenterGravity</function></entry>
+ <entry><symbol>CenterGravity</symbol></entry>
<entry>(Width/2, Height/2)</entry>
</row>
<row>
- <entry><function>EastGravity</function></entry>
+ <entry><symbol>EastGravity</symbol></entry>
<entry>(Width, Height/2)</entry>
</row>
<row>
- <entry><function>SouthWestGravity</function></entry>
+ <entry><symbol>SouthWestGravity</symbol></entry>
<entry>(0, Height)</entry>
</row>
<row>
- <entry><function>SouthGravity</function></entry>
+ <entry><symbol>SouthGravity</symbol></entry>
<entry>(Width/2, Height)</entry>
</row>
<row>
- <entry><function>SouthEastGravity</function></entry>
+ <entry><symbol>SouthEastGravity</symbol></entry>
<entry>(Width, Height)</entry>
</row>
</tbody>
@@ -809,13 +809,13 @@ When a window with one of these win-gravities has its parent window resized, the corresponding pair defines the change in position of the window
within the parent.
When a window is so repositioned, a
-<function>GravityNotify</function>
+<symbol>GravityNotify</symbol>
event is generated (see section 10.10.5).
</para>
<para>
<!-- .LP -->
A bit-gravity of
-<function>StaticGravity </function>
+<symbol>StaticGravity</symbol>
indicates that the contents or origin should not move relative to the
origin of the root window.
If the change in size of the window is coupled with a change in position (x, y),
@@ -823,25 +823,25 @@ then for bit-gravity the change in position of each pixel is (\-x, \-y), and for win-gravity the change in position of a child when its parent is so resized is
(\-x, \-y).
Note that
-<function>StaticGravity</function>
+<symbol>StaticGravity</symbol>
still only takes effect when the width or height of the window is changed,
not when the window is moved.
</para>
<para>
<!-- .LP -->
A bit-gravity of
-<function>ForgetGravity </function>
+<symbol>ForgetGravity</symbol>
indicates that the window's contents are always discarded after a size change,
even if a backing store or save under has been requested.
The window is tiled with its background
and zero or more
-<function>Expose </function>
+<symbol>Expose</symbol>
events are generated.
If no background is defined, the existing screen contents are not
altered.
Some X servers may also ignore the specified bit-gravity and
always generate
-<function>Expose</function>
+<symbol>Expose</symbol>
events.
</para>
<para>
@@ -849,20 +849,20 @@ events. The contents and borders of inferiors are not affected by their parent's
bit-gravity.
A server is permitted to ignore the specified bit-gravity and use
-<function>Forget</function>
+<symbol>Forget</symbol>
instead.
</para>
<para>
<!-- .LP -->
A win-gravity of
-<function>UnmapGravity </function>
+<symbol>UnmapGravity</symbol>
is like
-<function>NorthWestGravity</function>
+<symbol>NorthWestGravity</symbol>
(the window is not moved),
except the child is also
unmapped when the parent is resized,
and an
-<function>UnmapNotify </function>
+<symbol>UnmapNotify</symbol>
event is
generated.
</para>
@@ -875,7 +875,7 @@ generated. <para>
<!-- .LP -->
Some implementations of the X server may choose to maintain the contents of
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows.
If the X server maintains the contents of a window,
the off-screen saved pixels
@@ -883,39 +883,39 @@ are known as backing store. The backing store advises the X server on what to do
with the contents of a window.
The backing-store attribute can be set to
-<function>NotUseful </function>
+<symbol>NotUseful</symbol>
(default),
-<function>WhenMapped</function>,
+<symbol>WhenMapped</symbol>,
or
-<function>Always</function>.
+<symbol>Always</symbol>.
</para>
<para>
<!-- .LP -->
A backing-store attribute of
-<function>NotUseful </function>
+<symbol>NotUseful</symbol>
advises the X server that
maintaining contents is unnecessary,
although some X implementations may
still choose to maintain contents and, therefore, not generate
-<function>Expose</function>
+<symbol>Expose</symbol>
events.
A backing-store attribute of
-<function>WhenMapped </function>
+<symbol>WhenMapped</symbol>
advises the X server that maintaining contents of
obscured regions when the window is mapped would be beneficial.
In this case,
the server may generate an
-<function>Expose </function>
+<symbol>Expose</symbol>
event when the window is created.
A backing-store attribute of
-<function>Always </function>
+<symbol>Always</symbol>
advises the X server that maintaining contents even when
the window is unmapped would be beneficial.
Even if the window is larger than its parent,
this is a request to the X server to maintain complete contents,
not just the region within the parent window boundaries.
While the X server maintains the window's contents,
-<function>Expose </function>
+<symbol>Expose</symbol>
events normally are not generated,
but the X server may stop maintaining
contents at any time.
@@ -937,9 +937,9 @@ However, regions obscured by inferior windows are not included. <para>
<!-- .LP -->
Some server implementations may preserve contents of
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows under other
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
windows.
This is not the same as preserving the contents of a window for you.
You may get better visual
@@ -950,12 +950,12 @@ so the temporarily obscured applications do not have to repaint. <para>
<!-- .LP -->
You can set the save-under flag to
-<function>True</function>
+<symbol>True</symbol>
or
-<function>False </function>
+<symbol>False</symbol>
(default).
If save-under is
-<function>True</function>,
+<symbol>True</symbol>,
the X server is advised that, when this window is mapped,
saving the contents of windows it obscures would be beneficial.
</para>
@@ -969,7 +969,7 @@ saving the contents of windows it obscures would be beneficial. <!-- .LP -->
You can set backing planes to indicate (with bits set to 1)
which bit planes of an
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window hold dynamic data that must be preserved in backing store
and during save unders.
The default value for the backing-planes attribute is all bits set to 1.
@@ -994,14 +994,14 @@ required to store your window. <para>
<!-- .LP -->
The event mask defines which events the client is interested in for this
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window (or, for some event types, inferiors of this window).
The event mask is the bitwise inclusive OR of zero or more of the
valid event mask bits.
You can specify that no maskable events are reported by setting
-<function>NoEventMask </function>
+<symbol>NoEventMask</symbol>
(default).
</para>
<para>
@@ -1009,26 +1009,26 @@ You can specify that no maskable events are reported by setting The do-not-propagate-mask attribute
defines which events should not be propagated to
ancestor windows when no client has the event type selected in this
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window.
The do-not-propagate-mask is the bitwise inclusive OR of zero or more
of the following masks:
-<function>KeyPress</function>,
-<function>KeyRelease</function>,
-<function>ButtonPress</function>,
-<function>ButtonRelease</function>,
-<function>PointerMotion</function>,
-<function>Button1Motion</function>,
-<function>Button2Motion</function>,
-<function>Button3Motion</function>,
-<function>Button4Motion</function>,
-<function>Button5Motion</function>,
+<symbol>KeyPress</symbol>,
+<symbol>KeyRelease</symbol>,
+<symbol>ButtonPress</symbol>,
+<symbol>ButtonRelease</symbol>,
+<symbol>PointerMotion</symbol>,
+<symbol>Button1Motion</symbol>,
+<symbol>Button2Motion</symbol>,
+<symbol>Button3Motion</symbol>,
+<symbol>Button4Motion</symbol>,
+<symbol>Button5Motion</symbol>,
and
-<function>ButtonMotion</function>.
+<symbol>ButtonMotion</symbol>.
You can specify that all events are propagated by setting
-<function>NoEventMask </function>
+<symbol>NoEventMask</symbol>
(default).
</para>
</sect2>
@@ -1045,9 +1045,9 @@ request. Pop-up windows, however, often need to be mapped without a window manager
getting in the way.
To control whether an
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window is to ignore these structure control facilities,
use the override-redirect flag.
</para>
@@ -1055,12 +1055,12 @@ use the override-redirect flag. <!-- .LP -->
The override-redirect flag specifies whether map and configure requests
on this window should override a
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent.
You can set the override-redirect flag to
-<function>True</function>
+<symbol>True</symbol>
or
-<function>False </function>
+<symbol>False</symbol>
(default).
Window managers use this information to avoid tampering with pop-up windows
(see also chapter 14).
@@ -1075,33 +1075,33 @@ Window managers use this information to avoid tampering with pop-up windows <!-- .LP -->
The colormap attribute specifies which colormap best reflects the true
colors of the
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window.
The colormap must have the same visual type as the window,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
X servers capable of supporting multiple
hardware colormaps can use this information,
and window managers can use it for calls to
<function>XInstallColormap</function>.
You can set the colormap attribute to a colormap or to
-<function>CopyFromParent</function>
+<symbol>CopyFromParent</symbol>
(default).
</para>
<para>
<!-- .LP -->
If you set the colormap to
-<function>CopyFromParent</function>,
+<symbol>CopyFromParent</symbol>,
the parent window's colormap is copied and used by its child.
However, the child window must have the same visual type as the parent,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
The parent window must not have a colormap of
-<function>None</function>,
+<symbol>None</symbol>,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
The colormap is copied by sharing the colormap object between the child
and parent, not by making a complete copy of the colormap contents.
@@ -1118,23 +1118,23 @@ not affect the child window. <!-- .LP -->
The cursor attribute specifies which cursor is to be used when the pointer is
in the
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window.
You can set the cursor to a cursor or
-<function>None</function>
+<symbol>None</symbol>
(default).
</para>
<para>
<!-- .LP -->
If you set the cursor to
-<function>None</function>,
+<symbol>None</symbol>,
the parent's cursor is used when the
pointer is in the
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window, and any change in the parent's cursor will cause an
immediate change in the displayed cursor.
By calling
@@ -1209,25 +1209,25 @@ see chapter 14 and the <emphasis remap='I'>Inter-Client Communication Convention <function>XCreateWindow</function>
is the more general function that allows you to set specific window attributes
when you create a window.
-<function>XCreateSimpleWindow </function>
+<function>XCreateSimpleWindow</function>
creates a window that inherits its attributes from its parent window.
</para>
<para>
<!-- .LP -->
<indexterm><primary>Window</primary><secondary>InputOnly</secondary></indexterm>
The X server acts as if
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
windows do not exist for
the purposes of graphics requests, exposure processing, and
-<function>VisibilityNotify </function>
+<symbol>VisibilityNotify</symbol>
events.
An
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
window cannot be used as a
drawable (that is, as a source or destination for graphics requests).
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
and
-<function>InputOutput </function>
+<symbol>InputOutput</symbol>
windows act identically in other respects (properties,
grabs, input control, and so on).
Extension packages can define other classes of windows.
@@ -1240,7 +1240,7 @@ To create an unmapped window and set its window attributes, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Window<function> XCreateWindow</function></funcdef>
+ <funcdef>Window <function>XCreateWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> parent</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -1320,7 +1320,7 @@ and do not include the created window's borders Specify the width and height(Wh.
The dimensions must be nonzero,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
</listitem>
@@ -1343,7 +1343,7 @@ Specifies the width of the created window's border in pixels. <para>
Specifies the window's depth.
A depth of
-<function>CopyFromParent</function>
+<symbol>CopyFromParent</symbol>
means the depth is taken from the parent.
</para>
</listitem>
@@ -1356,12 +1356,12 @@ means the depth is taken from the parent. <para>
Specifies the created window's class.
You can pass
-<function>InputOutput</function>,
-<function>InputOnly</function>,
+<symbol>InputOutput</symbol>,
+<symbol>InputOnly</symbol>,
or
-<function>CopyFromParent</function>.
+<symbol>CopyFromParent</symbol>.
A class of
-<function>CopyFromParent</function>
+<symbol>CopyFromParent</symbol>
means the class
is taken from the parent.
</para>
@@ -1375,7 +1375,7 @@ is taken from the parent. <para>
Specifies the visual type.
A visual of
-<function>CopyFromParent </function>
+<symbol>CopyFromParent</symbol>
means the visual type is taken from the
parent.
</para>
@@ -1418,7 +1418,7 @@ The function creates an unmapped subwindow for a specified parent window,
returns the window ID of the created window,
and causes the X server to generate a
-<function>CreateNotify</function>
+<symbol>CreateNotify</symbol>
event.
The created window is placed on top in the stacking order
with respect to siblings.
@@ -1437,33 +1437,33 @@ the origin is inside the border at the inside, upper-left corner. <para>
<!-- .LP -->
The border_width for an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window must be zero, or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
For class
-<function>InputOutput</function>,
+<symbol>InputOutput</symbol>,
the visual type and depth must be a combination supported for the screen,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
The depth need not be the same as the parent,
but the parent must not be a window of class
-<function>InputOnly</function>,
+<symbol>InputOnly</symbol>,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
For an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window,
the depth must be zero, and the visual must be one supported by the screen.
If either condition is not met,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
The parent window, however, may have any depth and class.
If you specify any invalid window attribute for a window, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
@@ -1484,28 +1484,28 @@ ancestors are mapped and it is not obscured by any of its ancestors. <!-- .LP -->
<function>XCreateWindow</function>
can generate
-<function>BadAlloc</function>,
-<function>BadColor</function>,
-<function>BadCursor</function>,
-<function>BadMatch</function>,
-<function>BadPixmap</function>,
-<function>BadValue</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadColor</errorname>,
+<errorname>BadCursor</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadPixmap</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To create an unmapped
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
subwindow of a given parent window, use
<function>XCreateSimpleWindow</function>.
<indexterm significance="preferred"><primary>XCreateSimpleWindow</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Window<function> XCreateSimpleWindow</function></funcdef>
+ <funcdef>Window <function>XCreateSimpleWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> parent</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -1582,7 +1582,7 @@ and do not include the created window's borders Specify the width and height(Wh.
The dimensions must be nonzero,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
</listitem>
@@ -1626,18 +1626,18 @@ Specifies the background pixel value of the window. The
<function>XCreateSimpleWindow</function>
function creates an unmapped
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
subwindow for a specified parent window, returns the
window ID of the created window, and causes the X server to generate a
-<function>CreateNotify</function>
+<symbol>CreateNotify</symbol>
event.
The created window is placed on top in the stacking order with respect to
siblings.
Any part of the window that extends outside its parent window is clipped.
The border_width for an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window must be zero, or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
<function>XCreateSimpleWindow</function>
inherits its depth, class, and visual from its parent.
@@ -1648,11 +1648,11 @@ have their default values. <!-- .LP -->
<function>XCreateSimpleWindow</function>
can generate
-<function>BadAlloc</function>,
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -1675,7 +1675,7 @@ To destroy a window and all of its subwindows, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDestroyWindow</function></funcdef>
+ <funcdef><function>XDestroyWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -1711,29 +1711,29 @@ The <function>XDestroyWindow</function>
function destroys the specified window as well as all of its subwindows and causes
the X server to generate a
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
event for each window.
The window should never be referenced again.
If the window specified by the w argument is mapped,
it is unmapped automatically.
The ordering of the
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
events is such that for any given window being destroyed,
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
is generated on any inferiors of the window before being generated on
the window itself.
The ordering among siblings and across subhierarchies is not otherwise
constrained.
If the window you specified is a root window, no windows are destroyed.
Destroying a mapped window will generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events on other windows that were obscured by the window being destroyed.
</para>
<para>
<!-- .LP -->
<function>XDestroyWindow</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -1745,7 +1745,7 @@ To destroy all subwindows of a specified window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDestroySubwindows</function></funcdef>
+ <funcdef><function>XDestroySubwindows</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -1782,13 +1782,13 @@ The function destroys all inferior windows of the specified window,
in bottom-to-top stacking order.
It causes the X server to generate a
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
event for each window.
If any mapped
subwindows were actually destroyed,
<function>XDestroySubwindows</function>
causes the X server to generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events on the specified window.
This is much more efficient than deleting many windows
one at a time because much of the work need be performed only once for all
@@ -1799,7 +1799,7 @@ The subwindows should never be referenced again. <!-- .LP -->
<function>XDestroySubwindows</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -1834,11 +1834,11 @@ It is entirely clipped by an ancestor. </itemizedlist>
<para>
<!-- .LP -->
-<function>Expose </function>
+<symbol>Expose</symbol>
events are generated for the window when part or all of
it becomes visible on the screen.
A client receives the
-<function>Expose </function>
+<symbol>Expose</symbol>
events only if it has asked for them.
Windows retain their position in the stacking order when they are unmapped.
</para>
@@ -1846,15 +1846,15 @@ Windows retain their position in the stacking order when they are unmapped. <!-- .LP -->
A window manager may want to control the placement of subwindows.
If
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
has been selected by a window manager
on a parent window (usually a root window),
a map request initiated by other clients on a child window is not performed,
and the window manager is sent a
-<function>MapRequest </function>
+<symbol>MapRequest</symbol>
event.
However, if the override-redirect flag on the child had been set to
-<function>True</function>
+<symbol>True</symbol>
(usually only on pop-up menus),
the map request is performed.
</para>
@@ -1867,16 +1867,16 @@ reparent the child into a frame first. For further information,
see sections 3.2.8 and 10.10.
Only a single client at a time can select for
-<function>SubstructureRedirectMask</function>.
+<symbol>SubstructureRedirectMask</symbol>.
</para>
<para>
<!-- .LP -->
Similarly, a single client can select for
-<function>ResizeRedirectMask </function>
+<symbol>ResizeRedirectMask</symbol>
on a parent window.
Then, any attempt to resize the window by another client is suppressed, and
the client receives a
-<function>ResizeRequest </function>
+<symbol>ResizeRequest</symbol>
event.
</para>
<para>
@@ -1888,7 +1888,7 @@ To map a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMapWindow</function></funcdef>
+ <funcdef><function>XMapWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -1937,16 +1937,16 @@ This function has no effect if the window is already mapped. <para>
<!-- .LP -->
If the override-redirect of the window is
-<function>False </function>
+<symbol>False</symbol>
and if some other client has selected
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent window, then the X server generates a
-<function>MapRequest</function>
+<symbol>MapRequest</symbol>
event, and the
<function>XMapWindow</function>
function does not map the window.
Otherwise, the window is mapped, and the X server generates a
-<function>MapNotify</function>
+<symbol>MapNotify</symbol>
event.
</para>
<para>
@@ -1956,10 +1956,10 @@ the X server tiles the window with its background. If the window's background is undefined,
the existing screen contents are not
altered, and the X server generates zero or more
-<function>Expose</function>
+<symbol>Expose</symbol>
events.
If backing-store was maintained while the window was unmapped, no
-<function>Expose</function>
+<symbol>Expose</symbol>
events
are generated.
If backing-store will now be maintained,
@@ -1971,29 +1971,29 @@ Similar tiling and exposure take place for any newly viewable inferiors. <!-- .LP -->
<indexterm><primary>XMapWindow</primary></indexterm>
If the window is an
-<function>InputOutput </function>
+<symbol>InputOutput</symbol>
window,
<function>XMapWindow</function>
generates
-<function>Expose </function>
+<symbol>Expose</symbol>
events on each
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window that it causes to be displayed.
If the client maps and paints the window
and if the client begins processing events,
the window is painted twice.
To avoid this,
first ask for
-<function>Expose </function>
+<symbol>Expose</symbol>
events and then map the window,
so the client processes input events as usual.
The event list will include
-<function>Expose </function>
+<symbol>Expose</symbol>
for each
window that has appeared on the screen.
The client's normal response to
an
-<function>Expose </function>
+<symbol>Expose</symbol>
event should be to repaint the window.
This method usually leads to simpler programs and to proper interaction
with window managers.
@@ -2002,7 +2002,7 @@ with window managers. <!-- .LP -->
<function>XMapWindow</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -2014,7 +2014,7 @@ To map and raise a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMapRaised</function></funcdef>
+ <funcdef><function>XMapRaised</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -2062,7 +2062,7 @@ see <!-- .LP -->
<function>XMapRaised</function>
can generate multiple
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2074,7 +2074,7 @@ To map all subwindows for a specified window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMapSubwindows</function></funcdef>
+ <funcdef><function>XMapSubwindows</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -2112,7 +2112,7 @@ The function maps all subwindows for a specified window in top-to-bottom stacking
order.
The X server generates
-<function>Expose</function>
+<symbol>Expose</symbol>
events on each newly displayed window.
This may be much more efficient than mapping many windows
one at a time because the server needs to perform much of the work
@@ -2122,7 +2122,7 @@ only once, for all of the windows, rather than for each window. <!-- .LP -->
<function>XMapSubwindows</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -2144,7 +2144,7 @@ To unmap a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUnmapWindow</function></funcdef>
+ <funcdef><function>XUnmapWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -2179,12 +2179,12 @@ Specifies the window. The
<function>XUnmapWindow</function>
function unmaps the specified window and causes the X server to generate an
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
<indexterm><primary>UnmapNotify Event</primary></indexterm>
<indexterm><primary>XUnmapWindow</primary></indexterm>
event.
If the specified window is already unmapped,
-<function>XUnmapWindow </function>
+<function>XUnmapWindow</function>
has no effect.
Normal exposure processing on formerly obscured windows is performed.
Any child window will no longer be visible until another map call is
@@ -2192,14 +2192,14 @@ made on the parent. In other words, the subwindows are still mapped but are not visible
until the parent is mapped.
Unmapping a window will generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events on windows that were formerly obscured by it.
</para>
<para>
<!-- .LP -->
<function>XUnmapWindow</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -2211,7 +2211,7 @@ To unmap all subwindows for a specified window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUnmapSubwindows</function></funcdef>
+ <funcdef><function>XUnmapSubwindows</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -2248,9 +2248,9 @@ The function unmaps all subwindows for the specified window in bottom-to-top
stacking order.
It causes the X server to generate an
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
event on each subwindow and
-<function>Expose </function>
+<symbol>Expose</symbol>
events on formerly obscured windows.
<indexterm><primary>UnmapNotify Event</primary></indexterm>
Using this function is much more efficient than unmapping multiple windows
@@ -2261,7 +2261,7 @@ only once, for all of the windows, rather than for each window. <!-- .LP -->
<function>XUnmapSubwindows</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -2280,11 +2280,11 @@ move a window, resize a window, move and resize a window, or change a window's border width.
To change one of these parameters,
set the appropriate member of the
-<function>XWindowChanges</function>
+<structname>XWindowChanges</structname>
structure and OR in the corresponding value mask in subsequent calls to
<function>XConfigureWindow</function>.
The symbols for the value mask bits and the
-<function>XWindowChanges</function>
+<structname>XWindowChanges</structname>
structure are:
<!-- .sM -->
</para>
@@ -2323,7 +2323,7 @@ which are relative to the parent's origin and indicate the position of the upper-left outer corner of the window.
The width and height members are used to set the inside size of the window,
not including the border, and must be nonzero, or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
Attempts to configure a root window have no effect.
</para>
@@ -2333,9 +2333,9 @@ The border_width member is used to set the width of the border in pixels. Note that setting just the border width leaves the outer-left corner of the window
in a fixed position but moves the absolute position of the window's origin.
If you attempt to set the border-width attribute of an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window nonzero, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
@@ -2343,49 +2343,49 @@ error results. The sibling member is used to set the sibling window for stacking operations.
The stack_mode member is used to set how the window is to be restacked
and can be set to
-<function>Above</function>,
-<function>Below</function>,
-<function>TopIf</function>,
-<function>BottomIf</function>,
+<symbol>Above</symbol>,
+<symbol>Below</symbol>,
+<symbol>TopIf</symbol>,
+<symbol>BottomIf</symbol>,
or
-<function>Opposite</function>.
+<symbol>Opposite</symbol>.
</para>
<para>
<!-- .LP -->
If the override-redirect flag of the window is
-<function>False </function>
+<symbol>False</symbol>
and if some other client has selected
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates a
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
event, and no further processing is performed.
Otherwise,
if some other client has selected
-<function>ResizeRedirectMask </function>
+<symbol>ResizeRedirectMask</symbol>
on the window and the inside
width or height of the window is being changed,
a
-<function>ResizeRequest</function>
+<symbol>ResizeRequest</symbol>
event is generated, and the current inside width and height are
used instead.
Note that the override-redirect flag of the window has no effect
on
-<function>ResizeRedirectMask </function>
+<symbol>ResizeRedirectMask</symbol>
and that
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent has precedence over
-<function>ResizeRedirectMask </function>
+<symbol>ResizeRedirectMask</symbol>
on the window.
</para>
<para>
<!-- .LP -->
When the geometry of the window is changed as specified,
the window is restacked among siblings, and a
-<function>ConfigureNotify </function>
+<symbol>ConfigureNotify</symbol>
event is generated if the state of the window actually changes.
-<function>GravityNotify</function>
+<symbol>GravityNotify</symbol>
events are generated after
-<function>ConfigureNotify </function>
+<symbol>ConfigureNotify</symbol>
events.
If the inside width or height of the window has actually changed,
children of the window are affected as specified.
@@ -2409,15 +2409,15 @@ and any regions where window contents are lost. <para>
<!-- .LP -->
The restack check (specifically, the computation for
-<function>BottomIf</function>,
-<function>TopIf</function>,
+<symbol>BottomIf</symbol>,
+<symbol>TopIf</symbol>,
and
-<function>Opposite</function>)
+<symbol>Opposite</symbol>)
is performed with respect to the window's final size and position (as
controlled by the other arguments of the request), not its initial position.
If a sibling is specified without a stack_mode,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
@@ -2431,23 +2431,23 @@ the window is restacked as follows: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>Above</function></entry>
+ <entry><symbol>Above</symbol></entry>
<entry>The window is placed just above the sibling.</entry>
</row>
<row>
- <entry><function>Below</function></entry>
+ <entry><symbol>Below</symbol></entry>
<entry>The window is placed just below the sibling.</entry>
</row>
<row>
- <entry><function>TopIf</function></entry>
+ <entry><symbol>TopIf</symbol></entry>
<entry>If the sibling occludes the window, the window is placed at the top of the stack.</entry>
</row>
<row>
- <entry><function>BottomIf</function></entry>
+ <entry><symbol>BottomIf</symbol></entry>
<entry>If the window occludes the sibling, the window is placed at the bottom of the stack.</entry>
</row>
<row>
- <entry><function>Opposite</function></entry>
+ <entry><symbol>Opposite</symbol></entry>
<entry>
If the sibling occludes the window, the window is placed at the top of the stack.
If the window occludes the sibling,
@@ -2470,15 +2470,15 @@ the window is restacked as follows: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>Above</function></entry>
+ <entry><symbol>Above</symbol></entry>
<entry>The window is placed at the top of the stack.</entry>
</row>
<row>
- <entry><function>Below</function></entry>
+ <entry><symbol>Below</symbol></entry>
<entry>The window is placed at the bottom of the stack.</entry>
</row>
<row>
- <entry><function>TopIf</function></entry>
+ <entry><symbol>TopIf</symbol></entry>
<entry>
If any sibling occludes the window, the window is placed at
the top of the stack.
@@ -2491,7 +2491,7 @@ the bottom of the stack. </entry>
</row>
<row>
- <entry><function>Opposite</function></entry>
+ <entry><symbol>Opposite</symbol></entry>
<entry>
If any sibling occludes the window, the window
is placed at the top of the stack.
@@ -2516,7 +2516,7 @@ To configure a window's size, location, stacking, or border, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XConfigureWindow</function></funcdef>
+ <funcdef><function>XConfigureWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>unsignedint<parameter> value_mask</parameter></paramdef>
@@ -2565,7 +2565,7 @@ This mask is the bitwise inclusive OR of the valid configure window values bits. <listitem>
<para>
Specifies the
-<function>XWindowChanges </function>
+<structname>XWindowChanges</structname>
structure.
</para>
</listitem>
@@ -2578,7 +2578,7 @@ structure. The
<function>XConfigureWindow</function>
function uses the values specified in the
-<function>XWindowChanges</function>
+<structname>XWindowChanges</structname>
structure to reconfigure a window's size, position, border, and stacking order.
Values not specified are taken from the existing geometry of the window.
</para>
@@ -2587,13 +2587,13 @@ Values not specified are taken from the existing geometry of the window. If a sibling is specified without a stack_mode or if the window
is not actually a sibling,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
Note that the computations for
-<function>BottomIf</function>,
-<function>TopIf</function>,
+<symbol>BottomIf</symbol>,
+<symbol>TopIf</symbol>,
and
-<function>Opposite</function>
+<symbol>Opposite</symbol>
are performed with respect to the window's final geometry (as controlled by the
other arguments passed to
<function>XConfigureWindow</function>),
@@ -2607,10 +2607,10 @@ changed to reflect the current screen contents <!-- .LP -->
<function>XConfigureWindow</function>
can generate
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2622,7 +2622,7 @@ To move a window without changing its size, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMoveWindow</function></funcdef>
+ <funcdef><function>XMoveWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -2689,21 +2689,21 @@ depending on if the window is obscured by nonchildren and if no backing store exists.
If the contents of the window are lost,
the X server generates
-<function>Expose </function>
+<symbol>Expose</symbol>
events.
Moving a mapped window generates
-<function>Expose </function>
+<symbol>Expose</symbol>
events on any formerly obscured windows.
</para>
<para>
<!-- .LP -->
If the override-redirect flag of the window is
-<function>False </function>
+<symbol>False</symbol>
and some
other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates a
-<function>ConfigureRequest </function>
+<symbol>ConfigureRequest</symbol>
event, and no further processing is
performed.
Otherwise, the window is moved.
@@ -2712,7 +2712,7 @@ Otherwise, the window is moved. <!-- .LP -->
<function>XMoveWindow</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -2724,7 +2724,7 @@ To change a window's size without changing the upper-left coordinate, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XResizeWindow</function></funcdef>
+ <funcdef><function>XResizeWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>unsignedintwidth,<parameter> height</parameter></paramdef>
@@ -2787,35 +2787,35 @@ its borders. This function does not change the window's upper-left coordinate or
the origin and does not restack the window.
Changing the size of a mapped window may lose its contents and generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events.
If a mapped window is made smaller,
changing its size generates
-<function>Expose </function>
+<symbol>Expose</symbol>
events on windows that the mapped window formerly obscured.
</para>
<para>
<!-- .LP -->
If the override-redirect flag of the window is
-<function>False </function>
+<symbol>False</symbol>
and some
other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates a
-<function>ConfigureRequest </function>
+<symbol>ConfigureRequest</symbol>
event, and no further processing is performed.
If either width or height is zero,
a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XResizeWindow</function>
can generate
-<function>BadValue</function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2827,7 +2827,7 @@ To change the size and location of a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMoveResizeWindow</function></funcdef>
+ <funcdef><function>XMoveResizeWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -2911,22 +2911,22 @@ The function changes the size and location of the specified window
without raising it.
Moving and resizing a mapped window may generate an
-<function>Expose </function>
+<symbol>Expose</symbol>
event on the window.
Depending on the new size and location parameters,
moving and resizing a window may generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events on windows that the window formerly obscured.
</para>
<para>
<!-- .LP -->
If the override-redirect flag of the window is
-<function>False </function>
+<symbol>False</symbol>
and some
other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates a
-<function>ConfigureRequest </function>
+<symbol>ConfigureRequest</symbol>
event, and no further processing is performed.
Otherwise, the window size and location are changed.
</para>
@@ -2934,9 +2934,9 @@ Otherwise, the window size and location are changed. <!-- .LP -->
<function>XMoveResizeWindow</function>
can generate
-<function>BadValue </function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2948,7 +2948,7 @@ To change the border width of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWindowBorderWidth</function></funcdef>
+ <funcdef><function>XSetWindowBorderWidth</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>unsignedint<parameter> width</parameter></paramdef>
@@ -2999,7 +2999,7 @@ function sets the specified window's border width to the specified width. <!-- .LP -->
<function>XSetWindowBorderWidth</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -3025,7 +3025,7 @@ To raise a window so that no sibling window obscures it, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRaiseWindow</function></funcdef>
+ <funcdef><function>XRaiseWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -3067,18 +3067,18 @@ on a desk, then raising a window is analogous to moving the sheet to the top of
the stack but leaving its x and y location on the desk constant.
Raising a mapped window may generate
-<function>Expose</function>
+<symbol>Expose</symbol>
events for the window and any mapped subwindows that were formerly obscured.
</para>
<para>
<!-- .LP -->
If the override-redirect attribute of the window is
-<function>False </function>
+<symbol>False</symbol>
and some
other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates a
-<function>ConfigureRequest </function>
+<symbol>ConfigureRequest</symbol>
event, and no processing is performed.
Otherwise, the window is raised.
</para>
@@ -3086,7 +3086,7 @@ Otherwise, the window is raised. <!-- .LP -->
<function>XRaiseWindow</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -3098,7 +3098,7 @@ To lower a window so that it does not obscure any sibling windows, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XLowerWindow</function></funcdef>
+ <funcdef><function>XLowerWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -3140,18 +3140,18 @@ stacked on a desk, then lowering a window is analogous to moving the sheet to the bottom of the stack but leaving its x and y location on
the desk constant.
Lowering a mapped window will generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events on any windows it formerly obscured.
</para>
<para>
<!-- .LP -->
If the override-redirect attribute of the window is
-<function>False </function>
+<symbol>False</symbol>
and some
other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates a
-<function>ConfigureRequest </function>
+<symbol>ConfigureRequest</symbol>
event, and no processing is performed.
Otherwise, the window is lowered to the bottom of the
stack.
@@ -3160,7 +3160,7 @@ stack. <!-- .LP -->
<function>XLowerWindow</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -3172,7 +3172,7 @@ To circulate a subwindow up or down, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XCirculateSubwindows</function></funcdef>
+ <funcdef><function>XCirculateSubwindows</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> direction</parameter></paramdef>
@@ -3209,9 +3209,9 @@ Specifies the window. Specifies the direction (up or down) that you want to circulate
the window.
You can pass
-<function>RaiseLowest</function>
+<symbol>RaiseLowest</symbol>
or
-<function>LowerHighest</function>.
+<symbol>LowerHighest</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3225,33 +3225,33 @@ The function circulates children of the specified window in the specified
direction.
If you specify
-<function>RaiseLowest</function>,
+<symbol>RaiseLowest</symbol>,
<function>XCirculateSubwindows</function>
raises the lowest mapped child (if any) that is occluded
by another child to the top of the stack.
If you specify
-<function>LowerHighest</function>,
+<symbol>LowerHighest</symbol>,
<function>XCirculateSubwindows</function>
lowers the highest mapped child (if any) that occludes another child
to the bottom of the stack.
Exposure processing is then performed on formerly obscured windows.
If some other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the window, the X server generates a
-<function>CirculateRequest </function>
+<symbol>CirculateRequest</symbol>
event, and no further processing is performed.
If a child is actually restacked,
the X server generates a
-<function>CirculateNotify</function>
+<symbol>CirculateNotify</symbol>
event.
</para>
<para>
<!-- .LP -->
<function>XCirculateSubwindows</function>
can generate
-<function>BadValue</function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3264,7 +3264,7 @@ occluded by another child, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XCirculateSubwindowsUp</function></funcdef>
+ <funcdef><function>XCirculateSubwindowsUp</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -3306,14 +3306,14 @@ Completely unobscured children are not affected. This is a convenience function equivalent to
<function>XCirculateSubwindows</function>
with
-<function>RaiseLowest</function>
+<symbol>RaiseLowest</symbol>
specified.
</para>
<para>
<!-- .LP -->
<function>XCirculateSubwindowsUp</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -3326,7 +3326,7 @@ completely occludes another child, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XCirculateSubwindowsDown</function></funcdef>
+ <funcdef><function>XCirculateSubwindowsDown</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -3366,14 +3366,14 @@ Completely unobscured children are not affected. This is a convenience function equivalent to
<function>XCirculateSubwindows</function>
with
-<function>LowerHighest</function>
+<symbol>LowerHighest</symbol>
specified.
</para>
<para>
<!-- .LP -->
<function>XCirculateSubwindowsDown</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -3385,7 +3385,7 @@ To restack a set of windows from top to bottom, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRestackWindows</function></funcdef>
+ <funcdef><function>XRestackWindows</function></funcdef>
<paramdef>XRestackWindows\^(\^display,windows,<parameter> \^nwindows)</parameter></paramdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> windows[]</parameter></paramdef>
@@ -3439,18 +3439,18 @@ in the order of the array. The stacking order of the other windows is not affected.
For each window in the window array that is not a child of the specified window,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
If the override-redirect attribute of a window is
-<function>False </function>
+<symbol>False</symbol>
and some
other client has selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent, the X server generates
-<function>ConfigureRequest </function>
+<symbol>ConfigureRequest</symbol>
events for each window whose override-redirect flag is not set,
and no further processing is performed.
Otherwise, the windows will be restacked in top-to-bottom order.
@@ -3459,7 +3459,7 @@ Otherwise, the windows will be restacked in top-to-bottom order. <!-- .LP -->
<function>XRestackWindows</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -3477,7 +3477,7 @@ Xlib provides functions that you can use to set window attributes. <function>XChangeWindowAttributes</function>
is the more general function that allows you to set one or more window
attributes provided by the
-<function>XSetWindowAttributes</function>
+<structname>XSetWindowAttributes</structname>
structure.
The other functions described in this section allow you to set one specific
window attribute, such as a window's background.
@@ -3491,7 +3491,7 @@ To change one or more attributes for a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeWindowAttributes</function></funcdef>
+ <funcdef><function>XChangeWindowAttributes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
@@ -3569,7 +3569,7 @@ Depending on the valuemask, the
<function>XChangeWindowAttributes</function>
function uses the window attributes in the
-<function>XSetWindowAttributes</function>
+<structname>XSetWindowAttributes</structname>
structure to change the specified window attributes.
Changing the background does not cause the window contents to be
changed.
@@ -3578,31 +3578,31 @@ To repaint the window and its background, use Setting the border or changing the background such that the
border tile origin changes causes the border to be repainted.
Changing the background of a root window to
-<function>None </function>
+<symbol>None</symbol>
or
-<function>ParentRelative</function>
+<symbol>ParentRelative</symbol>
restores the default background pixmap.
Changing the border of a root window to
-<function>CopyFromParent</function>
+<symbol>CopyFromParent</symbol>
restores the default border pixmap.
Changing the win-gravity does not affect the current position of the
window.
Changing the backing-store of an obscured window to
-<function>WhenMapped </function>
+<symbol>WhenMapped</symbol>
or
-<function>Always</function>,
+<symbol>Always</symbol>,
or changing the backing-planes, backing-pixel, or
save-under of a mapped window may have no immediate effect.
Changing the colormap of a window (that is, defining a new map, not
changing the contents of the existing map) generates a
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
event.
Changing the colormap of a visible window may have no
immediate effect on the screen because the map may not be installed
(see
<function>XInstallColormap</function>).
Changing the cursor of a root window to
-<function>None </function>
+<symbol>None</symbol>
restores the default
cursor.
Whenever possible, you are encouraged to share colormaps.
@@ -3614,14 +3614,14 @@ Their event masks are maintained separately. When an event is generated,
it is reported to all interested clients.
However, only one client at a time can select for
-<function>SubstructureRedirectMask</function>,
-<function>ResizeRedirectMask</function>,
+<symbol>SubstructureRedirectMask</symbol>,
+<symbol>ResizeRedirectMask</symbol>,
and
-<function>ButtonPressMask</function>.
+<symbol>ButtonPressMask</symbol>.
If a client attempts to select any of these event masks
and some other client has already selected one,
a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
There is only one do-not-propagate-mask for a window,
not one per client.
@@ -3630,14 +3630,14 @@ not one per client. <!-- .LP -->
<function>XChangeWindowAttributes</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
-<function>BadCursor</function>,
-<function>BadMatch</function>,
-<function>BadPixmap</function>,
-<function>BadValue</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
+<errorname>BadCursor</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadPixmap</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3649,7 +3649,7 @@ To set the background of a window to a given pixel, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWindowBackground</function></funcdef>
+ <funcdef><function>XSetWindowBackground</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>unsignedlong<parameter> background_pixel</parameter></paramdef>
@@ -3699,18 +3699,18 @@ Changing the background does not cause the window contents to be changed. <function>XSetWindowBackground</function>
uses a pixmap of undefined size filled with the pixel value you passed.
If you try to change the background of an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XSetWindowBackground</function>
can generate
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3726,7 +3726,7 @@ To set the background of a window to a given pixmap, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWindowBackgroundPixmap</function></funcdef>
+ <funcdef><function>XSetWindowBackgroundPixmap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Pixmap<parameter> background_pixmap</parameter></paramdef>
@@ -3761,9 +3761,9 @@ Specifies the window. <listitem>
<para>
Specifies the background pixmap,
-<function>ParentRelative</function>,
+<symbol>ParentRelative</symbol>,
or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3780,27 +3780,27 @@ function sets the background pixmap of the window to the specified pixmap. The background pixmap can immediately be freed if no further explicit
references to it are to be made.
If
-<function>ParentRelative</function>
+<symbol>ParentRelative</symbol>
is specified,
the background pixmap of the window's parent is used,
or on the root window, the default background is restored.
If you try to change the background of an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If the background is set to
-<function>None</function>,
+<symbol>None</symbol>,
the window has no defined background.
</para>
<para>
<!-- .LP -->
<function>XSetWindowBackgroundPixmap</function>
can generate
-<function>BadMatch</function>,
-<function>BadPixmap</function>,
+<errorname>BadMatch</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .NT Note -->
<function>XSetWindowBackground</function>
@@ -3818,7 +3818,7 @@ To change and repaint a window's border to a given pixel, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWindowBorder</function></funcdef>
+ <funcdef><function>XSetWindowBorder</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>unsignedlong<parameter> border_pixel</parameter></paramdef>
@@ -3865,18 +3865,18 @@ The <function>XSetWindowBorder</function>
function sets the border of the window to the pixel value you specify.
If you attempt to perform this on an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XSetWindowBorder</function>
can generate
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3888,7 +3888,7 @@ To change and repaint the border tile of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWindowBorderPixmap</function></funcdef>
+ <funcdef><function>XSetWindowBorderPixmap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Pixmap<parameter> border_pixmap</parameter></paramdef>
@@ -3923,7 +3923,7 @@ Specifies the window. <listitem>
<para>
Specifies the border pixmap or
-<function>CopyFromParent</function>.
+<symbol>CopyFromParent</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3938,12 +3938,12 @@ function sets the border pixmap of the window to the pixmap you specify. The border pixmap can be freed immediately if no further explicit
references to it are to be made.
If you specify
-<function>CopyFromParent</function>,
+<symbol>CopyFromParent</symbol>,
a copy of the parent window's border pixmap is used.
If you attempt to perform this on an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
<indexterm><primary>Resource IDs</primary><secondary>freeing</secondary></indexterm>
<indexterm><primary>Freeing</primary><secondary>resources</secondary></indexterm>
@@ -3952,10 +3952,10 @@ error results. <!-- .LP -->
<function>XSetWindowBorderPixmap</function>
can generate
-<function>BadMatch</function>,
-<function>BadPixmap</function>,
+<errorname>BadMatch</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3967,7 +3967,7 @@ To set the colormap of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWindowColormap</function></funcdef>
+ <funcdef><function>XSetWindowColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Colormap<parameter> colormap</parameter></paramdef>
@@ -4015,17 +4015,17 @@ The function sets the specified colormap of the specified window.
The colormap must have the same visual type as the window,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XSetWindowColormap</function>
can generate
-<function>BadColor</function>,
-<function>BadMatch</function>,
+<errorname>BadColor</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -4038,7 +4038,7 @@ To define which cursor will be used in a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDefineCursor</function></funcdef>
+ <funcdef><function>XDefineCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Cursor<parameter> cursor</parameter></paramdef>
@@ -4073,7 +4073,7 @@ Specifies the window. <listitem>
<para>
Specifies the cursor that is to be displayed or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -4084,7 +4084,7 @@ Specifies the cursor that is to be displayed or <!-- .eM -->
If a cursor is set, it will be used when the pointer is in the window.
If the cursor is
-<function>None</function>,
+<symbol>None</symbol>,
it is equivalent to
<function>XUndefineCursor</function>.
</para>
@@ -4092,9 +4092,9 @@ it is equivalent to <!-- .LP -->
<function>XDefineCursor</function>
can generate
-<function>BadCursor</function>
+<errorname>BadCursor</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -4107,7 +4107,7 @@ To undefine the cursor in a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUndefineCursor</function></funcdef>
+ <funcdef><function>XUndefineCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -4153,7 +4153,7 @@ the default cursor is restored. <!-- .LP -->
<function>XUndefineCursor</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH04.xml b/libX11/specs/libX11/CH04.xml index ed8bd2427..dc611aef5 100644 --- a/libX11/specs/libX11/CH04.xml +++ b/libX11/specs/libX11/CH04.xml @@ -39,7 +39,7 @@ a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XQueryTree</function></funcdef>
+ <funcdef>Status <function>XQueryTree</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window<parameter> *root_return</parameter></paramdef>
@@ -134,7 +134,7 @@ To free a non-NULL children list when it is no longer needed, use <!-- .LP -->
<function>XQueryTree</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -146,7 +146,7 @@ To obtain the current attributes of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWindowAttributes</function></funcdef>
+ <funcdef>Status <function>XGetWindowAttributes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XWindowAttributes<parameter> *window_attributes_return</parameter></paramdef>
@@ -182,7 +182,7 @@ Specifies the window (Wi. <listitem>
<para>
Returns the specified window's attributes in the
-<function>XWindowAttributes</function>
+<structname>XWindowAttributes</structname>
structure.
</para>
</listitem>
@@ -195,7 +195,7 @@ structure. The
<function>XGetWindowAttributes</function>
function returns the current attributes for the specified window to an
-<function>XWindowAttributes</function>
+<structname>XWindowAttributes</structname>
structure.
</para>
<para>
@@ -241,13 +241,13 @@ The border_width member is set to the window's border width in pixels. The depth member is set to the depth of the window
(that is, bits per pixel for the object).
The visual member is a pointer to the screen's associated
-<function>Visual</function>
+<structname>Visual</structname>
structure.
The root member is set to the root window of the screen containing the window.
The class member is set to the window's class and can be either
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
or
-<function>InputOnly</function>.
+<symbol>InputOnly</symbol>.
</para>
<para>
<!-- .LP -->
@@ -260,24 +260,24 @@ and can be one of the following: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>ForgetGravity</function></entry>
- <entry><function>EastGravity</function></entry>
+ <entry><symbol>ForgetGravity</symbol></entry>
+ <entry><symbol>EastGravity</symbol></entry>
</row>
<row>
- <entry><function>NorthWestGravity</function></entry>
- <entry><function>SouthWestGravity</function></entry>
+ <entry><symbol>NorthWestGravity</symbol></entry>
+ <entry><symbol>SouthWestGravity</symbol></entry>
</row>
<row>
- <entry><function>NorthGravity</function></entry>
- <entry><function>SouthGravity</function></entry>
+ <entry><symbol>NorthGravity</symbol></entry>
+ <entry><symbol>SouthGravity</symbol></entry>
</row>
<row>
- <entry><function>NorthEastGravity</function></entry>
- <entry><function>SouthEastGravity</function></entry>
+ <entry><symbol>NorthEastGravity</symbol></entry>
+ <entry><symbol>SouthEastGravity</symbol></entry>
</row>
<row>
- <entry><function>WestGravity</function></entry>
- <entry><function>StaticGravity</function></entry>
+ <entry><symbol>WestGravity</symbol></entry>
+ <entry><symbol>StaticGravity</symbol></entry>
</row>
</tbody>
</tgroup>
@@ -294,27 +294,27 @@ and can be one of the following: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>UnmapGravity</function></entry>
- <entry><function>EastGravity</function></entry>
+ <entry><symbol>UnmapGravity</symbol></entry>
+ <entry><symbol>EastGravity</symbol></entry>
</row>
<row>
- <entry><function>NorthWestGravity</function></entry>
- <entry><function>SouthWestGravity</function></entry>
+ <entry><symbol>NorthWestGravity</symbol></entry>
+ <entry><symbol>SouthWestGravity</symbol></entry>
</row>
<row>
- <entry><function>NorthGravity</function></entry>
- <entry><function>SouthGravity</function></entry>
+ <entry><symbol>NorthGravity</symbol></entry>
+ <entry><symbol>SouthGravity</symbol></entry>
</row>
<row>
- <entry><function>NorthEastGravity</function></entry>
- <entry><function>SouthEastGravity</function></entry>
+ <entry><symbol>NorthEastGravity</symbol></entry>
+ <entry><symbol>SouthEastGravity</symbol></entry>
</row>
<row>
- <entry><function>WestGravity</function></entry>
- <entry><function>StaticGravity</function></entry>
+ <entry><symbol>WestGravity</symbol></entry>
+ <entry><symbol>StaticGravity</symbol></entry>
</row>
<row>
- <entry><function>CenterGravity</function></entry>
+ <entry><symbol>CenterGravity</symbol></entry>
<entry></entry>
</row>
</tbody>
@@ -330,10 +330,10 @@ see section 3.2.3. <!-- xref --> The backing_store member is set to indicate how the X server should maintain
the contents of a window
and can be
-<function>WhenMapped</function>,
-<function>Always</function>,
+<symbol>WhenMapped</symbol>,
+<symbol>Always</symbol>,
or
-<function>NotUseful</function>.
+<symbol>NotUseful</symbol>.
The backing_planes member is set to indicate (with bits set to 1) which bit
planes of the window hold dynamic data that must be preserved in backing_stores
and during save_unders.
@@ -343,23 +343,23 @@ for planes not set in backing_planes. <para>
<!-- .LP -->
The save_under member is set to
-<function>True</function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
The colormap member is set to the colormap for the specified window and can be
a colormap ID or
-<function>None</function>.
+<symbol>None</symbol>.
The map_installed member is set to indicate whether the colormap is
currently installed and can be
-<function>True</function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
The map_state member is set to indicate the state of the window and can be
-<function>IsUnmapped</function>,
-<function>IsUnviewable</function>,
+<symbol>IsUnmapped</symbol>,
+<symbol>IsUnviewable</symbol>,
or
-<function>IsViewable</function>.
-<function>IsUnviewable</function>
+<symbol>IsViewable</symbol>.
+<symbol>IsUnviewable</symbol>
is used if the window is mapped but some ancestor is unmapped.
</para>
<para>
@@ -375,11 +375,11 @@ set of events that should not propagate. <!-- .LP -->
The override_redirect member is set to indicate whether this window overrides
structure control facilities and can be
-<function>True</function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
Window manager clients should ignore the window if this member is
-<function>True</function>.
+<symbol>True</symbol>.
</para>
<para>
<!-- .LP -->
@@ -392,9 +392,9 @@ having to loop over the root window fields to see which field matches. <!-- .LP -->
<function>XGetWindowAttributes</function>
can generate
-<function>BadDrawable</function>
+<errorname>BadDrawable</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -406,7 +406,7 @@ To obtain the current geometry of a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetGeometry</function></funcdef>
+ <funcdef>Status <function>XGetGeometry</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>Window<parameter> *root_return</parameter></paramdef>
@@ -530,13 +530,13 @@ The geometry of the drawable includes the x and y coordinates, width and height, border width, and depth.
These are described in the argument list.
It is legal to pass to this function a window whose class is
-<function>InputOnly</function>.
+<symbol>InputOnly</symbol>.
</para>
<para>
<!-- .LP -->
<function>XGetGeometry</function>
can generate a
-<function>BadDrawable</function>
+<errorname>BadDrawable</errorname>
error.
</para>
</sect1>
@@ -567,7 +567,7 @@ space of another window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XTranslateCoordinates</function></funcdef>
+ <funcdef>Bool <function>XTranslateCoordinates</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Windowsrc_w,<parameter> dest_w</parameter></paramdef>
<paramdef>intsrc_x,<parameter> src_y</parameter></paramdef>
@@ -668,7 +668,7 @@ destination window. If
<function>XTranslateCoordinates</function>
returns
-<function>True</function>,
+<symbol>True</symbol>,
it takes the src_x and src_y coordinates relative
to the source window's origin and returns these coordinates to
dest_x_return and dest_y_return
@@ -676,19 +676,19 @@ relative to the destination window's origin. If
<function>XTranslateCoordinates</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
src_w and dest_w are on different screens,
and dest_x_return and dest_y_return are zero.
If the coordinates are contained in a mapped child of dest_w,
that child is returned to child_return.
Otherwise, child_return is set to
-<function>None</function>.
+<symbol>None</symbol>.
</para>
<para>
<!-- .LP -->
<function>XTranslateCoordinates</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -701,7 +701,7 @@ or to determine the pointer coordinates relative to a specified window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XQueryPointer</function></funcdef>
+ <funcdef>Bool <function>XQueryPointer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window*root_return,<parameter> *child_return</parameter></paramdef>
@@ -817,23 +817,23 @@ coordinates relative to the root window's origin. If
<function>XQueryPointer</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
the pointer is not on the same screen as the specified window, and
<function>XQueryPointer</function>
returns
-<function>None</function>
+<symbol>None</symbol>
to child_return and zero to win_x_return and win_y_return.
If
<function>XQueryPointer</function>
returns
-<function>True</function>,
+<symbol>True</symbol>,
the pointer coordinates returned to win_x_return and win_y_return
are relative to the origin of the specified window.
In this case,
<function>XQueryPointer</function>
returns the child that contains the pointer, if any,
or else
-<function>None</function>
+<symbol>None</symbol>
to child_return.
</para>
<para>
@@ -855,7 +855,7 @@ may lag the physical state if device event processing is frozen <!-- .LP -->
<function>XQueryPointer</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -910,9 +910,9 @@ arbitrary extension in this type scheme. Certain property names are
predefined in the server for commonly used functions.
The atoms for these properties are defined in
-<!-- .hN X11/Xatom.h . -->
+<<filename class="headerfile">X11/Xatom.h</filename>>.
To avoid name clashes with user symbols, the
-<function>#define </function>
+<code>#define</code>
name for each atom has the XA_ prefix.
For an explanation of the functions that let you get and set
much of the information stored in these predefined properties,
@@ -962,7 +962,7 @@ Font properties <listitem>
<para>
Type of a
-<function>ClientMessage </function>
+<symbol>ClientMessage</symbol>
event (none are built into the X server)
</para>
</listitem>
@@ -1189,7 +1189,7 @@ To return an atom for a given name, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Atom<function> XInternAtom</function></funcdef>
+ <funcdef>Atom <function>XInternAtom</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *atom_name</parameter></paramdef>
<paramdef>Bool<parameter> only_if_exists</parameter></paramdef>
@@ -1237,12 +1237,12 @@ The function returns the atom identifier associated with the specified atom_name
string.
If only_if_exists is
-<function>False</function>,
+<symbol>False</symbol>,
the atom is created if it does not exist.
Therefore,
<function>XInternAtom</function>
can return
-<function>None</function>.
+<symbol>None</symbol>.
If the atom name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Uppercase and lowercase matter;
@@ -1256,9 +1256,9 @@ the X server closes. <!-- .LP -->
<function>XInternAtom</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1271,7 +1271,7 @@ To return atoms for an array of names, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XInternAtoms</function></funcdef>
+ <funcdef>Status <function>XInternAtoms</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> **names</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -1357,9 +1357,9 @@ otherwise, it returns zero. <!-- .LP -->
<function>XInternAtoms</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1372,7 +1372,7 @@ To return a name for a given atom identifier, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XGetAtomName</function></funcdef>
+ <funcdef>char *<function>XGetAtomName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Atom<parameter> atom</parameter></paramdef>
</funcprototype>
@@ -1418,7 +1418,7 @@ call <!-- .LP -->
<function>XGetAtomName</function>
can generate a
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
error.
</para>
<para>
@@ -1431,7 +1431,7 @@ To return the names for an array of atom identifiers, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetAtomNames</function></funcdef>
+ <funcdef>Status <function>XGetAtomNames</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Atom<parameter> *atoms</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -1506,7 +1506,7 @@ otherwise, it returns zero. <!-- .LP -->
<function>XGetAtomNames</function>
can generate a
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
error.
</para>
</sect1>
@@ -1521,11 +1521,11 @@ You can attach a property list to every window. Each property has a name, a type, and a value (see section 4.3). <!-- xref -->
The value is an array of 8-bit, 16-bit, or 32-bit quantities,
whose interpretation is left to the clients. The type
-<function>char</function>
+<type>char</type>
is used to represent 8-bit quantities, the type
-<function>short</function>
+<type>short</type>
is used to represent 16-bit quantities, and the type
-<function>long</function>
+<type>long</type>
is used to represent 32-bit quantities.
</para>
<para>
@@ -1548,7 +1548,7 @@ To obtain the type, format, and value of a property of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XGetWindowProperty</function></funcdef>
+ <funcdef>int <function>XGetWindowProperty</function></funcdef>
<paramdef><parameter> \^display</parameter></paramdef>
<paramdef><parameter> w</parameter></paramdef>
<paramdef><parameter> property</parameter></paramdef>
@@ -1634,7 +1634,7 @@ Specifies a Boolean value that determines whether the property is deleted. <listitem>
<para>
Specifies the atom identifier associated with the property type or
-<function>AnyPropertyType</function>.
+<symbol>AnyPropertyType</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1707,9 +1707,9 @@ sets the return arguments as follows: <listitem>
<para>
If the specified property does not exist for the specified window,
-<function>XGetWindowProperty </function>
+<function>XGetWindowProperty</function>
returns
-<function>None</function>
+<symbol>None</symbol>
to actual_type_return and the value zero to
actual_format_return and bytes_after_return.
The nitems_return argument is empty.
@@ -1720,7 +1720,7 @@ In this case, the delete argument is ignored. <para>
If the specified property exists
but its type does not match the specified type,
-<function>XGetWindowProperty </function>
+<function>XGetWindowProperty</function>
returns the actual property type to actual_type_return,
the actual property format (never zero) to actual_format_return,
and the property length in bytes
@@ -1733,9 +1733,9 @@ The nitems_return argument is empty. <listitem>
<para>
If the specified property exists and either you assign
-<function>AnyPropertyType </function>
+<symbol>AnyPropertyType</symbol>
to the req_type argument or the specified type matches the actual property type,
-<function>XGetWindowProperty </function>
+<function>XGetWindowProperty</function>
returns the actual property type to actual_type_return and the actual
property format (never zero) to actual_format_return.
It also returns a value to bytes_after_return and nitems_return, by
@@ -1761,7 +1761,7 @@ The returned value starts at byte index I in the property (indexing from zero), and its length in bytes is L.
If the value for long_offset causes L to be negative,
a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
The value of bytes_after_return is A,
giving the number of trailing unread bytes in the stored property.
@@ -1771,13 +1771,13 @@ giving the number of trailing unread bytes in the stored property. <para>
<!-- .LP -->
If the returned format is 8, the returned data is represented as a
-<function>char</function>
+<type>char</type>
array.
If the returned format is 16, the returned data is represented as a
-<function>short</function>
+<type>short</type>
array and should be cast to that type to obtain the elements.
If the returned format is 32, the returned data is represented as a
-<function>long</function>
+<type>long</type>
array and should be cast to that type to obtain the elements.
</para>
<para>
@@ -1791,18 +1791,18 @@ do not have to be copied into yet another string before use. <para>
<!-- .LP -->
If delete is
-<function>True </function>
+<symbol>True</symbol>
and bytes_after_return is zero,
<function>XGetWindowProperty</function>
deletes the property
from the window and generates a
-<function>PropertyNotify </function>
+<symbol>PropertyNotify</symbol>
event on the window.
</para>
<para>
<!-- .LP -->
The function returns
-<function>Success</function>
+<symbol>Success</symbol>
if it executes successfully.
To free the resulting data,
use
@@ -1812,10 +1812,10 @@ use <!-- .LP -->
<function>XGetWindowProperty</function>
can generate
-<function>BadAtom</function>,
-<function>BadValue</function>,
+<errorname>BadAtom</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -1828,7 +1828,7 @@ To obtain a given window's property list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Atom<function> *XListProperties</function></funcdef>
+ <funcdef>Atom *<function>XListProperties</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> *num_prop_return</parameter></paramdef>
@@ -1883,7 +1883,7 @@ To free the memory allocated by this function, use <!-- .LP -->
<function>XListProperties</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
<para>
@@ -1901,7 +1901,7 @@ To change a property of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeProperty</function></funcdef>
+ <funcdef><function>XChangeProperty</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Atomproperty,<parameter> type</parameter></paramdef>
@@ -1984,10 +1984,10 @@ to <para>
Specifies the mode of the operation.
You can pass
-<function>PropModeReplace</function>,
-<function>PropModePrepend</function>,
+<symbol>PropModeReplace</symbol>,
+<symbol>PropModePrepend</symbol>,
or
-<function>PropModeAppend</function>.
+<symbol>PropModeAppend</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2020,7 +2020,7 @@ The <function>XChangeProperty</function>
function alters the property for the specified window and
causes the X server to generate a
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
event on that window.
<function>XChangeProperty</function>
performs the following:
@@ -2029,7 +2029,7 @@ performs the following: <listitem>
<para>
If mode is
-<function>PropModeReplace</function>,
+<symbol>PropModeReplace</symbol>,
<function>XChangeProperty</function>
discards the previous property value and stores the new data.
</para>
@@ -2037,15 +2037,15 @@ discards the previous property value and stores the new data. <listitem>
<para>
If mode is
-<function>PropModePrepend</function>
+<symbol>PropModePrepend</symbol>
or
-<function>PropModeAppend</function>,
+<symbol>PropModeAppend</symbol>,
<function>XChangeProperty</function>
inserts the specified data before the beginning of the existing data
or onto the end of the existing data, respectively.
The type and format must match the existing property value,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If the property is undefined,
it is treated as defined with the correct type and
@@ -2056,13 +2056,13 @@ format with zero-length data. <para>
<!-- .LP -->
If the specified format is 8, the property data must be a
-<function>char</function>
+<type>char</type>
array.
If the specified format is 16, the property data must be a
-<function>short</function>
+<type>short</type>
array.
If the specified format is 32, the property data must be a
-<function>long</function>
+<type>long</type>
array.
</para>
<para>
@@ -2075,19 +2075,19 @@ see section 2.6. <!-- xref --> The maximum size of a property is server dependent and can vary dynamically
depending on the amount of memory the server has available.
(If there is insufficient space, a
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
error results.)
</para>
<para>
<!-- .LP -->
<function>XChangeProperty</function>
can generate
-<function>BadAlloc</function>,
-<function>BadAtom</function>,
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadAtom</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2102,7 +2102,7 @@ To rotate a window's property list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRotateWindowProperties</function></funcdef>
+ <funcdef><function>XRotateWindowProperties</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Atom<parameter> properties[]\^</parameter></paramdef>
@@ -2171,7 +2171,7 @@ The <function>XRotateWindowProperties</function>
function allows you to rotate properties on a window and causes
the X server to generate
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
events.
If the property names in the properties array are viewed as being numbered
starting from zero and if there are num_prop property names in the list,
@@ -2182,17 +2182,17 @@ of property names (right for positive npositions, left for negative npositions).
If npositions mod N is nonzero,
the X server generates a
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
event for each property in the order that they are listed in the array.
If an atom occurs more than once in the list or no property with that
name is defined for the window,
a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
If a
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
or
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results,
no properties are changed.
</para>
@@ -2200,10 +2200,10 @@ no properties are changed. <!-- .LP -->
<function>XRotateWindowProperties</function>
can generate
-<function>BadAtom</function>,
-<function>BadMatch</function>,
+<errorname>BadAtom</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2216,7 +2216,7 @@ To delete a property on a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDeleteProperty</function></funcdef>
+ <funcdef><function>XDeleteProperty</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Atom<parameter> property</parameter></paramdef>
@@ -2265,16 +2265,16 @@ The function deletes the specified property only if the
property was defined on the specified window
and causes the X server to generate a
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
event on the window unless the property does not exist.
</para>
<para>
<!-- .LP -->
<function>XDeleteProperty</function>
can generate
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -2339,7 +2339,7 @@ To set the selection owner, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetSelectionOwner</function></funcdef>
+ <funcdef><function>XSetSelectionOwner</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Atom<parameter> selection</parameter></paramdef>
<paramdef>Window<parameter> owner</parameter></paramdef>
@@ -2376,7 +2376,7 @@ Specifies the selection atom. <para>
Specifies the owner of the specified selection atom.
You can pass a window or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2388,7 +2388,7 @@ You can pass a window or <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2405,12 +2405,12 @@ last-change time of the specified selection or is later than the current X server time.
Otherwise, the last-change time is set to the specified time,
with
-<function>CurrentTime</function>
+<symbol>CurrentTime</symbol>
replaced by the current server time.
If the owner window is specified as
-<function>None</function>,
+<symbol>None</symbol>,
then the owner of the selection becomes
-<function>None</function>
+<symbol>None</symbol>
(that is, no owner).
Otherwise, the owner of the selection becomes the client executing
the request.
@@ -2418,13 +2418,13 @@ the request. <para>
<!-- .LP -->
If the new owner (whether a client or
-<function>None</function>)
+<symbol>None</symbol>)
is not
the same as the current owner of the selection and the current
owner is not
-<function>None</function>,
+<symbol>None</symbol>,
the current owner is sent a
-<function>SelectionClear </function>
+<symbol>SelectionClear</symbol>
event.
If the client that is the owner of a selection is later
terminated (that is, its connection is closed)
@@ -2432,14 +2432,14 @@ or if the owner window it has specified in the request is later destroyed,
the owner of the selection automatically
reverts to
-<function>None</function>,
+<symbol>None</symbol>,
but the last-change time is not affected.
The selection atom is uninterpreted by the X server.
<function>XGetSelectionOwner</function>
returns the owner window, which is reported in
-<function>SelectionRequest</function>
+<symbol>SelectionRequest</symbol>
and
-<function>SelectionClear</function>
+<symbol>SelectionClear</symbol>
events.
Selections are global to the X server.
</para>
@@ -2447,9 +2447,9 @@ Selections are global to the X server. <!-- .LP -->
<function>XSetSelectionOwner</function>
can generate
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2462,7 +2462,7 @@ To return the selection owner, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Window<function> XGetSelectionOwner</function></funcdef>
+ <funcdef>Window <function>XGetSelectionOwner</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Atom<parameter> selection</parameter></paramdef>
</funcprototype>
@@ -2501,9 +2501,9 @@ function returns the window ID associated with the window that currently owns the
specified selection.
If no selection was specified, the function returns the constant
-<function>None</function>.
+<symbol>None</symbol>.
If
-<function>None</function>
+<symbol>None</symbol>
is returned,
there is no owner for the selection.
</para>
@@ -2511,7 +2511,7 @@ there is no owner for the selection. <!-- .LP -->
<function>XGetSelectionOwner</function>
can generate a
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
error.
</para>
<para>
@@ -2524,7 +2524,7 @@ To request conversion of a selection, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XConvertSelection</function></funcdef>
+ <funcdef><function>XConvertSelection</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Atomselection,<parameter> target</parameter></paramdef>
<paramdef>Atom<parameter> property</parameter></paramdef>
@@ -2572,7 +2572,7 @@ Specifies the target atom. <para>
Specifies the property name.
You also can pass
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2594,7 +2594,7 @@ Specifies the requestor. <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2611,7 +2611,7 @@ type: <listitem>
<para>
If the specified selection has an owner, the X server sends a
-<function>SelectionRequest</function>
+<symbol>SelectionRequest</symbol>
event to that owner.
</para>
</listitem>
@@ -2619,10 +2619,10 @@ event to that owner. <para>
If no owner for the specified
selection exists, the X server generates a
-<function>SelectionNotify</function>
+<symbol>SelectionNotify</symbol>
event to the
requestor with property
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</itemizedlist>
@@ -2635,9 +2635,9 @@ There are two predefined selection atoms: PRIMARY and SECONDARY. <!-- .LP -->
<function>XConvertSelection</function>
can generate
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH05.xml b/libX11/specs/libX11/CH05.xml index 449272a19..d4a3ff1a0 100644 --- a/libX11/specs/libX11/CH05.xml +++ b/libX11/specs/libX11/CH05.xml @@ -23,7 +23,7 @@ To create a pixmap of a given size, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Pixmap<function> XCreatePixmap</function></funcdef>
+ <funcdef>Pixmap <function>XCreatePixmap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>unsignedintwidth,<parameter> height</parameter></paramdef>
@@ -94,16 +94,16 @@ The function creates a pixmap of the width, height, and depth you specified
and returns a pixmap ID that identifies it.
It is valid to pass an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window to the drawable argument.
The width and height arguments must be nonzero,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
The depth argument must be one of the depths supported by the screen
of the specified drawable,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
@@ -120,10 +120,10 @@ The initial contents of the pixmap are undefined. <!-- .LP -->
<function>XCreatePixmap</function>
can generate
-<function>BadAlloc</function>,
-<function>BadDrawable</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadDrawable</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -135,7 +135,7 @@ To free all storage associated with a specified pixmap, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreePixmap</function></funcdef>
+ <funcdef><function>XFreePixmap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Pixmap<parameter> pixmap</parameter></paramdef>
</funcprototype>
@@ -177,7 +177,7 @@ The pixmap should never be referenced again. <!-- .LP -->
<function>XFreePixmap</function>
can generate a
-<function>BadPixmap </function>
+<errorname>BadPixmap</errorname>
error.
</para>
</sect1>
@@ -227,7 +227,7 @@ To create a cursor from the standard cursor font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Cursor<function> XCreateFontCursor</function></funcdef>
+ <funcdef>Cursor <function>XCreateFontCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedint<parameter> shape</parameter></paramdef>
</funcprototype>
@@ -280,9 +280,9 @@ see appendix B. <!-- .LP -->
<function>XCreateFontCursor</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -294,7 +294,7 @@ To create a cursor from font glyphs, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Cursor<function> XCreateGlyphCursor</function></funcdef>
+ <funcdef>Cursor <function>XCreateGlyphCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Fontsource_font,<parameter> mask_font</parameter></paramdef>
<paramdef>unsignedintsource_char,<parameter> mask_char</parameter></paramdef>
@@ -331,7 +331,7 @@ Specifies the font for the source glyph. <listitem>
<para>
Specifies the font for the mask glyph or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -388,12 +388,12 @@ except that the source and mask bitmaps are obtained from the specified font glyphs.
The source_char must be a defined glyph in source_font,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If mask_font is given,
mask_char must be a defined glyph in mask_font,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
The mask_font and character are optional.
The origins of the source_char and mask_char (if defined) glyphs are
@@ -417,10 +417,10 @@ least significant byte. <!-- .LP -->
<function>XCreateGlyphCursor</function>
can generate
-<function>BadAlloc</function>,
-<function>BadFont</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadFont</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -433,7 +433,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Cursor<function> XCreatePixmapCursor</function></funcdef>
+ <funcdef>Cursor <function>XCreatePixmapCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Pixmap<parameter> source</parameter></paramdef>
<paramdef>Pixmap<parameter> mask</parameter></paramdef>
@@ -472,7 +472,7 @@ Specifies the shape of the source cursor. <listitem>
<para>
Specifies the cursor's source bits to be displayed or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -529,14 +529,14 @@ function creates a cursor and returns the cursor ID associated with it. The foreground and background <acronym>RGB</acronym> values must be specified using
foreground_color and background_color,
even if the X server only has a
-<function>StaticGray</function>
+<symbol>StaticGray</symbol>
or
-<function>GrayScale</function>
+<symbol>GrayScale</symbol>
screen.
The foreground color is used for the pixels set to 1 in the
source, and the background color is used for the pixels set to 0.
Both source and mask, if specified, must have depth one (or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results) but can have any root.
The mask argument defines the shape of the cursor.
The pixels set to 1 in the mask define which source pixels are displayed,
@@ -545,11 +545,11 @@ If no mask is given, all pixels of the source are displayed.
The mask, if present, must be the same size as the pixmap defined by the
source argument, or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
The hotspot must be a point within the source,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
@@ -566,9 +566,9 @@ The X server might or might not make a copy of the pixmap. <!-- .LP -->
<function>XCreatePixmapCursor</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadPixmap</function>
+<errorname>BadPixmap</errorname>
errors.
</para>
<para>
@@ -580,7 +580,7 @@ To determine useful cursor sizes, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XQueryBestCursor</function></funcdef>
+ <funcdef>Status <function>XQueryBestCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>unsignedintwidth,<parameter> height</parameter></paramdef>
@@ -673,7 +673,7 @@ cannot support large ones. <!-- .LP -->
<function>XQueryBestCursor</function>
can generate a
-<function>BadDrawable </function>
+<errorname>BadDrawable</errorname>
error.
</para>
<para>
@@ -685,7 +685,7 @@ To change the color of a given cursor, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRecolorCursor</function></funcdef>
+ <funcdef><function>XRecolorCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Cursor<parameter> cursor</parameter></paramdef>
<paramdef>XColor*foreground_color,<parameter> *background_color</parameter></paramdef>
@@ -744,14 +744,14 @@ function changes the color of the specified cursor, and if the cursor is being displayed on a screen,
the change is visible immediately.
The pixel members of the
-<function>XColor</function>
+<structname>XColor</structname>
structures are ignored; only the <acronym>RGB</acronym> values are used.
</para>
<para>
<!-- .LP -->
<function>XRecolorCursor</function>
can generate a
-<function>BadCursor </function>
+<errorname>BadCursor</errorname>
error.
</para>
<para>
@@ -763,7 +763,7 @@ To free (destroy) a given cursor, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeCursor</function></funcdef>
+ <funcdef><function>XFreeCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Cursor<parameter> cursor</parameter></paramdef>
</funcprototype>
@@ -806,7 +806,7 @@ The specified cursor ID should not be referred to again. <!-- .LP -->
<function>XFreeCursor</function>
can generate a
-<function>BadCursor </function>
+<errorname>BadCursor</errorname>
error.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH06.xml b/libX11/specs/libX11/CH06.xml index 9ca12db0c..070898dd3 100644 --- a/libX11/specs/libX11/CH06.xml +++ b/libX11/specs/libX11/CH06.xml @@ -77,9 +77,9 @@ Add new color spaces <!-- .LP -->
All functions, types, and symbols in this chapter with the prefix ``Xcms''
are defined in
-<!-- .hN X11/Xcms.h . -->
+<<filename class="headerfile">X11/Xcms.h</filename>>.
The remaining functions and types are defined in
-<!-- .hN X11/Xlib.h . -->
+<<filename class="headerfile">X11/Xlib.h</filename>>.
</para>
<para>
<!-- .LP -->
@@ -148,21 +148,21 @@ are written to encourage sharing of colormap entries between applications. <para>
<!-- .LP -->
The
-<function>DefaultColormap </function>
+<function>DefaultColormap</function>
macro returns the default colormap.
The
-<function>DefaultVisual </function>
+<function>DefaultVisual</function>
macro
returns the default visual type for the specified screen.
<indexterm><primary>Color map</primary></indexterm>
Possible visual types are
-<function>StaticGray</function>,
-<function>GrayScale</function>,
-<function>StaticColor</function>,
-<function>PseudoColor</function>,
-<function>TrueColor</function>,
+<symbol>StaticGray</symbol>,
+<symbol>GrayScale</symbol>,
+<symbol>StaticColor</symbol>,
+<symbol>PseudoColor</symbol>,
+<symbol>TrueColor</symbol>,
or
-<function>DirectColor </function>
+<symbol>DirectColor</symbol>
(see section 3.1).
</para>
<sect1 id="Color_Structures">
@@ -173,7 +173,7 @@ or <para>
<!-- .LP -->
Functions that operate only on <acronym>RGB</acronym> color space values use an
-<function>XColor</function>
+<structname>XColor</structname>
structure, which contains:
</para>
<para>
@@ -204,26 +204,26 @@ and white is represented by (65535,65535,65535). In some functions,
the flags member controls which of the red, green, and blue members is used
and can be the inclusive OR of zero or more of
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>.
+<symbol>DoBlue</symbol>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
Functions that operate on all color space values use an
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure.
This structure contains a union of substructures,
each supporting color specification encoding for a particular color space.
Like the
-<function>XColor</function>
+<structname>XColor</structname>
structure, the
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure contains pixel
and color specification information (the spec member in the
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure).
<indexterm significance="preferred"><primary>XcmsColor</primary></indexterm>
<!-- .sM -->
@@ -258,7 +258,7 @@ typedef struct { Because the color specification can be encoded for the various color spaces,
encoding for the spec member is identified by the format member,
which is of type
-<function>XcmsColorFormat</function>.
+<type>XcmsColorFormat</type>.
The following macros define standard formats.
<!-- .sM -->
</para>
@@ -431,7 +431,7 @@ The device-dependent formats provided allow color specification in: <listitem>
<para>
<acronym>RGB</acronym> Intensity
-(<function>XcmsRGBi</function>)
+(<structname>XcmsRGBi</structname>)
</para>
</listitem>
<listitem>
@@ -444,17 +444,17 @@ where 1.0 indicates full intensity, 0.5 half intensity, and so on. <listitem>
<para>
<acronym>RGB</acronym> Device
-(<function>XcmsRGB</function>)
+(<structname>XcmsRGB</structname>)
</para>
</listitem>
<listitem>
<para>
Red, green, and blue values appropriate for the specified output device.
-<function>XcmsRGB</function>
+<structname>XcmsRGB</structname>
values are of type unsigned short,
scaled from 0 to 65535 inclusive,
and are interchangeable with the red, green, and blue values in an
-<function>XColor</function>
+<structname>XColor</structname>
structure.
</para>
</listitem>
@@ -762,20 +762,20 @@ so the default CCC attributes can be modified to affect new CCCs. <para>
<!-- .LP -->
Xcms functions in which gamut mapping can occur return
-<function>Status</function>
+<type>Status</type>
and have specific status values defined for them,
as follows:
</para>
<itemizedlist>
<listitem>
<para>
-<function>XcmsFailure</function>
+<symbol>XcmsFailure</symbol>
indicates that the function failed.
</para>
</listitem>
<listitem>
<para>
-<function>XcmsSuccess</function>
+<symbol>XcmsSuccess</symbol>
indicates that the function succeeded.
In addition,
if the function performed any color conversion,
@@ -784,7 +784,7 @@ the colors did not need to be compressed. </listitem>
<listitem>
<para>
-<function>XcmsSuccessWithCompression</function>
+<symbol>XcmsSuccessWithCompression</symbol>
indicates the function performed color conversion
and at least one of the colors needed to be compressed.
The gamut compression method is determined by the gamut compression
@@ -807,7 +807,7 @@ To create a colormap for a screen, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Colormap<function> XCreateColormap</function></funcdef>
+ <funcdef>Colormap <function>XCreateColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Visual<parameter> *visual</parameter></paramdef>
@@ -846,7 +846,7 @@ Specifies the window (Wi. Specifies a visual type supported on the screen.
If the visual type is not one supported by the screen,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
</listitem>
@@ -859,9 +859,9 @@ error results. <para>
Specifies the colormap entries to be allocated.
You can pass
-<function>AllocNone </function>
+<symbol>AllocNone</symbol>
or
-<function>AllocAll</function>.
+<symbol>AllocAll</symbol>.
</para>
</listitem>
</varlistentry>
@@ -881,30 +881,30 @@ Note that the specified window is only used to determine the screen. <!-- .LP -->
The initial values of the colormap entries are undefined for the
visual classes
-<function>GrayScale</function>,
-<function>PseudoColor</function>,
+<symbol>GrayScale</symbol>,
+<symbol>PseudoColor</symbol>,
and
-<function>DirectColor</function>.
+<symbol>DirectColor</symbol>.
For
-<function>StaticGray</function>,
-<function>StaticColor</function>,
+<symbol>StaticGray</symbol>,
+<symbol>StaticColor</symbol>,
and
-<function>TrueColor</function>,
+<symbol>TrueColor</symbol>,
the entries have defined values,
but those values are specific to the visual and are not defined by X.
For
-<function>StaticGray</function>,
-<function>StaticColor</function>,
+<symbol>StaticGray</symbol>,
+<symbol>StaticColor</symbol>,
and
-<function>TrueColor</function>,
+<symbol>TrueColor</symbol>,
alloc must be
-<function>AllocNone</function>,
+<symbol>AllocNone</symbol>,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
For the other visual classes,
if alloc is
-<function>AllocNone</function>,
+<symbol>AllocNone</symbol>,
the colormap initially has no allocated entries,
and clients can allocate them.
For information about the visual types,
@@ -913,19 +913,19 @@ see section 3.1. <para>
<!-- .LP -->
If alloc is
-<function>AllocAll</function>,
+<symbol>AllocAll</symbol>,
the entire colormap is allocated writable.
The initial values of all allocated entries are undefined.
For
-<function>GrayScale</function>
+<symbol>GrayScale</symbol>
and
-<function>PseudoColor</function>,
+<symbol>PseudoColor</symbol>,
the effect is as if an
<function>XAllocColorCells</function>
call returned all pixel values from zero to N - 1,
where N is the colormap entries value in the specified visual.
For
-<function>DirectColor</function>,
+<symbol>DirectColor</symbol>,
the effect is as if an
<function>XAllocColorPlanes</function>
call returned a pixel value of zero and red_mask, green_mask,
@@ -939,11 +939,11 @@ none of these entries can be freed by using <!-- .LP -->
<function>XCreateColormap</function>
can generate
-<function>BadAlloc</function>,
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -956,7 +956,7 @@ shared colormap has failed because of resource exhaustion, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Colormap<function>XCopyColormapAndFree </function></funcdef>
+ <funcdef>Colormap <function>XCopyColormapAndFree</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Colormap<parameter> colormap</parameter></paramdef>
</funcprototype>
@@ -998,13 +998,13 @@ and their read-only or writable characteristics intact and frees those entries in the specified colormap.
Color values in other entries in the new colormap are undefined.
If the specified colormap was created by the client with alloc set to
-<function>AllocAll</function>,
+<symbol>AllocAll</symbol>,
the new colormap is also created with
-<function>AllocAll</function>,
+<symbol>AllocAll</symbol>,
all color values for all entries are copied from the specified colormap,
and then all entries in the specified colormap are freed.
If the specified colormap was not created by the client with
-<function>AllocAll</function>,
+<symbol>AllocAll</symbol>,
the allocations to be moved are all those pixels and planes
that have been allocated by the client using
<function>XAllocColor</function>,
@@ -1018,9 +1018,9 @@ and that have not been freed since they were allocated. <!-- .LP -->
<function>XCopyColormapAndFree</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadColor </function>
+<errorname>BadColor</errorname>
errors.
</para>
<para>
@@ -1081,18 +1081,18 @@ or <function>XChangeWindowAttributes</function>),
<function>XFreeColormap</function>
changes the colormap associated with the window to
-<function>None </function>
+<symbol>None</symbol>
and generates a
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
event.
X does not define the colors displayed for a window with a colormap of
-<function>None</function>.
+<symbol>None</symbol>.
</para>
<para>
<!-- .LP -->
<function>XFreeColormap</function>
can generate a
-<function>BadColor </function>
+<errorname>BadColor</errorname>
error.
</para>
</sect1>
@@ -1195,7 +1195,7 @@ otherwise, it returns zero. <!-- .LP -->
<function>XLookupColor</function>
can generate a
-<function>BadColor </function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
@@ -1256,10 +1256,10 @@ case is ignored. <listitem>
<para>
Returns the exact color value for later use and sets the
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>
+<symbol>DoBlue</symbol>
flags.
</para>
</listitem>
@@ -1285,7 +1285,7 @@ otherwise, it returns zero. <!-- .LP -->
<function>XParseColor</function>
can generate a
-<function>BadColor </function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
@@ -1370,13 +1370,13 @@ Returns the color that can be reproduced on the screen. Specifies the color format for the returned color
specifications (color_screen_return and color_exact_return arguments).
If the format is
-<function>XcmsUndefinedFormat</function>
+<symbol>XcmsUndefinedFormat</symbol>
and the color string contains a
numerical color specification,
the specification is returned in the format used in that numerical
color specification.
If the format is
-<function>XcmsUndefinedFormat</function>
+<symbol>XcmsUndefinedFormat</symbol>
and the color string contains a color name,
the specification is returned in the format used
to store the color in the database.
@@ -1401,13 +1401,13 @@ the result is implementation-dependent. Use of uppercase or lowercase does not matter.
<function>XcmsLookupColor</function>
returns
-<function>XcmsSuccess</function>
+<symbol>XcmsSuccess</symbol>
or
-<function>XcmsSuccessWithCompression</function>
+<symbol>XcmsSuccessWithCompression</symbol>
if the name is resolved; otherwise, it returns
-<function>XcmsFailure</function>.
+<symbol>XcmsFailure</symbol>.
If
-<function>XcmsSuccessWithCompression</function>
+<symbol>XcmsSuccessWithCompression</symbol>
is returned, the color specification returned in
color_screen_return is the result of gamut compression.
</para>
@@ -1519,14 +1519,14 @@ the same read-only entry, thus allowing entries to be shared. When the last client deallocates a shared cell, it is deallocated.
<function>XAllocColor</function>
does not use or affect the flags in the
-<function>XColor</function>
+<structname>XColor</structname>
structure.
</para>
<para>
<!-- .LP -->
<function>XAllocColor</function>
can generate a
-<function>BadColor </function>
+<errorname>BadColor</errorname>
error.
<!-- .EQ -->
delim %%
@@ -1618,21 +1618,21 @@ returns the pixel value of the color cell and the color specification actually allocated.
This returned color specification is the result of converting the <acronym>RGB</acronym> value
returned by
-<function>XAllocColor </function>
+<function>XAllocColor</function>
into the format specified with the result_format argument.
If there is no interest in a returned color specification,
unnecessary computation can be bypassed if result_format is set to
-<function>XcmsRGBFormat</function>.
+<symbol>XcmsRGBFormat</symbol>.
The corresponding colormap cell is read-only.
If this routine returns
-<function>XcmsFailure</function>,
+<symbol>XcmsFailure</symbol>,
the color_in_out color specification is left unchanged.
</para>
<para>
<!-- .LP -->
<function>XcmsAllocColor</function>
can generate a
-<function>BadColor</function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
@@ -1737,7 +1737,7 @@ otherwise, it returns zero. <!-- .LP -->
<function>XAllocNamedColor</function>
can generate a
-<function>BadColor</function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
@@ -1828,13 +1828,13 @@ or parsed from the corresponding string found in a color-name database. Specifies the color format for the returned color
specifications (color_screen_return and color_exact_return arguments).
If the format is
-<function>XcmsUndefinedFormat</function>
+<symbol>XcmsUndefinedFormat</symbol>
and the color string contains a
numerical color specification,
the specification is returned in the format used in that numerical
color specification.
If the format is
-<function>XcmsUndefinedFormat</function>
+<symbol>XcmsUndefinedFormat</symbol>
and the color string contains a color name,
the specification is returned in the format used
to store the color in the database.
@@ -1856,7 +1856,7 @@ ultimately calls to allocate a read-only color cell with
the color specified by a color string.
The color string is parsed into an
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure (see
<function>XcmsLookupColor</function>),
converted
@@ -1877,7 +1877,7 @@ returned by into the format specified in result_format.
If there is no interest in a returned color specification,
unnecessary computation can be bypassed if result_format is set to
-<function>XcmsRGBFormat</function>.
+<symbol>XcmsRGBFormat</symbol>.
If color_screen_return and color_exact_return
point to the same structure, the pixel field will be set correctly,
but the color values are undefined.
@@ -1886,14 +1886,14 @@ but the color values are undefined. <!-- .LP -->
<function>XcmsAllocNamedColor</function>
can generate a
-<function>BadColor</function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To allocate read/write color cell and color plane combinations for a
-<function>PseudoColor</function>
+<symbol>PseudoColor</symbol>
model, use
<function>XAllocColorCells</function>.
</para>
@@ -2002,7 +2002,7 @@ The function allocates read/write color cells.
The number of colors must be positive and the number of planes nonnegative,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If ncolors and nplanes are requested,
then ncolors pixels
@@ -2014,23 +2014,23 @@ ncolors * %2 sup nplanes% distinct pixels can be produced. All of these are
allocated writable by the request.
For
-<function>GrayScale </function>
+<symbol>GrayScale</symbol>
or
-<function>PseudoColor</function>,
+<symbol>PseudoColor</symbol>,
each mask has exactly one bit set to 1.
For
-<function>DirectColor</function>,
+<symbol>DirectColor</symbol>,
each has exactly three bits set to 1.
If contig is
-<function>True </function>
+<symbol>True</symbol>
and if all masks are ORed
together, a single contiguous set of bits set to 1 will be formed for
-<function>GrayScale</function>
+<symbol>GrayScale</symbol>
or
-<function>PseudoColor </function>
+<symbol>PseudoColor</symbol>
and three contiguous sets of bits set to 1 (one within each
pixel subfield) for
-<function>DirectColor</function>.
+<symbol>DirectColor</symbol>.
The <acronym>RGB</acronym> values of the allocated
entries are undefined.
<function>XAllocColorCells</function>
@@ -2040,16 +2040,16 @@ returns nonzero if it succeeded or zero if it failed. <!-- .LP -->
<function>XAllocColorCells</function>
can generate
-<function>BadColor</function>
+<errorname>BadColor</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To allocate read/write color resources for a
-<function>DirectColor</function>
+<symbol>DirectColor</symbol>
model, use
<function>XAllocColorPlanes</function>.
</para>
@@ -2203,19 +2203,19 @@ delim %% The specified ncolors must be positive;
and nreds, ngreens, and nblues must be nonnegative,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested,
ncolors pixels are returned; and the masks have nreds, ngreens, and
nblues bits set to 1, respectively.
If contig is
-<function>True</function>,
+<symbol>True</symbol>,
each mask will have
a contiguous set of bits set to 1.
No mask will have any bits set to 1 in common with
any other mask or with any of the pixels.
For
-<function>DirectColor</function>,
+<symbol>DirectColor</symbol>,
each mask
will lie within the corresponding pixel subfield.
By ORing together
@@ -2227,7 +2227,7 @@ colormap, there are only ncolors * %2 sup nreds% independent red entries, ncolors * %2 sup ngreens% independent green entries,
and ncolors * %2 sup nblues% independent blue entries.
This is true even for
-<function>PseudoColor</function>.
+<symbol>PseudoColor</symbol>.
When the colormap entry of a pixel
value is changed (using
<function>XStoreColors</function>,
@@ -2243,9 +2243,9 @@ returns nonzero if it succeeded or zero if it failed. <!-- .LP -->
<function>XAllocColorPlanes</function>
can generate
-<function>BadColor</function>
+<errorname>BadColor</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2347,7 +2347,7 @@ and <function>XAllocColorPlanes</function>).
Note that freeing an
individual pixel obtained from
-<function>XAllocColorPlanes </function>
+<function>XAllocColorPlanes</function>
may not actually allow
it to be reused until all of its related pixels are also freed.
Similarly,
@@ -2360,16 +2360,16 @@ it must free the entry that many times before the entry is actually freed. All specified pixels that are allocated by the client in the colormap are
freed, even if one or more pixels produce an error.
If a specified pixel is not a valid index into the colormap, a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error results.
If a specified pixel is not allocated by the
client (that is, is unallocated or is only allocated by another client)
or if the colormap was created with all entries writable (by passing
-<function>AllocAll</function>
+<symbol>AllocAll</symbol>
to
<function>XCreateColormap</function>),
a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
@@ -2378,10 +2378,10 @@ the one that gets reported is arbitrary. <!-- .LP -->
<function>XFreeColors</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect1>
@@ -2448,26 +2448,26 @@ The <function>XStoreColor</function>
function changes the colormap entry of the pixel value specified in the
pixel member of the
-<function>XColor</function>
+<structname>XColor</structname>
structure.
You specified this value in the
pixel member of the
-<function>XColor</function>
+<structname>XColor</structname>
structure.
This pixel value must be a read/write cell and a valid index into the colormap.
If a specified pixel is not a valid index into the colormap,
a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
<function>XStoreColor</function>
also changes the red, green, and/or blue color components.
You specify which color components are to be changed by setting
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and/or
-<function>DoBlue</function>
+<symbol>DoBlue</symbol>
in the flags member of the
-<function>XColor</function>
+<structname>XColor</structname>
structure.
If the colormap is an installed map for its screen,
the changes are visible immediately.
@@ -2476,10 +2476,10 @@ the changes are visible immediately. <!-- .LP -->
<function>XStoreColor</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2540,7 +2540,7 @@ Specifies an array of color definition structures to be stored. <para>
<!-- .\"Specifies the number of color definition structures. -->
Specifies the number of
-<function>XColor</function>
+<structname>XColor</structname>
structures in the color definition array.
</para>
</listitem>
@@ -2554,26 +2554,26 @@ The <function>XStoreColors</function>
function changes the colormap entries of the pixel values
specified in the pixel members of the
-<function>XColor</function>
+<structname>XColor</structname>
structures.
You specify which color components are to be changed by setting
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and/or
-<function>DoBlue</function>
+<symbol>DoBlue</symbol>
in the flags member of the
-<function>XColor</function>
+<structname>XColor</structname>
structures.
If the colormap is an installed map for its screen, the
changes are visible immediately.
-<function>XStoreColors </function>
+<function>XStoreColors</function>
changes the specified pixels if they are allocated writable in the colormap
by any client, even if one or more pixels generates an error.
If a specified pixel is not a valid index into the colormap, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If a specified pixel either is unallocated or is allocated read-only, a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
@@ -2582,10 +2582,10 @@ the one that gets reported is arbitrary. <!-- .LP -->
<function>XStoreColors</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2635,7 +2635,7 @@ Specifies the colormap. <para>
Specifies the color cell and the color to store.
Values specified in this
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure remain unchanged on return.
</para>
</listitem>
@@ -2648,27 +2648,27 @@ structure remain unchanged on return. The
<function>XcmsStoreColor</function>
function converts the color specified in the
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure into <acronym>RGB</acronym> values.
It then uses this <acronym>RGB</acronym> specification in an
-<function>XColor</function>
+<structname>XColor</structname>
structure, whose three flags
-(<function>DoRed</function>,
-<function>DoGreen</function>,
+(<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>)
+<symbol>DoBlue</symbol>)
are set, in a call to
<function>XStoreColor</function>
to change the color cell specified by the pixel member of the
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure.
This pixel value must be a valid index for the specified colormap,
and the color cell specified by the pixel value must be a read/write cell.
If the pixel value is not a valid index, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If the color cell is unallocated or is allocated read-only, a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
If the colormap is an installed map for its screen,
the changes are visible immediately.
@@ -2678,7 +2678,7 @@ the changes are visible immediately. Note that
<function>XStoreColor</function>
has no return value; therefore, an
-<function>XcmsSuccess</function>
+<symbol>XcmsSuccess</symbol>
return value from this function indicates that the conversion
to <acronym>RGB</acronym> succeeded and the call to
<function>XStoreColor</function>
@@ -2693,10 +2693,10 @@ to the color specified. <!-- .LP -->
<function>XcmsStoreColor</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2747,7 +2747,7 @@ Specifies the colormap. <listitem>
<para>
Specifies the color specification array of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures, each specifying a color cell and the color to store in that
cell.
Values specified in the array remain unchanged upon return.
@@ -2761,7 +2761,7 @@ Values specified in the array remain unchanged upon return. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -2775,9 +2775,9 @@ structures in the color-specification array. Returns an array of Boolean values indicating compression status.
If a non-NULL pointer is supplied,
each element of the array is set to
-<function>True</function>
+<symbol>True</symbol>
if the corresponding color was compressed and
-<function>False</function>
+<symbol>False</symbol>
otherwise.
Pass NULL if the compression status is not useful.
</para>
@@ -2791,26 +2791,26 @@ Pass NULL if the compression status is not useful. The
<function>XcmsStoreColors</function>
function converts the colors specified in the array of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures into <acronym>RGB</acronym> values and then uses these <acronym>RGB</acronym> specifications in
-<function>XColor</function>
+<structname>XColor</structname>
structures, whose three flags
-(<function>DoRed</function>,
-<function>DoGreen</function>,
+(<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>)
+<symbol>DoBlue</symbol>)
are set, in a call to
<function>XStoreColors</function>
to change the color cells specified by the pixel member of the corresponding
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure.
Each pixel value must be a valid index for the specified colormap,
and the color cell specified by each pixel value must be a read/write cell.
If a pixel value is not a valid index, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If a color cell is unallocated or is allocated read-only, a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
@@ -2822,7 +2822,7 @@ the changes are visible immediately. Note that
<function>XStoreColors</function>
has no return value; therefore, an
-<function>XcmsSuccess</function>
+<symbol>XcmsSuccess</symbol>
return value from this function indicates that conversions
to <acronym>RGB</acronym> succeeded and the call to
<function>XStoreColors</function>
@@ -2837,10 +2837,10 @@ to the colors specified. <!-- .LP -->
<function>XcmsStoreColors</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2929,29 +2929,29 @@ The flags argument determines which of the red, green, and blue components are set.
You can set this member to the
bitwise inclusive OR of the bits
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>.
+<symbol>DoBlue</symbol>.
If the color name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Use of uppercase or lowercase does not matter.
If the specified pixel is not a valid index into the colormap, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If the specified pixel either is unallocated or is allocated read-only, a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XStoreNamedColor</function>
can generate
-<function>BadAccess</function>,
-<function>BadColor</function>,
-<function>BadName</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadColor</errorname>,
+<errorname>BadName</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2961,15 +2961,15 @@ The and
<function>XQueryColors</function>
functions take pixel values in the pixel member of
-<function>XColor</function>
+<structname>XColor</structname>
structures and store in the structures the <acronym>RGB</acronym> values for those
pixels from the specified colormap.
The values returned for an unallocated entry are undefined.
These functions also set the flags member in the
-<function>XColor</function>
+<structname>XColor</structname>
structure to all three colors.
If a pixel is not a valid index into the specified colormap, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
@@ -3031,21 +3031,21 @@ Specifies and returns the <acronym>RGB</acronym> values for the pixel specified The
<function>XQueryColor</function>
function returns the current <acronym>RGB</acronym> value for the pixel in the
-<function>XColor</function>
+<structname>XColor</structname>
structure and sets the
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>
+<symbol>DoBlue</symbol>
flags.
</para>
<para>
<!-- .LP -->
<function>XQueryColor</function>
can generate
-<function>BadColor</function>
+<errorname>BadColor</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -3107,7 +3107,7 @@ specified in the structure. <para>
<!-- .\"Specifies the number of color definition structures. -->
Specifies the number of
-<function>XColor</function>
+<structname>XColor</structname>
structures in the color definition array.
</para>
</listitem>
@@ -3120,12 +3120,12 @@ structures in the color definition array. The
<function>XQueryColors</function>
function returns the <acronym>RGB</acronym> value for each pixel in each
-<function>XColor</function>
+<structname>XColor</structname>
structure and sets the
-<function>DoRed</function>,
-<function>DoGreen</function>,
+<symbol>DoRed</symbol>,
+<symbol>DoGreen</symbol>,
and
-<function>DoBlue</function>
+<symbol>DoBlue</symbol>
flags in each structure.
</para>
@@ -3133,9 +3133,9 @@ flags in each structure. <!-- .LP -->
<function>XQueryColors</function>
can generate
-<function>BadColor</function>
+<errorname>BadColor</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
<!-- .sp -->
</para>
@@ -3186,7 +3186,7 @@ Specifies the colormap. <para>
Specifies the pixel member that indicates the color cell to query.
The color specification stored for the color cell is returned in this
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure.
</para>
</listitem>
@@ -3210,21 +3210,21 @@ The <function>XcmsQueryColor</function>
function obtains the <acronym>RGB</acronym> value
for the pixel value in the pixel member of the specified
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure and then
converts the value to the target format as
specified by the result_format argument.
If the pixel is not a valid index in the specified colormap, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XcmsQueryColor</function>
can generate
-<function>BadColor</function>
+<errorname>BadColor</errorname>
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
<!-- .sp -->
</para>
@@ -3275,7 +3275,7 @@ Specifies the colormap. <listitem>
<para>
Specifies an array of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures, each pixel member indicating the color cell to query.
The color specifications for the color cells are returned in these structures.
</para>
@@ -3288,7 +3288,7 @@ The color specifications for the color cells are returned in these structures. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -3312,12 +3312,12 @@ The <function>XcmsQueryColors</function>
function obtains the <acronym>RGB</acronym> values
for pixel values in the pixel members of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures and then
converts the values to the target format as
specified by the result_format argument.
If a pixel is not a valid index into the specified colormap, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
@@ -3326,9 +3326,9 @@ the one that gets reported is arbitrary. <!-- .LP -->
<function>XcmsQueryColors</function>
can generate
-<function>BadColor</function>
+<errorname>BadColor</errorname>
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect1>
@@ -3581,7 +3581,7 @@ specific. <para>
<!-- .LP -->
Applications should not directly modify any part of the
-<function>XcmsCCC</function>.
+<structname>XcmsCCC</structname>.
The following lists the C language macros, their corresponding function
equivalents for other language bindings, and what data they both
can return.
@@ -3601,7 +3601,7 @@ can return. <funcsynopsis>
<funcprototype>
- <funcdef>Display <function>*XcmsDisplayOfCCC</function></funcdef>
+ <funcdef>Display *<function>XcmsDisplayOfCCC</function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3638,7 +3638,7 @@ Both return the display associated with the specified CCC. <funcsynopsis>
<funcprototype>
- <funcdef>Visual<function>*XcmsVisualOfCCC</function></funcdef>
+ <funcdef>Visual *<function>XcmsVisualOfCCC</function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3748,7 +3748,7 @@ Both return the white point of the screen associated with the specified CCC. <funcsynopsis>
<funcprototype>
- <funcdef>XcmsColor<function> *XcmsClientWhitePointOfCCC</function></funcdef>
+ <funcdef>XcmsColor *<function>XcmsClientWhitePointOfCCC</function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3788,7 +3788,7 @@ To set the Client White Point in the CCC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status <function> XcmsSetWhitePoint</function></funcdef>
+ <funcdef>Status <function>XcmsSetWhitePoint</function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
<paramdef>XcmsColor<parameter> *color</parameter></paramdef>
</funcprototype>
@@ -3827,14 +3827,14 @@ function changes the Client White Point in the specified CCC. Note that the pixel member is ignored
and that the color specification is left unchanged upon return.
The format for the new white point must be
-<function>XcmsCIEXYZFormat</function>,
-<function>XcmsCIEuvYFormat</function>,
-<function>XcmsCIExyYFormat</function>,
+<symbol>XcmsCIEXYZFormat</symbol>,
+<symbol>XcmsCIEuvYFormat</symbol>,
+<symbol>XcmsCIExyYFormat</symbol>,
or
-<function>XcmsUndefinedFormat</function>.
+<symbol>XcmsUndefinedFormat</symbol>.
If the color argument is NULL, this function sets the format component of the
Client White Point specification to
-<function>XcmsUndefinedFormat</function>,
+<symbol>XcmsUndefinedFormat</symbol>,
indicating that the Client White Point is assumed to be the same as the
Screen White Point.
</para>
@@ -3889,7 +3889,7 @@ If NULL is specified and a function using this CCC must convert a color specification to a device-dependent format and encounters a color
that lies outside the screen's color gamut,
that function will return
-<function>XcmsFailure</function>.
+<symbol>XcmsFailure</symbol>.
<!-- .ds Cd the gamut compression procedure -->
</para>
</listitem>
@@ -4074,7 +4074,7 @@ If NULL is specified and a function using this CCC must convert a color specification to a device-dependent format and encounters a color
that lies outside the screen's color gamut,
that function will return
-<function>XcmsFailure</function>.
+<symbol>XcmsFailure</symbol>.
</para>
</listitem>
</varlistentry>
@@ -4220,7 +4220,7 @@ Pixel members are ignored and remain unchanged upon return. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -4244,9 +4244,9 @@ Specifies the target color specification format. Returns an array of Boolean values indicating compression status.
If a non-NULL pointer is supplied,
each element of the array is set to
-<function>True</function>
+<symbol>True</symbol>
if the corresponding color was compressed and
-<function>False</function>
+<symbol>False</symbol>
otherwise.
Pass NULL if the compression status is not useful.
</para>
@@ -4260,11 +4260,11 @@ Pass NULL if the compression status is not useful. The
<function>XcmsConvertColors</function>
function converts the color specifications in the specified array of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures from their current format to a single target format,
using the specified CCC.
When the return value is
-<function>XcmsFailure</function>,
+<symbol>XcmsFailure</symbol>,
the contents of the color specification array are left unchanged.
</para>
<para>
@@ -4274,8 +4274,8 @@ The array may contain a mixture of color specification formats When the array contains both device-independent and
device-dependent color specifications and the target_format argument specifies
a device-dependent format (for example,
-<function>XcmsRGBiFormat</function>,
-<function>XcmsRGBFormat</function>),
+<symbol>XcmsRGBiFormat</symbol>,
+<symbol>XcmsRGBFormat</symbol>),
all specifications are converted to <acronym>CIE</acronym> XYZ format and then to the target
device-dependent format.
</para>
@@ -4294,9 +4294,9 @@ adjustment callbacks. <!-- .LP -->
The gamut compression procedure specified in the CCC
is called when an attempt to convert a color specification from
-<function>XcmsCIEXYZ</function>
+<structname>XcmsCIEXYZ</structname>
to a device-dependent format (typically
-<function>XcmsRGBi</function>)
+<structname>XcmsRGBi</structname>)
results in a color that lies outside the screen's color gamut.
If the gamut compression procedure requires client data, this data is passed
via the gamut compression client data in the CCC.
@@ -4361,7 +4361,7 @@ Pixel members should be ignored and must remain unchanged upon return. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -4373,7 +4373,7 @@ structures in the color-specification array. <listitem>
<para>
Specifies the index into the array of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures for the encountered color specification that lies outside the
screen's color gamut.
Valid values are 0 (for the first element) to ncolors - 1.
@@ -4389,7 +4389,7 @@ Valid values are 0 (for the first element) to ncolors - 1. Returns an array of Boolean values for indicating compression status.
If a non-NULL pointer is supplied
and a color at a given index is compressed, then
-<function>True</function>
+<symbol>True</symbol>
should be stored at the corresponding index in this array;
otherwise, the array should not be modified.
</para>
@@ -4416,7 +4416,7 @@ When called, elements 0 to index - 1 in the color specification array can be assumed to fall within the screen's color gamut.
In addition, these color specifications are already in some device-dependent
format (typically
-<function>XcmsRGBi</function>).
+<structname>XcmsRGBi</structname>).
If any modifications are made to these color specifications,
they must be in their initial device-dependent format upon return.
</para>
@@ -4427,9 +4427,9 @@ When called, the element in the color specification array specified by the index argument contains the color specification outside the
screen's color gamut encountered by the calling routine.
In addition, this color specification can be assumed to be in
-<function>XcmsCIEXYZ</function>.
+<structname>XcmsCIEXYZ</structname>.
Upon return, this color specification must be in
-<function>XcmsCIEXYZ</function>.
+<structname>XcmsCIEXYZ</structname>.
</para>
</listitem>
<listitem>
@@ -4438,10 +4438,10 @@ When called, elements from index to ncolors - 1 in the color specification array may or may not fall within the
screen's color gamut.
In addition, these color specifications can be assumed to be in
-<function>XcmsCIEXYZ</function>.
+<structname>XcmsCIEXYZ</structname>.
If any modifications are made to these color specifications,
they must be in
-<function>XcmsCIEXYZ</function>
+<structname>XcmsCIEXYZ</structname>
upon return.
</para>
</listitem>
@@ -4720,7 +4720,7 @@ Pixel members should be ignored and must remain unchanged upon return. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -4734,7 +4734,7 @@ structures in the color-specification array. Returns an array of Boolean values for indicating compression status.
If a non-NULL pointer is supplied
and a color at a given index is compressed, then
-<function>True</function>
+<symbol>True</symbol>
should be stored at the corresponding index in this array;
otherwise, the array should not be modified.
</para>
@@ -4768,7 +4768,7 @@ This uses the <acronym>CIE</acronym> L*a*b* color space for adjusting the chroma of colors to compensate for the chromatic differences between the source
and destination white points.
This procedure simply converts the color specifications to
-<function>XcmsCIELab</function>
+<structname>XcmsCIELab</structname>
using the source white point and then converts to the target specification
format using the destination's white point.
No client data is necessary.
@@ -4785,7 +4785,7 @@ This uses the <acronym>CIE</acronym> L*u*v* color space for adjusting the chroma of colors to compensate for the chromatic differences between the source
and destination white points.
This procedure simply converts the color specifications to
-<function>XcmsCIELuv</function>
+<structname>XcmsCIELuv</structname>
using the source white point and then converts to the target specification
format using the destination's white point.
No client data is necessary.
@@ -4802,7 +4802,7 @@ This uses the TekHVC color space for adjusting the chromatic character of colors to compensate for the chromatic differences between the source
and destination white points.
This procedure simply converts the color specifications to
-<function>XcmsTekHVC</function>
+<structname>XcmsTekHVC</structname>
using the source white point and then converts to the target specification
format using the destination's white point.
An advantage of this procedure over those previously described
@@ -4845,26 +4845,26 @@ procedure twice: <listitem>
<para>
Once to convert to
-<function>XcmsRGB</function>
+<structname>XcmsRGB</structname>
</para>
</listitem>
<listitem>
<para>
A second time to convert from
-<function>XcmsRGB </function>
+<structname>XcmsRGB</structname>
</para>
</listitem>
</itemizedlist>
<para>
<!-- .LP -->
For example, assume the specification is in
-<function>XcmsCIEuvY</function>
+<structname>XcmsCIEuvY</structname>
and the adjustment procedure is
<function>XcmsCIELuvWhiteShiftColors</function>.
During conversion to
-<function>XcmsRGB</function>,
+<structname>XcmsRGB</structname>,
the call to
-<function>XcmsAllocColor </function>
+<function>XcmsAllocColor</function>
results in the following series of color specification conversions:
<!-- .\" Do these need to be font coded? -->
</para>
@@ -4872,44 +4872,44 @@ results in the following series of color specification conversions: <listitem>
<para>
From
-<function>XcmsCIEuvY</function>
+<structname>XcmsCIEuvY</structname>
to
-<function>XcmsCIELuv</function>
+<structname>XcmsCIELuv</structname>
using the Client White Point
</para>
</listitem>
<listitem>
<para>
From
-<function>XcmsCIELuv</function>
+<structname>XcmsCIELuv</structname>
to
-<function>XcmsCIEuvY</function>
+<structname>XcmsCIEuvY</structname>
using the Screen White Point
</para>
</listitem>
<listitem>
<para>
From
-<function>XcmsCIEuvY</function>
+<structname>XcmsCIEuvY</structname>
to
-<function>XcmsCIEXYZ</function>
+<structname>XcmsCIEXYZ</structname>
(<acronym>CIE</acronym> u'v'Y and XYZ are white-point-independent color spaces)
</para>
</listitem>
<listitem>
<para>
From
-<function>XcmsCIEXYZ</function>
+<structname>XcmsCIEXYZ</structname>
to
-<function>XcmsRGBi</function>
+<structname>XcmsRGBi</structname>
</para>
</listitem>
<listitem>
<para>
From
-<function>XcmsRGBi</function>
+<structname>XcmsRGBi</structname>
to
-<function>XcmsRGB</function>
+<structname>XcmsRGB</structname>
</para>
</listitem>
</itemizedlist>
@@ -4921,7 +4921,7 @@ and the <acronym>RGB</acronym> specification returned by
<function>XAllocColor</function>
is converted back to
-<function>XcmsCIEuvY</function>
+<structname>XcmsCIEuvY</structname>
by reversing the color conversion sequence.
</para>
</sect2>
@@ -5520,7 +5520,7 @@ finds the point in <acronym>CIE</acronym> L*a*b* color space of maximum lightness (L*) displayable by the screen.
It returns this point in <acronym>CIE</acronym> L*a*b* coordinates.
An
-<function>XcmsFailure</function>
+<symbol>XcmsFailure</symbol>
return value usually indicates that the given chroma
is beyond maximum for the given hue angle.
<!-- .sp -->
@@ -5682,7 +5682,7 @@ function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen.
It returns this point in <acronym>CIE</acronym> L*a*b* coordinates.
An
-<function>XcmsFailure</function>
+<symbol>XcmsFailure</symbol>
return value usually indicates that the given chroma
is beyond maximum for the given hue angle.
</para>
@@ -5877,7 +5877,7 @@ finds the point in <acronym>CIE</acronym> L*u*v* color space of maximum lightness (L*) displayable by the screen.
It returns this point in <acronym>CIE</acronym> L*u*v* coordinates.
An
-<function>XcmsFailure</function>
+<symbol>XcmsFailure</symbol>
return value usually indicates that the given chroma
is beyond maximum for the given hue angle.
<!-- .sp -->
@@ -5969,7 +5969,7 @@ for a given Psychometric Hue Angle and Psychometric Chroma, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> </function></funcdef>
+ <funcdef>Status <function>XcmsCIELuvQueryMinL</function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
<paramdef>XcmsFloat<parameter> hue_angle</parameter></paramdef>
<paramdef>XcmsFloat<parameter> chroma</parameter></paramdef>
@@ -6039,7 +6039,7 @@ function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen.
It returns this point in <acronym>CIE</acronym> L*u*v* coordinates.
An
-<function>XcmsFailure</function>
+<symbol>XcmsFailure</symbol>
return value usually indicates that the given chroma
is beyond maximum for the given hue angle.
</para>
@@ -6512,13 +6512,13 @@ function. The <acronym>CIE</acronym> XYZ color space serves as the hub for all
conversions between device-independent and device-dependent color spaces.
Therefore, the knowledge to convert an
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure to and from <acronym>CIE</acronym> XYZ format is associated with each color space.
For example, conversion from <acronym>CIE</acronym> L*u*v* to <acronym>RGB</acronym> requires the knowledge
to convert from <acronym>CIE</acronym> L*u*v* to <acronym>CIE</acronym> XYZ and from <acronym>CIE</acronym> XYZ to <acronym>RGB</acronym>.
This knowledge is stored as an array of functions that,
when applied in series, will convert the
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure to or from <acronym>CIE</acronym> XYZ format.
This color specification conversion mechanism facilitates
the addition of color spaces.
@@ -6571,7 +6571,7 @@ Specifies the device-independent color space to add. The
<function>XcmsAddColorSpace</function>
function makes a device-independent color space (actually an
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure) accessible by the color management system.
Because format values for unregistered color spaces are assigned at run time,
they should be treated as private to the client.
@@ -6587,16 +6587,16 @@ and <para>
<!-- .LP -->
If the
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure is already accessible in the color management system,
<function>XcmsAddColorSpace</function>
returns
-<function>XcmsSuccess</function>.
+<symbol>XcmsSuccess</symbol>.
</para>
<para>
<!-- .LP -->
Note that added
-<function>XcmsColorSpaces</function>
+<structname>XcmsColorSpace</structname>s
must be retained for reference by Xlib.
</para>
</sect2>
@@ -6615,7 +6615,7 @@ associated with a specified color string prefix, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XcmsColorFormat<function>XcmsFormatOfPrefix</function></funcdef>
+ <funcdef>XcmsColorFormat <function>XcmsFormatOfPrefix</function></funcdef>
<paramdef>char<parameter> *prefix</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6644,7 +6644,7 @@ The prefix is case-insensitive. If the color space is not accessible in the color management system,
<function>XcmsFormatOfPrefix</function>
returns
-<function>XcmsUndefinedFormat</function>.
+<symbol>XcmsUndefinedFormat</symbol>.
</para>
<para>
<!-- .LP -->
@@ -6657,7 +6657,7 @@ specified by a color format, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char <function>*XcmsPrefixOfFormat</function></funcdef>
+ <funcdef>char *<function>XcmsPrefixOfFormat</function></funcdef>
<paramdef>XcmsColorFormat<parameter> format</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6695,7 +6695,7 @@ The returned string must be treated as read-only. <!-- .LP -->
Color space specific information necessary
for color space conversion and color string parsing is stored in an
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure.
Therefore, a new structure containing this information is required
for each additional color space.
@@ -6708,7 +6708,7 @@ function. <para>
<!-- .LP -->
If a new
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure specifies a color space not registered with the X Consortium,
they should be treated as private to the client
because format values for unregistered color spaces are assigned at run time.
@@ -6752,7 +6752,7 @@ The format member specifies the color specification format. Formats for unregistered color spaces are assigned at run time.
The parseString member contains a pointer to the function
that can parse a color string into an
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure.
This function returns an integer (int): nonzero if it succeeded
and zero otherwise.
@@ -6760,7 +6760,7 @@ The to_CIEXYZ and from_CIEXYZ members contain pointers, each to a NULL terminated list of function pointers.
When the list of functions is executed in series,
it will convert the color specified in an
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structure from/to the current color space format to/from the <acronym>CIE</acronym> XYZ format.
Each function returns an integer (int): nonzero if it succeeded
and zero otherwise.
@@ -6793,7 +6793,7 @@ thus bypassing <acronym>CIE</acronym> XYZ if possible (for example, TekHVC to <a <para>
<!-- .LP -->
The callback in the
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure for parsing a color string for the particular color space must
adhere to the following software interface specification:
</para>
@@ -6843,7 +6843,7 @@ Returns the color specification in the color space's format. <para>
<!-- .LP -->
Callback functions in the
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure for converting a color specification between device-independent
spaces must adhere to the
following software interface specification:
@@ -6851,7 +6851,7 @@ following software interface specification: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status <function>ConversionProc</function></funcdef>
+ <funcdef>Status <function><replaceable>ConversionProc</replaceable></function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
<paramdef>XcmsColor<parameter> *white_point</parameter></paramdef>
<paramdef>XcmsColor<parameter> *colors_in_out</parameter></paramdef>
@@ -6900,7 +6900,7 @@ Pixel members should be ignored and must remain unchanged upon return. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -6912,7 +6912,7 @@ structures in the color-specification array. <!-- .eM -->
<!-- .sp -->
Callback functions in the
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure for converting a color specification to or from a device-dependent
space must adhere to the
following software interface specification:
@@ -6920,7 +6920,7 @@ following software interface specification: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status <function>ConversionProc</function></funcdef>
+ <funcdef>Status <function><replaceable>ConversionProc</replaceable></function></funcdef>
<paramdef>XcmsCCC<parameter> ccc</parameter></paramdef>
<paramdef>XcmsColor<parameter> *colors_in_out</parameter></paramdef>
<paramdef>unsignedint<parameter> ncolors</parameter></paramdef>
@@ -6957,7 +6957,7 @@ Pixel members should be ignored and must remain unchanged upon return. <listitem>
<para>
Specifies the number of
-<function>XcmsColor</function>
+<structname>XcmsColor</structname>
structures in the color-specification array.
</para>
</listitem>
@@ -6971,7 +6971,7 @@ structures in the color-specification array. Returns an array of Boolean values for indicating compression status.
If a non-NULL pointer is supplied
and a color at a given index is compressed, then
-<function>True</function>
+<symbol>True</symbol>
should be stored at the corresponding index in this array;
otherwise, the array should not be modified.
</para>
@@ -7001,73 +7001,73 @@ The conversion functions provided by Xlib are: <tbody>
<row>
<entry><function>XcmsCIELabToCIEXYZ</function></entry>
- <entry><function>XcmsCIELabFormat</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
+ <entry><symbol>XcmsCIELabFormat</symbol></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIELuvToCIEuvY</function></entry>
- <entry><function>XcmsCIELuvFormat</function></entry>
- <entry><function>XcmsCIEuvYFormat</function></entry>
+ <entry><symbol>XcmsCIELuvFormat</symbol></entry>
+ <entry><symbol>XcmsCIEuvYFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEXYZToCIELab</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
- <entry><function>XcmsCIELabFormat</function></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
+ <entry><symbol>XcmsCIELabFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEXYZToCIEuvY</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
- <entry><function>XcmsCIEuvYFormat</function></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
+ <entry><symbol>XcmsCIEuvYFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEXYZToCIExyY</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
- <entry><function>XcmsCIExyYFormat</function></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
+ <entry><symbol>XcmsCIExyYFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEXYZToRGBi</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
- <entry><function>XcmsRGBiFormat</function></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
+ <entry><symbol>XcmsRGBiFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEuvYToCIELuv</function></entry>
- <entry><function>XcmsCIEuvYFormat</function></entry>
- <entry><function>XcmsCIELabFormat</function></entry>
+ <entry><symbol>XcmsCIEuvYFormat</symbol></entry>
+ <entry><symbol>XcmsCIELabFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEuvYToCIEXYZ</function></entry>
- <entry><function>XcmsCIEuvYFormat</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
+ <entry><symbol>XcmsCIEuvYFormat</symbol></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIEuvYToTekHVC</function></entry>
- <entry><function>XcmsCIEuvYFormat</function></entry>
- <entry><function>XcmsTekHVCFormat</function></entry>
+ <entry><symbol>XcmsCIEuvYFormat</symbol></entry>
+ <entry><symbol>XcmsTekHVCFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsCIExyYToCIEXYZ</function></entry>
- <entry><function>XcmsCIExyYFormat</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
+ <entry><symbol>XcmsCIExyYFormat</symbol></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsRGBToRGBi</function></entry>
- <entry><function>XcmsRGBFormat</function></entry>
- <entry><function>XcmsRGBiFormat</function></entry>
+ <entry><symbol>XcmsRGBFormat</symbol></entry>
+ <entry><symbol>XcmsRGBiFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsRGBiToCIEXYZ</function></entry>
- <entry><function>XcmsRGBiFormat</function></entry>
- <entry><function>XcmsCIEXYZFormat</function></entry>
+ <entry><symbol>XcmsRGBiFormat</symbol></entry>
+ <entry><symbol>XcmsCIEXYZFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsRGBiToRGB</function></entry>
- <entry><function>XcmsRGBiFormat</function></entry>
- <entry><function>XcmsRGBFormat</function></entry>
+ <entry><symbol>XcmsRGBiFormat</symbol></entry>
+ <entry><symbol>XcmsRGBFormat</symbol></entry>
</row>
<row>
<entry><function>XcmsTekHVCToCIEuvY</function></entry>
- <entry><function>XcmsTekHVCFormat</function></entry>
- <entry><function>XcmsCIEuvYFormat</function></entry>
+ <entry><symbol>XcmsTekHVCFormat</symbol></entry>
+ <entry><symbol>XcmsCIEuvYFormat</symbol></entry>
</row>
</tbody>
</tgroup>
@@ -7148,12 +7148,12 @@ The <function>XcmsAddFunctionSet</function>
function adds a function set to the color management system.
If the function set uses device-dependent
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structures not accessible in the color management system,
<function>XcmsAddFunctionSet</function>
adds them.
If an added
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure is for a device-dependent color space not registered
with the X Consortium,
they should be treated as private to the client
@@ -7172,9 +7172,9 @@ and Additional function sets should be added before any calls to other
Xlib routines are made.
If not, the
-<function>XcmsPerScrnInfo</function>
+<structname>XcmsPerScrnInfo</structname>
member of a previously created
-<function>XcmsCCC</function>
+<structname>XcmsCCC</structname>
does not have the opportunity to initialize
with the added function set.
</para>
@@ -7190,11 +7190,11 @@ The creation of additional function sets should be required only when an output device does not conform to existing
function sets or when additional device-dependent color spaces are necessary.
A function set consists primarily of a collection of device-dependent
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structures and a means to read and store a
screen's color characterization data.
This data is stored in an
-<function>XcmsFunctionSet</function>
+<structname>XcmsFunctionSet</structname>
structure.
A handle to this structure (that is, by means of global variable)
is usually made accessible to the client program for use with
@@ -7203,18 +7203,18 @@ is usually made accessible to the client program for use with <para>
<!-- .LP -->
If a function set uses new device-dependent
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structures,
they will be transparently processed into the color management system.
Function sets can share an
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structure for a device-dependent color space.
In addition, multiple
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structures are allowed for a device-dependent color space;
however, a function set can reference only one of them.
These
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structures will differ in the functions to convert to and from <acronym>CIE</acronym> XYZ,
thus tailored for the specific function set.
<!-- .sM -->
@@ -7236,12 +7236,12 @@ typedef struct _XcmsFunctionSet { <!-- .eM -->
The DDColorSpaces member is a pointer to a NULL terminated list
of pointers to
-<function>XcmsColorSpace</function>
+<structname>XcmsColorSpace</structname>
structures for the device-dependent color spaces that are supported
by the function set.
The screenInitProc member is set to the callback procedure (see the following
interface specification) that initializes the
-<function>XcmsPerScrnInfo</function>
+<structname>XcmsPerScrnInfo</structname>
structure for a particular screen.
</para>
<para>
@@ -7289,7 +7289,7 @@ Specifies the appropriate screen number on the host server. <listitem>
<para>
Specifies the
-<function>XcmsPerScrnInfo </function>
+<structname>XcmsPerScrnInfo</structname>
structure, which contains the per screen information.
</para>
</listitem>
@@ -7300,18 +7300,18 @@ structure, which contains the per screen information. <!-- .LP -->
<!-- .eM -->
The screen initialization callback in the
-<function>XcmsFunctionSet</function>
+<structname>XcmsFunctionSet</structname>
structure fetches the color characterization data (device profile) for
the specified screen,
typically off properties on the
screen's root window.
It then initializes the specified
-<function>XcmsPerScrnInfo</function>
+<structname>XcmsPerScrnInfo</structname>
structure.
<indexterm><primary>Device profile</primary></indexterm>
<indexterm><primary>Color Characterization Data</primary></indexterm>
If successful, the procedure fills in the
-<function>XcmsPerScrnInfo</function>
+<structname>XcmsPerScrnInfo</structname>
structure as follows:
</para>
<itemizedlist>
@@ -7330,30 +7330,30 @@ It next sets the screenWhitePoint member. <listitem>
<para>
It next sets the functionSet member to the address of the
-<function>XcmsFunctionSet</function>
+<structname>XcmsFunctionSet</structname>
structure.
</para>
</listitem>
<listitem>
<para>
It then sets the state member to
-<function>XcmsInitSuccess </function>
+<symbol>XcmsInitSuccess</symbol>
and finally returns
-<function>XcmsSuccess</function>.
+<symbol>XcmsSuccess</symbol>.
</para>
</listitem>
</itemizedlist>
<para>
<!-- .LP -->
If unsuccessful, the procedure sets the state member to
-<function>XcmsInitFailure</function>
+<symbol>XcmsInitFailure</symbol>
and returns
-<function>XcmsFailure</function>.
+<symbol>XcmsFailure</symbol>.
</para>
<para>
<!-- .LP -->
The
-<function>XcmsPerScrnInfo</function>
+<structname>XcmsPerScrnInfo</structname>
structure contains:
<!-- .sM -->
</para>
@@ -7383,19 +7383,19 @@ The state member is set to one of the following: <itemizedlist>
<listitem>
<para>
-<function>XcmsInitNone</function>
+<symbol>XcmsInitNone</symbol>
indicates initialization has not been previously attempted.
</para>
</listitem>
<listitem>
<para>
-<function>XcmsInitFailure</function>
+<symbol>XcmsInitFailure</symbol>
indicates initialization has been previously attempted but failed.
</para>
</listitem>
<listitem>
<para>
-<function>XcmsInitSuccess</function>
+<symbol>XcmsInitSuccess</symbol>
indicates initialization has been previously attempted and succeeded.
</para>
</listitem>
@@ -7429,7 +7429,7 @@ Specifies the data to be freed. <!-- .LP -->
<!-- .eM -->
This function is called to free the screenData stored in an
-<function>XcmsPerScrnInfo</function>
+<structname>XcmsPerScrnInfo</structname>
structure.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH07.xml b/libX11/specs/libX11/CH07.xml index 6e8894080..ae977b365 100644 --- a/libX11/specs/libX11/CH07.xml +++ b/libX11/specs/libX11/CH07.xml @@ -58,11 +58,11 @@ sharing GCs between applications is highly discouraged. <!-- .LP -->
To set an attribute of a GC,
set the appropriate member of the
-<function>XGCValues</function>
+<structname>XGCValues</structname>
structure and OR in the corresponding value bitmask in your subsequent calls to
<function>XCreateGC</function>.
The symbols for the value mask bits and the
-<function>XGCValues</function>
+<structname>XGCValues</structname>
structure are:
<!-- .sM -->
</para>
@@ -147,7 +147,7 @@ The default GC values are: <tbody>
<row>
<entry>function</entry>
- <entry><function>GXcopy</function></entry>
+ <entry><symbol>GXcopy</symbol></entry>
</row>
<row>
<entry>plane_mask</entry>
@@ -167,27 +167,27 @@ The default GC values are: </row>
<row>
<entry>line_style</entry>
- <entry><function>LineSolid</function></entry>
+ <entry><symbol>LineSolid</symbol></entry>
</row>
<row>
<entry>cap_style</entry>
- <entry><function>CapButt</function></entry>
+ <entry><symbol>CapButt</symbol></entry>
</row>
<row>
<entry>join_style</entry>
- <entry><function>JoinMiter</function></entry>
+ <entry><symbol>JoinMiter</symbol></entry>
</row>
<row>
<entry>fill_style</entry>
- <entry><function>FillSolid</function></entry>
+ <entry><symbol>FillSolid</symbol></entry>
</row>
<row>
<entry>fill_rule</entry>
- <entry><function>EvenOddRule</function></entry>
+ <entry><symbol>EvenOddRule</symbol></entry>
</row>
<row>
<entry>arc_mode</entry>
- <entry><function>ArcPieSlice</function></entry>
+ <entry><symbol>ArcPieSlice</symbol></entry>
</row>
<row>
<entry>tile</entry>
@@ -219,11 +219,11 @@ The default GC values are: </row>
<row>
<entry>subwindow_mode</entry>
- <entry><function>ClipByChildren</function></entry>
+ <entry><symbol>ClipByChildren</symbol></entry>
</row>
<row>
<entry>graphics_exposures</entry>
- <entry><function>True</function></entry>
+ <entry><symbol>True</symbol></entry>
</row>
<row>
<entry>clip_x_origin</entry>
@@ -235,7 +235,7 @@ The default GC values are: </row>
<row>
<entry>clip_mask</entry>
- <entry><function>None</function></entry>
+ <entry><symbol>None</symbol></entry>
</row>
<row>
<entry>dash_offset</entry>
@@ -264,12 +264,12 @@ The function attributes of a GC are used when you update a section of a drawable (the destination) with bits from somewhere else (the source).
The function in a GC defines how the new destination bits are to be
computed from the source bits and the old destination bits.
-<function>GXcopy</function>
+<symbol>GXcopy</symbol>
is typically the most useful because it will work on a color display,
but special applications may use other functions,
particularly in concert with particular planes of a color display.
The 16 GC functions, defined in
-<!-- .hN X11/X.h , -->
+<<filename class="headerfile">X11/X.h</filename>>,
are:
</para>
<!-- .\" are listed in Table 5-1 along with the -->
@@ -291,82 +291,82 @@ are: </thead>
<tbody>
<row>
- <entry><function>GXclear</function></entry>
+ <entry><symbol>GXclear</symbol></entry>
<entry>0x0</entry>
<entry>0</entry>
</row>
<row>
- <entry><function>GXand</function></entry>
+ <entry><symbol>GXand</symbol></entry>
<entry>0x1</entry>
<entry>src AND dst</entry>
</row>
<row>
- <entry><function>GXandReverse</function></entry>
+ <entry><symbol>GXandReverse</symbol></entry>
<entry>0x2</entry>
<entry>src AND NOT dst</entry>
</row>
<row>
- <entry><function>GXcopy</function></entry>
+ <entry><symbol>GXcopy</symbol></entry>
<entry>0x3</entry>
<entry>src</entry>
</row>
<row>
- <entry><function>GXandInverted</function></entry>
+ <entry><symbol>GXandInverted</symbol></entry>
<entry>0x4</entry>
<entry>(NOT src) AND dst</entry>
</row>
<row>
- <entry><function>GXnoop</function></entry>
+ <entry><symbol>GXnoop</symbol></entry>
<entry>0x5</entry>
<entry>dst</entry>
</row>
<row>
- <entry><function>GXxor</function></entry>
+ <entry><symbol>GXxor</symbol></entry>
<entry>0x6</entry>
<entry>src XOR dst</entry>
</row>
<row>
- <entry><function>GXor</function></entry>
+ <entry><symbol>GXor</symbol></entry>
<entry>0x7</entry>
<entry>src OR dst</entry>
</row>
<row>
- <entry><function>GXnor</function></entry>
+ <entry><symbol>GXnor</symbol></entry>
<entry>0x8</entry>
<entry>(NOT src) AND (NOT dst)</entry>
</row>
<row>
- <entry><function>GXequiv</function></entry>
+ <entry><symbol>GXequiv</symbol></entry>
<entry>0x9</entry>
<entry>(NOT src) XOR dst</entry>
</row>
<row>
- <entry><function>GXinvert</function></entry>
+ <entry><symbol>GXinvert</symbol></entry>
<entry>0xa</entry>
<entry>NOT dst</entry>
</row>
<row>
- <entry><function>GXorReverse</function></entry>
+ <entry><symbol>GXorReverse</symbol></entry>
<entry>0xb</entry>
<entry>src OR (NOT dst)</entry>
</row>
<row>
- <entry><function>GXcopyInverted</function></entry>
+ <entry><symbol>GXcopyInverted</symbol></entry>
<entry>0xc</entry>
<entry>NOT src</entry>
</row>
<row>
- <entry><function>GXorInverted</function></entry>
+ <entry><symbol>GXorInverted</symbol></entry>
<entry>0xd</entry>
<entry>(NOT src) OR dst</entry>
</row>
<row>
- <entry><function>GXnand</function></entry>
+ <entry><symbol>GXnand</symbol></entry>
<entry>0xe</entry>
<entry>(NOT src) OR (NOT dst)</entry>
</row>
<row>
- <entry><function>GXset</function></entry>
+ <entry><symbol>GXset</symbol></entry>
<entry>0xf</entry>
<entry>1</entry>
</row>
@@ -393,7 +393,7 @@ the result is computed bitwise on corresponding bits of the pixels. That is, a Boolean operation is performed in each bit plane.
The plane_mask restricts the operation to a subset of planes.
A macro constant
-<function>AllPlanes</function>
+<symbol>AllPlanes</symbol>
can be used to refer to all planes of the screen simultaneously.
The result is computed by the following:
</para>
@@ -496,34 +496,34 @@ The line-style defines which sections of a line are drawn: <variablelist>
<varlistentry>
- <term><function>LineSolid</function></term>
+ <term><symbol>LineSolid</symbol></term>
<listitem>
<para>The full path of the line is drawn.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><function>LineDoubleDash</function></term>
+ <term><symbol>LineDoubleDash</symbol></term>
<listitem>
<para>
The full path of the line is drawn,
but the even dashes are filled differently
from the odd dashes (see fill-style) with <!-- xref -->
-<function>CapButt </function>
+<symbol>CapButt</symbol>
style used where even and odd dashes meet.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><function>LineOnOffDash</function></term>
+ <term><symbol>LineOnOffDash</symbol></term>
<listitem>
<para>
Only the even dashes are drawn,
and cap-style applies to
all internal ends of the individual dashes,
except
-<function>CapNotLast</function>
+<symbol>CapNotLast</symbol>
is treated as
-<function>CapButt</function>.
+<symbol>CapButt</symbol>.
</para>
</listitem>
</varlistentry>
@@ -534,18 +534,18 @@ The cap-style defines how the endpoints of a path are drawn: <variablelist>
<varlistentry>
- <term><function>CapNotLast</function></term>
+ <term><symbol>CapNotLast</symbol></term>
<listitem>
<para>
This is equivalent to
-<function>CapButt</function>
+<symbol>CapButt</symbol>
except that for a line-width of zero the final endpoint is not drawn.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><function>CapButt</function></term>
+ <term><symbol>CapButt</symbol></term>
<listitem>
<para>
The line is square at the endpoint (perpendicular to the slope of the line)
@@ -554,25 +554,25 @@ with no projection beyond. </listitem>
</varlistentry>
<varlistentry>
- <term><function>CapRound</function></term>
+ <term><symbol>CapRound</symbol></term>
<listitem>
<para>
The line has a circular arc with the diameter equal to the line-width,
centered on the endpoint.
(This is equivalent to
-<function>CapButt </function>
+<symbol>CapButt</symbol>
for line-width of zero).
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><function>CapProjecting</function></term>
+ <term><symbol>CapProjecting</symbol></term>
<listitem>
<para>
The line is square at the end, but the path continues beyond the endpoint
for a distance equal to half the line-width.
(This is equivalent to
-<function>CapButt </function>
+<symbol>CapButt</symbol>
for line-width of zero).
</para>
</listitem>
@@ -585,19 +585,19 @@ The join-style defines how corners are drawn for wide lines: <variablelist>
<varlistentry>
- <term><function>JoinMiter</function></term>
+ <term><symbol>JoinMiter</symbol></term>
<listitem>
<para>
The outer edges of two lines extend to meet at an angle.
However, if the angle is less than 11 degrees,
then a
-<function>JoinBevel</function>
+<symbol>JoinBevel</symbol>
join-style is used instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><function>JoinRound</function></term>
+ <term><symbol>JoinRound</symbol></term>
<listitem>
<para>
The corner is a circular arc with the diameter equal to the line-width,
@@ -606,11 +606,11 @@ centered on the joinpoint. </listitem>
</varlistentry>
<varlistentry>
- <term><function>JoinBevel</function></term>
+ <term><symbol>JoinBevel</symbol></term>
<listitem>
<para>
The corner has
-<function>CapButt </function>
+<symbol>CapButt</symbol>
endpoint styles with the triangular notch filled.
</para>
</listitem>
@@ -632,42 +632,42 @@ the semantics depends on the line-width and the cap-style: <colspec colname='c3'/>
<tbody>
<row>
- <entry><function>CapNotLast</function></entry>
+ <entry><symbol>CapNotLast</symbol></entry>
<entry>thin</entry>
<entry>The results are device dependent,
but the desired effect is that nothing is drawn.</entry>
</row>
<row>
- <entry><function>CapButt</function></entry>
+ <entry><symbol>CapButt</symbol></entry>
<entry>thin</entry>
<entry>The results are device dependent,
but the desired effect is that a single pixel is drawn.</entry>
</row>
<row>
- <entry><function>CapRound</function></entry>
+ <entry><symbol>CapRound</symbol></entry>
<entry>thin</entry>
<entry>The results are the same as for
- <function>CapButt /thin</function>.</entry>
+ <symbol>CapButt</symbol> /thin.</entry>
</row>
<row>
- <entry><function>CapProjecting</function></entry>
+ <entry><symbol>CapProjecting</symbol></entry>
<entry>thin</entry>
<entry>The results are the same as for
- <function>CapButt /thin</function>.</entry>
+ <symbol>CapButt</symbol> /thin.</entry>
</row>
<row>
- <entry><function>CapButt</function></entry>
+ <entry><symbol>CapButt</symbol></entry>
<entry>wide</entry>
<entry>Nothing is drawn.</entry>
</row>
<row>
- <entry><function>CapRound</function></entry>
+ <entry><symbol>CapRound</symbol></entry>
<entry>wide</entry>
<entry>The closed path is a circle, centered at the endpoint, and
with the diameter equal to the line-width.</entry>
</row>
<row>
- <entry><function>CapProjecting</function></entry>
+ <entry><symbol>CapProjecting</symbol></entry>
<entry>wide</entry>
<entry>The closed path is a square, aligned with the coordinate axes, centered at the
endpoint, and with the sides equal to the line-width.</entry>
@@ -698,16 +698,16 @@ origin of whatever destination drawable is specified in a graphics request.
The tile pixmap must have the same root and depth as the GC,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
The stipple pixmap must have depth one and must have the same root as the
GC, or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
For stipple operations where the fill-style is
-<function>FillStippled</function>
+<symbol>FillStippled</symbol>
but not
-<function>FillOpaqueStippled</function>,
+<symbol>FillOpaqueStippled</symbol>,
the stipple pattern is tiled in a
single plane and acts as an additional clip mask to be ANDed with the clip-mask.
Although some sizes may be faster to use than others,
@@ -727,16 +727,16 @@ and <function>XFillArc</function>);
for line requests
with line-style
-<function>LineSolid </function>
+<symbol>LineSolid</symbol>
(for example,
<function>XDrawLine</function>,
<function>XDrawSegments</function>,
<function>XDrawRectangle</function>,
<function>XDrawArc</function>);
and for the even dashes for line requests with line-style
-<function>LineOnOffDash </function>
+<symbol>LineOnOffDash</symbol>
or
-<function>LineDoubleDash</function>,
+<symbol>LineDoubleDash</symbol>,
the following apply:
</para>
@@ -746,21 +746,21 @@ the following apply: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>FillSolid</function></entry>
+ <entry><symbol>FillSolid</symbol></entry>
<entry>Foreground</entry>
</row>
<row>
- <entry><function>FillTiled</function></entry>
+ <entry><symbol>FillTiled</symbol></entry>
<entry>Tile</entry>
</row>
<row>
- <entry><function>FillOpaqueStippled</function></entry>
+ <entry><symbol>FillOpaqueStippled</symbol></entry>
<entry>A tile with the same width and height as stipple,
but with background everywhere stipple has a zero
and with foreground everywhere stipple has a one</entry>
</row>
<row>
- <entry><function>FillStippled</function></entry>
+ <entry><symbol>FillStippled</symbol></entry>
<entry>Foreground masked by stipple</entry>
</row>
</tbody>
@@ -770,7 +770,7 @@ the following apply: <para>
<!-- .LP -->
When drawing lines with line-style
-<function>LineDoubleDash</function>,
+<symbol>LineDoubleDash</symbol>,
the odd dashes are controlled by the fill-style in the following manner:
</para>
@@ -780,19 +780,19 @@ the odd dashes are controlled by the fill-style in the following manner: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>FillSolid</function></entry>
+ <entry><symbol>FillSolid</symbol></entry>
<entry>Background</entry>
</row>
<row>
- <entry><function>FillTiled</function></entry>
+ <entry><symbol>FillTiled</symbol></entry>
<entry>Same as for even dashes</entry>
</row>
<row>
- <entry><function>FillOpaqueStippled</function></entry>
+ <entry><symbol>FillOpaqueStippled</symbol></entry>
<entry>Same as for even dashes</entry>
</row>
<row>
- <entry><function>FillStippled</function></entry>
+ <entry><symbol>FillStippled</symbol></entry>
<entry>Background masked by stipple</entry>
</row>
</tbody>
@@ -830,7 +830,7 @@ value of N is equivalent to specifying the two-element list [N, N] in <function>XSetDashes</function>.
The value must be nonzero,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
@@ -839,10 +839,10 @@ The clip-mask restricts writes to the destination drawable. If the clip-mask is set to a pixmap,
it must have depth one and have the same root as the GC,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
If clip-mask is set to
-<function>None</function>,
+<symbol>None</symbol>,
the pixels are always drawn regardless of the clip origin.
The clip-mask also can be set by calling the
<function>XSetClipRectangles</function>
@@ -860,22 +860,22 @@ destination drawable is specified in a graphics request. <para>
<!-- .LP -->
You can set the subwindow-mode to
-<function>ClipByChildren</function>
+<symbol>ClipByChildren</symbol>
or
-<function>IncludeInferiors</function>.
+<symbol>IncludeInferiors</symbol>.
For
-<function>ClipByChildren</function>,
+<symbol>ClipByChildren</symbol>,
both source and destination windows are
additionally clipped by all viewable
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
children.
For
-<function>IncludeInferiors</function>,
+<symbol>IncludeInferiors</symbol>,
neither source nor destination window is clipped by inferiors.
This will result in including subwindow contents in the source
and drawing through subwindow boundaries of the destination.
The use of
-<function>IncludeInferiors </function>
+<symbol>IncludeInferiors</symbol>
on a window of one depth with mapped
inferiors of differing depth is not illegal, but the semantics are
undefined by the core protocol.
@@ -884,18 +884,18 @@ undefined by the core protocol. <!-- .LP -->
The fill-rule defines what pixels are inside (drawn) for
paths given in
-<function>XFillPolygon </function>
+<function>XFillPolygon</function>
requests and can be set to
-<function>EvenOddRule </function>
+<symbol>EvenOddRule</symbol>
or
-<function>WindingRule</function>.
+<symbol>WindingRule</symbol>.
For
-<function>EvenOddRule</function>,
+<symbol>EvenOddRule</symbol>,
a point is inside if
an infinite ray with the point as origin crosses the path an odd number
of times.
For
-<function>WindingRule</function>,
+<symbol>WindingRule</symbol>,
a point is inside if an infinite ray with the
point as origin crosses an unequal number of clockwise and
counterclockwise directed path segments.
@@ -910,9 +910,9 @@ coincident with a segment. <para>
<!-- .LP -->
For both
-<function>EvenOddRule</function>
+<symbol>EvenOddRule</symbol>
and
-<function>WindingRule</function>,
+<symbol>WindingRule</symbol>,
a point is infinitely small,
and the path is an infinitely thin line.
A pixel is inside if the center point of the pixel is inside
@@ -929,23 +929,23 @@ and are inside if and only if the polygon interior is immediately below The arc-mode controls filling in the
<function>XFillArcs</function>
function and can be set to
-<function>ArcPieSlice</function>
+<symbol>ArcPieSlice</symbol>
or
-<function>ArcChord</function>.
+<symbol>ArcChord</symbol>.
For
-<function>ArcPieSlice</function>,
+<symbol>ArcPieSlice</symbol>,
the arcs are pie-slice filled.
For
-<function>ArcChord</function>,
+<symbol>ArcChord</symbol>,
the arcs are chord filled.
</para>
<para>
<!-- .LP -->
The graphics-exposure flag controls
-<function>GraphicsExpose </function>
+<symbol>GraphicsExpose</symbol>
event generation
for
-<function>XCopyArea </function>
+<function>XCopyArea</function>
and
<function>XCopyPlane</function>
requests (and any similar requests defined by extensions).
@@ -961,7 +961,7 @@ depth of drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>GC<function> XCreateGC</function></funcdef>
+ <funcdef>GC <function>XCreateGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
@@ -1024,20 +1024,20 @@ function creates a graphics context and returns a GC. The GC can be used with any destination drawable having the same root
and depth as the specified drawable.
Use with other drawables results in a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error.
</para>
<para>
<!-- .LP -->
<function>XCreateGC</function>
can generate
-<function>BadAlloc</function>,
-<function>BadDrawable</function>,
-<function>BadFont</function>,
-<function>BadMatch</function>,
-<function>BadPixmap</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadFont</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1049,7 +1049,7 @@ To copy components from a source GC to a destination GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XCopyGC</function></funcdef>
+ <funcdef><function>XCopyGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GCsrc,<parameter> dest</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
@@ -1111,7 +1111,7 @@ function copies the specified components from the source GC to the destination GC.
The source and destination GCs must have the same root and depth,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
The valuemask specifies which component to copy, as for
<function>XCreateGC</function>.
@@ -1120,10 +1120,10 @@ The valuemask specifies which component to copy, as for <!-- .LP -->
<function>XCopyGC</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
errors.
</para>
<para>
@@ -1135,7 +1135,7 @@ To change the components in a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeGC</function></funcdef>
+ <funcdef><function>XChangeGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
@@ -1213,13 +1213,13 @@ If an error is generated, a subset of the components may have been altered. <!-- .LP -->
<function>XChangeGC</function>
can generate
-<function>BadAlloc</function>,
-<function>BadFont</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
-<function>BadPixmap</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadFont</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1231,7 +1231,7 @@ To obtain components of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetGCValues</function></funcdef>
+ <funcdef>Status <function>XGetGCValues</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
@@ -1280,7 +1280,7 @@ GC component mask bits. <listitem>
<para>
Returns the GC values in the specified
-<function>XGCValues </function>
+<structname>XGCValues</structname>
structure.
</para>
</listitem>
@@ -1294,44 +1294,44 @@ The <function>XGetGCValues</function>
function returns the components specified by valuemask for the specified GC.
If the valuemask contains a valid set of GC mask bits
-(<function>GCFunction</function>,
-<function>GCPlaneMask</function>,
-<function>GCForeground</function>,
-<function>GCBackground</function>,
-<function>GCLineWidth</function>,
-<function>GCLineStyle</function>,
-<function>GCCapStyle</function>,
-<function>GCJoinStyle</function>,
-<function>GCFillStyle</function>,
-<function>GCFillRule</function>,
-<function>GCTile</function>,
-<function>GCStipple</function>,
-<function>GCTileStipXOrigin</function>,
-<function>GCTileStipYOrigin</function>,
-<function>GCFont</function>,
-<function>GCSubwindowMode</function>,
-<function>GCGraphicsExposures</function>,
-<function>GCClipXOrigin</function>,
-<function>GCCLipYOrigin</function>,
-<function>GCDashOffset</function>,
+(<symbol>GCFunction</symbol>,
+<symbol>GCPlaneMask</symbol>,
+<symbol>GCForeground</symbol>,
+<symbol>GCBackground</symbol>,
+<symbol>GCLineWidth</symbol>,
+<symbol>GCLineStyle</symbol>,
+<symbol>GCCapStyle</symbol>,
+<symbol>GCJoinStyle</symbol>,
+<symbol>GCFillStyle</symbol>,
+<symbol>GCFillRule</symbol>,
+<symbol>GCTile</symbol>,
+<symbol>GCStipple</symbol>,
+<symbol>GCTileStipXOrigin</symbol>,
+<symbol>GCTileStipYOrigin</symbol>,
+<symbol>GCFont</symbol>,
+<symbol>GCSubwindowMode</symbol>,
+<symbol>GCGraphicsExposures</symbol>,
+<symbol>GCClipXOrigin</symbol>,
+<symbol>GCClipYOrigin</symbol>,
+<symbol>GCDashOffset</symbol>,
or
-<function>GCArcMode</function>)
+<symbol>GCArcMode</symbol>)
and no error occurs,
<function>XGetGCValues</function>
sets the requested components in values_return and returns a nonzero status.
Otherwise, it returns a zero status.
Note that the clip-mask and dash-list (represented by the
-<function>GCClipMask</function>
+<symbol>GCClipMask</symbol>
and
-<function>GCDashList</function>
+<symbol>GCDashList</symbol>
bits, respectively, in the valuemask)
cannot be requested.
Also note that an invalid resource ID (with one or more of the three
most significant bits set to 1) will be returned for
-<function>GCFont</function>,
-<function>GCTile</function>,
+<symbol>GCFont</symbol>,
+<symbol>GCTile</symbol>,
and
-<function>GCStipple</function>
+<symbol>GCStipple</symbol>
if the component has never been explicitly set by the client.
</para>
<para>
@@ -1343,7 +1343,7 @@ To free a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeGC</function></funcdef>
+ <funcdef><function>XFreeGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
</funcprototype>
@@ -1383,21 +1383,21 @@ function destroys the specified GC as well as all the associated storage. <!-- .LP -->
<function>XFreeGC</function>
can generate a
-<function>BadGC </function>
+<errorname>BadGC</errorname>
error.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain the
-<function>GContext </function>
+<type>GContext</type>
resource ID for a given GC, use
<function>XGContextFromGC</function>.
<indexterm significance="preferred"><primary>XGContextFromGC</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>GContext<function> XGContextFromGC</function></funcdef>
+ <funcdef>GContext <function>XGContextFromGC</function></funcdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1433,7 +1433,7 @@ To force sending GC component changes, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XFlushGC</function></funcdef>
+ <funcdef>void <function>XFlushGC</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
</funcprototype>
@@ -1527,7 +1527,7 @@ for a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetState</function></funcdef>
+ <funcdef><function>XSetState</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlongforeground,<parameter> background</parameter></paramdef>
@@ -1605,10 +1605,10 @@ Specifies the plane mask. <!-- .eM -->
<function>XSetState</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1620,7 +1620,7 @@ To set the foreground of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetForeground</function></funcdef>
+ <funcdef><function>XSetForeground</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlong<parameter> foreground</parameter></paramdef>
@@ -1665,9 +1665,9 @@ Specifies the foreground you want to set for the specified GC. <!-- .eM -->
<function>XSetForeground</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
<para>
@@ -1679,7 +1679,7 @@ To set the background of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetBackground</function></funcdef>
+ <funcdef><function>XSetBackground</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlong<parameter> background</parameter></paramdef>
@@ -1724,9 +1724,9 @@ Specifies the background you want to set for the specified GC. <!-- .eM -->
<function>XSetBackground</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
<para>
@@ -1738,7 +1738,7 @@ To set the display function in a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetFunction</function></funcdef>
+ <funcdef><function>XSetFunction</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> function</parameter></paramdef>
@@ -1783,10 +1783,10 @@ Specifies the function you want to set for the specified GC. <!-- .eM -->
<function>XSetFunction</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1798,7 +1798,7 @@ To set the plane mask of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetPlaneMask</function></funcdef>
+ <funcdef><function>XSetPlaneMask</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlong<parameter> plane_mask</parameter></paramdef>
@@ -1844,9 +1844,9 @@ Specifies the plane mask. <!-- .eM -->
<function>XSetPlaneMask</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
</sect2>
@@ -1863,7 +1863,7 @@ To set the line drawing components of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetLineAttributes</function></funcdef>
+ <funcdef><function>XSetLineAttributes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedint<parameter> line_width</parameter></paramdef>
@@ -1912,10 +1912,10 @@ Specifies the line-width you want to set for the specified GC. <para>
Specifies the line-style you want to set for the specified GC.
You can pass
-<function>LineSolid</function>,
-<function>LineOnOffDash</function>,
+<symbol>LineSolid</symbol>,
+<symbol>LineOnOffDash</symbol>,
or
-<function>LineDoubleDash</function>.
+<symbol>LineDoubleDash</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1927,11 +1927,11 @@ or <para>
Specifies the line-style and cap-style you want to set for the specified GC.
You can pass
-<function>CapNotLast</function>,
-<function>CapButt</function>,
-<function>CapRound</function>,
+<symbol>CapNotLast</symbol>,
+<symbol>CapButt</symbol>,
+<symbol>CapRound</symbol>,
or
-<function>CapProjecting</function>.
+<symbol>CapProjecting</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1943,10 +1943,10 @@ or <para>
Specifies the line join-style you want to set for the specified GC.
You can pass
-<function>JoinMiter</function>,
-<function>JoinRound</function>,
+<symbol>JoinMiter</symbol>,
+<symbol>JoinRound</symbol>,
or
-<function>JoinBevel</function>.
+<symbol>JoinBevel</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1957,10 +1957,10 @@ or <!-- .eM -->
<function>XSetLineAttributes</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1972,7 +1972,7 @@ To set the dash-offset and dash-list for dashed line styles of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetDashes</function></funcdef>
+ <funcdef><function>XSetDashes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> dash_offset</parameter></paramdef>
@@ -2045,7 +2045,7 @@ function sets the dash-offset and dash-list attributes for dashed line styles in the specified GC.
There must be at least one element in the specified dash_list,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
The initial and alternating elements (second, fourth, and so on)
of the dash_list are the even dashes, and
@@ -2053,7 +2053,7 @@ the others are the odd dashes. Each element specifies a dash length in pixels.
All of the elements must be nonzero,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
Specifying an odd-length list is equivalent to specifying the same list
concatenated with itself to produce an even-length list.
@@ -2081,10 +2081,10 @@ For all other lines, the major axis is the y axis. <!-- .LP -->
<function>XSetDashes</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect2>
@@ -2101,7 +2101,7 @@ To set the fill-style of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetFillStyle</function></funcdef>
+ <funcdef><function>XSetFillStyle</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> fill_style</parameter></paramdef>
@@ -2137,11 +2137,11 @@ Specifies the GC. <para>
Specifies the fill-style you want to set for the specified GC.
You can pass
-<function>FillSolid</function>,
-<function>FillTiled</function>,
-<function>FillStippled</function>,
+<symbol>FillSolid</symbol>,
+<symbol>FillTiled</symbol>,
+<symbol>FillStippled</symbol>,
or
-<function>FillOpaqueStippled</function>.
+<symbol>FillOpaqueStippled</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2152,10 +2152,10 @@ or <!-- .eM -->
<function>XSetFillStyle</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2167,7 +2167,7 @@ To set the fill-rule of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetFillRule</function></funcdef>
+ <funcdef><function>XSetFillRule</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> fill_rule</parameter></paramdef>
@@ -2203,9 +2203,9 @@ Specifies the GC. <para>
Specifies the fill-rule you want to set for the specified GC.
You can pass
-<function>EvenOddRule</function>
+<symbol>EvenOddRule</symbol>
or
-<function>WindingRule</function>.
+<symbol>WindingRule</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2216,10 +2216,10 @@ or <!-- .eM -->
<function>XSetFillRule</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect2>
@@ -2247,7 +2247,7 @@ To obtain the best size of a tile, stipple, or cursor, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XQueryBestSize</function></funcdef>
+ <funcdef>Status <function>XQueryBestSize</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> class</parameter></paramdef>
<paramdef>Drawable<parameter> which_screen</parameter></paramdef>
@@ -2275,10 +2275,10 @@ Specifies the connection to the X server. <para>
Specifies the class that you are interested in.
You can pass
-<function>TileShape</function>,
-<function>CursorShape</function>,
+<symbol>TileShape</symbol>,
+<symbol>CursorShape</symbol>,
or
-<function>StippleShape</function>.
+<symbol>StippleShape</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2344,41 +2344,41 @@ The <function>XQueryBestSize</function>
function returns the best or closest size to the specified size.
For
-<function>CursorShape</function>,
+<symbol>CursorShape</symbol>,
this is the largest size that can be fully displayed on the screen specified by
which_screen.
For
-<function>TileShape</function>,
+<symbol>TileShape</symbol>,
this is the size that can be tiled fastest.
For
-<function>StippleShape</function>,
+<symbol>StippleShape</symbol>,
this is the size that can be stippled fastest.
For
-<function>CursorShape</function>,
+<symbol>CursorShape</symbol>,
the drawable indicates the desired screen.
For
-<function>TileShape </function>
+<symbol>TileShape</symbol>
and
-<function>StippleShape</function>,
+<symbol>StippleShape</symbol>,
the drawable indicates the screen and possibly the window class and depth.
An
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
window cannot be used as the drawable for
-<function>TileShape</function>
+<symbol>TileShape</symbol>
or
-<function>StippleShape</function>,
+<symbol>StippleShape</symbol>,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XQueryBestSize</function>
can generate
-<function>BadDrawable</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2390,7 +2390,7 @@ To obtain the best fill tile shape, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XQueryBestTile</function></funcdef>
+ <funcdef>Status <function>XQueryBestTile</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> which_screen</parameter></paramdef>
<paramdef>unsignedintwidth,<parameter> height</parameter></paramdef>
@@ -2473,18 +2473,18 @@ function returns the best or closest size, that is, the size that can be tiled fastest on the screen specified by which_screen.
The drawable indicates the screen and possibly the window class and depth.
If an
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
window is used as the drawable, a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XQueryBestTile</function>
can generate
-<function>BadDrawable</function>
+<errorname>BadDrawable</errorname>
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
<para>
@@ -2496,7 +2496,7 @@ To obtain the best stipple shape, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XQueryBestStipple</function></funcdef>
+ <funcdef>Status <function>XQueryBestStipple</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> which_screen</parameter></paramdef>
<paramdef>unsignedintwidth,<parameter> height</parameter></paramdef>
@@ -2579,18 +2579,18 @@ function returns the best or closest size, that is, the size that can be stippled fastest on the screen specified by which_screen.
The drawable indicates the screen and possibly the window class and depth.
If an
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window is used as the drawable, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XQueryBestStipple</function>
can generate
-<function>BadDrawable</function>
+<errorname>BadDrawable</errorname>
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
<para>
@@ -2602,7 +2602,7 @@ To set the fill tile of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetTile</function></funcdef>
+ <funcdef><function>XSetTile</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>Pixmap<parameter> tile</parameter></paramdef>
@@ -2647,18 +2647,18 @@ Specifies the fill tile you want to set for the specified GC. <!-- .eM -->
The tile and GC must have the same depth,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XSetTile</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadPixmap </function>
+<errorname>BadPixmap</errorname>
errors.
</para>
<para>
@@ -2670,7 +2670,7 @@ To set the stipple of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetStipple</function></funcdef>
+ <funcdef><function>XSetStipple</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>Pixmap<parameter> stipple</parameter></paramdef>
@@ -2715,18 +2715,18 @@ Specifies the stipple you want to set for the specified GC. <!-- .eM -->
The stipple must have a depth of one,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XSetStipple</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadPixmap </function>
+<errorname>BadPixmap</errorname>
errors.
</para>
<para>
@@ -2738,7 +2738,7 @@ To set the tile or stipple origin of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetTSOrigin</function></funcdef>
+ <funcdef><function>XSetTSOrigin</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>intts_x_origin,<parameter> ts_y_origin</parameter></paramdef>
@@ -2800,9 +2800,9 @@ drawable is specified in the graphics request. <!-- .LP -->
<function>XSetTSOrigin</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
</sect2>
@@ -2819,7 +2819,7 @@ To set the current font of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetFont</function></funcdef>
+ <funcdef><function>XSetFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>Font<parameter> font</parameter></paramdef>
@@ -2864,10 +2864,10 @@ Specifies the font. <!-- .eM -->
<function>XSetFont</function>
can generate
-<function>BadAlloc</function>,
-<function>BadFont</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadFont</errorname>,
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
</sect2>
@@ -2890,7 +2890,7 @@ To set the clip-origin of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetClipOrigin</function></funcdef>
+ <funcdef><function>XSetClipOrigin</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>intclip_x_origin,<parameter> clip_y_origin</parameter></paramdef>
@@ -2951,9 +2951,9 @@ destination drawable is specified in the graphics request. <!-- .LP -->
<function>XSetClipOrigin</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
<para>
@@ -2965,7 +2965,7 @@ To set the clip-mask of a given GC to the specified pixmap, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetClipMask</function></funcdef>
+ <funcdef><function>XSetClipMask</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>Pixmap<parameter> pixmap</parameter></paramdef>
@@ -3000,7 +3000,7 @@ Specifies the GC. <listitem>
<para>
Specifies the pixmap or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3010,18 +3010,18 @@ Specifies the pixmap or <!-- .LP -->
<!-- .eM -->
If the clip-mask is set to
-<function>None</function>,
+<symbol>None</symbol>,
the pixels are always drawn (regardless of the clip-origin).
</para>
<para>
<!-- .LP -->
<function>XSetClipMask</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadPixmap </function>
+<errorname>BadPixmap</errorname>
errors.
</para>
<para>
@@ -3033,7 +3033,7 @@ To set the clip-mask of a given GC to the specified list of rectangles, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetClipRectangles</function></funcdef>
+ <funcdef><function>XSetClipRectangles</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>intclip_x_origin,<parameter> clip_y_origin</parameter></paramdef>
@@ -3113,11 +3113,11 @@ Specifies the number of rectangles. <para>
Specifies the ordering relations on the rectangles.
You can pass
-<function>Unsorted</function>,
-<function>YSorted</function>,
-<function>YXSorted</function>,
+<symbol>Unsorted</symbol>,
+<symbol>YSorted</symbol>,
+<symbol>YXSorted</symbol>,
or
-<function>YXBanded</function>.
+<symbol>YXBanded</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3140,7 +3140,7 @@ undefined. Note that the list of rectangles can be empty,
which effectively disables output.
This is the opposite of passing
-<function>None</function>
+<symbol>None</symbol>
as the clip-mask in
<function>XCreateGC</function>,
<function>XChangeGC</function>,
@@ -3154,23 +3154,23 @@ specified with the ordering argument. This may provide faster operation
by the server.
If an incorrect ordering is specified, the X server may generate a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error, but it is not required to do so.
If no error is generated, the graphics
results are undefined.
-<function>Unsorted </function>
+<symbol>Unsorted</symbol>
means the rectangles are in arbitrary order.
-<function>YSorted </function>
+<symbol>YSorted</symbol>
means that the rectangles are nondecreasing in their Y origin.
-<function>YXSorted </function>
+<symbol>YXSorted</symbol>
additionally constrains
-<function>YSorted </function>
+<symbol>YSorted</symbol>
order in that all
rectangles with an equal Y origin are nondecreasing in their X
origin.
-<function>YXBanded </function>
+<symbol>YXBanded</symbol>
additionally constrains
-<function>YXSorted </function>
+<symbol>YXSorted</symbol>
by requiring that,
for every possible Y scanline, all rectangles that include that
scanline have an identical Y origins and Y extents.
@@ -3179,11 +3179,11 @@ scanline have an identical Y origins and Y extents. <!-- .LP -->
<function>XSetClipRectangles</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -3207,7 +3207,7 @@ To set the arc mode of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetArcMode</function></funcdef>
+ <funcdef><function>XSetArcMode</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> arc_mode</parameter></paramdef>
@@ -3243,9 +3243,9 @@ Specifies the GC. <para>
Specifies the arc mode.
You can pass
-<function>ArcChord</function>
+<symbol>ArcChord</symbol>
or
-<function>ArcPieSlice</function>.
+<symbol>ArcPieSlice</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3256,10 +3256,10 @@ or <!-- .eM -->
<function>XSetArcMode</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -3271,7 +3271,7 @@ To set the subwindow mode of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetSubwindowMode</function></funcdef>
+ <funcdef><function>XSetSubwindowMode</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> subwindow_mode</parameter></paramdef>
@@ -3307,9 +3307,9 @@ Specifies the GC. <para>
Specifies the subwindow mode.
You can pass
-<function>ClipByChildren</function>
+<symbol>ClipByChildren</symbol>
or
-<function>IncludeInferiors</function>.
+<symbol>IncludeInferiors</symbol>.
</para>
</listitem>
</varlistentry>
@@ -3320,10 +3320,10 @@ or <!-- .eM -->
<function>XSetSubwindowMode</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -3335,7 +3335,7 @@ To set the graphics-exposures flag of a given GC, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetGraphicsExposures</function></funcdef>
+ <funcdef><function>XSetGraphicsExposures</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>Bool<parameter> graphics_exposures</parameter></paramdef>
@@ -3370,9 +3370,9 @@ Specifies the GC. <listitem>
<para>
Specifies a Boolean value that indicates whether you want
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
and
-<function>NoExpose</function>
+<symbol>NoExpose</symbol>
events to be reported when calling
<function>XCopyArea</function>
and
@@ -3388,10 +3388,10 @@ with this GC. <!-- .eM -->
<function>XSetGraphicsExposures</function>
can generate
-<function>BadAlloc</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH08.xml b/libX11/specs/libX11/CH08.xml index 5f08f93f3..d1e0b36d5 100644 --- a/libX11/specs/libX11/CH08.xml +++ b/libX11/specs/libX11/CH08.xml @@ -42,7 +42,7 @@ To clear a rectangular area of a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XClearArea</function></funcdef>
+ <funcdef><function>XClearArea</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -124,7 +124,7 @@ Specify the width and height(Wh. <listitem>
<para>
Specifies a Boolean value that indicates if
-<function>Expose</function>
+<symbol>Expose</symbol>
events are to be generated.
</para>
</listitem>
@@ -139,7 +139,7 @@ The function paints a rectangular area in the specified window according to the
specified dimensions with the window's background pixel or pixmap.
The subwindow-mode effectively is
-<function>ClipByChildren</function>.
+<symbol>ClipByChildren</symbol>.
If width is zero, it
is replaced with the current width of the window minus x.
If height is
@@ -148,29 +148,29 @@ If the window has a defined background tile, the rectangle clipped by any children is filled with this tile.
If the window has
background
-<function>None</function>,
+<symbol>None</symbol>,
the contents of the window are not changed.
In either
case, if exposures is
-<function>True</function>,
+<symbol>True</symbol>,
one or more
-<function>Expose </function>
+<symbol>Expose</symbol>
events are generated for regions of the rectangle that are either visible or are
being retained in a backing store.
If you specify a window whose class is
-<function>InputOnly</function>,
+<symbol>InputOnly</symbol>,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XClearArea</function>
can generate
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -184,7 +184,7 @@ To clear the entire area in a given window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XClearWindow</function></funcdef>
+ <funcdef><function>XClearWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -222,28 +222,28 @@ function clears the entire area in the specified window and is equivalent to
<function>XClearArea</function>
(display, w, 0, 0, 0, 0,
-<function>False</function>).
+<symbol>False</symbol>).
If the window has a defined background tile, the rectangle is tiled with a
plane-mask of all ones and
-<function>GXcopy</function>
+<symbol>GXcopy</symbol>
function.
If the window has
background
-<function>None</function>,
+<symbol>None</symbol>,
the contents of the window are not changed.
If you specify a window whose class is
-<function>InputOnly</function>,
+<symbol>InputOnly</symbol>,
a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XClearWindow</function>
can generate
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -268,7 +268,7 @@ root and depth, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XCopyArea</function></funcdef>
+ <funcdef><function>XCopyArea</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawablesrc,<parameter> dest</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -400,7 +400,7 @@ function combines the specified rectangle of src with the specified rectangle of dest.
The drawables must have the same root and depth,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
@@ -413,27 +413,27 @@ Instead, the following occurs on all corresponding destination regions that are either
visible or are retained in backing store.
If the destination is a window with a background other than
-<function>None</function>,
+<symbol>None</symbol>,
corresponding regions
of the destination are tiled with that background
(with plane-mask of all ones and
-<function>GXcopy </function>
+<symbol>GXcopy</symbol>
function).
Regardless of tiling or whether the destination is a window or a pixmap,
if graphics-exposures is
-<function>True</function>,
+<symbol>True</symbol>,
then
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
events for all corresponding destination regions are generated.
If graphics-exposures is
-<function>True </function>
+<symbol>True</symbol>
but no
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
events are generated, a
-<function>NoExpose </function>
+<symbol>NoExpose</symbol>
event is generated.
Note that by default graphics-exposures is
-<function>True</function>
+<symbol>True</symbol>
in new GCs.
</para>
<para>
@@ -446,10 +446,10 @@ clip-y-origin, and clip-mask. <!-- .LP -->
<function>XCopyArea</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
<!-- .sp -->
</para>
@@ -463,7 +463,7 @@ To copy a single bit plane of a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XCopyPlane</function></funcdef>
+ <funcdef><function>XCopyPlane</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawablesrc,<parameter> dest</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -606,11 +606,11 @@ function uses a single bit plane of the specified source rectangle combined with the specified GC to modify the specified rectangle of dest.
The drawables must have the same root but need not have the same depth.
If the drawables do not have the same root, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If plane does not have exactly one bit set to 1 and the value of plane
is not less than %2 sup n%, where <emphasis remap='I'>n</emphasis> is the depth of src, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
@@ -623,11 +623,11 @@ It uses the foreground/background pixels in the GC (foreground everywhere the bit plane in src contains a bit set to 1,
background everywhere the bit plane in src contains a bit set to 0)
and the equivalent of a
-<function>CopyArea</function>
+<systemitem>CopyArea</systemitem>
protocol request is performed with all the same exposure semantics.
This can also be thought of as using the specified region of the source
bit plane as a stipple with a fill-style of
-<function>FillOpaqueStippled</function>
+<symbol>FillOpaqueStippled</symbol>
for filling a rectangular area of the destination.
</para>
<para>
@@ -640,11 +640,11 @@ and clip-mask. <!-- .LP -->
<function>XCopyPlane</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect1>
@@ -767,7 +767,7 @@ To draw a single point in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawPoint</function></funcdef>
+ <funcdef><function>XDrawPoint</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -839,7 +839,7 @@ To draw multiple points in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawPoints</function></funcdef>
+ <funcdef><function>XDrawPoints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -908,9 +908,9 @@ Specifies the number of points in the array. <para>
Specifies the coordinate mode.
You can pass
-<function>CoordModeOrigin</function>
+<symbol>CoordModeOrigin</symbol>
or
-<function>CoordModePrevious</function>.
+<symbol>CoordModePrevious</symbol>.
</para>
</listitem>
</varlistentry>
@@ -925,10 +925,10 @@ function uses the foreground pixel and function components of the GC to draw a single point into the specified drawable;
<function>XDrawPoints</function>
draws multiple points this way.
-<function>CoordModeOrigin</function>
+<symbol>CoordModeOrigin</symbol>
treats all coordinates as relative to the origin,
and
-<function>CoordModePrevious</function>
+<symbol>CoordModePrevious</symbol>
treats all coordinates after the first as relative to the previous point.
<function>XDrawPoints</function>
draws the points in the order listed in the array.
@@ -942,18 +942,18 @@ foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. <!-- .LP -->
<function>XDrawPoint</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
<function>XDrawPoints</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect2>
@@ -980,7 +980,7 @@ To draw a single line between two points in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawLine</function></funcdef>
+ <funcdef><function>XDrawLine</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1074,7 +1074,7 @@ To draw multiple lines in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawLines</function></funcdef>
+ <funcdef><function>XDrawLines</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1143,9 +1143,9 @@ Specifies the number of points in the array. <para>
Specifies the coordinate mode.
You can pass
-<function>CoordModeOrigin</function>
+<symbol>CoordModeOrigin</symbol>
or
-<function>CoordModePrevious</function>.
+<symbol>CoordModePrevious</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1162,7 +1162,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawSegments</function></funcdef>
+ <funcdef><function>XDrawSegments</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1233,7 +1233,7 @@ function uses the components of the specified GC to draw a line between the specified set of points (x1, y1) and (x2, y2).
It does not perform joining at coincident endpoints.
For any given line,
-<function>XDrawLine </function>
+<function>XDrawLine</function>
does not draw a pixel more than once.
If lines intersect, the intersecting pixels are drawn multiple times.
</para>
@@ -1244,7 +1244,7 @@ The function uses the components of the specified GC to draw
npoints-1 lines between each pair of points (point[i], point[i+1])
in the array of
-<function>XPoint</function>
+<structname>XPoint</structname>
structures.
It draws the lines in the order listed in the array.
The lines join correctly at all intermediate points, and if the first and last
@@ -1256,25 +1256,25 @@ If thin (zero line-width) lines intersect, the intersecting pixels are drawn multiple times.
If wide lines intersect, the intersecting pixels are drawn only once, as though
the entire
-<function>PolyLine </function>
+<systemitem>PolyLine</systemitem>
protocol request were a single, filled shape.
-<function>CoordModeOrigin</function>
+<symbol>CoordModeOrigin</symbol>
treats all coordinates as relative to the origin,
and
-<function>CoordModePrevious</function>
+<symbol>CoordModePrevious</symbol>
treats all coordinates after the first as relative to the previous point.
</para>
<para>
<!-- .LP -->
The
-<function>XDrawSegments </function>
+<function>XDrawSegments</function>
function draws multiple, unconnected lines.
For each segment,
-<function>XDrawSegments </function>
+<function>XDrawSegments</function>
draws a
line between (x1, y1) and (x2, y2).
It draws the lines in the order listed in the array of
-<function>XSegment</function>
+<structname>XSegment</structname>
structures and does not perform joining at coincident endpoints.
For any given line,
<function>XDrawSegments</function>
@@ -1301,14 +1301,14 @@ tile-stipple-y-origin, dash-offset, and dash-list. and
<function>XDrawSegments</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
<function>XDrawLines</function>
also can generate
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect2>
@@ -1332,7 +1332,7 @@ To draw the outline of a single rectangle in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawRectangle</function></funcdef>
+ <funcdef><function>XDrawRectangle</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1429,7 +1429,7 @@ in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawRectangles</function></funcdef>
+ <funcdef><function>XDrawRectangles</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1500,7 +1500,7 @@ and <function>XDrawRectangles</function>
functions draw the outlines of the specified rectangle or rectangles as
if a five-point
-<function>PolyLine </function>
+<systemitem>PolyLine</systemitem>
protocol request were specified for each rectangle:
</para>
<itemizedlist>
@@ -1535,10 +1535,10 @@ tile-stipple-y-origin, dash-offset, and dash-list. and
<function>XDrawRectangles</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
</sect2>
@@ -1563,7 +1563,7 @@ To draw a single arc in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawArc</function></funcdef>
+ <funcdef><function>XDrawArc</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1683,7 +1683,7 @@ To draw multiple arcs in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawArcs</function></funcdef>
+ <funcdef><function>XDrawArcs</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -1866,10 +1866,10 @@ tile-stipple-y-origin, dash-offset, and dash-list. and
<function>XDrawArcs</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
</sect2>
@@ -1921,7 +1921,7 @@ To fill a single rectangular area in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFillRectangle</function></funcdef>
+ <funcdef><function>XFillRectangle</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -2018,7 +2018,7 @@ To fill multiple rectangular areas in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFillRectangles</function></funcdef>
+ <funcdef><function>XFillRectangles</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -2089,7 +2089,7 @@ and <function>XFillRectangles</function>
functions fill the specified rectangle or rectangles
as if a four-point
-<function>FillPolygon</function>
+<systemitem>FillPolygon</systemitem>
protocol request were specified for each rectangle:
</para>
<para>
@@ -2130,10 +2130,10 @@ and tile-stipple-y-origin. and
<function>XFillRectangles</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
</sect2>
@@ -2153,7 +2153,7 @@ To fill a polygon area in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFillPolygon</function></funcdef>
+ <funcdef><function>XFillPolygon</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -2223,10 +2223,10 @@ Specifies the number of points in the array. <para>
Specifies a shape that helps the server to improve performance.
You can pass
-<function>Complex</function>,
-<function>Convex</function>,
+<symbol>Complex</symbol>,
+<symbol>Convex</symbol>,
or
-<function>Nonconvex</function>.
+<symbol>Nonconvex</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2238,9 +2238,9 @@ or <para>
Specifies the coordinate mode.
You can pass
-<function>CoordModeOrigin</function>
+<symbol>CoordModeOrigin</symbol>
or
-<function>CoordModePrevious</function>.
+<symbol>CoordModePrevious</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2249,17 +2249,17 @@ or <para>
<!-- .LP -->
<!-- .eM -->
-<function>XFillPolygon </function>
+<function>XFillPolygon</function>
fills the region closed by the specified path.
The path is closed
automatically if the last point in the list does not coincide with the
first point.
<function>XFillPolygon</function>
does not draw a pixel of the region more than once.
-<function>CoordModeOrigin</function>
+<symbol>CoordModeOrigin</symbol>
treats all coordinates as relative to the origin,
and
-<function>CoordModePrevious</function>
+<symbol>CoordModePrevious</symbol>
treats all coordinates after the first as relative to the previous point.
</para>
<para>
@@ -2270,7 +2270,7 @@ Depending on the specified shape, the following occurs: <listitem>
<para>
If shape is
-<function>Complex</function>,
+<symbol>Complex</symbol>,
the path may self-intersect.
Note that contiguous coincident points in the path are not treated
as self-intersection.
@@ -2279,15 +2279,15 @@ as self-intersection. <listitem>
<para>
If shape is
-<function>Convex</function>,
+<symbol>Convex</symbol>,
for every pair of points inside the polygon,
the line segment connecting them does not intersect the path.
If known by the client,
specifying
-<function>Convex </function>
+<symbol>Convex</symbol>
can improve performance.
If you specify
-<function>Convex </function>
+<symbol>Convex</symbol>
for a path that is not convex,
the graphics results are undefined.
</para>
@@ -2295,17 +2295,17 @@ the graphics results are undefined. <listitem>
<para>
If shape is
-<function>Nonconvex</function>,
+<symbol>Nonconvex</symbol>,
the path does not self-intersect, but the shape is not
wholly convex.
If known by the client,
specifying
-<function>Nonconvex </function>
+<symbol>Nonconvex</symbol>
instead of
-<function>Complex </function>
+<symbol>Complex</symbol>
may improve performance.
If you specify
-<function>Nonconvex </function>
+<symbol>Nonconvex</symbol>
for a self-intersecting path, the graphics results are undefined.
</para>
</listitem>
@@ -2328,11 +2328,11 @@ and tile-stipple-y-origin. <!-- .LP -->
<function>XFillPolygon</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect2>
@@ -2352,7 +2352,7 @@ To fill a single arc in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFillArc</function></funcdef>
+ <funcdef><function>XFillArc</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -2472,7 +2472,7 @@ To fill multiple arcs in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFillArcs</function></funcdef>
+ <funcdef><function>XFillArcs</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -2545,10 +2545,10 @@ fills the region closed by the infinitely thin path described by the specified arc and, depending on the
arc-mode specified in the GC, one or two line segments.
For
-<function>ArcChord</function>,
+<symbol>ArcChord</symbol>,
the single line segment joining the endpoints of the arc is used.
For
-<function>ArcPieSlice</function>,
+<symbol>ArcPieSlice</symbol>,
the two line segments joining the endpoints of the arc with the center
point are used.
<function>XFillArcs</function>
@@ -2576,10 +2576,10 @@ and tile-stipple-y-origin. and
<function>XFillArcs</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
</sect2>
@@ -2649,18 +2649,18 @@ This means that it makes sense to draw text using stipples or tiles <!-- .LP -->
<!-- .sM -->
The
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure contains all of the information for the font
and consists of the font-specific information as well as
a pointer to an array of
-<function>XCharStruct</function>
+<structname>XCharStruct</structname>
structures for the
characters contained in the font.
The
-<function>XFontStruct</function>,
-<function>XFontProp</function>,
+<structname>XFontStruct</structname>,
+<structname>XFontProp</structname>,
and
-<function>XCharStruct</function>
+<structname>XCharStruct</structname>
structures contain:
</para>
<para>
@@ -2746,35 +2746,35 @@ specified in the structure defines a range of characters. <para>
<!-- .LP -->
The bounding box of a character is defined by the
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
of that character.
When characters are absent from a font,
the default_char is used.
When fonts have all characters of the same size,
only the information in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
min and max bounds are used.
</para>
<para>
<!-- .LP -->
The members of the
-<function>XFontStruct </function>
+<structname>XFontStruct</structname>
have the following semantics:
</para>
<itemizedlist>
<listitem>
<para>
The direction member can be either
-<function>FontLeftToRight </function>
+<symbol>FontLeftToRight</symbol>
or
-<function>FontRightToLeft</function>.
+<symbol>FontRightToLeft</symbol>.
It is just a hint as to whether most
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
elements
have a positive
-(<function>FontLeftToRight</function>)
+(<symbol>FontLeftToRight</symbol>)
or a negative
-(<function>FontRightToLeft</function>)
+(<symbol>FontRightToLeft</symbol>)
character width
metric.
The core protocol defines no support for vertical text.
@@ -2830,7 +2830,7 @@ as given by both min_bounds and max_bounds. <listitem>
<para>
If all_chars_exist is
-<function>True</function>,
+<symbol>True</symbol>,
all characters in the per_char array have nonzero bounding boxes.
</para>
</listitem>
@@ -2850,7 +2850,7 @@ no printing is performed for an undefined or nonexistent character. <para>
The min_bounds and max_bounds members contain the most extreme values of
each individual
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
component over all elements of this array
(and ignore nonexistent characters).
The bounding box of the font (the smallest
@@ -2909,7 +2909,7 @@ For a character origin at [x,y], the bounding box of a character (that is,
the smallest rectangle that encloses the character's shape)
described in terms of
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
components is a rectangle with its upper-left corner at:
</para>
<para>
@@ -2971,7 +2971,7 @@ a nonkerned character. When lbearing is zero,
no pixels with X-coordinate less than x are drawn.
Any of the
-<function>XCharStruct</function>
+<structname>XCharStruct</structname>
metric members could be negative.
If the width is negative,
the next character will be placed to the left of the current origin.
@@ -2980,10 +2980,10 @@ the next character will be placed to the left of the current origin. <!-- .LP -->
The X protocol does not define the interpretation of the attributes member
in the
-<function>XCharStruct</function>
+<structname>XCharStruct</structname>
structure.
A nonexistent character is represented with all members of its
-<function>XCharStruct</function>
+<structname>XCharStruct</structname>
set to zero.
</para>
<para>
@@ -3007,7 +3007,7 @@ unload fonts, and free font information. <indexterm><primary>Fonts</primary><secondary>unloading</secondary></indexterm>
<indexterm><primary>Fonts</primary><secondary>freeing font information</secondary></indexterm>
A few font functions use a
-<function>GContext </function>
+<type>GContext</type>
resource ID or a font ID interchangeably.
</para>
<para>
@@ -3019,7 +3019,7 @@ To load a given font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Font<function> XLoadFont</function></funcdef>
+ <funcdef>Font <function>XLoadFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *name</parameter></paramdef>
</funcprototype>
@@ -3069,7 +3069,7 @@ If <function>XLoadFont</function>
was unsuccessful at loading the specified font,
a
-<function>BadName </function>
+<errorname>BadName</errorname>
error results.
Fonts are not associated with a particular screen
and can be stored as a component
@@ -3081,9 +3081,9 @@ When the font is no longer needed, call <!-- .LP -->
<function>XLoadFont</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadName </function>
+<errorname>BadName</errorname>
errors.
</para>
<para>
@@ -3095,7 +3095,7 @@ To return information about an available font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XFontStruct<function> *XQueryFont</function></funcdef>
+ <funcdef>XFontStruct *<function>XQueryFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> font_ID</parameter></paramdef>
</funcprototype>
@@ -3119,7 +3119,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the font ID or the
-<function>GContext</function>
+<type>GContext</type>
ID.
</para>
</listitem>
@@ -3132,13 +3132,13 @@ ID. The
<function>XQueryFont</function>
function returns a pointer to the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure, which contains information associated with the font.
You can query a font or the font stored in a GC.
The font ID stored in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure will be the
-<function>GContext </function>
+<type>GContext</type>
ID, and you need to be careful when using this ID in other functions
(see
<function>XGContextFromGC</function>).
@@ -3161,7 +3161,7 @@ in a single operation, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XFontStruct<function> *XLoadQueryFont</function></funcdef>
+ <funcdef>XFontStruct *<function>XLoadQueryFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *name</parameter></paramdef>
</funcprototype>
@@ -3200,7 +3200,7 @@ function provides the most common way for accessing a font. <function>XLoadQueryFont</function>
both opens (loads) the specified font and returns a pointer to the
appropriate
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure.
If the font name is not in the Host Portable Character Encoding,
the result is implementation-dependent.
@@ -3212,7 +3212,7 @@ returns NULL. <!-- .LP -->
<function>XLoadQueryFont</function>
can generate a
-<function>BadAlloc </function>
+<errorname>BadAlloc</errorname>
error.
</para>
<para>
@@ -3229,7 +3229,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeFont</function></funcdef>
+ <funcdef><function>XFreeFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XFontStruct<parameter> *font_struct</parameter></paramdef>
</funcprototype>
@@ -3265,7 +3265,7 @@ The <function>XFreeFont</function>
function deletes the association between the font resource ID and the specified
font and frees the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure.
The font itself will be freed when no other resource references it.
The data and the font should not be referenced again.
@@ -3274,7 +3274,7 @@ The data and the font should not be referenced again. <!-- .LP -->
<function>XFreeFont</function>
can generate a
-<function>BadFont </function>
+<errorname>BadFont</errorname>
error.
</para>
<para>
@@ -3286,7 +3286,7 @@ To return a given font property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XGetFontProperty</function></funcdef>
+ <funcdef>Bool <function>XGetFontProperty</function></funcdef>
<paramdef>XFontStruct<parameter> *font_struct</parameter></paramdef>
<paramdef>Atom<parameter> atom</parameter></paramdef>
<paramdef>unsignedlong<parameter> *value_return</parameter></paramdef>
@@ -3335,13 +3335,13 @@ the function returns the value of the specified font property.
<function>XGetFontProperty</function>
also returns
-<function>False</function>
+<symbol>False</symbol>
if the property was not defined or
-<function>True</function>
+<symbol>True</symbol>
if it was defined.
A set of predefined atoms exists for font properties,
which can be found in
-<!-- .hN X11/Xatom.h . -->
+<<filename class="headerfile">X11/Xatom.h</filename>>.
This set contains the standard properties associated with
a font.
Although it is not guaranteed,
@@ -3358,7 +3358,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUnloadFont</function></funcdef>
+ <funcdef><function>XUnloadFont</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Font<parameter> font</parameter></paramdef>
</funcprototype>
@@ -3400,7 +3400,7 @@ The font should not be referenced again. <!-- .LP -->
<function>XUnloadFont</function>
can generate a
-<function>BadFont </function>
+<errorname>BadFont</errorname>
error.
</para>
</sect2>
@@ -3423,7 +3423,7 @@ To return a list of the available font names, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> **XListFonts</function></funcdef>
+ <funcdef>char **<function>XListFonts</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *pattern</parameter></paramdef>
<paramdef>int<parameter> maxnames</parameter></paramdef>
@@ -3510,7 +3510,7 @@ To free a font name array, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeFontNames</function></funcdef>
+ <funcdef><function>XFreeFontNames</function></funcdef>
<paramdef>char<parameter> *list[]</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3534,7 +3534,7 @@ Specifies the array of strings you want to free. The
<function>XFreeFontNames</function>
function frees the array and strings returned by
-<function>XListFonts </function>
+<function>XListFonts</function>
or
<function>XListFontsWithInfo</function>.
</para>
@@ -3547,7 +3547,7 @@ To obtain the names and information about available fonts, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> **XListFontsWithInfo</function></funcdef>
+ <funcdef>char **<function>XListFontsWithInfo</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *pattern</parameter></paramdef>
<paramdef>int<parameter> maxnames</parameter></paramdef>
@@ -3654,7 +3654,7 @@ To free font structures and font names, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeFontInfo</function></funcdef>
+ <funcdef><function>XFreeFontInfo</function></funcdef>
<paramdef>char<parameter> **names</parameter></paramdef>
<paramdef>XFontStruct<parameter> *free_info</parameter></paramdef>
<paramdef>int<parameter> actual_count</parameter></paramdef>
@@ -3738,7 +3738,7 @@ To determine the width of an 8-bit character string, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XTextWidth</function></funcdef>
+ <funcdef>int <function>XTextWidth</function></funcdef>
<paramdef>XFontStruct<parameter> *font_struct</parameter></paramdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -3788,7 +3788,7 @@ To determine the width of a 2-byte character string, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XTextWidth16</function></funcdef>
+ <funcdef>int <function>XTextWidth16</function></funcdef>
<paramdef>XFontStruct<parameter> *font_struct</parameter></paramdef>
<paramdef>XChar2b<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -3846,7 +3846,7 @@ To compute the bounding box of an 8-bit character string in a given font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XTextExtents</function></funcdef>
+ <funcdef><function>XTextExtents</function></funcdef>
<paramdef>XFontStruct<parameter> *font_struct</parameter></paramdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> nchars</parameter></paramdef>
@@ -3864,7 +3864,7 @@ To compute the bounding box of an 8-bit character string in a given font, use <listitem>
<para>
Specifies the
-<function>XFontStruct </function>
+<structname>XFontStruct</structname>
structure.
</para>
</listitem>
@@ -3896,9 +3896,9 @@ Specifies the number of characters in the character string. <listitem>
<para>
Returns the value of the direction hint
-(<function>FontLeftToRight</function>
+(<symbol>FontLeftToRight</symbol>
or
-<function>FontRightToLeft</function>).
+<symbol>FontRightToLeft</symbol>).
</para>
</listitem>
</varlistentry>
@@ -3929,7 +3929,7 @@ Returns the font descent. <listitem>
<para>
Returns the overall size in the specified
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
structure.
</para>
</listitem>
@@ -3946,7 +3946,7 @@ To compute the bounding box of a 2-byte character string in a given font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XTextExtents16</function></funcdef>
+ <funcdef><function>XTextExtents16</function></funcdef>
<paramdef>XFontStruct<parameter> *font_struct</parameter></paramdef>
<paramdef>XChar2b<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> nchars</parameter></paramdef>
@@ -3964,7 +3964,7 @@ To compute the bounding box of a 2-byte character string in a given font, use <listitem>
<para>
Specifies the
-<function>XFontStruct </function>
+<structname>XFontStruct</structname>
structure.
</para>
</listitem>
@@ -3996,9 +3996,9 @@ Specifies the number of characters in the character string. <listitem>
<para>
Returns the value of the direction hint
-(<function>FontLeftToRight</function>
+(<symbol>FontLeftToRight</symbol>
or
-<function>FontRightToLeft</function>).
+<symbol>FontRightToLeft</symbol>).
</para>
</listitem>
</varlistentry>
@@ -4029,7 +4029,7 @@ Returns the font descent. <listitem>
<para>
Returns the overall size in the specified
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
structure.
</para>
</listitem>
@@ -4046,11 +4046,11 @@ and functions
perform the size computation locally and, thereby,
avoid the round-trip overhead of
-<function>XQueryTextExtents </function>
+<function>XQueryTextExtents</function>
and
<function>XQueryTextExtents16</function>.
Both functions return an
-<function>XCharStruct</function>
+<structname>XCharStruct</structname>
structure, whose members are set to the values as follows.
</para>
<para>
@@ -4072,7 +4072,7 @@ The rbearing member is set to the maximum R. <!-- .LP -->
For fonts defined with linear indexing rather than 2-byte matrix indexing,
each
-<function>XChar2b </function>
+<structname>XChar2b</structname>
structure is interpreted as a 16-bit number with byte1 as the
most significant byte.
If the font has no defined default character,
@@ -4093,7 +4093,7 @@ given font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XQueryTextExtents</function></funcdef>
+ <funcdef><function>XQueryTextExtents</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> font_ID</parameter></paramdef>
<paramdef>char<parameter> *string</parameter></paramdef>
@@ -4122,7 +4122,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies either the font ID or the
-<function>GContext</function>
+<type>GContext</type>
ID that contains the font.
</para>
</listitem>
@@ -4154,9 +4154,9 @@ Specifies the number of characters in the character string. <listitem>
<para>
Returns the value of the direction hint
-(<function>FontLeftToRight</function>
+(<symbol>FontLeftToRight</symbol>
or
-<function>FontRightToLeft</function>).
+<symbol>FontRightToLeft</symbol>).
</para>
</listitem>
</varlistentry>
@@ -4187,7 +4187,7 @@ Returns the font descent. <listitem>
<para>
Returns the overall size in the specified
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
structure.
</para>
</listitem>
@@ -4205,7 +4205,7 @@ in a given font, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XQueryTextExtents16</function></funcdef>
+ <funcdef><function>XQueryTextExtents16</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> font_ID</parameter></paramdef>
<paramdef>XChar2b<parameter> *string</parameter></paramdef>
@@ -4234,7 +4234,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies either the font ID or the
-<function>GContext</function>
+<type>GContext</type>
ID that contains the font.
</para>
</listitem>
@@ -4266,9 +4266,9 @@ Specifies the number of characters in the character string. <listitem>
<para>
Returns the value of the direction hint
-(<function>FontLeftToRight</function>
+(<symbol>FontLeftToRight</symbol>
or
-<function>FontRightToLeft</function>).
+<symbol>FontRightToLeft</symbol>).
</para>
</listitem>
</varlistentry>
@@ -4299,7 +4299,7 @@ Returns the font descent. <listitem>
<para>
Returns the overall size in the specified
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
structure.
</para>
</listitem>
@@ -4322,7 +4322,7 @@ overhead that is avoided by and
<function>XTextExtents16</function>.
Both functions return a
-<function>XCharStruct </function>
+<structname>XCharStruct</structname>
structure, whose members are set to the values as follows.
</para>
<para>
@@ -4344,7 +4344,7 @@ The rbearing member is set to the maximum R. <!-- .LP -->
For fonts defined with linear indexing rather than 2-byte matrix indexing,
each
-<function>XChar2b </function>
+<structname>XChar2b</structname>
structure is interpreted as a 16-bit number with byte1 as the
most significant byte.
If the font has no defined default character,
@@ -4362,9 +4362,9 @@ the undefined characters in the string are also ignored. and
<function>XQueryTextExtents16</function>
can generate
-<function>BadFont</function>
+<errorname>BadFont</errorname>
and
-<function>BadGC </function>
+<errorname>BadGC</errorname>
errors.
</para>
</sect2>
@@ -4436,7 +4436,7 @@ typedef struct { <!-- .LP -->
<!-- .eM -->
If the font member is not
-<function>None</function>,
+<symbol>None</symbol>,
the font is changed before printing and also is stored in the GC.
If an error was generated during text drawing,
the previous items may have been drawn.
@@ -4451,13 +4451,13 @@ If you want the upper-left corner of the background rectangle to be at pixel coordinate (x,y), pass the (x,y + ascent)
as the baseline origin coordinates to the text functions.
The ascent is the font ascent, as given in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure.
If you want the lower-left corner of the background rectangle
to be at pixel coordinate (x,y), pass the (x,y - descent + 1)
as the baseline origin coordinates to the text functions.
The descent is the font descent, as given in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structure.
</para>
<sect2 id="Drawing_Complex_Text">
@@ -4478,7 +4478,7 @@ To draw 8-bit characters in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawText</function></funcdef>
+ <funcdef><function>XDrawText</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -4574,7 +4574,7 @@ To draw 2-byte characters in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawText16</function></funcdef>
+ <funcdef><function>XDrawText16</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -4666,7 +4666,7 @@ Specifies the number of text items in the array. The
<function>XDrawText16</function>
function is similar to
-<function>XDrawText </function>
+<function>XDrawText</function>
except that it uses 2-byte or 16-bit characters.
Both functions allow complex spacing and font shifts between counted strings.
</para>
@@ -4674,7 +4674,7 @@ Both functions allow complex spacing and font shifts between counted strings. <!-- .LP -->
Each text item is processed in turn.
A font member other than
-<function>None</function>
+<symbol>None</symbol>
in an item causes the font to be stored in the GC
and used for subsequent text.
A text element delta specifies an additional change
@@ -4685,14 +4685,14 @@ Each character image, as defined by the font in the GC, is treated as an additional mask for a fill operation on the drawable.
The drawable is modified only where the font character has a bit set to 1.
If a text item generates a
-<function>BadFont</function>
+<errorname>BadFont</errorname>
error, the previous text items may have been drawn.
</para>
<para>
<!-- .LP -->
For fonts defined with linear indexing rather than 2-byte matrix indexing,
each
-<function>XChar2b</function>
+<structname>XChar2b</structname>
structure is interpreted as a 16-bit number with byte1 as the
most significant byte.
</para>
@@ -4711,11 +4711,11 @@ and tile-stipple-y-origin. and
<function>XDrawText16</function>
can generate
-<function>BadDrawable</function>,
-<function>BadFont</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadFont</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
</sect2>
@@ -4734,7 +4734,7 @@ To draw 8-bit characters in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawString</function></funcdef>
+ <funcdef><function>XDrawString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -4830,7 +4830,7 @@ To draw 2-byte characters in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawString16</function></funcdef>
+ <funcdef><function>XDrawString16</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -4942,10 +4942,10 @@ and tile-stipple-y-origin. and
<function>XDrawString16</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
</sect2>
@@ -4974,7 +4974,7 @@ To draw 8-bit image text characters in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawImageString</function></funcdef>
+ <funcdef><function>XDrawImageString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -5070,7 +5070,7 @@ To draw 2-byte image text characters in a given drawable, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDrawImageString16</function></funcdef>
+ <funcdef><function>XDrawImageString16</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -5162,7 +5162,7 @@ Specifies the number of characters in the string argument. The
<function>XDrawImageString16</function>
function is similar to
-<function>XDrawImageString </function>
+<function>XDrawImageString</function>
except that it uses 2-byte or 16-bit characters.
Both functions also use both the foreground and background pixels
of the GC in the destination.
@@ -5204,13 +5204,13 @@ font-ascent + font-descent <!-- .LP -->
The overall-width, font-ascent, and font-descent
are as would be returned by
-<function>XQueryTextExtents </function>
+<function>XQueryTextExtents</function>
using gc and string.
The function and fill-style defined in the GC are ignored for these functions.
The effective function is
-<function>GXcopy</function>,
+<symbol>GXcopy</symbol>,
and the effective fill-style is
-<function>FillSolid</function>.
+<symbol>FillSolid</symbol>.
</para>
<para>
<!-- .LP -->
@@ -5231,10 +5231,10 @@ clip-y-origin, and clip-mask. and
<function>XDrawImageString16</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
errors.
</para>
<para>
@@ -5267,7 +5267,7 @@ to an image (see section 16.8). <!-- .LP -->
All the image manipulation functions discussed in this section make use of
the
-<function>XImage </function>
+<structname>XImage</structname>
structure,
which describes an image as it exists in the client's memory.
</para>
@@ -5315,7 +5315,7 @@ To initialize the image manipulation routines of an image structure, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XInitImage</function></funcdef>
+ <funcdef>Status <function>XInitImage</function></funcdef>
<paramdef>XImage<parameter> *image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -5373,7 +5373,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XPutImage</function></funcdef>
+ <funcdef><function>XPutImage</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -5433,7 +5433,7 @@ Specifies the image you want combined with the rectangle. <para>
Specifies the offset in X from the left edge of the image defined
by the
-<function>XImage </function>
+<structname>XImage</structname>
structure.
</para>
</listitem>
@@ -5446,7 +5446,7 @@ structure. <para>
Specifies the offset in Y from the top edge of the image defined
by the
-<function>XImage </function>
+<structname>XImage</structname>
structure.
<!-- .ds Dx , which are relative to the origin of the drawable \ -->
and are the coordinates of the subimage
@@ -5508,27 +5508,27 @@ combines an image with a rectangle of the specified drawable. The section of the image defined by the src_x, src_y, width, and height
arguments is drawn on the specified part of the drawable.
If
-<function>XYBitmap </function>
+<symbol>XYBitmap</symbol>
format is used, the depth of the image must be one,
or a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error results.
The foreground pixel in the GC defines the source for the one bits in the image,
and the background pixel defines the source for the zero bits.
For
-<function>XYPixmap </function>
+<symbol>XYPixmap</symbol>
and
-<function>ZPixmap</function>,
+<symbol>ZPixmap</symbol>,
the depth of the image must match the depth of the drawable,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
If the characteristics of the image (for example, byte_order and bitmap_unit)
differ from what the server requires,
-<function>XPutImage </function>
+<function>XPutImage</function>
automatically makes the appropriate
conversions.
</para>
@@ -5544,11 +5544,11 @@ foreground and background. <!-- .LP -->
<function>XPutImage</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -5562,7 +5562,7 @@ This function specifically supports rudimentary screen dumps. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XImage<function> *XGetImage</function></funcdef>
+ <funcdef>XImage *<function>XGetImage</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -5657,9 +5657,9 @@ Specifies the plane mask. <para>
Specifies the format for the image.
You can pass
-<function>XYPixmap</function>
+<symbol>XYPixmap</symbol>
or
-<function>ZPixmap</function>.
+<symbol>ZPixmap</symbol>.
</para>
</listitem>
</varlistentry>
@@ -5671,18 +5671,18 @@ or The
<function>XGetImage</function>
function returns a pointer to an
-<function>XImage</function>
+<structname>XImage</structname>
structure.
This structure provides you with the contents of the specified rectangle of
the drawable in the format you specify.
If the format argument is
-<function>XYPixmap</function>,
+<symbol>XYPixmap</symbol>,
the image contains only the bit planes you passed to the plane_mask argument.
If the plane_mask argument only requests a subset of the planes of the
display, the depth of the returned image will be the number of planes
requested.
If the format argument is
-<function>ZPixmap</function>,
+<symbol>ZPixmap</symbol>,
<function>XGetImage</function>
returns as zero the bits in all planes not
specified in the plane_mask argument.
@@ -5693,11 +5693,11 @@ extraneous bits. <!-- .LP -->
<function>XGetImage</function>
returns the depth of the image to the depth member of the
-<function>XImage</function>
+<structname>XImage</structname>
structure.
The depth of the image is as specified when the drawable was created,
except when getting a subset of the planes in
-<function>XYPixmap</function>
+<symbol>XYPixmap</symbol>
format, when the depth is given by the number of bits set to 1 in plane_mask.
</para>
<para>
@@ -5705,7 +5705,7 @@ format, when the depth is given by the number of bits set to 1 in plane_mask. If the drawable is a pixmap,
the given rectangle must be wholly contained within the pixmap,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If the drawable is a window,
the window must be viewable,
@@ -5713,7 +5713,7 @@ and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen
and wholly contained within the outside edges of the window,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
Note that the borders of the window can be included and read with
this request.
@@ -5733,10 +5733,10 @@ returns NULL. <!-- .LP -->
<function>XGetImage</function>
can generate
-<function>BadDrawable</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
<!-- .sp -->
</para>
@@ -5749,7 +5749,7 @@ to a location within a preexisting image structure, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XImage<function> *XGetSubImage</function></funcdef>
+ <funcdef>XImage *<function>XGetSubImage</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
@@ -5846,9 +5846,9 @@ Specifies the plane mask. <para>
Specifies the format for the image.
You can pass
-<function>XYPixmap</function>
+<symbol>XYPixmap</symbol>
or
-<function>ZPixmap</function>.
+<symbol>ZPixmap</symbol>.
</para>
</listitem>
</varlistentry>
@@ -5892,14 +5892,14 @@ Specify the x and y coordinates(Dx. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetSubImage </function>
+<function>XGetSubImage</function>
function updates dest_image with the specified subimage in the same manner as
<function>XGetImage</function>.
If the format argument is
-<function>XYPixmap</function>,
+<symbol>XYPixmap</symbol>,
the image contains only the bit planes you passed to the plane_mask argument.
If the format argument is
-<function>ZPixmap</function>,
+<symbol>ZPixmap</symbol>,
<function>XGetSubImage</function>
returns as zero the bits in all planes not
specified in the plane_mask argument.
@@ -5908,20 +5908,20 @@ extraneous bits. As a convenience,
<function>XGetSubImage</function>
returns a pointer to the same
-<function>XImage</function>
+<structname>XImage</structname>
structure specified by dest_image.
</para>
<para>
<!-- .LP -->
The depth of the destination
-<function>XImage</function>
+<structname>XImage</structname>
structure must be the same as that of the drawable.
If the specified subimage does not fit at the specified location
on the destination image, the right and bottom edges are clipped.
If the drawable is a pixmap,
the given rectangle must be wholly contained within the pixmap,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If the drawable is a window,
the window must be viewable,
@@ -5929,7 +5929,7 @@ and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen
and wholly contained within the outside edges of the window,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If the window has backing-store,
then the backing-store contents are returned for regions of the window
@@ -5946,11 +5946,11 @@ returns NULL. <!-- .LP -->
<function>XGetSubImage</function>
can generate
-<function>BadDrawable</function>,
-<function>BadGC</function>,
-<function>BadMatch</function>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadMatch</errorname>,
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH09.xml b/libX11/specs/libX11/CH09.xml index 20b2e99bc..60bf08e68 100644 --- a/libX11/specs/libX11/CH09.xml +++ b/libX11/specs/libX11/CH09.xml @@ -33,7 +33,7 @@ There is no way to move a window between screens. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XReparentWindow</function></funcdef>
+ <funcdef><function>XReparentWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window<parameter> parent</parameter></paramdef>
@@ -102,7 +102,7 @@ Specify the x and y coordinates(Xy. If the specified window is mapped,
<function>XReparentWindow</function>
automatically performs an
-<function>UnmapWindow</function>
+<systemitem>UnmapWindow</systemitem>
request on it, removes it from its current position in the hierarchy,
and inserts it as the child of the specified parent.
The window is placed in the stacking order on top with respect to
@@ -113,16 +113,16 @@ sibling windows. After reparenting the specified window,
<function>XReparentWindow</function>
causes the X server to generate a
-<function>ReparentNotify</function>
+<symbol>ReparentNotify</symbol>
event.
The override_redirect member returned in this event is
set to the window's corresponding attribute.
Window manager clients usually should ignore this window if this member
is set to
-<function>True</function>.
+<symbol>True</symbol>.
Finally, if the specified window was originally mapped,
the X server automatically performs a
-<function>MapWindow</function>
+<systemitem>MapWindow</systemitem>
request on it.
</para>
<para>
@@ -130,14 +130,14 @@ request on it. The X server performs normal exposure processing on formerly obscured
windows.
The X server might not generate
-<function>Expose </function>
+<symbol>Expose</symbol>
events for regions from the initial
-<function>UnmapWindow</function>
+<systemitem>UnmapWindow</systemitem>
request that are immediately obscured by the final
-<function>MapWindow</function>
+<systemitem>MapWindow</systemitem>
request.
A
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results if:
</para>
<itemizedlist>
@@ -156,14 +156,14 @@ specified window. <listitem>
<para>
The new parent is
-<function>InputOnly</function>,
+<symbol>InputOnly</symbol>,
and the window is not.
</para>
</listitem>
<listitem>
<para>
The specified window has a
-<function>ParentRelative</function>
+<symbol>ParentRelative</symbol>
background, and the new parent window is not the same depth as the
specified window.
</para>
@@ -173,9 +173,9 @@ specified window. <!-- .LP -->
<function>XReparentWindow</function>
can generate
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -217,7 +217,7 @@ To add or remove a window from the client's save-set, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeSaveSet</function></funcdef>
+ <funcdef><function>XChangeSaveSet</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> change_mode</parameter></paramdef>
@@ -254,9 +254,9 @@ Specifies the window (Wi. <para>
Specifies the mode.
You can pass
-<function>SetModeInsert </function>
+<symbol>SetModeInsert</symbol>
or
-<function>SetModeDelete</function>.
+<symbol>SetModeDelete</symbol>.
</para>
</listitem>
</varlistentry>
@@ -270,17 +270,17 @@ Depending on the specified mode, either inserts or deletes the specified window from the client's save-set.
The specified window must have been created by some other client,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XChangeSaveSet</function>
can generate
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -292,7 +292,7 @@ To add a window to the client's save-set, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAddToSaveSet</function></funcdef>
+ <funcdef><function>XAddToSaveSet</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -330,16 +330,16 @@ The function adds the specified window to the client's save-set.
The specified window must have been created by some other client,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XAddToSaveSet</function>
can generate
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -351,7 +351,7 @@ To remove a window from the client's save-set, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRemoveFromSaveSet</function></funcdef>
+ <funcdef><function>XRemoveFromSaveSet</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -389,16 +389,16 @@ The function removes the specified window from the client's save-set.
The specified window must have been created by some other client,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XRemoveFromSaveSet</function>
can generate
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -448,7 +448,7 @@ To install a colormap, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XInstallColormap</function></funcdef>
+ <funcdef><function>XInstallColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Colormap<parameter> colormap</parameter></paramdef>
</funcprototype>
@@ -496,20 +496,20 @@ or <!-- .LP -->
If the specified colormap is not already an installed colormap,
the X server generates a
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
event on each window that has that colormap.
In addition, for every other colormap that is installed as
a result of a call to
<function>XInstallColormap</function>,
the X server generates a
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
event on each window that has that colormap.
</para>
<para>
<!-- .LP -->
<function>XInstallColormap</function>
can generate a
-<function>BadColor </function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
@@ -521,7 +521,7 @@ To uninstall a colormap, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUninstallColormap</function></funcdef>
+ <funcdef><function>XUninstallColormap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Colormap<parameter> colormap</parameter></paramdef>
</funcprototype>
@@ -567,20 +567,20 @@ except that the required list must remain installed. <!-- .LP -->
If the specified colormap becomes uninstalled,
the X server generates a
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
event on each window that has that colormap.
In addition, for every other colormap that is installed or uninstalled as a
result of a call to
<function>XUninstallColormap</function>,
the X server generates a
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
event on each window that has that colormap.
</para>
<para>
<!-- .LP -->
<function>XUninstallColormap</function>
can generate a
-<function>BadColor </function>
+<errorname>BadColor</errorname>
error.
</para>
<para>
@@ -592,7 +592,7 @@ To obtain a list of the currently installed colormaps for a given screen, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Colormap<function> *XListInstalledColormaps</function></funcdef>
+ <funcdef>Colormap *<function>XListInstalledColormaps</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> *num_return</parameter></paramdef>
@@ -650,7 +650,7 @@ free it by using <!-- .LP -->
<function>XListInstalledColormaps</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -674,7 +674,7 @@ To set the font search path, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetFontPath</function></funcdef>
+ <funcdef><function>XSetFontPath</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> **directories</parameter></paramdef>
<paramdef>int<parameter> ndirs</parameter></paramdef>
@@ -740,7 +740,7 @@ The meaning of an error from this request is implementation-dependent. <!-- .LP -->
<function>XSetFontPath</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -752,7 +752,7 @@ To get the current font search path, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> **XGetFontPath</function></funcdef>
+ <funcdef>char **<function>XGetFontPath</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> *npaths_return</parameter></paramdef>
</funcprototype>
@@ -804,7 +804,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeFontPath</function></funcdef>
+ <funcdef><function>XFreeFontPath</function></funcdef>
<paramdef>char<parameter> **list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -860,7 +860,7 @@ To grab the server, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGrabServer</function></funcdef>
+ <funcdef><function>XGrabServer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -896,7 +896,7 @@ To ungrab the server, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUngrabServer</function></funcdef>
+ <funcdef><function>XUngrabServer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -938,7 +938,7 @@ To destroy a client, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XKillClient</function></funcdef>
+ <funcdef><function>XKillClient</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> resource</parameter></paramdef>
</funcprototype>
@@ -962,7 +962,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies any resource associated with the client that you want to destroy or
-<function>AllTemporary</function>.
+<symbol>AllTemporary</symbol>.
</para>
</listitem>
</varlistentry>
@@ -979,19 +979,19 @@ that created the resource if a valid resource is specified.
If the client has already terminated in
either
-<function>RetainPermanent </function>
+<symbol>RetainPermanent</symbol>
or
-<function>RetainTemporary </function>
+<symbol>RetainTemporary</symbol>
mode, all of the client's
resources are destroyed.
If
-<function>AllTemporary </function>
+<symbol>AllTemporary</symbol>
is specified, the resources of all clients that have terminated in
-<function>RetainTemporary </function>
+<symbol>RetainTemporary</symbol>
are destroyed (see section 2.5).
This permits implementation of window manager facilities that aid debugging.
A client can set its close-down mode to
-<function>RetainTemporary</function>.
+<symbol>RetainTemporary</symbol>.
If the client then crashes,
its windows would not be destroyed.
The programmer can then inspect the application's window tree
@@ -1001,7 +1001,7 @@ and use the window manager to destroy the zombie windows. <!-- .LP -->
<function>XKillClient</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
</sect1>
@@ -1025,7 +1025,7 @@ To set the screen saver mode, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetScreenSaver</function></funcdef>
+ <funcdef><function>XSetScreenSaver</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>inttimeout,<parameter> interval</parameter></paramdef>
<paramdef>int<parameter> prefer_blanking</parameter></paramdef>
@@ -1072,10 +1072,10 @@ Specifies the interval, in seconds, between screen saver alterations. <para>
Specifies how to enable screen blanking.
You can pass
-<function>DontPreferBlanking</function>,
-<function>PreferBlanking</function>,
+<symbol>DontPreferBlanking</symbol>,
+<symbol>PreferBlanking</symbol>,
or
-<function>DefaultBlanking</function>.
+<symbol>DefaultBlanking</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1087,10 +1087,10 @@ or <para>
Specifies the screen save control values.
You can pass
-<function>DontAllowExposures</function>,
-<function>AllowExposures</function>,
+<symbol>DontAllowExposures</symbol>,
+<symbol>AllowExposures</symbol>,
or
-<function>DefaultExposures</function>.
+<symbol>DefaultExposures</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1104,7 +1104,7 @@ A timeout of 0 disables the screen saver (but an activated screen saver is not deactivated),
and a timeout of \-1 restores the default.
Other negative values generate a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error.
If the timeout value is nonzero,
<function>XSetScreenSaver</function>
@@ -1121,7 +1121,7 @@ if blanking is preferred and the hardware supports video blanking, the screen simply goes blank.
Otherwise, if either exposures are allowed or the screen can be regenerated
without sending
-<function>Expose </function>
+<symbol>Expose</symbol>
events to clients,
the screen is tiled with the root window background tile randomly
re-origined each interval seconds.
@@ -1132,7 +1132,7 @@ and all screen states are restored at the next keyboard or pointer input or at the next call to
<function>XForceScreenSaver</function>
with mode
-<function>ScreenSaverReset</function>.
+<symbol>ScreenSaverReset</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1148,7 +1148,7 @@ periodically. <!-- .LP -->
<function>XSetScreenSaver</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -1160,7 +1160,7 @@ To force the screen saver on or off, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XForceScreenSaver</function></funcdef>
+ <funcdef><function>XForceScreenSaver</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> mode</parameter></paramdef>
</funcprototype>
@@ -1185,9 +1185,9 @@ Specifies the connection to the X server. <para>
Specifies the mode that is to be applied.
You can pass
-<function>ScreenSaverActive</function>
+<symbol>ScreenSaverActive</symbol>
or
-<function>ScreenSaverReset</function>.
+<symbol>ScreenSaverReset</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1197,13 +1197,13 @@ or <!-- .LP -->
<!-- .eM -->
If the specified mode is
-<function>ScreenSaverActive </function>
+<symbol>ScreenSaverActive</symbol>
and the screen saver currently is deactivated,
<function>XForceScreenSaver</function>
activates the screen saver even if the screen saver had been disabled
with a timeout of zero.
If the specified mode is
-<function>ScreenSaverReset </function>
+<symbol>ScreenSaverReset</symbol>
and the screen saver currently is enabled,
<function>XForceScreenSaver</function>
deactivates the screen saver if it was activated,
@@ -1214,7 +1214,7 @@ and the activation timer is reset to its initial state <!-- .LP -->
<function>XForceScreenSaver</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -1226,7 +1226,7 @@ To activate the screen saver, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XActivateScreenSaver</function></funcdef>
+ <funcdef><function>XActivateScreenSaver</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1254,7 +1254,7 @@ To reset the screen saver, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XResetScreenSaver</function></funcdef>
+ <funcdef><function>XResetScreenSaver</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1282,7 +1282,7 @@ To get the current screen saver values, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGetScreenSaver</function></funcdef>
+ <funcdef><function>XGetScreenSaver</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int*timeout_return,<parameter> *interval_return</parameter></paramdef>
<paramdef>int<parameter> *prefer_blanking_return</parameter></paramdef>
@@ -1328,10 +1328,10 @@ Returns the interval between screen saver invocations. <listitem>
<para>
Returns the current screen blanking preference
-(<function>DontPreferBlanking</function>,
-<function>PreferBlanking</function>,
+(<symbol>DontPreferBlanking</symbol>,
+<symbol>PreferBlanking</symbol>,
or
-<function>DefaultBlanking</function>).
+<symbol>DefaultBlanking</symbol>).
</para>
</listitem>
</varlistentry>
@@ -1342,10 +1342,10 @@ or <listitem>
<para>
Returns the current screen save control value
-(<function>DontAllowExposures</function>,
-<function>AllowExposures</function>,
+(<symbol>DontAllowExposures</symbol>,
+<symbol>AllowExposures</symbol>,
or
-<function>DefaultExposures</function>).
+<symbol>DefaultExposures</symbol>).
</para>
</listitem>
</varlistentry>
@@ -1405,11 +1405,11 @@ The host the window system is running on. <listitem>
<para>
On <acronym>POSIX</acronym>-conformant systems, each host listed in the
-<function>/etc/X?.hosts </function>
+<filename>/etc/X<replaceable>?</replaceable>.hosts</filename>
file.
The ? indicates the number of the
display.
-<indexterm><primary>Files</primary><secondary>/etc/X?.hosts</secondary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename>/etc/X<replaceable>?</replaceable>.hosts</filename></secondary></indexterm>
This file should consist of host names separated by newlines.
DECnet nodes must terminate in :: to distinguish them from Internet hosts.
</para>
@@ -1442,7 +1442,7 @@ see ``X Window System Protocol.'' Xlib provides functions that you can use to add, get, or remove hosts
from the access control list.
All the host access control functions use the
-<function>XHostAddress </function>
+<structname>XHostAddress</structname>
structure, which contains:
</para>
<para>
@@ -1464,12 +1464,12 @@ typedef struct { <!-- .eM -->
The family member specifies which protocol address family to use
(for example, <acronym>TCP</acronym>/<acronym>IP</acronym> or DECnet) and can be
-<function>FamilyInternet</function>,
-<function>FamilyInternet6</function>,
-<function>FamilyServerInterpreted</function>,
-<function>FamilyDECnet</function>,
+<symbol>FamilyInternet</symbol>,
+<symbol>FamilyInternet6</symbol>,
+<symbol>FamilyServerInterpreted</symbol>,
+<symbol>FamilyDECnet</symbol>,
or
-<function>FamilyChaos</function>.
+<symbol>FamilyChaos</symbol>.
The length member specifies the length of the address in bytes.
The address member specifies a pointer to the address.
</para>
@@ -1494,7 +1494,7 @@ and the area in the most significant 6 bits of the byte. <!-- .LP -->
For the ServerInterpreted family, the length is ignored and the address
member is a pointer to a
-<function>XServerInterpretedAddress</function>
+<structname>XServerInterpretedAddress</structname>
structure, which contains:
</para>
<para>
@@ -1529,7 +1529,7 @@ To add a single host, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAddHost</function></funcdef>
+ <funcdef><function>XAddHost</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XHostAddress<parameter> *host</parameter></paramdef>
</funcprototype>
@@ -1566,16 +1566,16 @@ The <function>XAddHost</function>
function adds the specified host to the access control list for that display.
The server must be on the same host as the client issuing the command, or a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XAddHost</function>
can generate
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1587,7 +1587,7 @@ To add multiple hosts at one time, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAddHosts</function></funcdef>
+ <funcdef><function>XAddHosts</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XHostAddress<parameter> *hosts</parameter></paramdef>
<paramdef>int<parameter> num_hosts</parameter></paramdef>
@@ -1635,16 +1635,16 @@ The <function>XAddHosts</function>
function adds each specified host to the access control list for that display.
The server must be on the same host as the client issuing the command, or a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XAddHosts</function>
can generate
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1656,7 +1656,7 @@ To obtain a host list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XHostAddress<function> *XListHosts</function></funcdef>
+ <funcdef>XHostAddress *<function>XListHosts</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> *nhosts_return</parameter></paramdef>
<paramdef>Bool<parameter> *state_return</parameter></paramdef>
@@ -1720,7 +1720,7 @@ To remove a single host, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRemoveHost</function></funcdef>
+ <funcdef><function>XRemoveHost</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XHostAddress<parameter> *host</parameter></paramdef>
</funcprototype>
@@ -1758,7 +1758,7 @@ The function removes the specified host from the access control list
for that display.
The server must be on the same host as the client process, or a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
If you remove your machine from the access list,
you can no longer connect to that server,
@@ -1768,9 +1768,9 @@ and this operation cannot be reversed unless you reset the server. <!-- .LP -->
<function>XRemoveHost</function>
can generate
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1782,7 +1782,7 @@ To remove multiple hosts at one time, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRemoveHosts</function></funcdef>
+ <funcdef><function>XRemoveHosts</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XHostAddress<parameter> *hosts</parameter></paramdef>
<paramdef>int<parameter> num_hosts</parameter></paramdef>
@@ -1831,7 +1831,7 @@ The function removes each specified host from the access control list for that
display.
The X server must be on the same host as the client process, or a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results.
If you remove your machine from the access list,
you can no longer connect to that server,
@@ -1841,9 +1841,9 @@ and this operation cannot be reversed unless you reset the server. <!-- .LP -->
<function>XRemoveHosts</function>
can generate
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
</sect2>
@@ -1873,7 +1873,7 @@ To change access control, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetAccessControl</function></funcdef>
+ <funcdef><function>XSetAccessControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> mode</parameter></paramdef>
</funcprototype>
@@ -1898,9 +1898,9 @@ Specifies the connection to the X server. <para>
Specifies the mode.
You can pass
-<function>EnableAccess</function>
+<symbol>EnableAccess</symbol>
or
-<function>DisableAccess</function>.
+<symbol>DisableAccess</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1918,9 +1918,9 @@ at each connection setup. <!-- .LP -->
<function>XSetAccessControl</function>
can generate
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -1932,7 +1932,7 @@ To enable access control, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XEnableAccessControl</function></funcdef>
+ <funcdef><function>XEnableAccessControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1961,7 +1961,7 @@ function enables the use of the access control list at each connection setup. <!-- .LP -->
<function>XEnableAccessControl</function>
can generate a
-<function>BadAccess </function>
+<errorname>BadAccess</errorname>
error.
</para>
<para>
@@ -1973,7 +1973,7 @@ To disable access control, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDisableAccessControl</function></funcdef>
+ <funcdef><function>XDisableAccessControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2002,7 +2002,7 @@ function disables the use of the access control list at each connection setup. <!-- .LP -->
<function>XDisableAccessControl</function>
can generate a
-<function>BadAccess </function>
+<errorname>BadAccess</errorname>
error.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH10.xml b/libX11/specs/libX11/CH10.xml index 68a5f98f4..e00b517e7 100644 --- a/libX11/specs/libX11/CH10.xml +++ b/libX11/specs/libX11/CH10.xml @@ -48,7 +48,7 @@ You can also mask out events that would propagate to ancestor windows by manipulating the
do-not-propagate mask of the window's attributes.
However,
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
events are always sent to all clients.
<indexterm><primary>Input Control</primary></indexterm>
<indexterm><primary>Output Control</primary></indexterm>
@@ -58,7 +58,7 @@ events are always sent to all clients. An event type describes a specific event generated by the X server.
For each event type,
a corresponding constant name is defined in
-<!-- .hN X11/X.h , -->
+<<filename class="headerfile">X11/X.h</filename>>,
which is used when referring to an event type.
<indexterm><primary>Event</primary><secondary>categories</secondary></indexterm>
The following table lists the event category
@@ -85,67 +85,67 @@ The processing associated with these events is discussed in section 10.5. <tbody>
<row>
<entry>Keyboard events</entry>
- <entry><function>KeyPress</function>,
- <function>KeyRelease</function></entry>
+ <entry><symbol>KeyPress</symbol>,
+ <symbol>KeyRelease</symbol></entry>
</row>
<row>
<entry>Pointer events</entry>
- <entry><function>ButtonPress</function>,
- <function>ButtonRelease</function>,
- <function>MotionNotify</function></entry>
+ <entry><symbol>ButtonPress</symbol>,
+ <symbol>ButtonRelease</symbol>,
+ <symbol>MotionNotify</symbol></entry>
</row>
<row>
<entry>Window crossing events</entry>
- <entry><function>EnterNotify</function>,
- <function>LeaveNotify</function></entry>
+ <entry><symbol>EnterNotify</symbol>,
+ <symbol>LeaveNotify</symbol></entry>
</row>
<row>
<entry>Input focus events</entry>
- <entry><function>FocusIn</function>,
- <function>FocusOut</function></entry>
+ <entry><symbol>FocusIn</symbol>,
+ <symbol>FocusOut</symbol></entry>
</row>
<row>
<entry>Keymap state notification event</entry>
- <entry><function>KeymapNotify</function></entry>
+ <entry><symbol>KeymapNotify</symbol></entry>
</row>
<row>
<entry>Exposure events</entry>
- <entry><function>Expose</function>,
- <function>GraphicsExpose</function>,
- <function>NoExpose</function></entry>
+ <entry><symbol>Expose</symbol>,
+ <symbol>GraphicsExpose</symbol>,
+ <symbol>NoExpose</symbol></entry>
</row>
<row>
<entry>Structure control events</entry>
- <entry><function>CirculateRequest</function>,
- <function>ConfigureRequest</function>,
- <function>MapRequest</function>,
- <function>ResizeRequest</function></entry>
+ <entry><symbol>CirculateRequest</symbol>,
+ <symbol>ConfigureRequest</symbol>,
+ <symbol>MapRequest</symbol>,
+ <symbol>ResizeRequest</symbol></entry>
</row>
<row>
<entry>Window state notification events</entry>
<entry>
- <function>CirculateNotify</function>,
- <function>ConfigureNotify</function>,
- <function>CreateNotify</function>,
- <function>DestroyNotify</function>,
- <function>GravityNotify</function>,
- <function>MapNotify</function>,
- <function>MappingNotify</function>,
- <function>ReparentNotify</function>,
- <function>UnmapNotify</function>,
- <function>VisibilityNotify</function></entry>
+ <symbol>CirculateNotify</symbol>,
+ <symbol>ConfigureNotify</symbol>,
+ <symbol>CreateNotify</symbol>,
+ <symbol>DestroyNotify</symbol>,
+ <symbol>GravityNotify</symbol>,
+ <symbol>MapNotify</symbol>,
+ <symbol>MappingNotify</symbol>,
+ <symbol>ReparentNotify</symbol>,
+ <symbol>UnmapNotify</symbol>,
+ <symbol>VisibilityNotify</symbol></entry>
</row>
<row>
<entry>Colormap state notification event</entry>
- <entry><function>ColormapNotify</function></entry>
+ <entry><symbol>ColormapNotify</symbol></entry>
</row>
<row>
<entry>Client communication events</entry>
- <entry><function>ClientMessage</function>,
- <function>PropertyNotify</function>,
- <function>SelectionClear</function>,
- <function>SelectionNotify</function>,
- <function>SelectionRequest</function></entry>
+ <entry><symbol>ClientMessage</symbol>,
+ <symbol>PropertyNotify</symbol>,
+ <symbol>SelectionClear</symbol>,
+ <symbol>SelectionNotify</symbol>,
+ <symbol>SelectionRequest</symbol></entry>
</row>
</tbody>
</tgroup>
@@ -171,7 +171,7 @@ The processing associated with these events is discussed in section 10.5. <!-- .LP -->
For each event type,
a corresponding structure is declared in
-<!-- .hN X11/Xlib.h . -->
+<<filename class="headerfile">X11/Xlib.h</filename>>.
All the event structures have the following common members:
</para>
<para>
@@ -196,16 +196,16 @@ typedef struct { The type member is set to the event type constant name that uniquely identifies
it.
For example, when the X server reports a
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
event to a client application, it sends an
-<function>XGraphicsExposeEvent</function>
+<structname>XGraphicsExposeEvent</structname>
structure with the type member set to
-<function>GraphicsExpose</function>.
+<symbol>GraphicsExpose</symbol>.
The display member is set to a pointer to the display the event was read on.
The send_event member is set to
-<function>True</function>
+<symbol>True</symbol>
if the event came from a
-<function>SendEvent</function>
+<systemitem>SendEvent</systemitem>
protocol request.
The serial member is set from the serial number reported in the protocol
but expanded from the 16-bit least-significant bits to a full 32-bit value.
@@ -223,11 +223,11 @@ in the event queue (see section 11.3). <para>
<!-- .LP -->
In addition to the individual structures declared for each event type, the
-<function>XEvent</function>
+<structname>XEvent</structname>
structure is a union of the individual structures declared for each event type.
Depending on the type,
you should access members of each event by using the
-<function>XEvent</function>
+<structname>XEvent</structname>
union.
</para>
<para>
@@ -279,14 +279,14 @@ typedef union _XEvent { <!-- .LP -->
<!-- .eM -->
An
-<function>XEvent</function>
+<structname>XEvent</structname>
structure's first entry always is the type member,
which is set to the event type.
The second member always is the serial number of the protocol request
that generated the event.
The third member always is send_event,
which is a
-<function>Bool</function>
+<type>Bool</type>
that indicates if the event was sent by a different client.
The fourth member always is a display,
which is the display that the event was read from.
@@ -313,7 +313,7 @@ Clients select event reporting of most events relative to a window. To do this, pass an event mask to an Xlib event-handling
function that takes an event_mask argument.
The bits of the event mask are defined in
-<!-- .hN X11/X.h . -->
+<<filename class="headerfile">X11/X.h</filename>>.
Each bit in the event mask maps to an event mask name,
which describes the event or events you want the X server to
return to a client application.
@@ -323,24 +323,24 @@ return to a client application. Unless the client has specifically asked for them,
most events are not reported to clients when they are generated.
Unless the client suppresses them by setting graphics-exposures in the GC to
-<function>False</function>,
-<function>GraphicsExpose </function>
+<symbol>False</symbol>,
+<symbol>GraphicsExpose</symbol>
and
-<function>NoExpose </function>
+<symbol>NoExpose</symbol>
are reported by default as a result of
<function>XCopyPlane</function>
and
<function>XCopyArea</function>.
-<function>SelectionClear</function>,
-<function>SelectionRequest</function>,
-<function>SelectionNotify</function>,
+<symbol>SelectionClear</symbol>,
+<symbol>SelectionRequest</symbol>,
+<symbol>SelectionNotify</symbol>,
or
-<function>ClientMessage</function>
+<symbol>ClientMessage</symbol>
cannot be masked.
Selection-related events are only sent to clients cooperating
with selections (see section 4.5).
When the keyboard or pointer mapping is changed,
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
is always sent to clients.
</para>
<para>
@@ -367,107 +367,107 @@ event mask: </thead>
<tbody>
<row>
- <entry><function>NoEventMask</function></entry>
+ <entry><symbol>NoEventMask</symbol></entry>
<entry>No events wanted</entry>
</row>
<row>
- <entry><function>KeyPressMask</function></entry>
+ <entry><symbol>KeyPressMask</symbol></entry>
<entry>Keyboard down events wanted</entry>
</row>
<row>
- <entry><function>KeyReleaseMask</function></entry>
+ <entry><symbol>KeyReleaseMask</symbol></entry>
<entry>Keyboard up events wanted</entry>
</row>
<row>
- <entry><function>ButtonPressMask</function></entry>
+ <entry><symbol>ButtonPressMask</symbol></entry>
<entry>Pointer button down events wanted</entry>
</row>
<row>
- <entry><function>ButtonReleaseMask</function></entry>
+ <entry><symbol>ButtonReleaseMask</symbol></entry>
<entry>Pointer button up events wanted</entry>
</row>
<row>
- <entry><function>EnterWindowMask</function></entry>
+ <entry><symbol>EnterWindowMask</symbol></entry>
<entry>Pointer window entry events wanted</entry>
</row>
<row>
- <entry><function>LeaveWindowMask</function></entry>
+ <entry><symbol>LeaveWindowMask</symbol></entry>
<entry>Pointer window leave events wanted</entry>
</row>
<row>
- <entry><function>PointerMotionMask</function></entry>
+ <entry><symbol>PointerMotionMask</symbol></entry>
<entry>Pointer motion events wanted</entry>
</row>
<row>
- <entry><function>PointerMotionHintMask</function></entry>
+ <entry><symbol>PointerMotionHintMask</symbol></entry>
<entry>Pointer motion hints wanted</entry>
</row>
<row>
- <entry><function>Button1MotionMask</function></entry>
+ <entry><symbol>Button1MotionMask</symbol></entry>
<entry>Pointer motion while button 1 down</entry>
</row>
<row>
- <entry><function>Button2MotionMask</function></entry>
+ <entry><symbol>Button2MotionMask</symbol></entry>
<entry>Pointer motion while button 2 down</entry>
</row>
<row>
- <entry><function>Button3MotionMask</function></entry>
+ <entry><symbol>Button3MotionMask</symbol></entry>
<entry>Pointer motion while button 3 down</entry>
</row>
<row>
- <entry><function>Button4MotionMask</function></entry>
+ <entry><symbol>Button4MotionMask</symbol></entry>
<entry>Pointer motion while button 4 down</entry>
</row>
<row>
- <entry><function>Button5MotionMask</function></entry>
+ <entry><symbol>Button5MotionMask</symbol></entry>
<entry>Pointer motion while button 5 down</entry>
</row>
<row>
- <entry><function>ButtonMotionMask</function></entry>
+ <entry><symbol>ButtonMotionMask</symbol></entry>
<entry>Pointer motion while any button down</entry>
</row>
<row>
- <entry><function>KeymapStateMask</function></entry>
+ <entry><symbol>KeymapStateMask</symbol></entry>
<entry>Keyboard state wanted at window entry and focus in</entry>
</row>
<row>
- <entry><function>ExposureMask</function></entry>
+ <entry><symbol>ExposureMask</symbol></entry>
<entry>Any exposure wanted</entry>
</row>
<row>
- <entry><function>VisibilityChangeMask</function></entry>
+ <entry><symbol>VisibilityChangeMask</symbol></entry>
<entry>Any change in visibility wanted</entry>
</row>
<row>
- <entry><function>StructureNotifyMask</function></entry>
+ <entry><symbol>StructureNotifyMask</symbol></entry>
<entry>Any change in window structure wanted</entry>
</row>
<row>
- <entry><function>ResizeRedirectMask</function></entry>
+ <entry><symbol>ResizeRedirectMask</symbol></entry>
<entry>Redirect resize of this window</entry>
</row>
<row>
- <entry><function>SubstructureNotifyMask</function></entry>
+ <entry><symbol>SubstructureNotifyMask</symbol></entry>
<entry>Substructure notification wanted</entry>
</row>
<row>
- <entry><function>SubstructureRedirectMask</function></entry>
+ <entry><symbol>SubstructureRedirectMask</symbol></entry>
<entry>Redirect structure requests on children</entry>
</row>
<row>
- <entry><function>FocusChangeMask</function></entry>
+ <entry><symbol>FocusChangeMask</symbol></entry>
<entry>Any change in input focus wanted</entry>
</row>
<row>
- <entry><function>PropertyChangeMask</function></entry>
+ <entry><symbol>PropertyChangeMask</symbol></entry>
<entry>Any change in property wanted</entry>
</row>
<row>
- <entry><function>ColormapChangeMask</function></entry>
+ <entry><symbol>ColormapChangeMask</symbol></entry>
<entry>Any change in colormap wanted</entry>
</row>
<row>
- <entry><function>OwnerGrabButtonMask</function></entry>
+ <entry><symbol>OwnerGrabButtonMask</symbol></entry>
<entry>Automatic grabs should activate with owner_events set to True</entry>
</row>
</tbody>
@@ -491,9 +491,9 @@ for a window. For some event masks, there is a one-to-one correspondence between
the event mask constant and the event type constant.
For example, if you pass the event mask
-<function>ButtonPressMask</function>,
+<symbol>ButtonPressMask</symbol>,
the X server sends back only
-<function>ButtonPress</function>
+<symbol>ButtonPress</symbol>
events.
<indexterm><primary>CurrentTime</primary></indexterm>
Most events contain a time member,
@@ -503,17 +503,17 @@ which is the time at which an event occurred. <!-- .LP -->
In other cases, one event mask constant can map to several event type constants.
For example, if you pass the event mask
-<function>SubstructureNotifyMask</function>,
+<symbol>SubstructureNotifyMask</symbol>,
the X server can send back
-<function>CirculateNotify</function>,
-<function>ConfigureNotify</function>,
-<function>CreateNotify</function>,
-<function>DestroyNotify</function>,
-<function>GravityNotify</function>,
-<function>MapNotify</function>,
-<function>ReparentNotify</function>,
+<symbol>CirculateNotify</symbol>,
+<symbol>ConfigureNotify</symbol>,
+<symbol>CreateNotify</symbol>,
+<symbol>DestroyNotify</symbol>,
+<symbol>GravityNotify</symbol>,
+<symbol>MapNotify</symbol>,
+<symbol>ReparentNotify</symbol>,
or
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
events.
</para>
<para>
@@ -522,12 +522,12 @@ In another case, two event masks can map to one event type.
For example,
if you pass either
-<function>PointerMotionMask </function>
+<symbol>PointerMotionMask</symbol>
or
-<function>ButtonMotionMask</function>,
+<symbol>ButtonMotionMask</symbol>,
the X server sends back
a
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
event.
</para>
<para>
@@ -925,28 +925,28 @@ with these client passed arguments: </row>
<row>
<entry><emphasis remap='I'>pointer_mode</emphasis></entry>
- <entry><function>GrabModeAsync</function></entry>
+ <entry><symbol>GrabModeAsync</symbol></entry>
</row>
<row>
<entry><emphasis remap='I'>keyboard_mode</emphasis></entry>
- <entry><function>GrabModeAsync </function></entry>
+ <entry><symbol>GrabModeAsync</symbol></entry>
</row>
<row>
<entry><emphasis remap='I'>owner_events</emphasis></entry>
- <entry><function>True</function>,
+ <entry><symbol>True</symbol>,
if the client has selected
- <function>OwnerGrabButtonMask</function>
+ <symbol>OwnerGrabButtonMask</symbol>
on the event window,
otherwise
- <function>False </function></entry>
+ <symbol>False</symbol></entry>
</row>
<row>
<entry><emphasis remap='I'>confine_to</emphasis></entry>
- <entry><function>None </function></entry>
+ <entry><symbol>None</symbol></entry>
</row>
<row>
<entry><emphasis remap='I'>cursor</emphasis></entry>
- <entry><function>None </function></entry>
+ <entry><symbol>None</symbol></entry>
</row>
</tbody>
</tgroup>
@@ -977,14 +977,14 @@ and <indexterm><primary>Events</primary><secondary>MotionNotify</secondary></indexterm>
This section discusses the processing that occurs for the
keyboard events
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
and
-<function>KeyRelease </function>
+<symbol>KeyRelease</symbol>
and the pointer events
-<function>ButtonPress</function>,
-<function>ButtonRelease</function>,
+<symbol>ButtonPress</symbol>,
+<symbol>ButtonRelease</symbol>,
and
-<function>MotionNotify</function>.
+<symbol>MotionNotify</symbol>.
For information about the keyboard event-handling utilities,
see chapter 11.
</para>
@@ -993,30 +993,30 @@ see chapter 11. <indexterm significance="preferred"><primary>KeyPress</primary></indexterm>
<indexterm significance="preferred"><primary>KeyRelease</primary></indexterm>
The X server reports
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
or
-<function>KeyRelease</function>
+<symbol>KeyRelease</symbol>
events to clients wanting information about keys that logically change state.
Note that these events are generated for all keys,
even those mapped to modifier bits.
<indexterm significance="preferred"><primary>ButtonPress</primary></indexterm>
<indexterm significance="preferred"><primary>ButtonRelease</primary></indexterm>
The X server reports
-<function>ButtonPress</function>
+<symbol>ButtonPress</symbol>
or
-<function>ButtonRelease</function>
+<symbol>ButtonRelease</symbol>
events to clients wanting information about buttons that logically change state.
</para>
<para>
<!-- .LP -->
<indexterm significance="preferred"><primary>MotionNotify</primary></indexterm>
The X server reports
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events to clients wanting information about when the pointer logically moves.
The X server generates this event whenever the pointer is moved
and the pointer motion begins and ends in the window.
The granularity of
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events is not guaranteed,
but a client that selects this event type is guaranteed
to receive at least one event when the pointer moves and then rests.
@@ -1029,23 +1029,23 @@ if device event processing is frozen. <para>
<!-- .LP -->
To receive
-<function>KeyPress</function>,
-<function>KeyRelease</function>,
-<function>ButtonPress</function>,
+<symbol>KeyPress</symbol>,
+<symbol>KeyRelease</symbol>,
+<symbol>ButtonPress</symbol>,
and
-<function>ButtonRelease </function>
+<symbol>ButtonRelease</symbol>
events, set
-<function>KeyPressMask</function>,
-<function>KeyReleaseMask</function>,
-<function>ButtonPressMask</function>,
+<symbol>KeyPressMask</symbol>,
+<symbol>KeyReleaseMask</symbol>,
+<symbol>ButtonPressMask</symbol>,
and
-<function>ButtonReleaseMask </function>
+<symbol>ButtonReleaseMask</symbol>
bits in the event-mask attribute of the window.
</para>
<para>
<!-- .LP -->
To receive
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events, set one or more of the following event
masks bits in the event-mask attribute of the window.
</para>
@@ -1053,57 +1053,57 @@ masks bits in the event-mask attribute of the window. <listitem>
<para>
<function>Button1MotionMask \ \-</function>
-<function>Button5MotionMask</function>
+<symbol>Button5MotionMask</symbol>
</para>
</listitem>
<listitem>
<para>
The client application receives
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events only when one or more of the specified buttons is pressed.
</para>
</listitem>
<listitem>
<para>
-<function>ButtonMotionMask</function>
+<symbol>ButtonMotionMask</symbol>
</para>
</listitem>
<listitem>
<para>
The client application receives
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events only when at least one button is pressed.
</para>
</listitem>
<listitem>
<para>
-<function>PointerMotionMask</function>
+<symbol>PointerMotionMask</symbol>
</para>
</listitem>
<listitem>
<para>
The client application receives
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events independent of the state of
the pointer buttons.
</para>
</listitem>
<listitem>
<para>
-<function>PointerMotionHintMask</function>
+<symbol>PointerMotionHintMask</symbol>
</para>
</listitem>
<listitem>
<para>
If
-<function>PointerMotionHintMask</function>
+<symbol>PointerMotionHintMask</symbol>
is selected in combination with one or more of the above masks,
the X server is free to send only one
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
event (with the is_hint member of the
-<function>XPointerMovedEvent</function>
+<type>XPointerMovedEvent</type>
structure set to
-<function>NotifyHint</function>)
+<symbol>NotifyHint</symbol>)
to the client for the event window,
until either the key or button state changes,
the pointer leaves the event window, or the client calls
@@ -1111,9 +1111,9 @@ the pointer leaves the event window, or the client calls or
<function>XGetMotionEvents</function>.
The server still may send
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events without is_hint set to
-<function>NotifyHint</function>.
+<symbol>NotifyHint</symbol>.
</para>
</listitem>
</itemizedlist>
@@ -1212,14 +1212,14 @@ relative to the root window's origin at the time of the event. The same_screen member is set to indicate whether the event
window is on the same screen
as the root window and can be either
-<function>True </function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
If
-<function>True</function>,
+<symbol>True</symbol>,
the event and root windows are on the same screen.
If
-<function>False</function>,
+<symbol>False</symbol>,
the event and root windows are not on the same screen.
</para>
<para>
@@ -1229,7 +1229,7 @@ the subwindow member of the structure is set to the child of the event window that is the source window or the child of the event window that is
an ancestor of the source window.
Otherwise, the X server sets the subwindow member to
-<function>None</function>.
+<symbol>None</symbol>.
The time member is set to the time when the event was generated
and is expressed in milliseconds.
</para>
@@ -1246,28 +1246,28 @@ The state member is set to indicate the logical state of the pointer buttons and modifier keys just prior to the event,
which is the bitwise inclusive OR of one or more of the
button or modifier key masks:
-<function>Button1Mask</function>,
-<function>Button2Mask</function>,
-<function>Button3Mask</function>,
-<function>Button4Mask</function>,
-<function>Button5Mask</function>,
-<function>ShiftMask</function>,
-<function>LockMask</function>,
-<function>ControlMask</function>,
-<function>Mod1Mask</function>,
-<function>Mod2Mask</function>,
-<function>Mod3Mask</function>,
-<function>Mod4Mask</function>,
+<symbol>Button1Mask</symbol>,
+<symbol>Button2Mask</symbol>,
+<symbol>Button3Mask</symbol>,
+<symbol>Button4Mask</symbol>,
+<symbol>Button5Mask</symbol>,
+<symbol>ShiftMask</symbol>,
+<symbol>LockMask</symbol>,
+<symbol>ControlMask</symbol>,
+<symbol>Mod1Mask</symbol>,
+<symbol>Mod2Mask</symbol>,
+<symbol>Mod3Mask</symbol>,
+<symbol>Mod4Mask</symbol>,
and
-<function>Mod5Mask</function>.
+<symbol>Mod5Mask</symbol>.
</para>
<para>
<!-- .LP -->
Each of these structures also has a member that indicates the detail.
For the
-<function>XKeyPressedEvent</function>
+<type>XKeyPressedEvent</type>
and
-<function>XKeyReleasedEvent</function>
+<type>XKeyReleasedEvent</type>
structures, this member is called a keycode.
It is set to a number that represents a physical key on the keyboard.
The keycode is an arbitrary representation for any key on the keyboard
@@ -1276,25 +1276,25 @@ The keycode is an arbitrary representation for any key on the keyboard <para>
<!-- .LP -->
For the
-<function>XButtonPressedEvent</function>
+<type>XButtonPressedEvent</type>
and
-<function>XButtonReleasedEvent</function>
+<type>XButtonReleasedEvent</type>
structures, this member is called button.
It represents the pointer button that changed state and can be the
-<function>Button1</function>,
-<function>Button2</function>,
-<function>Button3</function>,
-<function>Button4</function>,
+<symbol>Button1</symbol>,
+<symbol>Button2</symbol>,
+<symbol>Button3</symbol>,
+<symbol>Button4</symbol>,
or
-<function>Button5 </function>
+<symbol>Button5</symbol>
value.
For the
-<function>XPointerMovedEvent</function>
+<type>XPointerMovedEvent</type>
structure, this member is called is_hint.
It can be set to
-<function>NotifyNormal</function>
+<symbol>NotifyNormal</symbol>
or
-<function>NotifyHint</function>.
+<symbol>NotifyHint</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1313,95 +1313,95 @@ follows: </thead>
<tbody>
<row>
- <entry><function>Button1MotionMask</function></entry>
+ <entry><symbol>Button1MotionMask</symbol></entry>
<entry>(1L<<8)</entry>
</row>
<row>
- <entry><function>Button2MotionMask</function></entry>
+ <entry><symbol>Button2MotionMask</symbol></entry>
<entry>(1L<<9)</entry>
</row>
<row>
- <entry><function>Button3MotionMask</function></entry>
+ <entry><symbol>Button3MotionMask</symbol></entry>
<entry>(1L<<10)</entry>
</row>
<row>
- <entry><function>Button4MotionMask</function></entry>
+ <entry><symbol>Button4MotionMask</symbol></entry>
<entry>(1L<<11)</entry>
</row>
<row>
- <entry><function>Button5MotionMask</function></entry>
+ <entry><symbol>Button5MotionMask</symbol></entry>
<entry>(1L<<12)</entry>
</row>
<row>
- <entry><function>Button1Mask</function></entry>
+ <entry><symbol>Button1Mask</symbol></entry>
<entry>(1<<8)</entry>
</row>
<row>
- <entry><function>Button2Mask</function></entry>
+ <entry><symbol>Button2Mask</symbol></entry>
<entry>(1<<9)</entry>
</row>
<row>
- <entry><function>Button3Mask</function></entry>
+ <entry><symbol>Button3Mask</symbol></entry>
<entry>(1<<10)</entry>
</row>
<row>
- <entry><function>Button4Mask</function></entry>
+ <entry><symbol>Button4Mask</symbol></entry>
<entry>(1<<11)</entry>
</row>
<row>
- <entry><function>Button5Mask</function></entry>
+ <entry><symbol>Button5Mask</symbol></entry>
<entry>(1<<12)</entry>
</row>
<row>
- <entry><function>ShiftMask</function></entry>
+ <entry><symbol>ShiftMask</symbol></entry>
<entry>(1<<0)</entry>
</row>
<row>
- <entry><function>LockMask</function></entry>
+ <entry><symbol>LockMask</symbol></entry>
<entry>(1<<1)</entry>
</row>
<row>
- <entry><function>ControlMask</function></entry>
+ <entry><symbol>ControlMask</symbol></entry>
<entry>(1<<2)</entry>
</row>
<row>
- <entry><function>Mod1Mask</function></entry>
+ <entry><symbol>Mod1Mask</symbol></entry>
<entry>(1<<3)</entry>
</row>
<row>
- <entry><function>Mod2Mask</function></entry>
+ <entry><symbol>Mod2Mask</symbol></entry>
<entry>(1<<4)</entry>
</row>
<row>
- <entry><function>Mod3Mask</function></entry>
+ <entry><symbol>Mod3Mask</symbol></entry>
<entry>(1<<5)</entry>
</row>
<row>
- <entry><function>Mod4Mask</function></entry>
+ <entry><symbol>Mod4Mask</symbol></entry>
<entry>(1<<6)</entry>
</row>
<row>
- <entry><function>Mod5Mask</function></entry>
+ <entry><symbol>Mod5Mask</symbol></entry>
<entry>(1<<7)</entry>
</row>
<row>
- <entry><function>Button1</function></entry>
+ <entry><symbol>Button1</symbol></entry>
<entry>1</entry>
</row>
<row>
- <entry><function>Button2</function></entry>
+ <entry><symbol>Button2</symbol></entry>
<entry>2</entry>
</row>
<row>
- <entry><function>Button3</function></entry>
+ <entry><symbol>Button3</symbol></entry>
<entry>3</entry>
</row>
<row>
- <entry><function>Button4</function></entry>
+ <entry><symbol>Button4</symbol></entry>
<entry>4</entry>
</row>
<row>
- <entry><function>Button5</function></entry>
+ <entry><symbol>Button5</symbol></entry>
<entry>5</entry>
</row>
</tbody>
@@ -1421,50 +1421,50 @@ follows: <indexterm><primary>Events</primary><secondary>LeaveNotify</secondary></indexterm>
This section describes the processing that
occurs for the window crossing events
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify</function>.
+<symbol>LeaveNotify</symbol>.
<indexterm significance="preferred"><primary>EnterNotify</primary></indexterm>
<indexterm significance="preferred"><primary>LeaveNotify</primary></indexterm>
If a pointer motion or a window hierarchy change causes the
pointer to be in a different window than before, the X server reports
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
or
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events to clients who have selected for these events.
All
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events caused by a hierarchy change are
generated after any hierarchy event
-(<function>UnmapNotify</function>,
-<function>MapNotify</function>,
-<function>ConfigureNotify</function>,
-<function>GravityNotify</function>,
-<function>CirculateNotify</function>)
+(<symbol>UnmapNotify</symbol>,
+<symbol>MapNotify</symbol>,
+<symbol>ConfigureNotify</symbol>,
+<symbol>GravityNotify</symbol>,
+<symbol>CirculateNotify</symbol>)
caused by that change;
however, the X protocol does not constrain the ordering of
-<function>EnterNotify </function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify </function>
+<symbol>LeaveNotify</symbol>
events with respect to
-<function>FocusOut</function>,
-<function>VisibilityNotify</function>,
+<symbol>FocusOut</symbol>,
+<symbol>VisibilityNotify</symbol>,
and
-<function>Expose </function>
+<symbol>Expose</symbol>
events.
</para>
<para>
<!-- .LP -->
This contrasts with
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events, which are also generated when the pointer moves
but only when the pointer motion begins and ends in a single window.
An
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
or
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event also can be generated when some client application calls
<function>XGrabPointer</function>
and
@@ -1473,13 +1473,13 @@ and <para>
<!-- .LP -->
To receive
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
or
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events, set the
-<function>EnterWindowMask</function>
+<symbol>EnterWindowMask</symbol>
or
-<function>LeaveWindowMask</function>
+<symbol>LeaveWindowMask</symbol>
bits of the event-mask attribute of the window.
</para>
<para>
@@ -1523,9 +1523,9 @@ typedef XCrossingEvent XLeaveWindowEvent; <!-- .LP -->
<!-- .eM -->
The window member is set to the window on which the
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
or
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event was generated and is referred to as the event window.
This is the window used by the X server to report the event,
and is relative to the root
@@ -1536,17 +1536,17 @@ on which the event occurred. <para>
<!-- .LP -->
For a
-<function>LeaveNotify </function>
+<symbol>LeaveNotify</symbol>
event,
if a child of the event window contains the initial position of the pointer,
the subwindow component is set to that child.
Otherwise, the X server sets the subwindow member to
-<function>None</function>.
+<symbol>None</symbol>.
For an
-<function>EnterNotify </function>
+<symbol>EnterNotify</symbol>
event, if a child of the event window contains the final pointer position,
the subwindow component is set to that child or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1567,14 +1567,14 @@ root window's origin at the time of the event. <!-- .LP -->
The same_screen member is set to indicate whether the event window is on the same screen
as the root window and can be either
-<function>True </function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
If
-<function>True</function>,
+<symbol>True</symbol>,
the event and root windows are on the same screen.
If
-<function>False</function>,
+<symbol>False</symbol>,
the event and root windows are not on the same screen.
</para>
<para>
@@ -1582,14 +1582,14 @@ the event and root windows are not on the same screen. The focus member is set to indicate whether the event window is the focus window or an
inferior of the focus window.
The X server can set this member to either
-<function>True </function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
If
-<function>True</function>,
+<symbol>True</symbol>,
the event window is the focus window or an inferior of the focus window.
If
-<function>False</function>,
+<symbol>False</symbol>,
the event window is not the focus window or an inferior of the focus window.
</para>
<para>
@@ -1599,19 +1599,19 @@ modifier keys just prior to the event.
The X server can set this member to the bitwise inclusive OR of one
or more of the button or modifier key masks:
-<function>Button1Mask</function>,
-<function>Button2Mask</function>,
-<function>Button3Mask</function>,
-<function>Button4Mask</function>,
-<function>Button5Mask</function>,
-<function>ShiftMask</function>,
-<function>LockMask</function>,
-<function>ControlMask</function>,
-<function>Mod1Mask</function>,
-<function>Mod2Mask</function>,
-<function>Mod3Mask</function>,
-<function>Mod4Mask</function>,
-<function>Mod5Mask</function>.
+<symbol>Button1Mask</symbol>,
+<symbol>Button2Mask</symbol>,
+<symbol>Button3Mask</symbol>,
+<symbol>Button4Mask</symbol>,
+<symbol>Button5Mask</symbol>,
+<symbol>ShiftMask</symbol>,
+<symbol>LockMask</symbol>,
+<symbol>ControlMask</symbol>,
+<symbol>Mod1Mask</symbol>,
+<symbol>Mod2Mask</symbol>,
+<symbol>Mod3Mask</symbol>,
+<symbol>Mod4Mask</symbol>,
+<symbol>Mod5Mask</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1619,20 +1619,20 @@ The mode member is set to indicate whether the events are normal events, pseudo-motion events
when a grab activates, or pseudo-motion events when a grab deactivates.
The X server can set this member to
-<function>NotifyNormal</function>,
-<function>NotifyGrab</function>,
+<symbol>NotifyNormal</symbol>,
+<symbol>NotifyGrab</symbol>,
or
-<function>NotifyUngrab</function>.
+<symbol>NotifyUngrab</symbol>.
</para>
<para>
<!-- .LP -->
The detail member is set to indicate the notify detail and can be
-<function>NotifyAncestor</function>,
-<function>NotifyVirtual</function>,
-<function>NotifyInferior</function>,
-<function>NotifyNonlinear</function>,
+<symbol>NotifyAncestor</symbol>,
+<symbol>NotifyVirtual</symbol>,
+<symbol>NotifyInferior</symbol>,
+<symbol>NotifyNonlinear</symbol>,
or
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
<sect2 id="Normal_Entry_Exit_Events">
<title>Normal Entry/Exit Events</title>
@@ -1641,17 +1641,17 @@ or <!-- .XE -->
<para>
<!-- .LP -->
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events are generated when the pointer moves from
one window to another window.
Normal events are identified by
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
or
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structures whose mode member is set to
-<function>NotifyNormal</function>.
+<symbol>NotifyNormal</symbol>.
</para>
<itemizedlist>
<listitem>
@@ -1664,32 +1664,32 @@ the X server does the following: <listitem>
<para>
It generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on window A, with the detail member of the
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyAncestor</function>.
+<symbol>NotifyAncestor</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on each window between window A and window B, exclusive,
with the detail member of each
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyVirtual</function>.
+<symbol>NotifyVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on window B, with the detail member of the
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyInferior</function>.
+<symbol>NotifyInferior</symbol>.
<!-- .RE -->
</para>
</listitem>
@@ -1703,33 +1703,33 @@ the X server does the following: <listitem>
<para>
It generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on window A,
with the detail member of the
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyInferior</function>.
+<symbol>NotifyInferior</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on each window between window A and window B, exclusive, with the
detail member of each
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyVirtual</function>.
+<symbol>NotifyVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on window B, with the detail member of the
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyAncestor</function>.
+<symbol>NotifyAncestor</symbol>.
<!-- .RE -->
</para>
</listitem>
@@ -1744,44 +1744,44 @@ the X server does the following: <listitem>
<para>
It generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on window A,
with the detail member of the
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on each window between window A and window C, exclusive,
with the detail member of each
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on each window between window C and window B, exclusive,
with the detail member of each
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on window B, with the detail member of the
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
<!-- .RE -->
</para>
</listitem>
@@ -1795,46 +1795,46 @@ the X server does the following: <listitem>
<para>
It generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on window A,
with the detail member of the
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
If window A is not a root window,
it generates a
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
event on each window above window A up to and including its root,
with the detail member of each
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
If window B is not a root window,
it generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on each window from window B's root down to but not including
window B, with the detail member of each
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates an
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
event on window B, with the detail member of the
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
<!-- .RE -->
<!-- .\".SH 3 -->
</para>
@@ -1849,24 +1849,24 @@ structure set to <para>
<!-- .LP -->
Pseudo-motion mode
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events are generated when a pointer grab activates or deactivates.
Events in which the pointer grab activates
are identified by
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
or
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structures whose mode member is set to
-<function>NotifyGrab</function>.
+<symbol>NotifyGrab</symbol>.
Events in which the pointer grab deactivates
are identified by
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
or
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structures whose mode member is set to
-<function>NotifyUngrab</function>
+<symbol>NotifyUngrab</symbol>
(see
<function>XGrabPointer</function>).
</para>
@@ -1875,7 +1875,7 @@ structures whose mode member is set to <para>
When a pointer grab activates after any initial warp into a confine_to
window and before generating any actual
-<function>ButtonPress</function>
+<symbol>ButtonPress</symbol>
event that activates the grab,
G is the grab_window for the grab,
and P is the window the pointer is in,
@@ -1886,16 +1886,16 @@ the X server does the following: <listitem>
<para>
It generates
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events (see section 10.6.1)
with the mode members of the
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
and
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structures set to
-<function>NotifyGrab</function>.
+<symbol>NotifyGrab</symbol>.
These events are generated
as if the pointer were to suddenly warp from
its current position in P to some position in G.
@@ -1907,7 +1907,7 @@ as both the initial and final positions for the events. <listitem>
<para>
When a pointer grab deactivates after generating any actual
-<function>ButtonRelease</function>
+<symbol>ButtonRelease</symbol>
event that deactivates the grab,
G is the grab_window for the grab,
and P is the window the pointer is in,
@@ -1918,16 +1918,16 @@ the X server does the following: <listitem>
<para>
It generates
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events (see section 10.6.1)
with the mode members of the
-<function>XEnterWindowEvent</function>
+<type>XEnterWindowEvent</type>
and
-<function>XLeaveWindowEvent</function>
+<type>XLeaveWindowEvent</type>
structures set to
-<function>NotifyUngrab</function>.
+<symbol>NotifyUngrab</symbol>.
These events are generated as if the pointer were to suddenly warp from
some position in G to its current position in P.
However, the pointer does not warp, and the X server uses the
@@ -1949,15 +1949,15 @@ initial and final positions for the events. <indexterm><primary>Events</primary><secondary>FocusIn</secondary></indexterm>
<indexterm><primary>Events</primary><secondary>FocusOut</secondary></indexterm>
This section describes the processing that occurs for the input focus events
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut</function>.
+<symbol>FocusOut</symbol>.
<indexterm significance="preferred"><primary>FocusIn</primary></indexterm>
<indexterm significance="preferred"><primary>FocusOut</primary></indexterm>
The X server can report
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
or
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events to clients wanting information about when the input focus changes.
The keyboard is always attached to some window
(typically, the root window or a top-level window),
@@ -1970,11 +1970,11 @@ to control highlighting of areas on the screen. <para>
<!-- .LP -->
To receive
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
or
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events, set the
-<function>FocusChangeMask</function>
+<symbol>FocusChangeMask</symbol>
bit in the event-mask attribute of the window.
</para>
<para>
@@ -2010,9 +2010,9 @@ typedef XFocusChangeEvent XFocusOutEvent; <!-- .LP -->
<!-- .eM -->
The window member is set to the window on which the
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
or
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event was generated.
This is the window used by the X server to report the event.
The mode member is set to indicate whether the focus events
@@ -2021,42 +2021,42 @@ focus events while grabbed, focus events
when a grab activates, or focus events when a grab deactivates.
The X server can set the mode member to
-<function>NotifyNormal</function>,
-<function>NotifyWhileGrabbed</function>,
-<function>NotifyGrab</function>,
+<symbol>NotifyNormal</symbol>,
+<symbol>NotifyWhileGrabbed</symbol>,
+<symbol>NotifyGrab</symbol>,
or
-<function>NotifyUngrab</function>.
+<symbol>NotifyUngrab</symbol>.
</para>
<para>
<!-- .LP -->
All
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events caused by a window unmap are generated after any
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
event; however, the X protocol does not constrain the ordering of
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events with respect to
generated
-<function>EnterNotify</function>,
-<function>LeaveNotify</function>,
-<function>VisibilityNotify</function>,
+<symbol>EnterNotify</symbol>,
+<symbol>LeaveNotify</symbol>,
+<symbol>VisibilityNotify</symbol>,
and
-<function>Expose</function>
+<symbol>Expose</symbol>
events.
</para>
<para>
<!-- .LP -->
Depending on the event mode,
the detail member is set to indicate the notify detail and can be
-<function>NotifyAncestor</function>,
-<function>NotifyVirtual</function>,
-<function>NotifyInferior</function>,
-<function>NotifyNonlinear</function>,
-<function>NotifyNonlinearVirtual</function>,
-<function>NotifyPointer</function>,
-<function>NotifyPointerRoot</function>,
+<symbol>NotifyAncestor</symbol>,
+<symbol>NotifyVirtual</symbol>,
+<symbol>NotifyInferior</symbol>,
+<symbol>NotifyNonlinear</symbol>,
+<symbol>NotifyNonlinearVirtual</symbol>,
+<symbol>NotifyPointer</symbol>,
+<symbol>NotifyPointerRoot</symbol>,
or
-<function>NotifyDetailNone</function>.
+<symbol>NotifyDetailNone</symbol>.
</para>
<sect2 id="Normal_Focus_Events_and_Focus_Events_While_Grabbed_">
<title>Normal Focus Events and Focus Events While Grabbed </title>
@@ -2066,17 +2066,17 @@ or <para>
<!-- .LP -->
Normal focus events are identified by
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
or
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structures whose mode member is set to
-<function>NotifyNormal</function>.
+<symbol>NotifyNormal</symbol>.
Focus events while grabbed are identified by
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
or
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structures whose mode member is set to
-<function>NotifyWhileGrabbed</function>.
+<symbol>NotifyWhileGrabbed</symbol>.
The X server processes normal focus and focus events while grabbed according to
the following:
</para>
@@ -2092,32 +2092,32 @@ the X server does the following: <listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on window A, with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyAncestor</function>.
+<symbol>NotifyAncestor</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window between window A and window B, exclusive,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyVirtual</function>.
+<symbol>NotifyVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on window B, with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyInferior</function>.
+<symbol>NotifyInferior</symbol>.
</para>
</listitem>
<listitem>
@@ -2125,12 +2125,12 @@ structure set to If window P is an inferior of window B
but window P is not window A or an inferior or ancestor of window A,
it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window below window B, down to and including window P,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
<!-- .RE -->
</para>
</listitem>
@@ -2147,44 +2147,44 @@ the X server does the following: If window P is an inferior of window A
but P is not an inferior of window B or an ancestor of B,
it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window from window P up to but not including window A,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on window A,
with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyInferior</function>.
+<symbol>NotifyInferior</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window between window A and window B, exclusive, with the
detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyVirtual</function>.
+<symbol>NotifyVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on window B, with the detail member of the
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyAncestor</function>.
+<symbol>NotifyAncestor</symbol>.
<!-- .RE -->
</para>
</listitem>
@@ -2201,66 +2201,66 @@ the X server does the following: <para>
If window P is an inferior of window A,
it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window from window P up to but not including window A,
with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on window A,
with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window between window A and window C, exclusive,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window between C and B, exclusive,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on window B, with the detail member of the
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
If window P is an inferior of window B, it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window below window B down to and including window P,
with the detail member of the
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
<!-- .RE -->
</para>
</listitem>
@@ -2275,78 +2275,78 @@ the X server does the following: <listitem>
<para>
If window P is an inferior of window A, it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window from window P up to but not including window A,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on window A,
with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
If window A is not a root window,
it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window above window A up to and including its root,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
If window B is not a root window,
it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window from window B's root down to but not including
window B, with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on window B, with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
If window P is an inferior of window B, it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window below window B down to and including window P,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
<!-- .RE -->
</para>
</listitem>
<listitem>
<para>
When the focus moves from window A to
-<function>PointerRoot</function>
+<symbol>PointerRoot</symbol>
(events sent to the window under the pointer)
or
-<function>None </function>
+<symbol>None</symbol>
(discard), and the pointer is in window P,
the X server does the following:
<!-- .RS -->
@@ -2355,69 +2355,69 @@ the X server does the following: <listitem>
<para>
If window P is an inferior of window A, it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window from window P up to but not including window A,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on window A, with the detail member of the
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
If window A is not a root window,
it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window above window A up to and including its root,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on the root window of all screens, with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointerRoot</function>
+<symbol>NotifyPointerRoot</symbol>
(or
-<function>NotifyDetailNone</function>).
+<symbol>NotifyDetailNone</symbol>).
</para>
</listitem>
<listitem>
<para>
If the new focus is
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window from window P's root down to and including window P,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
<!-- .RE -->
</para>
</listitem>
<listitem>
<para>
When the focus moves from
-<function>PointerRoot</function>
+<symbol>PointerRoot</symbol>
(events sent to the window under the pointer)
or
-<function>None </function>
+<symbol>None</symbol>
to window A, and the pointer is in window P,
the X server does the following:
<!-- .RS -->
@@ -2426,71 +2426,71 @@ the X server does the following: <listitem>
<para>
If the old focus is
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window from window P up to and including window P's root,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on all root windows,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointerRoot</function>
+<symbol>NotifyPointerRoot</symbol>
(or
-<function>NotifyDetailNone</function>).
+<symbol>NotifyDetailNone</symbol>).
</para>
</listitem>
<listitem>
<para>
If window A is not a root window,
it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window from window A's root down to but not including window A,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyNonlinearVirtual</function>.
+<symbol>NotifyNonlinearVirtual</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on window A,
with the detail member of the
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyNonlinear</function>.
+<symbol>NotifyNonlinear</symbol>.
</para>
</listitem>
<listitem>
<para>
If window P is an inferior of window A, it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window below window A down to and including window P,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
<!-- .RE -->
</para>
</listitem>
<listitem>
<para>
When the focus moves from
-<function>PointerRoot</function>
+<symbol>PointerRoot</symbol>
(events sent to the window under the pointer)
to
-<function>None</function>
+<symbol>None</symbol>
(or vice versa), and the pointer is in window P,
the X server does the following:
<!-- .RS -->
@@ -2499,53 +2499,53 @@ the X server does the following: <listitem>
<para>
If the old focus is
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
it generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on each window from window P up to and including window P's root,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
event on all root windows,
with the detail member of each
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structure set to either
-<function>NotifyPointerRoot</function>
+<symbol>NotifyPointerRoot</symbol>
or
-<function>NotifyDetailNone</function>.
+<symbol>NotifyDetailNone</symbol>.
</para>
</listitem>
<listitem>
<para>
It generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on all root windows,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyDetailNone </function>
+<symbol>NotifyDetailNone</symbol>
or
-<function>NotifyPointerRoot</function>.
+<symbol>NotifyPointerRoot</symbol>.
</para>
</listitem>
<listitem>
<para>
If the new focus is
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
it generates a
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event on each window from window P's root down to and including window P,
with the detail member of each
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
structure set to
-<function>NotifyPointer</function>.
+<symbol>NotifyPointer</symbol>.
<!-- .RE -->
<!-- .\".SH 3 -->
</para>
@@ -2561,18 +2561,18 @@ structure set to <!-- .LP -->
Focus events in which the keyboard grab activates
are identified by
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
or
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structures whose mode member is set to
-<function>NotifyGrab</function>.
+<symbol>NotifyGrab</symbol>.
Focus events in which the keyboard grab deactivates
are identified by
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
or
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structures whose mode member is set to
-<function>NotifyUngrab </function>
+<symbol>NotifyUngrab</symbol>
(see
<function>XGrabKeyboard</function>).
</para>
@@ -2580,7 +2580,7 @@ structures whose mode member is set to <listitem>
<para>
When a keyboard grab activates before generating any actual
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event that activates the grab,
G is the grab_window, and F is the current focus,
the X server does the following:
@@ -2590,15 +2590,15 @@ the X server does the following: <listitem>
<para>
It generates
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events, with the mode members of the
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
and
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structures set to
-<function>NotifyGrab</function>.
+<symbol>NotifyGrab</symbol>.
These events are generated
as if the focus were to change from
F to G.
@@ -2608,7 +2608,7 @@ F to G. <listitem>
<para>
When a keyboard grab deactivates after generating any actual
-<function>KeyRelease</function>
+<symbol>KeyRelease</symbol>
event that deactivates the grab,
G is the grab_window, and F is the current focus,
the X server does the following:
@@ -2618,15 +2618,15 @@ the X server does the following: <listitem>
<para>
It generates
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events, with the mode members of the
-<function>XFocusInEvent</function>
+<type>XFocusInEvent</type>
and
-<function>XFocusOutEvent</function>
+<type>XFocusOutEvent</type>
structures set to
-<function>NotifyUngrab</function>.
+<symbol>NotifyUngrab</symbol>.
These events are generated
as if the focus were to change from
G to F.
@@ -2646,20 +2646,20 @@ G to F. <indexterm><primary>Events</primary><secondary>KeymapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>KeymapNotify</primary></indexterm>
The X server can report
-<function>KeymapNotify</function>
+<symbol>KeymapNotify</symbol>
events to clients that want information about changes in their keyboard state.
</para>
<para>
<!-- .LP -->
To receive
-<function>KeymapNotify</function>
+<symbol>KeymapNotify</symbol>
events, set the
-<function>KeymapStateMask</function>
+<symbol>KeymapStateMask</symbol>
bit in the event-mask attribute of the window.
The X server generates this event immediately after every
-<function>EnterNotify</function>
+<symbol>EnterNotify</symbol>
and
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
event.
</para>
<para>
@@ -2714,7 +2714,7 @@ restoring the contents of an exposed window region. (An exposed window region describes a formerly obscured window whose
region becomes visible.)
Therefore, the X server sends
-<function>Expose </function>
+<symbol>Expose</symbol>
events describing the window and the region of the window that has been exposed.
A naive client application usually redraws the entire window.
A more sophisticated client application redraws only the exposed region.
@@ -2729,43 +2729,43 @@ A more sophisticated client application redraws only the exposed region. <indexterm><primary>Events</primary><secondary>Expose</secondary></indexterm>
<indexterm significance="preferred"><primary>Expose</primary></indexterm>
The X server can report
-<function>Expose</function>
+<symbol>Expose</symbol>
events to clients wanting information about when the contents of window regions
have been lost.
The circumstances in which the X server generates
-<function>Expose</function>
+<symbol>Expose</symbol>
events are not as definite as those for other events.
However, the X server never generates
-<function>Expose</function>
+<symbol>Expose</symbol>
events on windows whose class you specified as
-<function>InputOnly</function>.
+<symbol>InputOnly</symbol>.
The X server can generate
-<function>Expose</function>
+<symbol>Expose</symbol>
events when no valid contents are available for regions of a window
and either the regions are visible,
the regions are viewable and the server is (perhaps newly) maintaining
backing store on the window,
or the window is not viewable but the server is (perhaps newly) honoring the
window's backing-store attribute of
-<function>Always</function>
+<symbol>Always</symbol>
or
-<function>WhenMapped</function>.
+<symbol>WhenMapped</symbol>.
The regions decompose into an (arbitrary) set of rectangles,
and an
-<function>Expose</function>
+<symbol>Expose</symbol>
event is generated for each rectangle.
For any given window,
the X server guarantees to report contiguously
all of the regions exposed by some action that causes
-<function>Expose </function>
+<symbol>Expose</symbol>
events, such as raising a window.
</para>
<para>
<!-- .LP -->
To receive
-<function>Expose</function>
+<symbol>Expose</symbol>
events, set the
-<function>ExposureMask</function>
+<symbol>ExposureMask</symbol>
bit in the event-mask attribute of the window.
</para>
<para>
@@ -2799,17 +2799,17 @@ The x and y members are set to the coordinates relative to the window's origin and indicate the upper-left corner of the rectangle.
The width and height members are set to the size (extent) of the rectangle.
The count member is set to the number of
-<function>Expose</function>
+<symbol>Expose</symbol>
events that are to follow.
If count is zero, no more
-<function>Expose</function>
+<symbol>Expose</symbol>
events follow for this window.
However, if count is nonzero, at least that number of
-<function>Expose </function>
+<symbol>Expose</symbol>
events (and possibly more) follow for this window.
Simple applications that do not want to optimize redisplay by distinguishing
between subareas of its window can just ignore all
-<function>Expose</function>
+<symbol>Expose</symbol>
events with nonzero counts and perform full redisplays
on events with zero counts.
</para>
@@ -2825,7 +2825,7 @@ on events with zero counts. <indexterm><primary>Events</primary><secondary>NoExpose</secondary></indexterm>
<indexterm significance="preferred"><primary>GraphicsExpose</primary></indexterm>
The X server can report
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
events to clients wanting information about when a destination region could not
be computed during certain graphics requests:
<function>XCopyArea</function>
@@ -2842,29 +2842,29 @@ drawable). <!-- .LP -->
<indexterm significance="preferred"><primary>NoExpose</primary></indexterm>
The X server generates a
-<function>NoExpose</function>
+<symbol>NoExpose</symbol>
event whenever a graphics request that might
produce a
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
event does not produce any.
In other words, the client is really asking for a
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
event but instead receives a
-<function>NoExpose</function>
+<symbol>NoExpose</symbol>
event.
</para>
<para>
<!-- .LP -->
To receive
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
or
-<function>NoExpose</function>
+<symbol>NoExpose</symbol>
events, you must first set the graphics-exposure
attribute of the graphics context to
-<function>True</function>.
+<symbol>True</symbol>.
You also can set the graphics-expose attribute when creating a graphics
context using
-<function>XCreateGC </function>
+<function>XCreateGC</function>
or by calling
<function>XSetGraphicsExposures</function>.
</para>
@@ -2918,21 +2918,21 @@ The drawable member is set to the drawable of the destination region on which the graphics request was to be performed.
The major_code member is set to the graphics request initiated by the client
and can be either
-<function>X_CopyArea</function>
+<symbol>X_CopyArea</symbol>
or
-<function>X_CopyPlane</function>.
+<symbol>X_CopyPlane</symbol>.
If it is
-<function>X_CopyArea</function>,
+<symbol>X_CopyArea</symbol>,
a call to
<function>XCopyArea</function>
initiated the request.
If it is
-<function>X_CopyPlane</function>,
+<symbol>X_CopyPlane</symbol>,
a call to
<function>XCopyPlane</function>
initiated the request.
These constants are defined in
-<!-- .hN X11/Xproto.h . -->
+<<filename class="headerfile">X11/Xproto.h</filename>>.
The minor_code member,
like the major_code member,
indicates which graphics request was initiated by
@@ -2944,19 +2944,19 @@ although it may be used by an extension. <para>
<!-- .LP -->
The
-<function>XGraphicsExposeEvent</function>
+<structname>XGraphicsExposeEvent</structname>
structure has these additional members: x, y, width, height, and count.
The x and y members are set to the coordinates relative to the drawable's origin
and indicate the upper-left corner of the rectangle.
The width and height members are set to the size (extent) of the rectangle.
The count member is set to the number of
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
events to follow.
If count is zero, no more
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
events follow for this window.
However, if count is nonzero, at least that number of
-<function>GraphicsExpose</function>
+<symbol>GraphicsExpose</symbol>
events (and possibly more) are to follow for this window.
</para>
</sect2>
@@ -2973,61 +2973,61 @@ The following sections discuss: <itemizedlist>
<listitem>
<para>
-<function>CirculateNotify</function>
+<symbol>CirculateNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>ConfigureNotify</function>
+<symbol>ConfigureNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>CreateNotify </function>
+<symbol>CreateNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>GravityNotify</function>
+<symbol>GravityNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>MapNotify</function>
+<symbol>MapNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>ReparentNotify </function>
+<symbol>ReparentNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events
<!-- .\" .SH 3 -->
</para>
@@ -3043,7 +3043,7 @@ events <indexterm><primary>Events</primary><secondary>CirculateNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>CirculateNotify</primary></indexterm>
The X server can report
-<function>CirculateNotify</function>
+<symbol>CirculateNotify</symbol>
events to clients wanting information about when a window changes
its position in the stack.
The X server generates this event type whenever a window is actually restacked
@@ -3056,12 +3056,12 @@ or <para>
<!-- .LP -->
To receive
-<function>CirculateNotify</function>
+<symbol>CirculateNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window
or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the parent window
(in which case, circulating any child generates an event).
</para>
@@ -3092,21 +3092,21 @@ typedef struct { <!-- .eM -->
The event member is set either to the restacked window or to its parent,
depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
The window member is set to the window that was restacked.
The place member is set to the window's position after the restack occurs and
is either
-<function>PlaceOnTop</function>
+<symbol>PlaceOnTop</symbol>
or
-<function>PlaceOnBottom</function>.
+<symbol>PlaceOnBottom</symbol>.
If it is
-<function>PlaceOnTop</function>,
+<symbol>PlaceOnTop</symbol>,
the window is now on top of all siblings.
If it is
-<function>PlaceOnBottom</function>,
+<symbol>PlaceOnBottom</symbol>,
the window is now below all siblings.
</para>
</sect2>
@@ -3120,7 +3120,7 @@ the window is now below all siblings. <indexterm><primary>Events</primary><secondary>ConfigureNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>ConfigureNotify</primary></indexterm>
The X server can report
-<function>ConfigureNotify</function>
+<symbol>ConfigureNotify</symbol>
events to clients wanting information about actual changes to a window's
state, such as size, position, border, and stacking order.
The X server generates this event type whenever one of the following configure
@@ -3178,11 +3178,11 @@ A window's border width is changed by calling <para>
<!-- .LP -->
To receive
-<function>ConfigureNotify</function>
+<symbol>ConfigureNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the parent window
(in which case, configuring any child generates an event).
</para>
@@ -3215,9 +3215,9 @@ typedef struct { <!-- .eM -->
The event member is set either to the reconfigured window or to its parent,
depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
The window member is set to the window whose size, position,
border, and/or stacking
@@ -3237,7 +3237,7 @@ The border_width member is set to the width of the window's border, in pixels. The above member is set to the sibling window and is used
for stacking operations.
If the X server sets this member to
-<function>None</function>,
+<symbol>None</symbol>,
the window whose state was changed is on the bottom of the stack
with respect to sibling windows.
However, if this member is set to a sibling window,
@@ -3250,7 +3250,7 @@ window. Window manager clients normally should ignore this window if the
override_redirect member
is
-<function>True</function>.
+<symbol>True</symbol>.
</para>
</sect2>
<sect2 id="CreateNotify_Events">
@@ -3263,7 +3263,7 @@ is <indexterm><primary>Events</primary><secondary>CreateNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>CreateNotify</primary></indexterm>
The X server can report
-<function>CreateNotify</function>
+<symbol>CreateNotify</symbol>
events to clients wanting information about creation of windows.
The X server generates this event whenever a client
application creates a window by calling
@@ -3274,9 +3274,9 @@ or <para>
<!-- .LP -->
To receive
-<function>CreateNotify</function>
+<symbol>CreateNotify</symbol>
events, set the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the window.
Creating any children then generates an event.
</para>
@@ -3320,7 +3320,7 @@ The override_redirect member is set to the override-redirect attribute of the window.
Window manager clients normally should ignore this window
if the override_redirect member is
-<function>True</function>.
+<symbol>True</symbol>.
</para>
</sect2>
<sect2 id="DestroyNotify_Events">
@@ -3333,7 +3333,7 @@ if the override_redirect member is <indexterm><primary>Events</primary><secondary>DestroyNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>DestroyNotify</primary></indexterm>
The X server can report
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
events to clients wanting information about which windows are destroyed.
The X server generates this event whenever a client application destroys a
window by calling
@@ -3344,9 +3344,9 @@ or <para>
<!-- .LP -->
The ordering of the
-<function>DestroyNotify </function>
+<symbol>DestroyNotify</symbol>
events is such that for any given window,
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
is generated on all inferiors of the window
before being generated on the window itself.
The X protocol does not constrain the ordering among
@@ -3355,11 +3355,11 @@ siblings and across subhierarchies. <para>
<!-- .LP -->
To receive
-<function>DestroyNotify</function>
+<symbol>DestroyNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the parent window
(in which case, destroying any child generates an event).
</para>
@@ -3389,9 +3389,9 @@ typedef struct { <!-- .eM -->
The event member is set either to the destroyed window or to its parent,
depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
The window member is set to the window that is destroyed.
</para>
@@ -3406,7 +3406,7 @@ The window member is set to the window that is destroyed. <indexterm><primary>Events</primary><secondary>GravityNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>GravityNotify</primary></indexterm>
The X server can report
-<function>GravityNotify</function>
+<symbol>GravityNotify</symbol>
events to clients wanting information about when a window is moved because of a
change in the size of its parent.
The X server generates this event whenever a client
@@ -3419,11 +3419,11 @@ or <para>
<!-- .LP -->
To receive
-<function>GravityNotify</function>
+<symbol>GravityNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the parent window
(in which case, any child that is moved because its parent has been resized
generates an event).
@@ -3455,9 +3455,9 @@ typedef struct { <!-- .eM -->
The event member is set either to the window that was moved or to its parent,
depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
The window member is set to the child window that was moved.
The x and y members are set to the coordinates relative to the
@@ -3476,7 +3476,7 @@ window. <indexterm><primary>Events</primary><secondary>MapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>MapNotify</primary></indexterm>
The X server can report
-<function>MapNotify</function>
+<symbol>MapNotify</symbol>
events to clients wanting information about which windows are mapped.
The X server generates this event type whenever a client application changes the
window's state from unmapped to mapped by calling
@@ -3489,11 +3489,11 @@ or as a result of save-set processing. <para>
<!-- .LP -->
To receive
-<function>MapNotify</function>
+<symbol>MapNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the parent window
(in which case, mapping any child generates an event).
</para>
@@ -3524,16 +3524,16 @@ typedef struct { <!-- .eM -->
The event member is set either to the window that was mapped or to its parent,
depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
The window member is set to the window that was mapped.
The override_redirect member is set to the override-redirect attribute
of the window.
Window manager clients normally should ignore this window
if the override-redirect attribute is
-<function>True</function>,
+<symbol>True</symbol>,
because these events usually are generated from pop-ups,
which override structure control.
</para>
@@ -3548,7 +3548,7 @@ which override structure control. <indexterm><primary>Events</primary><secondary>MappingNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>MappingNotify</primary></indexterm>
The X server reports
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
events to all clients.
There is no mechanism to express disinterest in this event.
The X server generates this event type whenever a client application
@@ -3603,22 +3603,22 @@ typedef struct { <!-- .eM -->
The request member is set to indicate the kind of mapping change that occurred
and can be
-<function>MappingModifier</function>,
-<function>MappingKeyboard</function>,
+<symbol>MappingModifier</symbol>,
+<symbol>MappingKeyboard</symbol>,
or
-<function>MappingPointer</function>.
+<symbol>MappingPointer</symbol>.
If it is
-<function>MappingModifier</function>,
+<symbol>MappingModifier</symbol>,
the modifier mapping was changed.
If it is
-<function>MappingKeyboard</function>,
+<symbol>MappingKeyboard</symbol>,
the keyboard mapping was changed.
If it is
-<function>MappingPointer</function>,
+<symbol>MappingPointer</symbol>,
the pointer button mapping was changed.
The first_keycode and count members are set only
if the request member was set to
-<function>MappingKeyboard</function>.
+<symbol>MappingKeyboard</symbol>.
The number in first_keycode represents the first number in the range
of the altered mapping,
and count represents the number of keycodes altered.
@@ -3640,21 +3640,21 @@ you should call <indexterm><primary>Events</primary><secondary>ReparentNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>ReparentNotify</primary></indexterm>
The X server can report
-<function>ReparentNotify</function>
+<symbol>ReparentNotify</symbol>
events to clients wanting information about changing a window's parent.
The X server generates this event whenever a client
application calls
-<function>XReparentWindow </function>
+<function>XReparentWindow</function>
and the window is actually reparented.
</para>
<para>
<!-- .LP -->
To receive
-<function>ReparentNotify</function>
+<symbol>ReparentNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of either the old or the new parent window
(in which case, reparenting any child generates an event).
</para>
@@ -3687,9 +3687,9 @@ typedef struct { <!-- .eM -->
The event member is set either to the reparented window
or to the old or the new parent, depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
The window member is set to the window that was reparented.
The parent member is set to the new parent window.
@@ -3700,7 +3700,7 @@ The override_redirect member is set to the override-redirect attribute of the window specified by the window member.
Window manager clients normally should ignore this window
if the override_redirect member is
-<function>True</function>.
+<symbol>True</symbol>.
</para>
</sect2>
<sect2 id="UnmapNotify_Events">
@@ -3713,7 +3713,7 @@ if the override_redirect member is <indexterm><primary>Events</primary><secondary>UnmapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>UnmapNotify</primary></indexterm>
The X server can report
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
events to clients wanting information about which windows are unmapped.
The X server generates this event type whenever a client application changes the
window's state from mapped to unmapped.
@@ -3721,11 +3721,11 @@ window's state from mapped to unmapped. <para>
<!-- .LP -->
To receive
-<function>UnmapNotify</function>
+<symbol>UnmapNotify</symbol>
events, set the
-<function>StructureNotifyMask</function>
+<symbol>StructureNotifyMask</symbol>
bit in the event-mask attribute of the window or the
-<function>SubstructureNotifyMask</function>
+<symbol>SubstructureNotifyMask</symbol>
bit in the event-mask attribute of the parent window
(in which case, unmapping any child window generates an event).
</para>
@@ -3756,17 +3756,17 @@ typedef struct { <!-- .eM -->
The event member is set either to the unmapped window or to its parent,
depending on whether
-<function>StructureNotify</function>
+<systemitem class="event">StructureNotify</systemitem>
or
-<function>SubstructureNotify</function>
+<systemitem class="event">SubstructureNotify</systemitem>
was selected.
This is the window used by the X server to report the event.
The window member is set to the window that was unmapped.
The from_configure member is set to
-<function>True </function>
+<symbol>True</symbol>
if the event was generated as a result of a resizing of the window's parent when
the window itself had a win_gravity of
-<function>UnmapGravity</function>.
+<symbol>UnmapGravity</symbol>.
</para>
</sect2>
<sect2 id="VisibilityNotify_Events">
@@ -3779,50 +3779,50 @@ the window itself had a win_gravity of <indexterm><primary>Events</primary><secondary>VisibilityNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>VisibilityNotify</primary></indexterm>
The X server can report
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events to clients wanting any change in the visibility of the specified window.
A region of a window is visible if someone looking at the screen can
actually see it.
The X server generates this event whenever the visibility changes state.
However, this event is never generated for windows whose class is
-<function>InputOnly</function>.
+<symbol>InputOnly</symbol>.
</para>
<para>
<!-- .LP -->
All
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events caused by a hierarchy change are generated
after any hierarchy event
-(<function>UnmapNotify</function>,
-<function>MapNotify</function>,
-<function>ConfigureNotify</function>,
-<function>GravityNotify</function>,
-<function>CirculateNotify</function>)
+(<symbol>UnmapNotify</symbol>,
+<symbol>MapNotify</symbol>,
+<symbol>ConfigureNotify</symbol>,
+<symbol>GravityNotify</symbol>,
+<symbol>CirculateNotify</symbol>)
caused by that change. Any
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
event on a given window is generated before any
-<function>Expose </function>
+<symbol>Expose</symbol>
events on that window, but it is not required that all
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events on all windows be generated before all
-<function>Expose</function>
+<symbol>Expose</symbol>
events on all windows.
The X protocol does not constrain the ordering of
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events with
respect to
-<function>FocusOut</function>,
-<function>EnterNotify</function>,
+<symbol>FocusOut</symbol>,
+<symbol>EnterNotify</symbol>,
and
-<function>LeaveNotify</function>
+<symbol>LeaveNotify</symbol>
events.
</para>
<para>
<!-- .LP -->
To receive
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events, set the
-<function>VisibilityChangeMask</function>
+<symbol>VisibilityChangeMask</symbol>
bit in the event-mask attribute of the window.
</para>
<para>
@@ -3851,13 +3851,13 @@ typedef struct { <!-- .eM -->
The window member is set to the window whose visibility state changes.
The state member is set to the state of the window's visibility and can be
-<function>VisibilityUnobscured</function>,
-<function>VisibilityPartiallyObscured</function>,
+<symbol>VisibilityUnobscured</symbol>,
+<symbol>VisibilityPartiallyObscured</symbol>,
or
-<function>VisibilityFullyObscured</function>.
+<symbol>VisibilityFullyObscured</symbol>.
The X server ignores all of a window's subwindows
when determining the visibility state of the window and processes
-<function>VisibilityNotify</function>
+<symbol>VisibilityNotify</symbol>
events according to the following:
</para>
<itemizedlist>
@@ -3866,9 +3866,9 @@ events according to the following: When the window changes state from partially obscured, fully obscured,
or not viewable to viewable and completely unobscured,
the X server generates the event with the state member of the
-<function>XVisibilityEvent</function>
+<structname>XVisibilityEvent</structname>
structure set to
-<function>VisibilityUnobscured</function>.
+<symbol>VisibilityUnobscured</symbol>.
</para>
</listitem>
<listitem>
@@ -3876,9 +3876,9 @@ structure set to When the window changes state from viewable and completely unobscured or
not viewable to viewable and partially obscured,
the X server generates the event with the state member of the
-<function>XVisibilityEvent</function>
+<structname>XVisibilityEvent</structname>
structure set to
-<function>VisibilityPartiallyObscured</function>.
+<symbol>VisibilityPartiallyObscured</symbol>.
</para>
</listitem>
<listitem>
@@ -3887,9 +3887,9 @@ When the window changes state from viewable and completely unobscured, viewable and partially obscured, or not viewable to viewable and
fully obscured,
the X server generates the event with the state member of the
-<function>XVisibilityEvent</function>
+<structname>XVisibilityEvent</structname>
structure set to
-<function>VisibilityFullyObscured</function>.
+<symbol>VisibilityFullyObscured</symbol>.
</para>
</listitem>
</itemizedlist>
@@ -3907,25 +3907,25 @@ This section discusses: <itemizedlist>
<listitem>
<para>
-<function>CirculateRequest</function>
+<symbol>CirculateRequest</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>MapRequest </function>
+<symbol>MapRequest</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>ResizeRequest </function>
+<symbol>ResizeRequest</symbol>
events
</para>
</listitem>
@@ -3940,7 +3940,7 @@ events <indexterm><primary>Events</primary><secondary>CirculateRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>CirculateRequest</primary></indexterm>
The X server can report
-<function>CirculateRequest</function>
+<symbol>CirculateRequest</symbol>
events to clients wanting information about
when another client initiates a circulate window request
on a specified window.
@@ -3955,9 +3955,9 @@ or <para>
<!-- .LP -->
To receive
-<function>CirculateRequest</function>
+<symbol>CirculateRequest</symbol>
events, set the
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
in the event-mask attribute of the window.
Then, in the future,
the circulate window request for the specified window is not executed,
@@ -3966,9 +3966,9 @@ For example, suppose a client application calls <function>XCirculateSubwindowsUp</function>
to raise a subwindow to the top of the stack.
If you had selected
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
on the window, the X server reports to you a
-<function>CirculateRequest</function>
+<symbol>CirculateRequest</symbol>
event and does not raise the subwindow to the top of the stack.
</para>
<para>
@@ -4000,14 +4000,14 @@ The parent member is set to the parent window. The window member is set to the subwindow to be restacked.
The place member is set to what the new position in the stacking order should be
and is either
-<function>PlaceOnTop</function>
+<symbol>PlaceOnTop</symbol>
or
-<function>PlaceOnBottom</function>.
+<symbol>PlaceOnBottom</symbol>.
If it is
-<function>PlaceOnTop</function>,
+<symbol>PlaceOnTop</symbol>,
the subwindow should be on top of all siblings.
If it is
-<function>PlaceOnBottom</function>,
+<symbol>PlaceOnBottom</symbol>,
the subwindow should be below all siblings.
</para>
</sect2>
@@ -4021,7 +4021,7 @@ the subwindow should be below all siblings. <indexterm><primary>Events</primary><secondary>ConfigureRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>ConfigureRequest</primary></indexterm>
The X server can report
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
events to clients wanting information about when a different client initiates
a configure window request on any child of a specified window.
The configure window request attempts to
@@ -4042,24 +4042,24 @@ or <para>
<!-- .LP -->
To receive
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
events, set the
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
bit in the event-mask attribute of the window.
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
events are generated when a
-<function>ConfigureWindow</function>
+<systemitem>ConfigureWindow</systemitem>
protocol request is issued on a child window by another client.
For example, suppose a client application calls
<function>XLowerWindow</function>
to lower a window.
If you had selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent window and if the override-redirect attribute
of the window is set to
-<function>False</function>,
+<symbol>False</symbol>,
the X server reports a
-<function>ConfigureRequest</function>
+<symbol>ConfigureRequest</symbol>
event to you and does not lower the specified window.
</para>
<para>
@@ -4096,15 +4096,15 @@ The parent member is set to the parent window. The window member is set to the window whose size, position, border width,
and/or stacking order is to be reconfigured.
The value_mask member indicates which components were specified in the
-<function>ConfigureWindow </function>
+<systemitem>ConfigureWindow</systemitem>
protocol request.
The corresponding values are reported as given in the request.
The remaining values are filled in from the current geometry of the window,
except in the case of above (sibling) and detail (stack-mode),
which are reported as
-<function>None</function>
+<symbol>None</symbol>
and
-<function>Above</function>,
+<symbol>Above</symbol>,
respectively, if they are not given in the request.
</para>
</sect2>
@@ -4118,14 +4118,14 @@ respectively, if they are not given in the request. <indexterm><primary>Events</primary><secondary>MapRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>MapRequest</primary></indexterm>
The X server can report
-<function>MapRequest</function>
+<symbol>MapRequest</symbol>
events to clients wanting information about a different client's desire
to map windows.
A window is considered mapped when a map window request completes.
The X server generates this event whenever a different client initiates
a map window request on an unmapped window whose override_redirect member
is set to
-<function>False</function>.
+<symbol>False</symbol>.
Clients initiate map window requests by calling
<function>XMapWindow</function>,
<function>XMapRaised</function>,
@@ -4135,24 +4135,24 @@ or <para>
<!-- .LP -->
To receive
-<function>MapRequest</function>
+<symbol>MapRequest</symbol>
events, set the
-<function>SubstructureRedirectMask</function>
+<symbol>SubstructureRedirectMask</symbol>
bit in the event-mask attribute of the window.
This means another client's attempts to map a child window by calling one of
the map window request functions is intercepted, and you are sent a
-<function>MapRequest</function>
+<symbol>MapRequest</symbol>
instead.
For example, suppose a client application calls
<function>XMapWindow</function>
to map a window.
If you (usually a window manager) had selected
-<function>SubstructureRedirectMask </function>
+<symbol>SubstructureRedirectMask</symbol>
on the parent window and if the override-redirect attribute
of the window is set to
-<function>False</function>,
+<symbol>False</symbol>,
the X server reports a
-<function>MapRequest</function>
+<symbol>MapRequest</symbol>
event to you
and does not map the specified window.
Thus, this event gives your window manager client the ability
@@ -4196,7 +4196,7 @@ The window member is set to the window to be mapped. <indexterm><primary>Events</primary><secondary>ResizeRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>ResizeRequest</primary></indexterm>
The X server can report
-<function>ResizeRequest</function>
+<symbol>ResizeRequest</symbol>
events to clients wanting information about another client's attempts to change the
size of a window.
The X server generates this event whenever some other client attempts to change
@@ -4209,9 +4209,9 @@ or <para>
<!-- .LP -->
To receive
-<function>ResizeRequest</function>
+<symbol>ResizeRequest</symbol>
events, set the
-<function>ResizeRedirect</function>
+<symbol>ResizeRedirect</symbol>
bit in the event-mask attribute of the window.
Any attempts to change the size by other clients are then redirected.
</para>
@@ -4256,7 +4256,7 @@ excluding the border. <indexterm><primary>Events</primary><secondary>ColormapNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>ColormapNotify</primary></indexterm>
The X server can report
-<function>ColormapNotify</function>
+<symbol>ColormapNotify</symbol>
events to clients wanting information about when the colormap changes
and when a colormap is installed or uninstalled.
The X server generates this event type whenever a client application:
@@ -4265,13 +4265,13 @@ The X server generates this event type whenever a client application: <listitem>
<para>
Changes the colormap member of the
-<function>XSetWindowAttributes</function>
+<structname>XSetWindowAttributes</structname>
structure by
calling
<function>XChangeWindowAttributes</function>,
<function>XFreeColormap</function>,
or
-<function>XSetWindowColormap </function>
+<function>XSetWindowColormap</function>
</para>
</listitem>
<listitem>
@@ -4279,16 +4279,16 @@ or Installs or uninstalls the colormap by calling
<function>XInstallColormap</function>
or
-<function>XUninstallColormap </function>
+<function>XUninstallColormap</function>
</para>
</listitem>
</itemizedlist>
<para>
<!-- .LP -->
To receive
-<function>ColormapNotify </function>
+<symbol>ColormapNotify</symbol>
events, set the
-<function>ColormapChangeMask</function>
+<symbol>ColormapChangeMask</symbol>
bit in the event-mask attribute of the window.
</para>
<para>
@@ -4324,24 +4324,24 @@ the colormap member is set to the colormap associated with the window. For a colormap that is changed by a call to
<function>XFreeColormap</function>,
the colormap member is set to
-<function>None</function>.
+<symbol>None</symbol>.
The new member is set to indicate whether the colormap
for the specified window was changed or installed or uninstalled
and can be
-<function>True</function>
+<symbol>True</symbol>
or
-<function>False</function>.
+<symbol>False</symbol>.
If it is
-<function>True</function>,
+<symbol>True</symbol>,
the colormap was changed.
If it is
-<function>False</function>,
+<symbol>False</symbol>,
the colormap was installed or uninstalled.
The state member is always set to indicate whether the colormap is installed or
uninstalled and can be
-<function>ColormapInstalled</function>
+<symbol>ColormapInstalled</symbol>
or
-<function>ColormapUninstalled</function>.
+<symbol>ColormapUninstalled</symbol>.
</para>
</sect1>
<sect1 id="Client_Communication_Events">
@@ -4356,31 +4356,31 @@ This section discusses: <itemizedlist>
<listitem>
<para>
-<function>ClientMessage </function>
+<symbol>ClientMessage</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>SelectionClear</function>
+<symbol>SelectionClear</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>SelectionNotify</function>
+<symbol>SelectionNotify</symbol>
events
</para>
</listitem>
<listitem>
<para>
-<function>SelectionRequest</function>
+<symbol>SelectionRequest</symbol>
events
</para>
</listitem>
@@ -4395,7 +4395,7 @@ events <indexterm><primary>Events</primary><secondary>ClientMessage</secondary></indexterm>
<indexterm significance="preferred"><primary>ClientMessage</primary></indexterm>
The X server generates
-<function>ClientMessage</function>
+<symbol>ClientMessage</symbol>
events only when a client calls the function
<function>XSendEvent</function>.
</para>
@@ -4451,16 +4451,16 @@ message_type, or data members. <indexterm><primary>Events</primary><secondary>PropertyNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>PropertyNotify</primary></indexterm>
The X server can report
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
events to clients wanting information about property changes
for a specified window.
</para>
<para>
<!-- .LP -->
To receive
-<function>PropertyNotify</function>
+<symbol>PropertyNotify</symbol>
events, set the
-<function>PropertyChangeMask</function>
+<symbol>PropertyChangeMask</symbol>
bit in the event-mask attribute of the window.
</para>
<para>
@@ -4496,11 +4496,11 @@ property was changed or desired. The time member is set to the server time when the property was changed.
The state member is set to indicate whether the property was changed
to a new value or deleted and can be
-<function>PropertyNewValue</function>
+<symbol>PropertyNewValue</symbol>
or
-<function>PropertyDelete</function>.
+<symbol>PropertyDelete</symbol>.
The state member is set to
-<function>PropertyNewValue</function>
+<symbol>PropertyNewValue</symbol>
when a property of the window is changed using
<function>XChangeProperty</function>
or
@@ -4512,11 +4512,11 @@ and when replacing all or part of a property with identical data using or
<function>XRotateWindowProperties</function>.
The state member is set to
-<function>PropertyDelete</function>
+<symbol>PropertyDelete</symbol>
when a property of the window is deleted using
<function>XDeleteProperty</function>
or, if the delete argument is
-<function>True</function>,
+<symbol>True</symbol>,
<function>XGetWindowProperty</function>.
</para>
</sect2>
@@ -4530,7 +4530,7 @@ or, if the delete argument is <indexterm ><primary>Events</primary><secondary>SelectionClear</secondary></indexterm>
<indexterm significance="preferred"><primary>SelectionClear</primary></indexterm>
The X server reports
-<function>SelectionClear</function>
+<symbol>SelectionClear</symbol>
events to the client losing ownership of a selection.
The X server generates this event type when another client
asserts ownership of the selection by calling
@@ -4580,11 +4580,11 @@ call. <indexterm><primary>Events</primary><secondary>SelectionRequest</secondary></indexterm>
<indexterm significance="preferred"><primary>SelectionRequest</primary></indexterm>
The X server reports
-<function>SelectionRequest</function>
+<symbol>SelectionRequest</symbol>
events to the owner of a selection.
The X server generates this event whenever a client
requests a selection conversion by calling
-<function>XConvertSelection </function>
+<function>XConvertSelection</function>
for the owned selection.
</para>
<para>
@@ -4625,18 +4625,18 @@ For example, PRIMARY is used to indicate the primary selection. The target member is set to the atom that indicates the type
the selection is desired in.
The property member can be a property name or
-<function>None</function>.
+<symbol>None</symbol>.
The time member is set to the timestamp or
-<function>CurrentTime </function>
+<symbol>CurrentTime</symbol>
value from the
-<function>ConvertSelection</function>
+<systemitem>ConvertSelection</systemitem>
request.
</para>
<para>
<!-- .LP -->
The owner should convert the selection based on the specified target type
and send a
-<function>SelectionNotify</function>
+<symbol>SelectionNotify</symbol>
event back to the requestor.
A complete specification for using selections is given in the X Consortium
standard <emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>.
@@ -4652,7 +4652,7 @@ standard <emphasis remap='I'>Inter-Client Communication Conventions Manual</emph <indexterm><primary>Events</primary><secondary>SelectionNotify</secondary></indexterm>
<indexterm significance="preferred"><primary>SelectionNotify</primary></indexterm>
This event is generated by the X server in response to a
-<function>ConvertSelection </function>
+<systemitem>ConvertSelection</systemitem>
protocol request when there is no owner for the selection.
When there is an owner, it should be generated by the owner
of the selection by using
@@ -4661,18 +4661,18 @@ The owner of a selection should send this event to a requestor when a selection has been converted and stored as a property
or when a selection conversion could
not be performed (which is indicated by setting the property member to
-<function>None</function>).
+<symbol>None</symbol>).
</para>
<para>
<!-- .LP -->
If
-<function>None</function>
+<symbol>None</symbol>
is specified as the property in the
-<function>ConvertSelection</function>
+<systemitem>ConvertSelection</systemitem>
protocol request, the owner should choose a property name,
store the result as that property on the requestor window,
and then send a
-<function>SelectionNotify</function>
+<symbol>SelectionNotify</symbol>
giving that actual property name.
</para>
<para>
@@ -4712,10 +4712,10 @@ The property member is set to the atom that indicates which property the result was stored on.
If the conversion failed,
the property member is set to
-<function>None</function>.
+<symbol>None</symbol>.
The time member is set to the time the conversion took place and
can be a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH11.xml b/libX11/specs/libX11/CH11.xml index 1a9bfc139..2cfae3aad 100644 --- a/libX11/specs/libX11/CH11.xml +++ b/libX11/specs/libX11/CH11.xml @@ -33,7 +33,7 @@ event. There are two ways to select the events you want reported to your client
application.
One way is to set the event_mask member of the
-<function>XSetWindowAttributes</function>
+<structname>XSetWindowAttributes</structname>
structure when you call
<function>XCreateWindow</function>
and
@@ -44,7 +44,7 @@ Another way is to use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSelectInput</function></funcdef>
+ <funcdef><function>XSelectInput</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>long<parameter> event_mask</parameter></paramdef>
@@ -118,32 +118,32 @@ to all interested clients. <listitem>
<para>
Only one client at a time can select
-<function>CirculateRequest</function>,
-<function>ConfigureRequest</function>,
+<symbol>CirculateRequest</symbol>,
+<symbol>ConfigureRequest</symbol>,
or
-<function>MapRequest</function>
+<symbol>MapRequest</symbol>
events, which are associated with
the event mask
-<function>SubstructureRedirectMask</function>.
+<symbol>SubstructureRedirectMask</symbol>.
</para>
</listitem>
<listitem>
<para>
Only one client at a time can select
a
-<function>ResizeRequest</function>
+<symbol>ResizeRequest</symbol>
event, which is associated with
the event mask
-<function>ResizeRedirectMask</function>.
+<symbol>ResizeRedirectMask</symbol>.
</para>
</listitem>
<listitem>
<para>
Only one client at a time can select a
-<function>ButtonPress </function>
+<symbol>ButtonPress</symbol>
event, which is associated with
the event mask
-<function>ButtonPressMask</function>.
+<symbol>ButtonPressMask</symbol>.
</para>
</listitem>
</itemizedlist>
@@ -155,7 +155,7 @@ The server reports the event to all interested clients. <!-- .LP -->
<function>XSelectInput</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -182,7 +182,7 @@ To flush the output buffer, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFlush</function></funcdef>
+ <funcdef><function>XFlush</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -228,7 +228,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSync</function></funcdef>
+ <funcdef><function>XSync</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Bool<parameter> discard</parameter></paramdef>
</funcprototype>
@@ -277,12 +277,12 @@ event queue. <para>
<!-- .LP -->
Finally, if you passed
-<function>False</function>,
+<symbol>False</symbol>,
<function>XSync</function>
does not discard the events in the queue.
If you passed
-<function>True</function>,
-<function>XSync </function>
+<symbol>True</symbol>,
+<function>XSync</function>
discards all events in the queue,
including those events that were on the queue before
<function>XSync</function>
@@ -311,7 +311,7 @@ To check the number of events in the event queue, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XEventsQueued</function></funcdef>
+ <funcdef>int <function>XEventsQueued</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> mode</parameter></paramdef>
</funcprototype>
@@ -336,10 +336,10 @@ Specifies the connection to the X server. <para>
Specifies the mode.
You can pass
-<function>QueuedAlready</function>,
-<function>QueuedAfterFlush</function>,
+<symbol>QueuedAlready</symbol>,
+<symbol>QueuedAfterFlush</symbol>,
or
-<function>QueuedAfterReading</function>.
+<symbol>QueuedAfterReading</symbol>.
</para>
</listitem>
</varlistentry>
@@ -349,12 +349,12 @@ or <!-- .LP -->
<!-- .eM -->
If mode is
-<function>QueuedAlready</function>,
-<function>XEventsQueued </function>
+<symbol>QueuedAlready</symbol>,
+<function>XEventsQueued</function>
returns the number of events
already in the event queue (and never performs a system call).
If mode is
-<function>QueuedAfterFlush</function>,
+<symbol>QueuedAfterFlush</symbol>,
<function>XEventsQueued</function>
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
@@ -363,7 +363,7 @@ flushes the output buffer, attempts to read more events out of the application's connection,
and returns the number read.
If mode is
-<function>QueuedAfterReading</function>,
+<symbol>QueuedAfterReading</symbol>,
<function>XEventsQueued</function>
returns the number of events already in the queue if the number is nonzero.
If there are no events in the queue,
@@ -378,12 +378,12 @@ always returns immediately without I/O if there are events already in the queue.
<function>XEventsQueued</function>
with mode
-<function>QueuedAfterFlush</function>
+<symbol>QueuedAfterFlush</symbol>
is identical in behavior to
<function>XPending</function>.
<function>XEventsQueued</function>
with mode
-<function>QueuedAlready</function>
+<symbol>QueuedAlready</symbol>
is identical to the
<function>XQLength</function>
function.
@@ -397,7 +397,7 @@ To return the number of events that are pending, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XPending</function></funcdef>
+ <funcdef>int <function>XPending</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -426,7 +426,7 @@ X server but have not been removed from the event queue. is identical to
<function>XEventsQueued</function>
with the mode
-<function>QueuedAfterFlush</function>
+<symbol>QueuedAfterFlush</symbol>
specified.
</para>
</sect1>
@@ -471,7 +471,7 @@ To get the next event and remove it from the queue, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XNextEvent</function></funcdef>
+ <funcdef><function>XNextEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
</funcprototype>
@@ -506,7 +506,7 @@ Returns the next event in the queue. The
<function>XNextEvent</function>
function copies the first event from the event queue into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure and then removes it from the queue.
If the event queue is empty,
<function>XNextEvent</function>
@@ -521,7 +521,7 @@ To peek at the event queue, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XPeekEvent</function></funcdef>
+ <funcdef><function>XPeekEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
</funcprototype>
@@ -561,7 +561,7 @@ If the queue is empty, <function>XPeekEvent</function>
flushes the output buffer and blocks until an event is received.
It then copies the event into the client-supplied
-<function>XEvent</function>
+<structname>XEvent</structname>
structure without removing it from the event queue.
</para>
</sect2>
@@ -591,7 +591,7 @@ The predicate procedure and its associated arguments are: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> Bool</function></funcdef>
+ <funcdef><type>Bool</type></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event</parameter></paramdef>
<paramdef>XPointer<parameter> arg</parameter></paramdef>
@@ -616,7 +616,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the
-<function>XEvent</function>
+<structname>XEvent</structname>
structure.
</para>
</listitem>
@@ -631,7 +631,7 @@ Specifies the argument passed in from the <function>XIfEvent</function>,
<function>XCheckIfEvent</function>,
or
-<function>XPeekIfEvent </function>
+<function>XPeekIfEvent</function>
function.
</para>
</listitem>
@@ -644,9 +644,9 @@ function. The predicate procedure is called once for each
event in the queue until it finds a match.
After finding a match, the predicate procedure must return
-<function>True</function>.
+<symbol>True</symbol>.
If it did not find a match, it must return
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -658,7 +658,7 @@ and, if found, remove the event from the queue, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XIfEvent</function></funcdef>
+ <funcdef><function>XIfEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
<paramdef>Bool<parameter> (*predicate)()</parameter></paramdef>
@@ -717,7 +717,7 @@ The <function>XIfEvent</function>
function completes only when the specified predicate
procedure returns
-<function>True </function>
+<symbol>True</symbol>
for an event,
which indicates an event in the queue matches.
<function>XIfEvent</function>
@@ -725,7 +725,7 @@ flushes the output buffer if it blocks waiting for additional events. <function>XIfEvent</function>
removes the matching event from the queue
and copies the structure into the client-supplied
-<function>XEvent</function>
+<structname>XEvent</structname>
structure.
</para>
<para>
@@ -737,7 +737,7 @@ To check the event queue for a matching event without blocking, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XCheckIfEvent</function></funcdef>
+ <funcdef>Bool <function>XCheckIfEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
<paramdef>Bool<parameter> (*predicate)()</parameter></paramdef>
@@ -795,14 +795,14 @@ Specifies the user-supplied argument that will be passed to the predicate proced When the predicate procedure finds a match,
<function>XCheckIfEvent</function>
copies the matched event into the client-supplied
-<function>XEvent</function>
+<structname>XEvent</structname>
structure and returns
-<function>True</function>.
+<symbol>True</symbol>.
(This event is removed from the queue.)
If the predicate procedure finds no match,
<function>XCheckIfEvent</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
and the output buffer will have been flushed.
All earlier events stored in the queue are not discarded.
</para>
@@ -816,7 +816,7 @@ without removing the event from the queue, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XPeekIfEvent</function></funcdef>
+ <funcdef><function>XPeekIfEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
<paramdef>Bool<parameter> (*predicate)()</parameter></paramdef>
@@ -875,12 +875,12 @@ The <function>XPeekIfEvent</function>
function returns only when the specified predicate
procedure returns
-<function>True</function>
+<symbol>True</symbol>
for an event.
After the predicate procedure finds a match,
<function>XPeekIfEvent</function>
copies the matched event into the client-supplied
-<function>XEvent</function>
+<structname>XEvent</structname>
structure without removing the event from the queue.
<function>XPeekIfEvent</function>
flushes the output buffer if it blocks waiting for additional events.
@@ -905,7 +905,7 @@ To remove the next event that matches both a window and an event mask, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XWindowEvent</function></funcdef>
+ <funcdef><function>XWindowEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>long<parameter> event_mask</parameter></paramdef>
@@ -967,7 +967,7 @@ window and event mask. When it finds a match,
<function>XWindowEvent</function>
removes that event from the queue and copies it into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure.
The other events stored in the queue are not discarded.
If a matching event is not in the queue,
@@ -982,15 +982,15 @@ use <function>XCheckWindowEvent</function>.
<indexterm><primary>XCheckWindowEvent</primary></indexterm>
This function is similar to
-<function>XWindowEvent </function>
+<function>XWindowEvent</function>
except that it never blocks and it returns a
-<function>Bool </function>
+<type>Bool</type>
indicating if the event was returned.
<indexterm significance="preferred"><primary>XCheckWindowEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XCheckWindowEvent</function></funcdef>
+ <funcdef>Bool <function>XCheckWindowEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>long<parameter> event_mask</parameter></paramdef>
@@ -1053,14 +1053,14 @@ and event mask. If it finds a match,
<function>XCheckWindowEvent</function>
removes that event, copies it into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure, and returns
-<function>True</function>.
+<symbol>True</symbol>.
The other events stored in the queue are not discarded.
If the event you requested is not available,
<function>XCheckWindowEvent</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
and the output buffer will have been flushed.
</para>
<para>
@@ -1072,7 +1072,7 @@ To remove the next event that matches an event mask, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XMaskEvent</function></funcdef>
+ <funcdef><function>XMaskEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>long<parameter> event_mask</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
@@ -1122,7 +1122,7 @@ specified mask. When it finds a match,
<function>XMaskEvent</function>
removes that event and copies it into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure.
The other events stored in the queue are not discarded.
If the event you requested is not in the queue,
@@ -1135,15 +1135,15 @@ flushes the output buffer and blocks until one is received. To return and remove the next event that matches an event mask (if any), use
<function>XCheckMaskEvent</function>.
This function is similar to
-<function>XMaskEvent </function>
+<function>XMaskEvent</function>
except that it never blocks and it returns a
-<function>Bool </function>
+<type>Bool</type>
indicating if the event was returned.
<indexterm significance="preferred"><primary>XCheckMaskEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XCheckMaskEvent</function></funcdef>
+ <funcdef>Bool <function>XCheckMaskEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>long<parameter> event_mask</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
@@ -1193,14 +1193,14 @@ server connection for the first event that matches the specified mask. If it finds a match,
<function>XCheckMaskEvent</function>
removes that event, copies it into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure, and returns
-<function>True</function>.
+<symbol>True</symbol>.
The other events stored in the queue are not discarded.
If the event you requested is not available,
<function>XCheckMaskEvent</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
and the output buffer will have been flushed.
</para>
<para>
@@ -1212,7 +1212,7 @@ To return and remove the next event in the queue that matches an event type, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XCheckTypedEvent</function></funcdef>
+ <funcdef>Bool <function>XCheckTypedEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> event_type</parameter></paramdef>
<paramdef>XEvent<parameter> *event_return</parameter></paramdef>
@@ -1263,14 +1263,14 @@ on the server connection for the first event that matches the specified type. If it finds a match,
<function>XCheckTypedEvent</function>
removes that event, copies it into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure, and returns
-<function>True</function>.
+<symbol>True</symbol>.
The other events in the queue are not discarded.
If the event is not available,
<function>XCheckTypedEvent</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
and the output buffer will have been flushed.
</para>
<para>
@@ -1283,7 +1283,7 @@ and a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XCheckTypedWindowEvent</function></funcdef>
+ <funcdef>Bool <function>XCheckTypedWindowEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> event_type</parameter></paramdef>
@@ -1346,14 +1346,14 @@ type and window. If it finds a match,
<function>XCheckTypedWindowEvent</function>
removes the event from the queue, copies it into the specified
-<function>XEvent</function>
+<structname>XEvent</structname>
structure, and returns
-<function>True</function>.
+<symbol>True</symbol>.
The other events in the queue are not discarded.
If the event is not available,
<function>XCheckTypedWindowEvent</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
and the output buffer will have been flushed.
</para>
</sect2>
@@ -1371,7 +1371,7 @@ To push an event back into the event queue, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XPutBackEvent</function></funcdef>
+ <funcdef><function>XPutBackEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XEvent<parameter> *event</parameter></paramdef>
</funcprototype>
@@ -1427,14 +1427,14 @@ This function is often used in selection processing. For example, the owner of a selection should use
<function>XSendEvent</function>
to send a
-<function>SelectionNotify</function>
+<symbol>SelectionNotify</symbol>
event to a requestor when a selection has been converted
and stored as a property.
<indexterm significance="preferred"><primary>XSendEvent</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XSendEvent</function></funcdef>
+ <funcdef>Status <function>XSendEvent</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Bool<parameter> propagate</parameter></paramdef>
@@ -1461,9 +1461,9 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the window the event is to be sent to, or
-<function>PointerWindow</function>,
+<symbol>PointerWindow</symbol>,
or
-<function>InputFocus</function>.
+<symbol>InputFocus</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1516,14 +1516,14 @@ This function uses the w argument to identify the destination window as follows: <listitem>
<para>
If w is
-<function>PointerWindow</function>,
+<symbol>PointerWindow</symbol>,
the destination window is the window that contains the pointer.
</para>
</listitem>
<listitem>
<para>
If w is
-<function>InputFocus </function>
+<symbol>InputFocus</symbol>
and if the focus window contains the pointer,
the destination window is the window that contains the pointer;
otherwise, the destination window is the focus window.
@@ -1548,7 +1548,7 @@ no event is sent. <listitem>
<para>
If propagate is
-<function>False</function>,
+<symbol>False</symbol>,
the event is sent to every client selecting on destination any of the event
types in the event_mask argument.
</para>
@@ -1556,7 +1556,7 @@ types in the event_mask argument. <listitem>
<para>
If propagate is
-<function>True </function>
+<symbol>True</symbol>
and no clients have selected on destination any of
the event types in event-mask, the destination is replaced with the
closest ancestor of destination for which some client has selected a
@@ -1564,7 +1564,7 @@ type in event-mask and for which no intervening window has that type in its do-not-propagate-mask.
If no such window exists or if the window is
an ancestor of the focus window and
-<function>InputFocus </function>
+<symbol>InputFocus</symbol>
was originally specified
as the destination, the event is not sent to any clients.
Otherwise, the event is reported to every client selecting on the final
@@ -1575,15 +1575,15 @@ destination any of the types specified in event_mask. <para>
<!-- .LP -->
The event in the
-<function>XEvent</function>
+<structname>XEvent</structname>
structure must be one of the core events or one of the events
defined by an extension (or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results) so that the X server can correctly byte-swap
the contents as necessary.
The contents of the event are
otherwise unaltered and unchecked by the X server except to force send_event to
-<function>True</function>
+<symbol>True</symbol>
in the forwarded event and to set the serial number in the event correctly;
therefore these fields
and the display field are ignored by
@@ -1599,9 +1599,9 @@ and returns nonzero otherwise. <!-- .LP -->
<function>XSendEvent</function>
can generate
-<function>BadValue</function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -1632,7 +1632,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned<function> long</function></funcdef>
+ <funcdef>unsigned <type>long</type></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1655,7 +1655,7 @@ Specifies the connection to the X server. <!-- .eM -->
The server may retain the recent history of the pointer motion
and do so to a finer granularity than is reported by
-<function>MotionNotify</function>
+<symbol>MotionNotify</symbol>
events.
The
<function>XGetMotionEvents</function>
@@ -1670,7 +1670,7 @@ To get the motion history for a specified window and time, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XTimeCoord<function> *XGetMotionEvents</function></funcdef>
+ <funcdef>XTimeCoord *<function>XGetMotionEvents</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Timestart,<parameter> stop</parameter></paramdef>
@@ -1719,7 +1719,7 @@ Specifies the window. Specify the time interval in which the events are returned from the motion
history buffer.
You can pass a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1751,7 +1751,7 @@ no events are returned; <function>XGetMotionEvents</function>
returns NULL.
If the stop time is in the future, it is equivalent to specifying
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
The return type for this function is a structure defined as follows:
</para>
<para>
@@ -1781,7 +1781,7 @@ To free the data returned from this call, use <!-- .LP -->
<function>XGetMotionEvents</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -1811,7 +1811,7 @@ synchronization is enabled. <indexterm><primary>_Xdebug</primary></indexterm>
On <acronym>POSIX</acronym>-conformant systems,
there is also a global variable
-<function>_Xdebug </function>
+<varname>_Xdebug</varname>
that, if set to nonzero before starting a program under a debugger, will force
synchronous library behavior.
</para>
@@ -1826,7 +1826,7 @@ sets which function is to be called. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> int</function></funcdef>
+ <funcdef><type>int</type></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> (*procedure)()</parameter></paramdef>
</funcprototype>
@@ -1871,7 +1871,7 @@ To enable or disable synchronization, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> int</function></funcdef>
+ <funcdef><type>int</type></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Bool<parameter> onoff</parameter></paramdef>
</funcprototype>
@@ -1909,12 +1909,12 @@ The function returns
the previous after function.
If onoff is
-<function>True</function>,
+<symbol>True</symbol>,
<function>XSynchronize</function>
turns on synchronous behavior.
If onoff is
-<function>False</function>,
-<function>XSynchronize </function>
+<symbol>False</symbol>,
+<function>XSynchronize</function>
turns off synchronous behavior.
</para>
</sect2>
@@ -1947,7 +1947,7 @@ To set the error handler, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> *XSetErrorHandler</function></funcdef>
+ <funcdef>int *<function>XSetErrorHandler</function></funcdef>
<paramdef>int <parameter> *handler</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1971,16 +1971,16 @@ Specifies the program's supplied error handler. Xlib generally calls the program's
supplied error handler whenever an error is received.
It is not called on
-<function>BadName</function>
+<errorname>BadName</errorname>
errors from
-<function>OpenFont</function>,
-<function>LookupColor</function>,
+<systemitem>OpenFont</systemitem>,
+<systemitem>LookupColor</systemitem>,
or
-<function>AllocNamedColor</function>
+<systemitem>AllocNamedColor</systemitem>
protocol requests or on
-<function>BadFont</function>
+<errorname>BadFont</errorname>
errors from a
-<function>QueryFont</function>
+<systemitem>QueryFont</systemitem>
protocol request.
These errors generally are reflected back to the program through the
procedural interface.
@@ -1995,7 +1995,7 @@ The previous error handler is returned. <para>
<!-- .LP -->
The
-<function>XErrorEvent</function>
+<structname>XErrorEvent</structname>
structure contains:
<indexterm><primary>Debugging</primary><secondary>error event</secondary></indexterm>
</para>
@@ -2022,7 +2022,7 @@ typedef struct { The serial member is the number of requests, starting from one,
sent over the network connection since it was opened.
It is the number that was the value of
-<function>NextRequest </function>
+<function>NextRequest</function>
immediately before the failing call was made.
The request_code member is a protocol request
of the procedure that failed, as defined in
@@ -2057,7 +2057,7 @@ chapter: </thead>
<tbody>
<row>
- <entry><function>BadAccess</function></entry>
+ <entry><errorname>BadAccess</errorname></entry>
<entry>A client attempts to grab a key/button combination already grabbed
by another client.</entry>
</row>
@@ -2081,57 +2081,57 @@ chapter: has already selected.</entry>
</row>
<row>
- <entry><function>BadAlloc</function></entry>
+ <entry><errorname>BadAlloc</errorname></entry>
<entry>The server fails to allocate the requested resource.
Note that the explicit listing of
- <function>BadAlloc</function>
+ <errorname>BadAlloc</errorname>
errors in requests only covers allocation errors at a very coarse level
and is not intended to (nor can it in practice hope to) cover all cases of
a server running out of allocation space in the middle of service.
The semantics when a server runs out of allocation space are left unspecified,
but a server may generate a
- <function>BadAlloc</function>
+ <errorname>BadAlloc</errorname>
error on any request for this reason,
and clients should be prepared to receive such errors and handle or discard
them.</entry>
</row>
<row>
- <entry><function>BadAtom</function></entry>
+ <entry><errorname>BadAtom</errorname></entry>
<entry>A value for an atom argument does not name a defined atom.</entry>
</row>
<row>
- <entry><function>BadColor</function></entry>
+ <entry><errorname>BadColor</errorname></entry>
<entry>A value for a colormap argument does not name a defined colormap.</entry>
</row>
<row>
- <entry><function>BadCursor</function></entry>
+ <entry><errorname>BadCursor</errorname></entry>
<entry>A value for a cursor argument does not name a defined cursor.</entry>
</row>
<row>
- <entry><function>BadDrawable</function></entry>
+ <entry><errorname>BadDrawable</errorname></entry>
<entry>A value for a drawable argument does not name a defined window or pixmap.</entry>
</row>
<row>
- <entry><function>BadFont</function></entry>
+ <entry><errorname>BadFont</errorname></entry>
<entry>A value for a font argument does not name a defined font (or, in some cases,
- <function>GContext</function>).</entry>
+ <type>GContext</type>).</entry>
</row>
<row>
- <entry><function>BadGC</function></entry>
+ <entry><errorname>BadGC</errorname></entry>
<entry>A value for a
- <function>GContext </function>
+ <type>GContext</type>
argument does not name a defined
- <function>GContext</function>.</entry>
+ <type>GContext</type>.</entry>
</row>
<row>
- <entry><function>BadIDChoice</function></entry>
+ <entry><errorname>BadIDChoice</errorname></entry>
<entry>The value chosen for a resource identifier either is not included in the
range assigned to the client or is already in use.
Under normal circumstances,
this cannot occur and should be considered a server or Xlib error.</entry>
</row>
<row>
- <entry><function>BadImplementation</function></entry>
+ <entry><errorname>BadImplementation</errorname></entry>
<entry>The server does not implement some aspect of the request.
A server that generates this error for a core request is deficient.
As such, this error is not listed for any of the requests,
@@ -2139,7 +2139,7 @@ chapter: and handle or discard them.</entry>
</row>
<row>
- <entry><function>BadLength</function></entry>
+ <entry><errorname>BadLength</errorname></entry>
<entry>The length of a request is shorter or longer than that required to
contain the arguments.
This is an internal Xlib or server error.</entry>
@@ -2150,13 +2150,13 @@ chapter: The length of a request exceeds the maximum length accepted by the server.</entry>
</row>
<row>
- <entry><function>BadMatch</function></entry>
+ <entry><errorname>BadMatch</errorname></entry>
<entry>In a graphics request,
the root and depth of the graphics context do not match those of the drawable.</entry>
</row>
<row>
<entry></entry>
- <entry>An <function>InputOnly </function> window is used as a drawable.</entry>
+ <entry>An <symbol>InputOnly</symbol> window is used as a drawable.</entry>
</row>
<row>
<entry></entry>
@@ -2166,24 +2166,24 @@ chapter: </row>
<row>
<entry></entry>
- <entry>An <function>InputOnly </function>
+ <entry>An <symbol>InputOnly</symbol>
window lacks this attribute.</entry>
</row>
<row>
- <entry><function>BadName</function></entry>
+ <entry><errorname>BadName</errorname></entry>
<entry>A font or color of the specified name does not exist.</entry>
</row>
<row>
- <entry><function>BadPixmap</function></entry>
+ <entry><errorname>BadPixmap</errorname></entry>
<entry>A value for a pixmap argument does not name a defined pixmap.</entry>
</row>
<row>
- <entry><function>BadRequest</function></entry>
+ <entry><errorname>BadRequest</errorname></entry>
<entry>The major or minor opcode does not specify a valid request.
This usually is an Xlib or server error.</entry>
</row>
<row>
- <entry><function>BadValue</function></entry>
+ <entry><errorname>BadValue</errorname></entry>
<entry>Some numeric value falls outside of the range of values accepted
by the request.
Unless a specific range is specified for an argument,
@@ -2192,7 +2192,7 @@ chapter: this error (due to the encoding).</entry>
</row>
<row>
- <entry><function>BadWindow</function></entry>
+ <entry><errorname>BadWindow</errorname></entry>
<entry>A value for a window argument does not name a defined window.</entry>
</row>
</tbody>
@@ -2212,15 +2212,15 @@ chapter: <note>
<para>
The
-<function>BadAtom</function>,
-<function>BadColor</function>,
-<function>BadCursor</function>,
-<function>BadDrawable</function>,
-<function>BadFont</function>,
-<function>BadGC</function>,
-<function>BadPixmap</function>,
+<errorname>BadAtom</errorname>,
+<errorname>BadColor</errorname>,
+<errorname>BadCursor</errorname>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadFont</errorname>,
+<errorname>BadGC</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors are also used when the argument type is extended by a set of
fixed alternatives.
</para>
@@ -2237,7 +2237,7 @@ To obtain textual descriptions of the specified error code, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGetErrorText</function></funcdef>
+ <funcdef><function>XGetErrorText</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> code</parameter></paramdef>
<paramdef>char<parameter> *buffer_return</parameter></paramdef>
@@ -2309,7 +2309,7 @@ To obtain error messages from the error database, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGetErrorDatabaseText</function></funcdef>
+ <funcdef><function>XGetErrorDatabaseText</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char*name,<parameter> *message</parameter></paramdef>
<paramdef>char<parameter> *default_string</parameter></paramdef>
@@ -2454,7 +2454,7 @@ To report an error to the user when the requested display does not exist, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XDisplayName</function></funcdef>
+ <funcdef>char *<function>XDisplayName</function></funcdef>
<paramdef>char<parameter> *string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2497,7 +2497,7 @@ To handle fatal I/O errors, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> int</function></funcdef>
+ <funcdef><type>int</type></funcdef>
<paramdef>int(*handler)(Display<parameter> *)</parameter></paramdef>
</funcprototype>
</funcsynopsis>
diff --git a/libX11/specs/libX11/CH12.xml b/libX11/specs/libX11/CH12.xml index 210a2be9f..dabf2b04b 100644 --- a/libX11/specs/libX11/CH12.xml +++ b/libX11/specs/libX11/CH12.xml @@ -87,7 +87,7 @@ The X server includes a timestamp in various events. One special time, called
<indexterm significance="preferred"><primary>CurrentTime</primary></indexterm>
<indexterm significance="preferred"><primary>Time</primary></indexterm>
-<function>CurrentTime</function>,
+<symbol>CurrentTime</symbol>,
represents the current server time.
The X server maintains the time when the input focus was last changed,
when the keyboard was last grabbed,
@@ -111,7 +111,7 @@ The server, given its current time is represented by timestamp T, always interprets timestamps from clients by treating half of the timestamp
space as being later in time than T.
One timestamp value, named
-<function>CurrentTime</function>,
+<symbol>CurrentTime</symbol>,
is never generated by the server.
This value is reserved for use in requests to represent the current server time.
</para>
@@ -120,32 +120,32 @@ This value is reserved for use in requests to represent the current server time. For many functions in this section,
you pass pointer event mask bits.
The valid pointer event mask bits are:
-<function>ButtonPressMask</function>,
-<function>ButtonReleaseMask</function>,
-<function>EnterWindowMask</function>,
-<function>LeaveWindowMask</function>,
-<function>PointerMotionMask</function>,
-<function>PointerMotionHintMask</function>,
-<function>Button1MotionMask</function>,
-<function>Button2MotionMask</function>,
-<function>Button3MotionMask</function>,
-<function>Button4MotionMask</function>,
-<function>Button5MotionMask</function>,
-<function>ButtonMotionMask</function>,
+<symbol>ButtonPressMask</symbol>,
+<symbol>ButtonReleaseMask</symbol>,
+<symbol>EnterWindowMask</symbol>,
+<symbol>LeaveWindowMask</symbol>,
+<symbol>PointerMotionMask</symbol>,
+<symbol>PointerMotionHintMask</symbol>,
+<symbol>Button1MotionMask</symbol>,
+<symbol>Button2MotionMask</symbol>,
+<symbol>Button3MotionMask</symbol>,
+<symbol>Button4MotionMask</symbol>,
+<symbol>Button5MotionMask</symbol>,
+<symbol>ButtonMotionMask</symbol>,
and
-<function>KeyMapStateMask</function>.
+<symbol>KeymapStateMask</symbol>.
For other functions in this section,
you pass keymask bits.
The valid keymask bits are:
-<function>ShiftMask</function>,
-<function>LockMask</function>,
-<function>ControlMask</function>,
-<function>Mod1Mask</function>,
-<function>Mod2Mask</function>,
-<function>Mod3Mask</function>,
-<function>Mod4Mask</function>,
+<symbol>ShiftMask</symbol>,
+<symbol>LockMask</symbol>,
+<symbol>ControlMask</symbol>,
+<symbol>Mod1Mask</symbol>,
+<symbol>Mod2Mask</symbol>,
+<symbol>Mod3Mask</symbol>,
+<symbol>Mod4Mask</symbol>,
and
-<function>Mod5Mask</function>.
+<symbol>Mod5Mask</symbol>.
</para>
<para>
<!-- .LP -->
@@ -158,7 +158,7 @@ To grab the pointer, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XGrabPointer</function></funcdef>
+ <funcdef>int <function>XGrabPointer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> grab_window</parameter></paramdef>
<paramdef>Bool<parameter> owner_events</parameter></paramdef>
@@ -222,9 +222,9 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. <para>
Specifies further processing of pointer events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -236,9 +236,9 @@ or <para>
Specifies further processing of keyboard events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -249,7 +249,7 @@ or <listitem>
<para>
Specifies the window to confine the pointer in or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -260,7 +260,7 @@ Specifies the window to confine the pointer in or <listitem>
<para>
Specifies the cursor that is to be displayed during the grab or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -272,7 +272,7 @@ Specifies the cursor that is to be displayed during the grab or <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -284,18 +284,18 @@ You can pass either a timestamp or The
<function>XGrabPointer</function>
function actively grabs control of the pointer and returns
-<function>GrabSuccess</function>
+<symbol>GrabSuccess</symbol>
if the grab was successful.
Further pointer events are reported only to the grabbing client.
<function>XGrabPointer</function>
overrides any active pointer grab by this client.
If owner_events is
-<function>False</function>,
+<symbol>False</symbol>,
all generated pointer events
are reported with respect to grab_window and are reported only if
selected by event_mask.
If owner_events is
-<function>True</function>
+<symbol>True</symbol>
and if a generated
pointer event would normally be reported to this client,
it is reported as usual.
@@ -306,12 +306,12 @@ For either value of owner_events, unreported events are discarded. <para>
<!-- .LP -->
If the pointer_mode is
-<function>GrabModeAsync</function>,
+<symbol>GrabModeAsync</symbol>,
pointer event processing continues as usual.
If the pointer is currently frozen by this client,
the processing of events for the pointer is resumed.
If the pointer_mode is
-<function>GrabModeSync</function>,
+<symbol>GrabModeSync</symbol>,
the state of the pointer, as seen by
client applications,
appears to freeze, and the X server generates no further pointer events
@@ -324,10 +324,10 @@ they are simply queued in the server for later processing. <para>
<!-- .LP -->
If the keyboard_mode is
-<function>GrabModeAsync</function>,
+<symbol>GrabModeAsync</symbol>,
keyboard event processing is unaffected by activation of the grab.
If the keyboard_mode is
-<function>GrabModeSync</function>,
+<symbol>GrabModeSync</symbol>,
the state of the keyboard, as seen by
client applications,
appears to freeze, and the X server generates no further keyboard events
@@ -342,7 +342,7 @@ they are simply queued in the server for later processing. If a cursor is specified, it is displayed regardless of what
window the pointer is in.
If
-<function>None</function>
+<symbol>None</symbol>
is specified,
the normal cursor for that window is displayed
when the pointer is in grab_window or one of its subwindows;
@@ -375,11 +375,11 @@ grabbed the pointer before its request was processed. </para>
<para>
<!-- .LP -->
-<function>XGrabPointer </function>
+<function>XGrabPointer</function>
generates
-<function>EnterNotify </function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify </function>
+<symbol>LeaveNotify</symbol>
events.
</para>
<para>
@@ -389,28 +389,28 @@ or if the confine_to window lies completely outside the boundaries of the root window,
<function>XGrabPointer</function>
fails and returns
-<function>GrabNotViewable</function>.
+<symbol>GrabNotViewable</symbol>.
If the pointer is actively grabbed by some other client,
it fails and returns
-<function>AlreadyGrabbed</function>.
+<symbol>AlreadyGrabbed</symbol>.
If the pointer is frozen by an active grab of another client,
it fails and returns
-<function>GrabFrozen</function>.
+<symbol>GrabFrozen</symbol>.
If the specified time is earlier than the last-pointer-grab time or later
than the current X server time, it fails and returns
-<function>GrabInvalidTime</function>.
+<symbol>GrabInvalidTime</symbol>.
Otherwise, the last-pointer-grab time is set to the specified time
-(<function>CurrentTime </function>
+(<symbol>CurrentTime</symbol>
is replaced by the current X server time).
</para>
<para>
<!-- .LP -->
<function>XGrabPointer</function>
can generate
-<function>BadCursor</function>,
-<function>BadValue</function>,
+<errorname>BadCursor</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -424,7 +424,7 @@ To ungrab the pointer, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUngrabPointer</function></funcdef>
+ <funcdef><function>XUngrabPointer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Time<parameter> time</parameter></paramdef>
</funcprototype>
@@ -449,7 +449,7 @@ Specifies the connection to the X server. <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -470,12 +470,12 @@ does not release the pointer if the specified time is earlier than the last-pointer-grab time or is later than the
current X server time.
It also generates
-<function>EnterNotify </function>
+<symbol>EnterNotify</symbol>
and
-<function>LeaveNotify </function>
+<symbol>LeaveNotify</symbol>
events.
The X server performs an
-<function>UngrabPointer </function>
+<systemitem>UngrabPointer</systemitem>
request automatically if the event window or confine_to window
for an active pointer grab becomes not viewable
or if window reconfiguration causes the confine_to window to lie completely
@@ -492,7 +492,7 @@ To change an active pointer grab, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeActivePointerGrab</function></funcdef>
+ <funcdef><function>XChangeActivePointerGrab</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedint<parameter> event_mask</parameter></paramdef>
<paramdef>Cursor<parameter> cursor</parameter></paramdef>
@@ -529,7 +529,7 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. <listitem>
<para>
Specifies the cursor that is to be displayed or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -541,7 +541,7 @@ Specifies the cursor that is to be displayed or <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -564,9 +564,9 @@ The interpretation of event_mask and cursor is the same as described in <!-- .LP -->
<function>XChangeActivePointerGrab</function>
can generate
-<function>BadCursor </function>
+<errorname>BadCursor</errorname>
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -580,7 +580,7 @@ To grab a pointer button, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGrabButton</function></funcdef>
+ <funcdef><function>XGrabButton</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedint<parameter> button</parameter></paramdef>
<paramdef>unsignedint<parameter> modifiers</parameter></paramdef>
@@ -612,7 +612,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the pointer button that is to be (Bu or
-<function>AnyButton</function>.
+<symbol>AnyButton</symbol>.
</para>
</listitem>
</varlistentry>
@@ -623,7 +623,7 @@ Specifies the pointer button that is to be (Bu or <listitem>
<para>
Specifies the set of keymasks or
-<function>AnyModifier</function>.
+<symbol>AnyModifier</symbol>.
The mask is the bitwise inclusive OR of the valid keymask bits.
</para>
</listitem>
@@ -669,9 +669,9 @@ The mask is the bitwise inclusive OR of the valid pointer event mask bits. <para>
Specifies further processing of pointer events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -683,9 +683,9 @@ or <para>
Specifies further processing of keyboard events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -696,7 +696,7 @@ or <listitem>
<para>
Specifies the window to confine the pointer in or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -707,7 +707,7 @@ Specifies the window to confine the pointer in or <listitem>
<para>
Specifies the cursor that is to be displayed or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -724,9 +724,9 @@ the pointer is actively grabbed (as for <function>XGrabPointer</function>),
the last-pointer-grab time is set to the time at which the button was pressed
(as transmitted in the
-<function>ButtonPress</function>
+<symbol>ButtonPress</symbol>
event), and the
-<function>ButtonPress</function>
+<symbol>ButtonPress</symbol>
event is reported if all of the following conditions are true:
</para>
<itemizedlist>
@@ -772,13 +772,13 @@ may lag the physical state if device event processing is frozen. This request overrides all previous grabs by the same client on the same
button/key combinations on the same window.
A modifiers of
-<function>AnyModifier </function>
+<symbol>AnyModifier</symbol>
is equivalent to issuing the grab request for all
possible modifier combinations (including the combination of no modifiers).
It is not required that all modifiers specified have currently assigned
KeyCodes.
A button of
-<function>AnyButton </function>
+<symbol>AnyButton</symbol>
is equivalent to
issuing the request for all possible buttons.
Otherwise, it is not required that the specified button currently be assigned
@@ -789,15 +789,15 @@ to a physical button. If some other client has already issued an
<function>XGrabButton</function>
with the same button/key combination on the same window, a
-<function>BadAccess </function>
+<errorname>BadAccess</errorname>
error results.
When using
-<function>AnyModifier </function>
+<symbol>AnyModifier</symbol>
or
-<function>AnyButton</function>,
+<symbol>AnyButton</symbol>,
the request fails completely,
and a
-<function>BadAccess</function>
+<errorname>BadAccess</errorname>
error results (no grabs are
established) if there is a conflicting grab for any combination.
<function>XGrabButton</function>
@@ -807,10 +807,10 @@ has no effect on an active grab. <!-- .LP -->
<function>XGrabButton</function>
can generate
-<function>BadCursor</function>,
-<function>BadValue</function>,
+<errorname>BadCursor</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -824,7 +824,7 @@ To ungrab a pointer button, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUngrabButton</function></funcdef>
+ <funcdef><function>XUngrabButton</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedint<parameter> button</parameter></paramdef>
<paramdef>unsignedint<parameter> modifiers</parameter></paramdef>
@@ -851,7 +851,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the pointer button that is to be (Bu or
-<function>AnyButton</function>.
+<symbol>AnyButton</symbol>.
</para>
</listitem>
</varlistentry>
@@ -862,7 +862,7 @@ Specifies the pointer button that is to be (Bu or <listitem>
<para>
Specifies the set of keymasks or
-<function>AnyModifier</function>.
+<symbol>AnyModifier</symbol>.
The mask is the bitwise inclusive OR of the valid keymask bits.
</para>
</listitem>
@@ -887,13 +887,13 @@ The function releases the passive button/key combination on the specified window if
it was grabbed by this client.
A modifiers of
-<function>AnyModifier </function>
+<symbol>AnyModifier</symbol>
is
equivalent to issuing
the ungrab request for all possible modifier combinations, including
the combination of no modifiers.
A button of
-<function>AnyButton </function>
+<symbol>AnyButton</symbol>
is equivalent to issuing the
request for all possible buttons.
<function>XUngrabButton</function>
@@ -903,9 +903,9 @@ has no effect on an active grab. <!-- .LP -->
<function>XUngrabButton</function>
can generate
-<function>BadValue</function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -924,15 +924,15 @@ as well as allow events. For many functions in this section,
you pass keymask bits.
The valid keymask bits are:
-<function>ShiftMask</function>,
-<function>LockMask</function>,
-<function>ControlMask</function>,
-<function>Mod1Mask</function>,
-<function>Mod2Mask</function>,
-<function>Mod3Mask</function>,
-<function>Mod4Mask</function>,
+<symbol>ShiftMask</symbol>,
+<symbol>LockMask</symbol>,
+<symbol>ControlMask</symbol>,
+<symbol>Mod1Mask</symbol>,
+<symbol>Mod2Mask</symbol>,
+<symbol>Mod3Mask</symbol>,
+<symbol>Mod4Mask</symbol>,
and
-<function>Mod5Mask</function>.
+<symbol>Mod5Mask</symbol>.
</para>
<para>
<!-- .LP -->
@@ -945,7 +945,7 @@ To grab the keyboard, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XGrabKeyboard</function></funcdef>
+ <funcdef>int <function>XGrabKeyboard</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> grab_window</parameter></paramdef>
<paramdef>Bool<parameter> owner_events</parameter></paramdef>
@@ -994,9 +994,9 @@ are to be reported as usual. <para>
Specifies further processing of pointer events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1008,9 +1008,9 @@ or <para>
Specifies further processing of keyboard events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1022,7 +1022,7 @@ or <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1034,45 +1034,45 @@ You can pass either a timestamp or The
<function>XGrabKeyboard</function>
function actively grabs control of the keyboard and generates
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events.
Further key events are reported only to the
grabbing client.
<function>XGrabKeyboard</function>
overrides any active keyboard grab by this client.
If owner_events is
-<function>False</function>,
+<symbol>False</symbol>,
all generated key events are reported with
respect to grab_window.
If owner_events is
-<function>True </function>
+<symbol>True</symbol>
and if a generated
key event would normally be reported to this client, it is reported
normally; otherwise, the event is reported with respect to the
grab_window.
Both
-<function>KeyPress </function>
+<symbol>KeyPress</symbol>
and
-<function>KeyRelease </function>
+<symbol>KeyRelease</symbol>
events are always reported,
independent of any event selection made by the client.
</para>
<para>
<!-- .LP -->
If the keyboard_mode argument is
-<function>GrabModeAsync</function>,
+<symbol>GrabModeAsync</symbol>,
keyboard event processing continues
as usual.
If the keyboard is currently frozen by this client,
then processing of keyboard events is resumed.
If the keyboard_mode argument is
-<function>GrabModeSync</function>,
+<symbol>GrabModeSync</symbol>,
the state of the keyboard (as seen by client applications) appears to freeze,
and the X server generates no further keyboard events until the
grabbing client issues a releasing
-<function>XAllowEvents </function>
+<function>XAllowEvents</function>
call or until the keyboard grab is released.
Actual keyboard changes are not lost while the keyboard is frozen;
they are simply queued in the server for later processing.
@@ -1080,15 +1080,15 @@ they are simply queued in the server for later processing. <para>
<!-- .LP -->
If pointer_mode is
-<function>GrabModeAsync</function>,
+<symbol>GrabModeAsync</symbol>,
pointer event processing is unaffected
by activation of the grab.
If pointer_mode is
-<function>GrabModeSync</function>,
+<symbol>GrabModeSync</symbol>,
the state of the pointer (as seen by client applications) appears to freeze,
and the X server generates no further pointer events
until the grabbing client issues a releasing
-<function>XAllowEvents </function>
+<function>XAllowEvents</function>
call or until the keyboard grab is released.
Actual pointer changes are not lost while the pointer is frozen;
they are simply queued in the server for later processing.
@@ -1098,28 +1098,28 @@ they are simply queued in the server for later processing. If the keyboard is actively grabbed by some other client,
<function>XGrabKeyboard</function>
fails and returns
-<function>AlreadyGrabbed</function>.
+<symbol>AlreadyGrabbed</symbol>.
If grab_window is not viewable,
it fails and returns
-<function>GrabNotViewable</function>.
+<symbol>GrabNotViewable</symbol>.
If the keyboard is frozen by an active grab of another client,
it fails and returns
-<function>GrabFrozen</function>.
+<symbol>GrabFrozen</symbol>.
If the specified time is earlier than the last-keyboard-grab time
or later than the current X server time,
it fails and returns
-<function>GrabInvalidTime</function>.
+<symbol>GrabInvalidTime</symbol>.
Otherwise, the last-keyboard-grab time is set to the specified time
-(<function>CurrentTime </function>
+(<symbol>CurrentTime</symbol>
is replaced by the current X server time).
</para>
<para>
<!-- .LP -->
<function>XGrabKeyboard</function>
can generate
-<function>BadValue</function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -1133,7 +1133,7 @@ To ungrab the keyboard, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUngrabKeyboard</function></funcdef>
+ <funcdef><function>XUngrabKeyboard</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Time<parameter> time</parameter></paramdef>
</funcprototype>
@@ -1158,7 +1158,7 @@ Specifies the connection to the X server. <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1180,12 +1180,12 @@ does not release the keyboard and any queued events if the specified time is earlier than
the last-keyboard-grab time or is later than the current X server time.
It also generates
-<function>FocusIn </function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut </function>
+<symbol>FocusOut</symbol>
events.
The X server automatically performs an
-<function>UngrabKeyboard </function>
+<systemitem>UngrabKeyboard</systemitem>
request if the event window for an
active keyboard grab becomes not viewable.
</para>
@@ -1200,7 +1200,7 @@ To passively grab a single key of the keyboard, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGrabKey</function></funcdef>
+ <funcdef><function>XGrabKey</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> keycode</parameter></paramdef>
<paramdef>unsignedint<parameter> modifiers</parameter></paramdef>
@@ -1228,7 +1228,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the KeyCode or
-<function>AnyKey</function>.
+<symbol>AnyKey</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1239,7 +1239,7 @@ Specifies the KeyCode or <listitem>
<para>
Specifies the set of keymasks or
-<function>AnyModifier</function>.
+<symbol>AnyModifier</symbol>.
The mask is the bitwise inclusive OR of the valid keymask bits.
</para>
</listitem>
@@ -1273,9 +1273,9 @@ are to be reported as usual. <para>
Specifies further processing of pointer events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1287,9 +1287,9 @@ or <para>
Specifies further processing of keyboard events.
You can pass
-<function>GrabModeSync </function>
+<symbol>GrabModeSync</symbol>
or
-<function>GrabModeAsync</function>.
+<symbol>GrabModeAsync</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1306,9 +1306,9 @@ the keyboard is actively grabbed (as for <function>XGrabKeyboard</function>),
the last-keyboard-grab time is set to the time at which the key was pressed
(as transmitted in the
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event), and the
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event is reported if all of the following conditions are true:
</para>
<itemizedlist>
@@ -1349,21 +1349,21 @@ may lag the physical state if device event processing is frozen. <para>
<!-- .LP -->
A modifiers argument of
-<function>AnyModifier</function>
+<symbol>AnyModifier</symbol>
is equivalent to issuing the request for all
possible modifier combinations (including the combination of no
modifiers).
It is not required that all modifiers specified have
currently assigned KeyCodes.
A keycode argument of
-<function>AnyKey</function>
+<symbol>AnyKey</symbol>
is equivalent to issuing
the request for all possible KeyCodes.
Otherwise, the specified keycode must be in
the range specified by min_keycode and max_keycode in the connection
setup,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
@@ -1371,15 +1371,15 @@ error results. If some other client has issued a
<function>XGrabKey</function>
with the same key combination on the same window, a
-<function>BadAccess </function>
+<errorname>BadAccess</errorname>
error results.
When using
-<function>AnyModifier</function>
+<symbol>AnyModifier</symbol>
or
-<function>AnyKey</function>,
+<symbol>AnyKey</symbol>,
the request fails completely,
and a
-<function>BadAccess </function>
+<errorname>BadAccess</errorname>
error results (no grabs are established)
if there is a conflicting grab for any combination.
</para>
@@ -1387,10 +1387,10 @@ if there is a conflicting grab for any combination. <!-- .LP -->
<function>XGrabKey</function>
can generate
-<function>BadAccess</function>,
-<function>BadValue</function>,
+<errorname>BadAccess</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -1404,7 +1404,7 @@ To ungrab a key, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUngrabKey</function></funcdef>
+ <funcdef><function>XUngrabKey</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> keycode</parameter></paramdef>
<paramdef>unsignedint<parameter> modifiers</parameter></paramdef>
@@ -1430,7 +1430,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the KeyCode or
-<function>AnyKey</function>.
+<symbol>AnyKey</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1441,7 +1441,7 @@ Specifies the KeyCode or <listitem>
<para>
Specifies the set of keymasks or
-<function>AnyModifier</function>.
+<symbol>AnyModifier</symbol>.
The mask is the bitwise inclusive OR of the valid keymask bits.
</para>
</listitem>
@@ -1467,21 +1467,21 @@ function releases the key combination on the specified window if it was grabbed by this client.
It has no effect on an active grab.
A modifiers of
-<function>AnyModifier</function>
+<symbol>AnyModifier</symbol>
is equivalent to issuing
the request for all possible modifier combinations
(including the combination of no modifiers).
A keycode argument of
-<function>AnyKey</function>
+<symbol>AnyKey</symbol>
is equivalent to issuing the request for all possible key codes.
</para>
<para>
<!-- .LP -->
<function>XUngrabKey</function>
can generate
-<function>BadValue</function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect1>
@@ -1505,7 +1505,7 @@ To allow further events to be processed when the device has been frozen, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAllowEvents</function></funcdef>
+ <funcdef><function>XAllowEvents</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> event_mode</parameter></paramdef>
<paramdef>Time<parameter> time</parameter></paramdef>
@@ -1531,15 +1531,15 @@ Specifies the connection to the X server. <para>
Specifies the event mode.
You can pass
-<function>AsyncPointer</function>,
-<function>SyncPointer</function>,
-<function>AsyncKeyboard</function>,
-<function>SyncKeyboard</function>,
-<function>ReplayPointer</function>,
-<function>ReplayKeyboard</function>,
-<function>AsyncBoth</function>,
+<symbol>AsyncPointer</symbol>,
+<symbol>SyncPointer</symbol>,
+<symbol>AsyncKeyboard</symbol>,
+<symbol>SyncKeyboard</symbol>,
+<symbol>ReplayPointer</symbol>,
+<symbol>ReplayKeyboard</symbol>,
+<symbol>AsyncBoth</symbol>,
or
-<function>SyncBoth</function>.
+<symbol>SyncBoth</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1551,7 +1551,7 @@ or <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1575,41 +1575,41 @@ Depending on the event_mode argument, the following occurs: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>AsyncPointer</function></entry>
+ <entry><symbol>AsyncPointer</symbol></entry>
<entry>If the pointer is frozen by the client,
pointer event processing continues as usual.
If the pointer is frozen twice by the client on behalf of two separate grabs,
- <function>AsyncPointer </function>
+ <symbol>AsyncPointer</symbol>
thaws for both.
- <function>AsyncPointer</function>
+ <symbol>AsyncPointer</symbol>
has no effect if the pointer is not frozen by the client,
but the pointer need not be grabbed by the client.</entry>
</row>
<row>
- <entry><function>SyncPointer </function></entry>
+ <entry><symbol>SyncPointer</symbol></entry>
<entry>If the pointer is frozen and actively grabbed by the client,
pointer event processing continues as usual until the next
- <function>ButtonPress </function>
+ <symbol>ButtonPress</symbol>
or
- <function>ButtonRelease </function>
+ <symbol>ButtonRelease</symbol>
event is reported to the client.
At this time,
the pointer again appears to freeze.
However, if the reported event causes the pointer grab to be released,
the pointer does not freeze.
- <function>SyncPointer </function>
+ <symbol>SyncPointer</symbol>
has no effect if the pointer is not frozen by the client
or if the pointer is not grabbed by the client.</entry>
</row>
<row>
- <entry><function>ReplayPointer</function></entry>
+ <entry><symbol>ReplayPointer</symbol></entry>
<entry>If the pointer is actively grabbed by the client and is frozen as the result of
an event having been sent to the client (either from the activation of an
- <function>XGrabButton </function>
+ <function>XGrabButton</function>
or from a previous
- <function>XAllowEvents </function>
+ <function>XAllowEvents</function>
with mode
- <function>SyncPointer</function>
+ <symbol>SyncPointer</symbol>
but not from an
<function>XGrabPointer</function>),
the pointer grab is released and that event is completely reprocessed.
@@ -1619,42 +1619,42 @@ Depending on the event_mode argument, the following occurs: or if the pointer is not frozen as the result of an event.</entry>
</row>
<row>
- <entry><function>AsyncKeyboard </function></entry>
+ <entry><symbol>AsyncKeyboard</symbol></entry>
<entry>If the keyboard is frozen by the client,
keyboard event processing continues as usual.
If the keyboard is frozen twice by the client on behalf of two separate grabs,
- <function>AsyncKeyboard </function>
+ <symbol>AsyncKeyboard</symbol>
thaws for both.
- <function>AsyncKeyboard </function>
+ <symbol>AsyncKeyboard</symbol>
has no effect if the keyboard is not frozen by the client,
but the keyboard need not be grabbed by the client.</entry>
</row>
<row>
- <entry><function>SyncKeyboard</function></entry>
+ <entry><symbol>SyncKeyboard</symbol></entry>
<entry>If the keyboard is frozen and actively grabbed by the client,
keyboard event processing continues as usual until the next
- <function>KeyPress </function>
+ <symbol>KeyPress</symbol>
or
- <function>KeyRelease </function>
+ <symbol>KeyRelease</symbol>
event is reported to the client.
At this time,
the keyboard again appears to freeze.
However, if the reported event causes the keyboard grab to be released,
the keyboard does not freeze.
- <function>SyncKeyboard </function>
+ <symbol>SyncKeyboard</symbol>
has no effect if the keyboard is not frozen by the client
or if the keyboard is not grabbed by the client.</entry>
</row>
<row>
- <entry><function>ReplayKeyboard</function></entry>
+ <entry><symbol>ReplayKeyboard</symbol></entry>
<entry>If the keyboard is actively grabbed by the client and is frozen
as the result of an event having been sent to the client (either from the
activation of an
- <function>XGrabKey </function>
+ <function>XGrabKey</function>
or from a previous
- <function>XAllowEvents </function>
+ <function>XAllowEvents</function>
with mode
- <function>SyncKeyboard </function>
+ <symbol>SyncKeyboard</symbol>
but not from an
<function>XGrabKeyboard</function>),
the keyboard grab is released and that event is completely reprocessed.
@@ -1665,14 +1665,14 @@ Depending on the event_mode argument, the following occurs: or if the keyboard is not frozen as the result of an event.</entry>
</row>
<row>
- <entry><function>SyncBoth</function></entry>
+ <entry><symbol>SyncBoth</symbol></entry>
<entry>If both pointer and keyboard are frozen by the client,
event processing for both devices continues as usual until the next
- <function>ButtonPress</function>,
- <function>ButtonRelease</function>,
- <function>KeyPress</function>,
+ <symbol>ButtonPress</symbol>,
+ <symbol>ButtonRelease</symbol>,
+ <symbol>KeyPress</symbol>,
or
- <function>KeyRelease </function>
+ <symbol>KeyRelease</symbol>
event is reported to the client for a grabbed device
(button event for the pointer, key event for the keyboard),
at which time the devices again appear to freeze.
@@ -1680,24 +1680,24 @@ Depending on the event_mode argument, the following occurs: then the devices do not freeze (but if the other device is still
grabbed, then a subsequent event for it will still cause both devices
to freeze).
- <function>SyncBoth</function>
+ <symbol>SyncBoth</symbol>
has no effect unless both pointer and keyboard
are frozen by the client.
If the pointer or keyboard is frozen twice
by the client on behalf of two separate grabs,
- <function>SyncBoth </function>
+ <symbol>SyncBoth</symbol>
thaws for both (but a subsequent freeze for
- <function>SyncBoth </function>
+ <symbol>SyncBoth</symbol>
will only freeze each device once).</entry>
</row>
<row>
- <entry><function>AsyncBoth</function></entry>
+ <entry><symbol>AsyncBoth</symbol></entry>
<entry>If the pointer and the keyboard are frozen by the
client, event processing for both devices continues as usual.
If a device is frozen twice by the client on behalf of two separate grabs,
- <function>AsyncBoth </function>
+ <symbol>AsyncBoth</symbol>
thaws for both.
- <function>AsyncBoth </function>
+ <symbol>AsyncBoth</symbol>
has no effect unless both
pointer and keyboard are frozen by the client.</entry>
</row>
@@ -1707,16 +1707,16 @@ Depending on the event_mode argument, the following occurs: <para>
<!-- .LP -->
-<function>AsyncPointer</function>,
-<function>SyncPointer</function>,
+<symbol>AsyncPointer</symbol>,
+<symbol>SyncPointer</symbol>,
and
-<function>ReplayPointer </function>
+<symbol>ReplayPointer</symbol>
have no effect on the
processing of keyboard events.
-<function>AsyncKeyboard</function>,
-<function>SyncKeyboard</function>,
+<symbol>AsyncKeyboard</symbol>,
+<symbol>SyncKeyboard</symbol>,
and
-<function>ReplayKeyboard </function>
+<symbol>ReplayKeyboard</symbol>
have no effect on the
processing of pointer events.
It is possible for both a pointer grab and a keyboard grab (by the same
@@ -1729,14 +1729,14 @@ the freeze must be released on behalf of both grabs before events can again be processed.
If a device is frozen twice by a single client,
then a single
-<function>AllowEvents</function>
+<function>XAllowEvents</function>
releases both.
</para>
<para>
<!-- .LP -->
<function>XAllowEvents</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
</sect1>
@@ -1760,7 +1760,7 @@ To move the pointer to an arbitrary point in a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XWarpPointer</function></funcdef>
+ <funcdef><function>XWarpPointer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Windowsrc_w,<parameter> dest_w</parameter></paramdef>
<paramdef>intsrc_x,<parameter> src_y</parameter></paramdef>
@@ -1787,7 +1787,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the source window or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1798,7 +1798,7 @@ Specifies the source window or <listitem>
<para>
Specifies the destination window or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1872,7 +1872,7 @@ Specify the x and y coordinates within the destination window. <!-- .LP -->
<!-- .eM -->
If dest_w is
-<function>None</function>,
+<symbol>None</symbol>,
<function>XWarpPointer</function>
moves the pointer by the offsets (dest_x, dest_y) relative to the current
position of the pointer.
@@ -1908,7 +1908,7 @@ confine_to window. <!-- .LP -->
<function>XWarpPointer</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect1>
@@ -1934,7 +1934,7 @@ To set the input focus, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetInputFocus</function></funcdef>
+ <funcdef><function>XSetInputFocus</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> focus</parameter></paramdef>
<paramdef>int<parameter> revert_to</parameter></paramdef>
@@ -1960,9 +1960,9 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the window,
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1975,10 +1975,10 @@ or Specifies where the input focus reverts to if the window becomes not
viewable.
You can pass
-<function>RevertToParent</function>,
-<function>RevertToPointerRoot</function>,
+<symbol>RevertToParent</symbol>,
+<symbol>RevertToPointerRoot</symbol>,
or
-<function>RevertToNone</function>.
+<symbol>RevertToNone</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1990,7 +1990,7 @@ or <para>
Specifies the time.
You can pass either a timestamp or
-<function>CurrentTime</function>.
+<symbol>CurrentTime</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2005,13 +2005,13 @@ function changes the input focus and the last-focus-change time. It has no effect if the specified time is earlier than the current
last-focus-change time or is later than the current X server time.
Otherwise, the last-focus-change time is set to the specified time
-(<function>CurrentTime </function>
+(<symbol>CurrentTime</symbol>
is replaced by the current X server time).
<function>XSetInputFocus</function>
causes the X server to generate
-<function>FocusIn </function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut </function>
+<symbol>FocusOut</symbol>
events.
</para>
<para>
@@ -2023,7 +2023,7 @@ the following occurs: <listitem>
<para>
If focus is
-<function>None</function>,
+<symbol>None</symbol>,
all keyboard events are discarded until a new focus window is set,
and the revert_to argument is ignored.
</para>
@@ -2040,7 +2040,7 @@ Otherwise, the event is reported relative to the focus window. <listitem>
<para>
If focus is
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
the focus window is dynamically taken to be the root window of whatever screen
the pointer is on at each keyboard event.
In this case, the revert_to argument is ignored.
@@ -2053,7 +2053,7 @@ The specified focus window must be viewable at the time <function>XSetInputFocus</function>
is called,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
If the focus window later becomes not viewable,
the X server
@@ -2063,28 +2063,28 @@ evaluates the revert_to argument to determine the new focus window as follows: <listitem>
<para>
If revert_to is
-<function>RevertToParent</function>,
+<symbol>RevertToParent</symbol>,
the focus reverts to the parent (or the closest viewable ancestor),
and the new revert_to value is taken to be
-<function>RevertToNone</function>.
+<symbol>RevertToNone</symbol>.
</para>
</listitem>
<listitem>
<para>
If revert_to is
-<function>RevertToPointerRoot </function>
+<symbol>RevertToPointerRoot</symbol>
or
-<function>RevertToNone</function>,
+<symbol>RevertToNone</symbol>,
the focus reverts to
-<function>PointerRoot</function>
+<symbol>PointerRoot</symbol>
or
-<function>None</function>,
+<symbol>None</symbol>,
respectively.
When the focus reverts,
the X server generates
-<function>FocusIn</function>
+<symbol>FocusIn</symbol>
and
-<function>FocusOut</function>
+<symbol>FocusOut</symbol>
events, but the last-focus-change time is not affected.
</para>
</listitem>
@@ -2093,10 +2093,10 @@ events, but the last-focus-change time is not affected. <!-- .LP -->
<function>XSetInputFocus</function>
can generate
-<function>BadMatch</function>,
-<function>BadValue</function>,
+<errorname>BadMatch</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2108,7 +2108,7 @@ To obtain the current input focus, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGetInputFocus</function></funcdef>
+ <funcdef><function>XGetInputFocus</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> *focus_return</parameter></paramdef>
<paramdef>int<parameter> *revert_to_return</parameter></paramdef>
@@ -2133,9 +2133,9 @@ Specifies the connection to the X server. <listitem>
<para>
Returns the focus window,
-<function>PointerRoot</function>,
+<symbol>PointerRoot</symbol>,
or
-<function>None</function>.
+<symbol>None</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2146,10 +2146,10 @@ or <listitem>
<para>
Returns the current focus state
-(<function>RevertToParent</function>,
-<function>RevertToPointerRoot</function>,
+(<symbol>RevertToParent</symbol>,
+<symbol>RevertToPointerRoot</symbol>,
or
-<function>RevertToNone</function>).
+<symbol>RevertToNone</symbol>).
</para>
</listitem>
</varlistentry>
@@ -2194,7 +2194,7 @@ parameters. The
<function>XChangeKeyboardControl</function>
function changes control of a keyboard and operates on a
-<function>XKeyboardControl</function>
+<structname>XKeyboardControl</structname>
structure:
<!-- .sM -->
</para>
@@ -2235,7 +2235,7 @@ The key_click_percent member sets the volume for key clicks between 0 (off) and 100 (loud) inclusive, if possible.
A setting of -1 restores the default.
Other negative values generate a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -2244,18 +2244,18 @@ The bell_percent sets the base volume for the bell between 0 (off) and 100 (loud) inclusive, if possible.
A setting of -1 restores the default.
Other negative values generate a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error.
The bell_pitch member sets the pitch (specified in Hz) of the bell, if possible.
A setting of -1 restores the default.
Other negative values generate a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error.
The bell_duration member sets the duration of the
bell specified in milliseconds, if possible.
A setting of -1 restores the default.
Other negative values generate a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -2263,31 +2263,31 @@ error. If both the led_mode and led members are specified,
the state of that <acronym>LED</acronym> is changed, if possible.
The led_mode member can be set to
-<function>LedModeOn</function>
+<symbol>LedModeOn</symbol>
or
-<function>LedModeOff</function>.
+<symbol>LedModeOff</symbol>.
If only led_mode is specified, the state of
all LEDs are changed, if possible.
At most 32 LEDs numbered from one are supported.
No standard interpretation of LEDs is defined.
If led is specified without led_mode, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
If both the auto_repeat_mode and key members are specified,
the auto_repeat_mode of that key is changed (according to
-<function>AutoRepeatModeOn</function>,
-<function>AutoRepeatModeOff</function>,
+<symbol>AutoRepeatModeOn</symbol>,
+<symbol>AutoRepeatModeOff</symbol>,
or
-<function>AutoRepeatModeDefault</function>),
+<symbol>AutoRepeatModeDefault</symbol>),
if possible.
If only auto_repeat_mode is
specified, the global auto_repeat_mode for the entire keyboard is
changed, if possible, and does not affect the per-key settings.
If a key is specified without an auto_repeat_mode, a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
Each key has an individual mode of whether or not it should auto-repeat
and a default setting for the mode.
@@ -2295,15 +2295,15 @@ In addition, there is a global mode of whether auto-repeat should be enabled or not
and a default setting for that mode.
When global mode is
-<function>AutoRepeatModeOn</function>,
+<symbol>AutoRepeatModeOn</symbol>,
keys should obey their individual auto-repeat modes.
When global mode is
-<function>AutoRepeatModeOff</function>,
+<symbol>AutoRepeatModeOff</symbol>,
no keys should auto-repeat.
An auto-repeating key generates alternating
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
and
-<function>KeyRelease</function>
+<symbol>KeyRelease</symbol>
events.
When a key is used as a modifier,
it is desirable for the key not to auto-repeat,
@@ -2323,7 +2323,7 @@ If an error is generated, a subset of the controls may have been altered. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeKeyboardControl</function></funcdef>
+ <funcdef><function>XChangeKeyboardControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedlong<parameter> value_mask</parameter></paramdef>
<paramdef>XKeyboardControl<parameter> *values</parameter></paramdef>
@@ -2370,7 +2370,7 @@ Specifies one value for each bit set to 1 in the mask. The
<function>XChangeKeyboardControl</function>
function controls the keyboard characteristics defined by the
-<function>XKeyboardControl</function>
+<structname>XKeyboardControl</structname>
structure.
The value_mask argument specifies which values are to be changed.
</para>
@@ -2378,9 +2378,9 @@ The value_mask argument specifies which values are to be changed. <!-- .LP -->
<function>XChangeKeyboardControl</function>
can generate
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -2392,7 +2392,7 @@ To obtain the current control values for the keyboard, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGetKeyboardControl</function></funcdef>
+ <funcdef><function>XGetKeyboardControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XKeyboardState<parameter> *values_return</parameter></paramdef>
</funcprototype>
@@ -2416,7 +2416,7 @@ Specifies the connection to the X server. <listitem>
<para>
Returns the current keyboard controls in the specified
-<function>XKeyboardState </function>
+<structname>XKeyboardState</structname>
structure.
</para>
</listitem>
@@ -2429,7 +2429,7 @@ structure. The
<function>XGetKeyboardControl</function>
function returns the current control values for the keyboard to the
-<function>XKeyboardState</function>
+<structname>XKeyboardState</structname>
structure.
</para>
<para>
@@ -2457,9 +2457,9 @@ For the LEDs, the least significant bit of led_mask corresponds to <acronym>LED</acronym> one,
and each bit set to 1 in led_mask indicates an <acronym>LED</acronym> that is lit.
The global_auto_repeat member can be set to
-<function>AutoRepeatModeOn</function>
+<symbol>AutoRepeatModeOn</symbol>
or
-<function>AutoRepeatModeOff</function>.
+<symbol>AutoRepeatModeOff</symbol>.
The auto_repeats member is a bit vector.
Each bit set to 1 indicates that auto-repeat is enabled
for the corresponding key.
@@ -2476,7 +2476,7 @@ To turn on keyboard auto-repeat, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAutoRepeatOn</function></funcdef>
+ <funcdef><function>XAutoRepeatOn</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2510,7 +2510,7 @@ To turn off keyboard auto-repeat, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAutoRepeatOff</function></funcdef>
+ <funcdef><function>XAutoRepeatOff</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2544,7 +2544,7 @@ To ring the bell, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XBell</function></funcdef>
+ <funcdef><function>XBell</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> percent</parameter></paramdef>
</funcprototype>
@@ -2583,7 +2583,7 @@ function rings the bell on the keyboard on the specified display, if possible. The specified volume is relative to the base volume for the keyboard.
If the value for the percent argument is not in the range -100 to 100
inclusive, a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
The volume at which the bell rings
when the percent argument is nonnegative is:
@@ -2616,7 +2616,7 @@ To change the base volume of the bell, use <!-- .LP -->
<function>XBell</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -2628,7 +2628,7 @@ To obtain a bit vector that describes the state of the keyboard, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XQueryKeymap</function></funcdef>
+ <funcdef><function>XQueryKeymap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> keys_return[32]</parameter></paramdef>
</funcprototype>
@@ -2684,7 +2684,7 @@ To set the mapping of the pointer buttons, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XSetPointerMapping</function></funcdef>
+ <funcdef>int <function>XSetPointerMapping</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedchar<parameter> map[]</parameter></paramdef>
<paramdef>int<parameter> nmap</parameter></paramdef>
@@ -2731,36 +2731,36 @@ The <function>XSetPointerMapping</function>
function sets the mapping of the pointer.
If it succeeds, the X server generates a
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
event, and
<function>XSetPointerMapping</function>
returns
-<function>MappingSuccess</function>.
+<symbol>MappingSuccess</symbol>.
Element map[i] defines the logical button number for the physical button
i+1.
The length of the list must be the same as
<function>XGetPointerMapping</function>
would return,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
A zero element disables a button, and elements are not restricted in
value by the number of physical buttons.
However, no two elements can have the same nonzero value,
or a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error results.
If any of the buttons to be altered are logically in the down state,
<function>XSetPointerMapping</function>
returns
-<function>MappingBusy</function>,
+<symbol>MappingBusy</symbol>,
and the mapping is not changed.
</para>
<para>
<!-- .LP -->
<function>XSetPointerMapping</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -2772,7 +2772,7 @@ To get the pointer mapping, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XGetPointerMapping</function></funcdef>
+ <funcdef>int <function>XGetPointerMapping</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>unsignedchar<parameter> map_return[]</parameter></paramdef>
<paramdef>int<parameter> nmap</parameter></paramdef>
@@ -2835,7 +2835,7 @@ To control the pointer's interactive feel, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangePointerControl</function></funcdef>
+ <funcdef><function>XChangePointerControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Booldo_accel,<parameter> do_threshold</parameter></paramdef>
<paramdef>intaccel_numerator,<parameter> accel_denominator</parameter></paramdef>
@@ -2924,11 +2924,11 @@ only takes effect if the pointer moves more than threshold pixels at once and only applies to the amount beyond the value in the threshold argument.
Setting a value to -1 restores the default.
The values of the do_accel and do_threshold arguments must be
-<function>True </function>
+<symbol>True</symbol>
for the pointer values to be set,
or the parameters are unchanged.
Negative values (other than -1) generate a
-<function>BadValue</function>
+<errorname>BadValue</errorname>
error, as does a zero value
for the accel_denominator argument.
</para>
@@ -2936,7 +2936,7 @@ for the accel_denominator argument. <!-- .LP -->
<function>XChangePointerControl</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -2948,7 +2948,7 @@ To get the current pointer parameters, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XGetPointerControl</function></funcdef>
+ <funcdef><function>XGetPointerControl</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int*accel_numerator_return,<parameter> *accel_denominator_return</parameter></paramdef>
<paramdef>int<parameter> *threshold_return</parameter></paramdef>
@@ -3035,14 +3035,14 @@ standards. In areas where no standards exist,
some of these sets are derived from Digital Equipment Corporation standards.
The list of defined symbols can be found in
-<!-- .hN X11/keysymdef.h . -->
+<<filename class="headerfile">X11/keysymdef.h</filename>>.
Unfortunately, some C preprocessors have
limits on the number of defined symbols.
If you must use KeySyms not
in the Latin 1-4, Greek, and miscellaneous classes,
you may have to define a symbol for those sets.
Most applications usually only include
-<!-- .hN X11/keysym.h , -->
+<<filename class="headerfile">X11/keysym.h</filename>>,
which defines symbols for ISO Latin 1-4, Greek, and miscellaneous.
</para>
<para>
@@ -3050,22 +3050,22 @@ which defines symbols for ISO Latin 1-4, Greek, and miscellaneous. A list of KeySyms is associated with each KeyCode.
The list is intended to convey the set of symbols on the corresponding key.
If the list (ignoring trailing
-<function>NoSymbol</function>
+<symbol>NoSymbol</symbol>
entries) is
a single KeySym ``<emphasis remap='I'>K</emphasis>'',
then the list is treated as if it were the list
``<emphasis remap='I'>K</emphasis> NoSymbol <emphasis remap='I'>K</emphasis> NoSymbol''.
If the list (ignoring trailing
-<function>NoSymbol</function>
+<symbol>NoSymbol</symbol>
entries) is a pair of KeySyms ``<emphasis remap='I'>K1 K2</emphasis>'',
then the list is treated as if it were the list ``<emphasis remap='I'>K1 K2 K1 K2</emphasis>''.
If the list (ignoring trailing
-<function>NoSymbol</function>
+<symbol>NoSymbol</symbol>
entries) is a triple of KeySyms ``<emphasis remap='I'>K1 K2 K3</emphasis>'',
then the list is treated as if it were the list ``<emphasis remap='I'>K1 K2 K3</emphasis> NoSymbol''.
When an explicit ``void'' element is desired in the list,
the value
-<function>VoidSymbol</function>
+<symbol>VoidSymbol</symbol>
can be used.
</para>
<para>
@@ -3075,7 +3075,7 @@ Group 1 contains the first and second KeySyms; Group 2 contains the third and fourth KeySyms.
Within each group,
if the second element of the group is
-<function>NoSymbol</function>,
+<symbol>NoSymbol</symbol>,
then the group should be treated as if the second element were
the same as the first element,
except when the first element is an alphabetic KeySym ``<emphasis remap='I'>K</emphasis>''
@@ -3088,16 +3088,16 @@ the uppercase form of ``<emphasis remap='I'>K</emphasis>''. <para>
<!-- .LP -->
The standard rules for obtaining a KeySym from a
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event make use of only the Group 1 and Group 2 KeySyms;
no interpretation of other KeySyms in the list is given.
Which group to use is determined by the modifier state.
Switching between groups is controlled by the KeySym named MODE SWITCH,
by attaching that KeySym to some KeyCode and attaching
that KeyCode to any one of the modifiers
-<function>Mod1</function>
+<symbol>Mod1</symbol>
through
-<function>Mod5</function>.
+<symbol>Mod5</symbol>.
This modifier is called the <emphasis remap='I'>group modifier</emphasis>.
For any KeyCode,
Group 1 is used when the group modifier is off,
@@ -3106,17 +3106,17 @@ and Group 2 is used when the group modifier is on. <para>
<!-- .LP -->
The
-<function>Lock</function>
+<symbol>Lock</symbol>
modifier is interpreted as CapsLock when the KeySym named XK_Caps_Lock
is attached to some KeyCode and that KeyCode is attached to the
-<function>Lock</function>
+<symbol>Lock</symbol>
modifier. The
-<function>Lock</function>
+<symbol>Lock</symbol>
modifier is interpreted as ShiftLock when the KeySym named XK_Shift_Lock
is attached to some KeyCode and that KeyCode is attached to the
-<function>Lock </function>
+<symbol>Lock</symbol>
modifier. If the
-<function>Lock </function>
+<symbol>Lock</symbol>
modifier could be interpreted as both
CapsLock and ShiftLock, the CapsLock interpretation is used.
</para>
@@ -3125,9 +3125,9 @@ CapsLock and ShiftLock, the CapsLock interpretation is used. The operation of keypad keys is controlled by the KeySym named XK_Num_Lock,
by attaching that KeySym to some KeyCode and attaching that KeyCode to any
one of the modifiers
-<function>Mod1 </function>
+<symbol>Mod1</symbol>
through
-<function>Mod5</function>.
+<symbol>Mod5</symbol>.
This modifier is called the
<emphasis remap='I'>numlock modifier</emphasis>. The standard KeySyms with the prefix ``XK_KP_''
in their
@@ -3146,9 +3146,9 @@ rule that is satisfied from the following list: <para>
The numlock modifier is on and the second KeySym is a keypad KeySym. In
this case, if the
-<function>Shift </function>
+<symbol>Shift</symbol>
modifier is on, or if the
-<function>Lock </function>
+<symbol>Lock</symbol>
modifier is on and
is interpreted as ShiftLock, then the first KeySym is used, otherwise the
second KeySym is used.
@@ -3157,9 +3157,9 @@ second KeySym is used. <listitem>
<para>
The
-<function>Shift </function>
+<symbol>Shift</symbol>
and
-<function>Lock </function>
+<symbol>Lock</symbol>
modifiers are both off. In this case, the first
KeySym is used.
</para>
@@ -3167,9 +3167,9 @@ KeySym is used. <listitem>
<para>
The
-<function>Shift </function>
+<symbol>Shift</symbol>
modifier is off, and the
-<function>Lock </function>
+<symbol>Lock</symbol>
modifier is on and is
interpreted as CapsLock. In this case, the first KeySym is used, but if
that KeySym is lowercase alphabetic, then the corresponding uppercase
@@ -3179,9 +3179,9 @@ KeySym is used instead. <listitem>
<para>
The
-<function>Shift </function>
+<symbol>Shift</symbol>
modifier is on, and the
-<function>Lock </function>
+<symbol>Lock</symbol>
modifier is on and is interpreted
as CapsLock. In this case, the second KeySym is used, but if that KeySym
is lowercase alphabetic, then the corresponding uppercase KeySym is used
@@ -3191,9 +3191,9 @@ instead. <listitem>
<para>
The
-<function>Shift </function>
+<symbol>Shift</symbol>
modifier is on, or the
-<function>Lock </function>
+<symbol>Lock</symbol>
modifier is on and is interpreted
as ShiftLock, or both. In this case, the second KeySym is used.
</para>
@@ -3217,7 +3217,7 @@ To obtain the legal KeyCodes for a display, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDisplayKeycodes</function></funcdef>
+ <funcdef><function>XDisplayKeycodes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int*min_keycodes_return,<parameter> *max_keycodes_return</parameter></paramdef>
</funcprototype>
@@ -3276,7 +3276,7 @@ To obtain the symbols for the specified KeyCodes, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>KeySym<function> *XGetKeyboardMapping</function></funcdef>
+ <funcdef>KeySym *<function>XGetKeyboardMapping</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>KeyCode<parameter> first_keycode</parameter></paramdef>
<paramdef>int<parameter> keycode_count</parameter></paramdef>
@@ -3339,11 +3339,11 @@ The value specified in first_keycode must be greater than or equal to min_keycode as returned by
<function>XDisplayKeycodes</function>,
or a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error results.
In addition, the following expression must be less than or equal
to max_keycode as returned by
-<function>XDisplayKeycodes :</function>
+<function>XDisplayKeycodes</function>:
</para>
<para>
<!-- .LP -->
@@ -3354,7 +3354,7 @@ first_keycode + keycode_count - 1 <para>
<!-- .LP -->
If this is not the case, a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error results.
The number of elements in the KeySyms list is:
</para>
@@ -3377,7 +3377,7 @@ in the list, counting from zero: The X server arbitrarily chooses the keysyms_per_keycode_return value
to be large enough to report all requested symbols.
A special KeySym value of
-<function>NoSymbol </function>
+<symbol>NoSymbol</symbol>
is used to fill in unused elements for
individual KeyCodes.
To free the storage returned by
@@ -3389,7 +3389,7 @@ use <!-- .LP -->
<function>XGetKeyboardMapping</function>
can generate a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error.
</para>
<para>
@@ -3401,7 +3401,7 @@ To change the keyboard mapping, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XChangeKeyboardMapping</function></funcdef>
+ <funcdef><function>XChangeKeyboardMapping</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> first_keycode</parameter></paramdef>
<paramdef>int<parameter> keysyms_per_keycode</parameter></paramdef>
@@ -3486,13 +3486,13 @@ The specified first_keycode must be greater than or equal to min_keycode returned by
<function>XDisplayKeycodes</function>,
or a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error results.
In addition, the following expression must be less than or equal to
max_keycode as returned by
<function>XDisplayKeycodes</function>,
or a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error results:
</para>
<para>
@@ -3517,16 +3517,16 @@ in keysyms, counting from zero: The specified keysyms_per_keycode can be chosen arbitrarily by the client
to be large enough to hold all desired symbols.
A special KeySym value of
-<function>NoSymbol </function>
+<symbol>NoSymbol</symbol>
should be used to fill in unused elements
for individual KeyCodes.
It is legal for
-<function>NoSymbol </function>
+<symbol>NoSymbol</symbol>
to appear in nontrailing positions
of the effective list for a KeyCode.
<function>XChangeKeyboardMapping</function>
generates a
-<function>MappingNotify </function>
+<symbol>MappingNotify</symbol>
event.
</para>
<para>
@@ -3538,15 +3538,15 @@ It is merely stored for reading and writing by clients. <!-- .LP -->
<function>XChangeKeyboardMapping</function>
can generate
-<function>BadAlloc </function>
+<errorname>BadAlloc</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
<!-- .LP -->
The next six functions make use of the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
data structure, which contains:
</para>
<para>
@@ -3566,14 +3566,14 @@ typedef struct { <!-- .LP -->
<!-- .eM -->
To create an
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure, use
<function>XNewModifiermap</function>.
<indexterm significance="preferred"><primary>XNewModifiermap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XModifierKeymap<function> *XNewModifiermap</function></funcdef>
+ <funcdef>XModifierKeymap *<function>XNewModifiermap</function></funcdef>
<paramdef>int<parameter> max_keys_per_mod</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3598,21 +3598,21 @@ in the map. The
<function>XNewModifiermap</function>
function returns a pointer to
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure for later use.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To add a new entry to an
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure, use
<function>XInsertModifiermapEntry</function>.
<indexterm significance="preferred"><primary>XInsertModifiermapEntry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XModifierKeymap<function> *XInsertModifiermapEntry</function></funcdef>
+ <funcdef>XModifierKeymap *<function>XInsertModifiermapEntry</function></funcdef>
<paramdef>XModifierKeymap<parameter> *modmap</parameter></paramdef>
<paramdef>KeyCode<parameter> keycode_entry</parameter></paramdef>
<paramdef>int<parameter> modifier</parameter></paramdef>
@@ -3627,7 +3627,7 @@ structure, use <listitem>
<para>
Specifies the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure.
</para>
</listitem>
@@ -3661,21 +3661,21 @@ The <function>XInsertModifiermapEntry</function>
function adds the specified KeyCode to the set that controls the specified
modifier and returns the resulting
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure (expanded as needed).
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To delete an entry from an
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure, use
<function>XDeleteModifiermapEntry</function>.
<indexterm significance="preferred"><primary>XDeleteModifiermapEntry</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XModifierKeymap<function> *XDeleteModifiermapEntry</function></funcdef>
+ <funcdef>XModifierKeymap *<function>XDeleteModifiermapEntry</function></funcdef>
<paramdef>XModifierKeymap<parameter> *modmap</parameter></paramdef>
<paramdef>KeyCode<parameter> keycode_entry</parameter></paramdef>
<paramdef>int<parameter> modifier</parameter></paramdef>
@@ -3690,7 +3690,7 @@ structure, use <listitem>
<para>
Specifies the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure.
</para>
</listitem>
@@ -3724,21 +3724,21 @@ The <function>XDeleteModifiermapEntry</function>
function deletes the specified KeyCode from the set that controls the
specified modifier and returns a pointer to the resulting
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To destroy an
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure, use
<function>XFreeModifiermap</function>.
<indexterm significance="preferred"><primary>XFreeModifiermap</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XFreeModifiermap</function></funcdef>
+ <funcdef><function>XFreeModifiermap</function></funcdef>
<paramdef>XModifierKeymap<parameter> *modmap</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3751,7 +3751,7 @@ structure, use <listitem>
<para>
Specifies the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure.
</para>
</listitem>
@@ -3764,7 +3764,7 @@ structure. The
<function>XFreeModifiermap</function>
function frees the specified
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure.
</para>
<para>
@@ -3776,7 +3776,7 @@ To set the KeyCodes to be used as modifiers, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XSetModifierMapping</function></funcdef>
+ <funcdef>int <function>XSetModifierMapping</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XModifierKeymap<parameter> *modmap</parameter></paramdef>
</funcprototype>
@@ -3800,7 +3800,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure.
</para>
</listitem>
@@ -3816,41 +3816,41 @@ function specifies the KeyCodes of the keys (if any) that are to be used as modifiers.
If it succeeds,
the X server generates a
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
event, and
<function>XSetModifierMapping</function>
returns
-<function>MappingSuccess</function>.
+<symbol>MappingSuccess</symbol>.
X permits at most 8 modifier keys.
If more than 8 are specified in the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure, a
-<function>BadLength</function>
+<errorname>BadLength</errorname>
error results.
</para>
<para>
<!-- .LP -->
The modifiermap member of the
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure contains 8 sets of max_keypermod KeyCodes,
one for each modifier in the order
-<function>Shift</function>,
-<function>Lock</function>,
-<function>Control</function>,
-<function>Mod1</function>,
-<function>Mod2</function>,
-<function>Mod3</function>,
-<function>Mod4</function>,
+<symbol>Shift</symbol>,
+<symbol>Lock</symbol>,
+<symbol>Control</symbol>,
+<symbol>Mod1</symbol>,
+<symbol>Mod2</symbol>,
+<symbol>Mod3</symbol>,
+<symbol>Mod4</symbol>,
and
-<function>Mod5</function>.
+<symbol>Mod5</symbol>.
Only nonzero KeyCodes have meaning in each set,
and zero KeyCodes are ignored.
In addition, all of the nonzero KeyCodes must be in the range specified by
min_keycode and max_keycode in the
-<function>Display </function>
+<type>Display</type>
structure,
or a
-<function>BadValue </function>
+<errorname>BadValue</errorname>
error results.
</para>
<para>
@@ -3862,23 +3862,23 @@ if auto-repeat cannot be disabled on certain keys, or if multiple modifier keys are not supported.
If some such restriction is violated,
the status reply is
-<function>MappingFailed</function>,
+<symbol>MappingFailed</symbol>,
and none of the modifiers are changed.
If the new KeyCodes specified for a modifier differ from those
currently defined and any (current or new) keys for that modifier are
in the logically down state,
<function>XSetModifierMapping</function>
returns
-<function>MappingBusy</function>,
+<symbol>MappingBusy</symbol>,
and none of the modifiers is changed.
</para>
<para>
<!-- .LP -->
<function>XSetModifierMapping</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadValue </function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
@@ -3890,7 +3890,7 @@ To obtain the KeyCodes used as modifiers, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XModifierKeymap<function> *XGetModifierMapping</function></funcdef>
+ <funcdef>XModifierKeymap *<function>XGetModifierMapping</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3914,7 +3914,7 @@ Specifies the connection to the X server. The
<function>XGetModifierMapping</function>
function returns a pointer to a newly created
-<function>XModifierKeymap</function>
+<structname>XModifierKeymap</structname>
structure that contains the keys being used as modifiers.
The structure should be freed after use by calling
<function>XFreeModifiermap</function>.
diff --git a/libX11/specs/libX11/CH13.xml b/libX11/specs/libX11/CH13.xml index 06564c3da..f7809f665 100644 --- a/libX11/specs/libX11/CH13.xml +++ b/libX11/specs/libX11/CH13.xml @@ -105,14 +105,14 @@ To determine if the current locale is supported by X, use The
<function>XSupportsLocale</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if Xlib functions are capable of operating under the current locale.
If it returns
-<function>False</function>,
+<symbol>False</symbol>,
Xlib locale-dependent functions for which the
-<function>XLocaleNotSupported </function>
+<symbol>XLocaleNotSupported</symbol>
return status is defined will return
-<function>XLocaleNotSupported</function>.
+<symbol>XLocaleNotSupported</symbol>.
Other Xlib locale-dependent routines will operate in the ``C'' locale.
</para>
<para>
@@ -145,7 +145,7 @@ To configure Xlib locale modifiers for the current locale, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XSetLocaleModifiers</function></funcdef>
+ <funcdef>char *<function>XSetLocaleModifiers</function></funcdef>
<paramdef>char<parameter> *modifier_list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -321,16 +321,16 @@ the following table describes the locale (and modifiers) dependency: <row>
<entry><function>setlocale</function></entry>
<entry><function>XrmGetFileDatabase</function></entry>
- <entry>Locale of <function>XrmDatabase</function></entry>
+ <entry>Locale of <type>XrmDatabase</type></entry>
</row>
<row>
<entry></entry>
<entry><function>XrmGetStringDatabase</function></entry>
</row>
<row>
- <entry><function>XrmDatabase</function></entry>
+ <entry><type>XrmDatabase</type></entry>
<entry><function>XrmPutFileDatabase</function></entry>
- <entry>Locale of <function>XrmDatabase</function></entry>
+ <entry>Locale of <type>XrmDatabase</type></entry>
</row>
<row>
<entry></entry>
@@ -390,7 +390,7 @@ the following table describes the locale (and modifiers) dependency: <entry><acronym>XIM</acronym> selection</entry>
</row>
<row>
- <entry><function>XIM</function></entry>
+ <entry><type>XIM</type></entry>
<entry><function>XCreateIC</function></entry>
<entry><acronym>XIC</acronym> input method configuration</entry>
</row>
@@ -400,7 +400,7 @@ the following table describes the locale (and modifiers) dependency: <entry>Queried locale</entry>
</row>
<row>
- <entry><function>XIC</function></entry>
+ <entry><type>XIC</type></entry>
<entry><function>XmbLookupString</function></entry>
<entry>Keyboard layout</entry>
</row>
@@ -427,7 +427,7 @@ the following table describes the locale (and modifiers) dependency: <entry>Charsets of fonts in XFontSet</entry>
</row>
<row>
- <entry><function>XOM</function></entry>
+ <entry><type>XOM</type></entry>
<entry><function>XCreateOC</function></entry>
<entry><acronym>XOC</acronym> output method configuration</entry>
</row>
@@ -437,7 +437,7 @@ the following table describes the locale (and modifiers) dependency: <entry>Queried locale</entry>
</row>
<row>
- <entry><function>XFontSet</function></entry>
+ <entry><type>XFontSet</type></entry>
<entry><function>XmbDrawText</function>,</entry>
<entry>Locale of supplied text</entry>
</row>
@@ -520,17 +520,17 @@ to the ANSI C variable argument list calling convention. Each function denoted with an argument of the form ``...'' takes
a variable-length list of name and value pairs,
where each name is a string and each value is of type
-<function>XPointer</function>.
+<type>XPointer</type>.
A name argument that is NULL identifies the end of the list.
</para>
<para>
<!-- .LP -->
A variable-length argument list may contain a nested list.
If the name
-<function>XNVaNestedList</function>
+<symbol>XNVaNestedList</symbol>
is specified in place of an argument name,
then the following value is interpreted as an
-<function>XVaNestedList</function>
+<type>XVaNestedList</type>
value that specifies a list of values logically inserted into the
original list at the point of declaration.
A NULL identifies the end of a nested list.
@@ -544,7 +544,7 @@ To allocate a nested variable argument list dynamically, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XVaNestedList<function> XVaCreateNestedList</function></funcdef>
+ <funcdef>XVaNestedList <function>XVaCreateNestedList</function></funcdef>
<paramdef>int<parameter> dummy</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -706,14 +706,14 @@ the output method for clients. <!-- .LP -->
The abstraction used to communicate with an output method
is an opaque data structure represented by the
-<function>XOM</function>
+<type>XOM</type>
data type.
The abstraction for representing the state of a particular output thread
is called an <emphasis remap='I'>output context</emphasis>.
The Xlib representation of an output context is an
-<function>XOC</function>,
+<type>XOC</type>,
which is compatible with
-<function>XFontSet</function>
+<type>XFontSet</type>
in terms of its functional interface, but is
a broader, more generalized abstraction.
</para>
@@ -731,7 +731,7 @@ To open an output method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XOM<function> XOpenOM</function></funcdef>
+ <funcdef>XOM <function>XOpenOM</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XrmDatabase<parameter> db</parameter></paramdef>
<paramdef>char<parameter> *res_name</parameter></paramdef>
@@ -849,7 +849,7 @@ To close an output method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XCloseOM</function></funcdef>
+ <funcdef>Status <function>XCloseOM</function></funcdef>
<paramdef>XOM<parameter> om</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -883,7 +883,7 @@ To set output method attributes, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XSetOMValues</function></funcdef>
<paramdef>XOM<parameter> om</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -936,7 +936,7 @@ To query an output method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XGetOMValues</function></funcdef>
<paramdef>XOM<parameter> om</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -984,7 +984,7 @@ To obtain the display associated with an output method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Display<function> *</function></funcdef>
+ <funcdef>Display *<function>XDisplayOfOM</function></funcdef>
<paramdef>XOM<parameter> om</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1018,7 +1018,7 @@ To get the locale associated with an output method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XLocaleOfOM</function></funcdef>
<paramdef>XOM<parameter> om</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1095,19 +1095,19 @@ The following key applies to this table. </thead>
<tbody>
<row>
- <entry><function>XNRequiredCharSet</function></entry>
+ <entry><symbol>XNRequiredCharSet</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNQueryOrientation</function></entry>
+ <entry><symbol>XNQueryOrientation</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNDirectionalDependentDrawing</function></entry>
+ <entry><symbol>XNDirectionalDependentDrawing</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNContextualDrawing</function></entry>
+ <entry><symbol>XNContextualDrawing</symbol></entry>
<entry>G</entry>
</row>
</tbody>
@@ -1125,16 +1125,16 @@ The following key applies to this table. <para>
<!-- .LP -->
The
-<function>XNRequiredCharSet</function>
+<symbol>XNRequiredCharSet</symbol>
argument returns the list of charsets that are required for loading the fonts
needed for the locale.
The value of the argument is a pointer to a structure of type
-<function>XOMCharSetList</function>.
+<structname>XOMCharSetList</structname>.
</para>
<para>
<!-- .LP -->
The
-<function>XOMCharSetList</function>
+<structname>XOMCharSetList</structname>
structure is defined as follows:
<indexterm significance="preferred"><primary>XOMCharSetList</primary></indexterm>
<!-- .sM -->
@@ -1163,7 +1163,7 @@ freed by the client. It will be freed by a call to
<function>XCloseOM</function>
with the associated
-<function>XOM</function>.
+<type>XOM</type>.
Until freed, its contents will not be modified by Xlib.
</para>
<para>
@@ -1178,15 +1178,15 @@ Until freed, its contents will not be modified by Xlib. <para>
<!-- .LP -->
The
-<function>XNQueryOrientation</function>
+<symbol>XNQueryOrientation</symbol>
argument returns the global orientation of text when drawn.
Other than
-<function>XOMOrientation_LTR_TTB</function>,
+<constant>XOMOrientation_LTR_TTB</constant>,
the set of orientations supported is locale-dependent.
The value of the argument is a pointer to a structure of type
-<function>XOMOrientation</function>.
+<structname>XOMOrientation</structname>.
Clients are responsible for freeing the
-<function>XOMOrientation</function>
+<structname>XOMOrientation</structname>
structure by using
<function>XFree</function>;
this also frees the contents of the structure.
@@ -1219,31 +1219,31 @@ The possible value for XOrientation may be: <itemizedlist>
<listitem>
<para>
-<function>XOMOrientation_LTR_TTB </function>
+<constant>XOMOrientation_LTR_TTB</constant>
left-to-right, top-to-bottom global orientation
</para>
</listitem>
<listitem>
<para>
-<function>XOMOrientation_RTL_TTB </function>
+<constant>XOMOrientation_RTL_TTB</constant>
right-to-left, top-to-bottom global orientation
</para>
</listitem>
<listitem>
<para>
-<function>XOMOrientation_TTB_LTR </function>
+<constant>XOMOrientation_TTB_LTR</constant>
top-to-bottom, left-to-right global orientation
</para>
</listitem>
<listitem>
<para>
-<function>XOMOrientation_TTB_RTL </function>
+<constant>XOMOrientation_TTB_RTL</constant>
top-to-bottom, right-to-left global orientation
</para>
</listitem>
<listitem>
<para>
-<function>XOMOrientation_Context </function>
+<constant>XOMOrientation_Context</constant>
contextual global orientation
</para>
</listitem>
@@ -1260,15 +1260,15 @@ contextual global orientation <para>
<!-- .LP -->
The
-<function>XNDirectionalDependentDrawing</function>
+<symbol>XNDirectionalDependentDrawing</symbol>
argument indicates whether the text rendering functions
implement implicit handling of directional text. If this value
is
-<function>True</function>,
+<symbol>True</symbol>,
the output method has knowledge of directional
dependencies and reorders text as necessary when
rendering text. If this value is
-<function>False</function>,
+<symbol>False</symbol>,
the output method does not implement any directional text
handling, and all character directions are assumed to be left-to-right.
</para>
@@ -1293,10 +1293,10 @@ function. <para>
<!-- .LP -->
The
-<function>XNContextualDrawing</function>
+<symbol>XNContextualDrawing</symbol>
argument indicates whether the text rendering functions
implement implicit context-dependent drawing. If this value is
-<function>True</function>,
+<symbol>True</symbol>,
the output method has knowledge of context dependencies and
performs character shape editing, combining glyphs to present
a single character as necessary. The actual shape editing is
@@ -1328,22 +1328,22 @@ It is intended that output methods be controlled by these <acronym>XOC</acronym> As new <acronym>XOC</acronym> values are created,
they should be registered with the X Consortium.
An
-<function>XOC</function>
+<type>XOC</type>
can be used anywhere an
-<function>XFontSet</function>
+<type>XFontSet</type>
can be used, and vice versa;
-<function>XFontSet</function>
+<type>XFontSet</type>
is retained for compatibility with previous releases.
The concepts of output methods and output contexts include broader,
more generalized abstraction than font set,
supporting complex and more intelligent text display, and dealing not only
with multiple fonts but also with context dependencies.
However,
-<function>XFontSet</function>
+<type>XFontSet</type>
is widely used in several interfaces, so
-<function>XOC</function>
+<type>XOC</type>
is defined as an upward compatible type of
-<function>XFontSet</function>.
+<type>XFontSet</type>.
</para>
<para>
<!-- .LP -->
@@ -1354,7 +1354,7 @@ To create an output context, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XOC<function> XCreateOC</function></funcdef>
+ <funcdef>XOC <function>XCreateOC</function></funcdef>
<paramdef>XOM<parameter> om</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1387,7 +1387,7 @@ Specifies the variable-length argument list(Al. <!-- .LP -->
<!-- .eM -->
The
-<function>XCreateOC </function>
+<function>XCreateOC</function>
function creates an output context within the specified output method.
</para>
<para>
@@ -1428,7 +1428,7 @@ The output method encountered an output method implementation-dependent error. <!-- .LP -->
<function>XCreateOC</function>
can generate a
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
error.
</para>
<para>
@@ -1440,7 +1440,7 @@ To destroy an output context, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XDestroyOC</function></funcdef>
+ <funcdef>void <function>XDestroyOC</function></funcdef>
<paramdef>XOC<parameter> oc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1474,7 +1474,7 @@ To get the output method associated with an output context, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XOM<function> XOMOfOC</function></funcdef>
+ <funcdef>XOM <function>XOMOfOC</function></funcdef>
<paramdef>XOC<parameter> oc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1521,7 +1521,7 @@ To set <acronym>XOC</acronym> values, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XSetOCValues</function></funcdef>
<paramdef>XOC<parameter> oc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1586,7 +1586,7 @@ matching the data type imposed by the semantics of the argument. <!-- .LP -->
<function>XSetOCValues</function>
can generate a
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
error.
</para>
<para>
@@ -1598,7 +1598,7 @@ To obtain <acronym>XOC</acronym> values, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XGetOCValues</function></funcdef>
<paramdef>XOC<parameter> oc</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1774,7 +1774,7 @@ The following keys apply to this table. <para>
<!-- .LP -->
The
-<function>XNBaseFontName</function>
+<symbol>XNBaseFontName</symbol>
argument is a list of base font names that Xlib uses
to load the fonts needed for the locale.
The base font names are a comma-separated list. The string is null-terminated
@@ -1817,7 +1817,7 @@ returns NULL. <para>
<!-- .LP -->
When querying for the
-<function>XNBaseFontName</function>
+<symbol>XNBaseFontName</symbol>
<acronym>XOC</acronym> value,
<function>XGetOCValues</function>
returns a null-terminated string identifying the base font names that
@@ -1827,7 +1827,7 @@ the client. The string will be freed by a call to
<function>XDestroyOC</function>
with the associated
-<function>XOC</function>.
+<type>XOC</type>.
Until freed, the string contents will not be modified by Xlib.
</para>
</sect3>
@@ -1839,11 +1839,11 @@ Until freed, the string contents will not be modified by Xlib. <para>
<!-- .LP -->
The
-<function>XNMissingCharSet</function>
+<symbol>XNMissingCharSet</symbol>
argument returns the list of required charsets that are missing from the
font set.
The value of the argument is a pointer to a structure of type
-<function>XOMCharSetList</function>.
+<structname>XOMCharSetList</structname>.
</para>
<para>
<!-- .LP -->
@@ -1864,7 +1864,7 @@ freed by the client. It will be freed by a call to
<function>XDestroyOC</function>
with the associated
-<function>XOC</function>.
+<type>XOC</type>.
Until freed, its contents will not be modified by Xlib.
</para>
</sect3>
@@ -1876,14 +1876,14 @@ Until freed, its contents will not be modified by Xlib. <para>
<!-- .LP -->
When a drawing or measuring function is called with an
-<function>XOC</function>
+<type>XOC</type>
that has missing charsets, some characters in the locale will not be
drawable.
The
-<function>XNDefaultString</function>
+<symbol>XNDefaultString</symbol>
argument returns a pointer to a string that represents the glyphs
that are drawn with this
-<function>XOC</function>
+<type>XOC</type>
when the charsets of the available fonts do not include all glyphs
required to draw a character.
The string does not necessarily consist of valid characters
@@ -1891,12 +1891,12 @@ in the current locale and is not necessarily drawn with the fonts loaded for the font set,
but the client can draw or measure the default glyphs
by including this string in a string being drawn or measured with the
-<function>XOC</function>.
+<type>XOC</type>.
</para>
<para>
<!-- .LP -->
If the
-<function>XNDefaultString</function>
+<symbol>XNDefaultString</symbol>
argument returned the empty string (""),
no glyphs are drawn and the escapement is zero.
The returned string is null-terminated.
@@ -1904,7 +1904,7 @@ It is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to
<function>XDestroyOC</function>
with the associated
-<function>XOC</function>.
+<type>XOC</type>.
Until freed, its contents will not be modified by Xlib.
</para>
</sect3>
@@ -1916,39 +1916,39 @@ Until freed, its contents will not be modified by Xlib. <para>
<!-- .LP -->
The
-<function>XNOrientation</function>
+<symbol>XNOrientation</symbol>
argument specifies the current orientation of text when drawn. The value of
this argument is one of the values returned by the
<function>XGetOMValues</function>
function with the
-<function>XNQueryOrientation</function>
+<symbol>XNQueryOrientation</symbol>
argument specified in the
-<function>XOrientation</function>
+<type>XOrientation</type>
list.
The value of the argument is of type
-<function>XOrientation</function>.
+<type>XOrientation</type>.
When
-<function>XNOrientation</function>
+<symbol>XNOrientation</symbol>
is queried, the value specifies the current orientation.
When
-<function>XNOrientation</function>
+<symbol>XNOrientation</symbol>
is set, a value is used to set the current orientation.
</para>
<para>
<!-- .LP -->
When
-<function>XOMOrientation_Context</function>
+<constant>XOMOrientation_Context</constant>
is set, the text orientation of the
text is determined according to an implementation-defined method
(for example, ISO 6429 control sequences), and the initial text orientation for
locale-dependent Xlib functions is assumed to
be
-<function>XOMOrientation_LTR_TTB</function>.
+<constant>XOMOrientation_LTR_TTB</constant>.
</para>
<para>
<!-- .LP -->
The
-<function>XNOrientation</function>
+<symbol>XNOrientation</symbol>
value does not change the prime drawing direction
for Xlib drawing functions.
</para>
@@ -1961,9 +1961,9 @@ for Xlib drawing functions. <para>
<!-- .LP -->
The
-<function>XNResourceName</function>
+<symbol>XNResourceName</symbol>
and
-<function>XNResourceClass</function>
+<symbol>XNResourceClass</symbol>
arguments are strings that specify the full name and class
used by the client to obtain resources for the display of the output context.
These values should be used as prefixes for name and class
@@ -1979,9 +1979,9 @@ set as resources. <para>
<!-- .LP -->
When querying for the
-<function>XNResourceName</function>
+<symbol>XNResourceName</symbol>
or
-<function>XNResourceClass</function>
+<symbol>XNResourceClass</symbol>
<acronym>XOC</acronym> value,
<function>XGetOCValues</function>
returns a null-terminated string.
@@ -1990,7 +1990,7 @@ the client. The string will be freed by a call to
<function>XDestroyOC</function>
with the associated
-<function>XOC</function>
+<type>XOC</type>
or when the associated value is changed via
<function>XSetOCValues</function>.
Until freed, the string contents will not be modified by Xlib.
@@ -2004,13 +2004,13 @@ Until freed, the string contents will not be modified by Xlib. <para>
<!-- .LP -->
The
-<function>XNFontInfo</function>
+<symbol>XNFontInfo</symbol>
argument specifies a list of one or more
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures
and font names for the fonts used for drawing by the given output context.
The value of the argument is a pointer to a structure of type
-<function>XOMFontInfo</function>.
+<structname>XOMFontInfo</structname>.
</para>
<para>
<!-- .LP -->
@@ -2029,13 +2029,13 @@ typedef struct { <!-- .LP -->
<!-- .eM -->
A list of pointers to the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures is returned to font_struct_list.
A list of pointers to null-terminated, fully-specified font name strings
in the locale of the output context is returned to font_name_list.
The font_name_list order corresponds to the font_struct_list order.
The number of
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures and font names is returned to num_font.
</para>
<para>
@@ -2046,31 +2046,31 @@ there is no provision for mapping a character or default string to the font properties, font ID, or direction hint for the font
for the character.
The client may access the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
list to obtain these values for all the fonts currently in use.
</para>
<para>
<!-- .LP -->
Xlib does not guarantee that fonts are loaded from the server
at the creation of an
-<function>XOC</function>.
+<type>XOC</type>.
Xlib may choose to cache font data, loading it only as needed to draw text
or compute text dimensions.
Therefore, existence of the per_char metrics in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures in the
-<function>XFontStructSet</function>
+<structname>XFontStructSet</structname>
is undefined.
Also, note that all properties in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures are in the STRING encoding.
</para>
<para>
<!-- .LP -->
The client must not free the
-<function>XOMFontInfo</function>
+<structname>XOMFontInfo</structname>
struct itself; it will be freed when the
-<function>XOC</function>
+<type>XOC</type>
is closed.
</para>
</sect3>
@@ -2082,7 +2082,7 @@ is closed. <para>
<!-- .LP -->
The
-<function>XNOMAutomatic</function>
+<symbol>XNOMAutomatic</symbol>
argument returns whether the associated output context was created by
<function>XCreateFontSet</function>
or not. Because the
@@ -2096,9 +2096,9 @@ However, it is possible that a client does not know how the output context was created.
Before a client destroys the output context,
it can query whether
-<function>XNOMAutomatic</function>
+<symbol>XNOMAutomatic</symbol>
is set to determine whether
-<function>XFreeFontSet </function>
+<function>XFreeFontSet</function>
or
<function>XDestroyOC</function>
should be used to destroy the output context.
@@ -2117,10 +2117,10 @@ as needed for the locale of the text. Fonts are loaded according to a list of base font names
supplied by the client and the charsets required by the locale.
The
-<function>XFontSet</function>
+<type>XFontSet</type>
is an opaque type representing the state of a particular output thread
and is equivalent to the type
-<function>XOC</function>.
+<type>XOC</type>.
</para>
<para>
<!-- .LP -->
@@ -2129,15 +2129,15 @@ The <function>XCreateFontSet</function>
function is a convenience function for creating an output context using
only default values. The returned
-<function>XFontSet</function>
+<type>XFontSet</type>
has an implicitly created
-<function>XOM</function>.
+<type>XOM</type>.
This
-<function>XOM</function>
+<type>XOM</type>
has an OM value
-<function>XNOMAutomatic</function>
+<symbol>XNOMAutomatic</symbol>
automatically set to
-<function>True</function>
+<symbol>True</symbol>
so that the output context self indicates whether it was created by
<function>XCreateOC</function>
or
@@ -2146,7 +2146,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XFontSet<function> XCreateFontSet</function></funcdef>
+ <funcdef>XFontSet <function>XCreateFontSet</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *base_font_name_list</parameter></paramdef>
<paramdef>char<parameter> ***missing_charset_list_return</parameter></paramdef>
@@ -2256,7 +2256,7 @@ function will return this <acronym>XLFD</acronym> name instead of the client-sup <!-- .LP -->
Xlib uses the following algorithm to select the fonts
that will be used to display text with the
-<function>XFontSet</function>.
+<type>XFontSet</type>.
</para>
<para>
<!-- .LP -->
@@ -2269,9 +2269,9 @@ of the following cases that names a set of fonts that exist at the server: <para>
The first <acronym>XLFD</acronym>-conforming base font name that specifies the required
charset or a superset of the required charset in its
-<function>CharSetRegistry</function>
+<structfield>CharSetRegistry</structfield>
and
-<function>CharSetEncoding</function>
+<structfield>CharSetEncoding</structfield>
fields.
The implementation may use a base font name whose specified charset
is a superset of the required charset, for example,
@@ -2297,9 +2297,9 @@ if a JIS Roman font is not available. The first <acronym>XLFD</acronym>-conforming font name or the first non-<acronym>XLFD</acronym> font name
for which an <acronym>XLFD</acronym> font name can be obtained, combined with the
required charset (replacing the
-<function>CharSetRegistry</function>
+<structfield>CharSetRegistry</structfield>
and
-<function>CharSetEncoding</function>
+<structfield>CharSetEncoding</structfield>
fields in the <acronym>XLFD</acronym> font name).
As in case 1,
the implementation may use a charset that is a superset
@@ -2384,7 +2384,7 @@ is set to zero. If fonts exist for all of the charsets required by the current locale,
<function>XCreateFontSet</function>
returns a valid
-<function>XFontSet</function>,
+<type>XFontSet</type>,
missing_charset_list_return is set to NULL,
and missing_charset_count_return is set to zero.
</para>
@@ -2409,20 +2409,20 @@ returns NULL. Otherwise,
<function>XCreateFontSet</function>
returns a valid
-<function>XFontSet</function>
+<type>XFontSet</type>
to font_set.
</para>
<para>
<!-- .LP -->
When an Xmb/wc drawing or measuring function is called with an
-<function>XFontSet</function>
+<type>XFontSet</type>
that has missing charsets, some characters in the locale will not be
drawable.
If def_string_return is non-NULL,
<function>XCreateFontSet</function>
returns a pointer to a string that represents the glyphs
that are drawn with this
-<function>XFontSet</function>
+<type>XFontSet</type>
when the charsets of the available fonts do not include all font glyphs
required to draw a codepoint.
The string does not necessarily consist of valid characters
@@ -2430,7 +2430,7 @@ in the current locale and is not necessarily drawn with the fonts loaded for the font set,
but the client can draw and measure the default glyphs
by including this string in a string being drawn or measured with the
-<function>XFontSet</function>.
+<type>XFontSet</type>.
</para>
<para>
<!-- .LP -->
@@ -2441,7 +2441,7 @@ It is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to
<function>XFreeFontSet</function>
with the associated
-<function>XFontSet</function>.
+<type>XFontSet</type>.
Until freed, its contents will not be modified by Xlib.
</para>
<para>
@@ -2453,7 +2453,7 @@ operation in the case that some fonts did not exist. <para>
<!-- .LP -->
The returned
-<function>XFontSet</function>
+<type>XFontSet</type>
and missing charset list should be freed with
<function>XFreeFontSet</function>
and
@@ -2467,16 +2467,16 @@ by the client after calling <!-- .LP -->
<!-- .sp -->
To obtain a list of
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures and full font names given an
-<function>XFontSet</function>,
+<type>XFontSet</type>,
use
<function>XFontsOfFontSet</function>.
<indexterm significance="preferred"><primary>XFontsOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XFontsOfFontSet</function></funcdef>
+ <funcdef>int <function>XFontsOfFontSet</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>XFontStruct<parameter> ***font_struct_list_return</parameter></paramdef>
<paramdef>char<parameter> ***font_name_list_return</parameter></paramdef>
@@ -2522,17 +2522,17 @@ Returns the list of font names. The
<function>XFontsOfFontSet</function>
function returns a list of one or more
-<function>XFontStructs</function>
+<structname>XFontStruct</structname>s
and font names for the fonts used by the Xmb and Xwc layers
for the given font set.
A list of pointers to the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures is returned to font_struct_list_return.
A list of pointers to null-terminated, fully specified font name strings
in the locale of the font set is returned to font_name_list_return.
The font_name_list order corresponds to the font_struct_list order.
The number of
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures and font names is returned as the value of the function.
</para>
<para>
@@ -2543,49 +2543,49 @@ there is no provision for mapping a character or default string to the font properties, font ID, or direction hint for the font
for the character.
The client may access the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
list to obtain these values for all the fonts currently in use.
</para>
<para>
<!-- .LP -->
Xlib does not guarantee that fonts are loaded from the server
at the creation of an
-<function>XFontSet</function>.
+<type>XFontSet</type>.
Xlib may choose to cache font data, loading it only as needed to draw text
or compute text dimensions.
Therefore, existence of the per_char metrics in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures in the
-<function>XFontStructSet</function>
+<structname>XFontStructSet</structname>
is undefined.
Also, note that all properties in the
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
structures are in the STRING encoding.
</para>
<para>
<!-- .LP -->
The
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
and font name lists are owned by Xlib
and should not be modified or freed by the client.
They will be freed by a call to
<function>XFreeFontSet</function>
with the associated
-<function>XFontSet</function>.
+<type>XFontSet</type>.
Until freed, their contents will not be modified by Xlib.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain the base font name list and the selected font name list given an
-<function>XFontSet</function>,
+<type>XFontSet</type>,
use
<function>XBaseFontNameListOfFontSet</function>.
<indexterm significance="preferred"><primary>XBaseFontNameListOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XBaseFontNameListOfFontSet</function></funcdef>
+ <funcdef>char *<function>XBaseFontNameListOfFontSet</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2610,7 +2610,7 @@ The <function>XBaseFontNameListOfFontSet</function>
function returns the original base font name list supplied
by the client when the
-<function>XFontSet</function>
+<type>XFontSet</type>
was created.
A null-terminated string containing a list of
comma-separated font names is returned
@@ -2633,21 +2633,21 @@ freed by the client. It will be freed by a call to
<function>XFreeFontSet</function>
with the associated
-<function>XFontSet</function>.
+<type>XFontSet</type>.
Until freed, its contents will not be modified by Xlib.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain the locale name given an
-<function>XFontSet</function>,
+<type>XFontSet</type>,
use
<function>XLocaleOfFontSet</function>.
<indexterm significance="preferred"><primary>XLocaleOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *XLocaleOfFontSet</function></funcdef>
+ <funcdef>char *<function>XLocaleOfFontSet</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2672,7 +2672,7 @@ The <function>XLocaleOfFontSet</function>
function
returns the name of the locale bound to the specified
-<function>XFontSet</function>,
+<type>XFontSet</type>,
as a null-terminated string.
</para>
<para>
@@ -2682,7 +2682,7 @@ and should not be modified or freed by the client. It may be freed by a call to
<function>XFreeFontSet</function>
with the associated
-<function>XFontSet</function>.
+<type>XFontSet</type>.
Until freed, it will not be modified by Xlib.
</para>
<para>
@@ -2691,16 +2691,16 @@ Until freed, it will not be modified by Xlib. The
<function>XFreeFontSet</function>
function is a convenience function for freeing an output context.
-<function>XFreeFontSet </function>
+<function>XFreeFontSet</function>
also frees its associated
-<function>XOM</function>
+<type>XOM</type>
if the output context was created by
<function>XCreateFontSet</function>.
<indexterm significance="preferred"><primary>XFreeFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XFreeFontSet</function></funcdef>
+ <funcdef>void <function>XFreeFontSet</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
@@ -2736,9 +2736,9 @@ The <function>XFreeFontSet</function>
function frees the specified font set.
The associated base font name list, font name list,
-<function>XFontStruct</function>
+<structname>XFontStruct</structname>
list, and
-<function>XFontSetExtents</function>,
+<structname>XFontSetExtents</structname>,
if any, are freed.
</para>
</sect2>
@@ -2804,7 +2804,7 @@ To find out about direction-dependent rendering, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XDirectionalDependentDrawing</function></funcdef>
+ <funcdef>Bool <function>XDirectionalDependentDrawing</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2828,10 +2828,10 @@ Specifies the font set. The
<function>XDirectionalDependentDrawing</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if the drawing functions implement implicit text directionality;
otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -2842,7 +2842,7 @@ To find out about context-dependent rendering, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XContextualDrawing</function></funcdef>
+ <funcdef>Bool <function>XContextualDrawing</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2866,10 +2866,10 @@ Specifies the font set. The
<function>XContextualDrawing</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if text drawn with the font set might include context-dependent drawing;
otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -2880,7 +2880,7 @@ To find out about context-dependent or direction-dependent rendering, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XContextDependentDrawing</function></funcdef>
+ <funcdef>Bool <function>XContextDependentDrawing</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2904,11 +2904,11 @@ Specifies the font set. The
<function>XContextDependentDrawing</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if the drawing functions implement implicit text directionality or
if text drawn with the font_set might include context-dependent drawing;
otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -2923,7 +2923,7 @@ in a text stream. <!-- .LP -->
The maximum character extents for the fonts that are used by the text
drawing layers can be accessed by the
-<function>XFontSetExtents</function>
+<structname>XFontSetExtents</structname>
structure:
<indexterm significance="preferred"><primary>XFontSetExtents</primary></indexterm>
</para>
@@ -2941,7 +2941,7 @@ typedef struct { <para>
<!-- .LP -->
The
-<function>XRectangle</function>
+<structname>XRectangle</structname>
structures used to return font set metrics are the usual Xlib screen-oriented
rectangles
with x, y giving the upper left corner, and width and height always positive.
@@ -2979,22 +2979,22 @@ individual extent. <para>
<!-- .LP -->
The rectangles for a given character in a string can be obtained from
-<function>XmbPerCharExtents</function>
+<function>XmbTextPerCharExtents</function>
or
-<function>XwcPerCharExtents</function>.
+<function>XwcTextPerCharExtents</function>.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To obtain the maximum extents structure given an
-<function>XFontSet</function>,
+<type>XFontSet</type>,
use
<function>XExtentsOfFontSet</function>.
<indexterm significance="preferred"><primary>XExtentsOfFontSet</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XFontSetExtents<function> *XExtentsOfFontSet</function></funcdef>
+ <funcdef>XFontSetExtents *<function>XExtentsOfFontSet</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3018,20 +3018,20 @@ Specifies the font set. The
<function>XExtentsOfFontSet</function>
function returns an
-<function>XFontSetExtents</function>
+<structname>XFontSetExtents</structname>
structure for the fonts used by the Xmb and Xwc layers
for the given font set.
</para>
<para>
<!-- .LP -->
The
-<function>XFontSetExtents</function>
+<structname>XFontSetExtents</structname>
structure is owned by Xlib and should not be modified
or freed by the client.
It will be freed by a call to
<function>XFreeFontSet</function>
with the associated
-<function>XFontSet</function>.
+<type>XFontSet</type>.
Until freed, its contents will not be modified by Xlib.
</para>
<para>
@@ -3047,7 +3047,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XmbTextEscapement</function></funcdef>
+ <funcdef>int <function>XmbTextEscapement</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_bytes</parameter></paramdef>
@@ -3056,7 +3056,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XwcTextEscapement</function></funcdef>
+ <funcdef>int <function>XwcTextEscapement</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>wchar_t<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_wchars</parameter></paramdef>
@@ -3139,7 +3139,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XmbTextExtents</function></funcdef>
+ <funcdef>int <function>XmbTextExtents</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_bytes</parameter></paramdef>
@@ -3150,7 +3150,7 @@ use <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XwcTextExtents</function></funcdef>
+ <funcdef>int <function>XwcTextExtents</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>wchar_t<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_wchars</parameter></paramdef>
@@ -3265,11 +3265,11 @@ should not intersect this rectangle. <para>
<!-- .LP -->
When the
-<function>XFontSet</function>
+<type>XFontSet</type>
has missing charsets,
metrics for each unavailable character are taken
from the default string returned by
-<function>XCreateFontSet </function>
+<function>XCreateFontSet</function>
so that the metrics represent the text as it will actually be drawn.
The behavior for an invalid codepoint is undefined.
</para>
@@ -3299,7 +3299,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XmbTextPerCharExtents</function></funcdef>
+ <funcdef>Status <function>XmbTextPerCharExtents</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_bytes</parameter></paramdef>
@@ -3314,7 +3314,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XwcTextPerCharExtents</function></funcdef>
+ <funcdef>Status <function>XwcTextPerCharExtents</function></funcdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
<paramdef>wchar_t<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_wchars</parameter></paramdef>
@@ -3462,19 +3462,19 @@ logical_array_return rectangles. <para>
<!-- .LP -->
Note that an
-<function>XRectangle</function>
+<structname>XRectangle</structname>
represents the effective drawing dimensions of the character,
regardless of the number of font glyphs that are used to draw
the character or the direction in which the character is drawn.
If multiple characters map to a single character glyph,
the dimensions of all the
-<function>XRectangles</function>
+<structname>XRectangle</structname>s
of those characters are the same.
</para>
<para>
<!-- .LP -->
When the
-<function>XFontSet</function>
+<type>XFontSet</type>
has missing charsets, metrics for each unavailable
character are taken from the default string returned by
<function>XCreateFontSet</function>
@@ -3521,7 +3521,7 @@ instead of treating the bytes of the string as direct font indexes. See section 8.6 for details of the use of Graphics Contexts (GCs)
and possible protocol errors.
If a
-<function>BadFont</function>
+<errorname>BadFont</errorname>
error is generated,
characters prior to the offending character may have been drawn.
</para>
@@ -3581,7 +3581,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XmbDrawText</function></funcdef>
+ <funcdef>void <function>XmbDrawText</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -3593,7 +3593,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XwcDrawText</function></funcdef>
+ <funcdef>void <function>XwcDrawText</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
@@ -3684,7 +3684,7 @@ Specifies the number of text items in the array. The
<function>XmbDrawText</function>
and
-<function>XwcDrawText </function>
+<function>XwcDrawText</function>
functions allow complex spacing and font set shifts between text strings.
Each text item is processed in turn, with the origin of a text
element advanced in the primary draw direction by the escapement of the
@@ -3692,11 +3692,11 @@ previous text item. A text item delta specifies an additional escapement of the text item
drawing origin in the primary draw direction.
A font_set member other than
-<function>None</function>
+<symbol>None</symbol>
in an item causes the font set to be used for this and subsequent text items
in the text_items list.
Leading text items with a font_set member set to
-<function>None</function>
+<symbol>None</symbol>
will not be drawn.
</para>
<para>
@@ -3714,7 +3714,7 @@ or and
<function>XwcTextPerCharExtents</function>.
When the
-<function>XFontSet</function>
+<type>XFontSet</type>
has missing charsets, each unavailable character is drawn
with the default string returned by
<function>XCreateFontSet</function>.
@@ -3732,7 +3732,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XmbDrawString</function></funcdef>
+ <funcdef>void <function>XmbDrawString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
@@ -3745,7 +3745,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XwcDrawString</function></funcdef>
+ <funcdef>void <function>XwcDrawString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
@@ -3860,7 +3860,7 @@ and <function>XwcDrawString</function>
functions draw the specified text with the foreground pixel.
When the
-<function>XFontSet</function>
+<type>XFontSet</type>
has missing charsets, each unavailable character is drawn
with the default string returned by
<function>XCreateFontSet</function>.
@@ -3878,7 +3878,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XmbDrawImageString</function></funcdef>
+ <funcdef>void <function>XmbDrawImageString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
@@ -3891,7 +3891,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XwcDrawImageString</function></funcdef>
+ <funcdef>void <function>XwcDrawImageString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>XFontSet<parameter> font_set</parameter></paramdef>
@@ -4011,12 +4011,12 @@ The filled rectangle is the rectangle returned to overall_logical_return by or
<function>XwcTextExtents</function>
for the same text and
-<function>XFontSet</function>.
+<type>XFontSet</type>.
</para>
<para>
<!-- .LP -->
When the
-<function>XFontSet</function>
+<type>XFontSet</type>
has missing charsets, each unavailable character is drawn
with the default string returned by
<function>XCreateFontSet</function>.
@@ -4387,7 +4387,7 @@ but there is only one in a front-end architecture. <!-- .LP -->
The abstraction used by a client to communicate with an input method
is an opaque data structure represented by the
-<function>XIM</function>
+<type>XIM</type>
data type.
This data structure is returned by the
<function>XOpenIM</function>
@@ -4403,7 +4403,7 @@ A single input server may be used for one or more languages, supporting one or more encoding schemes.
But the strings returned from an input method will always be encoded
in the (single) locale associated with the
-<function>XIM</function>
+<type>XIM</type>
object.
</para>
</sect3>
@@ -4421,7 +4421,7 @@ and the user possibly switching among them at any time. The abstraction for representing the state of a particular input thread
is called an <emphasis remap='I'>input context</emphasis>.
The Xlib representation of an input context is an
-<function>XIC</function>.
+<type>XIC</type>.
</para>
<para>
<!-- .LP -->
@@ -4440,11 +4440,11 @@ One input context belongs to exactly one input method. Different input contexts may be associated with the same input method,
possibly with the same client window.
An
-<function>XIC</function>
+<type>XIC</type>
is created with the
<function>XCreateIC</function>
function, providing an
-<function>XIM</function>
+<type>XIM</type>
argument and affiliating the input context to the input method
for its lifetime.
When an input method is closed with
@@ -4606,19 +4606,19 @@ Before a client provides geometry management for an input method, it must determine if geometry management is needed.
The input method indicates the need for geometry management
by setting
-<function>XIMPreeditArea</function>
+<symbol>XIMPreeditArea</symbol>
or
-<function>XIMStatusArea</function>
+<symbol>XIMStatusArea</symbol>
in its
-<function>XIMStyles</function>
+<structname>XIMStyles</structname>
value returned by
<function>XGetIMValues</function>.
When a client has decided that it will provide geometry management
for an input method,
it indicates that decision by setting the
-<function>XNInputStyle</function>
+<symbol>XNInputStyle</symbol>
value in the
-<function>XIC</function>.
+<type>XIC</type>.
</para>
<para>
<!-- .LP -->
@@ -4631,7 +4631,7 @@ The geometry is negotiated by the following steps: <listitem>
<para>
The client suggests an area to the input method by setting the
-<function>XNAreaNeeded</function>
+<symbol>XNAreaNeeded</symbol>
value for that area.
If the client has no constraints for the input method,
it either will not suggest an area or will set the width and height to zero.
@@ -4641,7 +4641,7 @@ Otherwise, it will set one of the values. <listitem>
<para>
The client will get the <acronym>XIC</acronym> value
-<function>XNAreaNeeded</function>.
+<symbol>XNAreaNeeded</symbol>.
The input method will return its suggested size in this value.
The input method should pay attention to any constraints suggested
by the client.
@@ -4650,7 +4650,7 @@ by the client. <listitem>
<para>
The client sets the <acronym>XIC</acronym> value
-<function>XNArea</function>
+<symbol>XNArea</symbol>
to inform the input method of the geometry of its window.
The client should try to honor the geometry requested by the input method.
The input method must accept this geometry.
@@ -4662,9 +4662,9 @@ The input method must accept this geometry. Clients doing geometry management must be aware that setting other
<acronym>XIC</acronym> values may affect the geometry desired by an input method.
For example,
-<function>XNFontSet</function>
+<symbol>XNFontSet</symbol>
and
-<function>XNLineSpacing</function>
+<symbol>XNLineSpace</symbol>
may change the geometry desired by the input method.
</para>
<para>
@@ -4694,7 +4694,7 @@ to capture X events transparently to clients. It is expected that toolkits (or clients) using
<function>XmbLookupString</function>
or
-<function>XwcLookupString </function>
+<function>XwcLookupString</function>
will call this filter at some point in the event processing mechanism
to make sure that events needed by an input method can be filtered
by that input method.
@@ -4729,7 +4729,7 @@ to translations such as those the X Toolkit Intrinsics library provides. <para>
<!-- .LP -->
Clients are expected to get the <acronym>XIC</acronym> value
-<function>XNFilterEvents</function>
+<symbol>XNFilterEvents</symbol>
and augment the event mask for the client window with that event mask.
This mask may be zero.
</para>
@@ -4793,7 +4793,7 @@ attempting to draw preedit strings that are longer than the available space. Once the display area is exceeded, it is not
clear how best to display the preedit string.
The visible position feedback masks of
-<function>XIMText</function>
+<structname>XIMText</structname>
help resolve this problem by allowing the input method to specify hints that
indicate the essential portions of the preedit string.
For example, such hints can help developers implement
@@ -4919,16 +4919,16 @@ functions. <para>
<!-- .LP -->
String conversion support is dependent on the availability of the
-<function>XNStringConversion</function>
+<symbol>XNStringConversion</symbol>
or
-<function>XNStringConversionCallback </function>
+<symbol>XNStringConversionCallback</symbol>
<acronym>XIC</acronym> values.
Because the input method may not support string conversions,
clients have to query the availability of string conversion
operations by checking the supported <acronym>XIC</acronym> values list by calling
<function>XGetIMValues</function>
with the
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
IM value.
</para>
<para>
@@ -4936,7 +4936,7 @@ IM value. The difference between these two values is whether the
conversion is invoked by the client or the input method.
The
-<function>XNStringConversion</function>
+<symbol>XNStringConversion</symbol>
<acronym>XIC</acronym> value is used by clients to request
a string conversion from the input method. The client
is responsible for determining which events are used
@@ -4945,14 +4945,14 @@ converted should be copied or deleted. The type of conversion is determined by the input method; the client can only
pass the string to be converted. The client is guaranteed that
no
-<function>XNStringConversionCallback</function>
+<symbol>XNStringConversionCallback</symbol>
will be issued when this value is set; thus, the client need
only set one of these values.
</para>
<para>
<!-- .LP -->
The
-<function>XNStringConversionCallback</function>
+<symbol>XNStringConversionCallback</symbol>
<acronym>XIC</acronym> value is used by the client to notify the input method that
it will accept requests from the input method for string conversion.
If this value is set,
@@ -4963,13 +4963,13 @@ client-supplied procedure to retrieve the string to be converted. The client's callback procedure is notified whether to copy or delete the string and
is provided with hints as to the amount of text needed.
The
-<function>XIMStringConversionCallbackStruct</function>
+<structname>XIMStringConversionCallbackStruct</structname>
specifies which text should be passed back to the input method.
</para>
<para>
<!-- .LP -->
Finally, the input method may call the client's
-<function>XNStringConversionCallback</function>
+<symbol>XNStringConversionCallback</symbol>
procedure multiple times if the string returned from the callback is
not sufficient to perform a successful conversion. The arguments
to the client's procedure allow the input method to define a
@@ -5048,9 +5048,9 @@ functions are provided: being called.</entry>
</row>
<row>
- <entry><function>XSetIMValue</function>, <function>XSetICValue</function></entry>
+ <entry><function>XSetIMValues</function>, <function>XSetICValues</function></entry>
<entry>These functions use the <acronym>XIM</acronym> and <acronym>XIC</acronym> values,
- <function>XNDestroyCallback</function>,
+ <symbol>XNDestroyCallback</symbol>,
to allow a client
to register a callback procedure to be called when Xlib detects that
an IM server that was associated with an opened
@@ -5115,7 +5115,7 @@ Therefore, clients have to query support of hot keys by checking the supported <acronym>XIC</acronym> values list by calling
<function>XGetIMValues</function>
with the
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
IM value.
When the hot keys specified conflict with the key bindings of the
input method, hot keys take precedence over the key bindings of the input
@@ -5142,20 +5142,20 @@ retrieving the preedit state of an input context. One method is to query the state by calling
<function>XGetICValues</function>
with the
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
<acronym>XIC</acronym> value.
Another method is to receive notification whenever
the preedit state is changed. To receive such notification,
an application needs to register a callback by calling
<function>XSetICValues</function>
with the
-<function>XNPreeditStateNotifyCallback</function>
+<symbol>XNPreeditStateNotifyCallback</symbol>
<acronym>XIC</acronym> value.
In order to change the preedit state programmatically, an application
needs to call
<function>XSetICValues</function>
with
-<function>XNPreeditState</function>.
+<symbol>XNPreeditState</symbol>.
</para>
<para>
<!-- .LP -->
@@ -5166,7 +5166,7 @@ query availability of preedit state operations by checking the supported <acronym>XIC</acronym> values list by calling
<function>XGetIMValues</function>
with the
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
IM value.
</para>
</sect3>
@@ -5184,7 +5184,7 @@ To open a connection, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XIM<function> XOpenIM</function></funcdef>
+ <funcdef>XIM <function>XOpenIM</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XrmDatabase<parameter> db</parameter></paramdef>
<paramdef>char<parameter> *res_name</parameter></paramdef>
@@ -5305,7 +5305,7 @@ To close a connection, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XCloseIM</function></funcdef>
+ <funcdef>Status <function>XCloseIM</function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -5339,7 +5339,7 @@ To set input method attributes, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XSetIMValues</function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -5392,7 +5392,7 @@ To query an input method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XGetIMValues</function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -5455,7 +5455,7 @@ To obtain the display associated with an input method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Display<function> *</function></funcdef>
+ <funcdef>Display *<function>XDisplayOfIM</function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -5489,7 +5489,7 @@ To get the locale associated with an input method, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XLocaleOfIM</function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -5523,7 +5523,7 @@ To register an input method instantiate callback, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XRegisterIMInstantiateCallback</function></funcdef>
+ <funcdef>Bool <function>XRegisterIMInstantiateCallback</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XrmDatabase<parameter> db</parameter></paramdef>
<paramdef>char<parameter> *res_name</parameter></paramdef>
@@ -5608,9 +5608,9 @@ locale and modifiers. <para>
<!-- .LP -->
The function returns
-<function>True</function>
+<symbol>True</symbol>
if it succeeds; otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -5619,7 +5619,7 @@ The generic prototype is as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> IMInstantiateCallback</function></funcdef>
+ <funcdef>void <function><replaceable>IMInstantiateCallback</replaceable></function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -5668,7 +5668,7 @@ To unregister an input method instantiation callback, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XUnregisterIMInstantiateCallback</function></funcdef>
+ <funcdef>Bool <function>XUnregisterIMInstantiateCallback</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XrmDatabase<parameter> db</parameter></paramdef>
<paramdef>char<parameter> *res_name</parameter></paramdef>
@@ -5749,9 +5749,9 @@ The function removes an input method instantiation callback previously
registered.
The function returns
-<function>True</function>
+<symbol>True</symbol>
if it succeeds; otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
</sect2>
<sect2 id="Input_Method_Values">
@@ -5817,35 +5817,35 @@ The following keys apply to this table. </thead>
<tbody>
<row>
- <entry><function>XNQueryInputStyle</function></entry>
+ <entry><symbol>XNQueryInputStyle</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNResourceName</function></entry>
+ <entry><symbol>XNResourceName</symbol></entry>
<entry>D-S-G</entry>
</row>
<row>
- <entry><function>XNResourceClass</function></entry>
+ <entry><symbol>XNResourceClass</symbol></entry>
<entry>D-S-G</entry>
</row>
<row>
- <entry><function>XNDestroyCallback</function></entry>
+ <entry><symbol>XNDestroyCallback</symbol></entry>
<entry>D-S-G</entry>
</row>
<row>
- <entry><function>XNQueryIMValuesList</function></entry>
+ <entry><symbol>XNQueryIMValuesList</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNQueryICValuesList</function></entry>
+ <entry><symbol>XNQueryICValuesList</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNVisiblePosition</function></entry>
+ <entry><symbol>XNVisiblePosition</symbol></entry>
<entry>G</entry>
</row>
<row>
- <entry><function>XNR6PreeditCallbackBehavior</function></entry>
+ <entry><symbol>XNR6PreeditCallback</symbol></entry>
<entry>D-S-G</entry>
</row>
</tbody>
@@ -5854,7 +5854,7 @@ The following keys apply to this table. <para>
<!-- .LP -->
-<function>XNR6PreeditCallbackBehavior</function>
+<symbol>XNR6PreeditCallback</symbol>
is obsolete and its use is not recommended (see section 13.5.4.6).
</para>
@@ -5880,9 +5880,9 @@ it should negotiate with the user the continuation of the program The argument value must be a pointer to a location
where the returned value will be stored.
The returned value is a pointer to a structure of type
-<function>XIMStyles</function>.
+<structname>XIMStyles</structname>.
Clients are responsible for freeing the
-<function>XIMStyles</function>
+<structname>XIMStyles</structname>
structure.
To do so, use
<function>XFree</function>.
@@ -5890,7 +5890,7 @@ To do so, use <para>
<!-- .LP -->
The
-<function>XIMStyles</function>
+<structname>XIMStyles</structname>
structure is defined as follows:
</para>
@@ -5934,7 +5934,7 @@ typedef struct { <!-- .LP -->
<!-- .eM -->
An
-<function>XIMStyles</function>
+<structname>XIMStyles</structname>
structure contains the number of input styles supported
in its count_styles field.
This is also the size of the supported_styles array.
@@ -5965,41 +5965,41 @@ by the input method for preedit information. <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>XIMPreeditArea </function></entry>
+ <entry><symbol>XIMPreeditArea</symbol></entry>
<entry>If chosen,
the input method would require the client to provide some area values
for it to do its preediting.
Refer to <acronym>XIC</acronym> values
- <function>XNArea</function>
+ <symbol>XNArea</symbol>
and
- <function>XNAreaNeeded</function>.</entry>
+ <symbol>XNAreaNeeded</symbol>.</entry>
</row>
<row>
- <entry><function>XIMPreeditPosition</function></entry>
+ <entry><symbol>XIMPreeditPosition</symbol></entry>
<entry>If chosen,
the input method would require the client to provide positional values.
Refer to <acronym>XIC</acronym> values
- <function>XNSpotLocation</function>
+ <symbol>XNSpotLocation</symbol>
and
- <function>XNFocusWindow</function>.</entry>
+ <symbol>XNFocusWindow</symbol>.</entry>
</row>
<row>
- <entry><function>XIMPreeditCallbacks</function></entry>
+ <entry><symbol>XIMPreeditCallbacks</symbol></entry>
<entry>If chosen,
the input method would require the client to define the set of preedit callbacks.
Refer to <acronym>XIC</acronym> values
- <function>XNPreeditStartCallback</function>,
- <function>XNPreeditDoneCallback</function>,
- <function>XNPreeditDrawCallback</function>,
+ <symbol>XNPreeditStartCallback</symbol>,
+ <symbol>XNPreeditDoneCallback</symbol>,
+ <symbol>XNPreeditDrawCallback</symbol>,
and
- <function>XNPreeditCaretCallback</function>.</entry>
+ <symbol>XNPreeditCaretCallback</symbol>.</entry>
</row>
<row>
- <entry><function>XIMPreeditNothing</function></entry>
+ <entry><symbol>XIMPreeditNothing</symbol></entry>
<entry>If chosen, the input method can function without any preedit values.</entry>
</row>
<row>
- <entry><function>XIMPreeditNone</function></entry>
+ <entry><symbol>XIMPreeditNone</symbol></entry>
<entry>The input method does not provide any preedit feedback.
Any preedit value is ignored.
This style is mutually exclusive with the other preedit styles.</entry>
@@ -6023,28 +6023,28 @@ by the input method for status information. <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>XIMStatusArea</function></entry>
+ <entry><symbol>XIMStatusArea</symbol></entry>
<entry>The input method requires the client to provide
some area values for it to do its status feedback.
See
- <function>XNArea</function>
+ <symbol>XNArea</symbol>
and
- <function>XNAreaNeeded</function>.</entry>
+ <symbol>XNAreaNeeded</symbol>.</entry>
</row>
<row>
- <entry><function>XIMStatusCallbacks</function></entry>
+ <entry><symbol>XIMStatusCallbacks</symbol></entry>
<entry>The input method requires the client to define the set of status callbacks,
- <function>XNStatusStartCallback</function>,
- <function>XNStatusDoneCallback</function>,
+ <symbol>XNStatusStartCallback</symbol>,
+ <symbol>XNStatusDoneCallback</symbol>,
and
- <function>XNStatusDrawCallback</function>.</entry>
+ <symbol>XNStatusDrawCallback</symbol>.</entry>
</row>
<row>
- <entry><function>XIMStatusNothing</function></entry>
+ <entry><symbol>XIMStatusNothing</symbol></entry>
<entry>The input method can function without any status values.</entry>
</row>
<row>
- <entry><function>XIMStatusNone</function></entry>
+ <entry><symbol>XIMStatusNone</symbol></entry>
<entry>The input method does not provide any status feedback.
If chosen, any status value is ignored.
This style is mutually exclusive with the other status styles.</entry>
@@ -6062,9 +6062,9 @@ by the input method for status information. <para>
<!-- .LP -->
The
-<function>XNResourceName</function>
+<symbol>XNResourceName</symbol>
and
-<function>XNResourceClass</function>
+<symbol>XNResourceClass</symbol>
arguments are strings that specify the full name and class
used by the input method.
These values should be used as prefixes for the name and class
@@ -6089,10 +6089,10 @@ set as resources. <para>
<!-- .LP -->
The
-<function>XNDestroyCallback </function>
+<symbol>XNDestroyCallback</symbol>
argument is a pointer to a structure of type
-<function>XIMCallback</function>.
-<function>XNDestroyCallback</function>
+<structname>XIMCallback</structname>.
+<symbol>XNDestroyCallback</symbol>
is triggered when an input method stops its service for any reason.
After the callback is invoked, the input method is closed and the
associated input context(s) are destroyed by Xlib.
@@ -6108,7 +6108,7 @@ The generic prototype of this callback function is as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> DestroyCallback</function></funcdef>
+ <funcdef>void <function><replaceable>DestroyCallback</replaceable></function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -6164,9 +6164,9 @@ A DestroyCallback is always called with a NULL call_data argument. <!-- .XE -->
<para>
<!-- .LP -->
-<function>XNQueryIMValuesList</function>
+<symbol>XNQueryIMValuesList</symbol>
and
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
are used to query about <acronym>XIM</acronym> and <acronym>XIC</acronym> values supported by the input method.
</para>
<para>
@@ -6174,9 +6174,9 @@ are used to query about <acronym>XIM</acronym> and <acronym>XIC</acronym> values The argument value must be a pointer to a location where the returned
value will be stored. The returned value is a pointer to a structure
of type
-<function>XIMValuesList</function>.
+<structname>XIMValuesList</structname>.
Clients are responsible for freeing the
-<function>XIMValuesList</function>
+<structname>XIMValuesList</structname>
structure.
To do so, use
<function>XFree</function>.
@@ -6184,7 +6184,7 @@ To do so, use <para>
<!-- .LP -->
The
-<function>XIMValuesList</function>
+<structname>XIMValuesList</structname>
structure is defined as follows:
<!-- .sM -->
<literallayout class="monospaced">
@@ -6209,24 +6209,24 @@ typedef struct { <para>
<!-- .LP -->
The
-<function>XNVisiblePosition</function>
+<symbol>XNVisiblePosition</symbol>
argument indicates whether the visible position masks of
-<function>XIMFeedback</function>
+<type>XIMFeedback</type>
in
-<function>XIMText</function>
+<structname>XIMText</structname>
are available.
</para>
<para>
<!-- .LP -->
The argument value must be a pointer to a location where the returned
value will be stored. The returned value is of type
-<function>Bool</function>.
+<type>Bool</type>.
If the returned value is
-<function>True</function>,
+<symbol>True</symbol>,
the input method uses the visible position masks of
-<function>XIMFeedback</function>
+<type>XIMFeedback</type>
in
-<function>XIMText</function>;
+<structname>XIMText</structname>;
otherwise, the input method does not use the masks.
</para>
<para>
@@ -6234,16 +6234,16 @@ otherwise, the input method does not use the masks. Because this <acronym>XIM</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryIMValues</function>
+<symbol>XNQueryIMValuesList</symbol>
before using this argument.
If the
-<function>XNVisiblePosition</function>
+<symbol>XNVisiblePosition</symbol>
does not exist in the IM values list returned from
-<function>XNQueryIMValues</function>,
+<symbol>XNQueryIMValuesList</symbol>,
the visible position masks of
-<function>XIMFeedback</function>
+<type>XIMFeedback</type>
in
-<function>XIMText</function>
+<structname>XIMText</structname>
are not used to indicate the visible position.
</para>
<para>
@@ -6258,7 +6258,7 @@ are not used to indicate the visible position. <para>
<!-- .LP -->
The
-<function>XNR6PreeditCallbackBehavior</function>
+<symbol>XNR6PreeditCallback</symbol>
argument originally included in the X11R6 specification has been
deprecated.\(dg
<!-- .\" If XNR6PreeditCallbackBehavior is not deprecated, then its type -->
@@ -6269,7 +6269,7 @@ the R6 PreeditDrawCallbacks was going to differ significantly from that of the R5 callbacks.
Late changes to the specification converged the R5 and R6 behaviors,
eliminating the need for
-<function>XNR6PreeditCallbackBehavior</function>.
+<symbol>XNR6PreeditCallback</symbol>.
Unfortunately, this argument was not removed from the R6 specification
before it was published.
<!-- .FE -->
@@ -6277,39 +6277,39 @@ before it was published. <para>
<!-- .LP -->
The
-<function>XNR6PreeditCallbackBehavior</function>
+<symbol>XNR6PreeditCallback</symbol>
argument indicates whether the behavior of preedit callbacks regarding
-<function>XIMPreeditDrawCallbackStruct</function>
+<structname>XIMPreeditDrawCallbackStruct</structname>
values follows Release 5 or Release 6 semantics.
</para>
<para>
<!-- .LP -->
The value is of type
-<function>Bool</function>.
+<type>Bool</type>.
When querying for
-<function>XNR6PreeditCallbackBehavior</function>,
+<symbol>XNR6PreeditCallback</symbol>,
if the returned value is
-<function>True</function>,
+<symbol>True</symbol>,
the input method uses the Release 6 behavior;
otherwise, it uses the Release 5 behavior.
The default value is
-<function>False</function>.
+<symbol>False</symbol>.
In order to use Release 6 semantics, the value of
-<function>XNR6PreeditCallbackBehavior</function>
+<symbol>XNR6PreeditCallback</symbol>
must be set to
-<function>True</function>.
+<symbol>True</symbol>.
</para>
<para>
<!-- .LP -->
Because this <acronym>XIM</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryIMValues</function>
+<symbol>XNQueryIMValuesList</symbol>
before using this argument.
If the
-<function>XNR6PreeditCallbackBehavior</function>
+<symbol>XNR6PreeditCallback</symbol>
does not exist in the IM values list returned from
-<function>XNQueryIMValues</function>,
+<symbol>XNQueryIMValuesList</symbol>,
the PreeditCallback behavior is Release 5 semantics.
</para>
<para>
@@ -6344,7 +6344,7 @@ To create an input context, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XIC<function> XCreateIC</function></funcdef>
+ <funcdef>XIC <function>XCreateIC</function></funcdef>
<paramdef>XIM<parameter> im</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6377,7 +6377,7 @@ Specifies the variable length argument list(Al. <!-- .LP -->
<!-- .eM -->
The
-<function>XCreateIC </function>
+<function>XCreateIC</function>
function creates a context within the specified input method.
</para>
<para>
@@ -6403,7 +6403,7 @@ A required argument was not set. <listitem>
<para>
A read-only argument was set (for example,
-<function>XNFilterEvents</function>).
+<symbol>XNFilterEvents</symbol>).
</para>
</listitem>
<listitem>
@@ -6421,11 +6421,11 @@ The input method encountered an input method implementation-dependent error. <!-- .LP -->
<function>XCreateIC</function>
can generate
-<function>BadAtom</function>,
-<function>BadColor</function>,
-<function>BadPixmap</function>,
+<errorname>BadAtom</errorname>,
+<errorname>BadColor</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -6437,7 +6437,7 @@ To destroy an input context, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XDestroyIC</function></funcdef>
+ <funcdef>void <function>XDestroyIC</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6474,7 +6474,7 @@ and <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetICFocus</function></funcdef>
+ <funcdef>void <function>XSetICFocus</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6515,7 +6515,7 @@ does not affect the focus window value. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XUnsetICFocus</function></funcdef>
+ <funcdef>void <function>XUnsetICFocus</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6564,14 +6564,14 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XmbResetIC</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>wchar_t<function> *</function></funcdef>
+ <funcdef>wchar_t *<function>XwcResetIC</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6593,17 +6593,17 @@ Specifies the input context. <!-- .LP -->
<!-- .eM -->
When
-<function>XNResetState</function>
+<symbol>XNResetState</symbol>
is set to
-<function>XIMInitialState</function>,
+<symbol>XIMInitialState</symbol>,
<function>XmbResetIC</function>
and
<function>XwcResetIC</function>
reset an input context to its initial state;
when
-<function>XNResetState</function>
+<symbol>XNResetState</symbol>
is set to
-<function>XIMPreserveState</function>,
+<symbol>XIMPreserveState</symbol>,
the current input context state is preserved.
In both cases, any input pending on that context is deleted.
The input method is required to clear the preedit area, if any,
@@ -6639,7 +6639,7 @@ To get the input method associated with an input context, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XIM<function> XIMOfIC</function></funcdef>
+ <funcdef>XIM <function>XIMOfIC</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6684,7 +6684,7 @@ To set <acronym>XIC</acronym> values, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XSetICValues</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6727,7 +6727,7 @@ An argument might not be set for any of the following reasons: <listitem>
<para>
The argument is read-only (for example,
-<function>XNFilterEvents</function>).
+<symbol>XNFilterEvents</symbol>).
</para>
</listitem>
<listitem>
@@ -6750,12 +6750,12 @@ matching the data type imposed by the semantics of the argument. <!-- .LP -->
<function>XSetICValues</function>
can generate
-<function>BadAtom</function>,
-<function>BadColor</function>,
-<function>BadCursor</function>,
-<function>BadPixmap</function>,
+<errorname>BadAtom</errorname>,
+<errorname>BadColor</errorname>,
+<errorname>BadCursor</errorname>,
+<errorname>BadPixmap</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -6767,7 +6767,7 @@ To obtain <acronym>XIC</acronym> values, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char<function> *</function></funcdef>
+ <funcdef>char *<function>XGetICValues</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -6831,10 +6831,10 @@ and the client is responsible for freeing this data by calling <function>XFree</function>
with the returned pointer.
The exception to this rule is for an IC value of type
-<function>XVaNestedList</function>
+<type>XVaNestedList</type>
(for preedit and status attributes).
In this case, the argument must also be of type
-<function>XVaNestedList</function>.
+<type>XVaNestedList</type>.
Then, the rule of changing type T to T* and freeing the allocated data
applies to each element of the nested list.
</para>
@@ -7263,7 +7263,7 @@ The following keys apply to these tables. <entry>G</entry>
</row>
<row>
- <entry><function>Status</function></entry>
+ <entry><type>Status</type></entry>
</row>
<row>
<entry>Area</entry>
@@ -7356,12 +7356,12 @@ The following keys apply to these tables. <para>
<!-- .LP -->
The
-<function>XNInputStyle</function>
+<symbol>XNInputStyle</symbol>
argument specifies the input style to be used.
The value of this argument must be one of the values returned by the
<function>XGetIMValues</function>
function with the
-<function>XNQueryInputStyle</function>
+<symbol>XNQueryInputStyle</symbol>
argument specified in the supported_styles list.
</para>
<para>
@@ -7379,7 +7379,7 @@ and cannot be changed. <!-- .LP -->
<indexterm significance="preferred"><primary>XNClientWindow</primary></indexterm>
The
-<function>XNClientWindow</function>
+<symbol>XNClientWindow</symbol>
argument specifies to the input method the client window in
which the input method
can display data or create subwindows.
@@ -7396,7 +7396,7 @@ the input method may not operate correctly. If an attempt is made to set this value a second time with
<function>XSetICValues</function>,
the string
-<function>XNClientWindow</function>
+<symbol>XNClientWindow</symbol>
will be returned by
<function>XSetICValues</function>,
and the client window will not be changed.
@@ -7406,7 +7406,7 @@ and the client window will not be changed. If the client window is not a valid window ID on the display
attached to the input method,
a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error can be generated when this value is used by the input method.
</para>
</sect3>
@@ -7419,10 +7419,10 @@ error can be generated when this value is used by the input method. <!-- .LP -->
<indexterm significance="preferred"><primary>XNFocusWindow</primary></indexterm>
The
-<function>XNFocusWindow</function>
+<symbol>XNFocusWindow</symbol>
argument specifies the focus window.
The primary purpose of the
-<function>XNFocusWindow</function>
+<symbol>XNFocusWindow</symbol>
is to identify the window that will receive the key event when input
is composed.
In addition, the input method may possibly affect the focus window
@@ -7453,11 +7453,11 @@ Grab the keyboard within that window <para>
<!-- .LP -->
The associated value must be of type
-<function>Window</function>.
+<type>Window</type>.
If the focus window is not a valid window ID on the display
attached to the input method,
a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error can be generated when this value is used by the input method.
</para>
<para>
@@ -7476,9 +7476,9 @@ the input method will use the client window as the default focus window. <indexterm significance="preferred"><primary>XNResourceName</primary></indexterm>
<indexterm significance="preferred"><primary>XNResourceClass</primary></indexterm>
The
-<function>XNResourceName</function>
+<symbol>XNResourceName</symbol>
and
-<function>XNResourceClass</function>
+<symbol>XNResourceClass</symbol>
arguments are strings that specify the full name and class
used by the client to obtain resources for the client window.
These values should be used as prefixes for name and class
@@ -7501,15 +7501,15 @@ set as resources. <!-- .LP -->
<indexterm significance="preferred"><primary>XNGeometryCallback</primary></indexterm>
The
-<function>XNGeometryCallback</function>
+<symbol>XNGeometryCallback</symbol>
argument is a structure of type
-<function>XIMCallback </function>
+<structname>XIMCallback</structname>
(see section 13.5.6.13.12).
</para>
<para>
<!-- .LP -->
The
-<function>XNGeometryCallback</function>
+<symbol>XNGeometryCallback</symbol>
argument specifies the geometry callback that a client can set.
This callback is not required for correct operation of either
an input method or a client.
@@ -7529,7 +7529,7 @@ events that it uses to initiate the change. <!-- .LP -->
<indexterm significance="preferred"><primary>XNFilterEvents</primary></indexterm>
The
-<function>XNFilterEvents</function>
+<symbol>XNFilterEvents</symbol>
argument returns the event mask that an input method needs
to have selected for.
The client is expected to augment its own event mask
@@ -7543,8 +7543,8 @@ and is never changed. <para>
<!-- .LP -->
The type of this argument is
-<function>unsigned</function>
-<function>long</function>.
+<type>unsigned</type>
+<type>long</type>.
Setting this value will cause an error.
</para>
</sect3>
@@ -7556,9 +7556,9 @@ Setting this value will cause an error. <para>
<!-- .LP -->
The
-<function>XNDestroyCallback </function>
+<symbol>XNDestroyCallback</symbol>
argument is a pointer to a structure of type
-<function>XIMCallback </function>
+<structname>XIMCallback</structname>
(see section 13.5.6.13.12). This callback is triggered when the input method
stops its service for any reason; for example, when a connection to an IM
server is broken. After the destroy callback is called,
@@ -7580,15 +7580,15 @@ and <para>
<!-- .LP -->
The
-<function>XNStringConversionCallback</function>
+<symbol>XNStringConversionCallback</symbol>
argument is a structure of type
-<function>XIMCallback </function>
+<structname>XIMCallback</structname>
(see section 13.5.6.13.12).
</para>
<para>
<!-- .LP -->
The
-<function>XNStringConversionCallback</function>
+<symbol>XNStringConversionCallback</symbol>
argument specifies a string conversion callback. This callback
is not required for correct operation of
either the input method or the client. It can be set by a client
@@ -7601,7 +7601,7 @@ will filter any events that it uses to initiate the conversion. Because this <acronym>XIC</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
before using this argument.
</para>
<para>
@@ -7616,14 +7616,14 @@ before using this argument. <para>
<!-- .LP -->
The
-<function>XNStringConversion</function>
+<symbol>XNStringConversion</symbol>
argument is a structure of type
-<function>XIMStringConversionText</function>.
+<structname>XIMStringConversionText</structname>.
</para>
<para>
<!-- .LP -->
The
-<function>XNStringConversion</function>
+<symbol>XNStringConversion</symbol>
argument specifies the string to be converted by an input method.
This argument is not required for correct operation of either
the input method or the client.
@@ -7641,13 +7641,13 @@ reconversion, or transliteration conversion on it. Because this <acronym>XIC</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
before using this argument.
</para>
<para>
<!-- .LP -->
The
-<function>XIMStringConversionText</function>
+<structname>XIMStringConversionText</structname>
structure is defined as follows:
</para>
<para>
@@ -7689,7 +7689,7 @@ element to NULL. <para>
<!-- .LP -->
The
-<function>XNResetState</function>
+<symbol>XNResetState</symbol>
argument specifies the state the input context will return to after calling
<function>XmbResetIC</function>
or
@@ -7698,7 +7698,7 @@ or <para>
<!-- .LP -->
The <acronym>XIC</acronym> state may be set to its initial state, as specified by the
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
value when
<function>XCreateIC</function>
was called, or it may be set to preserve the current state.
@@ -7706,7 +7706,7 @@ was called, or it may be set to preserve the current state. <para>
<!-- .LP -->
The valid masks for
-<function>XIMResetState</function>
+<type>XIMResetState</type>
are as follows:
</para>
<para>
@@ -7727,19 +7727,19 @@ typedef unsigned long XIMResetState; <!-- .LP -->
<!-- .eM -->
If
-<function>XIMInitialState</function>
+<symbol>XIMInitialState</symbol>
is set, then
<function>XmbResetIC</function>
and
<function>XwcResetIC</function>
will return to the initial
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
state of the <acronym>XIC</acronym>.
</para>
<para>
<!-- .LP -->
If
-<function>XIMPreserveState</function>
+<symbol>XIMPreserveState</symbol>
is set, then
<function>XmbResetIC</function>
and
@@ -7749,22 +7749,22 @@ will preserve the current state of the <acronym>XIC</acronym>. <para>
<!-- .LP -->
If
-<function>XNResetState</function>
+<symbol>XNResetState</symbol>
is left unspecified, the default is
-<function>XIMInitialState</function>.
+<symbol>XIMInitialState</symbol>.
</para>
<para>
<!-- .LP -->
-<function>XIMResetState</function>
+<type>XIMResetState</type>
values other than those specified above will default to
-<function>XIMInitialState</function>.
+<symbol>XIMInitialState</symbol>.
</para>
<para>
<!-- .LP -->
Because this <acronym>XIC</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
before using this argument.
</para>
<para>
@@ -7779,30 +7779,30 @@ before using this argument. <para>
<!-- .LP -->
The
-<function>XNHotKey</function>
+<symbol>XNHotKey</symbol>
argument specifies the hot key list to the <acronym>XIC</acronym>.
The hot key list is a pointer to the structure of type
-<function>XIMHotKeyTriggers</function>,
+<structname>XIMHotKeyTriggers</structname>,
which specifies the key events that must be received
without any interruption of the input method.
For the hot key list set with this argument to be utilized, the client
must also set
-<function>XNHotKeyState</function>
+<symbol>XNHotKeyState</symbol>
to
-<function>XIMHotKeyStateON</function>.
+<symbol>XIMHotKeyStateON</symbol>.
</para>
<para>
<!-- .LP -->
Because this <acronym>XIC</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
before using this functionality.
</para>
<para>
<!-- .LP -->
The value of the argument is a pointer to a structure of type
-<function>XIMHotKeyTriggers</function>.
+<structname>XIMHotKeyTriggers</structname>.
</para>
<para>
<!-- .LP -->
@@ -7882,7 +7882,7 @@ is ignored when evaluating whether the key is hot or not. <para>
<!-- .LP -->
The
-<function>XNHotKeyState</function>
+<symbol>XNHotKeyState</symbol>
argument specifies the hot key state of the input method.
This is usually used to switch the input method between hot key
operation and normal input processing.
@@ -7907,7 +7907,7 @@ typedef unsigned long XIMHotKeyState; <para>
<!-- .LP -->
If not specified, the default is
-<function>XIMHotKeyStateOFF</function>.
+<symbol>XIMHotKeyStateOFF</symbol>.
</para>
<para>
<!-- .LP -->
@@ -7923,9 +7923,9 @@ If not specified, the default is <indexterm significance="preferred"><primary>XNPreeditAttributes</primary></indexterm>
<indexterm significance="preferred"><primary>XNStatusAttributes</primary></indexterm>
The
-<function>XNPreeditAttributes</function>
+<symbol>XNPreeditAttributes</symbol>
and
-<function>XNStatusAttributes</function>
+<symbol>XNStatusAttributes</symbol>
arguments specify to an input method the attributes to be used for the
preedit and status areas,
if any.
@@ -7945,18 +7945,18 @@ The names to be used in these lists are described in the following sections. <!-- .LP -->
<indexterm significance="preferred"><primary>XNArea</primary></indexterm>
The value of the
-<function>XNArea</function>
+<symbol>XNArea</symbol>
argument must be a pointer to a structure of type
-<function>XRectangle</function>.
+<structname>XRectangle</structname>.
The interpretation of the
-<function>XNArea</function>
+<symbol>XNArea</symbol>
argument is dependent on the input method style that has been set.
</para>
<para>
<!-- .LP -->
If the input method style is
-<function>XIMPreeditPosition</function>,
-<function>XNArea</function>
+<symbol>XIMPreeditPosition</symbol>,
+<symbol>XNArea</symbol>
specifies the clipping region within which preediting will take place.
If the focus window has been set,
the coordinates are assumed to be relative to the focus window.
@@ -7967,33 +7967,33 @@ the results are undefined. <para>
<!-- .LP -->
If
-<function>XNArea</function>
+<symbol>XNArea</symbol>
is not specified, is set to NULL, or is invalid,
the input method will default the clipping region
to the geometry of the
-<function>XNFocusWindow</function>.
+<symbol>XNFocusWindow</symbol>.
If the area specified is NULL or invalid,
the results are undefined.
</para>
<para>
<!-- .LP -->
If the input style is
-<function>XIMPreeditArea</function>
+<symbol>XIMPreeditArea</symbol>
or
-<function>XIMStatusArea</function>,
-<function>XNArea</function>
+<symbol>XIMStatusArea</symbol>,
+<symbol>XNArea</symbol>
specifies the geometry provided by the client to the input method.
The input method may use this area to display its data,
either preedit or status depending on the area designated.
The input method may create a window as a child of the client window
with dimensions that fit the
-<function>XNArea</function>.
+<symbol>XNArea</symbol>.
The coordinates are relative to the client window.
If the client window has not been set yet,
the input method should save these values
and apply them when the client window is set.
If
-<function>XNArea</function>
+<symbol>XNArea</symbol>
is not specified, is set to NULL, or is invalid,
the results are undefined.
</para>
@@ -8007,12 +8007,12 @@ the results are undefined. <!-- .LP -->
<indexterm significance="preferred"><primary>XNAreaNeeded</primary></indexterm>
When set, the
-<function>XNAreaNeeded</function>
+<symbol>XNAreaNeeded</symbol>
argument specifies the geometry suggested by the client for this area
(preedit or status).
The value associated with the argument must be a pointer to a
structure of type
-<function>XRectangle</function>.
+<structname>XRectangle</structname>.
Note that the x, y values are not used
and that nonzero values for width or height are the constraints
that the client wishes the input method to respect.
@@ -8020,16 +8020,16 @@ that the client wishes the input method to respect. <para>
<!-- .LP -->
When read, the
-<function>XNAreaNeeded</function>
+<symbol>XNAreaNeeded</symbol>
argument specifies the preferred geometry desired by the input method
for the area.
</para>
<para>
<!-- .LP -->
This argument is only valid if the input style is
-<function>XIMPreeditArea</function>
+<symbol>XIMPreeditArea</symbol>
or
-<function>XIMStatusArea</function>.
+<symbol>XIMStatusArea</symbol>.
It is used for geometry negotiation between the client and the input method
and has no other effect on the input method
(see section 13.5.1.5).
@@ -8044,14 +8044,14 @@ and has no other effect on the input method <!-- .LP -->
<indexterm significance="preferred"><primary>XNSpotLocation</primary></indexterm>
The
-<function>XNSpotLocation</function>
+<symbol>XNSpotLocation</symbol>
argument specifies to the input method the coordinates of the spot
to be used by an input method executing with
-<function>XNInputStyle </function>
+<symbol>XNInputStyle</symbol>
set to
-<function>XIMPreeditPosition</function>.
+<symbol>XIMPreeditPosition</symbol>.
When specified to any input method other than
-<function>XIMPreeditPosition</function>,
+<symbol>XIMPreeditPosition</symbol>,
this <acronym>XIC</acronym> value is ignored.
</para>
<para>
@@ -8068,7 +8068,7 @@ the results are undefined. <para>
<!-- .LP -->
The value of the argument is a pointer to a structure of type
-<function>XPoint</function>.
+<structname>XPoint</structname>.
</para>
</sect4>
<sect4 id="Colormap">
@@ -8085,27 +8085,27 @@ should use to allocate colors, a colormap ID, or a standard colormap name. <!-- .LP -->
<indexterm significance="preferred"><primary>XNColormap</primary></indexterm>
The
-<function>XNColormap</function>
+<symbol>XNColormap</symbol>
argument is used to specify a colormap ID.
The argument value is of type
-<function>Colormap</function>.
+<type>Colormap</type>.
An invalid argument may generate a
-<function>BadColor</function>
+<errorname>BadColor</errorname>
error when it is used by the input method.
</para>
<para>
<!-- .LP -->
<indexterm significance="preferred"><primary>XNStdColormap</primary></indexterm>
The
-<function>XNStdColormap</function>
+<symbol>XNStdColormap</symbol>
argument is used to indicate the name of the standard colormap
in which the input method should allocate colors.
The argument value is an
-<function>Atom</function>
+<type>Atom</type>
that should be a valid atom for calling
<function>XGetRGBColormaps</function>.
An invalid argument may generate a
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
error when it is used by the input method.
</para>
<para>
@@ -8124,13 +8124,13 @@ the client window colormap becomes the default. <indexterm significance="preferred"><primary>XNForeground</primary></indexterm>
<indexterm significance="preferred"><primary>XNBackground</primary></indexterm>
The
-<function>XNForeground</function>
+<symbol>XNForeground</symbol>
and
-<function>XNBackground</function>
+<symbol>XNBackground</symbol>
arguments specify the foreground and background pixel, respectively.
The argument value is of type
-<function>unsigned</function>
-<function>long</function>.
+<type>unsigned</type>
+<type>long</type>.
It must be a valid pixel in the input method colormap.
</para>
<para>
@@ -8147,13 +8147,13 @@ the default is determined by the input method. <para>
<!-- .LP -->
The
-<function>XNBackgroundPixmap</function>
+<symbol>XNBackgroundPixmap</symbol>
argument specifies a background pixmap to be used as the background of the
window.
The value must be of type
-<function>Pixmap</function>.
+<type>Pixmap</type>.
An invalid argument may generate a
-<function>BadPixmap</function>
+<errorname>BadPixmap</errorname>
error when it is used by the input method.
</para>
<para>
@@ -8171,10 +8171,10 @@ the default is determined by the input method. <!-- .LP -->
<indexterm significance="preferred"><primary>XNFontSet</primary></indexterm>
The
-<function>XNFontSet</function>
+<symbol>XNFontSet</symbol>
argument specifies to the input method what font set is to be used.
The argument value is of type
-<function>XFontSet</function>.
+<type>XFontSet</type>.
</para>
<para>
<!-- .LP -->
@@ -8190,11 +8190,11 @@ the default is determined by the input method. <para>
<!-- .LP -->
The
-<function>XNLineSpace</function>
+<symbol>XNLineSpace</symbol>
argument specifies to the input method what line spacing is to be used
in the preedit window if more than one line is to be used.
This argument is of type
-<function>int</function>.
+<type>int</type>.
</para>
<para>
<!-- .LP -->
@@ -8211,16 +8211,16 @@ the default is determined by the input method. <!-- .LP -->
<indexterm significance="preferred"><primary>XNCursor</primary></indexterm>
The
-<function>XNCursor</function>
+<symbol>XNCursor</symbol>
argument specifies to the input method what cursor is to be used
in the specified window.
This argument is of type
-<function>Cursor</function>.
+<type>Cursor</type>.
</para>
<para>
<!-- .LP -->
An invalid argument may generate a
-<function>BadCursor</function>
+<errorname>BadCursor</errorname>
error when it is used by the input method.
If this value is left unspecified,
the default is determined by the input method.
@@ -8234,14 +8234,14 @@ the default is determined by the input method. <para>
<!-- .LP -->
The
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
argument specifies the state of input preediting for the input method.
Input preediting can be on or off.
</para>
<para>
<!-- .LP -->
The valid mask names for
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
are as follows:
</para>
<para>
@@ -8265,29 +8265,29 @@ typedef unsigned long XIMPreeditState; <!-- .LP -->
<!-- .eM -->
If a value of
-<function>XIMPreeditEnable</function>
+<symbol>XIMPreeditEnable</symbol>
is set, then input preediting is turned on by the input method.
</para>
<para>
<!-- .LP -->
If a value of
-<function>XIMPreeditDisable</function>
+<symbol>XIMPreeditDisable</symbol>
is set, then input preediting is turned off by the input method.
</para>
<para>
<!-- .LP -->
If
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
is left unspecified, then the state will be implementation-dependent.
</para>
<para>
<!-- .LP -->
When
-<function>XNResetState</function>
+<symbol>XNResetState</symbol>
is set to
-<function>XIMInitialState</function>,
+<symbol>XIMInitialState</symbol>,
the
-<function>XNPreeditState</function>
+<symbol>XNPreeditState</symbol>
value specified at the creation time will be reflected as the initial state for
<function>XmbResetIC</function>
and
@@ -8298,7 +8298,7 @@ and Because this <acronym>XIC</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
before using this argument.
</para>
</sect4>
@@ -8312,15 +8312,15 @@ before using this argument. The preedit state notify callback is triggered by the input method
when the preediting state has changed.
The value of the
-<function>XNPreeditStateNotifyCallback</function>
+<symbol>XNPreeditStateNotifyCallback</symbol>
argument is a pointer to a structure of type
-<function>XIMCallback</function>.
+<structname>XIMCallback</structname>.
The generic prototype is as follows:
<indexterm significance="preferred"><primary>PreeditStateNotifyCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> PreeditStateNotifyCallback</function></funcdef>
+ <funcdef>void <function><replaceable>PreeditStateNotifyCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XIMPreeditStateNotifyCallbackStruct<parameter> *call_data</parameter></paramdef>
@@ -8364,7 +8364,7 @@ Specifies the current preedit state. <!-- .LP -->
<!-- .eM -->
The
-<function>XIMPreeditStateNotifyCallbackStruct</function>
+<structname>XIMPreeditStateNotifyCallbackStruct</structname>
structure is defined as follows:
</para>
<para>
@@ -8388,7 +8388,7 @@ typedef struct _XIMPreeditStateNotifyCallbackStruct { Because this <acronym>XIC</acronym> value is optional, a client should call
<function>XGetIMValues</function>
with argument
-<function>XNQueryICValuesList</function>
+<symbol>XNQueryICValuesList</symbol>
before using this argument.
</para>
</sect4>
@@ -8400,7 +8400,7 @@ before using this argument. <para>
<!-- .LP -->
A client that wants to support the input style
-<function>XIMPreeditCallbacks</function>
+<symbol>XIMPreeditCallbacks</symbol>
must provide a set of preedit callbacks to the input method.
The set of preedit callbacks is as follows:
</para>
@@ -8414,19 +8414,19 @@ The set of preedit callbacks is as follows: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>XNPreeditStartCallback</function></entry>
+ <entry><symbol>XNPreeditStartCallback</symbol></entry>
<entry>This is called when the input method starts preedit.</entry>
</row>
<row>
- <entry><function>XNPreeditDoneCallback</function></entry>
+ <entry><symbol>XNPreeditDoneCallback</symbol></entry>
<entry>This is called when the input method stops preedit.</entry>
</row>
<row>
- <entry><function>XNPreeditDrawCallback</function></entry>
+ <entry><symbol>XNPreeditDrawCallback</symbol></entry>
<entry>This is called when a number of preedit keystrokes should be echoed.</entry>
</row>
<row>
- <entry><function>XNPreeditCaretCallback</function></entry>
+ <entry><symbol>XNPreeditCaretCallback</symbol></entry>
<entry>This is called to move the text insertion point within the preedit string.</entry>
</row>
</tbody>
@@ -8436,7 +8436,7 @@ The set of preedit callbacks is as follows: <para>
<!-- .LP -->
A client that wants to support the input style
-<function>XIMStatusCallbacks</function>
+<symbol>XIMStatusCallbacks</symbol>
must provide a set of status callbacks to the input method.
The set of status callbacks is as follows:
</para>
@@ -8450,15 +8450,15 @@ The set of status callbacks is as follows: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>XNStatusStartCallback</function></entry>
+ <entry><symbol>XNStatusStartCallback</symbol></entry>
<entry>This is called when the input method initializes the status area.</entry>
</row>
<row>
- <entry><function>XNStatusDoneCallback</function></entry>
+ <entry><symbol>XNStatusDoneCallback</symbol></entry>
<entry>This is called when the input method no longer needs the status area.</entry>
</row>
<row>
- <entry><function>XNStatusDrawCallback</function></entry>
+ <entry><symbol>XNStatusDrawCallback</symbol></entry>
<entry>This is called when updating of the status area is required.</entry>
</row>
</tbody>
@@ -8468,7 +8468,7 @@ The set of status callbacks is as follows: <!-- .LP -->
The value of any status or preedit argument is a pointer
to a structure of type
-<function>XIMCallback</function>.
+<structname>XIMCallback</structname>.
<indexterm significance="preferred"><primary>XIMProc</primary></indexterm>
<indexterm significance="preferred"><primary>XIMCallback</primary></indexterm>
<!-- .sM -->
@@ -8538,7 +8538,7 @@ All callback procedures follow the generic prototype: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> CallbackPrototype</function></funcdef>
+ <funcdef>void <function><replaceable>CallbackPrototype</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>SomeType<parameter> call_data</parameter></paramdef>
@@ -8610,7 +8610,7 @@ The generic prototype is as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> GeometryCallback</function></funcdef>
+ <funcdef>void <function><replaceable>GeometryCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -8671,7 +8671,7 @@ The generic prototype is as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> DestroyCallback</function></funcdef>
+ <funcdef>void <function><replaceable>DestroyCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -8733,7 +8733,7 @@ The callback prototype is as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> StringConversionCallback</function></funcdef>
+ <funcdef>void <function><replaceable>StringConversionCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XIMStringConversionCallbackStruct<parameter> *call_data</parameter></paramdef>
@@ -8777,15 +8777,15 @@ Specifies the amount of the string to be converted. <!-- .LP -->
<!-- .eM -->
The callback is passed an
-<function>XIMStringConversionCallbackStruct</function>
+<structname>XIMStringConversionCallbackStruct</structname>
structure in the call_data argument.
The text member is an
-<function>XIMStringConversionText</function>
+<structname>XIMStringConversionText</structname>
structure (see section 13.5.6.9) to be filled in by the client
and describes the text to be sent to the input method.
The data pointed to by the
string and feedback elements of the
-<function>XIMStringConversionText</function>
+<structname>XIMStringConversionText</structname>
structure will be freed using
<function>XFree</function>
by the input method
@@ -8798,7 +8798,7 @@ freeing memory at some random location due to an uninitialized pointer. <para>
<!-- .LP -->
The
-<function>XIMStringConversionCallbackStruct</function>
+<structname>XIMStringConversionCallbackStruct</structname>
structure is defined as follows:
</para>
<para>
@@ -8828,10 +8828,10 @@ typedef unsigned short XIMStringConversionOperation; <para>
<!-- .LP -->
<!-- .eM -->
-<function>XIMStringConversionPosition</function>
+<type>XIMStringConversionPosition</type>
specifies the starting position of the string to be returned
in the
-<function>XIMStringConversionText</function>
+<structname>XIMStringConversionText</structname>
structure. The value identifies a position, in units of characters,
relative to the client's cursor position in the client's buffer.
</para>
@@ -8840,36 +8840,36 @@ relative to the client's cursor position in the client's buffer. The ending position of the text buffer is determined by
the direction and factor members. Specifically, it is the character position
relative to the starting point as defined by the
-<function>XIMCaretDirection</function>.
+<structname>XIMCaretDirection</structname>.
The factor member of
-<function>XIMStringConversionCallbackStruct </function>
+<structname>XIMStringConversionCallbackStruct</structname>
specifies the number of
-<function>XIMCaretDirection </function>
+<structname>XIMCaretDirection</structname>
positions to be applied. For example, if the direction specifies
-<function>XIMLineEnd</function>
+<constant>XIMLineEnd</constant>
and factor is 1, then all characters from the starting position to
the end of the current display line are returned. If the direction
specifies
-<function>XIMForwardChar</function>
+<constant>XIMForwardChar</constant>
or
-<function>XIMBackwardChar</function>,
+<constant>XIMBackwardChar</constant>,
then the factor specifies a relative position, indicated in characters,
from the starting position.
</para>
<para>
<!-- .LP -->
-<function>XIMStringConversionOperation</function>
+<type>XIMStringConversionOperation</type>
specifies whether the string to be converted should be
deleted (substitution) or copied (retrieval) from the client's
buffer. When the
-<function>XIMStringConversionOperation</function>
+<type>XIMStringConversionOperation</type>
is
-<function>XIMStringConversionSubstitution</function>,
+<symbol>XIMStringConversionSubstitution</symbol>,
the client must delete the string to be converted from its own buffer.
When the
-<function>XIMStringConversionOperation</function>
+<type>XIMStringConversionOperation</type>
is
-<function>XIMStringConversionRetrieval</function>,
+<symbol>XIMStringConversionRetrieval</symbol>,
the client must not delete the string to be converted from its buffer.
The substitute operation is typically used for reconversion and
transliteration conversion,
@@ -8885,16 +8885,16 @@ conversion. <para>
<!-- .LP -->
When the input method turns preediting on or off, a
-<function>PreeditStartCallback</function>
+<function><replaceable>PreeditStartCallback</replaceable></function>
or
-<function>PreeditDoneCallback</function>
+<function><replaceable>PreeditDoneCallback</replaceable></function>
callback is triggered to let the toolkit do the setup
or the cleanup for the preedit region.
<indexterm significance="preferred"><primary>PreeditStartCallback</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> PreeditStartCallback</function></funcdef>
+ <funcdef>int <function><replaceable>PreeditStartCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -8939,7 +8939,7 @@ Not used for this callback and always passed as NULL. <!-- .eM -->
When preedit starts on the specified input context,
the callback is called with a NULL call_data argument.
-<function>PreeditStartCallback</function>
+<function><replaceable>PreeditStartCallback</replaceable></function>
will return the maximum size of the preedit string.
A positive number indicates the maximum number of bytes allowed
in the preedit string,
@@ -8948,7 +8948,7 @@ and a value of -1 indicates there is no limit. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> PreeditDoneCallback</function></funcdef>
+ <funcdef>void <function><replaceable>PreeditDoneCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -8994,19 +8994,19 @@ Not used for this callback and always passed as NULL. When preedit stops on the specified input context,
the callback is called with a NULL call_data argument.
The client can release the data allocated by
-<function>PreeditStartCallback</function>.
+<function><replaceable>PreeditStartCallback</replaceable></function>.
</para>
<para>
<!-- .LP -->
-<function>PreeditStartCallback</function>
+<function><replaceable>PreeditStartCallback</replaceable></function>
should initialize appropriate data needed for
displaying preedit information and for handling further
-<function>PreeditDrawCallback</function>
+<function><replaceable>PreeditDrawCallback</replaceable></function>
calls.
Once
-<function>PreeditStartCallback</function>
+<function><replaceable>PreeditStartCallback</replaceable></function>
is called, it will not be called again before
-<function>PreeditDoneCallback</function>
+<function><replaceable>PreeditDoneCallback</replaceable></function>
has been called.
</para>
</sect3>
@@ -9029,7 +9029,7 @@ is as follows: <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> PreeditDrawCallback</function></funcdef>
+ <funcdef>void <function><replaceable>PreeditDrawCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XIMPreeditDrawCallbackStruct<parameter> *call_data</parameter></paramdef>
@@ -9073,7 +9073,7 @@ Specifies the preedit drawing information. <!-- .LP -->
<!-- .eM -->
The callback is passed an
-<function>XIMPreeditDrawCallbackStruct</function>
+<structname>XIMPreeditDrawCallbackStruct</structname>
structure in the call_data argument.
The text member of this structure contains the text to be drawn.
After the string has been drawn,
@@ -9082,7 +9082,7 @@ the caret should be moved to the specified location. <para>
<!-- .LP -->
The
-<function>XIMPreeditDrawCallbackStruct</function>
+<structname>XIMPreeditDrawCallbackStruct</structname>
structure is defined as follows:
</para>
<para>
@@ -9132,7 +9132,7 @@ that are affected by this call. A positive chg_length indicates that chg_length number of characters, starting
at chg_first, must be deleted or must be replaced by text, whose length is
specified in the
-<function>XIMText</function>
+<structname>XIMText</structname>
structure.
</para>
</listitem>
@@ -9148,7 +9148,7 @@ A value of zero for chg_first specifies the first character in the buffer. chg_length and chg_first combine to identify the modification required to
the preedit buffer; beginning at chg_first, replace chg_length number of
characters with the text in the supplied
-<function>XIMText</function>
+<structname>XIMText</structname>
structure. For example, suppose the preedit buffer contains the string "ABCDE".
</para>
</listitem>
@@ -9171,7 +9171,7 @@ relative to the character. If the value of chg_first is 1 and the value of chg_length is 3, this
says to replace 3 characters beginning at character position 1 with the
string in the
-<function>XIMText</function>
+<structname>XIMText</structname>
structure.
Hence, <acronym>BCD</acronym> would be replaced by the value in the structure.
</para>
@@ -9264,25 +9264,25 @@ If an input method wants to control display of the preedit string, an input method can indicate the visibility hints using feedbacks in
a specific way.
The
-<function>XIMVisibleToForward</function>,
-<function>XIMVisibleToBackward</function>,
+<symbol>XIMVisibleToForward</symbol>,
+<symbol>XIMVisibleToBackword</symbol>,
and
-<function>XIMVisibleCenter</function>
+<symbol>XIMVisibleToCenter</symbol>
masks are exclusively used for these visibility hints.
The
-<function>XIMVisibleToForward</function>
+<symbol>XIMVisibleToForward</symbol>
mask
indicates that the preedit text is preferably displayed in the
primary draw direction from the
caret position in the preedit area forward.
The
-<function>XIMVisibleToBackward</function>
+<symbol>XIMVisibleToBackword</symbol>
mask
indicates that the preedit text is preferably displayed from
the caret position in the preedit area backward, relative to the primary
draw direction.
The
-<function>XIMVisibleCenter</function>
+<symbol>XIMVisibleToCenter</symbol>
mask
indicates that the preedit text is preferably displayed with
the caret position in the preedit area centered.
@@ -9296,7 +9296,7 @@ masks is valid for the entire preedit string, and only one character
can hold one of these feedbacks for a given input context at one time.
This feedback may be OR'ed together with another highlight (such as
-<function>XIMReverse</function>).
+<symbol>XIMReverse</symbol>).
Only the most recently set feedback is valid, and any previous
feedback is automatically canceled. This is a hint to the client, and
the client is free to choose how to display the preedit string.
@@ -9318,17 +9318,17 @@ character of the string, and the length of the array is thus length. If an input method wants to indicate that it is only updating the feedback of
the preedit text without changing the content of it,
the
-<function>XIMText</function>
+<structname>XIMText</structname>
structure will contain a NULL value for the string field,
the number of characters affected (relative to chg_first)
will be in the length field,
and the feedback field will point to an array of
-<function>XIMFeedback</function>.
+<type>XIMFeedback</type>.
</para>
<para>
<!-- .LP -->
Each element in the feedback array is a bitmask represented by a value of type
-<function>XIMFeedback</function>.
+<type>XIMFeedback</type>.
The valid mask names are as follows:
</para>
<para>
@@ -9341,7 +9341,7 @@ The valid mask names are as follows: <indexterm significance="preferred"><primary>XIMTertiary</primary></indexterm>
<indexterm significance="preferred"><primary>XIMVisibleToForward</primary></indexterm>
<indexterm significance="preferred"><primary>XIMVisibleToBackward</primary></indexterm>
-<indexterm significance="preferred"><primary>XIMVisibleCenter</primary></indexterm>
+<indexterm significance="preferred"><primary>XIMVisibleToCenter</primary></indexterm>
<!-- .sM -->
</para>
<literallayout class="monospaced">
@@ -9355,7 +9355,7 @@ typedef unsigned long XIMFeedback; #define XIMTertiary (1L<<7)*
#define XIMVisibleToForward (1L<<8)
#define XIMVisibleToBackward (1L<<9)
-#define XIMVisibleCenter (1L<<10)
+#define XIMVisibleToCenter (1L<<10)
*† The values for XIMPrimary, XIMSecondary, and XIMTertiary were incorrectly defined in
the R5 specification. The X Consortium’s X11R5 implementation correctly implemented the val-
@@ -9367,29 +9367,29 @@ agree with the values in the Consortium’s X11R5 and X11R6 implementations. <para>
<!-- .LP -->
Characters drawn with the
-<function>XIMReverse</function>
+<symbol>XIMReverse</symbol>
highlight should be drawn by swapping the foreground and background colors
used to draw normal, unhighlighted characters.
Characters drawn with the
-<function>XIMUnderline</function>
+<symbol>XIMUnderline</symbol>
highlight should be underlined.
Characters drawn with the
-<function>XIMHighlight</function>,
-<function>XIMPrimary</function>,
-<function>XIMSecondary</function>,
+<symbol>XIMHighlight</symbol>,
+<symbol>XIMPrimary</symbol>,
+<symbol>XIMSecondary</symbol>,
and
-<function>XIMTertiary</function>
+<symbol>XIMTertiary</symbol>
highlights should be drawn in some unique manner that must be different
from
-<function>XIMReverse</function>
+<symbol>XIMReverse</symbol>
and
-<function>XIMUnderline</function>.
+<symbol>XIMUnderline</symbol>.
<!-- .FS \(dg -->
The values for
-<function>XIMPrimary</function>,
-<function>XIMSecondary</function>,
+<symbol>XIMPrimary</symbol>,
+<symbol>XIMSecondary</symbol>,
and
-<function>XIMTertiary</function>
+<symbol>XIMTertiary</symbol>
were incorrectly defined in the R5 specification.
The X Consortium's X11R5
implementation correctly implemented the values for these highlights.
@@ -9415,7 +9415,7 @@ It then calls the PreeditCaretCallback. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> PreeditCaretCallback</function></funcdef>
+ <funcdef>void <function><replaceable>PreeditCaretCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XIMPreeditCaretCallbackStruct<parameter> *call_data</parameter></paramdef>
@@ -9461,7 +9461,7 @@ Specifies the preedit caret information. The input method will trigger PreeditCaretCallback
to move the text insertion point during preedit.
The call_data argument contains a pointer to an
-<function>XIMPreeditCaretCallbackStruct</function>
+<structname>XIMPreeditCaretCallbackStruct</structname>
structure,
which indicates where the caret should be moved.
The callback must move the insertion point to its new location
@@ -9470,7 +9470,7 @@ and return, in field position, the new offset value from the initial position. <para>
<!-- .LP -->
The
-<function>XIMPreeditCaretCallbackStruct</function>
+<structname>XIMPreeditCaretCallbackStruct</structname>
structure is defined as follows:
<indexterm significance="preferred"><primary>XIMPreeditCaretCallbackStruct</primary></indexterm>
</para>
@@ -9491,7 +9491,7 @@ typedef struct _XIMPreeditCaretCallbackStruct { <!-- .LP -->
<!-- .eM -->
The
-<function>XIMCaretStyle</function>
+<structname>XIMCaretStyle</structname>
structure is defined as follows:
</para>
<para>
@@ -9512,7 +9512,7 @@ typedef enum { <!-- .LP -->
<!-- .eM -->
The
-<function>XIMCaretDirection</function>
+<structname>XIMCaretDirection</structname>
structure is defined as follows:
<indexterm significance="preferred"><primary>XIMCaretDirection</primary></indexterm>
</para>
@@ -9550,54 +9550,54 @@ These values are defined as follows: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>XIMForwardChar</function></entry>
+ <entry><constant>XIMForwardChar</constant></entry>
<entry>Move the caret forward one character position.</entry>
</row>
<row>
- <entry><function>XIMBackwardChar</function></entry>
+ <entry><constant>XIMBackwardChar</constant></entry>
<entry>Move the caret backward one character position.</entry>
</row>
<row>
- <entry><function>XIMForwardWord</function></entry>
+ <entry><constant>XIMForwardWord</constant></entry>
<entry>Move the caret forward one word.</entry>
</row>
<row>
- <entry><function>XIMBackwardWord</function></entry>
+ <entry><constant>XIMBackwardWord</constant></entry>
<entry>Move the caret backward one word.</entry>
</row>
<row>
- <entry><function>XIMCaretUp</function></entry>
+ <entry><constant>XIMCaretUp</constant></entry>
<entry>Move the caret up one line keeping the current horizontal offset.</entry>
</row>
<row>
- <entry><function>XIMCaretDown</function></entry>
+ <entry><constant>XIMCaretDown</constant></entry>
<entry>Move the caret down one line keeping the current horizontal offset.</entry>
</row>
<row>
- <entry><function>XIMPreviousLine</function></entry>
+ <entry><constant>XIMPreviousLine</constant></entry>
<entry>Move the caret to the beginning of the previous line.</entry>
</row>
<row>
- <entry><function>XIMNextLine</function></entry>
+ <entry><constant>XIMNextLine</constant></entry>
<entry>Move the caret to the beginning of the next line.</entry>
</row>
<row>
- <entry><function>XIMLineStart</function></entry>
+ <entry><constant>XIMLineStart</constant></entry>
<entry>Move the caret to the beginning of the current display line that contains the caret.</entry>
</row>
<row>
- <entry><function>XIMLineEnd</function></entry>
+ <entry><constant>XIMLineEnd</constant></entry>
<entry>Move the caret to the end of the current display line that contains the caret.</entry>
</row>
<row>
- <entry><function>XIMAbsolutePosition</function></entry>
+ <entry><constant>XIMAbsolutePosition</constant></entry>
<entry>The callback must move to the location specified by the position field
of the callback data, indicated in characters, starting from the beginning
of the preedit text.
Hence, a value of zero means move back to the beginning of the preedit text.</entry>
</row>
<row>
- <entry><function>XIMDontChange</function></entry>
+ <entry><constant>XIMDontChange</constant></entry>
<entry>The caret position does not change.</entry>
</row>
</tbody>
@@ -9631,7 +9631,7 @@ the input method calls the StatusStartCallback callback. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> StatusStartCallback</function></funcdef>
+ <funcdef>void <function><replaceable>StatusStartCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -9688,7 +9688,7 @@ is destroyed or when it loses focus, the input method calls StatusDoneCallback. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> StatusDoneCallback</function></funcdef>
+ <funcdef>void <function><replaceable>StatusDoneCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XPointer<parameter> call_data</parameter></paramdef>
@@ -9743,7 +9743,7 @@ StatusDrawCallback. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> StatusDrawCallback</function></funcdef>
+ <funcdef>void <function><replaceable>StatusDrawCallback</replaceable></function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XPointer<parameter> client_data</parameter></paramdef>
<paramdef>XIMStatusDrawCallbackStruct<parameter> *call_data</parameter></paramdef>
@@ -9792,9 +9792,9 @@ or imaging a bitmap in the status area. <para>
<!-- .LP -->
The
-<function>XIMStatusDataType</function>
+<structname>XIMStatusDataType</structname>
and
-<function>XIMStatusDrawCallbackStruct</function>
+<structname>XIMStatusDrawCallbackStruct</structname>
structures are defined as follows:
<indexterm significance="preferred"><primary>XIMStatusDataType</primary></indexterm>
<indexterm significance="preferred"><primary>XIMStatusDrawCallbackStruct</primary></indexterm>
@@ -9826,14 +9826,14 @@ typedef struct _XIMStatusDrawCallbackStruct { <para>
<!-- .LP -->
The feedback styles
-<function>XIMVisibleToForward</function>,
-<function>XIMVisibleToBackward</function>,
+<symbol>XIMVisibleToForward</symbol>,
+<symbol>XIMVisibleToBackword</symbol>,
and
-<function>XIMVisibleToCenter</function>
+<symbol>XIMVisibleToCenter</symbol>
are not relevant and will not appear in the
-<function>XIMFeedback</function>
+<type>XIMFeedback</type>
element of the
-<function>XIMText</function>
+<structname>XIMText</structname>
structure.
</para>
<para>
@@ -9855,7 +9855,7 @@ This filter is called by a client (or toolkit) by calling after calling
<function>XNextEvent</function>.
Any client that uses the
-<function>XIM</function>
+<type>XIM</type>
interface should call
<function>XFilterEvent</function>
to allow input methods to process their events without knowledge
@@ -9881,7 +9881,7 @@ To filter an event, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool<function> XFilterEvent</function></funcdef>
+ <funcdef>Bool <function>XFilterEvent</function></funcdef>
<paramdef>XEvent<parameter> *event</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -9916,10 +9916,10 @@ Specifies the window (Wi. <!-- .LP -->
<!-- .eM -->
If the window argument is
-<function>None</function>,
-<function>XFilterEvent </function>
+<symbol>None</symbol>,
+<function>XFilterEvent</function>
applies the filter to the window specified in the
-<function>XEvent</function>
+<structname>XEvent</structname>
structure.
The window argument is provided so that layers above Xlib
that do event redirection can indicate to which window an event
@@ -9930,13 +9930,13 @@ has been redirected. If
<function>XFilterEvent</function>
returns
-<function>True</function>,
+<symbol>True</symbol>,
then some input method has filtered the event,
and the client should discard the event.
If
<function>XFilterEvent</function>
returns
-<function>False</function>,
+<symbol>False</symbol>,
then the client should continue processing the event.
</para>
<para>
@@ -9944,7 +9944,7 @@ then the client should continue processing the event. If a grab has occurred in the client and
<function>XFilterEvent</function>
returns
-<function>True</function>,
+<symbol>True</symbol>,
the client should ungrab the keyboard.
</para>
</sect2>
@@ -9965,7 +9965,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XmbLookupString</function></funcdef>
+ <funcdef>int <function>XmbLookupString</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XKeyPressedEvent<parameter> *event</parameter></paramdef>
<paramdef>char<parameter> *buffer_return</parameter></paramdef>
@@ -9977,7 +9977,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XwcLookupString</function></funcdef>
+ <funcdef>int <function>XwcLookupString</function></funcdef>
<paramdef>XIC<parameter> ic</parameter></paramdef>
<paramdef>XKeyPressedEvent<parameter> *event</parameter></paramdef>
<paramdef>wchar_t<parameter> *buffer_return</parameter></paramdef>
@@ -10108,13 +10108,13 @@ begins in the initial state of the encoding of the locale <note><para>
To insure proper input processing,
it is essential that the client pass only
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
events to
<function>XmbLookupString</function>
and
<function>XwcLookupString</function>.
Their behavior when a client passes a
-<function>KeyRelease</function>
+<symbol>KeyRelease</symbol>
event is undefined.
</para></note>
<!-- .NE -->
@@ -10134,7 +10134,7 @@ The possible values returned are: <colspec colname='c2'/>
<tbody>
<row>
- <entry><function>XBufferOverflow</function></entry>
+ <entry><symbol>XBufferOverflow</symbol></entry>
<entry>The input string to be returned is too large for the supplied buffer_return.
The required size
(<function>XmbLookupString</function>
@@ -10146,13 +10146,13 @@ The possible values returned are: and a buffer of adequate size to obtain the string.</entry>
</row>
<row>
- <entry><function>XLookupNone</function></entry>
+ <entry><symbol>XLookupNone</symbol></entry>
<entry>No consistent input has been composed so far.
The contents of buffer_return and keysym_return are not modified,
and the function returns zero.</entry>
</row>
<row>
- <entry><function>XLookupChars</function></entry>
+ <entry><symbol>XLookupChars</symbol></entry>
<entry>Some input characters have been composed.
They are placed in the buffer_return argument,
and the string length is returned as the value of the function.
@@ -10160,18 +10160,18 @@ The possible values returned are: The content of the keysym_return argument is not modified.</entry>
</row>
<row>
- <entry><function>XLookupKeySym</function></entry>
+ <entry><symbol>XLookupKeySym</symbol></entry>
<entry>A KeySym has been returned instead of a string
and is returned in keysym_return.
The content of the buffer_return argument is not modified,
and the function returns zero.</entry>
</row>
<row>
- <entry><function>XLookupBoth</function></entry>
+ <entry><symbol>XLookupBoth</symbol></entry>
<entry>Both a KeySym and a string are returned;
- <function>XLookupChars</function>
+ <symbol>XLookupChars</symbol>
and
- <function>XLookupKeySym</function>
+ <symbol>XLookupKeySym</symbol>
occur simultaneously.</entry>
</row>
</tbody>
@@ -10228,14 +10228,14 @@ or raise an exception or error of some sort. <para>
<!-- .LP -->
A
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event with a KeyCode of zero is used exclusively as a
signal that an input method has composed input that can be returned by
<function>XmbLookupString</function>
or
<function>XwcLookupString</function>.
No other use is made of a
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event with KeyCode of zero.
</para>
<para>
@@ -10259,7 +10259,7 @@ onto a client's event queue <listitem>
<para>
A
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
event whose KeyCode value is modified by an input method filter
</para>
</listitem>
diff --git a/libX11/specs/libX11/CH14.xml b/libX11/specs/libX11/CH14.xml index dd301bf9f..4221e9b01 100644 --- a/libX11/specs/libX11/CH14.xml +++ b/libX11/specs/libX11/CH14.xml @@ -258,7 +258,7 @@ To request that a top-level window be iconified, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XIconifyWindow</function></funcdef>
+ <funcdef>Status <function>XIconifyWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
@@ -302,18 +302,18 @@ Specifies the appropriate screen number on the host server. <!-- .LP -->
<!-- .eM -->
The
-<function>XIconifyWindow </function>
+<function>XIconifyWindow</function>
function sends a WM_CHANGE_STATE
-<function>ClientMessage </function>
+<symbol>ClientMessage</symbol>
event with a format of 32 and a first data element of
-<function>IconicState </function>
+<symbol>IconicState</symbol>
(as described in section 4.1.4 of the
<emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>)
and a window of w
to the root window of the specified screen
with an event mask set to
-<function>SubstructureNotifyMask |</function>
-<function>SubstructureRedirectMask</function>.
+<symbol>SubstructureNotifyMask</symbol> |
+<symbol>SubstructureRedirectMask</symbol>.
Window managers may elect to receive this message and
if the window is in its normal state,
may treat it as a request to change the window's state from normal to iconic.
@@ -332,7 +332,7 @@ To request that a top-level window be withdrawn, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XWithdrawWindow</function></funcdef>
+ <funcdef>Status <function>XWithdrawWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
@@ -376,17 +376,17 @@ Specifies the appropriate screen number on the host server. <!-- .LP -->
<!-- .eM -->
The
-<function>XWithdrawWindow </function>
+<function>XWithdrawWindow</function>
function unmaps the specified window
and sends a synthetic
-<function>UnmapNotify </function>
+<symbol>UnmapNotify</symbol>
event to the root window of the specified screen.
Window managers may elect to receive this message
and may treat it as a request to change the window's state to withdrawn.
When a window is in the withdrawn state,
neither its normal nor its iconic representations is visible.
It returns a nonzero status if the
-<function>UnmapNotify </function>
+<symbol>UnmapNotify</symbol>
event is successfully sent;
otherwise, it returns a zero status.
</para>
@@ -394,7 +394,7 @@ otherwise, it returns a zero status. <!-- .LP -->
<function>XWithdrawWindow</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
<!-- .sp -->
</para>
@@ -406,7 +406,7 @@ To request that a top-level window be reconfigured, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XReconfigureWMWindow</function></funcdef>
+ <funcdef>Status <function>XReconfigureWMWindow</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>int<parameter> screen_number</parameter></paramdef>
@@ -465,7 +465,7 @@ This mask is the bitwise inclusive OR of the valid configure window values bits. <listitem>
<para>
Specifies the
-<function>XWindowChanges </function>
+<structname>XWindowChanges</structname>
structure.
</para>
</listitem>
@@ -476,15 +476,15 @@ structure. <!-- .LP -->
<!-- .eM -->
The
-<function>XReconfigureWMWindow </function>
+<function>XReconfigureWMWindow</function>
function issues a
-<function>ConfigureWindow </function>
+<systemitem>ConfigureWindow</systemitem>
request on the specified top-level window.
If the stacking mode is changed and the request fails with a
-<function>BadMatch </function>
+<errorname>BadMatch</errorname>
error,
the error is trapped by Xlib and a synthetic
-<function>ConfigureRequestEvent </function>
+<systemitem class="event">ConfigureRequestEvent</systemitem>
containing the same configuration parameters is sent to the root
of the specified window.
Window managers may elect to receive this event
@@ -494,11 +494,11 @@ otherwise, it returns a zero status. </para>
<para>
<!-- .LP -->
-<function>XReconfigureWMWindow </function>
+<function>XReconfigureWMWindow</function>
can generate
-<function>BadValue </function>
+<errorname>BadValue</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect2>
@@ -512,11 +512,11 @@ errors. Many of the text properties allow a variety of types and formats.
Because the data stored in these properties are not
simple null-terminated strings, an
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure is used to describe the encoding, type, and length of the text
as well as its value.
The
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure contains:
<indexterm significance="preferred"><primary>XTextProperty</primary></indexterm>
<!-- .sM -->
@@ -543,7 +543,7 @@ to character strings and text properties in the STRING encoding. <!-- .LP -->
The functions for localized text return a signed integer error status
that encodes
-<function>Success</function>
+<symbol>Success</symbol>
as zero, specific error conditions as negative numbers, and partial conversion
as a count of unconvertible characters.
</para>
@@ -570,7 +570,7 @@ typedef enum { <para>
<!-- .LP -->
To convert a list of text strings to an
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure, use
<function>XmbTextListToTextProperty</function>
or
@@ -580,7 +580,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XmbTextListToTextProperty</function></funcdef>
+ <funcdef>int <function>XmbTextListToTextProperty</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> **list</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -591,7 +591,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XwcTextListToTextProperty</function></funcdef>
+ <funcdef>int <function>XwcTextListToTextProperty</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>wchar_t<parameter> **list</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
@@ -648,7 +648,7 @@ Specifies the manner in which the property is encoded. <listitem>
<para>
Returns the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
</para>
</listitem>
@@ -663,7 +663,7 @@ The and
<function>XwcTextListToTextProperty</function>
functions set the specified
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
value to a set of null-separated elements representing the concatenation
of the specified list of null-terminated text strings.
A final terminating null is stored at the end of the value field
@@ -672,23 +672,23 @@ of text_prop_return but is not included in the nitems member. <para>
<!-- .LP -->
The functions set the encoding field of text_prop_return to an
-<function>Atom </function>
+<type>Atom</type>
for the specified display
naming the encoding determined by the specified style
and convert the specified text list to this encoding for storage in
the text_prop_return value field.
If the style
-<function>XStringStyle</function>
+<constant>XStringStyle</constant>
or
-<function>XCompoundTextStyle</function>
+<constant>XCompoundTextStyle</constant>
is specified,
this encoding is ``STRING'' or ``COMPOUND_TEXT'', respectively.
If the style
-<function>XTextStyle</function>
+<constant>XTextStyle</constant>
is specified,
this encoding is the encoding of the current locale.
If the style
-<function>XStdICCTextStyle</function>
+<constant>XStdICCTextStyle</constant>
is specified,
this encoding is ``STRING'' if the text is fully convertible to STRING,
else ``COMPOUND_TEXT''.
@@ -697,17 +697,17 @@ else ``COMPOUND_TEXT''. <!-- .LP -->
If insufficient memory is available for the new value string,
the functions return
-<function>XNoMemory</function>.
+<symbol>XNoMemory</symbol>.
If the current locale is not supported,
the functions return
-<function>XLocaleNotSupported</function>.
+<symbol>XLocaleNotSupported</symbol>.
In both of these error cases,
the functions do not set text_prop_return.
</para>
<para>
<!-- .LP -->
To determine if the functions are guaranteed not to return
-<function>XLocaleNotSupported</function>,
+<symbol>XLocaleNotSupported</symbol>,
use
<function>XSupportsLocale</function>.
</para>
@@ -718,9 +718,9 @@ the functions return the number of unconvertible characters. Each unconvertible character is converted to an implementation-defined and
encoding-specific default string.
Otherwise, the functions return
-<function>Success</function>.
+<symbol>Success</symbol>.
Note that full convertibility to all styles except
-<function>XStringStyle</function>
+<constant>XStringStyle</constant>
is guaranteed.
</para>
<para>
@@ -732,7 +732,7 @@ To free the storage for the value field, use <para>
<!-- .LP -->
To obtain a list of text strings from an
-<function>XTextProperty </function>
+<structname>XTextProperty</structname>
structure, use
<function>XmbTextPropertyToTextList</function>
or
@@ -742,7 +742,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XmbTextPropertyToTextList</function></funcdef>
+ <funcdef>int <function>XmbTextPropertyToTextList</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
<paramdef>char<parameter> ***list_return</parameter></paramdef>
@@ -752,7 +752,7 @@ or <!-- .FN -->
<funcsynopsis>
<funcprototype>
- <funcdef>int<function> XwcTextPropertyToTextList</function></funcdef>
+ <funcdef>int <function>XwcTextPropertyToTextList</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
<paramdef>wchar_t<parameter> ***list_return</parameter></paramdef>
@@ -778,7 +778,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure to be used.
</para>
</listitem>
@@ -815,7 +815,7 @@ and <function>XwcTextPropertyToTextList</function>
functions return a list of text strings in the current locale representing the
null-separated elements of the specified
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
The data in text_prop must be format 8.
</para>
@@ -833,20 +833,20 @@ If insufficient memory is available for the list and its elements, and
<function>XwcTextPropertyToTextList</function>
return
-<function>XNoMemory</function>.
+<symbol>XNoMemory</symbol>.
If the current locale is not supported,
the functions return
-<function>XLocaleNotSupported</function>.
+<symbol>XLocaleNotSupported</symbol>.
Otherwise, if the encoding field of text_prop is not convertible
to the encoding of the current locale,
the functions return
-<function>XConverterNotFound</function>.
+<symbol>XConverterNotFound</symbol>.
For supported locales,
existence of a converter from COMPOUND_TEXT, STRING
or the encoding of the current locale is guaranteed if
-<function>XSupportsLocale </function>
+<function>XSupportsLocale</function>
returns
-<function>True</function>
+<symbol>True</symbol>
for the current locale (but the actual text
may contain unconvertible characters).
Conversion of other encodings is implementation-dependent.
@@ -877,7 +877,7 @@ Otherwise, and
<function>XwcTextPropertyToTextList</function>
return
-<function>Success</function>.
+<symbol>Success</symbol>.
</para>
<para>
<!-- .LP -->
@@ -900,7 +900,7 @@ wide character string list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XwcFreeStringList</function></funcdef>
+ <funcdef>void <function>XwcFreeStringList</function></funcdef>
<paramdef>wchar_t<parameter> **list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -959,7 +959,7 @@ is independent of the default string for text drawing; see
<function>XCreateFontSet</function>
to obtain the default string for an
-<function>XFontSet</function>.
+<type>XFontSet</type>.
</para>
<para>
<!-- .LP -->
@@ -977,14 +977,14 @@ Until freed, it will not be modified by Xlib. <para>
<!-- .LP -->
To set the specified list of strings in the STRING encoding to a
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure, use
<function>XStringListToTextProperty</function>.
<indexterm significance="preferred"><primary>XStringListToTextProperty</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XStringListToTextProperty</function></funcdef>
+ <funcdef>Status <function>XStringListToTextProperty</function></funcdef>
<paramdef>char<parameter> **list</parameter></paramdef>
<paramdef>int<parameter> count</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop_return</parameter></paramdef>
@@ -1020,7 +1020,7 @@ Specifies the number of (Cn. <listitem>
<para>
Returns the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
</para>
</listitem>
@@ -1031,9 +1031,9 @@ structure. <!-- .LP -->
<!-- .eM -->
The
-<function>XStringListToTextProperty </function>
+<function>XStringListToTextProperty</function>
function sets the specified
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
to be of type STRING (format 8) with a value representing the
concatenation of the specified list of null-separated character strings.
An extra null byte (which is not included in the nitems member)
@@ -1042,7 +1042,7 @@ The strings are assumed (without verification) to be in the STRING encoding. If insufficient memory is available for the new value string,
<function>XStringListToTextProperty</function>
does not set any fields in the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure and returns a zero status.
Otherwise, it returns a nonzero status.
To free the storage for the value field, use
@@ -1052,14 +1052,14 @@ To free the storage for the value field, use <para>
<!-- .LP -->
To obtain a list of strings from a specified
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure in the STRING encoding, use
<function>XTextPropertyToStringList</function>.
<indexterm significance="preferred"><primary>XTextPropertyToStringList</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XTextPropertyToStringList</function></funcdef>
+ <funcdef>Status <function>XTextPropertyToStringList</function></funcdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
<paramdef>char<parameter> ***list_return</parameter></paramdef>
<paramdef>int<parameter> *count_return</parameter></paramdef>
@@ -1074,7 +1074,7 @@ structure in the STRING encoding, use <listitem>
<para>
Specifies the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure to be used.
</para>
</listitem>
@@ -1106,10 +1106,10 @@ Returns the number of (Cn. <!-- .LP -->
<!-- .eM -->
The
-<function>XTextPropertyToStringList </function>
+<function>XTextPropertyToStringList</function>
function returns a list of strings representing the null-separated elements
of the specified
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
The data in text_prop must be of type STRING and format 8.
Multiple elements of the property
@@ -1132,7 +1132,7 @@ To free the in-memory data associated with the specified string list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XFreeStringList</function></funcdef>
+ <funcdef>void <function>XFreeStringList</function></funcdef>
<paramdef>char<parameter> **list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1154,7 +1154,7 @@ Specifies the list of strings to be freed. <!-- .LP -->
<!-- .eM -->
The
-<function>XFreeStringList </function>
+<function>XFreeStringList</function>
function releases memory allocated by
<function>XmbTextPropertyToTextList</function>
and
@@ -1189,7 +1189,7 @@ To set one of a window's text properties, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetTextProperty</function></funcdef>
+ <funcdef>void <function>XSetTextProperty</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
@@ -1225,7 +1225,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure to be used.
</para>
</listitem>
@@ -1251,7 +1251,7 @@ function replaces the existing specified property for the named window with the data, type, format, and number of items determined
by the value field, the encoding field, the format field,
and the nitems field, respectively, of the specified
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
If the property does not already exist,
<function>XSetTextProperty</function>
@@ -1261,11 +1261,11 @@ sets it for the specified window. <!-- .LP -->
<function>XSetTextProperty</function>
can generate
-<function>BadAlloc</function>,
-<function>BadAtom</function>,
-<function>BadValue</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadAtom</errorname>,
+<errorname>BadValue</errorname>,
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -1277,7 +1277,7 @@ To read one of a window's text properties, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetTextProperty</function></funcdef>
+ <funcdef>Status <function>XGetTextProperty</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop_return</parameter></paramdef>
@@ -1313,7 +1313,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
</para>
</listitem>
@@ -1334,10 +1334,10 @@ Specifies the property name. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetTextProperty </function>
+<function>XGetTextProperty</function>
function reads the specified property from the window
and stores the data in the returned
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
It stores the data in the value field,
the type of the data in the encoding field,
@@ -1351,14 +1351,14 @@ If the specified property does not exist on the window, <function>XGetTextProperty</function>
sets the value field to NULL,
the encoding field to
-<function>None</function>,
+<symbol>None</symbol>,
the format field to zero,
and the nitems field to zero.
</para>
<para>
<!-- .LP -->
If it was able to read and store the data in the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure,
<function>XGetTextProperty</function>
returns a nonzero status;
@@ -1368,9 +1368,9 @@ otherwise, it returns a zero status. <!-- .LP -->
<function>XGetTextProperty</function>
can generate
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect2>
@@ -1393,7 +1393,7 @@ To set a window's WM_NAME property with the supplied convenience function, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetWMName</function></funcdef>
+ <funcdef>void <function>XSetWMName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
@@ -1428,7 +1428,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure to be used.
</para>
</listitem>
@@ -1441,7 +1441,7 @@ structure to be used. The
<function>XSetWMName</function>
convenience function calls
-<function>XSetTextProperty </function>
+<function>XSetTextProperty</function>
to set the WM_NAME property.
<!-- .sp -->
</para>
@@ -1453,7 +1453,7 @@ To read a window's WM_NAME property with the supplied convenience function, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMName</function></funcdef>
+ <funcdef>Status <function>XGetWMName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop_return</parameter></paramdef>
@@ -1488,7 +1488,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
</para>
</listitem>
@@ -1499,9 +1499,9 @@ structure. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetWMName </function>
+<function>XGetWMName</function>
convenience function calls
-<function>XGetTextProperty </function>
+<function>XGetTextProperty</function>
to obtain the WM_NAME property.
It returns a nonzero status on success;
otherwise, it returns a zero status.
@@ -1526,7 +1526,7 @@ To assign a name to a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XStoreName</function></funcdef>
+ <funcdef><function>XStoreName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> *window_name</parameter></paramdef>
@@ -1585,9 +1585,9 @@ the result is implementation-dependent. <!-- .LP -->
<function>XStoreName</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -1599,7 +1599,7 @@ To get the name of a window, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XFetchName</function></funcdef>
+ <funcdef>Status <function>XFetchName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> **window_name_return</parameter></paramdef>
@@ -1663,7 +1663,7 @@ the window name string using <!-- .LP -->
<function>XFetchName</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -1687,7 +1687,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetWMIconName</function></funcdef>
+ <funcdef>void <function>XSetWMIconName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
@@ -1722,7 +1722,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure to be used.
</para>
</listitem>
@@ -1748,7 +1748,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMIconName</function></funcdef>
+ <funcdef>Status <function>XGetWMIconName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop_return</parameter></paramdef>
@@ -1783,7 +1783,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
</para>
</listitem>
@@ -1794,9 +1794,9 @@ structure. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetWMIconName </function>
+<function>XGetWMIconName</function>
convenience function calls
-<function>XGetTextProperty </function>
+<function>XGetTextProperty</function>
to obtain the WM_ICON_NAME property.
It returns a nonzero status on success;
otherwise, it returns a zero status.
@@ -1822,7 +1822,7 @@ To set the name to be displayed in a window's icon, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetIconName</function></funcdef>
+ <funcdef><function>XSetIconName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> *icon_name</parameter></paramdef>
@@ -1870,9 +1870,9 @@ If the string is not in the Host Portable Character Encoding, the result is implementation-dependent.
<function>XSetIconName</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -1884,7 +1884,7 @@ To get the name a window wants displayed in its icon, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetIconName</function></funcdef>
+ <funcdef>Status <function>XGetIconName</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> **icon_name_return</parameter></paramdef>
@@ -1948,7 +1948,7 @@ the icon name string using <!-- .LP -->
<function>XGetIconName</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -1962,16 +1962,16 @@ error. Xlib provides functions that you can use to set and read
the WM_HINTS property for a given window.
These functions use the flags and the
-<function>XWMHints </function>
+<structname>XWMHints</structname>
structure, as defined in the
-<!-- .hN X11/Xutil.h -->
+<<filename class="headerfile">X11/Xutil.h</filename>>
header file.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To allocate an
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure, use
<function>XAllocWMHints</function>.
</para>
@@ -1986,10 +1986,10 @@ structure, use The
<function>XAllocWMHints</function>
function allocates and returns a pointer to an
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure.
Note that all fields in the
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure are initially set to zero.
If insufficient memory is available,
<function>XAllocWMHints</function>
@@ -2001,7 +2001,7 @@ use <para>
<!-- .LP -->
The
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure contains:
</para>
@@ -2045,32 +2045,32 @@ Applications that expect input but never explicitly set focus to any of their subwindows (that is, use the push model of focus management),
such as X Version 10 style applications that use real-estate
driven focus, should set this member to
-<function>True</function>.
+<symbol>True</symbol>.
Similarly, applications
that set input focus to their subwindows only when it is given to their
top-level window by a window manager should also set this member to
-<function>True</function>.
+<symbol>True</symbol>.
Applications that manage their own input focus by explicitly setting
focus to one of their subwindows whenever they want keyboard input
(that is, use the pull model of focus management) should set this member to
-<function>False</function>.
+<symbol>False</symbol>.
Applications that never expect any keyboard input also should set this member
to
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
Pull model window managers should make it possible for push model
applications to get input by setting input focus to the top-level windows of
applications whose input member is
-<function>True</function>.
+<symbol>True</symbol>.
Push model window managers should
make sure that pull model applications do not break them
by resetting input focus to
-<function>PointerRoot </function>
+<symbol>PointerRoot</symbol>
when it is appropriate (for example, whenever an application whose
input member is
-<function>False </function>
+<symbol>False</symbol>
sets input focus to one of its subwindows).
</para>
<para>
@@ -2101,7 +2101,7 @@ rather than just the one window. <para>
<!-- .LP -->
The
-<function>UrgencyHint</function>
+<symbol>UrgencyHint</symbol>
flag, if set in the flags field, indicates that the client deems the window
contents to be urgent, requiring the timely response of the user. The
window manager will make some effort to draw the user's attention to this
@@ -2119,7 +2119,7 @@ To set a window's WM_HINTS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetWMHints</function></funcdef>
+ <funcdef><function>XSetWMHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XWMHints<parameter> *wmhints</parameter></paramdef>
@@ -2154,7 +2154,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure to be used.
</para>
</listitem>
@@ -2174,9 +2174,9 @@ window manager to get keyboard input. <!-- .LP -->
<function>XSetWMHints</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2188,7 +2188,7 @@ To read a window's WM_HINTS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XWMHints<function> *XGetWMHints</function></funcdef>
+ <funcdef>XWMHints *<function>XGetWMHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
</funcprototype>
@@ -2225,7 +2225,7 @@ The function reads the window manager hints and
returns NULL if no WM_HINTS property was set on the window
or returns a pointer to an
-<function>XWMHints </function>
+<structname>XWMHints</structname>
structure if it succeeds.
When finished with the data,
free the space used for it by calling
@@ -2235,7 +2235,7 @@ free the space used for it by calling <!-- .LP -->
<function>XGetWMHints</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -2249,15 +2249,15 @@ error. Xlib provides functions that you can use to set or read
the WM_NORMAL_HINTS property for a given window.
The functions use the flags and the
-<function>XSizeHints </function>
+<structname>XSizeHints</structname>
structure, as defined in the
-<!-- .hN X11/Xutil.h -->
+<<filename class="headerfile">X11/Xutil.h</filename>>
header file.
</para>
<para>
<!-- .LP -->
The size of the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure may grow in future releases, as new components are
added to support new <acronym>ICCCM</acronym> features.
Passing statically allocated instances of this structure into
@@ -2270,7 +2270,7 @@ instances of the structure be used. <para>
<!-- .LP -->
To allocate an
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure, use
<function>XAllocSizeHints</function>.
</para>
@@ -2284,10 +2284,10 @@ XSizeHints *XAllocSizeHints() The
<function>XAllocSizeHints</function>
function allocates and returns a pointer to an
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure.
Note that all fields in the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure are initially set to zero.
If insufficient memory is available,
<function>XAllocSizeHints</function>
@@ -2299,7 +2299,7 @@ use <para>
<!-- .LP -->
The
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure contains:
</para>
@@ -2370,7 +2370,7 @@ in the absence of a window manager. <para>
<!-- .LP -->
Note that use of the
-<function>PAllHints</function>
+<symbol>PAllHints</symbol>
macro is highly discouraged.
<!-- .sp -->
</para>
@@ -2382,7 +2382,7 @@ To set a window's WM_NORMAL_HINTS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetWMNormalHints</function></funcdef>
+ <funcdef>void <function>XSetWMNormalHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints</parameter></paramdef>
@@ -2426,7 +2426,7 @@ Specifies the size hints for the window in its normal state. <!-- .LP -->
<!-- .eM -->
The
-<function>XSetWMNormalHints </function>
+<function>XSetWMNormalHints</function>
function replaces the size hints for the WM_NORMAL_HINTS property
on the specified window.
If the property does not already exist,
@@ -2438,9 +2438,9 @@ The property is stored with a type of WM_SIZE_HINTS and a format of 32. <!-- .LP -->
<function>XSetWMNormalHints</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -2452,7 +2452,7 @@ To read a window's WM_NORMAL_HINTS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMNormalHints</function></funcdef>
+ <funcdef>Status <function>XGetWMNormalHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints_return</parameter></paramdef>
@@ -2507,7 +2507,7 @@ Returns the hints that were supplied by the user. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetWMNormalHints </function>
+<function>XGetWMNormalHints</function>
function returns the size hints stored in the WM_NORMAL_HINTS property
on the specified window.
If the property is of type WM_SIZE_HINTS, is of format 32,
@@ -2515,7 +2515,7 @@ and is long enough to contain either an old (pre-<acronym>ICCCM</acronym>) or new size hints structure,
<function>XGetWMNormalHints</function>
sets the various fields of the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure, sets the supplied_return argument to the list of fields
that were supplied by the user (whether or not they contained defined values),
and returns a nonzero status.
@@ -2551,7 +2551,7 @@ PBaseSize|PWinGravity <!-- .LP -->
<function>XGetWMNormalHints</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
<!-- .sp -->
</para>
@@ -2563,7 +2563,7 @@ To set a window's WM_SIZE_HINTS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetWMSizeHints</function></funcdef>
+ <funcdef>void <function>XSetWMSizeHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints</parameter></paramdef>
@@ -2599,7 +2599,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure to be used.
</para>
</listitem>
@@ -2620,7 +2620,7 @@ Specifies the property name. <!-- .LP -->
<!-- .eM -->
The
-<function>XSetWMSizeHints </function>
+<function>XSetWMSizeHints</function>
function replaces the size hints for the specified property
on the named window.
If the specified property does not already exist,
@@ -2637,10 +2637,10 @@ function. <!-- .LP -->
<function>XSetWMSizeHints</function>
can generate
-<function>BadAlloc</function>,
-<function>BadAtom</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadAtom</errorname>,
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -2652,7 +2652,7 @@ To read a window's WM_SIZE_HINTS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMSizeHints</function></funcdef>
+ <funcdef>Status <function>XGetWMSizeHints</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XSizeHints<parameter> *hints_return</parameter></paramdef>
@@ -2689,7 +2689,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure.
</para>
</listitem>
@@ -2728,7 +2728,7 @@ and is long enough to contain either an old (pre-<acronym>ICCCM</acronym>) or new size hints structure,
<function>XGetWMSizeHints</function>
sets the various fields of the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure, sets the supplied_return argument to the
list of fields that were supplied by the user
(whether or not they contained defined values),
@@ -2736,7 +2736,7 @@ and returns a nonzero status. Otherwise, it returns a zero status.
To get a window's normal size hints,
you can use the
-<function>XGetWMNormalHints </function>
+<function>XGetWMNormalHints</function>
function.
</para>
<para>
@@ -2769,9 +2769,9 @@ PBaseSize|PWinGravity <!-- .LP -->
<function>XGetWMSizeHints</function>
can generate
-<function>BadAtom </function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect2>
@@ -2785,16 +2785,16 @@ errors. Xlib provides functions that you can use to set and get
the WM_CLASS property for a given window.
These functions use the
-<function>XClassHint </function>
+<structname>XClassHint</structname>
structure, which is defined in the
-<!-- .hN X11/Xutil.h -->
+<<filename class="headerfile">X11/Xutil.h</filename>>
header file.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To allocate an
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure, use
<function>XAllocClassHint</function>.
<indexterm significance="preferred"><primary>XAllocClassHint</primary></indexterm>
@@ -2811,10 +2811,10 @@ structure, use The
<function>XAllocClassHint</function>
function allocates and returns a pointer to an
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure.
Note that the pointer fields in the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure are initially set to NULL.
If insufficient memory is available,
<function>XAllocClassHint</function>
@@ -2826,7 +2826,7 @@ use <para>
<!-- .LP -->
The
-<function>XClassHint</function>
+<structname>XClassHint</structname>
contains:
</para>
<para>
@@ -2865,7 +2865,7 @@ To set a window's WM_CLASS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetClassHint</function></funcdef>
+ <funcdef><function>XSetClassHint</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XClassHint<parameter> *class_hints</parameter></paramdef>
@@ -2900,7 +2900,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure that is to be used.
</para>
</listitem>
@@ -2920,9 +2920,9 @@ the result is implementation-dependent. <!-- .LP -->
<function>XSetClassHint</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -2934,7 +2934,7 @@ To read a window's WM_CLASS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetClassHint</function></funcdef>
+ <funcdef>Status <function>XGetClassHint</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XClassHint<parameter> *class_hints_return</parameter></paramdef>
@@ -2969,7 +2969,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure.
</para>
</listitem>
@@ -2997,7 +2997,7 @@ on each individually. <!-- .LP -->
<function>XGetClassHint</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -3020,7 +3020,7 @@ To set a window's WM_TRANSIENT_FOR property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetTransientForHint</function></funcdef>
+ <funcdef><function>XSetTransientForHint</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window<parameter> prop_window</parameter></paramdef>
@@ -3072,9 +3072,9 @@ specified prop_window. <!-- .LP -->
<function>XSetTransientForHint</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3086,7 +3086,7 @@ To read a window's WM_TRANSIENT_FOR property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetTransientForHint</function></funcdef>
+ <funcdef>Status <function>XGetTransientForHint</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window<parameter> *prop_window_return</parameter></paramdef>
@@ -3139,7 +3139,7 @@ otherwise, it returns a zero status. <!-- .LP -->
<function>XGetTransientForHint</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -3162,7 +3162,7 @@ To set a window's WM_PROTOCOLS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XSetWMProtocols</function></funcdef>
+ <funcdef>Status <function>XSetWMProtocols</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Atom<parameter> *protocols</parameter></paramdef>
@@ -3218,7 +3218,7 @@ Specifies the number of (Cn. <!-- .LP -->
<!-- .eM -->
The
-<function>XSetWMProtocols </function>
+<function>XSetWMProtocols</function>
function replaces the WM_PROTOCOLS property on the specified window
with the list of atoms specified by the protocols argument.
If the property does not already exist,
@@ -3235,9 +3235,9 @@ Otherwise, it returns a nonzero status. <!-- .LP -->
<function>XSetWMProtocols</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -3249,7 +3249,7 @@ To read a window's WM_PROTOCOLS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMProtocols</function></funcdef>
+ <funcdef>Status <function>XGetWMProtocols</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Atom<parameter> **protocols_return</parameter></paramdef>
@@ -3305,7 +3305,7 @@ Returns the number of (Cn. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetWMProtocols </function>
+<function>XGetWMProtocols</function>
function returns the list of atoms stored in the WM_PROTOCOLS property
on the specified window.
These atoms describe window manager protocols in which the owner
@@ -3325,7 +3325,7 @@ To release the list of atoms, use <!-- .LP -->
<function>XGetWMProtocols</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -3348,7 +3348,7 @@ To set a window's WM_COLORMAP_WINDOWS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XSetWMColormapWindows</function></funcdef>
+ <funcdef>Status <function>XSetWMColormapWindows</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window<parameter> *colormap_windows</parameter></paramdef>
@@ -3404,7 +3404,7 @@ Specifies the number of (Cn. <!-- .LP -->
<!-- .eM -->
The
-<function>XSetWMColormapWindows </function>
+<function>XSetWMColormapWindows</function>
function replaces the WM_COLORMAP_WINDOWS property on the specified
window with the list of windows specified by the colormap_windows argument.
If the property does not already exist,
@@ -3421,9 +3421,9 @@ Otherwise, it returns a nonzero status. <!-- .LP -->
<function>XSetWMColormapWindows</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -3435,7 +3435,7 @@ To read a window's WM_COLORMAP_WINDOWS property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMColormapWindows</function></funcdef>
+ <funcdef>Status <function>XGetWMColormapWindows</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>Window<parameter> **colormap_windows_return</parameter></paramdef>
@@ -3491,7 +3491,7 @@ Returns the number of (Cn. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetWMColormapWindows </function>
+<function>XGetWMColormapWindows</function>
function returns the list of window identifiers stored
in the WM_COLORMAP_WINDOWS property on the specified window.
These identifiers indicate the colormaps that the window manager
@@ -3511,7 +3511,7 @@ To release the list of window identifiers, use <!-- .LP -->
<function>XGetWMColormapWindows</function>
can generate a
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -3525,17 +3525,17 @@ error. Xlib provides functions that you can use to set and read
the WM_ICON_SIZE property for a given window.
These functions use the
-<function>XIconSize </function>
+<structname>XIconSize</structname>
<indexterm><primary>XIconSize</primary></indexterm>
structure, which is defined in the
-<!-- .hN X11/Xutil.h -->
+<<filename class="headerfile">X11/Xutil.h</filename>>
header file.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To allocate an
-<function>XIconSize</function>
+<structname>XIconSize</structname>
structure, use
<function>XAllocIconSize</function>.
</para>
@@ -3548,12 +3548,12 @@ structure, use <!-- .LP -->
<!-- .eM -->
The
-<function>XAllocIconSize </function>
+<function>XAllocIconSize</function>
function allocates and returns a pointer to an
-<function>XIconSize </function>
+<structname>XIconSize</structname>
structure.
Note that all fields in the
-<function>XIconSize</function>
+<structname>XIconSize</structname>
structure are initially set to zero.
If insufficient memory is available,
<function>XAllocIconSize</function>
@@ -3565,7 +3565,7 @@ use <para>
<!-- .LP -->
The
-<function>XIconSize</function>
+<structname>XIconSize</structname>
structure contains:
</para>
<para>
@@ -3597,7 +3597,7 @@ To set a window's WM_ICON_SIZE property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetIconSizes</function></funcdef>
+ <funcdef><function>XSetIconSizes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XIconSize<parameter> *size_list</parameter></paramdef>
@@ -3659,9 +3659,9 @@ function is used only by window managers to set the supported icon sizes. <!-- .LP -->
<function>XSetIconSizes</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
</para>
<para>
@@ -3673,7 +3673,7 @@ To read a window's WM_ICON_SIZE property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetIconSizes</function></funcdef>
+ <funcdef>Status <function>XGetIconSizes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XIconSize<parameter> **size_list_return</parameter></paramdef>
@@ -3747,7 +3747,7 @@ To free the data allocated in size_list_return, use <!-- .LP -->
<function>XGetIconSizes</function>
can generate a
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
error.
</para>
</sect2>
@@ -3770,7 +3770,7 @@ WM_COMMAND, WM_CLIENT_MACHINE, and WM_LOCALE_NAME. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XmbSetWMProperties</function></funcdef>
+ <funcdef>void <function>XmbSetWMProperties</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> *window_name</parameter></paramdef>
@@ -3863,7 +3863,7 @@ Specifies the size hints for the window in its normal state. <listitem>
<para>
Specifies the
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure to be used.
</para>
</listitem>
@@ -3875,7 +3875,7 @@ structure to be used. <listitem>
<para>
Specifies the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure to be used.
</para>
</listitem>
@@ -3930,7 +3930,7 @@ An argc of zero indicates a zero-length command. <para>
<!-- .LP -->
The hostname of the machine is stored using
-<function>XSetWMClientMachine </function>
+<function>XSetWMClientMachine</function>
(see section 14.2.2).
</para>
<para>
@@ -3939,7 +3939,7 @@ If the class_hints argument is non-NULL, <function>XmbSetWMProperties</function>
sets the WM_CLASS property.
If the res_name member in the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure is set to the NULL pointer and the RESOURCE_NAME
environment variable is set,
the value of the environment variable is substituted for res_name.
@@ -3970,9 +3970,9 @@ and is converted to STRING for storage in the property. <!-- .LP -->
<function>XmbSetWMProperties</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -3988,7 +3988,7 @@ WM_COMMAND, and WM_CLIENT_MACHINE. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetWMProperties</function></funcdef>
+ <funcdef>void <function>XSetWMProperties</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *window_name</parameter></paramdef>
@@ -4081,7 +4081,7 @@ Specifies the size hints for the window in its normal state. <listitem>
<para>
Specifies the
-<function>XWMHints</function>
+<structname>XWMHints</structname>
structure to be used.
</para>
</listitem>
@@ -4093,7 +4093,7 @@ structure to be used. <listitem>
<para>
Specifies the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure to be used.
</para>
</listitem>
@@ -4104,7 +4104,7 @@ structure to be used. <!-- .LP -->
<!-- .eM -->
The
-<function>XSetWMProperties </function>
+<function>XSetWMProperties</function>
convenience function provides a single programming interface
for setting those essential window properties that are used
for communicating with other clients (particularly window and session
@@ -4129,7 +4129,7 @@ calls which sets the WM_COMMAND property (see section 14.2.1).
Note that an argc of zero is allowed to indicate a zero-length command.
Note also that the hostname of this machine is stored using
-<function>XSetWMClientMachine </function>
+<function>XSetWMClientMachine</function>
(see section 14.2.2).
</para>
<para>
@@ -4153,7 +4153,7 @@ calls <function>XSetClassHint</function>,
which sets the WM_CLASS property (see section 14.1.8).
If the res_name member in the
-<function>XClassHint</function>
+<structname>XClassHint</structname>
structure is set to the NULL pointer and the RESOURCE_NAME environment
variable is set,
then the value of the environment variable is substituted for res_name.
@@ -4167,9 +4167,9 @@ any directory prefixes, is substituted for res_name. <!-- .LP -->
<function>XSetWMProperties</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
</para>
</sect2>
@@ -4214,7 +4214,7 @@ To set a window's WM_COMMAND property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetCommand</function></funcdef>
+ <funcdef><function>XSetCommand</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> **argv</parameter></paramdef>
@@ -4280,9 +4280,9 @@ the result is implementation-dependent. <!-- .LP -->
<function>XSetCommand</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadWindow </function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
@@ -4294,7 +4294,7 @@ To read a window's WM_COMMAND property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetCommand</function></funcdef>
+ <funcdef>Status <function>XGetCommand</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>char<parameter> ***argv_return</parameter></paramdef>
@@ -4349,7 +4349,7 @@ Returns the number of arguments returned. <!-- .LP -->
<!-- .eM -->
The
-<function>XGetCommand </function>
+<function>XGetCommand</function>
function reads the WM_COMMAND property from the specified window
and returns a string list.
If the WM_COMMAND property exists,
@@ -4385,7 +4385,7 @@ To set a window's WM_CLIENT_MACHINE property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetWMClientMachine</function></funcdef>
+ <funcdef>void <function>XSetWMClientMachine</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop</parameter></paramdef>
@@ -4420,7 +4420,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure to be used.
</para>
</listitem>
@@ -4445,7 +4445,7 @@ To read a window's WM_CLIENT_MACHINE property, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetWMClientMachine</function></funcdef>
+ <funcdef>Status <function>XGetWMClientMachine</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XTextProperty<parameter> *text_prop_return</parameter></paramdef>
@@ -4480,7 +4480,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XTextProperty</function>
+<structname>XTextProperty</structname>
structure.
</para>
</listitem>
@@ -4493,7 +4493,7 @@ structure. The
<function>XGetWMClientMachine</function>
convenience function performs an
-<function>XGetTextProperty </function>
+<function>XGetTextProperty</function>
on the WM_CLIENT_MACHINE property.
It returns a nonzero status on success;
otherwise, it returns a zero status.
@@ -4605,7 +4605,7 @@ Applications should use the standard colormaps if they already exist. <para>
<!-- .LP -->
To allocate an
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure, use
<function>XAllocStandardColormap</function>.
</para>
@@ -4619,10 +4619,10 @@ XStandardColormap *XAllocStandardColormap() The
<function>XAllocStandardColormap</function>
function allocates and returns a pointer to an
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure.
Note that all fields in the
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure are initially set to zero.
If insufficient memory is available,
<function>XAllocStandardColormap</function>
@@ -4634,7 +4634,7 @@ use <para>
<!-- .LP -->
The
-<function>XStandardColormap </function>
+<structname>XStandardColormap</structname>
structure contains:
</para>
<literallayout class="monospaced">
@@ -4707,13 +4707,13 @@ using the following expression: <para>
<!-- .LP -->
For
-<function>GrayScale</function>
+<symbol>GrayScale</symbol>
colormaps,
only the colormap, red_max, red_mult,
and base_pixel members are defined.
The other members are ignored.
To compute a
-<function>GrayScale </function>
+<symbol>GrayScale</symbol>
pixel value, use the following expression:
</para>
<para>
@@ -4748,7 +4748,7 @@ function on the indicated resource. <para>
<!-- .LP -->
The properties containing the
-<function>XStandardColormap </function>
+<structname>XStandardColormap</structname>
information have
the type RGB_COLOR_MAP.
</para>
@@ -4772,7 +4772,7 @@ and each such property is identified by an atom. The following list names the atoms and describes the colormap
associated with each one.
The
-<!-- .hN X11/Xatom.h -->
+<<filename class="headerfile">X11/Xatom.h</filename>>
header file contains the definitions for each of the following atoms,
which are prefixed with XA_.
</para>
@@ -4786,7 +4786,7 @@ which are prefixed with XA_. <para>
This atom names a property.
The value of the property is an array of
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structures.
Each entry in the array describes an <acronym>RGB</acronym> subset of the default color
map for the Visual specified by visual_id.
@@ -4813,7 +4813,7 @@ for text, borders, and so on. <listitem>
<para>
This atom names a property. The value of the property is an
-<function>XStandardColormap</function>.
+<structname>XStandardColormap</structname>.
</para>
<para>
The property defines the best <acronym>RGB</acronym> colormap available on
@@ -4827,11 +4827,11 @@ red, as well as more green or red than blue. </para>
<para>
For an 8-plane
-<function>PseudoColor </function>
+<symbol>PseudoColor</symbol>
visual,
RGB_BEST_MAP is likely to be a 3/3/2 allocation.
For a 24-plane
-<function>DirectColor </function>
+<symbol>DirectColor</symbol>
visual,
RGB_BEST_MAP is normally an 8/8/8 allocation.
</para>
@@ -4843,7 +4843,7 @@ RGB_BEST_MAP is normally an 8/8/8 allocation. <para>
These atoms name properties.
The value of each property is an
-<function>XStandardColormap</function>.
+<structname>XStandardColormap</structname>.
</para>
<para>
The properties define all-red, all-green, and all-blue
@@ -4863,17 +4863,17 @@ and once with blue) and by multiply exposing a single frame in a camera. <para>
This atom names a property.
The value of the property is an
-<function>XStandardColormap</function>.
+<structname>XStandardColormap</structname>.
</para>
<para>
The property describes the best
-<function>GrayScale </function>
+<symbol>GrayScale</symbol>
colormap available on the screen.
As previously mentioned,
only the colormap, red_max, red_mult, and base_pixel members of the
-<function>XStandardColormap </function>
+<structname>XStandardColormap</structname>
structure are used for
-<function>GrayScale </function>
+<symbol>GrayScale</symbol>
colormaps.
</para>
</listitem>
@@ -4890,21 +4890,21 @@ colormaps. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and obtain an
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To set an
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure, use
<function>XSetRGBColormaps</function>.
<indexterm significance="preferred"><primary>XSetRGBColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void<function> XSetRGBColormaps</function></funcdef>
+ <funcdef>void <function>XSetRGBColormaps</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XStandardColormap<parameter> *std_colormap</parameter></paramdef>
@@ -4941,7 +4941,7 @@ Specifies the window. <listitem>
<para>
Specifies the
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure to be used.
<!-- .ds Cn colormaps -->
</para>
@@ -4973,7 +4973,7 @@ Specifies the property name. <!-- .LP -->
<!-- .eM -->
The
-<function>XSetRGBColormaps </function>
+<function>XSetRGBColormaps</function>
function replaces the <acronym>RGB</acronym> colormap definition in the specified property
on the named window.
If the property does not already exist,
@@ -5027,7 +5027,7 @@ Determine the color characteristics of the visual. <listitem>
<para>
Allocate cells in the colormap (or create it with
-<function>AllocAll</function>).
+<symbol>AllocAll</symbol>).
</para>
</listitem>
<listitem>
@@ -5040,7 +5040,7 @@ to store appropriate color values in the colormap. <listitem>
<para>
Fill in the descriptive members in the
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure.
</para>
</listitem>
@@ -5067,24 +5067,24 @@ Ungrab the server. <!-- .LP -->
<function>XSetRGBColormaps</function>
can generate
-<function>BadAlloc</function>,
-<function>BadAtom</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadAtom</errorname>,
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
To obtain the
-<function>XStandardColormap </function>
+<structname>XStandardColormap</structname>
structure associated with the specified property, use
<function>XGetRGBColormaps</function>.
<indexterm significance="preferred"><primary>XGetRGBColormaps</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status<function> XGetRGBColormaps</function></funcdef>
+ <funcdef>Status <function>XGetRGBColormaps</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
<paramdef>XStandardColormap<parameter> **std_colormap_return</parameter></paramdef>
@@ -5121,7 +5121,7 @@ Specifies the window. <listitem>
<para>
Returns the
-<function>XStandardColormap</function>
+<structname>XStandardColormap</structname>
structure.
<!-- .ds Cn colormaps -->
</para>
@@ -5162,10 +5162,10 @@ and is long enough to contain a colormap definition, allocates and fills in space for the returned colormaps
and returns a nonzero status.
If the visualid is not present,
-<function>XGetRGBColormaps </function>
+<function>XGetRGBColormaps</function>
assumes the default visual for the screen on which the window is located;
if the killid is not present,
-<function>None</function>
+<symbol>None</symbol>
is assumed, which indicates that the resources cannot be released.
Otherwise,
none of the fields are set, and
@@ -5178,9 +5178,9 @@ restriction that only RGB_DEFAULT_MAP contain more than one definition. <!-- .LP -->
<function>XGetRGBColormaps</function>
can generate
-<function>BadAtom</function>
+<errorname>BadAtom</errorname>
and
-<function>BadWindow</function>
+<errorname>BadWindow</errorname>
errors.
<!-- .bp -->
diff --git a/libX11/specs/libX11/CH15.xml b/libX11/specs/libX11/CH15.xml index 299a1196f..844f1d204 100644 --- a/libX11/specs/libX11/CH15.xml +++ b/libX11/specs/libX11/CH15.xml @@ -123,7 +123,7 @@ value for that entry. <para>
<!-- .LP -->
The definitions for the resource manager are contained in
-<!-- .hN X11/Xresource.h . -->
+<<filename class="headerfile">X11/Xresource.h</filename>>.
</para>
<sect1 id="Resource_File_Syntax">
<title>Resource File Syntax</title>
@@ -337,7 +337,7 @@ in many of the resource manager functions. Simple comparisons can be performed rather than string comparisons.
The shorthand name for a string is called a quark and is the
type
-<function>XrmQuark</function>.
+<type>XrmQuark</type>.
On some occasions,
you may want to allocate a quark that has no string equivalent.
</para>
@@ -368,7 +368,7 @@ is known to the resource manager. <!-- .LP -->
<!-- .sp -->
Each name, class, and representation type is typedef'd as an
-<function>XrmQuark</function>.
+<type>XrmQuark</type>.
</para>
<para>
<!-- .LP -->
@@ -473,7 +473,7 @@ To convert a quark to a string, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char <function> *XrmQuarkToString</function></funcdef>
+ <funcdef>char *<function>XrmQuarkToString</function></funcdef>
<paramdef>XrmQuark<parameter> quark</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -520,7 +520,7 @@ To convert a string with one or more components to a quark list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmStringToQuarkList</function></funcdef>
+ <funcdef>void <function>XrmStringToQuarkList</function></funcdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>XrmQuarkList<parameter> quarks_return</parameter></paramdef>
</funcprototype>
@@ -567,7 +567,7 @@ the conversion is implementation-dependent. <para>
<!-- .LP -->
A binding list is a list of type
-<function>XrmBindingList</function>
+<type>XrmBindingList</type>
and indicates if components of name or class lists are bound tightly or loosely
(that is, if wildcarding of intermediate components is specified).
</para>
@@ -579,9 +579,9 @@ typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList; </para>
<para>
<!-- .LP -->
-<function>XrmBindTightly</function>
+<constant>XrmBindTightly</constant>
indicates that a period separates the components, and
-<function>XrmBindLoosely</function>
+<constant>XrmBindLoosely</constant>
indicates that an asterisk separates the components.
</para>
<para>
@@ -594,7 +594,7 @@ and a quark list, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XrmStringToBindingQuarkList</function></funcdef>
+ <funcdef><function>XrmStringToBindingQuarkList</function></funcdef>
<paramdef>char<parameter> *string</parameter></paramdef>
<paramdef>XrmBindingList<parameter> bindings_return</parameter></paramdef>
<paramdef>XrmQuarkList<parameter> quarks_return</parameter></paramdef>
@@ -668,9 +668,9 @@ bindings: loose tight loose <!-- .LP -->
<indexterm significance="preferred"><primary>XrmDatabase</primary></indexterm>
A resource database is an opaque type,
-<function>XrmDatabase</function>.
+<type>XrmDatabase</type>.
Each database value is stored in an
-<function>XrmValue </function>
+<type>XrmValue</type>
structure.
This structure consists of a size, an address, and a representation type.
The size is specified in bytes.
@@ -678,7 +678,7 @@ The representation type is a way for you to store data tagged by some application-defined type (for example, the strings ``font'' or ``color'').
It has nothing to do with the C data type or with its class.
The
-<function>XrmValue </function>
+<type>XrmValue</type>
structure is defined as:
</para>
<para>
@@ -704,7 +704,7 @@ To initialize the resource manager, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmInitialize</function></funcdef>
+ <funcdef>void <function>XrmInitialize</function></funcdef>
<paramdef>void<parameter> XrmInitialize(\|)</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -719,7 +719,7 @@ To retrieve a database from disk, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XrmDatabase <function> XrmGetFileDatabase</function></funcdef>
+ <funcdef>XrmDatabase <function>XrmGetFileDatabase</function></funcdef>
<paramdef>char<parameter> *filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -763,7 +763,7 @@ To store a copy of a database to disk, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmPutFileDatabase</function></funcdef>
+ <funcdef>void <function>XrmPutFileDatabase</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
<paramdef>char<parameter> *stored_db</parameter></paramdef>
</funcprototype>
@@ -816,7 +816,7 @@ To obtain a pointer to the screen-independent resources of a display, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XResourceManagerString</function></funcdef>
+ <funcdef>char *<function>XResourceManagerString</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -860,7 +860,7 @@ To obtain a pointer to the screen-specific resources of a screen, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XScreenResourceString</function></funcdef>
+ <funcdef>char *<function>XScreenResourceString</function></funcdef>
<paramdef>Screen<parameter> *screen</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -904,7 +904,7 @@ To create a database from a string, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XrmDatabase <function> XrmGetStringDatabase</function></funcdef>
+ <funcdef>XrmDatabase <function>XrmGetStringDatabase</function></funcdef>
<paramdef>char<parameter> *data</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -949,7 +949,7 @@ To obtain the locale name of a database, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XrmLocaleOfDatabase</function></funcdef>
+ <funcdef>char *<function>XrmLocaleOfDatabase</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -989,7 +989,7 @@ To destroy a resource database and free its allocated memory, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmDestroyDatabase</function></funcdef>
+ <funcdef>void <function>XrmDestroyDatabase</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1023,7 +1023,7 @@ To associate a resource database with a display, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmSetDatabase</function></funcdef>
+ <funcdef>void <function>XrmSetDatabase</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
</funcprototype>
@@ -1072,7 +1072,7 @@ To get the resource database associated with a display, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XrmDatabase <function> XrmGetDatabase</function></funcdef>
+ <funcdef>XrmDatabase <function>XrmGetDatabase</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1112,7 +1112,7 @@ To merge the contents of a resource file into a database, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status <function> XrmCombineFileDatabase</function></funcdef>
+ <funcdef>Status <function>XrmCombineFileDatabase</function></funcdef>
<paramdef>char<parameter> *filename</parameter></paramdef>
<paramdef>XrmDatabase<parameter> *target_db</parameter></paramdef>
<paramdef>Bool<parameter> override</parameter></paramdef>
@@ -1163,7 +1163,7 @@ If the same specifier is used for an entry in both the file and the database,
the entry in the file will replace the entry in the database
if override is
-<function>True</function>;
+<symbol>True</symbol>;
otherwise, the entry in the file is discarded.
The file is parsed in the current locale.
If the file cannot be read,
@@ -1186,7 +1186,7 @@ To merge the contents of one database into another database, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmCombineDatabase</function></funcdef>
+ <funcdef>void <function>XrmCombineDatabase</function></funcdef>
<paramdef>XrmDatabasesource_db,<parameter> *target_db</parameter></paramdef>
<paramdef>Bool<parameter> override</parameter></paramdef>
</funcprototype>
@@ -1235,7 +1235,7 @@ function merges the contents of one database into another. If the same specifier is used for an entry in both databases,
the entry in the source_db will replace the entry in the target_db
if override is
-<function>True</function>;
+<symbol>True</symbol>;
otherwise, the entry in source_db is discarded.
If target_db contains NULL,
<function>XrmCombineDatabase</function>
@@ -1256,7 +1256,7 @@ semantics, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmMergeDatabases</function></funcdef>
+ <funcdef>void <function>XrmMergeDatabases</function></funcdef>
<paramdef>XrmDatabasesource_db,<parameter> *target_db</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1293,7 +1293,7 @@ Calling the function is equivalent to calling the
<function>XrmCombineDatabase</function>
function with an override argument of
-<function>True</function>.
+<symbol>True</symbol>.
</para>
</sect1>
<sect1 id="Looking_Up_Resources">
@@ -1316,7 +1316,7 @@ or <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XrmGetResource</function></funcdef>
+ <funcdef>Bool <function>XrmGetResource</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
<paramdef>char<parameter> *str_name</parameter></paramdef>
<paramdef>char<parameter> *str_class</parameter></paramdef>
@@ -1386,7 +1386,7 @@ Returns the value in the database. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XrmQGetResource</function></funcdef>
+ <funcdef>Bool <function>XrmQGetResource</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
<paramdef>XrmNameList<parameter> quark_name</parameter></paramdef>
<paramdef>XrmClassList<parameter> quark_class</parameter></paramdef>
@@ -1452,9 +1452,9 @@ Returns the value in the database. <!-- .LP -->
<!-- .eM -->
The
-<function>XrmGetResource </function>
+<function>XrmGetResource</function>
and
-<function>XrmQGetResource </function>
+<function>XrmQGetResource</function>
functions retrieve a resource from the specified database.
Both take a fully qualified name/class pair, a destination
resource representation, and the address of a value
@@ -1473,13 +1473,13 @@ A client that is not storing new values into the database or is not merging the database should be safe using the address passed
back at any time until it exits.
If a resource was found, both
-<function>XrmGetResource </function>
+<function>XrmGetResource</function>
and
-<function>XrmQGetResource </function>
+<function>XrmQGetResource</function>
return
-<function>True</function>;
+<symbol>True</symbol>;
otherwise, they return
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1493,7 +1493,7 @@ The X toolkit access pattern for a resource database is quite stylized. A series of from 1 to 20 probes is made with only the
last name/class differing in each probe.
The
-<function>XrmGetResource </function>
+<function>XrmGetResource</function>
function is at worst a %2 sup n% algorithm, <!-- FIXME: log(n) ? -->
where <emphasis remap='I'>n</emphasis> is the length of the name/class list.
This can be improved upon by the application programmer by prefetching a list
@@ -1508,7 +1508,7 @@ To obtain a list of database levels, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XrmQGetSearchResource</function></funcdef>
+ <funcdef>Bool <function>XrmQGetSearchResource</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
<paramdef>XrmNameList<parameter> names</parameter></paramdef>
<paramdef>XrmClassList<parameter> classes</parameter></paramdef>
@@ -1581,14 +1581,14 @@ function takes a list of names and classes and returns a list of database levels where a match might occur.
The returned list is in best-to-worst order and
uses the same algorithm as
-<function>XrmGetResource </function>
+<function>XrmGetResource</function>
for determining precedence.
If list_return was large enough for the search list,
<function>XrmQGetSearchList</function>
returns
-<function>True</function>;
+<symbol>True</symbol>;
otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -1601,7 +1601,7 @@ where <emphasis remap='I'>n</emphasis> is the number of name or class components <para>
<!-- .LP -->
When using
-<function>XrmQGetSearchList </function>
+<function>XrmQGetSearchList</function>
followed by multiple probes for resources with a common name and class prefix,
only the common prefix should be specified in the name and class list to
<function>XrmQGetSearchList</function>.
@@ -1615,7 +1615,7 @@ To search resource database levels for a given resource, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XrmQGetSearchResource</function></funcdef>
+ <funcdef>Bool <function>XrmQGetSearchResource</function></funcdef>
<paramdef>XrmSearchList<parameter> list</parameter></paramdef>
<paramdef>XrmName<parameter> name</parameter></paramdef>
<paramdef>XrmClass<parameter> class</parameter></paramdef>
@@ -1688,22 +1688,22 @@ that is fully identified by the specified name and class. The search stops with the first match.
<function>XrmQGetSearchResource</function>
returns
-<function>True </function>
+<symbol>True</symbol>
if the resource was found;
otherwise, it returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
A call to
-<function>XrmQGetSearchList </function>
+<function>XrmQGetSearchList</function>
with a name and class list containing all but the last component
of a resource name followed by a call to
-<function>XrmQGetSearchResource </function>
+<function>XrmQGetSearchResource</function>
with the last component name and class returns the same database entry as
-<function>XrmGetResource </function>
+<function>XrmGetResource</function>
and
-<function>XrmQGetResource </function>
+<function>XrmQGetResource</function>
with the fully qualified name and class.
</para>
</sect1>
@@ -1715,7 +1715,7 @@ with the fully qualified name and class. <para>
<!-- .LP -->
To store resources into the database, use
-<function>XrmPutResource </function>
+<function>XrmPutResource</function>
or
<function>XrmQPutResource</function>.
Both functions take a partial resource specification, a
@@ -1729,7 +1729,7 @@ This value is copied into the specified database. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmPutResource</function></funcdef>
+ <funcdef>void <function>XrmPutResource</function></funcdef>
<paramdef>XrmDatabase<parameter> *database</parameter></paramdef>
<paramdef>char<parameter> *specifier</parameter></paramdef>
<paramdef>char<parameter> *type</parameter></paramdef>
@@ -1807,7 +1807,7 @@ The value is stored in the database without modification. <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmQPutResource</function></funcdef>
+ <funcdef>void <function>XrmQPutResource</function></funcdef>
<paramdef>XrmDatabase<parameter> *database</parameter></paramdef>
<paramdef>XrmBindingList<parameter> bindings</parameter></paramdef>
<paramdef>XrmQuarkList<parameter> quarks</parameter></paramdef>
@@ -1889,7 +1889,7 @@ To add a resource that is specified as a string, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmPutStringResource</function></funcdef>
+ <funcdef>void <function>XrmPutStringResource</function></funcdef>
<paramdef>XrmDatabase<parameter> *database</parameter></paramdef>
<paramdef>char<parameter> *specifier</parameter></paramdef>
<paramdef>char<parameter> *value</parameter></paramdef>
@@ -1956,7 +1956,7 @@ To add a string resource using quarks as a specification, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmQPutStringResource</function></funcdef>
+ <funcdef>void <function>XrmQPutStringResource</function></funcdef>
<paramdef>XrmDatabase<parameter> *database</parameter></paramdef>
<paramdef>XrmBindingList<parameter> bindings</parameter></paramdef>
<paramdef>XrmQuarkList<parameter> quarks</parameter></paramdef>
@@ -2015,7 +2015,7 @@ If database contains NULL, creates a new database and returns a pointer to it.
<function>XrmQPutStringResource</function>
is a convenience routine that constructs an
-<function>XrmValue</function>
+<type>XrmValue</type>
for the value string (by calling
<function>strlen</function>
to compute the size) and
@@ -2034,7 +2034,7 @@ both a name and a value, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmPutLineResource</function></funcdef>
+ <funcdef>void <function>XrmPutLineResource</function></funcdef>
<paramdef>XrmDatabase<parameter> *database</parameter></paramdef>
<paramdef>char<parameter> *line</parameter></paramdef>
</funcprototype>
@@ -2077,7 +2077,7 @@ the database that results from using a string with incorrect syntax is implementation-dependent.
The string is parsed in the locale of the database.
If the
-<function>ResourceName</function>
+<replaceable>ResourceName</replaceable>
is not in the Host Portable Character Encoding,
the result is implementation-dependent.
Note that comment lines are not stored.
@@ -2103,7 +2103,7 @@ To enumerate the entries of a database, use <funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XrmEnumerateDatabase</function></funcdef>
+ <funcdef>Bool <function>XrmEnumerateDatabase</function></funcdef>
<paramdef>XrmDatabase<parameter> database</parameter></paramdef>
<paramdef>XrmNameList<parameter> name_prefix</parameter></paramdef>
<paramdef>XrmClassList<parameter> class_prefix</parameter></paramdef>
@@ -2185,20 +2185,20 @@ function calls the specified procedure for each resource in the database that would match some completion of the given name/class resource prefix.
The order in which resources are found is implementation-dependent.
If mode is
-<function>XrmEnumOneLevel</function>,
+<symbol>XrmEnumOneLevel</symbol>,
a resource must match the given name/class prefix with
just a single name and class appended. If mode is
-<function>XrmEnumAllLevels</function>,
+<symbol>XrmEnumAllLevels</symbol>,
the resource must match the given name/class prefix with one or more names and
classes appended.
If the procedure returns
-<function>True</function>,
+<symbol>True</symbol>,
the enumeration terminates and the function returns
-<function>True</function>.
+<symbol>True</symbol>.
If the procedure always returns
-<function>False</function>,
+<symbol>False</symbol>,
all matching resources are enumerated and the function returns
-<function>False</function>.
+<symbol>False</symbol>.
</para>
<para>
<!-- .LP -->
@@ -2223,7 +2223,7 @@ The procedure is called with the following arguments: <para>
<!-- .LP -->
The bindings and quarks lists are terminated by
-<function>NULLQUARK</function>.
+<symbol>NULLQUARK</symbol>.
Note that pointers
to the database and type are passed, but these values should not be modified.
</para>
@@ -2271,14 +2271,14 @@ typedef enum { <!-- .LP -->
<!-- .eM -->
Note that
-<function>XrmoptionSkipArg</function>
+<constant>XrmoptionSkipArg</constant>
is equivalent to
-<function>XrmoptionSkipNArgs</function>
+<constant>XrmoptionSkipNArgs</constant>
with the
-<function>XrmOptionDescRec.value</function>
+<structname>XrmOptionDescRec</structname>.<structfield>value</structfield>
field containing the value one.
Note also that the value zero for
-<function>XrmoptionSkipNArgs</function>
+<constant>XrmoptionSkipNArgs</constant>
indicates that only the option itself is to be skipped.
</para>
<para>
@@ -2307,7 +2307,7 @@ To load a resource database from a C command line, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XrmParseCommand</function></funcdef>
+ <funcdef>void <function>XrmParseCommand</function></funcdef>
<paramdef>XrmDatabase<parameter> *database</parameter></paramdef>
<paramdef>XrmOptionDescList<parameter> table</parameter></paramdef>
<paramdef>int<parameter> table_count</parameter></paramdef>
@@ -2404,7 +2404,7 @@ in the order they occur in argv. The table entries contain information on the option string,
the option name, the style of option,
and a value to provide if the option kind is
-<function>XrmoptionNoArg</function>.
+<constant>XrmoptionNoArg</constant>.
The option names are compared byte-for-byte to arguments in argv,
independent of any locale.
The resource values given in the table are stored in the resource database
diff --git a/libX11/specs/libX11/CH16.xml b/libX11/specs/libX11/CH16.xml index 7575c4a61..c3751cc09 100644 --- a/libX11/specs/libX11/CH16.xml +++ b/libX11/specs/libX11/CH16.xml @@ -99,7 +99,7 @@ To obtain a KeySym for the KeyCode of an event, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>KeySym <function> XLookupKeysym</function></funcdef>
+ <funcdef>KeySym <function>XLookupKeysym</function></funcdef>
<paramdef>XKeyEvent<parameter> *key_event</parameter></paramdef>
<paramdef>int<parameter> index</parameter></paramdef>
</funcprototype>
@@ -113,9 +113,9 @@ To obtain a KeySym for the KeyCode of an event, use <listitem>
<para>
Specifies the
-<function>KeyPress</function>
+<symbol>KeyPress</symbol>
or
-<function>KeyRelease</function>
+<symbol>KeyRelease</symbol>
event.
</para>
</listitem>
@@ -139,14 +139,14 @@ The <function>XLookupKeysym</function>
function uses a given keyboard event and the index you specified to return
the KeySym from the list that corresponds to the KeyCode member in the
-<function>XKeyPressedEvent</function>
+<type>XKeyPressedEvent</type>
or
-<function>XKeyReleasedEvent</function>
+<type>XKeyReleasedEvent</type>
structure.
If no KeySym is defined for the KeyCode of the event,
<function>XLookupKeysym</function>
returns
-<function>NoSymbol</function>.
+<symbol>NoSymbol</symbol>.
</para>
<para>
<!-- .LP -->
@@ -157,7 +157,7 @@ To obtain a KeySym for a specific KeyCode, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>KeySym <function> XKeycodeToKeysym</function></funcdef>
+ <funcdef>KeySym <function>XKeycodeToKeysym</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>KeyCode<parameter> keycode</parameter></paramdef>
<paramdef>int<parameter> index</parameter></paramdef>
@@ -208,7 +208,7 @@ the element of the KeyCode vector. If no symbol is defined,
<function>XKeycodeToKeysym</function>
returns
-<function>NoSymbol</function>.
+<symbol>NoSymbol</symbol>.
</para>
<para>
<!-- .LP -->
@@ -219,7 +219,7 @@ To obtain a KeyCode for a key having a specific KeySym, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>KeyCode <function> XKeysymToKeycode</function></funcdef>
+ <funcdef>KeyCode <function>XKeysymToKeycode</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>KeySym<parameter> keysym</parameter></paramdef>
</funcprototype>
@@ -267,7 +267,7 @@ To refresh the stored modifier and keymap information, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRefreshKeyboardMapping</function></funcdef>
+ <funcdef><function>XRefreshKeyboardMapping</function></funcdef>
<paramdef>XMappingEvent<parameter> *event_map</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -292,11 +292,11 @@ The <function>XRefreshKeyboardMapping</function>
function refreshes the stored modifier and keymap information.
You usually call this function when a
-<function>MappingNotify</function>
+<symbol>MappingNotify</symbol>
event with a request member of
-<function>MappingKeyboard</function>
+<symbol>MappingKeyboard</symbol>
or
-<function>MappingModifier</function>
+<symbol>MappingModifier</symbol>
occurs.
The result is to update Xlib's knowledge of the keyboard.
</para>
@@ -309,7 +309,7 @@ To obtain the uppercase and lowercase forms of a KeySym, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>void <function> XConvertCase</function></funcdef>
+ <funcdef>void <function>XConvertCase</function></funcdef>
<paramdef>KeySym<parameter> keysym</parameter></paramdef>
<paramdef>KeySym<parameter> *lower_return</parameter></paramdef>
<paramdef>KeySym<parameter> *upper_return</parameter></paramdef>
@@ -372,7 +372,7 @@ To convert the name of the KeySym to the KeySym code, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>KeySym <function> XStringToKeysym</function></funcdef>
+ <funcdef>KeySym <function>XStringToKeysym</function></funcdef>
<paramdef>char<parameter> *string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -394,7 +394,7 @@ Specifies the name of the KeySym that is to be converted. <!-- .LP -->
<!-- .eM -->
Standard KeySym names are obtained from
-<!-- .hN X11/keysymdef.h -->
+<<filename class="headerfile">X11/keysymdef.h</filename>>
by removing the XK_ prefix from each name.
KeySyms that are not part of the Xlib standard also may be obtained
with this function.
@@ -408,7 +408,7 @@ the result is implementation-dependent. If the specified string does not match a valid KeySym,
<function>XStringToKeysym</function>
returns
-<function>NoSymbol</function>.
+<symbol>NoSymbol</symbol>.
</para>
<para>
<!-- .LP -->
@@ -419,7 +419,7 @@ To convert a KeySym code to the name of the KeySym, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XKeysymToString</function></funcdef>
+ <funcdef>char *<function>XKeysymToString</function></funcdef>
<paramdef>KeySym<parameter> keysym</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -479,7 +479,7 @@ Specifies the KeySym that is to be tested. <!-- .eM -->
<indexterm significance="preferred"><primary>IsCursorKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a cursor key.
</para>
<!-- .LP -->
@@ -506,7 +506,7 @@ Specifies the KeySym that is to be tested. <!-- .eM -->
<indexterm significance="preferred"><primary>IsFunctionKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a function key.
</para>
<!-- .LP -->
@@ -533,7 +533,7 @@ Specifies the KeySym that is to be (Fn. <!-- .eM -->
<indexterm significance="preferred"><primary>IsKeypadKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a standard keypad key.
</para>
<!-- .LP -->
@@ -559,7 +559,7 @@ Specifies the KeySym that is to be (Fn. <!-- .eM -->
<indexterm significance="preferred"><primary>IsPrivateKeypadKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a vendor-private keypad key.
</para>
@@ -587,7 +587,7 @@ Specifies the KeySym that is to be (Fn. <!-- .eM -->
<indexterm significance="preferred"><primary>IsMiscFunctionKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a miscellaneous function key.
</para>
<!-- .LP -->
@@ -613,7 +613,7 @@ Specifies the KeySym that is to be tested. <!-- .eM -->
<indexterm significance="preferred"><primary>IsModifierKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a modifier key.
</para>
@@ -637,7 +637,7 @@ Specifies the KeySym that is to be tested. <!-- .eM -->
<indexterm significance="preferred"><primary>IsPFKey</primary></indexterm>
Returns
-<function>True</function>
+<symbol>True</symbol>
if the specified KeySym is a PF key.
</para>
</sect2>
@@ -667,7 +667,7 @@ To map a key event to an ISO Latin-1 string, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XLookupString</function></funcdef>
+ <funcdef>int <function>XLookupString</function></funcdef>
<paramdef>XKeyEvent<parameter> *event_struct</parameter></paramdef>
<paramdef>char<parameter> *buffer_return</parameter></paramdef>
<paramdef>int<parameter> bytes_buffer</parameter></paramdef>
@@ -685,9 +685,9 @@ To map a key event to an ISO Latin-1 string, use <para>
Specifies the key event structure to be used.
You can pass
-<function>XKeyPressedEvent</function>
+<type>XKeyPressedEvent</type>
or
-<function>XKeyReleasedEvent</function>.
+<type>XKeyReleasedEvent</type>.
</para>
</listitem>
</varlistentry>
@@ -729,7 +729,7 @@ Returns the KeySym computed from the event if this argument is not NULL. <listitem>
<para>
Specifies or returns the
-<function>XComposeStatus </function>
+<structname>XComposeStatus</structname>
structure or NULL.
</para>
</listitem>
@@ -743,8 +743,8 @@ The <function>XLookupString</function>
function translates a key event to a KeySym and a string.
The KeySym is obtained by using the standard interpretation of the
-<function>Shift</function>,
-<function>Lock</function>,
+<symbol>Shift</symbol>,
+<symbol>Lock</symbol>,
group, and numlock modifiers as defined in the X Protocol specification.
If the KeySym has been rebound (see
<function>XRebindKeysym</function>),
@@ -759,14 +759,14 @@ returns the number of characters that are stored in the buffer. <!-- .LP -->
If present (non-NULL),
the
-<function>XComposeStatus</function>
+<structname>XComposeStatus</structname>
structure records the state,
which is private to Xlib,
that needs preservation across calls to
<function>XLookupString</function>
to implement compose processing.
The creation of
-<function>XComposeStatus</function>
+<structname>XComposeStatus</structname>
structures is implementation-dependent;
a portable program must pass NULL for this argument.
</para>
@@ -789,7 +789,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRebindKeysym</function></funcdef>
+ <funcdef><function>XRebindKeysym</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>KeySym<parameter> keysym</parameter></paramdef>
<paramdef>KeySym<parameter> list[\^]\^</parameter></paramdef>
@@ -894,7 +894,7 @@ To allocate some memory you will never give back, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> Xpermalloc</function></funcdef>
+ <funcdef>char *<function>Xpermalloc</function></funcdef>
<paramdef>unsignedint<parameter> size</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -928,7 +928,7 @@ To parse standard window geometry strings, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XParseGeometry</function></funcdef>
+ <funcdef>int <function>XParseGeometry</function></funcdef>
<paramdef>char<parameter> *parsestring</parameter></paramdef>
<paramdef>int*x_return,<parameter> *y_return</parameter></paramdef>
<paramdef>unsignedint*width_return,<parameter> *height_return</parameter></paramdef>
@@ -1029,24 +1029,24 @@ be able to say ``position the window relative to the right or bottom edge.'' For each value found, the corresponding argument is updated.
For each value not found, the argument is left unchanged.
The bits are represented by
-<function>XValue</function>,
-<function>YValue</function>,
-<function>WidthValue</function>,
-<function>HeightValue</function>,
-<function>XNegative</function>,
+<symbol>XValue</symbol>,
+<symbol>YValue</symbol>,
+<symbol>WidthValue</symbol>,
+<symbol>HeightValue</symbol>,
+<symbol>XNegative</symbol>,
or
-<function>YNegative</function>
+<symbol>YNegative</symbol>
and are defined in
-<!-- .hN X11/Xutil.h . -->
+<<filename class="headerfile">X11/Xutil.h</filename>>.
They will be set whenever one of the values is defined
or one of the signs is set.
</para>
<para>
<!-- .LP -->
If the function returns either the
-<function>XValue </function>
+<symbol>XValue</symbol>
or
-<function>YValue </function>
+<symbol>YValue</symbol>
flag,
you should place the window at the requested position.
<!-- .sp -->
@@ -1059,7 +1059,7 @@ To construct a window's geometry information, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XWMGeometry</function></funcdef>
+ <funcdef>int <function>XWMGeometry</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen</parameter></paramdef>
<paramdef>char<parameter> *user_geom</parameter></paramdef>
@@ -1192,20 +1192,20 @@ Returns the window gravity. <!-- .LP -->
<!-- .eM -->
The
-<function>XWMGeometry </function>
+<function>XWMGeometry</function>
function combines any geometry information (given in the format used by
<function>XParseGeometry</function>)
specified by the user and by the calling program with size hints
(usually the ones to be stored in WM_NORMAL_HINTS) and returns the position,
size, and gravity
-(<function>NorthWestGravity</function>,
-<function>NorthEastGravity</function>,
-<function>SouthEastGravity</function>,
+(<symbol>NorthWestGravity</symbol>,
+<symbol>NorthEastGravity</symbol>,
+<symbol>SouthEastGravity</symbol>,
or
-<function>SouthWestGravity</function>)
+<symbol>SouthWestGravity</symbol>)
that describe the window.
If the base size is not set in the
-<function>XSizeHints</function>
+<structname>XSizeHints</structname>
structure,
the minimum size is used if set.
Otherwise, a base size of zero is assumed.
@@ -1237,9 +1237,9 @@ as gravity_return to update the hints directly. Regions are arbitrary sets of pixel locations.
Xlib provides functions for manipulating regions.
The opaque type
-<function>Region</function>
+<structname>Region</structname>
is defined in
-<!-- .hN X11/Xutil.h . -->
+<<filename class="headerfile">X11/Xutil.h</filename>>.
Xlib provides functions that you can use to manipulate regions.
This section discusses how to:
</para>
@@ -1295,7 +1295,7 @@ To generate a region from a polygon, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Region <function> XPolygonRegion</function></funcdef>
+ <funcdef>Region <function>XPolygonRegion</function></funcdef>
<paramdef>XPoint<parameter> points[]</parameter></paramdef>
<paramdef>int<parameter> n</parameter></paramdef>
<paramdef>int<parameter> fill_rule</parameter></paramdef>
@@ -1331,9 +1331,9 @@ Specifies the number of points in the polygon. <para>
Specifies the fill-rule you want to set for the specified GC.
You can pass
-<function>EvenOddRule</function>
+<symbol>EvenOddRule</symbol>
or
-<function>WindingRule</function>.
+<symbol>WindingRule</symbol>.
</para>
</listitem>
</varlistentry>
@@ -1358,7 +1358,7 @@ To set the clip-mask of a GC to a region, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSetRegion</function></funcdef>
+ <funcdef><function>XSetRegion</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>Region<parameter> r</parameter></paramdef>
@@ -1418,7 +1418,7 @@ To deallocate the storage associated with a specified region, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDestroyRegion</function></funcdef>
+ <funcdef><function>XDestroyRegion</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1454,7 +1454,7 @@ To move a region by a specified amount, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XOffsetRegion</function></funcdef>
+ <funcdef><function>XOffsetRegion</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
<paramdef>intdx,<parameter> dy</parameter></paramdef>
</funcprototype>
@@ -1506,7 +1506,7 @@ To reduce a region by a specified amount, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XShrinkRegion</function></funcdef>
+ <funcdef><function>XShrinkRegion</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
<paramdef>intdx,<parameter> dy</parameter></paramdef>
</funcprototype>
@@ -1569,7 +1569,7 @@ To generate the smallest rectangle enclosing a region, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XClipBox</function></funcdef>
+ <funcdef><function>XClipBox</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
<paramdef>XRectangle<parameter> *rect_return</parameter></paramdef>
</funcprototype>
@@ -1614,7 +1614,7 @@ To compute the intersection of two regions, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XIntersectRegion</function></funcdef>
+ <funcdef><function>XIntersectRegion</function></funcdef>
<paramdef>Regionsra,srb,<parameter> dr_return</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1663,7 +1663,7 @@ To compute the union of two regions, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUnionRegion</function></funcdef>
+ <funcdef><function>XUnionRegion</function></funcdef>
<paramdef>Regionsra,srb,<parameter> dr_return</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1712,7 +1712,7 @@ To create a union of a source region and a rectangle, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XUnionRectWithRegion</function></funcdef>
+ <funcdef><function>XUnionRectWithRegion</function></funcdef>
<paramdef>XRectangle<parameter> *rectangle</parameter></paramdef>
<paramdef>Region<parameter> src_region</parameter></paramdef>
<paramdef>Region<parameter> dest_region_return</parameter></paramdef>
@@ -1769,7 +1769,7 @@ To subtract two regions, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XSubtractRegion</function></funcdef>
+ <funcdef><function>XSubtractRegion</function></funcdef>
<paramdef>Regionsra,srb,<parameter> dr_return</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1825,7 +1825,7 @@ of two regions, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XXorRegion</function></funcdef>
+ <funcdef><function>XXorRegion</function></funcdef>
<paramdef>Regionsra,srb,<parameter> dr_return</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1882,7 +1882,7 @@ To determine if the specified region is empty, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XEmptyRegion</function></funcdef>
+ <funcdef>Bool <function>XEmptyRegion</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1906,7 +1906,7 @@ Specifies the region. The
<function>XEmptyRegion</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if the region is empty.
</para>
<para>
@@ -1918,7 +1918,7 @@ To determine if two regions have the same offset, size, and shape, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XEqualRegion</function></funcdef>
+ <funcdef>Bool <function>XEqualRegion</function></funcdef>
<paramdef>Regionr1,<parameter> r2</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -1953,7 +1953,7 @@ Specify the two regions. The
<function>XEqualRegion</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if the two regions have the same offset, size, and shape.
</para>
</sect2>
@@ -1970,7 +1970,7 @@ To determine if a specified point resides in a specified region, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Bool <function> XPointInRegion</function></funcdef>
+ <funcdef>Bool <function>XPointInRegion</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
</funcprototype>
@@ -2017,7 +2017,7 @@ Specify the x and y coordinates(Xy. The
<function>XPointInRegion</function>
function returns
-<function>True</function>
+<symbol>True</symbol>
if the point (x, y) is contained in the region r.
</para>
<para>
@@ -2029,7 +2029,7 @@ To determine if a specified rectangle is inside a region, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XRectInRegion</function></funcdef>
+ <funcdef>int <function>XRectInRegion</function></funcdef>
<paramdef>Region<parameter> r</parameter></paramdef>
<paramdef>intx,<parameter> y</parameter></paramdef>
<paramdef>unsignedintwidth,<parameter> height</parameter></paramdef>
@@ -2099,12 +2099,12 @@ Specify the width and height(Wh. The
<function>XRectInRegion</function>
function returns
-<function>RectangleIn</function>
+<symbol>RectangleIn</symbol>
if the rectangle is entirely in the specified region,
-<function>RectangleOut</function>
+<symbol>RectangleOut</symbol>
if the rectangle is entirely out of the specified region,
and
-<function>RectanglePart</function>
+<symbol>RectanglePart</symbol>
if the rectangle is partially in the specified region.
</para>
</sect2>
@@ -2141,7 +2141,7 @@ To store data in cut buffer 0, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XStoreBytes</function></funcdef>
+ <funcdef><function>XStoreBytes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *bytes</parameter></paramdef>
<paramdef>int<parameter> \^nbytes</parameter></paramdef>
@@ -2194,7 +2194,7 @@ any client calling <!-- .LP -->
<function>XStoreBytes</function>
can generate a
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
error.
</para>
<para>
@@ -2206,7 +2206,7 @@ To store data in a specified cut buffer, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XStoreBuffer</function></funcdef>
+ <funcdef><function>XStoreBuffer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *bytes</parameter></paramdef>
<paramdef>int<parameter> \^nbytes</parameter></paramdef>
@@ -2269,7 +2269,7 @@ and need not be null-terminated. <!-- .LP -->
<function>XStoreBuffer</function>
can generate a
-<function>BadAlloc </function>
+<errorname>BadAlloc</errorname>
error.
</para>
<para>
@@ -2281,7 +2281,7 @@ To return data from cut buffer 0, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XFetchBytes</function></funcdef>
+ <funcdef>char *<function>XFetchBytes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> *nbytes_return</parameter></paramdef>
</funcprototype>
@@ -2333,7 +2333,7 @@ To return data from a specified cut buffer, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>char *<function> XFetchBuffer</function></funcdef>
+ <funcdef>char *<function>XFetchBuffer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> *nbytes_return</parameter></paramdef>
<paramdef>int<parameter> buffer</parameter></paramdef>
@@ -2392,7 +2392,7 @@ To rotate the cut buffers, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XRotateBuffers</function></funcdef>
+ <funcdef><function>XRotateBuffers</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> rotate</parameter></paramdef>
</funcprototype>
@@ -2433,7 +2433,7 @@ This cut buffer numbering is global to the display. Note that
<function>XRotateBuffers</function>
generates
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
errors if any of the eight buffers have not been created.
</para>
</sect1>
@@ -2453,10 +2453,10 @@ which visual to use for your application. <para>
<!-- .LP -->
The functions in this section use the visual information masks and the
-<function>XVisualInfo </function>
+<structname>XVisualInfo</structname>
structure,
which is defined in
-<!-- .hN X11/Xutil.h -->
+<<filename class="headerfile">X11/Xutil.h</filename>>
and contains:
<!-- .sM -->
</para>
@@ -2509,7 +2509,7 @@ template, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XVisualInfo *<function> XGetVisualInfo</function></funcdef>
+ <funcdef>XVisualInfo *<function>XGetVisualInfo</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>long<parameter> vinfo_mask</parameter></paramdef>
<paramdef>XVisualInfo<parameter> *vinfo_template</parameter></paramdef>
@@ -2584,7 +2584,7 @@ class of the screen, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Status <function> XMatchVisualInfo</function></funcdef>
+ <funcdef>Status <function>XMatchVisualInfo</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>int<parameter> screen</parameter></paramdef>
<paramdef>int<parameter> depth</parameter></paramdef>
@@ -2672,10 +2672,10 @@ returns zero. <!-- .LP -->
Xlib provides several functions that perform basic operations on images.
All operations on images are defined using an
-<function>XImage </function>
+<structname>XImage</structname>
structure,
as defined in
-<!-- .hN X11/Xlib.h . -->
+<<filename class="headerfile">X11/Xlib.h</filename>>.
Because the number of different types of image formats can be very large,
this hides details of image storage properly from applications.
</para>
@@ -2701,7 +2701,7 @@ to and from disk files. <para>
<!-- .LP -->
The
-<function>XImage </function>
+<structname>XImage</structname>
structure describes an image as it exists in the client's memory.
The user can request that some of the members such as height, width,
and xoffset be changed when the image is sent to the server.
@@ -2711,12 +2711,12 @@ Other members (for example, byte order, bitmap_unit, and so forth) are characteristics of both the image and the server.
If these members
differ between the image and the server,
-<function>XPutImage </function>
+<function>XPutImage</function>
makes the appropriate conversions.
The first byte of the first line of
plane n must be located at the address (data + (n * height * bytes_per_line)).
For a description of the
-<function>XImage </function>
+<structname>XImage</structname>
structure,
see section 8.7.
</para>
@@ -2724,14 +2724,14 @@ see section 8.7. <!-- .LP -->
<!-- .sp -->
To allocate an
-<function>XImage </function>
+<structname>XImage</structname>
structure and initialize it with image format values from a display, use
<function>XCreateImage</function>.
<indexterm significance="preferred"><primary>XCreateImage</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XImage *<function> XCreateImage</function></funcdef>
+ <funcdef>XImage *<function>XCreateImage</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Visual<parameter> *visual</parameter></paramdef>
<paramdef>unsignedint<parameter> depth</parameter></paramdef>
@@ -2763,7 +2763,7 @@ Specifies the connection to the X server. <listitem>
<para>
Specifies the
-<function>Visual</function>
+<structname>Visual</structname>
structure.
</para>
</listitem>
@@ -2786,10 +2786,10 @@ Specifies the depth of the image. <para>
Specifies the format for the image.
You can pass
-<function>XYBitmap</function>,
-<function>XYPixmap</function>,
+<symbol>XYBitmap</symbol>,
+<symbol>XYPixmap</symbol>,
or
-<function>ZPixmap</function>.
+<symbol>ZPixmap</symbol>.
</para>
</listitem>
</varlistentry>
@@ -2864,16 +2864,16 @@ the start of one scanline and the start of the next. The
<function>XCreateImage</function>
function allocates the memory needed for an
-<function>XImage</function>
+<structname>XImage</structname>
structure for the
specified display but does not allocate space for the image itself.
Rather, it initializes the structure byte-order, bit-order, and bitmap-unit
values from the display and returns a pointer to the
-<function>XImage </function>
+<structname>XImage</structname>
structure.
The red, green, and blue mask values are defined for Z format images only
and are derived from the
-<function>Visual </function>
+<structname>Visual</structname>
structure passed in.
Other values also are passed in.
The offset permits the rapid displaying of the image without requiring each
@@ -2900,7 +2900,7 @@ The basic functions used to get a pixel, set a pixel, create a subimage, and add a constant value to an image are defined in the image object.
The functions in this section are really macro invocations of the functions
in the image object and are defined in
-<!-- .hN X11/Xutil.h . -->
+<<filename class="headerfile">X11/Xutil.h</filename>>.
</para>
<para>
<!-- .LP -->
@@ -2911,7 +2911,7 @@ To obtain a pixel value in an image, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>unsigned long <function> XGetPixel</function></funcdef>
+ <funcdef>unsigned long <function>XGetPixel</function></funcdef>
<paramdef>XImage<parameter> *ximage</parameter></paramdef>
<paramdef>int<parameter> x</parameter></paramdef>
<paramdef>int<parameter> y</parameter></paramdef>
@@ -2972,7 +2972,7 @@ To set a pixel value in an image, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XPutPixel</function></funcdef>
+ <funcdef><function>XPutPixel</function></funcdef>
<paramdef>XImage<parameter> *ximage</parameter></paramdef>
<paramdef>int<parameter> x</parameter></paramdef>
<paramdef>int<parameter> y</parameter></paramdef>
@@ -3044,7 +3044,7 @@ To create a subimage, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>XImage *<function> XSubImage</function></funcdef>
+ <funcdef>XImage *<function>XSubImage</function></funcdef>
<paramdef>XImage<parameter> *ximage</parameter></paramdef>
<paramdef>int<parameter> x</parameter></paramdef>
<paramdef>int<parameter> y</parameter></paramdef>
@@ -3114,7 +3114,7 @@ The <function>XSubImage</function>
function creates a new image that is a subsection of an existing one.
It allocates the memory necessary for the new
-<function>XImage</function>
+<structname>XImage</structname>
structure
and returns a pointer to the new image.
The data is copied from the source image,
@@ -3130,7 +3130,7 @@ To increment each pixel in an image by a constant value, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XAddPixel</function></funcdef>
+ <funcdef><function>XAddPixel</function></funcdef>
<paramdef>XImage<parameter> *ximage</parameter></paramdef>
<paramdef>long<parameter> value</parameter></paramdef>
</funcprototype>
@@ -3179,7 +3179,7 @@ use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef><function> XDestroyImage</function></funcdef>
+ <funcdef><function>XDestroyImage</function></funcdef>
<paramdef>XImage<parameter> *\^ximage</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -3203,7 +3203,7 @@ Specifies the image. The
<function>XDestroyImage</function>
function deallocates the memory associated with the
-<function>XImage</function>
+<structname>XImage</structname>
structure.
</para>
<para>
@@ -3266,7 +3266,7 @@ To read a bitmap from a file and store it in a pixmap, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XReadBitmapFile</function></funcdef>
+ <funcdef>int <function>XReadBitmapFile</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>char<parameter> *filename</parameter></paramdef>
@@ -3373,32 +3373,32 @@ The file is parsed in the encoding of the current locale. The ability to read other than the standard format
is implementation-dependent.
If the file cannot be opened,
-<function>XReadBitmapFile </function>
+<function>XReadBitmapFile</function>
returns
-<function>BitmapOpenFailed</function>.
+<returnvalue>BitmapOpenFailed</returnvalue>.
If the file can be opened but does not contain valid bitmap data,
it returns
-<function>BitmapFileInvalid</function>.
+<returnvalue>BitmapFileInvalid</returnvalue>.
If insufficient working storage is allocated,
it returns
-<function>BitmapNoMemory</function>.
+<returnvalue>BitmapNoMemory</returnvalue>.
If the file is readable and valid,
it returns
-<function>BitmapSuccess</function>.
+<returnvalue>BitmapSuccess</returnvalue>.
</para>
<para>
<!-- .LP -->
-<function>XReadBitmapFile </function>
+<function>XReadBitmapFile</function>
returns the bitmap's height and width, as read
from the file, to width_return and height_return.
It then creates a pixmap of the appropriate size,
reads the bitmap data from the file into the pixmap,
and assigns the pixmap to the caller's variable bitmap.
The caller must free the bitmap using
-<function>XFreePixmap </function>
+<function>XFreePixmap</function>
when finished.
If <emphasis remap='I'>name</emphasis>_x_hot and <emphasis remap='I'>name</emphasis>_y_hot exist,
-<function>XReadBitmapFile </function>
+<function>XReadBitmapFile</function>
returns them to x_hot_return and y_hot_return;
otherwise, it returns \-1,\-1.
</para>
@@ -3406,10 +3406,10 @@ otherwise, it returns \-1,\-1. <!-- .LP -->
<function>XReadBitmapFile</function>
can generate
-<function>BadAlloc</function>,
-<function>BadDrawable</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadDrawable</errorname>,
and
-<function>BadGC</function>
+<errorname>BadGC</errorname>
errors.
</para>
<para>
@@ -3421,7 +3421,7 @@ To read a bitmap from a file and return it as data, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XReadBitmapFileData</function></funcdef>
+ <funcdef>int <function>XReadBitmapFileData</function></funcdef>
<paramdef>char<parameter> *filename</parameter></paramdef>
<paramdef>unsignedint*width_return,<parameter> *height_return</parameter></paramdef>
<paramdef>unsignedchar<parameter> *data_return</parameter></paramdef>
@@ -3518,7 +3518,7 @@ To write out a bitmap from a pixmap to a file, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XWriteBitmapFile</function></funcdef>
+ <funcdef>int <function>XWriteBitmapFile</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *filename</parameter></paramdef>
<paramdef>Pixmap<parameter> bitmap</parameter></paramdef>
@@ -3615,14 +3615,14 @@ by deleting the directory prefix. The file is written in the encoding of the current locale.
If the file cannot be opened for writing,
it returns
-<function>BitmapOpenFailed</function>.
+<returnvalue>BitmapOpenFailed</returnvalue>.
If insufficient memory is allocated,
<function>XWriteBitmapFile</function>
returns
-<function>BitmapNoMemory</function>;
+<returnvalue>BitmapNoMemory</returnvalue>;
otherwise, on no error,
it returns
-<function>BitmapSuccess</function>.
+<returnvalue>BitmapSuccess</returnvalue>.
If x_hot and y_hot are not \-1, \-1,
<function>XWriteBitmapFile</function>
writes them out as the hotspot coordinates for the bitmap.
@@ -3631,9 +3631,9 @@ writes them out as the hotspot coordinates for the bitmap. <!-- .LP -->
<function>XWriteBitmapFile</function>
can generate
-<function>BadDrawable</function>
+<errorname>BadDrawable</errorname>
and
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
errors.
</para>
<para>
@@ -3645,7 +3645,7 @@ To create a pixmap and then store bitmap-format data into it, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Pixmap <function> XCreatePixmapFromBitmapData</function></funcdef>
+ <funcdef>Pixmap <function>XCreatePixmapFromBitmapData</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>char<parameter> *data</parameter></paramdef>
@@ -3751,25 +3751,25 @@ function creates a pixmap of the given depth and then does a bitmap-format of the data into it.
The depth must be supported by the screen of the specified drawable,
or a
-<function>BadMatch</function>
+<errorname>BadMatch</errorname>
error results.
</para>
<para>
<!-- .LP -->
<function>XCreatePixmapFromBitmapData</function>
can generate
-<function>BadAlloc</function>,
-<function>BadDrawable</function>,
-<function>BadGC</function>,
+<errorname>BadAlloc</errorname>,
+<errorname>BadDrawable</errorname>,
+<errorname>BadGC</errorname>,
and
-<function>BadValue</function>
+<errorname>BadValue</errorname>
errors.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
To include a bitmap written out by
-<function>XWriteBitmapFile </function>
+<function>XWriteBitmapFile</function>
<indexterm><primary>XWriteBitmapFile</primary></indexterm>
in a program directly, as opposed to reading it in every time at run time, use
<function>XCreateBitmapFromData</function>.
@@ -3777,7 +3777,7 @@ in a program directly, as opposed to reading it in every time at run time, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>Pixmap <function> XCreateBitmapFromData</function></funcdef>
+ <funcdef>Pixmap <function>XCreateBitmapFromData</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>char<parameter> *data</parameter></paramdef>
@@ -3846,7 +3846,7 @@ Specify the width and height. The
<function>XCreateBitmapFromData</function>
function allows you to include in your C program (using
-<function>#include</function>)
+<code>#include</code>)
a bitmap file that was written out by
<function>XWriteBitmapFile</function>
(X version 11 format only) without reading in the bitmap file.
@@ -3866,7 +3866,7 @@ bitmap = XCreateBitmapFromData(display, window, gray_bits, gray_width, gray_heig If insufficient working storage was allocated,
<function>XCreateBitmapFromData</function>
returns
-<function>None</function>.
+<symbol>None</symbol>.
It is your responsibility to free the
bitmap using
<function>XFreePixmap</function>
@@ -3876,9 +3876,9 @@ when finished. <!-- .LP -->
<function>XCreateBitmapFromData</function>
can generate
-<function>BadAlloc</function>
+<errorname>BadAlloc</errorname>
and
-<function>BadGC</function>
+<errorname>BadGC</errorname>
errors.
</para>
</sect1>
@@ -3909,7 +3909,7 @@ Xlib provides context management functions with which you can save data values, get data values, delete entries, and create a unique
context type.
The symbols used are in
-<!-- .hN X11/Xutil.h . -->
+<<filename class="headerfile">X11/Xutil.h</filename>>.
</para>
<para>
<!-- .LP -->
@@ -3920,7 +3920,7 @@ To save a data value that corresponds to a resource ID and context type, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XSaveContext</function></funcdef>
+ <funcdef>int <function>XSaveContext</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> rid</parameter></paramdef>
<paramdef>XContext<parameter> context</parameter></paramdef>
@@ -3982,7 +3982,7 @@ The function returns a nonzero error code if an error has occurred
and zero otherwise.
Possible errors are
-<function>XCNOMEM</function>
+<symbol>XCNOMEM</symbol>
(out of memory).
</para>
<para>
@@ -3994,7 +3994,7 @@ To get the data associated with a resource ID and type, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XFindContext</function></funcdef>
+ <funcdef>int <function>XFindContext</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> rid</parameter></paramdef>
<paramdef>XContext<parameter> context</parameter></paramdef>
@@ -4055,7 +4055,7 @@ The function returns a nonzero error code if an error has occurred
and zero otherwise.
Possible errors are
-<function>XCNOENT</function>
+<symbol>XCNOENT</symbol>
(context-not-found).
</para>
<para>
@@ -4067,7 +4067,7 @@ To delete an entry for a given resource ID and type, use <!-- .sM -->
<funcsynopsis>
<funcprototype>
- <funcdef>int <function> XDeleteContext</function></funcdef>
+ <funcdef>int <function>XDeleteContext</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>XID<parameter> rid</parameter></paramdef>
<paramdef>XContext<parameter> context</parameter></paramdef>
@@ -4124,7 +4124,7 @@ does not free the data whose address was saved. <!-- .LP -->
<!-- .sp -->
To create a unique context type that may be used in subsequent calls to
-<function>XSaveContext </function>
+<function>XSaveContext</function>
and
<function>XFindContext</function>,
use
diff --git a/libX11/specs/libX11/glossary.xml b/libX11/specs/libX11/glossary.xml index eda236875..4202e9a9d 100644 --- a/libX11/specs/libX11/glossary.xml +++ b/libX11/specs/libX11/glossary.xml @@ -1,6 +1,6 @@ <glossary id='glossary'>
<title>Glossary</title>
-<glossentry>
+<glossentry id="glossary:Access_control_list">
<glossterm>Access control list</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Access control list</primary></indexterm>
@@ -14,69 +14,63 @@ Some server implementations can also implement other authorization mechanisms in addition to or in place of this mechanism.
The action of this mechanism can be conditional based on the authorization
protocol name and data received by the server at connection setup.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Active_grab">
<glossterm>Active grab</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Active grab</primary></indexterm>
<para>
A grab is active when the pointer or keyboard is actually owned by the
single grabbing client.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Ancestors">
<glossterm>Ancestors</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Ancestors</primary></indexterm>
<para>
If W is an inferior of A, then A is an ancestor of W.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Atom">
<glossterm>Atom</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Atom</primary></indexterm>
<para>
An atom is a unique ID corresponding to a string name.
Atoms are used to identify properties, types, and selections.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Background">
<glossterm>Background</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Background</primary></indexterm>
<para>
An
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window can have a background, which is defined as a pixmap.
When regions of the window have their contents lost
or invalidated,
the server automatically tiles those regions with the background.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Backing_store">
<glossterm>Backing store</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Backing store</primary></indexterm>
<para>
When a server maintains the contents of a window,
the pixels saved off-screen are known as a backing store.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Base_font_name">
<glossterm>Base font name</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Base font name</primary></indexterm>
@@ -84,29 +78,28 @@ the pixels saved off-screen are known as a backing store. A font name used to select a family of fonts whose members may be encoded
in various charsets.
The
-<function>CharSetRegistry</function>
+<structfield>CharSetRegistry</structfield>
and
-<function>CharSetEncoding</function>
+<structfield>CharSetEncoding</structfield>
fields of an <acronym>XLFD</acronym> name identify the charset of the font.
A base font name may be a full <acronym>XLFD</acronym> name, with all fourteen '-' delimiters,
or an abbreviated <acronym>XLFD</acronym> name containing only the first 12 fields of an <acronym>XLFD</acronym> name,
up to but not including
-<function>CharSetRegistry</function>,
+<structfield>CharSetRegistry</structfield>,
with or without the thirteenth '-', or a non-<acronym>XLFD</acronym> name.
Any <acronym>XLFD</acronym> fields may contain wild cards.
</para>
<para>
When creating an
-<function>XFontSet</function>,
+<type>XFontSet</type>,
Xlib accepts from the client a list of one or more base font names
which select one or more font families.
They are combined with charset names obtained from the encoding of the locale
to load the fonts required to render text.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Bit_gravity">
<glossterm>Bit gravity</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Bit</primary><secondary>gravity</secondary></indexterm>
@@ -117,47 +110,43 @@ It is possible to request that the server relocate the previous contents to some region of the window (though no guarantees are made).
This attraction of window contents for some location of
a window is known as bit gravity.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Bit_plane">
<glossterm>Bit plane</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Bit</primary><secondary>plane</secondary></indexterm>
<para>
When a pixmap or window is thought of as a stack of bitmaps,
each bitmap is called a bit plane or plane.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Bitmap">
<glossterm>Bitmap</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Bitmap</primary></indexterm>
<para>
-A bitmap is a pixmap of depth one.
-<!-- .KE -->
+A bitmap is a <glossterm linkend="glossary:Pixmap">pixmap</glossterm> of depth one.
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Border">
<glossterm>Border</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Border</primary></indexterm>
<para>
An
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window can have a border of equal thickness on all four sides of the window.
The contents of the border are defined by a pixmap,
and the server automatically maintains the contents of the border.
Exposure events are never generated for border regions.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Button_grabbing">
<glossterm>Button grabbing</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Button</primary><secondary>grabbing</secondary></indexterm>
@@ -165,11 +154,10 @@ Exposure events are never generated for border regions. Buttons on the pointer can be passively grabbed by a client.
When the button is pressed,
the pointer is then actively grabbed by the client.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Byte_order">
<glossterm>Byte order</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Byte</primary><secondary>order</secondary></indexterm>
@@ -181,11 +169,10 @@ necessary. For all other parts of the protocol,
the client defines the byte order,
and the server swaps bytes as necessary.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Character">
<glossterm>Character</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Character</primary></indexterm>
@@ -194,11 +181,10 @@ A member of a set of elements used for the organization, control, or representation of text (ISO2022, as adapted by XPG3).
Note that in ISO2022 terms, a character is not bound to a coded value
until it is identified as part of a coded character set.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Character_glyph">
<glossterm>Character glyph</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Character glyph</primary></indexterm>
@@ -207,21 +193,19 @@ The abstract graphical symbol for a character. Character glyphs may or may not map one-to-one to font glyphs,
and may be context-dependent, varying with the adjacent characters.
Multiple characters may map to a single character glyph.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Character_set">
<glossterm>Character set</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Character set</primary></indexterm>
<para>
A collection of characters.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Charset">
<glossterm>Charset</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Charset</primary></indexterm>
@@ -244,36 +228,33 @@ not characters to character glyphs. <para>
Note that a single font charset is sometimes used as the encoding of a locale,
for example, ISO8859-1.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Children">
<glossterm>Children</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Children</primary></indexterm>
<para>
The children of a window are its first-level subwindows.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Class">
<glossterm>Class</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Class</primary></indexterm>
<para>
Windows can be of different classes or types.
See the entries for
-<function>InputOnly</function>
+<glossterm linkend="glossary:InputOnly_window">InputOnly</glossterm>
and
-<function>InputOutput</function>
+<glossterm linkend="glossary:InputOutput_window">InputOutput</glossterm>
windows for further information about valid window types.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Client">
<glossterm>Client</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Client</primary></indexterm>
@@ -288,11 +269,10 @@ A program with multiple paths open to the server is viewed as multiple clients by the protocol.
Resource lifetimes are controlled by
connection lifetimes, not by program lifetimes.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Clipping_region">
<glossterm>Clipping region</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Clipping region</primary></indexterm>
@@ -301,21 +281,19 @@ In a graphics context, a bitmap or list of rectangles can be specified
to restrict output to a particular region of the window.
The image defined by the bitmap or rectangles is called a clipping region.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Coded_character">
<glossterm>Coded character</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Coded character</primary></indexterm>
<para>
A character bound to a codepoint.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Coded_character_set">
<glossterm>Coded character set</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Coded character set</primary></indexterm>
@@ -326,21 +304,19 @@ and its bit representation. (ISO2022, as adapted by XPG3)
A definition of a one-to-one mapping of a set of characters to a set of
codepoints.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Codepoint">
<glossterm>Codepoint</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Codepoint</primary></indexterm>
<para>
The coded representation of a single character in a coded character set.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Colormap">
<glossterm>Colormap</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Colormap</primary></indexterm>
@@ -352,11 +328,10 @@ that drives the guns of a monitor. Depending on hardware limitations,
one or more colormaps can be installed at one time so
that windows associated with those maps display with true colors.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Connection">
<glossterm>Connection</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Connection</primary></indexterm>
@@ -364,11 +339,10 @@ that windows associated with those maps display with true colors. The <acronym>IPC</acronym> path between the server and client program is known as a connection.
A client program typically (but not necessarily) has one
connection to the server over which requests and events are sent.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Containment">
<glossterm>Containment</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Containment</primary></indexterm>
@@ -379,11 +353,10 @@ visible region of one of its inferiors. The border of the window is included as part of the window for containment.
The pointer is in a window if the window contains the pointer
but no inferior contains the pointer.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Coordinate_system">
<glossterm>Coordinate system</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Coordinate system</primary></indexterm>
@@ -394,11 +367,10 @@ Coordinates are integral and coincide with pixel centers. Each window and pixmap has its own coordinate system.
For a window,
the origin is inside the border at the inside upper-left corner.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Cursor">
<glossterm>Cursor</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Cursor</primary></indexterm>
@@ -408,11 +380,10 @@ It consists of a hotspot, a source bitmap, a shape bitmap, and a pair of colors.
The cursor defined for a window controls the visible
appearance when the pointer is in that window.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Depth">
<glossterm>Depth</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Depth</primary></indexterm>
@@ -420,11 +391,10 @@ appearance when the pointer is in that window. The depth of a window or pixmap is the number of bits per pixel it has.
The depth of a graphics context is the depth of the drawables it can be
used in conjunction with graphics output.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Device">
<glossterm>Device</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Device</primary></indexterm>
@@ -435,16 +405,15 @@ Pointers can have one or more buttons (the most common number is three).
The core protocol only deals with two devices: the keyboard
and the pointer.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:DirectColor">
<glossterm>DirectColor</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>DirectColor</primary></indexterm>
<para>
-<function>DirectColor</function>
+<symbol>DirectColor</symbol>
is a class of colormap in which a pixel value is decomposed into three
separate subfields for indexing.
The first subfield indexes an array to produce red intensity values.
@@ -452,27 +421,25 @@ The second subfield indexes a second array to produce blue intensity values. The third subfield indexes a third array to produce green intensity values.
The <acronym>RGB</acronym> (red, green, and blue) values in the colormap entry can be
changed dynamically.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Display">
<glossterm>Display</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Display</primary></indexterm>
<para>
A server, together with its screens and input devices, is called a display.
The Xlib
-<function>Display</function>
+<type>Display</type>
<indexterm><primary>Display</primary><secondary>structure</secondary></indexterm>
structure contains all information about the particular display and its screens
as well as the state that Xlib needs to communicate with the display over a
particular connection.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Drawable">
<glossterm>Drawable</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Drawable</primary></indexterm>
@@ -481,14 +448,13 @@ Both windows and pixmaps can be used as sources and destinations in graphics operations.
These windows and pixmaps are collectively known as drawables.
However, an
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
window cannot be used as a source or destination in a
graphics operation.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Encoding">
<glossterm>Encoding</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Encoding</primary></indexterm>
@@ -505,20 +471,19 @@ sets, and the X Compound Text encoding. <para>
In X, encodings are identified by a string
which appears as: the
-<function>CharSetRegistry</function>
+<structfield>CharSetRegistry</structfield>
and
-<function>CharSetEncoding</function>
+<structfield>CharSetEncoding</structfield>
components of an <acronym>XLFD</acronym>
name; the name of a charset of the locale for which a font could not be
found; or an atom which identifies the encoding of a text property or
which names an encoding for a text selection target type.
Encoding names should be composed of characters from the X Portable
Character Set.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Escapement">
<glossterm>Escapement</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Escapement</primary></indexterm>
@@ -526,11 +491,10 @@ Character Set. The escapement of a string is the distance in pixels in the
primary draw direction from the drawing origin to the origin of the next
character (that is, the one following the given string) to be drawn.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Event">
<glossterm>Event</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Event</primary></indexterm>
@@ -543,11 +507,10 @@ The server never sends an event to a client unless the client has specifically asked to be informed of that type of event.
However, clients can force events to be sent to other clients.
Events are typically reported relative to a window.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Event_mask">
<glossterm>Event mask</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Event</primary><secondary>mask</secondary></indexterm>
@@ -555,11 +518,10 @@ Events are typically reported relative to a window. Events are requested relative to a window.
The set of event types a client requests relative to a window is described
by using an event mask.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Event_propagation">
<glossterm>Event propagation</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Event</primary><secondary>propagation</secondary></indexterm>
@@ -567,22 +529,20 @@ by using an event mask. Device-related events propagate from the source window to ancestor
windows until some client has expressed interest in handling that type
of event or until the event is discarded explicitly.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Event_source">
<glossterm>Event source</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Event</primary><secondary>source</secondary></indexterm>
<para>
The deepest viewable window that the pointer is in is called
the source of a device-related event.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Event_synchronization">
<glossterm>Event synchronization</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Event</primary><secondary>synchronization</secondary></indexterm>
@@ -593,11 +553,10 @@ events should be sent when in the middle of window management operations).
The event synchronization mechanism allows synchronous processing of
device events.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Exposure_event">
<glossterm>Exposure event</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Event</primary><secondary>Exposure</secondary></indexterm>
@@ -606,11 +565,10 @@ Servers do not guarantee to preserve the contents of windows when windows are obscured or reconfigured.
Exposure events are sent to clients to inform them when contents of regions
of windows have been lost.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Extension">
<glossterm>Extension</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Extension</primary></indexterm>
@@ -618,11 +576,10 @@ of windows have been lost. Named extensions to the core protocol can be defined to extend the system.
Extensions to output requests, resources, and event types are all possible
and expected.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Font">
<glossterm>Font</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Font</primary></indexterm>
@@ -632,42 +589,38 @@ The protocol does no translation or interpretation of character sets. The client simply indicates values used to index the glyph array.
A font contains additional metric information to determine interglyph
and interline spacing.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Font_glyph">
<glossterm>Font glyph</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Font glyph</primary></indexterm>
<para>
The abstract graphical symbol for an index into a font.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Frozen_events">
<glossterm>Frozen events</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Frozen events</primary></indexterm>
<para>
Clients can freeze event processing during keyboard and pointer grabs.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:GC">
<glossterm>GC</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>GC</primary></indexterm>
<para>
GC is an abbreviation for graphics context.
-See <function>Graphics context</function>.
-<!-- .KE -->
+See <glossterm linkend="glossary:Graphics_context">Graphics context</glossterm>.
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Glyph">
<glossterm>Glyph</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Glyph</primary></indexterm>
@@ -676,11 +629,10 @@ An identified abstract graphical symbol independent of any actual image. (ISO/IEC/DIS 9541-1)
An abstract visual representation of a graphic character,
not bound to a codepoint.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Glyph_image">
<glossterm>Glyph image</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Glyph image</primary></indexterm>
@@ -688,11 +640,10 @@ not bound to a codepoint. An image of a glyph, as obtained from a glyph representation displayed
on a presentation surface.
(ISO/IEC/DIS 9541-1)
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Grab">
<glossterm>Grab</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Grab</primary></indexterm>
@@ -703,79 +654,74 @@ In general, these facilities are not intended to be used by normal applications
but are intended for various input and window managers to implement various
styles of user interfaces.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Graphics_context">
<glossterm>Graphics context</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Graphics context</primary></indexterm>
<para>
Various information for graphics output is stored in a graphics
-context (GC), such as foreground pixel, background
+context (<acronym>GC</acronym>), such as foreground pixel, background
pixel, line width, clipping region, and so on.
A graphics context can only
be used with drawables that have the same root and the same depth as
the graphics context.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Gravity">
<glossterm>Gravity</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Gravity</primary></indexterm>
<para>
The contents of windows and windows themselves have a gravity,
which determines how the contents move when a window is resized.
-See <function>Bit gravity</function> and <function>Window gravity</function>.
-<!-- .KE -->
+See <glossterm linkend="glossary:Bit_gravity">Bit gravity</glossterm> and
+<glossterm linkend="glossary:Window_gravity">Window gravity</glossterm>.
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:GrayScale">
<glossterm>GrayScale</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>GrayScale</primary></indexterm>
<para>
-<function>GrayScale </function>
+<symbol>GrayScale</symbol>
can be viewed as a degenerate case of
-<function>PseudoColor</function>,
+<glossterm linkend="glossary:PseudoColor"><symbol>PseudoColor</symbol></glossterm>,
in which the red, green, and blue values in any given colormap entry
are equal and thus, produce shades of gray.
The gray values can be changed dynamically.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Host_Portable_Character_Encoding">
<glossterm>Host Portable Character Encoding</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Host Portable Character Encoding</primary></indexterm>
<para>
-The encoding of the X Portable Character Set on the host.
+The encoding of the <glossterm linkend="glossary:X_Portable_Character_Set">X Portable Character Set</glossterm> on the host.
The encoding itself is not defined by this standard,
but the encoding must be the same in all locales supported by Xlib on the host.
If a string is said to be in the Host Portable Character Encoding,
then it only contains characters from the X Portable Character Set,
in the host encoding.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Hotspot">
<glossterm>Hotspot</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Hotspot</primary></indexterm>
<para>
A cursor has an associated hotspot, which defines the point in the
cursor corresponding to the coordinates reported for the pointer.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Identifier">
<glossterm>Identifier</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Identifier</primary></indexterm>
@@ -783,22 +729,20 @@ cursor corresponding to the coordinates reported for the pointer. An identifier is a unique value associated with a resource
that clients use to name that resource.
The identifier can be used over any connection to name the resource.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Inferiors">
<glossterm>Inferiors</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Inferiors</primary></indexterm>
<para>
The inferiors of a window are all of the subwindows nested below it:
the children, the children's children, and so on.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Input_focus">
<glossterm>Input focus</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Input</primary><secondary>focus</secondary></indexterm>
@@ -812,59 +756,55 @@ Otherwise, the event is reported with respect to the focus window. The input focus also can be set such that all keyboard events are discarded
and such that the focus window is dynamically taken to be the root window
of whatever screen the pointer is on at each keyboard event.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Input_manager">
<glossterm>Input manager</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Input</primary><secondary>manager</secondary></indexterm>
<para>
Control over keyboard input is typically provided by an input manager
client, which usually is part of a window manager.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:InputOnly_window">
<glossterm>InputOnly window</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Window</primary><secondary>InputOnly</secondary></indexterm>
<para>
An
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
window is a window that cannot be used for graphics requests.
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
windows are invisible and are used to control such things as cursors,
input event generation, and grabbing.
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
windows cannot have
-<function>InputOutput </function>
+<symbol>InputOutput</symbol>
windows as inferiors.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:InputOutput_window">
<glossterm>InputOutput window</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Window</primary><secondary>InputOutput</secondary></indexterm>
<para>
An
-<function>InputOutput</function>
+<symbol>InputOutput</symbol>
window is the normal kind of window that is used for both input and output.
-<function>InputOutput </function>
+<symbol>InputOutput</symbol>
windows can have both
-<function>InputOutput </function>
+<symbol>InputOutput</symbol>
and
-<function>InputOnly </function>
+<symbol>InputOnly</symbol>
windows as inferiors.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Internationalization">
<glossterm>Internationalization</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Internationalization</primary></indexterm>
@@ -873,22 +813,20 @@ The process of making software adaptable to the requirements of different native languages, local customs, and character string encodings.
Making a computer program adaptable to different locales
without program source modifications or recompilation.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:ISO2022">
<glossterm>ISO2022</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>ISO2022</primary></indexterm>
<para>
ISO standard for code extension techniques for 7-bit and 8-bit coded
character sets.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Key_grabbing">
<glossterm>Key grabbing</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Key</primary><secondary>grabbing</secondary></indexterm>
@@ -896,11 +834,10 @@ character sets. Keys on the keyboard can be passively grabbed by a client.
When the key is pressed,
the keyboard is then actively grabbed by the client.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Keyboard_grabbing">
<glossterm>Keyboard grabbing</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Keyboard</primary><secondary>grabbing</secondary></indexterm>
@@ -908,31 +845,28 @@ the keyboard is then actively grabbed by the client. A client can actively grab control of the keyboard, and key events
will be sent to that client rather than the client the events would
normally have been sent to.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Keysym">
<glossterm>Keysym</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Keysym</primary></indexterm>
<para>
An encoding of a symbol on a keycap on a keyboard.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Latin-1">
<glossterm>Latin-1</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Latin-1</primary></indexterm>
<para>
The coded character set defined by the ISO8859-1 standard.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Latin_Portable_Character_Encoding">
<glossterm>Latin Portable Character Encoding</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Latin Portable Character Encoding</primary></indexterm>
@@ -942,11 +876,10 @@ plus ASCII control characters. If a string is said to be in the Latin Portable Character Encoding,
then it only contains characters from the X Portable Character Set,
not all of Latin-1.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Locale">
<glossterm>Locale</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Locale</primary></indexterm>
@@ -963,25 +896,23 @@ category. Associated with each locale is a text encoding. When text is processed
in the context of a locale, the text must be in the encoding of the locale.
The current locale affects Xlib in its:
-<!-- .RS -->
-</para>
- <para>
+ <itemizedlist>
+ <listitem><para>
Encoding and processing of input method text
-</para>
- <para>
+ </para></listitem>
+ <listitem><para>
Encoding of resource files and values
-</para>
- <para>
+ </para></listitem>
+ <listitem><para>
Encoding and imaging of text strings
-</para>
- <para>
+ </para></listitem>
+ <listitem><para>
Encoding and decoding for inter-client text communication
-<!-- .RE -->
-<!-- .KE -->
- </para>
+ </para></listitem>
+ </itemizedlist></para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Locale_name">
<glossterm>Locale name</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Locale name</primary></indexterm>
@@ -992,11 +923,10 @@ On ANSI C library compliant systems, the locale argument to the
<function>setlocale</function>
function.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Localization">
<glossterm>Localization</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Localization</primary></indexterm>
@@ -1005,45 +935,41 @@ The process of establishing information within a computer system specific to the operation of particular native languages, local customs
and coded character sets.
(XPG3)
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Mapped">
<glossterm>Mapped</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Mapped window</primary></indexterm>
<para>
A window is said to be mapped if a map call has been performed on it.
Unmapped windows and their inferiors are never viewable or visible.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Modifier_keys">
<glossterm>Modifier keys</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Modifier keys</primary></indexterm>
<para>
Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock,
ShiftLock, and similar keys are called modifier keys.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Monochrome">
<glossterm>Monochrome</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Monochrome</primary></indexterm>
<para>
Monochrome is a special case of
-<function>StaticGray</function>
+<glossterm linkend="glossary:StaticGray"><symbol>StaticGray</symbol></glossterm>
in which there are only two colormap entries.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Multibyte">
<glossterm>Multibyte</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Multibyte</primary></indexterm>
@@ -1051,14 +977,13 @@ in which there are only two colormap entries. A character whose codepoint is stored in more than one byte;
any encoding which can contain multibyte characters;
text in a multibyte encoding.
-The ``char *'' null-terminated string datatype in ANSI C.
+The ``<type>char *</type>'' null-terminated string datatype in ANSI C.
Note that references in this document to multibyte strings
imply only that the strings <emphasis remap='I'>may</emphasis> contain multibyte characters.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Obscure">
<glossterm>Obscure</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Obscure</primary></indexterm>
@@ -1066,17 +991,16 @@ imply only that the strings <emphasis remap='I'>may</emphasis> contain multibyte A window is obscured if some other window obscures it.
A window can be partially obscured and so still have visible regions.
Window A obscures window B if both are viewable
-<function>InputOutput </function>
+<symbol>InputOutput</symbol>
windows, if A is higher in the global stacking order,
and if the rectangle defined by the outside
edges of A intersects the rectangle defined by the outside edges of B.
Note the distinction between obscures and occludes.
Also note that window borders are included in the calculation.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Occlude">
<glossterm>Occlude</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Occlude</primary></indexterm>
@@ -1089,13 +1013,12 @@ by the outside edges of B. Note the distinction between occludes and obscures.
Also note that window borders are included in the calculation
and that
-<function>InputOnly</function>
+<symbol>InputOnly</symbol>
windows never obscure other windows but can occlude other windows.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Padding">
<glossterm>Padding</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Padding</primary></indexterm>
@@ -1103,32 +1026,29 @@ windows never obscure other windows but can occlude other windows. Some padding bytes are inserted in the data stream to maintain
alignment of the protocol requests on natural boundaries.
This increases ease of portability to some machine architectures.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Parent_window">
<glossterm>Parent window</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Window</primary><secondary>parent</secondary></indexterm>
<para>
If C is a child of P, then P is the parent of C.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Passive_grab">
<glossterm>Passive grab</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Passive grab</primary></indexterm>
<para>
Grabbing a key or button is a passive grab.
The grab activates when the key or button is actually pressed.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Pixel_value">
<glossterm>Pixel value</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Pixel value</primary></indexterm>
@@ -1138,11 +1058,10 @@ where N is the number of bit planes used in a particular window or pixmap (that is, is the depth of the window or pixmap).
A pixel in a window indexes a colormap to derive an actual color to be
displayed.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Pixmap">
<glossterm>Pixmap</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Pixmap</primary></indexterm>
@@ -1155,22 +1074,20 @@ where each pixel can be a value from 0 to %2 sup N %\-1, and where N is the depth (z axis) of the pixmap.
A pixmap can also be thought of as a stack of N bitmaps.
A pixmap can only be used on the screen that it was created in.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Plane">
<glossterm>Plane</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Plane</primary></indexterm>
<para>
When a pixmap or window is thought of as a stack of bitmaps, each
bitmap is called a plane or bit plane.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Plane_mask">
<glossterm>Plane mask</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Plane</primary><secondary>mask</secondary></indexterm>
@@ -1179,22 +1096,20 @@ Graphics operations can be restricted to only affect a subset of bit planes of a destination.
A plane mask is a bit mask describing which planes are to be modified.
The plane mask is stored in a graphics context.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Pointer">
<glossterm>Pointer</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Pointer</primary></indexterm>
<para>
The pointer is the pointing device currently attached to the cursor
and tracked on the screens.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Pointer_grabbing">
<glossterm>Pointer grabbing</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Pointer</primary><secondary>grabbing</secondary></indexterm>
@@ -1202,11 +1117,10 @@ and tracked on the screens. A client can actively grab control of the pointer.
Then button and motion events will be sent to that client
rather than the client the events would normally have been sent to.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Pointing_device">
<glossterm>Pointing device</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Pointing device</primary></indexterm>
@@ -1215,21 +1129,19 @@ A pointing device is typically a mouse, tablet, or some other device with effective dimensional motion.
The core protocol defines only one visible cursor,
which tracks whatever pointing device is attached as the pointer.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:POSIX">
<glossterm><acronym>POSIX</acronym></glossterm>
<glossdef>
<indexterm significance="preferred"><primary><acronym>POSIX</acronym></primary></indexterm>
<para>
Portable Operating System Interface, ISO/IEC 9945-1 (IEEE Std 1003.1).
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:POSIX_Portable_Filename_Character_Set">
<glossterm><acronym>POSIX</acronym> Portable Filename Character Set</glossterm>
<glossdef>
<indexterm significance="preferred"><primary><acronym>POSIX</acronym> Portable Filename Character Set</primary></indexterm>
@@ -1242,11 +1154,10 @@ The set is: <!-- .Ds 0 -->
a..z A..Z 0..9 ._-
<!-- .De -->
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Property">
<glossterm>Property</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Property</primary></indexterm>
@@ -1257,36 +1168,33 @@ The protocol places no interpretation on properties. They are intended as a general-purpose naming mechanism for clients.
For example, clients might use properties to share information such as resize
hints, program names, and icon formats with a window manager.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Property_list">
<glossterm>Property list</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Property list</primary></indexterm>
<para>
The property list of a window is the list of properties that have
been defined for the window.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:PseudoColor">
<glossterm>PseudoColor</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>PseudoColor</primary></indexterm>
<para>
-<function>PseudoColor</function>
+<symbol>PseudoColor</symbol>
is a class of colormap in which a pixel value indexes the colormap entry to
produce an independent <acronym>RGB</acronym> value;
that is, the colormap is viewed as an array of triples (<acronym>RGB</acronym> values).
The <acronym>RGB</acronym> values can be changed dynamically.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Rectangle">
<glossterm>Rectangle</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Rectangle</primary></indexterm>
@@ -1300,11 +1208,10 @@ if w=h=0, nothing would be drawn.
For w=h=1,
a single pixel would be drawn.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Redirecting_control">
<glossterm>Redirecting control</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Redirecting control</primary></indexterm>
@@ -1314,11 +1221,10 @@ policy in various ways. When a client attempts to change the size or position of a window,
the operation may be redirected to a specified client
rather than the operation actually being performed.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Reply">
<glossterm>Reply</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Reply</primary></indexterm>
@@ -1328,22 +1234,20 @@ is sent back to the client with a reply. Both events and replies are multiplexed on the same connection.
Most requests do not generate replies,
but some requests generate multiple replies.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Request">
<glossterm>Request</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Request</primary></indexterm>
<para>
A command to the server is called a request.
It is a single block of data sent over a connection.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Resource">
<glossterm>Resource</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Resource</primary></indexterm>
@@ -1353,11 +1257,10 @@ known as resources. They all have unique identifiers associated with them for naming purposes.
The lifetime of a resource usually is bounded by the lifetime of the
connection over which the resource was created.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:RGB_values">
<glossterm><acronym>RGB</acronym> values</glossterm>
<glossdef>
<indexterm significance="preferred"><primary><acronym>RGB</acronym> values</primary></indexterm>
@@ -1367,11 +1270,10 @@ to define a color. These values are always represented as 16-bit, unsigned numbers, with 0
the minimum intensity and 65535 the maximum intensity.
The X server scales these values to match the display hardware.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Root">
<glossterm>Root</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Root</primary></indexterm>
@@ -1379,11 +1281,10 @@ The X server scales these values to match the display hardware. The root of a pixmap or graphics context is the same as the root
of whatever drawable was used when the pixmap or GC was created.
The root of a window is the root window under which the window was created.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Root_window">
<glossterm>Root window</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Window</primary><secondary>root</secondary></indexterm>
@@ -1392,11 +1293,10 @@ Each screen has a root window covering it. The root window cannot be reconfigured or unmapped,
but otherwise it acts as a full-fledged window.
A root window has no parent.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Save_set">
<glossterm>Save set</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Save set</primary></indexterm>
@@ -1407,11 +1307,10 @@ close, should not be destroyed and that should be remapped if currently unmapped.
Save sets are typically used by window managers to avoid
lost windows if the manager should terminate abnormally.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Scanline">
<glossterm>Scanline</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Scanline</primary></indexterm>
@@ -1419,22 +1318,20 @@ lost windows if the manager should terminate abnormally. A scanline is a list of pixel or bit values viewed as a horizontal
row (all values having the same y coordinate) of an image, with the
values ordered by increasing the x coordinate.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Scanline_order">
<glossterm>Scanline order</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Scanline</primary><secondary>order</secondary></indexterm>
<para>
An image represented in scanline order contains scanlines ordered by
increasing the y coordinate.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Screen">
<glossterm>Screen</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Screen</primary></indexterm>
@@ -1444,18 +1341,17 @@ which typically have physically independent monitors. This would be the expected configuration when there is only a single keyboard
and pointer shared among the screens.
A
-<function>Screen </function>
+<type>Screen</type>
<indexterm><primary>Screen</primary><secondary>structure</secondary></indexterm>
structure contains the information about that screen
and is linked to the
-<function>Display</function>
+<type>Display</type>
<indexterm><primary>Display</primary><secondary>structure</secondary></indexterm>
structure.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Selection">
<glossterm>Selection</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Selection</primary></indexterm>
@@ -1485,11 +1381,10 @@ text of the paragraph. The target type can also be used for other
purposes.
The protocol does not constrain the semantics.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Server">
<glossterm>Server</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Server</primary></indexterm>
@@ -1499,11 +1394,10 @@ provides the basic windowing mechanism. It handles <acronym>IPC</acronym> connections from clients,
multiplexes graphics requests onto the screens,
and demultiplexes input back to the appropriate clients.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Server_grabbing">
<glossterm>Server grabbing</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Server</primary><secondary>grabbing</secondary></indexterm>
@@ -1513,11 +1407,10 @@ This prevents processing of any requests from other client connections until the grab is completed.
This is typically only a transient state for such things as rubber-banding,
pop-up menus, or executing requests indivisibly.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Shift_sequence">
<glossterm>Shift sequence</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Shift sequence</primary></indexterm>
@@ -1525,21 +1418,19 @@ pop-up menus, or executing requests indivisibly. ISO2022 defines control characters and escape sequences
which temporarily (single shift) or permanently (locking shift) cause a
different character set to be in effect (``invoking'' a character set).
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Sibling">
<glossterm>Sibling</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Sibling</primary></indexterm>
<para>
Children of the same parent window are known as sibling windows.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Stacking_order">
<glossterm>Stacking order</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Stacking order</primary></indexterm>
@@ -1548,11 +1439,10 @@ Sibling windows, similar to sheets of paper on a desk, can stack on top of each other.
Windows above both obscure and occlude lower windows.
The relationship between sibling windows is known as the stacking order.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:State-dependent_encoding">
<glossterm>State-dependent encoding</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>State-dependent encoding</primary></indexterm>
@@ -1564,11 +1454,10 @@ and enters other ``shift states'' when specific ``shift sequences'' are encountered in the byte sequence.
In ISO2022 terms,
this means use of locking shifts, not single shifts.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:State-independent_encoding">
<glossterm>State-independent encoding</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>State-independent encoding</primary></indexterm>
@@ -1577,38 +1466,35 @@ Any encoding in which the invocations of the charsets are fixed, or span only a single character.
In ISO2022 terms,
this means use of at most single shifts, not locking shifts.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:StaticColor">
<glossterm>StaticColor</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>StaticColor</primary></indexterm>
<para>
-<function>StaticColor </function>
+<symbol>StaticColor</symbol>
can be viewed as a degenerate case of
-<function>PseudoColor</function>
+<glossterm linkend="glossary:PseudoColor"><symbol>PseudoColor</symbol></glossterm>
in which the <acronym>RGB</acronym> values are predefined and read-only.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:StaticGray">
<glossterm>StaticGray</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>StaticGray</primary></indexterm>
<para>
-<function>StaticGray </function>
+<symbol>StaticGray</symbol>
can be viewed as a degenerate case of
-<function>GrayScale</function>
+<glossterm linkend="glossary:GrayScale"><symbol>GrayScale</symbol></glossterm>
in which the gray values are predefined and read-only.
The values are typically linear or near-linear increasing ramps.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Status">
<glossterm>Status</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Status</primary></indexterm>
@@ -1616,11 +1502,10 @@ The values are typically linear or near-linear increasing ramps. Many Xlib functions return a success status.
If the function does not succeed,
however, its arguments are not disturbed.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Stipple">
<glossterm>Stipple</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Stipple</primary></indexterm>
@@ -1631,16 +1516,15 @@ color. </para>
</glossdef>
</glossentry>
-<!-- .KE -->
-<glossentry>
+<glossentry id="glossary:STRING_encoding">
<glossterm>STRING encoding</glossterm>
<glossdef>
<para>
-Latin-1, plus tab and newline.
+<glossterm linkend="glossary:Latin-1">Latin-1</glossterm>, plus tab and newline.
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:String_Equivalence">
<glossterm>String Equivalence</glossterm>
<glossdef>
<para>
@@ -1655,22 +1539,20 @@ values 224 to 246 inclusive (characters ``a grave'' to ``o diaeresis''), and decimal values 216 to 222 inclusive (characters ``O oblique'' to ``THORN'')
are pairwise equivalent to decimal values 246 to 254 inclusive
(characters ``o oblique'' to ``thorn'').
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Tile">
<glossterm>Tile</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Tile</primary></indexterm>
<para>
A pixmap can be replicated in two dimensions to tile a region.
The pixmap itself is also known as a tile.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Timestamp">
<glossterm>Timestamp</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Timestamp</primary></indexterm>
@@ -1683,30 +1565,28 @@ always interprets timestamps from clients by treating half of the timestamp space as being earlier in time than T
and half of the timestamp space as being later in time than T.
One timestamp value, represented by the constant
-<function>CurrentTime</function>,
+<symbol>CurrentTime</symbol>,
is never generated by the server.
This value is reserved for use in requests to represent the current server time.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:TrueColor">
<glossterm>TrueColor</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>TrueColor</primary></indexterm>
<para>
-<function>TrueColor</function>
+<symbol>TrueColor</symbol>
can be viewed as a degenerate case of
-<function>DirectColor</function>
+<glossterm linkend="glossary:DirectColor"><symbol>DirectColor</symbol></glossterm>
in which the subfields in the pixel value directly encode the corresponding <acronym>RGB</acronym>
values.
That is, the colormap has predefined read-only <acronym>RGB</acronym> values.
The values are typically linear or near-linear increasing ramps.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Type">
<glossterm>Type</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Type</primary></indexterm>
@@ -1717,11 +1597,10 @@ Types are completely uninterpreted by the server. They are solely for the benefit of clients.
X predefines type atoms for many frequently used types,
and clients also can define new types.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Viewable">
<glossterm>Viewable</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Viewable</primary></indexterm>
@@ -1731,11 +1610,10 @@ This does not imply that any portion of the window is actually visible. Graphics requests can be performed on a window when it is not
viewable, but output will not be retained unless the server is maintaining
backing store.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Visible">
<glossterm>Visible</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Visible</primary></indexterm>
@@ -1743,11 +1621,10 @@ backing store. A region of a window is visible if someone looking at the screen can
actually see it; that is, the window is viewable and the region is not occluded
by any other window.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Whitespace">
<glossterm>Whitespace</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Whitespace</primary></indexterm>
@@ -1757,11 +1634,10 @@ On implementations that conform to the ANSI C library, whitespace is any character for which
<function>isspace</function>
returns true.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Window_gravity">
<glossterm>Window gravity</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Window</primary><secondary>gravity</secondary></indexterm>
@@ -1771,22 +1647,20 @@ subwindows may be repositioned automatically relative to some position in the window.
This attraction of a subwindow to some part of its parent is known
as window gravity.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Window_manager">
<glossterm>Window manager</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Window</primary><secondary>manager</secondary></indexterm>
<para>
Manipulation of windows on the screen and much of the user interface
(policy) is typically provided by a window manager client.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:X_Portable_Character_Set">
<glossterm>X Portable Character Set</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>X Portable Character Set</primary></indexterm>
@@ -1813,23 +1687,21 @@ of the graphic character set of ISO8859-1 plus <space>, <tab>, and & It is also the set of graphic characters in 7-bit ASCII plus the same
three control characters.
The actual encoding of these characters on the host is system dependent;
-see the Host Portable Character Encoding.
-<!-- .KE -->
+see the <glossterm linkend="glossary:Host_Portable_Character_Encoding">Host Portable Character Encoding</glossterm>.
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:XLFD">
<glossterm><acronym>XLFD</acronym></glossterm>
<glossdef>
<indexterm significance="preferred"><primary><acronym>XLFD</acronym></primary></indexterm>
<para>
The X Logical Font Description Conventions that define a standard syntax
for structured font names.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:XY_format">
<glossterm>XY format</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>XY format</primary></indexterm>
@@ -1837,18 +1709,16 @@ for structured font names. The data for a pixmap is said to be in XY format if it is organized as
a set of bitmaps representing individual bit planes with the planes
appearing from most-significant to least-significant bit order.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
-<glossentry>
+<glossentry id="glossary:Z_format">
<glossterm>Z format</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Z format</primary></indexterm>
<para>
The data for a pixmap is said to be in Z format if it is organized as
a set of pixel values in scanline order.
-<!-- .KE -->
</para>
</glossdef>
</glossentry>
diff --git a/libX11/specs/xmlrules.in b/libX11/specs/xmlrules.in index 20263afba..29e371a81 100644 --- a/libX11/specs/xmlrules.in +++ b/libX11/specs/xmlrules.in @@ -56,4 +56,9 @@ SUFFIXES = .xml .ps .pdf .txt .html %.ps: %.xml $(dist_spec_DATA)
$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop ps $<
+chunked-html: $(doc_sources)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) -o html xhtml $(doc_sources)
+
+CLEANFILES += html
+
endif HAVE_XMLTO
|