diff options
Diffstat (limited to 'libX11/specs/libX11/CH12.xml')
| -rw-r--r-- | libX11/specs/libX11/CH12.xml | 724 |
1 files changed, 362 insertions, 362 deletions
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>.
|