lv_keyboard.h

lv_keyboard_set_textarea

Assign a text area to the keyboard. Pressed characters will be inserted there.

void lv_keyboard_set_textarea(lv_obj_t *obj, lv_obj_t *ta)

lv_keyboard_set_mode

Set a new mode (e.g., text, number, special characters).

void lv_keyboard_set_mode(lv_obj_t *obj, lv_keyboard_mode_t mode)

lv_keyboard_set_popovers

Enable or disable popovers showing button titles on press.

void lv_keyboard_set_popovers(lv_obj_t *obj, bool en)

lv_keyboard_set_map

Set a custom button map for the keyboard.

void lv_keyboard_set_map(lv_obj_t *obj, lv_keyboard_mode_t mode, const char *const map[], const lv_buttonmatrix_ctrl_t ctrl_map[])

lv_keyboard_get_textarea

Get the text area currently assigned to the keyboard.

lv_obj_t * lv_keyboard_get_textarea(const lv_obj_t *obj)

Returns: lv_obj_t * — pointer to the assigned text area object

lv_keyboard_get_mode

Get the current mode of the keyboard.

lv_keyboard_mode_t lv_keyboard_get_mode(const lv_obj_t *obj)

Returns: lv_keyboard_mode_t — the current mode (see 'lv_keyboard_mode_t')

lv_keyboard_get_popovers

Check whether popovers are enabled on the keyboard.

bool lv_keyboard_get_popovers(const lv_obj_t *obj)

Returns: bool — true if popovers are enabled; false otherwise

lv_keyboard_get_map_array

Get the current button map of the keyboard.

const char *const  * lv_keyboard_get_map_array(const lv_obj_t *kb)

Returns: const char *const * — pointer to the map array

lv_keyboard_get_selected_button

Get the index of the last selected button (pressed, released, focused, etc.). Useful in the event_cb to retrieve button text or properties.

uint32_t lv_keyboard_get_selected_button(const lv_obj_t *obj)

Returns: uint32_t — index of the last interacted button returns LV_BUTTONMATRIX_BUTTON_NONE if not set

lv_keyboard_get_button_text

Get the text of a button by index.

const char * lv_keyboard_get_button_text(const lv_obj_t *obj, uint32_t btn_id)

Returns: const char * — pointer to the text of the button

lv_keyboard_create

Create a Keyboard object

lv_obj_t * lv_keyboard_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created keyboard object

lv_keyboard_def_event_cb

Default keyboard event callback to handle button presses. Adds characters to the text area and switches map if needed. If a custom event_cb is used, this function can be called within it.

void lv_keyboard_def_event_cb(lv_event_t *e)