man/xkb/XkbAddGeomOutline.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 XkbAddGeomOutline __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbAddGeomOutline \- Add one outline to an existing shape
  25 .SH SYNOPSIS
  26 .HP
  27 .B XkbOutlinePtr XkbAddGeomOutline
  28 .BI "(\^XkbShapePtr " "shape" "\^,"
  29 .BI "int " "sz_points" "\^);"
  30 .if n .ti +5n
  31 .if t .ti +.5i
  32 .SH ARGUMENTS
  33 .TP
  34 .I \- shape
  35 shape to be updated
  36 .TP
  37 .I \- sz_points
  38 number of points to be reserved
  39 .SH DESCRIPTION
  40 .LP
  41 Xkb provides functions to add a single new element to the top-level keyboard
  42 geometry. In each case the
  43 .I num_ *
  44 fields of the corresponding structure is incremented by 1. These functions do
  45 not change
  46 .I sz_*
  47 unless there is no more room in the array. Some of these functions fill in the
  48 values of the element's structure from the arguments. For other functions, you
  49 must explicitly write code to fill the structure's elements.
  50
  51 The top-level geometry description includes a list of
  52 .I geometry properties.
  53 A geometry property associates an arbitrary string with an equally arbitrary
  54 name. Programs that display images of keyboards can use geometry properties as
  55 hints, but they are not interpreted by Xkb. No other geometry structures refer
  56 to geometry properties.
  57
  58 An outline consists of an arbitrary number of points.
  59 .I XkbAddGeomOutline
  60 adds an outline to the specified
  61 .I shape
  62 by reserving
  63 .I sz_points
  64 points for it. The new outline is allocated and zeroed.
  65 .I XkbAddGeomOutline
  66 returns NULL if any of the parameters is empty or if it was not able to allocate
  67 space. To allocate space for an arbitrary number of outlines to a shape, use
  68 .I XkbAllocGeomOutlines.
  69 .SH STRUCTURES
  70 .LP
  71 .nf
  72
  73     typedef struct _XkbOutline {
  74         unsigned short    num_points;      /\(** number of points in the outline */
  75         unsigned short    sz_points;       /\(** size of the points array */
  76         unsigned short    corner_radius;   /\(** draw corners as circles with this radius */
  77         XkbPointPtr       points;          /\(** array of points defining the outline */
  78     } XkbOutlineRec, *XkbOutlinePtr;
  79
  80 .fi
  81 .SH "SEE ALSO"
  82 .BR XkbAllocGeomOutlines (__libmansuffix__)