1XkbAddGeomShape(3)               XKB FUNCTIONS              XkbAddGeomShape(3)
2
3
4

NAME

6       XkbAddGeomShape - Add a shape to a keyboard geometry
7

SYNOPSIS

9       XkbShapePtr   XkbAddGeomShape  (XkbGeometryPtr  geom,  Atom  name,  int
10              sz_outlines);
11

ARGUMENTS

13       - geom geometry to be updated
14
15       - name name of the new shape
16
17       - sz_outlines
18              number of outlines to be reserved
19

DESCRIPTION

21       Xkb provides functions to add a single new  element  to  the  top-level
22       keyboard  geometry. In each case the num_ * fields of the corresponding
23       structure is incremented by 1.  These  functions  do  not  change  sz_*
24       unless there is no more room in the array. Some of these functions fill
25       in the values of the element's structure from the arguments. For  other
26       functions,  you must explicitly write code to fill the structure's ele‐
27       ments.
28
29       The top-level geometry description includes a list of geometry  proper‐
30       ties.   A  geometry  property  associates  an  arbitrary string with an
31       equally arbitrary name. Programs that display images of  keyboards  can
32       use  geometry properties as hints, but they are not interpreted by Xkb.
33       No other geometry structures refer to geometry properties.
34
35       A geometry contains an arbitrary number of shapes,  each  of  which  is
36       made  up  of  an  arbitrary number of outlines.  XkbAddGeomShape adds a
37       shape to a geometry geom by allocating space for  sz_outlines  outlines
38       for  it and giving it the name specified by name.  If a shape with name
39       name already exists in the geometry, a pointer to the existing shape is
40       returned.   XkbAddGeomShape  returns  NULL  if any of the parameters is
41       empty or if it was not able to allocate space. To allocate space for an
42       arbitrary number of geometry shapes, use XkbAllocGeomShapes.
43

STRUCTURES

45           typedef struct _XkbShape {
46               Atom              name;           /∗ shape's name */
47               unsigned short    num_outlines;   /∗ number of outlines for the shape */
48               unsigned short    sz_outlines;    /∗ size of the outlines array */
49               XkbOutlinePtr     outlines;       /∗ array of outlines for the shape */
50               XkbOutlinePtr     approx;         /∗ pointer into the array to the approximating outline */
51               XkbOutlinePtr     primary;        /∗ pointer into the array to the primary outline */
52               XkbBoundsRec      bounds;         /∗ bounding box for the shape; encompasses all outlines */
53           } XkbShapeRec, *XkbShapePtr;
54
55

SEE ALSO

57       XkbAllocGeomShapes(3)
58
59
60
61X Version 11                     libX11 1.6.5               XkbAddGeomShape(3)
Impressum