lv_keyboard.h

API reference for lv_keyboard.h

Summary

Functions

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

void lv_keyboard_set_textarea(lv_obj_t *kb, lv_obj_t *ta)

Name	Type	Description
`kb`	`lv_obj_t *`	pointer to a keyboard object
`ta`	`lv_obj_t *`	pointer to a text area object to write into

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

void lv_keyboard_set_mode(lv_obj_t *kb, lv_keyboard_mode_t mode)

Name	Type	Description
`kb`	`lv_obj_t *`	pointer to a keyboard object
`mode`	`lv_keyboard_mode_t`	the desired mode (see 'lv_keyboard_mode_t')

Enable or disable popovers showing button titles on press.

void lv_keyboard_set_popovers(lv_obj_t *kb, bool en)

Name	Type	Description
`kb`	`lv_obj_t *`	pointer to a keyboard object
`en`	`bool`	true to enable popovers; false to disable

Set a custom button map for the keyboard.

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

Name	Type	Description
`kb`	`lv_obj_t *`	pointer to a keyboard object
`mode`	`lv_keyboard_mode_t`	the mode to assign the new map to (see 'lv_keyboard_mode_t')
`map`	`const char *const`	pointer to a string array describing the button map see '`lv_buttonmatrix_set_map()`' for more details
`ctrl_map`	`const lv_buttonmatrix_ctrl_t`	pointer to the control map. See '`lv_buttonmatrix_set_ctrl_map()`'

Current keyboard mode.

Used by 2 functions

Name	Value
`LV_PROPERTY_KEYBOARD_TEXTAREA`	`(LV_PROPERTY_KEYBOARD_START + ((int) 0 )) \| (( 8 ) << 28 )`
`LV_PROPERTY_KEYBOARD_MODE`	`(LV_PROPERTY_KEYBOARD_START + ((int) 1 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_KEYBOARD_POPOVERS`	`(LV_PROPERTY_KEYBOARD_START + ((int) 2 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_KEYBOARD_SELECTED_BUTTON`	`(LV_PROPERTY_KEYBOARD_START + ((int) 3 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_KEYBOARD_END`

#define LV_KEYBOARD_CTRL_BUTTON_FLAGS (LV_BUTTONMATRIX_CTRL_NO_REPEAT | LV_BUTTONMATRIX_CTRL_CLICK_TRIG | LV_BUTTONMATRIX_CTRL_CHECKED)

const lv_obj_class_t lv_keyboard_class

Indirect dependencies