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

NAME

6       XkbAddGeomOverlayRow - Add a row to an existing overlay
7

SYNOPSIS

9       XkbOverlayRowPtr XkbAddGeomOverlayRow (XkbOverlayPtr overlay, XkbRowPtr
10              row_under, int sz_keys);
11

ARGUMENTS

13       overlay
14              overlay to be updated
15
16       row_under
17              row to be overlaid in the section overlay overlays
18
19       sz_keys
20              number of keys to reserve in the row
21

DESCRIPTION

23       Xkb provides functions to add a single new  element  to  the  top-level
24       keyboard  geometry. In each case the num_ * fields of the corresponding
25       structure is incremented by 1. These functions do not change  sz_*  un‐
26       less  there  is no more room in the array. Some of these functions fill
27       in the values of the element's structure from the arguments. For  other
28       functions,  you must explicitly write code to fill the structure's ele‐
29       ments.
30
31       The top-level geometry description includes a list of geometry  proper‐
32       ties.   A  geometry  property  associates  an  arbitrary string with an
33       equally arbitrary name. Programs that display images of  keyboards  can
34       use  geometry properties as hints, but they are not interpreted by Xkb.
35       No other geometry structures refer to geometry properties.
36
37       XkbAddGeomOverlayRow adds one row to the overlay.  The new row contains
38       space for sz_keys keys. If row_under specifies a row that doesn't exist
39       on  the  underlying  section,  XkbAddGeomOverlayRow  returns  NULL  and
40       doesn't  change  the overlay.  XkbAddGeomOverlayRow returns NULL if any
41       of the parameters is empty or if it was not able to allocate space  for
42       the overlay.
43

STRUCTURES

45           typedef struct _XkbOverlayRow {
46               unsigned short      row_under;    /* index into the row under this overlay row */
47               unsigned short      num_keys;     /* number of keys in the keys array */
48               unsigned short      sz_keys;      /* size of the keys array */
49               XkbOverlayKeyPtr    keys;         /* array of keys in the overlay row */
50           } XkbOverlayRowRec,*XkbOverlayRowPtr;
51
52
53
54
55X Version 11                     libX11 1.8.7          XkbAddGeomOverlayRow(3)
Impressum