diff options
Diffstat (limited to 'libX11/man/xkb/XkbCopyKeyType.man')
-rw-r--r-- | libX11/man/xkb/XkbCopyKeyType.man | 188 |
1 files changed, 94 insertions, 94 deletions
diff --git a/libX11/man/xkb/XkbCopyKeyType.man b/libX11/man/xkb/XkbCopyKeyType.man index ddc90369c..cfcbd4356 100644 --- a/libX11/man/xkb/XkbCopyKeyType.man +++ b/libX11/man/xkb/XkbCopyKeyType.man @@ -1,94 +1,94 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
-.\"
-.\" Permission is hereby granted, free of charge, to any person obtaining a
-.\" copy of this software and associated documentation files (the "Software"),
-.\" to deal in the Software without restriction, including without limitation
-.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
-.\" and/or sell copies of the Software, and to permit persons to whom the
-.\" Software is furnished to do so, subject to the following conditions:
-.\"
-.\" The above copyright notice and this permission notice (including the next
-.\" paragraph) shall be included in all copies or substantial portions of the
-.\" Software.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-.\" DEALINGS IN THE SOFTWARE.
-.\"
-.TH XkbCopyKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
-.SH NAME
-XkbCopyKeyType \- Copy one XkbKeyTypeRec structures
-.SH SYNOPSIS
-.HP
-.B Status XkbCopyKeyType
-.BI "(\^XkbKeyTypePtr " "from" "\^,"
-.BI "XkbKeyTypePtr " "into" "\^);"
-.if n .ti +5n
-.if t .ti +.5i
-.SH ARGUMENTS
-.TP
-.I \- from
-pointer to XkbKeyTypeRec to be copied
-.TP
-.I \- into
-pointer to XkbKeyTypeRec to be changed
-.SH DESCRIPTION
-.LP
-.I XkbCopyKeyType
-copies the key type specified by
-.I from
-to the key type specified by
-.I into.
-Both must point to legal XkbKeyTypeRec structures. Xkb assumes
-.I from
-and
-.I into
-point to different places. As a result, overlaps can be fatal.
-.I XkbCopyKeyType
-frees any existing
-.I map, preserve,
-and
-.I level_names
-in
-.I into
-prior to copying. If any allocation errors occur while copying
-.I from
-to
-.I into, XkbCopyKeyType
-returns BadAlloc. Otherwise,
-.I XkbCopyKeyType
-copies
-.I from
-to
-.I into
-and returns Success.
-.SH STRUCTURES
-.LP
-Key types are used to determine the shift level of a key given the current state of the
-keyboard. The set of all possible key types for the Xkb keyboard description are held in the
-.I types
-field of the client map, whose total size is stored in
-.I size_types,
-and whose total number of valid entries is stored in
-.I num_types.
-Key types are defined using the following structure:
-.nf
-
-typedef struct { /\(** Key Type */
- XkbModsRec mods; /\(** modifiers used to compute shift level */
- unsigned char num_levels; /\(** total # shift levels, do not modify directly */
- unsigned char map_count; /\(** # entries in map, preserve (if non-NULL) */
- XkbKTMapEntryPtr map; /\(** vector of modifiers for each shift level */
- XkbModsPtr preserve; /\(** mods to preserve for corresponding map entry */
- Atom name; /\(** name of key type */
- Atom * level_names; /\(** array of names of each shift level */
-} XkbKeyTypeRec, *XkbKeyTypePtr;
-.fi
-.SH DIAGNOSTICS
-.TP 15
-.B BadAlloc
-Unable to allocate storage
+.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining a +.\" copy of this software and associated documentation files (the "Software"), +.\" to deal in the Software without restriction, including without limitation +.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, +.\" and/or sell copies of the Software, and to permit persons to whom the +.\" Software is furnished to do so, subject to the following conditions: +.\" +.\" The above copyright notice and this permission notice (including the next +.\" paragraph) shall be included in all copies or substantial portions of the +.\" Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +.\" DEALINGS IN THE SOFTWARE. +.\" +.TH XkbCopyKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbCopyKeyType \- Copy one XkbKeyTypeRec structures +.SH SYNOPSIS +.HP +.B Status XkbCopyKeyType +.BI "(\^XkbKeyTypePtr " "from" "\^," +.BI "XkbKeyTypePtr " "into" "\^);" +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- from +pointer to XkbKeyTypeRec to be copied +.TP +.I \- into +pointer to XkbKeyTypeRec to be changed +.SH DESCRIPTION +.LP +.I XkbCopyKeyType +copies the key type specified by +.I from +to the key type specified by +.I into. +Both must point to legal XkbKeyTypeRec structures. Xkb assumes +.I from +and +.I into +point to different places. As a result, overlaps can be fatal. +.I XkbCopyKeyType +frees any existing +.I map, preserve, +and +.I level_names +in +.I into +prior to copying. If any allocation errors occur while copying +.I from +to +.I into, XkbCopyKeyType +returns BadAlloc. Otherwise, +.I XkbCopyKeyType +copies +.I from +to +.I into +and returns Success. +.SH STRUCTURES +.LP +Key types are used to determine the shift level of a key given the current state of the +keyboard. The set of all possible key types for the Xkb keyboard description are held in the +.I types +field of the client map, whose total size is stored in +.I size_types, +and whose total number of valid entries is stored in +.I num_types. +Key types are defined using the following structure: +.nf + +typedef struct { /\(** Key Type */ + XkbModsRec mods; /\(** modifiers used to compute shift level */ + unsigned char num_levels; /\(** total # shift levels, do not modify directly */ + unsigned char map_count; /\(** # entries in map, preserve (if non-NULL) */ + XkbKTMapEntryPtr map; /\(** vector of modifiers for each shift level */ + XkbModsPtr preserve; /\(** mods to preserve for corresponding map entry */ + Atom name; /\(** name of key type */ + Atom * level_names; /\(** array of names of each shift level */ +} XkbKeyTypeRec, *XkbKeyTypePtr; +.fi +.SH DIAGNOSTICS +.TP 15 +.B BadAlloc +Unable to allocate storage |