30.18 On-Screen Keyboards

An on-screen keyboard is a special kind of pop up provided by the system, with rows of clickable buttons that act as a real keyboard.

On certain systems (see On-Screen Keyboards in The Emacs Manual), Emacs is supposed to display and hide the on screen keyboard depending on whether or not the user is about to type something.

Function: frame-toggle-on-screen-keyboard frame hide ¶

This function displays or hides the on-screen keyboard on behalf of the frame frame. If hide is non-nil, then the on-screen keyboard is hidden; otherwise, it is displayed.

It returns whether or not the on screen keyboard may have been displayed, which should be used to determine whether or not to hide the on-screen keyboard later.

This has no effect if the system automatically detects when to display the on-screen keyboard, or when it does not provide any on-screen keyboard.