docs: fix links, add references, rename files (#5138)
This commit is contained in:
@@ -1,12 +1,17 @@
|
||||
.. _lv_keyboard:
|
||||
|
||||
======================
|
||||
Keyboard (lv_keyboard)
|
||||
======================
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
The Keyboard object is a special `Button matrix </widgets/buttonmatrix>`__
|
||||
The Keyboard object is a special :ref:`Button matrix <lv_buttonmatrix>`
|
||||
with predefined keymaps and other features to realize a virtual keyboard
|
||||
to write texts into a `Text area </widgets/textarea>`__.
|
||||
to write texts into a :ref:`Text area <lv_textarea>`.
|
||||
|
||||
.. _lv_keyboard_parts_and_styles:
|
||||
|
||||
Parts and Styles
|
||||
****************
|
||||
@@ -16,6 +21,8 @@ Similarly to Button matrices Keyboards consist of 2 part:
|
||||
- :cpp:enumerator:`LV_PART_MAIN` The main part. Uses all the typical background properties
|
||||
- :cpp:enumerator:`LV_PART_ITEMS` The buttons. Also uses all typical background properties as well as the *text* properties.
|
||||
|
||||
.. _lv_keyboard_usage:
|
||||
|
||||
Usage
|
||||
*****
|
||||
|
||||
@@ -38,7 +45,7 @@ default mode is :cpp:enumerator:`LV_KEYBOARD_MODE_TEXT_UPPER`.
|
||||
Assign Text area
|
||||
----------------
|
||||
|
||||
You can assign a `Text area </widgets/textarea>`__ to the Keyboard to
|
||||
You can assign a :ref:`Text area <lv_textarea>` to the Keyboard to
|
||||
automatically put the clicked characters there. To assign the text area,
|
||||
use :cpp:expr:`lv_keyboard_set_textarea(kb, ta)`.
|
||||
|
||||
@@ -65,7 +72,7 @@ New Keymap
|
||||
|
||||
You can specify a new map (layout) for the keyboard with
|
||||
:cpp:expr:`lv_keyboard_set_map(kb, LV_KEYBOARD_MODE_..., kb_map, kb_ctrl)`. See
|
||||
the `Button matrix </widgets/buttonmatrix>`__ for more information about
|
||||
the :ref:`Button matrix <lv_buttonmatrix>` for more information about
|
||||
creating new maps and ctrls.
|
||||
|
||||
Keep in mind that using following keywords will have the same effect as
|
||||
@@ -81,6 +88,8 @@ with the original map:
|
||||
- *"abc"* Load the lower case map.
|
||||
- *"1#"* Load the lower case map.
|
||||
|
||||
.. _lv_keyboard_events:
|
||||
|
||||
Events
|
||||
******
|
||||
|
||||
@@ -101,6 +110,8 @@ with a custom event handler if you wish.
|
||||
|
||||
Learn more about :ref:`events`.
|
||||
|
||||
.. _lv_keyboard_keys:
|
||||
|
||||
Keys
|
||||
****
|
||||
|
||||
@@ -110,10 +121,14 @@ Keys
|
||||
|
||||
Learn more about :ref:`indev_keys`.
|
||||
|
||||
Examples
|
||||
********
|
||||
.. _lv_keyboard_example:
|
||||
|
||||
Example
|
||||
*******
|
||||
|
||||
.. include:: ../examples/widgets/keyboard/index.rst
|
||||
|
||||
.. _lv_keyboard_api:
|
||||
|
||||
API
|
||||
***
|
||||
|
||||
Reference in New Issue
Block a user