Skip to content

Possible typo in the documentation of the struct KeyboardHandle #1018

@Geostartico

Description

@Geostartico

As title, i think there is a typo in the documentation, in the documentation for the KeyboardHandle::input function there is the following paragraph:

The filter argument is expected to be a closure which will peek at the generated input as interpreted by the keymap before it is forwarded to the focused client. If this closure returns FilterResult::Forward, the input will not be sent to the client. If it returns FilterResult::Intercept a value can be passed to be returned by the whole function. This mechanism can be used to implement compositor-level key bindings for example.

It seemed just counterintuitive naming but i checked the docs for Smithay::input::keyboard::FilterResult it says:

Forward
Forward the given keycode to the client
Intercept(T)
Do not forward and return value

Are the two saying the opposite thing or did i misunderstand something?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions