keyboard.h File Reference

#include <libbase/libbase.h>
#include <libbase/plist.h>
#include <stdint.h>
#include "manager.h"
#include "toolkit/toolkit.h"

Include dependency graph for keyboard.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	wlmim_keyboard_options

Typedefs
typedef struct _wlmim_keyboard_t	wlmim_keyboard_t
typedef struct _wlmtk_element_t	wlmtk_element_t

Functions
wlmim_keyboard_t *	wlmim_keyboard_create (wlmim_t *input_manager_ptr, struct xkb_keymap *xkb_keymap_ptr, const struct wlmim_keyboard_options *options_ptr, struct wlr_keyboard *wlr_keyboard_ptr, struct wlr_seat *wlr_seat_ptr, wlmtk_element_t *root_element_ptr)
void	wlmim_keyboard_destroy (wlmim_keyboard_t *keyboard_ptr)
void	wlmim_keyboard_configure (wlmim_keyboard_t *keyboard_ptr, struct xkb_keymap *xkb_keymap_ptr, const struct wlmim_keyboard_options *options_ptr)
struct xkb_keymap *	wlmim_keyboard_xkb_from_config (bspl_dict_t *dict_ptr)

Variables
const bspl_enum_desc_t	wlmim_keyboard_modifiers []
const bspl_desc_t	wlmim_keyboard_options_desc []
const bs_test_set_t	wlmim_keyboard_test_set

Detailed Description

Copyright

Copyright (c) 2026 Philipp Kaeser (kaese.nosp@m.r@gu.nosp@m.bbe.c.nosp@m.h) Copyright 2023 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Typedef Documentation

wlmim_keyboard_t

typedef struct _wlmim_keyboard_t wlmim_keyboard_t

Type of the keyboard handle.

wlmtk_element_t

typedef struct _wlmtk_element_t wlmtk_element_t

Forward declaration.

Function Documentation

wlmim_keyboard_configure()

void wlmim_keyboard_configure	(	wlmim_keyboard_t *	keyboard_ptr,
		struct xkb_keymap *	xkb_keymap_ptr,
		const struct wlmim_keyboard_options *	options_ptr
	)

Configures the active xkb_keymap and repeat settings.

Parameters

keyboard_ptr
xkb_keymap_ptr
options_ptr

wlmim_keyboard_create()

wlmim_keyboard_t * wlmim_keyboard_create	(	wlmim_t *	input_manager_ptr,
		struct xkb_keymap *	xkb_keymap_ptr,
		const struct wlmim_keyboard_options *	options_ptr,
		struct wlr_keyboard *	wlr_keyboard_ptr,
		struct wlr_seat *	wlr_seat_ptr,
		wlmtk_element_t *	root_element_ptr
	)

Creates a handle for a registered keyboard.

Parameters

input_manager_ptr
xkb_keymap_ptr
options_ptr
wlr_keyboard_ptr
wlr_seat_ptr
root_element_ptr

Returns

The handle or NULL on error. Free via wlmim_keyboard_destroy().

wlmim_keyboard_destroy()

void wlmim_keyboard_destroy

(

wlmim_keyboard_t *

keyboard_ptr

)

Destroys the keyboard handle.

Parameters

keyboard_ptr

wlmim_keyboard_xkb_from_config()

struct xkb_keymap * wlmim_keyboard_xkb_from_config

(

bspl_dict_t *

dict_ptr

)

Creates a struct xkb_keymap from the keyboard configuration dict.

Parameters

dict_ptr

Plist dict of the Keyboard configuration. If NULL, NULL is returned.

Returns

Pointer to a created struct xkb_keymap (to be released by calling xkb_keymap_unref()), or NULL on error.

Variable Documentation

wlmim_keyboard_modifiers

const bspl_enum_desc_t wlmim_keyboard_modifiers[]

extern

Keyboard modifiers, as enum to lookup.

wlmim_keyboard_options_desc

const bspl_desc_t wlmim_keyboard_options_desc[]

extern

BSPL descriptor for decoding the keyboard dict.

wlmim_keyboard_test_set

const bs_test_set_t wlmim_keyboard_test_set

extern

Unit test set.