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

FreeBSD Manual Pages

  
 
  

home | help
XStringToKeysym(3)		XLIB FUNCTIONS		    XStringToKeysym(3)

NAME
       XStringToKeysym,	 XKeysymToString,  XKeycodeToKeysym, XKeysymToKeycode,
       XConvertCase - convert keysyms

SYNTAX
       KeySym XStringToKeysym(_Xconst char *string);

       char *XKeysymToString(KeySym keysym);

       KeySym XKeycodeToKeysym(Display *display, KeyCode keycode, int index);

       KeyCode XKeysymToKeycode(Display	*display, KeySym keysym);

       void XConvertCase(KeySym	 keysym,  KeySym  *lower_return,  KeySym  *up-
	      per_return);

ARGUMENTS
       display	 Specifies the connection to the X server.

       index	 Specifies the element of KeyCode vector.

       keycode	 Specifies the KeyCode.

       keysym	 Specifies the KeySym that is to be searched for or converted.

       lower_return
		 Returns the lowercase form of keysym, or keysym.

       string	 Specifies the name of the KeySym that is to be	converted.

       upper_return
		 Returns the uppercase form of keysym, or keysym.

DESCRIPTION
       Standard	KeySym names are obtained from by removing the XK_ prefix from
       each name.  KeySyms that	are not	part of	the Xlib standard also may  be
       obtained	 with this function.  The set of KeySyms that are available in
       this manner and the mechanisms by which Xlib obtains them is  implemen-
       tation-dependent.

       If  the KeySym name is not in the Host Portable Character Encoding, the
       result is implementation-dependent.  If the specified string  does  not
       match a valid KeySym, XStringToKeysym returns NoSymbol.

       The  returned string is in a static area	and must not be	modified.  The
       returned	string is in the Host Portable	Character  Encoding.   If  the
       specified KeySym	is not defined,	XKeysymToString	returns	a NULL.

       The XKeycodeToKeysym function uses internal Xlib	tables and returns the
       KeySym defined for the specified	KeyCode	and the	element	of the KeyCode
       vector.	 If  no	 symbol	is defined, XKeycodeToKeysym returns NoSymbol.
       XKeycodeToKeysym	predates the XKB extension.  If	you want to  lookup  a
       KeySym while using XKB you have to use XkbKeycodeToKeysym.

       If  the	specified KeySym is not	defined	for any	KeyCode, XKeysymToKey-
       code returns zero.

       The XConvertCase	function returns the uppercase and lowercase forms  of
       the specified Keysym, if	the KeySym is subject to case conversion; oth-
       erwise, the specified KeySym is returned	to both	lower_return  and  up-
       per_return.   Support  for  conversion of other than Latin and Cyrillic
       KeySyms is implementation-dependent.

SEE ALSO
       XkbKeycodeToKeysym(3), XLookupKeysym(3)
       Xlib - C	Language X Interface

X Version 11			 libX11	1.6.12		    XStringToKeysym(3)

NAME | SYNTAX | ARGUMENTS | DESCRIPTION | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XStringToKeysym&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help