.. _gfx_ui-module:

ui
==

.. warning:: The UI module is in alpha version. Some things might change over time.

The ui module contains the classes to easily build full screen Terminal User Interface
(TUI) for your games (or applications).

.. important:: It works exclusively with the screen buffer system (place, delete,
   render, update, etc.).
   It doesn't work with Screen functions tagged "direct display" like display_at().

.. toctree::

    pygamelib.gfx.ui.Box.rst
    pygamelib.gfx.ui.BoxLayout
    pygamelib.gfx.ui.ColorPickerDialog.rst
    pygamelib.gfx.ui.ColorPicker.rst
    pygamelib.gfx.ui.Cursor
    pygamelib.gfx.ui.Dialog.rst
    pygamelib.gfx.ui.FileDialog.rst
    pygamelib.gfx.ui.FormLayout
    pygamelib.gfx.ui.GridLayout
    pygamelib.gfx.ui.GridSelectorDialog.rst
    pygamelib.gfx.ui.GridSelector.rst
    pygamelib.gfx.ui.Layout
    pygamelib.gfx.ui.LineInput
    pygamelib.gfx.ui.LineInputDialog.rst
    pygamelib.gfx.ui.Menu
    pygamelib.gfx.ui.MenuAction
    pygamelib.gfx.ui.MenuBar
    pygamelib.gfx.ui.MessageDialog.rst
    pygamelib.gfx.ui.MultiLineInputDialog.rst
    pygamelib.gfx.ui.ProgressBar.rst
    pygamelib.gfx.ui.ProgressDialog.rst
    pygamelib.gfx.ui.UiConfig.rst
    pygamelib.gfx.ui.Widget


.. automodule:: pygamelib.gfx.ui
    :noindex: