XkbRefreshKeyboardMapping (3)
Leading comments
Copyright 1999 Oracle and/or its affiliates. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following condition...
NAME
XkbRefreshKeyboardMapping - Update the keyboard description that is internal to the X librarySYNOPSIS
-
Status XkbRefreshKeyboardMapping
(XkbMapNotifyEvent *event);
ARGUMENTS
- - event
-
- event initiating remapping
DESCRIPTION
XkbRefreshKeyboardMapping
is the Xkb equivalent of the core
XRefreshKeyboardMapping
function. It requests that the X server send the current key mapping information to
this client. A client usually invokes
XkbRefreshKeyboardMapping
after receiving an XkbMapNotify event.
XkbRefreshKeyboardMapping
returns Success if it succeeds and BadMatch if the event is not an Xkb event.
The XkbMapNotify event can be generated when some client calls
XkbSetMap, XkbChangeMap, XkbGetKeyboardByName,
or any of the standard X library functions that change the keyboard mapping or modifier
mapping.
RETURN VALUES
- Success
- The XkbRefreshKeyboardMapping function returns Success when the request that the X server send the current key mapping information to this client is successful.
DIAGNOSTICS
- BadMatch
- A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid