1XkbAddGeomDoodad(3) XKB FUNCTIONS XkbAddGeomDoodad(3)
2
6 XkbAddGeomDoodad - Add one doodad to a section of a keyboard geometry
7 or to the top-level geometry
8
10 XkbDoodadPtr XkbAddGeomDoodad (XkbGeometryPtr geom, XkbSectionPtr sec‐
11 tion, Atom name);
12
14 - geom geometry to which the doodad is added
15 - section
17 section, if any, to which the doodad is added
18 - name name of the new doodad
20
22 Xkb provides functions to add a single new element to the top-level
23 keyboard geometry. In each case the num_ * fields of the corresponding
24 structure is incremented by 1. These functions do not change sz_*
25 unless there is no more room in the array. Some of these functions fill
26 in the values of the element's structure from the arguments. For other
27 functions, you must explicitly write code to fill the structure's ele‐
28 ments.
29 The top-level geometry description includes a list of geometry proper‐
31 ties. A geometry property associates an arbitrary string with an
32 equally arbitrary name. Programs that display images of keyboards can
33 use geometry properties as hints, but they are not interpreted by Xkb.
34 No other geometry structures refer to geometry properties.
35 A doodad describes some visible aspect of the keyboard that is not a
37 key and is not a section. XkbAddGeomDoodad adds a doodad with name
38 specified by name to the geometry geom if section is NULL or to the
39 section of the geometry specified by section if section is not NULL.
40 XkbAddGeomDoodad returns NULL if any of the parameters is empty or if
41 it was not able to allocate space for the doodad. If there is already a
42 doodad with the name name in the doodad array for the geometry (if sec‐
43 tion is NULL) or the section (if section is non-NULL), a pointer to
44 that doodad is returned. To allocate space for an arbitrary number of
45 doodads to a section, use the XkbAllocGeomSectionDoodads function. To
46 allocate space for an arbitrary number of doodads to a keyboard geome‐
47 try, use the XkbAllocGeomDoodads function.
48
50 typedef union _XkbDoodad {
51 XkbAnyDoodadRec any;
52 XkbShapeDoodadRec shape;
53 XkbTextDoodadRec text;
54 XkbIndicatorDoodadRec indicator;
55 XkbLogoDoodadRec logo;
56 } XkbDoodadRec, *XkbDoodadPtr;
57
60 XkbAllocGeomDoodads(3), XkbAllocGeomSectionDoodads(3)
61X Version 11 libX11 1.3.4 XkbAddGeomDoodad(3)