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

NAME

6       XkbAddGeomSection - Add one section to an existing keyboard geometry
7

SYNOPSIS

9       XkbSectionPtr  XkbAddGeomSection  (XkbGeometryPtr  geom, Atom name, int
10              sz_rows, int sz_doodads, int sz_overlays);
11

ARGUMENTS

13       - geom geometry to be updated
14
15       - name name of the new section
16
17       - sz_rows
18              number of rows to reserve in the section
19
20       - sz_doodads
21              number of doodads to reserve in the section
22
23       - sz_overlays
24              number of overlays to reserve in the section
25

DESCRIPTION

27       Xkb provides functions to add a single new  element  to  the  top-level
28       keyboard  geometry. In each case the num_ * fields of the corresponding
29       structure is incremented by 1. These functions do not change  sz_*  un‐
30       less  there  is no more room in the array. Some of these functions fill
31       in the values of the element's structure from the arguments. For  other
32       functions,  you must explicitly write code to fill the structure's ele‐
33       ments.
34
35       The top-level geometry description includes a list of geometry  proper‐
36       ties.   A  geometry  property  associates  an  arbitrary string with an
37       equally arbitrary name. Programs that display images of  keyboards  can
38       use  geometry properties as hints, but they are not interpreted by Xkb.
39       No other geometry structures refer to geometry properties.
40
41       A keyboard geometry contains an arbitrary number of  sections.   XkbAd‐
42       dGeomSection  adds  one  section to an existing keyboard geometry geom.
43       The new section contains space for the number  of  rows,  doodads,  and
44       overlays  specified  by  sz_rows, sz_doodads, and sz_overlays.  The new
45       section is allocated and zeroed and given the name specified  by  name.
46       If  a  section with name name already exists in the geometry, a pointer
47       to the existing section is returned.  XkbAddGeomSection returns NULL if
48       any  of the parameters is empty or if it was not able to allocate space
49       for the section. To allocate space for an arbitrary number of  sections
50       to a geometry, use XkbAllocGeomSections.
51

STRUCTURES

53       typedef struct _XkbSection {
54           Atom                    name;        /* section name */
55           unsigned char           priority;    /* drawing priority, 0=>highest, 255=>lowest */
56           short                   top;         /* top coordinate of section origin */
57           short                   left;        /* left coordinate of row origin */
58           unsigned short          width;       /* section width, in mm/10 */
59           unsigned short          height;      /* section height, in mm/10 */
60           short                   angle;       /* angle of section rotation, counterclockwise */
61           unsigned short          num_rows;    /* number of rows in the rows array */
62           unsigned short          num_doodads; /* number of doodads in the doodads array */
63           unsigned short          num_overlays; /* number of overlays in the overlays array */
64           unsigned short          sz_rows;      /* size of the rows array */
65           unsigned short          sz_doodads;   /* size of the doodads array */
66           unsigned short          sz_overlays;  /* size of the overlays array */
67           XkbRowPtr               rows;         /* section rows array */
68           XkbDoodadPtr            doodads;      /* section doodads array */
69           XkbBoundsRec            bounds;       /* bounding box for the section, before rotation*/
70           XkbOverlayPtr           overlays;     /* section overlays array */
71       } XkbSectionRec, *XkbSectionPtr;
72
73       top  and  left are the origin of the section, relative to the origin of
74       the keyboard, in mm/10. angle is in 1/10 degrees.
75

SEE ALSO

77       XkbAllocGeomSections(3)
78
79
80
81X Version 11                     libX11 1.7.2             XkbAddGeomSection(3)
Impressum