aboutsummaryrefslogtreecommitdiff
path: root/libX11/specs/libX11/CH05.xml
diff options
context:
space:
mode:
Diffstat (limited to 'libX11/specs/libX11/CH05.xml')
-rw-r--r--libX11/specs/libX11/CH05.xml74
1 files changed, 37 insertions, 37 deletions
diff --git a/libX11/specs/libX11/CH05.xml b/libX11/specs/libX11/CH05.xml
index 134831e60..501ead0d9 100644
--- a/libX11/specs/libX11/CH05.xml
+++ b/libX11/specs/libX11/CH05.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
-<chapter id="pixmap_and_cursor_functions">
+<chapter id='Pixmap_and_Cursor_Functions'>
<title>Pixmap and Cursor Functions</title>
<sect1 id="Creating_and_Freeing_Pixmaps">
<title>Creating and Freeing Pixmaps</title>
@@ -21,11 +21,11 @@ A bitmap is a single bit-plane pixmap.
<!-- .LP -->
<!-- .sp -->
To create a pixmap of a given size, use
-<function>XCreatePixmap</function>.
+<xref linkend='XCreatePixmap' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XCreatePixmap</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xcreatepixmap'>
+<funcsynopsis id='XCreatePixmap'>
<funcprototype>
<funcdef>Pixmap <function>XCreatePixmap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -93,7 +93,7 @@ Specifies the depth of the pixmap.
<!-- .LP -->
<!-- .eM -->
The
-<function>XCreatePixmap</function>
+<xref linkend='XCreatePixmap' xrefstyle='select: title'/>
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
@@ -115,13 +115,13 @@ The server uses the specified drawable to determine on which screen
to create the pixmap.
The pixmap can be used only on this screen
and only with other drawables of the same depth (see
-<function>XCopyPlane</function>
+<xref linkend='XCopyPlane' xrefstyle='select: title'/>
for an exception to this rule).
The initial contents of the pixmap are undefined.
</para>
<para>
<!-- .LP -->
-<function>XCreatePixmap</function>
+<xref linkend='XCreatePixmap' xrefstyle='select: title'/>
can generate
<errorname>BadAlloc</errorname>,
<errorname>BadDrawable</errorname>,
@@ -133,11 +133,11 @@ errors.
<!-- .LP -->
<!-- .sp -->
To free all storage associated with a specified pixmap, use
-<function>XFreePixmap</function>.
+<xref linkend='XFreePixmap' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XFreePixmap</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xfreepixmap'>
+<funcsynopsis id='XFreePixmap'>
<funcprototype>
<funcdef><function>XFreePixmap</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -171,14 +171,14 @@ Specifies the pixmap.
<!-- .LP -->
<!-- .eM -->
The
-<function>XFreePixmap</function>
+<xref linkend='XFreePixmap' xrefstyle='select: title'/>
function first deletes the association between the pixmap ID and the pixmap.
Then, the X server frees the pixmap storage when there are no references to it.
The pixmap should never be referenced again.
</para>
<para>
<!-- .LP -->
-<function>XFreePixmap</function>
+<xref linkend='XFreePixmap' xrefstyle='select: title'/>
can generate a
<errorname>BadPixmap</errorname>
error.
@@ -210,7 +210,7 @@ when a pointer event occurs.
There may be limitations imposed by the hardware on
cursors as to size and whether a mask is implemented.
<indexterm><primary>XQueryBestCursor</primary></indexterm>
-<function>XQueryBestCursor</function>
+<xref linkend='XQueryBestCursor' xrefstyle='select: title'/>
can be used to find out what sizes are possible.
There is a standard font for creating cursors, but
Xlib provides functions that you can use to create cursors
@@ -220,7 +220,7 @@ from an arbitrary font or from bitmaps.
<!-- .LP -->
<!-- .sp -->
To create a cursor from the standard cursor font, use
-<function>XCreateFontCursor</function>.
+<xref linkend='XCreateFontCursor' xrefstyle='select: title'/>.
</para>
<para>
#include &lt;X11/cursorfont.h&gt;
@@ -228,7 +228,7 @@ To create a cursor from the standard cursor font, use
<indexterm significance="preferred"><primary>XCreateFontCursor</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xcreatefontcursor'>
+<funcsynopsis id='XCreateFontCursor'>
<funcprototype>
<funcdef>Cursor <function>XCreateFontCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -275,13 +275,13 @@ to use.
The hotspot comes from the information stored in the cursor font.
The initial colors of a cursor are a black foreground and a white
background (see
-<function>XRecolorCursor</function>).
+<xref linkend='XRecolorCursor' xrefstyle='select: title'/>).
For further information about cursor shapes,
see <link linkend="x_font_cursors">appendix B</link>.
</para>
<para>
<!-- .LP -->
-<function>XCreateFontCursor</function>
+<xref linkend='XCreateFontCursor' xrefstyle='select: title'/>
can generate
<errorname>BadAlloc</errorname>
and
@@ -292,11 +292,11 @@ errors.
<!-- .LP -->
<!-- .sp -->
To create a cursor from font glyphs, use
-<function>XCreateGlyphCursor</function>.
+<xref linkend='XCreateGlyphCursor' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XCreateGlyphCursor</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xcreateglyphcursor'>
+<funcsynopsis id='XCreateGlyphCursor'>
<funcprototype>
<funcdef>Cursor <function>XCreateGlyphCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -384,9 +384,9 @@ Specifies the <acronym>RGB</acronym> values for the background of the source.
<!-- .LP -->
<!-- .eM -->
The
-<function>XCreateGlyphCursor</function>
+<xref linkend='XCreateGlyphCursor' xrefstyle='select: title'/>
function is similar to
-<function>XCreatePixmapCursor</function>
+<xref linkend='XCreatePixmapCursor' xrefstyle='select: title'/>
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,
@@ -406,7 +406,7 @@ and there is no restriction on the placement of the hotspot relative to the boun
boxes.
If no mask_char is given, all pixels of the source are displayed.
You can free the fonts immediately by calling
-<function>XFreeFont</function>
+<xref linkend='XFreeFont' xrefstyle='select: title'/>
if no further explicit references to them are to be made.
</para>
<para>
@@ -418,7 +418,7 @@ least significant byte.
</para>
<para>
<!-- .LP -->
-<function>XCreateGlyphCursor</function>
+<xref linkend='XCreateGlyphCursor' xrefstyle='select: title'/>
can generate
<errorname>BadAlloc</errorname>,
<errorname>BadFont</errorname>,
@@ -431,11 +431,11 @@ errors.
<!-- .sp -->
To create a cursor from two bitmaps,
use
-<function>XCreatePixmapCursor</function>.
+<xref linkend='XCreatePixmapCursor' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XCreatePixmapCursor</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xcreatepixmapcursor'>
+<funcsynopsis id='XCreatePixmapCursor'>
<funcprototype>
<funcdef>Cursor <function>XCreatePixmapCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -527,7 +527,7 @@ Specify the x and y coordinates(Xy.
<!-- .LP -->
<!-- .eM -->
The
-<function>XCreatePixmapCursor</function>
+<xref linkend='XCreatePixmapCursor' xrefstyle='select: title'/>
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,
@@ -567,7 +567,7 @@ The X server might or might not make a copy of the pixmap.
</para>
<para>
<!-- .LP -->
-<function>XCreatePixmapCursor</function>
+<xref linkend='XCreatePixmapCursor' xrefstyle='select: title'/>
can generate
<errorname>BadAlloc</errorname>
and
@@ -578,11 +578,11 @@ errors.
<!-- .LP -->
<!-- .sp -->
To determine useful cursor sizes, use
-<function>XQueryBestCursor</function>.
+<xref linkend='XQueryBestCursor' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XQueryBestCursor</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xquerybestcursor'>
+<funcsynopsis id='XQueryBestCursor'>
<funcprototype>
<funcdef>Status <function>XQueryBestCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -664,7 +664,7 @@ and height.
<!-- .eM -->
Some displays allow larger cursors than other displays.
The
-<function>XQueryBestCursor</function>
+<xref linkend='XQueryBestCursor' xrefstyle='select: title'/>
function provides a way to find out what size cursors are actually
possible on the display.
<indexterm ><primary>Cursor</primary><secondary>limitations</secondary></indexterm>
@@ -674,7 +674,7 @@ cannot support large ones.
</para>
<para>
<!-- .LP -->
-<function>XQueryBestCursor</function>
+<xref linkend='XQueryBestCursor' xrefstyle='select: title'/>
can generate a
<errorname>BadDrawable</errorname>
error.
@@ -683,11 +683,11 @@ error.
<!-- .LP -->
<!-- .sp -->
To change the color of a given cursor, use
-<function>XRecolorCursor</function>.
+<xref linkend='XRecolorCursor' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XRecolorCursor</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xrecolorcursor'>
+<funcsynopsis id='XRecolorCursor'>
<funcprototype>
<funcdef><function>XRecolorCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -742,7 +742,7 @@ Specifies the <acronym>RGB</acronym> values for the background of the source.
<!-- .LP -->
<!-- .eM -->
The
-<function>XRecolorCursor</function>
+<xref linkend='XRecolorCursor' xrefstyle='select: title'/>
function changes the color of the specified cursor, and
if the cursor is being displayed on a screen,
the change is visible immediately.
@@ -752,7 +752,7 @@ structures are ignored; only the <acronym>RGB</acronym> values are used.
</para>
<para>
<!-- .LP -->
-<function>XRecolorCursor</function>
+<xref linkend='XRecolorCursor' xrefstyle='select: title'/>
can generate a
<errorname>BadCursor</errorname>
error.
@@ -761,11 +761,11 @@ error.
<!-- .LP -->
<!-- .sp -->
To free (destroy) a given cursor, use
-<function>XFreeCursor</function>.
+<xref linkend='XFreeCursor' xrefstyle='select: title'/>.
</para>
<indexterm significance="preferred"><primary>XFreeCursor</primary></indexterm>
<!-- .sM -->
-<funcsynopsis id='xfreecursor'>
+<funcsynopsis id='XFreeCursor'>
<funcprototype>
<funcdef><function>XFreeCursor</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -799,7 +799,7 @@ Specifies the cursor.
<!-- .LP -->
<!-- .eM -->
The
-<function>XFreeCursor</function>
+<xref linkend='XFreeCursor' xrefstyle='select: title'/>
function deletes the association between the cursor resource ID
and the specified cursor.
The cursor storage is freed when no other resource references it.
@@ -807,7 +807,7 @@ The specified cursor ID should not be referred to again.
</para>
<para>
<!-- .LP -->
-<function>XFreeCursor</function>
+<xref linkend='XFreeCursor' xrefstyle='select: title'/>
can generate a
<errorname>BadCursor</errorname>
error.