Function input_sys::libinput_device_config_scroll_get_button_lock[][src]

pub unsafe extern "C" fn libinput_device_config_scroll_get_button_lock(
    device: *mut libinput_device
) -> libinput_config_scroll_button_lock_state
Expand description

@ingroup config

Get the current scroll button lock state.

If @ref LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN scroll method is not supported, or no button is set, this function returns @ref LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_DISABLED.

@note The return value is independent of the currently selected scroll-method. For the scroll button lock to activate, a device must have the @ref LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN method enabled, and a non-zero button set as scroll button.

@param device The device to configure @return The scroll button lock state

@see libinput_device_config_scroll_set_button @see libinput_device_config_scroll_set_button_lock @see libinput_device_config_scroll_get_button_lock @see libinput_device_config_scroll_get_default_button_lock