mirror
/
micropython-micro-gui
kopia lustrzana https://github.com/peterhinch/micropython-micro-gui
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

README.md Add note on icon fonts.

pull/8/head
Peter Hinch 2021-09-14 07:28:07 +01:00
rodzic 9761fbe50c
commit a9fd3492b9
1 zmienionych plików z 7 dodań i 3 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

10
README.md
Wyświetl plik

@ -2,7 +2,7 @@
This is a lightweight, portable, MicroPython GUI library for displays having This is a lightweight, portable, MicroPython GUI library for displays having
drivers subclassed from `framebuf`. Written in Python it runs under a standard drivers subclassed from `framebuf`. Written in Python it runs under a standard
MicroPython firmware build. Options for data input comprise MicroPython firmware build. Options for data input comprise:
* Via from two to five pushbuttons depending on the application. * Via from two to five pushbuttons depending on the application.
* Via a switch-based navigation joystick. * Via a switch-based navigation joystick.
* Via two pushbuttons and a rotary encoder such as * Via two pushbuttons and a rotary encoder such as
@ -140,7 +140,9 @@ graphics primitives rather than icons. This makes them efficiently scalable and
minimises RAM usage compared to icon-based graphics. It also facilitates the minimises RAM usage compared to icon-based graphics. It also facilitates the
provision of extra visual information. For example the color of all or part of provision of extra visual information. For example the color of all or part of
a widget may be changed programmatically, for example to highlight an overrange a widget may be changed programmatically, for example to highlight an overrange
condition. condition. There is limited support for
[icons](https://github.com/peterhinch/micropython-font-to-py/blob/master/writer/WRITER.md#3-icons)
in pushbuttons via icon fonts.
The following, taken from `gui.demos.simple.py`, is a complete application. It The following, taken from `gui.demos.simple.py`, is a complete application. It
shows a message and has "Yes" and "No" buttons which trigger a callback. shows a message and has "Yes" and "No" buttons which trigger a callback.
@ -1099,7 +1101,9 @@ Optional keyword only arguments:
* `textcolor=None` Text color. Defaults to `fgcolor`. * `textcolor=None` Text color. Defaults to `fgcolor`.
* `litcolor=None` If provided the button will display this color for one * `litcolor=None` If provided the button will display this color for one
second after being pressed. second after being pressed.
* `text=''` Shown in centre of button. * `text=''` Shown in centre of button. It is possible to show simple
[icons](https://github.com/peterhinch/micropython-font-to-py/blob/master/writer/WRITER.md#3-icons),
for example media playback symbols.
* `callback=dolittle` Callback function which runs when button is pressed. * `callback=dolittle` Callback function which runs when button is pressed.
* `args=()` A list/tuple of arguments for the above callback. * `args=()` A list/tuple of arguments for the above callback.
* `onrelease=False` If `True` the callback will occur when the `select` * `onrelease=False` If `True` the callback will occur when the `select`