man/xkb/XkbAllocGeomOverlays.man

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