Urwid Reference

• MainLoop and Event Loops
  • MainLoop
    • MainLoop
      • MainLoop.screen
      • MainLoop.event_loop
      • MainLoop.draw_screen()
      • MainLoop.entering_idle()
      • MainLoop.input_filter()
      • MainLoop.process_input()
      • MainLoop.remove_alarm()
      • MainLoop.remove_watch_file()
      • MainLoop.remove_watch_pipe()
      • MainLoop.run()
      • MainLoop.set_alarm_at()
      • MainLoop.set_alarm_in()
      • MainLoop.start()
      • MainLoop.stop()
      • MainLoop.unhandled_input()
      • MainLoop.watch_file()
      • MainLoop.watch_pipe()
      • MainLoop.widget
  • SelectEventLoop
    • SelectEventLoop
      • SelectEventLoop.alarm()
      • SelectEventLoop.enter_idle()
      • SelectEventLoop.remove_alarm()
      • SelectEventLoop.remove_enter_idle()
      • SelectEventLoop.remove_watch_file()
      • SelectEventLoop.run()
      • SelectEventLoop.run_in_executor()
      • SelectEventLoop.watch_file()
  • AsyncioEventLoop
    • AsyncioEventLoop
      • AsyncioEventLoop.alarm()
      • AsyncioEventLoop.enter_idle()
      • AsyncioEventLoop.remove_alarm()
      • AsyncioEventLoop.remove_enter_idle()
      • AsyncioEventLoop.remove_watch_file()
      • AsyncioEventLoop.run()
      • AsyncioEventLoop.run_in_executor()
      • AsyncioEventLoop.watch_file()
  • TrioEventLoop
    • TrioEventLoop
      • TrioEventLoop.alarm()
      • TrioEventLoop.enter_idle()
      • TrioEventLoop.remove_alarm()
      • TrioEventLoop.remove_enter_idle()
      • TrioEventLoop.remove_watch_file()
      • TrioEventLoop.run()
      • TrioEventLoop.run_async()
      • TrioEventLoop.watch_file()
  • GLibEventLoop
    • GLibEventLoop
      • GLibEventLoop.alarm()
      • GLibEventLoop.enter_idle()
      • GLibEventLoop.handle_exit()
      • GLibEventLoop.remove_alarm()
      • GLibEventLoop.remove_enter_idle()
      • GLibEventLoop.remove_watch_file()
      • GLibEventLoop.run()
      • GLibEventLoop.run_in_executor()
      • GLibEventLoop.set_signal_handler()
      • GLibEventLoop.watch_file()
  • TwistedEventLoop
    • TwistedEventLoop
      • TwistedEventLoop.alarm()
      • TwistedEventLoop.enter_idle()
      • TwistedEventLoop.handle_exit()
      • TwistedEventLoop.remove_alarm()
      • TwistedEventLoop.remove_enter_idle()
      • TwistedEventLoop.remove_watch_file()
      • TwistedEventLoop.run()
      • TwistedEventLoop.run_in_executor()
      • TwistedEventLoop.watch_file()
  • TornadoEventLoop
    • TornadoEventLoop
      • TornadoEventLoop.alarm()
      • TornadoEventLoop.enter_idle()
      • TornadoEventLoop.remove_alarm()
      • TornadoEventLoop.remove_enter_idle()
      • TornadoEventLoop.remove_watch_file()
      • TornadoEventLoop.run()
      • TornadoEventLoop.run_in_executor()
      • TornadoEventLoop.watch_file()
  • ZMQEventLoop
    • ZMQEventLoop
      • ZMQEventLoop.alarm()
      • ZMQEventLoop.enter_idle()
      • ZMQEventLoop.remove_alarm()
      • ZMQEventLoop.remove_enter_idle()
      • ZMQEventLoop.remove_watch_file()
      • ZMQEventLoop.remove_watch_queue()
      • ZMQEventLoop.run()
      • ZMQEventLoop.run_in_executor()
      • ZMQEventLoop.watch_file()
      • ZMQEventLoop.watch_queue()
• Widget Classes
  • Widget Base Classes
    • Widget
      • Widget
        • Widget._selectable
        • Widget._sizing
        • Widget._command_map
        • Widget.rows()
        • Widget.get_cursor_coords()
        • Widget.get_pref_col()
        • Widget.move_cursor_to_coords()
        • Widget._emit()
        • Widget._invalidate()
        • Widget.base_widget
        • Widget.focus
        • Widget.focus_position
        • Widget.keypress()
        • Widget.mouse_event()
        • Widget.pack()
        • Widget.render()
        • Widget.selectable()
        • Widget.sizing()
    • WidgetWrap
      • WidgetWrap
    • WidgetDecoration
      • WidgetDecoration
        • WidgetDecoration.base_widget
        • WidgetDecoration.selectable()
        • WidgetDecoration.sizing()
    • WidgetContainerMixin
      • WidgetContainerMixin
        • WidgetContainerMixin.focus
        • WidgetContainerMixin.get_focus_path()
        • WidgetContainerMixin.get_focus_widgets()
        • WidgetContainerMixin.set_focus_path()
  • Basic Widget Classes
    • Text
      • Text
        • Text.attrib
        • Text.get_line_translation()
        • Text.get_text()
        • Text.pack()
        • Text.render()
        • Text.rows()
        • Text.set_align_mode()
        • Text.set_layout()
        • Text.set_text()
        • Text.set_wrap_mode()
        • Text.text
    • Edit
      • Edit
        • Edit.caption
        • Edit.edit_pos
        • Edit.edit_text
        • Edit.get_cursor_coords()
        • Edit.get_edit_text()
        • Edit.get_line_translation()
        • Edit.get_pref_col()
        • Edit.get_text()
        • Edit.insert_text()
        • Edit.insert_text_result()
        • Edit.keypress()
        • Edit.mouse_event()
        • Edit.move_cursor_to_coords()
        • Edit.position_coords()
        • Edit.render()
        • Edit.set_caption()
        • Edit.set_edit_pos()
        • Edit.set_edit_text()
        • Edit.set_mask()
        • Edit.set_text()
        • Edit.valid_char()
    • IntEdit
      • IntEdit
        • IntEdit.keypress()
        • IntEdit.valid_char()
        • IntEdit.value()
    • Button
      • Button
        • Button.get_label()
        • Button.keypress()
        • Button.label
        • Button.mouse_event()
        • Button.pack()
        • Button.set_label()
    • CheckBox
      • CheckBox
        • CheckBox.get_label()
        • CheckBox.get_state()
        • CheckBox.keypress()
        • CheckBox.label
        • CheckBox.mouse_event()
        • CheckBox.pack()
        • CheckBox.set_label()
        • CheckBox.set_state()
        • CheckBox.state
        • CheckBox.toggle_state()
    • RadioButton
      • RadioButton
        • RadioButton.set_state()
        • RadioButton.toggle_state()
    • TreeWidget
      • TreeWidget
        • TreeWidget.first_child()
        • TreeWidget.keypress()
        • TreeWidget.last_child()
        • TreeWidget.mouse_event()
        • TreeWidget.next_inorder()
        • TreeWidget.prev_inorder()
        • TreeWidget.selectable()
        • TreeWidget.update_expanded_icon()
    • Extended Numerical Editing Classes
    • IntegerEdit
      • IntegerEdit
        • IntegerEdit.value()
    • FloatEdit
      • FloatEdit
        • FloatEdit.value()
    • SelectableIcon
      • SelectableIcon
        • SelectableIcon.get_cursor_coords()
        • SelectableIcon.keypress()
        • SelectableIcon.render()
  • Decoration Widget Classes
    • AttrMap
      • AttrMap
        • AttrMap.render()
        • AttrMap.set_attr_map()
        • AttrMap.set_focus_map()
    • Padding
      • Padding
        • Padding.align
        • Padding.get_cursor_coords()
        • Padding.get_pref_col()
        • Padding.keypress()
        • Padding.mouse_event()
        • Padding.move_cursor_to_coords()
        • Padding.pack()
        • Padding.padding_values()
        • Padding.render()
        • Padding.rows()
        • Padding.sizing()
        • Padding.width
    • Filler
      • Filler
        • Filler.body
        • Filler.filler_values()
        • Filler.get_body()
        • Filler.get_cursor_coords()
        • Filler.get_pref_col()
        • Filler.keypress()
        • Filler.mouse_event()
        • Filler.move_cursor_to_coords()
        • Filler.render()
        • Filler.rows()
        • Filler.selectable()
        • Filler.sizing()
    • Divider
      • Divider
        • Divider.Symbols
        • Divider.render()
        • Divider.rows()
    • LineBox
      • LineBox
        • LineBox.focus
    • SolidFill
      • SolidFill
        • SolidFill.render()
    • PopUpLauncher
      • PopUpLauncher
        • PopUpLauncher.create_pop_up()
        • PopUpLauncher.get_pop_up_parameters()
        • PopUpLauncher.render()
    • PopUpTarget
      • PopUpTarget
        • PopUpTarget.keypress()
        • PopUpTarget.mouse_event()
        • PopUpTarget.pack()
        • PopUpTarget.render()
    • WidgetPlaceholder
      • WidgetPlaceholder
    • WidgetDisable
      • WidgetDisable
        • WidgetDisable.pack()
        • WidgetDisable.render()
        • WidgetDisable.selectable()
        • WidgetDisable.sizing()
  • Container Widget Classes
    • Frame
      • Frame
        • Frame.contents
        • Frame.focus
        • Frame.focus_position
        • Frame.frame_top_bottom()
        • Frame.get_cursor_coords()
        • Frame.get_focus()
        • Frame.keypress()
        • Frame.mouse_event()
        • Frame.options()
        • Frame.render()
    • ListBox
      • ListBox
        • ListBox.body
        • ListBox.calculate_visible()
        • ListBox.change_focus()
        • ListBox.contents
        • ListBox.ends_visible()
        • ListBox.focus
        • ListBox.focus_position
        • ListBox.get_cursor_coords()
        • ListBox.get_focus()
        • ListBox.get_focus_offset_inset()
        • ListBox.get_scrollpos()
        • ListBox.keypress()
        • ListBox.make_cursor_visible()
        • ListBox.mouse_event()
        • ListBox.options()
        • ListBox.render()
        • ListBox.require_relative_scroll()
        • ListBox.rows_max()
        • ListBox.set_focus()
        • ListBox.set_focus_valign()
        • ListBox.shift_focus()
        • ListBox.update_pref_col_from_focus()
    • TreeListBox
      • TreeListBox
        • TreeListBox.collapse_focus_parent()
        • TreeListBox.focus_end()
        • TreeListBox.focus_home()
        • TreeListBox.keypress()
        • TreeListBox.move_focus_to_parent()
        • TreeListBox.unhandled_input()
    • Columns
      • Columns
        • Columns.box_columns
        • Columns.column_types
        • Columns.column_widths()
        • Columns.contents
        • Columns.focus
        • Columns.focus_col
        • Columns.focus_position
        • Columns.get_column_sizes()
        • Columns.get_cursor_coords()
        • Columns.get_focus()
        • Columns.get_focus_column()
        • Columns.get_pref_col()
        • Columns.has_flow_type
        • Columns.keypress()
        • Columns.mouse_event()
        • Columns.move_cursor_to_coords()
        • Columns.options()
        • Columns.pack()
        • Columns.render()
        • Columns.rows()
        • Columns.set_focus()
        • Columns.set_focus_column()
        • Columns.sizing()
        • Columns.widget_list
    • Pile
      • Pile
        • Pile.contents
        • Pile.focus
        • Pile.focus_position
        • Pile.get_cursor_coords()
        • Pile.get_focus()
        • Pile.get_item_rows()
        • Pile.get_item_size()
        • Pile.get_pref_col()
        • Pile.get_rows_sizes()
        • Pile.item_types
        • Pile.keypress()
        • Pile.mouse_event()
        • Pile.move_cursor_to_coords()
        • Pile.options()
        • Pile.pack()
        • Pile.render()
        • Pile.sizing()
        • Pile.widget_list
    • GridFlow
      • GridFlow
        • GridFlow.cell_width
        • GridFlow.cells
        • GridFlow.contents
        • GridFlow.focus
        • GridFlow.focus_position
        • GridFlow.generate_display_widget()
        • GridFlow.get_cursor_coords()
        • GridFlow.get_display_widget()
        • GridFlow.get_focus()
        • GridFlow.get_pref_col()
        • GridFlow.keypress()
        • GridFlow.mouse_event()
        • GridFlow.move_cursor_to_coords()
        • GridFlow.options()
        • GridFlow.pack()
        • GridFlow.render()
        • GridFlow.set_focus()
        • GridFlow.sizing()
    • BoxAdapter
      • BoxAdapter
        • BoxAdapter.keypress()
        • BoxAdapter.mouse_event()
        • BoxAdapter.render()
        • BoxAdapter.rows()
        • BoxAdapter.sizing()
    • Overlay
      • Overlay
        • Overlay.calculate_padding_filler()
        • Overlay.contents
        • Overlay.focus
        • Overlay.focus_position
        • Overlay.get_cursor_coords()
        • Overlay.keypress()
        • Overlay.mouse_event()
        • Overlay.options()
        • Overlay.pack()
        • Overlay.render()
        • Overlay.rows()
        • Overlay.selectable()
        • Overlay.set_overlay_parameters()
        • Overlay.sizing()
        • Overlay.top_w_size()
  • Graphic Widget Classes
    • BarGraph
      • BarGraph
        • BarGraph.calculate_bar_widths()
        • BarGraph.calculate_display()
        • BarGraph.hlines_display()
        • BarGraph.render()
        • BarGraph.selectable()
        • BarGraph.set_bar_width()
        • BarGraph.set_data()
        • BarGraph.set_segment_attributes()
        • BarGraph.smooth_display()
    • GraphVScale
      • GraphVScale
        • GraphVScale.render()
        • GraphVScale.selectable()
        • GraphVScale.set_scale()
    • ProgressBar
      • ProgressBar
        • ProgressBar.get_text()
        • ProgressBar.render()
        • ProgressBar.set_completion()
    • BigText
      • BigText
        • BigText.get_text()
        • BigText.pack()
        • BigText.render()
      • get_all_fonts()
    • Terminal
      • Terminal
        • Terminal.change_focus()
        • Terminal.get_cursor_coords()
        • Terminal.keypress()
        • Terminal.render()
        • Terminal.respond()
  • Scroll Widget Classes
    • Scrollable
      • Scrollable
        • Scrollable.get_scrollpos()
        • Scrollable.keypress()
        • Scrollable.mouse_event()
        • Scrollable.render()
        • Scrollable.rows_max()
        • Scrollable.selectable()
        • Scrollable.set_scrollpos()
        • Scrollable.sizing()
    • ScrollBar
      • ScrollBar
        • ScrollBar.Symbols
        • ScrollBar.keypress()
        • ScrollBar.mouse_event()
        • ScrollBar.render()
        • ScrollBar.scrollbar_side
        • ScrollBar.scrollbar_width
        • ScrollBar.scrolling_base_widget
        • ScrollBar.selectable()
        • ScrollBar.sizing()
• Display Modules
  • BaseScreen
    • BaseScreen.clear()
    • BaseScreen.get_cols_rows()
    • BaseScreen.register_palette()
    • BaseScreen.register_palette_entry()
    • BaseScreen.run_wrapper()
    • BaseScreen.start()
  • RAW display
    • Screen
      • Screen.get_cols_rows()
      • Screen.get_input_descriptors()
      • Screen.hook_event_loop()
      • Screen.signal_init()
      • Screen.signal_restore()
      • Screen.unhook_event_loop()
  • Curses display
    • Screen
      • Screen.clear()
      • Screen.draw_screen()
      • Screen.get_cols_rows()
      • Screen.get_input()
      • Screen.set_input_timeouts()
      • Screen.set_mouse_tracking()
  • WEB display
    • Screen
      • Screen.clear()
      • Screen.draw_screen()
      • Screen.get_cols_rows()
      • Screen.get_input()
      • Screen.register_palette()
      • Screen.register_palette_entry()
      • Screen.set_mouse_tracking()
      • Screen.start()
      • Screen.stop()
      • Screen.tty_signal_keys()
  • HTML fragment
    • HtmlGenerator
      • HtmlGenerator.draw_screen()
      • HtmlGenerator.get_cols_rows()
      • HtmlGenerator.get_input()
    • screenshot_init()
    • screenshot_collect()
  • LCD display
    • LCDScreen
      • LCDScreen.get_cols_rows()
    • CFLCDScreen
      • CFLCDScreen.InvalidPacket
      • CFLCDScreen.MoreDataRequired
    • CF635Screen
      • CF635Screen.get_input_descriptors()
      • CF635Screen.get_input_nonblocking()
      • CF635Screen.program_cgram()
      • CF635Screen.set_backlight()
      • CF635Screen.set_cursor_style()
      • CF635Screen.set_lcd_contrast()
      • CF635Screen.set_led_pin()
    • KeyRepeatSimulator
      • KeyRepeatSimulator.next_event()
      • KeyRepeatSimulator.sent_event()
• List Walker Classes
  • ListWalker
    • ListWalker
      • ListWalker.get_focus()
      • ListWalker.get_next()
      • ListWalker.get_prev()
  • List-like List Walkers
    • SimpleFocusListWalker
      • SimpleFocusListWalker.next_position()
      • SimpleFocusListWalker.positions()
      • SimpleFocusListWalker.prev_position()
      • SimpleFocusListWalker.set_focus()
      • SimpleFocusListWalker.set_modified_callback()
    • SimpleListWalker
      • SimpleListWalker.contents
      • SimpleListWalker.next_position()
      • SimpleListWalker.positions()
      • SimpleListWalker.prev_position()
      • SimpleListWalker.set_focus()
      • SimpleListWalker.set_modified_callback()
  • TreeWalker and Nodes
    • TreeWalker
      • TreeWalker.get_focus()
      • TreeWalker.get_next()
      • TreeWalker.get_prev()
    • TreeNode
      • TreeNode.get_widget()
      • TreeNode.load_parent()
    • ParentNode
      • ParentNode.get_child_keys()
      • ParentNode.get_child_node()
      • ParentNode.get_child_widget()
      • ParentNode.get_first_child()
      • ParentNode.get_last_child()
      • ParentNode.has_children()
      • ParentNode.load_child_keys()
      • ParentNode.load_child_node()
      • ParentNode.next_child()
      • ParentNode.prev_child()
      • ParentNode.set_child_node()
• Signal Functions
  • connect_signal()
  • Signals.connect()
  • disconnect_signal_by_key()
  • Signals.disconnect_by_key()
  • disconnect_signal()
  • Signals.disconnect()
  • register_signal()
  • Signals.register()
  • emit_signal()
  • Signals.emit()
• Global Settings
  • set_encoding()
  • get_encoding_mode()
  • supports_unicode()
• Raw Display Attributes
  • AttrSpec
    • AttrSpec.background
    • AttrSpec.colors
    • AttrSpec.get_rgb_values()
• Canvas Classes and Functions
  • Canvas Classes
    • Canvas
      • Canvas.decoded_text
      • Canvas.finalize()
      • Canvas.set_pop_up()
      • Canvas.text
      • Canvas.translate_coords()
    • TextCanvas
      • TextCanvas.cols()
      • TextCanvas.content()
      • TextCanvas.content_delta()
      • TextCanvas.rows()
      • TextCanvas.translated_coords()
    • BlankCanvas
      • BlankCanvas.content()
    • SolidCanvas
      • SolidCanvas.content_delta()
    • CompositeCanvas
      • CompositeCanvas.content()
      • CompositeCanvas.content_delta()
      • CompositeCanvas.fill_attr()
      • CompositeCanvas.fill_attr_apply()
      • CompositeCanvas.overlay()
      • CompositeCanvas.pad_trim_left_right()
      • CompositeCanvas.pad_trim_top_bottom()
      • CompositeCanvas.set_depends()
      • CompositeCanvas.trim()
      • CompositeCanvas.trim_end()
  • CompositeCanvas Builders
    • CanvasCombine()
    • CanvasJoin()
    • CanvasOverlay()
  • CanvasCache
    • CanvasCache
      • CanvasCache.clear()
      • CanvasCache.fetch()
      • CanvasCache.invalidate()
      • CanvasCache.store()
• Text Layout Classes
  • TextLayout
    • TextLayout.layout()
    • TextLayout.supports_align_mode()
    • TextLayout.supports_wrap_mode()
  • StandardTextLayout
    • StandardTextLayout.align_layout()
    • StandardTextLayout.calculate_text_segments()
    • StandardTextLayout.layout()
    • StandardTextLayout.pack()
    • StandardTextLayout.supports_align_mode()
    • StandardTextLayout.supports_wrap_mode()
• Command Map
  • CommandMap
    • CommandMap.copy()
• Constants
  • Widget Sizing Methods
    • FLOW
    • BOX
    • FIXED
  • Horizontal Alignment
    • LEFT
    • CENTER
    • RIGHT
  • Veritcal Alignment
    • TOP
    • MIDDLE
    • BOTTOM
  • Width and Height Settings
    • PACK
    • GIVEN
    • RELATIVE
    • RELATIVE_100
    • WEIGHT
  • Text Wrapping Modes
    • SPACE
    • ANY
    • CLIP
    • ELLIPSIS
  • Foreground and Background Colors
    • Standard background and foreground colors
      • BLACK
      • DARK_RED
      • DARK_GREEN
      • BROWN
      • DARK_BLUE
      • DARK_MAGENTA
      • DARK_CYAN
      • LIGHT_GRAY
    • Standard foreground colors (not safe to use as background)
      • DARK_GRAY
      • LIGHT_RED
      • LIGHT_GREEN
      • YELLOW
      • LIGHT_BLUE
      • LIGHT_MAGENTA
      • LIGHT_CYAN
      • WHITE
    • User’s terminal configuration default foreground or background
      • DEFAULT
    • 256 and 88 Color Foregrounds and Backgrounds
  • Signal Names
    • UPDATE_PALETTE_ENTRY
    • INPUT_DESCRIPTORS_CHANGED
  • Command Names
    • REDRAW_SCREEN
    • ACTIVATE
    • CURSOR_UP
    • CURSOR_DOWN
    • CURSOR_LEFT
    • CURSOR_RIGHT
    • CURSOR_PAGE_UP
    • CURSOR_PAGE_DOWN
    • CURSOR_MAX_LEFT
    • CURSOR_MAX_RIGHT
• Exceptions
  • ExitMainLoop
  • WidgetError
  • ListBoxError
  • ColumnsError
  • PileError
  • GridFlowError
  • BoxAdapterError
  • OverlayError
  • TextError
  • EditError
  • CanvasError
• Metaclasses
  • WidgetMeta
  • MetaSuper
  • MetaSignals
• Deprecated Classes
  • FlowWidget
    • FlowWidget.render()
    • FlowWidget.rows()
  • BoxWidget
    • BoxWidget.render()
  • FixedWidget
    • FixedWidget.pack()
    • FixedWidget.render()
  • AttrWrap
    • AttrWrap.set_attr()
    • AttrWrap.set_focus_attr()
    • AttrWrap.sizing()
    • AttrWrap.w