Package: gdk

Function gdk:toplevel-inhibit-system-shortcuts

Lambda List

gdk:toplevel-inhibit-system-shortcuts (toplevel event)

Arguments

toplevel -- a gdk:toplevel object requesting system keyboard shortcuts
event -- a gdk:event instance that is triggering the inhibit request, or nil if none is available

Details

Requests that the toplevel inhibit the system shortcuts, asking the desktop environment/windowing system to let all keyboard events reach the surface, as long as it is focused, instead of triggering system actions.

If granted, the rerouting remains active until the default shortcuts processing is restored with the gdk:toplevel-restore-system-shortcuts function, or the request is revoked by the desktop environment, windowing system or the user.

A typical use case for this API is remote desktop or virtual machine viewers which need to inhibit the default system keyboard shortcuts so that the remote session or virtual host gets those instead of the local environment.

The windowing system or desktop environment may ask the user to grant or deny the request or even choose to ignore the request entirely.

The caller can be notified whenever the request is granted or revoked by listening to the shortcuts-inhibited property.
 

See also

#2023-8-1