####################
UI element reference
####################

UI elements are used in applications and some core system functions to interace with the user. For example, the Menu element is used for making menus, and can as well be used to show lists of items.

Using UI elements in your applications is as easy as doing:

``from zpui_lib.ui import ElementName``

and initialising them, passing your UI element contents and parameters, as well as input and output device objects as initialisation arguments.

.. warning::

  There are more UI elements and helper functions than this, but they may don't appear here
  because they haven't been documented yet.
  You can find about them in the ``zpui_lib`` code, and find usage examples
  within the ZPUI codebase.

UI elements:

   * :ref:`ui_canvas`
   * :ref:`ui_menu`
   * :ref:`ui_printer`
   * :ref:`ui_listbox`
   * :ref:`ui_path_picker`
   * :ref:`ui_checkbox`
   * :ref:`ui_dialogbox`
   * :ref:`ui_refresher`
   * :ref:`ui_number_input`
   * :ref:`ui_char_input`
   * :ref:`ui_utils`

More about UI elements:

  * :ref:`ui_internals`

.. toctree::
   :maxdepth: 1
   :hidden:

   ui/canvas.rst
   ui/menu.rst
   ui/printer.rst
   ui/listbox.rst
   ui/path_picker.rst
   ui/checkbox.rst
   ui/dialogbox.rst
   ui/refresher.rst
   ui/number_input.rst
   ui/char_input.rst
   ui/utils.rst
   ui_internals.rst