Urwid Reference¶
- MainLoop and Event Loops
- MainLoop
MainLoopMainLoop.screenMainLoop.event_loopMainLoop.draw_screen()MainLoop.entering_idle()MainLoop.input_filter()MainLoop.paused()MainLoop.pop_upsMainLoop.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
- AsyncioEventLoop
- TrioEventLoop
- GLibEventLoop
- TwistedEventLoop
- TornadoEventLoop
- ZMQEventLoop
- MainLoop
- Widget Classes
- Widget Base Classes
- Widget
WidgetWidget._selectableWidget._sizingWidget._command_mapWidget.rows()Widget.get_cursor_coords()Widget.get_pref_col()Widget.move_cursor_to_coords()Widget._emit()Widget._invalidate()Widget.base_widgetWidget.focusWidget.focus_positionWidget.keypress()Widget.mouse_event()Widget.pack()Widget.render()Widget.selectable()Widget.sizing()
- WidgetWrap
- WidgetDecoration
- WidgetContainerMixin
- SelectNavigationMixin
SelectNavigationMixinSelectNavigationMixin._select_candidates()SelectNavigationMixin._select_enter_focus()SelectNavigationMixin._select_keypress_unhandled()SelectNavigationMixin.enter_selectable()SelectNavigationMixin.focus_first_selectable()SelectNavigationMixin.focus_last_selectable()SelectNavigationMixin.select_navigation
- SelectNavigationListContentsMixin
- Widget
- Basic Widget Classes
- Text
- Edit
EditEdit.attribEdit.captionEdit.edit_posEdit.edit_textEdit.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.layoutEdit.max_lengthEdit.mouse_event()Edit.move_cursor_to_coords()Edit.position_coords()Edit.render()Edit.selectable()Edit.set_align_mode()Edit.set_caption()Edit.set_edit_pos()Edit.set_edit_text()Edit.set_layout()Edit.set_mask()Edit.set_wrap_mode()Edit.sizing()Edit.textEdit.valid_char()
- IntEdit
- TreeWidget
TreeWidgetTreeWidget.collapse()TreeWidget.expand()TreeWidget.first_child()TreeWidget.get_display_text()TreeWidget.get_indent_cols()TreeWidget.get_indented_widget()TreeWidget.get_inner_widget()TreeWidget.get_node()TreeWidget.is_initially_expanded()TreeWidget.keypress()TreeWidget.last_child()TreeWidget.load_inner_widget()TreeWidget.mouse_event()TreeWidget.next_inorder()TreeWidget.prev_inorder()TreeWidget.selectable()TreeWidget.toggle_expanded()TreeWidget.update_expanded_icon()
- Extended Numerical Editing Classes
- IntegerEdit
- FloatEdit
- Control Widget Classes
- Special cases text widgets
- Decoration Widget Classes
- Pop-up Widget Classes
- Special Widget Classes
- WidgetDisable
WidgetDisableWidgetDisable.disabledWidgetDisable.enter_selectable()WidgetDisable.get_cursor_coordsWidgetDisable.get_pref_colWidgetDisable.keypress()WidgetDisable.mouse_event()WidgetDisable.move_cursor_to_coordsWidgetDisable.pack()WidgetDisable.render()WidgetDisable.rows()WidgetDisable.selectable()WidgetDisable.sizing()
- WidgetPlaceholder
- WidgetDisable
- Container Widget Classes
- Frame
- ListBox
ListBoxListBox.bodyListBox.calculate_visible()ListBox.change_focus()ListBox.contentsListBox.ends_visible()ListBox.focusListBox.focus_next_match()ListBox.focus_positionListBox.get_cursor_coords()ListBox.get_first_visible_pos()ListBox.get_focus_offset_inset()ListBox.get_scrollpos()ListBox.get_visible_amount()ListBox.keypress()ListBox.make_cursor_visible()ListBox.mouse_event()ListBox.options()ListBox.render()ListBox.require_relative_scroll()ListBox.rows()ListBox.rows_max()ListBox.scroll_to_bottom()ListBox.scroll_to_top()ListBox.selectable()ListBox.set_focus()ListBox.set_focus_valign()ListBox.shift_focus()ListBox.update_pref_col_from_focus()
- TreeListBox
TreeListBoxTreeListBox.collapse_focus_parent()TreeListBox.focus_end()TreeListBox.focus_first_child()TreeListBox.focus_home()TreeListBox.focus_last_child()TreeListBox.focus_next_sibling()TreeListBox.focus_prev_sibling()TreeListBox.keypress()TreeListBox.move_focus_to_parent()TreeListBox.unhandled_input()
- Columns
ColumnsColumns.column_widths()Columns.contentsColumns.focusColumns.focus_positionColumns.get_column_sizes()Columns.get_cursor_coords()Columns.get_pref_col()Columns.keypress()Columns.mouse_event()Columns.move_cursor_to_coords()Columns.options()Columns.pack()Columns.render()Columns.rows()Columns.selectable()Columns.sizing()
- Pile
PilePile.contentsPile.focusPile.focus_positionPile.get_cursor_coords()Pile.get_item_rows()Pile.get_item_size()Pile.get_pref_col()Pile.get_rows_sizes()Pile.keypress()Pile.mouse_event()Pile.move_cursor_to_coords()Pile.options()Pile.pack()Pile.render()Pile.rows()Pile.selectable()Pile.sizing()
- GridFlow
GridFlowGridFlow.base_widgetGridFlow.cell_widthGridFlow.contentsGridFlow.enter_selectable()GridFlow.focusGridFlow.focus_positionGridFlow.generate_display_widget()GridFlow.get_cursor_coords()GridFlow.get_display_widget()GridFlow.get_pref_col()GridFlow.keypress()GridFlow.mouse_event()GridFlow.move_cursor_to_coords()GridFlow.options()GridFlow.pack()GridFlow.render()GridFlow.rows()GridFlow.selectable()GridFlow.sizing()
- BoxAdapter
- Overlay
OverlayOverlay.alignOverlay.bottom_wOverlay.calculate_padding_filler()Overlay.contentsOverlay.focusOverlay.focus_positionOverlay.get_cursor_coords()Overlay.heightOverlay.keypress()Overlay.mouse_event()Overlay.options()Overlay.pack()Overlay.render()Overlay.rows()Overlay.selectable()Overlay.set_overlay_parameters()Overlay.sizing()Overlay.top_wOverlay.top_w_size()Overlay.valignOverlay.width
- Graphic Widget Classes
- BarGraph
- GraphVScale
- ProgressBar
- BigText
- Terminal
TerminalTerminal.add_watch()Terminal.beep()Terminal.change_focus()Terminal.feed()Terminal.flush_responses()Terminal.get_cursor_coords()Terminal.keypress()Terminal.leds()Terminal.mouse_event()Terminal.remove_watch()Terminal.render()Terminal.respond()Terminal.set_termsize()Terminal.set_title()Terminal.spawn()Terminal.terminate()Terminal.touch_term()Terminal.wait_and_feed()
- Scroll Widget Classes
- Scrollable
- ScrollBar
ScrollBarScrollbarSymbolsScrollbarSymbols.ARROW_ASCII_DOWNScrollbarSymbols.ARROW_ASCII_UPScrollbarSymbols.ARROW_DOWNScrollbarSymbols.ARROW_SMALL_TRIANGLE_DOWNScrollbarSymbols.ARROW_SMALL_TRIANGLE_UPScrollbarSymbols.ARROW_TRIANGLE_DOWNScrollbarSymbols.ARROW_TRIANGLE_UPScrollbarSymbols.ARROW_UPScrollbarSymbols.ARROW_WHITE_TRIANGLE_DOWNScrollbarSymbols.ARROW_WHITE_TRIANGLE_UPScrollbarSymbols.BLACK_VERTICAL_RECTANGLEScrollbarSymbols.DARK_SHADEScrollbarSymbols.DRAWING_DOUBLEScrollbarSymbols.DRAWING_HEAVYScrollbarSymbols.DRAWING_HEAVY_2_DASHScrollbarSymbols.DRAWING_HEAVY_3_DASHScrollbarSymbols.DRAWING_HEAVY_4_DASHScrollbarSymbols.DRAWING_LIGHTScrollbarSymbols.DRAWING_LIGHT_2_DASHScrollbarSymbols.DRAWING_LIGHT_3_DASHScrollbarSymbols.DRAWING_LIGHT_4_DASHScrollbarSymbols.FULL_BLOCKScrollbarSymbols.LITE_SHADEScrollbarSymbols.MEDIUM_SHADEScrollbarSymbols.MIDDLE_DOT
- Widget Base Classes
- Display Modules
- List Walker Classes
- ListWalker
- List-like List Walkers
- Deque-like List Walkers
- TreeWalker and Nodes
TreeWalkerTreeNodeParentNodeParentNode.change_child_key()ParentNode.get_child_index()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
- Global Settings
- Raw Display Attributes
AttrSpecAttrSpec.backgroundAttrSpec.background_basicAttrSpec.background_highAttrSpec.background_inheritAttrSpec.background_numberAttrSpec.background_trueAttrSpec.blinkAttrSpec.boldAttrSpec.colorsAttrSpec.copy_modified()AttrSpec.faintAttrSpec.foregroundAttrSpec.foreground_basicAttrSpec.foreground_highAttrSpec.foreground_inheritAttrSpec.foreground_numberAttrSpec.foreground_trueAttrSpec.get_rgb_values()AttrSpec.hyperlinkAttrSpec.italicsAttrSpec.layered_over()AttrSpec.standoutAttrSpec.strikethroughAttrSpec.style_only()AttrSpec.underline
HyperlinkNO_HYPERLINKLayeredAttr
- Canvas Classes and Functions
- Canvas Classes
CanvasCanvas.cols()Canvas.content()Canvas.cursorCanvas.decoded_textCanvas.finalize()Canvas.get_cursor()Canvas.get_pop_up()Canvas.get_pop_up_anchor_height()Canvas.get_pop_up_unhandled_key()Canvas.rows()Canvas.set_cursor()Canvas.set_pop_up()Canvas.textCanvas.translate_coords()Canvas.widget_info
TextCanvasBlankCanvasSolidCanvasCompositeCanvasCompositeCanvas.cols()CompositeCanvas.content()CompositeCanvas.fill_attr()CompositeCanvas.fill_attr_apply()CompositeCanvas.overlay()CompositeCanvas.pad_trim_left_right()CompositeCanvas.pad_trim_top_bottom()CompositeCanvas.rows()CompositeCanvas.set_depends()CompositeCanvas.trim()CompositeCanvas.trim_end()
- CompositeCanvas Builders
- CanvasCache
- Canvas Classes
- Testing Helpers
- Text Layout Classes
- Command Map
- Constants
- Widget Sizing Methods
- Horizontal Alignment
- Veritcal Alignment
- Width and Height Settings
- Text Wrapping Modes
- Foreground and Background Colors
- Signal Names
- Command Names
- Exceptions
- Metaclasses
- Deprecated Classes
- Deprecated Import Paths
- Deprecated Extension Points
