gi-keybinder-0.3.3: Libkeybinder bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Keybinder.Functions

Description

 
Synopsis

Methods

bind

bind Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

keystring: an accelerator description (gtk_accelerator_parse() format)

-> Handler

handler: callback function

-> m Bool

Returns: True if the accelerator could be grabbed

Grab a key combination globally and register a callback to be called each time the key combination is pressed.

Since: 0.3.0

getCurrentEventTime

getCurrentEventTime Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Word32

Returns: the current event timestamp

No description available in the introspection data.

init

init :: (HasCallStack, MonadIO m) => m () Source #

Initialize the keybinder library.

This function must be called after initializing GTK, before calling any other function in the library. Can only be called once.

setUseCookedAccelerators

setUseCookedAccelerators Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Bool

useCooked: if False disable cooked accelerators

-> m () 

"Cooked" accelerators use symbols produced by using modifiers such as shift or altgr, for example if "!" is produced by "Shift+1".

If cooked accelerators are enabled, use "<Ctrl>exclam" to bind "Ctrl+!" If disabled, use "<Ctrl><Shift>1" to bind "Ctrl+Shift+1". These two examples are not equal on all keymaps.

The cooked accelerator keyvalue and modifiers are provided by the function gdk_keymap_translate_keyboard_state()

Cooked accelerators are useful if you receive keystrokes from GTK to bind, but raw accelerators can be useful if you or the user inputs accelerators as text.

Default: Enabled. Should be set before binding anything.

supported

supported Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Bool

Returns: TRUE if keybindings are supported

No description available in the introspection data.

unbind

unbind Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

keystring: an accelerator description (gtk_accelerator_parse() format)

-> m () 

Unregister all previously bound callbacks for this keystring.

Since: 0.3.0