Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xkbaddgeomkeyalias(3) [suse man page]

XkbAddGeomKeyAlias(3)						   XKB FUNCTIONS					     XkbAddGeomKeyAlias(3)

NAME
XkbAddGeomKeyAlias - Add one key alias to an existing keyboard geometry description SYNOPSIS
XkbKeyAliasPtr XkbAddGeomKeyAlias (XkbGeometryPtr geom, char *alias, 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_* 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. XkbAddGeomKeyAlias adds one key alias with the value alias to the geometry geom, and associates it with the key whose real name is real. XkbAddGeomKeyAlias 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 function. 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.3.2 XkbAddGeomKeyAlias(3)

Check Out this Related Man Page

XkbAllocGeomKeyAliases(3)					   XKB FUNCTIONS					 XkbAllocGeomKeyAliases(3)

NAME
XkbAllocGeomKeyAliases - Allocate geometry key aliases SYNOPSIS
Status XkbAllocGeomKeyAliases ( geom, num_needed ) XkbGeometryPtr geom; int num_needed; ARGUMENTS
- geom geometry for which key aliases should be allocated - num_needed number of new key aliases required DESCRIPTION
Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify key- board geometries. Note that these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase sz_* but never touch num_* (unless there is an allocation failure, in which case they reset both sz_* and num_* to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. XkbAllocGeomKeyAliases allocates space for num_needed key aliases and adds them to the specified geometry geom. A key alias is a pair of strings that associates an alternate name for a key with the real name for that key. To free geometry key aliases, use XkbFreeGeomKeyAliases. DIAGNOSTICS
BadAlloc Unable to allocate storage BadValue An argument is out of range SEE ALSO
XkbFreeGeomKeyAliases(3) X Version 11 libX11 1.2.1 XkbAllocGeomKeyAliases(3)
Man Page