Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XkbAddGeomKeyAlias(3)		 XKB FUNCTIONS		 XkbAddGeomKeyAlias(3)

NAME
       XkbAddGeomKeyAlias - Add	one key	alias to an existing keyboard geometry
       description

SYNOPSIS

       XkbKeyAliasPtr  XkbAddGeomKeyAlias  (XkbGeometryPtr  geom, _Xconst char
	      *alias, _Xconst char *real);

ARGUMENTS
       geom   geometry to be updated

       alias  alias to be added

       real   real name	to be bound to the new alias

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_*  un-
       less  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 ele-
       ments.

       The top-level geometry description includes a list of geometry  proper-
       ties.   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.

       XkbAddGeomKeyAlias adds one key alias with the value alias to the geom-
       etry geom, and associates it with the key whose real name is real.  Xk-
       bAddGeomKeyAlias	 returns  NULL if any of the parameters	is empty or if
       it was not able to allocate space for the alias.	To allocate space  for
       an  arbitrary  number  of aliases, use the XkbAllocGeomKeyAliases func-
       tion.

STRUCTURES
	   typedef struct {
	       char	       real[XkbKeyNameLength];	 /* this key name must be in the keys array */
	       char	       alias[XkbKeyNameLength];	 /* symbolic key name as alias for the key */
	   } XkbKeyAliasRec,*XkbKeyAliasPtr;

SEE ALSO
       XkbAllocGeomKeyAliases(3)

X Version 11			 libX11	1.8.12		 XkbAddGeomKeyAlias(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XkbAddGeomKeyAlias&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help