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

FreeBSD Manual Pages

  
 
  

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

NAME
     XkbGetKeyboard  -	  Retrieves  one or more components of a keyboard device
     description

SYNOPSIS
     XkbDescPtr XkbGetKeyboard (Display *display, unsigned int	which,	unsigned
	    int device_spec);

ARGUMENTS
     display
	    connection to the X server

     device_spec
	    device ID, or XkbUseCoreKbd

     bits_to_change
	    determines events to be selected / deselected

     values_for_bits
	    1=>select, 0->deselect; for events in bits_to_change

DESCRIPTION
     XkbGetKeyboard  allocates	and returns a pointer to a keyboard description.
     It queries the server for those components specified in the which parameter
     for device device_spec and copies the results to the  XkbDescRec  it  allo-
     cated.  The  remaining  fields in the keyboard description are set to NULL.
     The valid masks for which are those listed in Table 1.

	     Table 1 Mask Bits for XkbDescRec
     --------------------------------------------------
     Mask Bit		    XkbDescRec Field   Value
     --------------------------------------------------
     XkbControlsMask	    ctrls	       (1L<<0)
     XkbServerMapMask	    server	       (1L<<1)
     XkbIClientMapMask	    map 	       (1L<<2)
     XkbIndicatorMapMask    indicators	       (1L<<3)
     XkbNamesMask	    names	       (1L<<4)
     XkbCompatMapMask	    compat	       (1L<<5)
     XkbGeometryMask	    geom	       (1L<<6)
     XkbAllComponentsMask   All Fields	       (1L<<7)

     XkbGetKeyboard is used to read the current description for one or more com-
     ponents of a keyboard device. It calls XkbGetKeyboardByName(3) as follows:

     XkbGetKeyboardByName(dpy, device_spec, NULL, which, which, False).

     If successful, XkbGetKeyboard returns a pointer to a newly allocated XkbDe-
     scRec structure, which is described in XkbGetKeyboardByName(3),  and  which
     should  be  freed with XkbFreeKeyboard(3).  If XkbGetKeyboard does not suc-
     ceed, it returns NULL.

DIAGNOSTICS
     BadAlloc	    Unable to allocate storage

SEE ALSO
     XkbGetKeyboardByName(3)

X Version 11			  libX11 1.8.13 	       XkbGetKeyboard(3)

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

home | help