Function input_sys::libinput_device_config_scroll_get_button[][src]

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

@ingroup config

Get the button for the @ref LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN method for this device.

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

@note The return value is independent of the currently selected scroll-method. For button scrolling 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 button which when pressed switches to sending scroll events

@see libinput_device_config_scroll_get_methods @see libinput_device_config_scroll_set_method @see libinput_device_config_scroll_get_method @see libinput_device_config_scroll_get_default_method @see libinput_device_config_scroll_set_button @see libinput_device_config_scroll_get_default_button