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().

• Box
  • Box
    • Box.__init__()
    • Box.config
    • Box.height
    • Box.render_to_buffer()
    • Box.title
    • Box.width
• BoxLayout
  • BoxLayout
    • BoxLayout.__init__()
    • BoxLayout.add_widget()
    • BoxLayout.attach()
    • BoxLayout.count()
    • BoxLayout.detach()
    • BoxLayout.handle_notification()
    • BoxLayout.height
    • BoxLayout.notify()
    • BoxLayout.orientation
    • BoxLayout.parent
    • BoxLayout.render_to_buffer()
    • BoxLayout.screen_column
    • BoxLayout.screen_row
    • BoxLayout.size_constraint
    • BoxLayout.spacing
    • BoxLayout.store_screen_position()
    • BoxLayout.widgets()
    • BoxLayout.width
• ColorPickerDialog
  • ColorPickerDialog
    • ColorPickerDialog.__init__()
    • ColorPickerDialog.config
    • ColorPickerDialog.render_to_buffer()
    • ColorPickerDialog.set_color()
    • ColorPickerDialog.set_selection()
    • ColorPickerDialog.show()
    • ColorPickerDialog.title
    • ColorPickerDialog.user_input
• ColorPicker
  • ColorPicker
    • ColorPicker.__init__()
    • ColorPicker.blue
    • ColorPicker.color
    • ColorPicker.green
    • ColorPicker.red
    • ColorPicker.render_to_buffer()
    • ColorPicker.selection
• Cursor
  • Cursor
    • Cursor.__init__()
    • Cursor.attach()
    • Cursor.detach()
    • Cursor.handle_notification()
    • Cursor.lock_position()
    • Cursor.notify()
    • Cursor.parent
    • Cursor.relative_column
    • Cursor.relative_row
    • Cursor.render_to_buffer()
    • Cursor.screen_column
    • Cursor.screen_row
    • Cursor.sprixel
    • Cursor.store_screen_position()
    • Cursor.unlock_position()
• Dialog
  • Dialog
    • Dialog.__init__()
    • Dialog.config
    • Dialog.show()
    • Dialog.user_input
• FileDialog
  • FileDialog
    • FileDialog.__init__()
    • FileDialog.config
    • FileDialog.filter
    • FileDialog.path
    • FileDialog.render_to_buffer()
    • FileDialog.show()
    • FileDialog.show_hidden_files
    • FileDialog.user_input
• FormLayout
  • FormLayout
    • FormLayout.__init__()
    • FormLayout.add_row()
    • FormLayout.add_widget()
    • FormLayout.attach()
    • FormLayout.column_minimum_width
    • FormLayout.count()
    • FormLayout.count_columns()
    • FormLayout.count_rows()
    • FormLayout.detach()
    • FormLayout.handle_notification()
    • FormLayout.height
    • FormLayout.horizontal_spacing
    • FormLayout.notify()
    • FormLayout.parent
    • FormLayout.remove_row()
    • FormLayout.render_to_buffer()
    • FormLayout.row_minimum_height
    • FormLayout.screen_column
    • FormLayout.screen_row
    • FormLayout.spacing
    • FormLayout.store_screen_position()
    • FormLayout.vertical_spacing
    • FormLayout.widgets()
    • FormLayout.width
• GridLayout
  • GridLayout
    • GridLayout.__init__()
    • GridLayout.add_widget()
    • GridLayout.attach()
    • GridLayout.column_minimum_width
    • GridLayout.count()
    • GridLayout.count_columns()
    • GridLayout.count_rows()
    • GridLayout.detach()
    • GridLayout.handle_notification()
    • GridLayout.height
    • GridLayout.horizontal_spacing
    • GridLayout.notify()
    • GridLayout.parent
    • GridLayout.render_to_buffer()
    • GridLayout.row_minimum_height
    • GridLayout.screen_column
    • GridLayout.screen_row
    • GridLayout.spacing
    • GridLayout.store_screen_position()
    • GridLayout.vertical_spacing
    • GridLayout.widgets()
    • GridLayout.width
• GridSelectorDialog
  • GridSelectorDialog
    • GridSelectorDialog.__init__()
    • GridSelectorDialog.config
    • GridSelectorDialog.grid_selector
    • GridSelectorDialog.render_to_buffer()
    • GridSelectorDialog.show()
    • GridSelectorDialog.title
    • GridSelectorDialog.user_input
• GridSelector
  • GridSelector
    • GridSelector.__init__()
    • GridSelector.choices
    • GridSelector.current_choice
    • GridSelector.current_page
    • GridSelector.current_sprixel()
    • GridSelector.cursor_down()
    • GridSelector.cursor_left()
    • GridSelector.cursor_right()
    • GridSelector.cursor_up()
    • GridSelector.items_per_page()
    • GridSelector.max_height
    • GridSelector.max_width
    • GridSelector.nb_pages()
    • GridSelector.page_down()
    • GridSelector.page_up()
    • GridSelector.render_to_buffer()
• Layout
  • Layout
    • Layout.__init__()
    • Layout.add_widget()
    • Layout.attach()
    • Layout.count()
    • Layout.detach()
    • Layout.handle_notification()
    • Layout.height
    • Layout.notify()
    • Layout.parent
    • Layout.render_to_buffer()
    • Layout.screen_column
    • Layout.screen_row
    • Layout.spacing
    • Layout.store_screen_position()
    • Layout.widgets()
    • Layout.width
• LineInput
  • LineInput
    • LineInput.__init__()
    • LineInput.attach()
    • LineInput.backspace()
    • LineInput.bg_color
    • LineInput.children
    • LineInput.clear()
    • LineInput.cursor
    • LineInput.delete()
    • LineInput.detach()
    • LineInput.end()
    • LineInput.filter
    • LineInput.focus
    • LineInput.handle_notification()
    • LineInput.height
    • LineInput.home()
    • LineInput.insert_characters()
    • LineInput.layout
    • LineInput.length()
    • LineInput.maximum_height
    • LineInput.maximum_width
    • LineInput.minimum_height
    • LineInput.minimum_width
    • LineInput.move_cursor()
    • LineInput.notify()
    • LineInput.parent
    • LineInput.redo()
    • LineInput.render_to_buffer()
    • LineInput.screen_column
    • LineInput.screen_row
    • LineInput.size_constraint
    • LineInput.store_screen_position()
    • LineInput.text
    • LineInput.undo()
    • LineInput.width
    • LineInput.x
    • LineInput.y
• LineInputDialog
  • LineInputDialog
    • LineInputDialog.__init__()
    • LineInputDialog.config
    • LineInputDialog.label
    • LineInputDialog.render_to_buffer()
    • LineInputDialog.show()
    • LineInputDialog.title
    • LineInputDialog.user_input
• Menu
  • Menu
    • Menu.__init__()
    • Menu.activate()
    • Menu.add_entry()
    • Menu.collapse()
    • Menu.config
    • Menu.current_entry()
    • Menu.entries
    • Menu.expand()
    • Menu.menu_width()
    • Menu.padding
    • Menu.render_to_buffer()
    • Menu.select_next()
    • Menu.select_previous()
    • Menu.selected
    • Menu.title
    • Menu.title_width()
• MenuAction
  • MenuAction
    • MenuAction.__init__()
    • MenuAction.action
    • MenuAction.activate()
    • MenuAction.config
    • MenuAction.padding
    • MenuAction.render_to_buffer()
    • MenuAction.selected
    • MenuAction.title
    • MenuAction.title_width()
• MenuBar
  • MenuBar
    • MenuBar.__init__()
    • MenuBar.add_entry()
    • MenuBar.close()
    • MenuBar.config
    • MenuBar.current_entry()
    • MenuBar.current_index
    • MenuBar.entries
    • MenuBar.length()
    • MenuBar.render_to_buffer()
    • MenuBar.select_next()
    • MenuBar.select_previous()
    • MenuBar.spacing
• MessageDialog
  • MessageDialog
    • MessageDialog.__init__()
    • MessageDialog.add_line()
    • MessageDialog.config
    • MessageDialog.height
    • MessageDialog.render_to_buffer()
    • MessageDialog.show()
    • MessageDialog.title
    • MessageDialog.user_input
• MultiLineInputDialog
  • MultiLineInputDialog
    • MultiLineInputDialog.__init__()
    • MultiLineInputDialog.config
    • MultiLineInputDialog.fields
    • MultiLineInputDialog.render_to_buffer()
    • MultiLineInputDialog.show()
    • MultiLineInputDialog.title
    • MultiLineInputDialog.user_input
• ProgressBar
  • ProgressBar
    • ProgressBar.__init__()
    • ProgressBar.config
    • ProgressBar.empty_marker
    • ProgressBar.maximum
    • ProgressBar.progress_marker
    • ProgressBar.render_to_buffer()
    • ProgressBar.value
• ProgressDialog
  • ProgressDialog
    • ProgressDialog.__init__()
    • ProgressDialog.config
    • ProgressDialog.label
    • ProgressDialog.maximum
    • ProgressDialog.render_to_buffer()
    • ProgressDialog.show()
    • ProgressDialog.user_input
    • ProgressDialog.value
• UiConfig
  • UiConfig
    • UiConfig.__init__()
    • UiConfig.instance()
• Widget
  • Widget
    • Widget.__init__()
    • Widget.attach()
    • Widget.bg_color
    • Widget.children
    • Widget.detach()
    • Widget.focus
    • Widget.handle_notification()
    • Widget.height
    • Widget.layout
    • Widget.maximum_height
    • Widget.maximum_width
    • Widget.minimum_height
    • Widget.minimum_width
    • Widget.notify()
    • Widget.parent
    • Widget.render_to_buffer()
    • Widget.screen_column
    • Widget.screen_row
    • Widget.size_constraint
    • Widget.store_screen_position()
    • Widget.width
    • Widget.x
    • Widget.y