man/xkb/XkbAddGeomOverlayRow.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 XkbAddGeomOverlayRow __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbAddGeomOverlayRow \- Add a row to an existing overlay
  25 .SH SYNOPSIS
  26 .HP
  27 .B XkbOverlayRowPtr XkbAddGeomOverlayRow
  28 .BI "(\^XkbOverlayPtr " "overlay" "\^,"
  29 .BI "XkbRowPtr " "row_under" "\^,"
  30 .BI "int " "sz_keys" "\^);"
  31 .if n .ti +5n
  32 .if t .ti +.5i
  33 .SH ARGUMENTS
  34 .TP
  35 .I \- overlay
  36 overlay to be updated
  37 .TP
  38 .I \- row_under
  39 row to be overlayed in the section overlay overlays
  40 .TP
  41 .I \- sz_keys
  42 number of keys to reserve in the row
  43 .SH DESCRIPTION
  44 .LP
  45 Xkb provides functions to add a single new element to the top-level keyboard
  46 geometry. In each case the
  47 .I num_ *
  48 fields of the corresponding structure is incremented by 1. These functions do
  49 not change
  50 .I sz_*
  51 unless there is no more room in the array. Some of these functions fill in the
  52 values of the element's structure from the arguments. For other functions, you
  53 must explicitly write code to fill the structure's elements.
  54
  55 The top-level geometry description includes a list of
  56 .I geometry properties.
  57 A geometry property associates an arbitrary string with an equally arbitrary
  58 name. Programs that display images of keyboards can use geometry properties as
  59 hints, but they are not interpreted by Xkb. No other geometry structures refer
  60 to geometry properties.
  61
  62 .I XkbAddGeomOverlayRow
  63 adds one row to the
  64 .I overlay.
  65 The new row contains space for
  66 .I sz_keys
  67 keys. If
  68 . I row_under
  69 specifies a row that doesn't exist on the underlying section,
  70 .I  XkbAddGeomOverlayRow
  71 returns NULL and doesn't change the overlay.
  72 .I XkbAddGeomOverlayRow
  73 returns NULL if any of the parameters is empty or if it was not able to allocate
  74 space for the overlay.
  75 .SH STRUCTURES
  76 .LP
  77 .nf
  78
  79     typedef struct _XkbOverlayRow {
  80         unsigned short      row_under;    /\(** index into the row under this overlay row */
  81         unsigned short      num_keys;     /\(** number of keys in the keys array */
  82         unsigned short      sz_keys;      /\(** size of the keys array */
  83         XkbOverlayKeyPtr    keys;         /\(** array of keys in the overlay row */
  84     } XkbOverlayRowRec,*XkbOverlayRowPtr;
  85
  86 .fi