xkbaddgeomoverlay(3) [x11r4 man page]

XkbAddGeomOverlay(3)						   XKB FUNCTIONS					      XkbAddGeomOverlay(3)

NAME

       XkbAddGeomOverlay - Add one overlay to a section

SYNOPSIS

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

ARGUMENTS

       - section
	      section to which an overlay will be added

       - name name of the overlay

       - sz_rows
	      number of rows to reserve in the overlay

DESCRIPTION

       Xkb  provides functions to add a single new element to the top-level keyboard geometry. In each case the num_ * fields of the corresponding
       structure is incremented by 1. These functions do not change sz_* unless there is no more room in the array. Some of these  functions  fill
       in  the	values	of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's
       elements.

       The top-level geometry description includes a list of geometry properties.  A geometry property associates  an  arbitrary  string  with	an
       equally	arbitrary  name.  Programs  that display images of keyboards can use geometry properties as hints, but they are not interpreted by
       Xkb. No other geometry structures refer to geometry properties.

       XkbAddGeomOverlay adds an overlay with the specified name to the specified section.  The new overlay is created with  space  allocated  for
       sz_rows rows. If an overlay with name name already exists in the section, a pointer to the existing overlay is returned.  XkbAddGeomOverlay
       returns NULL if any of the parameters is empty or if it was not able to allocate space for the overlay. To allocate space for an  arbitrary
       number of overlays to a section, use the XkbAllocGeomOverlay function.

STRUCTURES

	   typedef struct _XkbOverlayRec {
	       Atom		     name;	      /* overlay name */
	       XkbSectionPtr	     section_under;   /* the section under this overlay */
	       unsigned short	     num_rows;	      /* number of rows in the rows array */
	       unsigned short	     sz_rows;	      /* size of the rows array */
	       XkbOverlayRowPtr      rows;	      /* array of rows in the overlay */
	       XkbBoundsPtr	     bounds;	      /* bounding box for the overlay */
	   } XkbOverlayRec,*XkbOverlayPtr;

SEE ALSO

       XkbAllocGeomOverlay(3)

X Version 11							   libX11 1.2.1 					      XkbAddGeomOverlay(3)

Check Out this Related Man Page

XkbAddGeomOverlayRow(3) 					   XKB FUNCTIONS					   XkbAddGeomOverlayRow(3)

NAME

       XkbAddGeomOverlayRow - Add a row to an existing overlay

SYNOPSIS

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

ARGUMENTS

       - overlay
	      overlay to be updated

       - row_under
	      row to be overlayed in the section overlay overlays

       - sz_keys
	      number of keys to reserve in the row

DESCRIPTION

       Xkb  provides functions to add a single new element to the top-level keyboard geometry. In each case the num_ * fields of the corresponding
       structure is incremented by 1. These functions do not change sz_* unless there is no more room in the array. Some of these  functions  fill
       in  the	values	of the element's structure from the arguments. For other functions, you must explicitly write code to fill the structure's
       elements.

       The top-level geometry description includes a list of geometry properties.  A geometry property associates  an  arbitrary  string  with	an
       equally	arbitrary  name.  Programs  that display images of keyboards can use geometry properties as hints, but they are not interpreted by
       Xkb. No other geometry structures refer to geometry properties.

       XkbAddGeomOverlayRow adds one row to the overlay.  The new row contains space for sz_keys keys. If row_under specifies a row  that  doesn't
       exist  on  the  underlying section, XkbAddGeomOverlayRow returns NULL and doesn't change the overlay.  XkbAddGeomOverlayRow returns NULL if
       any of the parameters is empty or if it was not able to allocate space for the overlay.

STRUCTURES

	   typedef struct _XkbOverlayRow {
	       unsigned short	   row_under;	 /* index into the row under this overlay row */
	       unsigned short	   num_keys;	 /* number of keys in the keys array */
	       unsigned short	   sz_keys;	 /* size of the keys array */
	       XkbOverlayKeyPtr    keys;	 /* array of keys in the overlay row */
	   } XkbOverlayRowRec,*XkbOverlayRowPtr;

X Version 11							   libX11 1.2.1 					   XkbAddGeomOverlayRow(3)

Linux and UNIX Man Pages

xkbaddgeomoverlay(3) [x11r4 man page]

Check Out this Related Man Page