man/xkb/XkbFreeGeomOverlayKeys.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 XkbFreeGeomOverlayKeys __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbFreeGeomOverlayKeys \- Free keys in an overlay row
  25 .SH SYNOPSIS
  26 .HP
  27 .B void XkbFreeGeomOverlayKeys
  28 .BI "(\^XkbRowPtr " "row" "\^,"
  29 .BI "int " "first" "\^,"
  30 .BI "int " "count" "\^,"
  31 .BI "Bool " "free_all" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- row
  37 row in which keys should be freed
  38 .TP
  39 .I \- first
  40 first key to be freed
  41 .TP
  42 .I \- count
  43 number of keys to be freed
  44 .TP
  45 .I \- free_all
  46 True => all keys are freed
  47 .SH DESCRIPTION
  48 .LP
  49 Xkb provides a number of functions to allocate and free subcomponents of a
  50 keyboard geometry. Use these functions to create or modify keyboard geometries.
  51 Note that these functions merely allocate space for the new element(s), and it
  52 is up to you to fill in the values explicitly in your code. These allocation
  53 functions increase
  54 .I sz_*
  55 but never touch
  56 .I num_*
  57 (unless there is an allocation failure, in which case they reset both
  58 .I sz_*
  59 and
  60 .I num_*
  61 to zero). These functions return Success if they succeed, BadAlloc if they are
  62 not able to allocate space, or BadValue if a parameter is not as expected.
  63
  64 If
  65 .I free_all
  66 is True, all keys are freed regardless of the value of
  67 .I first
  68 and
  69 .I count.
  70 Otherwise, the number of keys specified by
  71 .I count
  72 are freed, beginning with the key specified by
  73 .I first
  74 in the specified row.
  75 .SH "RETURN VALUES"
  76 .TP 15
  77 Success
  78 The XkbFreeGeomOverlayKeys function returns Success if there are no allocation
  79 or argument errors.
  80 .SH DIAGNOSTICS
  81 .TP 15
  82 .B BadAlloc
  83 Unable to allocate storage
  84 .TP 15
  85 .B BadValue
  86 An argument is out of range