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

NAME

6       XkbAddGeomOverlay - Add one overlay to a section
7

SYNOPSIS

9       XkbOverlayPtr  XkbAddGeomOverlay (XkbSectionPtr section, Atom name, int
10              sz_rows);
11

ARGUMENTS

13       - section
14              section to which an overlay will be added
15
16       - name name of the overlay
17
18       - sz_rows
19              number of rows to reserve in the overlay
20

DESCRIPTION

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
30       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
36       XkbAddGeomOverlay adds an overlay with the specified name to the speci‐
37       fied  section.   The  new  overlay  is created with space allocated for
38       sz_rows rows. If an overlay with name name already exists in  the  sec‐
39       tion, a pointer to the existing overlay is returned.  XkbAddGeomOverlay
40       returns NULL if any of the parameters is empty or if it was not able to
41       allocate space for the overlay. To allocate space for an arbitrary num‐
42       ber of overlays to a section, use the XkbAllocGeomOverlay function.
43

STRUCTURES

45           typedef struct _XkbOverlayRec {
46               Atom                  name;            /∗ overlay name */
47               XkbSectionPtr         section_under;   /∗ the section under this overlay */
48               unsigned short        num_rows;        /∗ number of rows in the rows array */
49               unsigned short        sz_rows;         /∗ size of the rows array */
50               XkbOverlayRowPtr      rows;            /∗ array of rows in the overlay */
51               XkbBoundsPtr          bounds;          /∗ bounding box for the overlay */
52           } XkbOverlayRec,*XkbOverlayPtr;
53
54

SEE ALSO

56       XkbAllocGeomOverlay(3)
57
58
59
60X Version 11                     libX11 1.6.4             XkbAddGeomOverlay(3)
Impressum