man/xkb/XkbAllocGeometry.man

   1 '\" t
   2 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a
   5 .\" copy of this software and associated documentation files (the "Software"),
   6 .\" to deal in the Software without restriction, including without limitation
   7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 .\" and/or sell copies of the Software, and to permit persons to whom the
   9 .\" Software is furnished to do so, subject to the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice (including the next
  12 .\" paragraph) shall be included in all copies or substantial portions of the
  13 .\" Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 .\" DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .TH XkbAllocGeometry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbAllocGeometry \- Allocate an entire geometry
  26 .SH SYNOPSIS
  27 .HP
  28 .B Status XkbAllocGeometry
  29 .BI "(\^XkbDescPtr " "xkb" "\^,"
  30 .BI "XkbGeometrySizesPtr " "sizes" "\^);"
  31 .if n .ti +5n
  32 .if t .ti +.5i
  33 .SH ARGUMENTS
  34 .TP
  35 .I \- xkb
  36 keyboard description for which geometry is to be allocated
  37 .TP
  38 .I \- sizes
  39 initial sizes for all geometry components
  40 .SH DESCRIPTION
  41 .LP
  42 Xkb provides a number of functions to allocate and free subcomponents of a
  43 keyboard geometry. Use these functions to create or modify keyboard geometries.
  44 Note that these functions merely allocate space for the new element(s), and it
  45 is up to you to fill in the values explicitly in your code. These allocation
  46 functions increase
  47 .I sz_*
  48 but never touch
  49 .I num_*
  50 (unless there is an allocation failure, in which case they reset both
  51 .I sz_*
  52 and
  53 .I num_*
  54 to zero). These functions return Success if they succeed, BadAlloc if they are
  55 not able to allocate space, or BadValue if a parameter is not as expected.
  56
  57 .I XkbAllocGeometry
  58 allocates a keyboard geometry and adds it to the keyboard description specified
  59 by
  60 .I xkb.
  61 The keyboard description should be obtained via the
  62 .I XkbGetKeyboard
  63 or
  64 .I XkbAllocKeyboard
  65 functions. The
  66 .I sizes
  67 parameter specifies the number of elements to be reserved for the subcomponents
  68 of the keyboard geometry and can be zero or more. These subcomponents include
  69 the
  70 .I properties, colors, shapes, sections, and doodads.
  71
  72 To free an entire geometry, use
  73 .I XkbFreeGeometry.
  74 .SH DIAGNOSTICS
  75 .TP 15
  76 .B BadAlloc
  77 Unable to allocate storage
  78 .TP 15
  79 .B BadValue
  80 An argument is out of range
  81 .SH "SEE ALSO"
  82 .BR XkbAllocKeyboard (__libmansuffix__),
  83 .BR XkbFreeGeometry (__libmansuffix__),
  84 .BR XkbGetKeyboard (__libmansuffix__)
  85