Urwid 0.9.9.1 Reference

MainLoop & event loops

function MainLoop [back to top]

class MainLoop(object) [back to top]

__init__(self, widget, palette=[], screen=None, handle_mouse=True, input_filter=None, unhandled_input=None, event_loop=None)

Simple main loop implementation.
 
widget -- topmost widget used for painting the screen, 
    stored as self.widget, may be modified
palette -- initial palette for screen
screen -- screen object or None to use raw_display.Screen,
    stored as self.screen
handle_mouse -- True to process mouse events, passed to
    self.screen
input_filter -- a function to filter input before sending
    it to self.widget, called from self.input_filter
unhandled_input -- a function called when input is not
    handled by self.widget, called from self.unhandled_input
event_loop -- if screen supports external an event loop it
    may be given here, or leave as None to use 
    SelectEventLoop, stored as self.event_loop
 
This is a standard main loop implementation with a single
screen. 
 
The widget passed must be a box widget.
 
raw_display.Screen is the only screen type that currently
supports external event loops.  Other screen types include
curses_display.Screen, web_display.Screen and
html_fragment.HtmlGenerator.

draw_screen(self)

Renter the widgets and paint the screen.  This function is
called automatically from run() but may be called additional 
times if repainting is required without also processing input.

input_filter(self, keys, raw)

This function is passed each all the input events and raw
keystroke values.  These values are passed to the
input_filter function passed to the constructor.  That
function must return a list of keys to be passed to the
widgets to handle.  If no input_filter was defined this
implementation will return all the input events.
 
input -- keyboard or mouse input

process_input(self, keys)

This function will pass keyboard input and mouse events
to self.widget.  This function is called automatically
from the run() method when there is input, but may also be
called to simulate input from the user.
 
keys -- list of input returned from self.screen.get_input()
 
>>> w = _refl("widget")
>>> w.selectable_rval = True
>>> scr = _refl("screen")
>>> scr.get_cols_rows_rval = (10, 5)
>>> ml = MainLoop(w, [], scr)
>>> ml.process_input(['enter', ('mouse drag', 1, 14, 20)])
screen.get_cols_rows()
widget.selectable()
widget.keypress((10, 5), 'enter')
widget.mouse_event((10, 5), 'mouse drag', 1, 14, 20, focus=True)

remove_alarm(self, handle)

Remove an alarm. 
 
Return True if the handle was found, False otherwise.

run(self)

Start the main loop handling input events and updating 
the screen.  The loop will continue until an ExitMainLoop 
exception is raised.  
 
This function will call screen.run_wrapper() if screen.start() 
has not already been called.
 
>>> w = _refl("widget")   # _refl prints out function calls
>>> w.render_rval = "fake canvas"  # *_rval is used for return values
>>> scr = _refl("screen")
>>> scr.get_input_descriptors_rval = [42]
>>> scr.get_cols_rows_rval = (20, 10)
>>> scr.started = True
>>> evl = _refl("event_loop")
>>> ml = MainLoop(w, [], scr, event_loop=evl)
>>> ml.run()    # doctest:+ELLIPSIS
screen.set_mouse_tracking()
screen.get_cols_rows()
widget.render((20, 10), focus=True)
screen.draw_screen((20, 10), 'fake canvas')
screen.get_input_descriptors()
event_loop.watch_file(42, <bound method ...>)
event_loop.run()
>>> scr.started = False
>>> ml.run()    # doctest:+ELLIPSIS
screen.run_wrapper(<bound method ...>)

set_alarm_at(self, tm, callback, user_data=None)

Schedule at tm time that will call 
callback(main_loop, user_data) from the within the run()
function.
 
Returns a handle that may be passed to remove_alarm()
 
tm -- floating point local time of alarm
callback -- callback(main_loop, user_data) callback function
user_data -- object to pass to callback

set_alarm_in(self, sec, callback, user_data=None)

Schedule an alarm in sec seconds that will call
callback(main_loop, user_data) from the within the run()
function.
 
sec -- floating point seconds until alarm
callback -- callback(main_loop, user_data) callback function
user_data -- object to pass to callback

unhandled_input(self, input)

This function is called with any input that was not handled
by the widgets, and calls the unhandled_input function passed
to the constructor.  If no unhandled_input was defined then
the input will be ignored.
 
input -- keyboard or mouse input

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

function SelectEventLoop [back to top]

class SelectEventLoop(object) [back to top]

__init__(self)

Event loop based on select.select()
 
>>> import os
>>> rd, wr = os.pipe()
>>> evl = SelectEventLoop()
>>> def step1():
...     print "writing"
...     os.write(wr, "hi")
>>> def step2():
...     print os.read(rd, 2)
...     raise ExitMainLoop
>>> handle = evl.alarm(0, step1)
>>> handle = evl.watch_file(rd, step2)
>>> evl.run()
writing
hi

alarm(self, seconds, callback)

Call callback() given time from from now.  No parameters are
passed to callback.
 
Returns a handle that may be passed to remove_alarm()
 
seconds -- floating point time to wait before calling callback
callback -- function to call from event loop

remove_alarm(self, handle)

Remove an alarm.
 
Returns True if the alarm exists, False otherwise
 
>>> evl = SelectEventLoop()
>>> handle = evl.alarm(50, lambda: None)
>>> evl.remove_alarm(handle)
True
>>> evl.remove_alarm(handle)
False

remove_watch_file(self, handle)

Remove an input file.
 
Returns True if the input file exists, False otherwise
 
>>> evl = SelectEventLoop()
>>> handle = evl.watch_file(5, lambda: None)
>>> evl.remove_watch_file(handle)
True
>>> evl.remove_watch_file(handle)
False

run(self)

Start the event loop.  Exit the loop when any callback raises
an exception.  If ExitMainLoop is raised, exit cleanly.
 
>>> import os
>>> rd, wr = os.pipe()
>>> os.write(wr, "data") # something to read from rd
4
>>> evl = SelectEventLoop()
>>> def say_hello():
...     print "hello"
>>> def exit_clean():
...     print "clean exit"
...     raise ExitMainLoop
>>> def exit_error():
...     1/0
>>> handle = evl.alarm(0.0625, exit_clean)
>>> handle = evl.alarm(0, say_hello)
>>> evl.run()
hello
clean exit
>>> handle = evl.watch_file(rd, exit_clean)
>>> evl.run()
clean exit
>>> evl.remove_watch_file(handle)
True
>>> handle = evl.alarm(0, exit_error)
>>> evl.run()
Traceback (most recent call last):
   ...
ZeroDivisionError: integer division or modulo by zero
>>> handle = evl.watch_file(rd, exit_error)
>>> evl.run()
Traceback (most recent call last):
   ...
ZeroDivisionError: integer division or modulo by zero

watch_file(self, fd, callback)

Call callback() when fd has some data to read.  No parameters
are passed to callback.
 
Returns a handle that may be passed to remove_watch_file()
 
fd -- file descriptor to watch for input
callback -- function to call when input is available

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

function GLibEventLoop [back to top]

class GLibEventLoop(object) [back to top]

__init__(self)

Event loop based on gobject.MainLoop
 
>>> import os
>>> rd, wr = os.pipe()
>>> evl = GLibEventLoop()
>>> def step1():
...     print "writing"
...     os.write(wr, "hi")
>>> def step2():
...     print os.read(rd, 2)
...     raise ExitMainLoop
>>> handle = evl.alarm(0, step1)
>>> handle = evl.watch_file(rd, step2)
>>> evl.run()
writing
hi

alarm(self, seconds, callback)

Call callback() given time from from now.  No parameters are
passed to callback.
 
Returns a handle that may be passed to remove_alarm()
 
seconds -- floating point time to wait before calling callback
callback -- function to call from event loop

handle_exit(self, f)

Decorator that cleanly exits the GLibEventLoop if ExitMainLoop is
thrown inside of the wrapped function.  Store the exception info if 
some other exception occurs, it will be reraised after the loop quits.
f -- function to be wrapped

remove_alarm(self, handle)

Remove an alarm.
 
Returns True if the alarm exists, False otherwise
 
>>> evl = GLibEventLoop()
>>> handle = evl.alarm(50, lambda: None)
>>> evl.remove_alarm(handle)
True
>>> evl.remove_alarm(handle)
False

remove_watch_file(self, handle)

Remove an input file.
 
Returns True if the input file exists, False otherwise
 
>>> evl = GLibEventLoop()
>>> handle = evl.watch_file(1, lambda: None)
>>> evl.remove_watch_file(handle)
True
>>> evl.remove_watch_file(handle)
False

run(self)

Start the event loop.  Exit the loop when any callback raises
an exception.  If ExitMainLoop is raised, exit cleanly.
 
>>> import os
>>> rd, wr = os.pipe()
>>> os.write(wr, "data") # something to read from rd
4
>>> evl = GLibEventLoop()
>>> def say_hello():
...     print "hello"
>>> def exit_clean():
...     print "clean exit"
...     raise ExitMainLoop
>>> def exit_error():
...     1/0
>>> handle = evl.alarm(0.0625, exit_clean)
>>> handle = evl.alarm(0, say_hello)
>>> evl.run()
hello
clean exit
>>> handle = evl.watch_file(rd, exit_clean)
>>> evl.run()
clean exit
>>> evl.remove_watch_file(handle)
True
>>> handle = evl.alarm(0, exit_error)
>>> evl.run()
Traceback (most recent call last):
   ...
ZeroDivisionError: integer division or modulo by zero
>>> handle = evl.watch_file(rd, exit_error)
>>> evl.run()
Traceback (most recent call last):
   ...
ZeroDivisionError: integer division or modulo by zero

watch_file(self, fd, callback)

Call callback() when fd has some data to read.  No parameters
are passed to callback.
 
Returns a handle that may be passed to remove_watch_file()
 
fd -- file descriptor to watch for input
callback -- function to call when input is available

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

function TwistedEventLoop [back to top]

class TwistedEventLoop(object) [back to top]

__init__(self, reactor=None)

Event loop based on Twisted
 
>>> import os
>>> rd, wr = os.pipe()
>>> evl = TwistedEventLoop()
>>> def step1():
...     print "writing"
...     os.write(wr, "hi")
>>> def step2():
...     print os.read(rd, 2)
...     raise ExitMainLoop
>>> handle = evl.alarm(0, step1)
>>> handle = evl.watch_file(rd, step2)
>>> evl.run()
writing
hi

alarm(self, seconds, callback)

Call callback() given time from from now.  No parameters are
passed to callback.
 
Returns a handle that may be passed to remove_alarm()
 
seconds -- floating point time to wait before calling callback
callback -- function to call from event loop

handle_exit(self, f)

Decorator that cleanly exits the TwistedEventLoop if ExitMainLoop is
thrown inside of the wrapped function.  Store the exception info if 
some other exception occurs, it will be reraised after the loop quits.
f -- function to be wrapped

remove_alarm(self, handle)

Remove an alarm.
 
Returns True if the alarm exists, False otherwise
 
>>> evl = TwistedEventLoop()
>>> handle = evl.alarm(50, lambda: None)
>>> evl.remove_alarm(handle)
True
>>> evl.remove_alarm(handle)
False

remove_watch_file(self, handle)

Remove an input file.
 
Returns True if the input file exists, False otherwise
 
>>> evl = TwistedEventLoop()
>>> handle = evl.watch_file(1, lambda: None)
>>> evl.remove_watch_file(handle)
True
>>> evl.remove_watch_file(handle)
False

run(self)

Start the event loop.  Exit the loop when any callback raises
an exception.  If ExitMainLoop is raised, exit cleanly.
 
>>> import os
>>> rd, wr = os.pipe()
>>> os.write(wr, "data") # something to read from rd
4
>>> evl = TwistedEventLoop()
>>> def say_hello():
...     print "hello"
>>> def exit_clean():
...     print "clean exit"
...     raise ExitMainLoop
>>> def exit_error():
...     1/0
>>> handle = evl.alarm(0.0625, exit_clean)
>>> handle = evl.alarm(0, say_hello)
>>> evl.run()
hello
clean exit
>>> handle = evl.watch_file(rd, exit_clean)
>>> evl.run()
clean exit
>>> evl.remove_watch_file(handle)
True
>>> handle = evl.alarm(0, exit_error)
>>> evl.run()
Traceback (most recent call last):
   ...
ZeroDivisionError: integer division or modulo by zero
>>> handle = evl.watch_file(rd, exit_error)
>>> evl.run()
Traceback (most recent call last):
   ...
ZeroDivisionError: integer division or modulo by zero

watch_file(self, fd, callback)

Call callback() when fd has some data to read.  No parameters
are passed to callback.
 
Returns a handle that may be passed to remove_watch_file()
 
fd -- file descriptor to watch for input
callback -- function to call when input is available

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Top-level widgets

function Frame [back to top]

class Frame(BoxWidget) [back to top]

Method resolution order:

Frame

BoxWidget

Widget

object

__init__(self, body, header=None, footer=None, focus_part='body')

body -- a box widget for the body of the frame
header -- a flow widget for above the body (or None)
footer -- a flow widget for below the body (or None)
focus_part -- 'header', 'footer' or 'body'

frame_top_bottom(self, size, focus)

Calculate the number of rows for the header and footer.
 
Returns (head rows, foot rows),(orig head, orig foot).
orig head/foot are from rows() calls.

get_body(self)

get_footer(self)

get_header(self)

keypress(self, size, key)

Pass keypress to widget in focus.

mouse_event(self, size, event, button, col, row, focus)

Pass mouse event to appropriate part of frame.
Focus may be changed on button 1 press.

render(self, size, focus=False)

Render frame and return it.

set_body(self, body)

set_focus(self, part)

Set the part of the frame that is in focus.
 
part -- 'header', 'footer' or 'body'

set_footer(self, footer)

set_header(self, header)

body

footer

header

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Filler [back to top]

class Filler(WidgetDecoration) [back to top]

Method resolution order:

Filler

WidgetDecoration

Widget

object

__init__(self, body, valign='middle', height=None, min_height=None)

body -- a flow widget or box widget to be filled around (stored 
    as self.original_widget)
valign -- one of:
    'top', 'middle', 'bottom'
    ('fixed top', rows)
    ('fixed bottom', rows)
    ('relative', percentage 0=top 100=bottom)
height -- one of:
    None if body is a flow widget
    number of rows high 
    ('fixed bottom', rows)  Only if valign is 'fixed top'
    ('fixed top', rows)  Only if valign is 'fixed bottom'
    ('relative', percentage of total height)
min_height -- one of:
    None if no minimum or if body is a flow widget
    minimum number of rows for the widget when height not fixed
 
If body is a flow widget then height and min_height must be set
to None.
 
Filler widgets will try to satisfy height argument first by
reducing the valign amount when necessary.  If height still 
cannot be satisfied it will also be reduced.

filler_values(self, size, focus)

Return the number of rows to pad on the top and bottom.
 
Override this method to define custom padding behaviour.

get_body = _get_original_widget(self)

get_cursor_coords(self, size)

Return cursor coords from self.original_widget if any.

get_pref_col(self, size)

Return pref_col from self.original_widget if any.

keypress(self, size, key)

Pass keypress to self.original_widget.

mouse_event(self, size, event, button, col, row, focus)

Pass to self.original_widget.

move_cursor_to_coords(self, size, col, row)

Pass to self.original_widget.

render(self, size, focus=False)

Render self.original_widget with space above and/or below.

selectable(self)

Return selectable from body.

set_body = _set_original_widget(self, original_widget)

sizing(self)

body

base_widget

Return the widget without decorations.  If there is only one
Decoration then this is the same as original_widget.
 
>>> t = Text('hello')
>>> wd1 = WidgetDecoration(t)
>>> wd2 = WidgetDecoration(wd1)
>>> wd3 = WidgetDecoration(wd2)
>>> wd3.original_widget is wd2
True
>>> wd3.base_widget is t
True

original_widget

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function ListBox [back to top]

class ListBox(BoxWidget) [back to top]

Method resolution order:

ListBox

BoxWidget

Widget

object

__init__(self, body)

body -- a ListWalker-like object that contains
    widgets to be displayed inside the list box

calculate_visible(self, size, focus=False)

Return (middle,top,bottom) or None,None,None.
 
middle -- ( row offset(when +ve) or inset(when -ve),
    focus widget, focus position, focus rows, 
    cursor coords or None )
top -- ( # lines to trim off top, 
    list of (widget, position, rows) tuples above focus
    in order from bottom to top )
bottom -- ( # lines to trim off bottom, 
    list of (widget, position, rows) tuples below focus
    in order from top to bottom )

change_focus(self, size, position, offset_inset=0, coming_from=None, cursor_coords=None, snap_rows=None)

Change the current focus widget.
 
position -- a position compatible with self.body.set_focus
offset_inset -- either the number of rows between the 
  top of the listbox and the start of the focus widget (+ve
  value) or the number of lines of the focus widget hidden off 
  the top edge of the listbox (-ve value) or 0 if the top edge
  of the focus widget is aligned with the top edge of the
  listbox (default if unspecified)
coming_from -- eiter 'above', 'below' or unspecified (None)
cursor_coords -- (x, y) tuple indicating the desired
  column and row for the cursor, a (x,) tuple indicating only
  the column for the cursor, or unspecified (None)
snap_rows -- the maximum number of extra rows to scroll
  when trying to "snap" a selectable focus into the view

ends_visible(self, size, focus=False)

Return a list that may contain 'top' and/or 'bottom'.
 
convenience function for checking whether the top and bottom
of the list are visible

get_focus(self)

Return a (focus widget, focus position) tuple.

get_focus_offset_inset(self, size)

Return (offset rows, inset rows) for focus widget.

keypress(self, size, key)

Move selection through the list elements scrolling when 
necessary. 'up' and 'down' are first passed to widget in focus
in case that widget can handle them. 'page up' and 'page down'
are always handled by the ListBox.
 
Keystrokes handled by this widget are:
 'up'        up one line (or widget)
 'down'      down one line (or widget)
 'page up'   move cursor up one listbox length
 'page down' move cursor down one listbox length

make_cursor_visible(self, size)

Shift the focus widget so that its cursor is visible.

mouse_event(self, size, event, button, col, row, focus)

Pass the event to the contained widgets.
May change focus on button 1 press.

render(self, size, focus=False)

Render listbox and return canvas.

set_focus(self, position, coming_from=None)

Set the focus position and try to keep the old focus in view.
 
position -- a position compatible with self.body.set_focus
coming_from -- set to 'above' or 'below' if you know that
               old position is above or below the new position.

set_focus_valign(self, valign)

Set the focus widget's display offset and inset.
 
valign -- one of:
    'top', 'middle', 'bottom'
    ('fixed top', rows)
    ('fixed bottom', rows)
    ('relative', percentage 0=top 100=bottom)

shift_focus(self, size, offset_inset)

Move the location of the current focus relative to the top.
 
offset_inset -- either the number of rows between the 
  top of the listbox and the start of the focus widget (+ve
  value) or the number of lines of the focus widget hidden off 
  the top edge of the listbox (-ve value) or 0 if the top edge
  of the focus widget is aligned with the top edge of the
  listbox

update_pref_col_from_focus(self, size)

Update self.pref_col from the focus widget.

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

Decorations

function AttrMap [back to top]

class AttrMap(WidgetDecoration) [back to top]

Method resolution order:

AttrMap

WidgetDecoration

Widget

object

__init__(self, w, attr_map, focus_map=None)

w -- widget to wrap (stored as self.original_widget)
attr_map -- attribute to apply to w, or dictionary of attribute mappings
focus_map -- attribute to apply when in focus or dictionary of
    attribute mappings, if None use attr
 
This object will pass all function calls and variable references
to the wrapped widget.
 
>>> AttrMap(Divider("!"), 'bright')
<AttrMap flow widget <Divider flow widget div_char='!'> attr_map={None: 'bright'}>
>>> AttrMap(Edit(), 'notfocus', 'focus')
<AttrMap selectable flow widget <Edit selectable flow widget '' edit_pos=0> attr_map={None: 'notfocus'} focus_map={None: 'focus'}>
>>> size = (5,)
>>> am = AttrMap(Text("hi"), 'greeting', 'fgreet')
>>> am.render(size, focus=False).content().next()
[('greeting', None, 'hi   ')]
>>> am.render(size, focus=True).content().next()
[('fgreet', None, 'hi   ')]
>>> am2 = AttrMap(Text(('word', "hi")), {None:'bg', 'word':'greeting'})
>>> am2
<AttrMap flow widget <Text flow widget 'hi'> attr_map={None: 'bg', 'word': 'greeting'}>
>>> am2.render(size).content().next()
[('greeting', None, 'hi'), ('bg', None, '   ')]

get_attr_map(self)

get_focus_map(self)

render(self, size, focus=False)

Render wrapped widget and apply attribute. Return canvas.

set_attr_map(self, attr_map)

Set the attribute mapping dictionary {from_attr: to_attr, ...}
 
Note this function does not accept a single attribute the way the
constructor does.  You must specify {None: attribute} instead.
 
>> w = AttrMap(Text("hi"), None)
>> w.set_attr({'a':'b'})
>> w
<AttrMap flow widget <Text flow widget 'hi'> attr_map={'a': 'b'}>

set_focus_map(self, focus_map)

Set the focus attribute mapping dictionary 
{from_attr: to_attr, ...}
 
If None this widget will use the attr mapping instead (no change 
when in focus).
 
Note this function does not accept a single attribute the way the
constructor does.  You must specify {None: attribute} instead.
 
>> w = AttrMap(Text("hi"), {})
>> w.set_focus_map({'a':'b'})
>> w
<AttrMap flow widget <Text flow widget 'hi'> attr_map={} focus_map={'a': 'b'}>
>> w.set_focus_map(None)
>> w
<AttrMap flow widget <Text flow widget 'hi'> attr_map={}>

attr_map

focus_map

get_cursor_coords

get_pref_col

keypress

mouse_event

move_cursor_to_coords

rows

selectable

sizing

base_widget

Return the widget without decorations.  If there is only one
Decoration then this is the same as original_widget.
 
>>> t = Text('hello')
>>> wd1 = WidgetDecoration(t)
>>> wd2 = WidgetDecoration(wd1)
>>> wd3 = WidgetDecoration(wd2)
>>> wd3.original_widget is wd2
True
>>> wd3.base_widget is t
True

original_widget

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Padding [back to top]

class Padding(WidgetDecoration) [back to top]

Method resolution order:

Padding

WidgetDecoration

Widget

object

__init__(self, w, align='left', width='pack', min_width=None, left=0, right=0)

w -- a box, flow or fixed widget to pad on the left and/or right
    this widget is stored as self.original_widget
align -- one of:
    'left', 'center', 'right'
    ('relative', percentage 0=left 100=right)
width -- one of:
    fixed number of columns for self.original_widget 
    'pack'   try to pack self.original_widget to its ideal size
    ('relative', percentage of total width)
    'clip'   to enable clipping mode for a fixed widget
min_width -- the minimum number of columns for 
    self.original_widget or None
left -- a fixed number of columns to pad on the left
right -- a fixed number of columns to pad on thr right
    
Clipping Mode: (width='clip')
In clipping mode this padding widget will behave as a flow
widget and self.original_widget will be treated as a fixed 
widget.  self.original_widget will will be clipped to fit
the available number of columns.  For example if align is 
'left' then self.original_widget may be clipped on the right.
 
>>> size = (7,)
>>> Padding(Text("Head"), ('relative', 20)).render(size).text
[' Head  ']
>>> Padding(Divider("-"), left=2, right=1).render(size).text
['  ---- ']
>>> Padding(Divider("*"), 'center', 3).render(size).text
['  ***  ']
>>> p=Padding(Text("1234"), 'left', 2, None, 1, 1)
>>> p
<Padding flow widget <Text flow widget '1234'> left=1 right=1 width=2>
>>> p.render(size).text   # align against left
[' 12    ', ' 34    ']
>>> p.align = 'right'
>>> p.render(size).text   # align against right
['    12 ', '    34 ']
>>> Padding(Text("hi\nthere"), 'right').render(size).text
['  hi   ', '  there']

get_cursor_coords(self, size)

Return the (x,y) coordinates of cursor within self._original_widget.

get_pref_col(self, size)

Return the preferred column from self._original_widget, or None.

keypress(self, size, key)

Pass keypress to self._original_widget.

mouse_event(self, size, event, button, x, y, focus)

Send mouse event if position is within self._original_widget.

move_cursor_to_coords(self, size, x, y)

Set the cursor position with (x,y) coordinates of self._original_widget.
 
Returns True if move succeeded, False otherwise.

padding_values(self, size, focus)

Return the number of columns to pad on the left and right.
 
Override this method to define custom padding behaviour.

render(self, size, focus=False)

rows(self, size, focus=False)

Return the rows needed for self.original_widget.

sizing(self)

align

Return the padding alignment setting.

width

Return the padding widthment setting.

selectable(self)

base_widget

Return the widget without decorations.  If there is only one
Decoration then this is the same as original_widget.
 
>>> t = Text('hello')
>>> wd1 = WidgetDecoration(t)
>>> wd2 = WidgetDecoration(wd1)
>>> wd3 = WidgetDecoration(wd2)
>>> wd3.original_widget is wd2
True
>>> wd3.base_widget is t
True

original_widget

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Divider [back to top]

class Divider(FlowWidget) [back to top]

Method resolution order:

Divider

FlowWidget

Widget

object

__init__(self, div_char=' ', top=0, bottom=0)

Create a horizontal divider widget.
 
div_char -- character to repeat across line
top -- number of blank lines above
bottom -- number of blank lines below
 
>>> Divider()
<Divider flow widget div_char=' '>
>>> Divider('-')
<Divider flow widget div_char='-'>
>>> Divider('x', 1, 2)
<Divider flow widget bottom=2 div_char='x' top=1>

render(self, size, focus=False)

Render the divider as a canvas and return it.
 
>>> Divider().render((10,)).text 
['          ']
>>> Divider('-', top=1).render((10,)).text
['          ', '----------']
>>> Divider('x', bottom=2).render((5,)).text
['xxxxx', '     ', '     ']

rows(self, size, focus=False)

Return the number of lines that will be rendered.
 
>>> Divider().rows((10,))
1
>>> Divider('x', 1, 2).rows((10,))
4

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function LineBox [back to top]

class LineBox(WidgetDecoration, WidgetWrap) [back to top]

Method resolution order:

LineBox

WidgetDecoration

WidgetWrap

Widget

object

__init__(self, original_widget)

Draw a line around original_widget.

selectable(self)

sizing(self)

base_widget

Return the widget without decorations.  If there is only one
Decoration then this is the same as original_widget.
 
>>> t = Text('hello')
>>> wd1 = WidgetDecoration(t)
>>> wd2 = WidgetDecoration(wd1)
>>> wd3 = WidgetDecoration(wd2)
>>> wd3.original_widget is wd2
True
>>> wd3.base_widget is t
True

original_widget

render(self, size, focus=False)

Render self._w.

get_cursor_coords

get_pref_col

keypress

mouse_event

move_cursor_to_coords

rows

w

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function SolidFill [back to top]

class SolidFill(BoxWidget) [back to top]

Method resolution order:

SolidFill

BoxWidget

Widget

object

__init__(self, fill_char=' ')

Create a box widget that will fill an area with a single 
character.
 
fill_char -- character to fill area with
 
>>> SolidFill('8')
<SolidFill box widget '8'>

render(self, size, focus=False)

Render the Fill as a canvas and return it.
 
>>> SolidFill().render((4,2)).text
['    ', '    ']
>>> SolidFill('#').render((5,3)).text
['#####', '#####', '#####']

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

Composite widgets

function Columns [back to top]

class Columns(Widget) [back to top]

Method resolution order:

Columns

Widget

object

__init__(self, widget_list, dividechars=0, focus_column=None, min_width=1, box_columns=None)

widget_list -- list of flow widgets or list of box widgets
dividechars -- blank characters between columns
focus_column -- index into widget_list of column in focus,
    if None the first selectable widget will be chosen.
min_width -- minimum width for each column before it is hidden
box_columns -- a list of column indexes containing box widgets
    whose maxrow is set to the maximum of the rows 
    required by columns not listed in box_columns.
 
widget_list may also contain tuples such as:
('fixed', width, widget) give this column a fixed width
('weight', weight, widget) give this column a relative weight
 
widgets not in a tuple are the same as ('weight', 1, widget)    
 
box_columns is ignored when this widget is being used as a
box widget because in that case all columns are treated as box
widgets.

column_widths(self, size)

Return a list of column widths.
 
size -- (maxcol,) if self.widget_list contains flow widgets or
    (maxcol, maxrow) if it contains box widgets.

get_cursor_coords(self, size)

Return the cursor coordinates from the focus widget.

get_focus(self)

Return the widget in focus.

get_focus_column(self)

Return the focus column index.

get_pref_col(self, size)

Return the pref col from the column in focus.

keypress(self, size, key)

Pass keypress to the focus column.
 
size -- (maxcol,) if self.widget_list contains flow widgets or
    (maxcol, maxrow) if it contains box widgets.

mouse_event(self, size, event, button, col, row, focus)

Send event to appropriate column.
May change focus on button 1 press.

move_cursor_to_coords(self, size, col, row)

Choose a selectable column to focus based on the coords.

render(self, size, focus=False)

Render columns and return canvas.
 
size -- (maxcol,) if self.widget_list contains flow widgets or
    (maxcol, maxrow) if it contains box widgets.

rows(self, size, focus=False)

Return the number of rows required by the columns.
Only makes sense if self.widget_list contains flow widgets.

selectable(self)

Return the selectable value of the focus column.

set_focus(self, item)

Set the item in focus.  
 
item -- widget or integer index

set_focus_column(self, num)

Set the column in focus by its index in self.widget_list.

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Pile [back to top]

class Pile(Widget) [back to top]

Method resolution order:

Pile

Widget

object

__init__(self, widget_list, focus_item=None)

widget_list -- list of widgets
focus_item -- widget or integer index, if None the first
    selectable widget will be chosen.
 
widget_list may also contain tuples such as:
('flow', widget) always treat widget as a flow widget
('fixed', height, widget) give this box widget a fixed height
('weight', weight, widget) if the pile is treated as a box
    widget then treat widget as a box widget with a
    height based on its relative weight value, otherwise
    treat widget as a flow widget
 
widgets not in a tuple are the same as ('weight', 1, widget)
 
If the pile is treated as a box widget there must be at least
one 'weight' tuple in widget_list.

get_cursor_coords(self, size)

Return the cursor coordinates of the focus widget.

get_focus(self)

Return the widget in focus.

get_item_rows(self, size, focus)

Return a list of the number of rows used by each widget
in self.item_list.

get_item_size(self, size, i, focus, item_rows=None)

Return a size appropriate for passing to self.widget_list[i]

get_pref_col(self, size)

Return the preferred column for the cursor, or None.

keypress(self, size, key)

Pass the keypress to the widget in focus.
Unhandled 'up' and 'down' keys may cause a focus change.

mouse_event(self, size, event, button, col, row, focus)

Pass the event to the contained widget.
May change focus on button 1 press.

move_cursor_to_coords(self, size, col, row)

Capture pref col and set new focus.

render(self, size, focus=False)

Render all widgets in self.widget_list and return the results
stacked one on top of the next.

rows(self, size, focus=False)

Return the number of rows required for this widget.

selectable(self)

Return True if the focus item is selectable.

set_focus(self, item)

Set the item in focus.  
 
item -- widget or integer index

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function GridFlow [back to top]

class GridFlow(FlowWidget) [back to top]

Method resolution order:

GridFlow

FlowWidget

Widget

object

__init__(self, cells, cell_width, h_sep, v_sep, align)

cells -- list of flow widgets to display
cell_width -- column width for each cell
h_sep -- blank columns between each cell horizontally
v_sep -- blank rows between cells vertically (if more than
         one row is required to display all the cells)
align -- horizontal alignment of cells, see "align" parameter
         of Padding widget for available options

generate_display_widget(self, size)

Actually generate display widget (ignoring cache)

get_cursor_coords(self, size)

Get cursor from display widget.

get_display_widget(self, size)

Arrange the cells into columns (and possibly a pile) for 
display, input or to calculate rows.

get_pref_col(self, size)

Return pref col from display widget.

keypress(self, size, key)

Pass keypress to display widget for handling.  
Capture    focus changes.

mouse_event(self, size, event, button, col, row, focus)

Send mouse event to contained widget.

move_cursor_to_coords(self, size, col, row)

Set the widget in focus based on the col + row.

render(self, size, focus=False)

Use display widget to render.

rows(self, size, focus=False)

Return rows used by this widget.

selectable(self)

Return True if the cell in focus is selectable.

set_focus(self, cell)

Set the cell in focus.  
 
cell -- widget or integer index into self.cells

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function BoxAdapter [back to top]

class BoxAdapter(WidgetDecoration) [back to top]

Method resolution order:

BoxAdapter

WidgetDecoration

Widget

object

__getattr__(self, name)

Pass calls to box widget.

__init__(self, box_widget, height)

Create a flow widget that contains a box widget
 
box_widget -- box widget (stored as self.original_widget)
height -- number of rows for box widget
 
>>> BoxAdapter(SolidFill("x"), 5) # 5-rows of x's
<BoxAdapter flow widget <SolidFill box widget 'x'> height=5>

get_cursor_coords(self, size)

# The next few functions simply tack-on our height and pass through
# to self._original_widget

get_pref_col(self, size)

keypress(self, size, key)

mouse_event(self, size, event, button, col, row, focus)

move_cursor_to_coords(self, size, col, row)

render(self, size, focus=False)

rows(self, size, focus=False)

Return the predetermined height (behave like a flow widget)
 
>>> BoxAdapter(SolidFill("x"), 5).rows((20,))
5

sizing(self)

box_widget

selectable(self)

base_widget

Return the widget without decorations.  If there is only one
Decoration then this is the same as original_widget.
 
>>> t = Text('hello')
>>> wd1 = WidgetDecoration(t)
>>> wd2 = WidgetDecoration(wd1)
>>> wd3 = WidgetDecoration(wd2)
>>> wd3.original_widget is wd2
True
>>> wd3.base_widget is t
True

original_widget

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Overlay [back to top]

class Overlay(BoxWidget) [back to top]

Method resolution order:

Overlay

BoxWidget

Widget

object

__init__(self, top_w, bottom_w, align, width, valign, height, min_width=None, min_height=None)

top_w -- a flow, box or fixed widget to overlay "on top"
bottom_w -- a box widget to appear "below" previous widget
align -- one of:
    'left', 'center', 'right'
    ('fixed left', columns)
    ('fixed right', columns)
    ('relative', percentage 0=left 100=right)
width -- one of:
    None if top_w is a fixed widget
    number of columns wide
    ('fixed right', columns)  Only if align is 'fixed left'
    ('fixed left', columns)  Only if align is 'fixed right'
    ('relative', percentage of total width)
valign -- one of:
    'top', 'middle', 'bottom'
    ('fixed top', rows)
    ('fixed bottom', rows)
    ('relative', percentage 0=top 100=bottom)
height -- one of:
    None if top_w is a flow or fixed widget
    number of rows high 
    ('fixed bottom', rows)  Only if valign is 'fixed top'
    ('fixed top', rows)  Only if valign is 'fixed bottom'
    ('relative', percentage of total height)
min_width -- the minimum number of columns for top_w
    when width is not fixed
min_height -- one of:
    minimum number of rows for the widget when height not fixed
 
Overlay widgets behave similarly to Padding and Filler widgets
when determining the size and position of top_w.  bottom_w is
always rendered the full size available "below" top_w.

calculate_padding_filler(self, size, focus)

Return (padding left, right, filler top, bottom).

get_cursor_coords(self, size)

Return cursor coords from top_w, if any.

keypress(self, size, key)

Pass keypress to top_w.

mouse_event(self, size, event, button, col, row, focus)

Pass event to top_w, ignore if outside of top_w.

render(self, size, focus=False)

Render top_w overlayed on bottom_w.

selectable(self)

Return selectable from top_w.

top_w_size(self, size, left, right, top, bottom)

Return the size to pass to top_w.

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

Content widgets

function Text [back to top]

class Text(FlowWidget) [back to top]

Method resolution order:

Text

FlowWidget

Widget

object

__init__(self, markup, align='left', wrap='space', layout=None)

markup -- content of text widget, one of:
    plain string -- string is displayed
    ( attr, markup2 ) -- markup2 is given attribute attr
    [ markupA, markupB, ... ] -- list items joined together
align -- align mode for text layout
wrap -- wrap mode for text layout
layout -- layout object to use, defaults to StandardTextLayout
 
>>> Text("Hello")
<Text flow widget 'Hello'>
>>> t = Text(('bold', "stuff"), 'right', 'any')
>>> t
<Text flow widget 'stuff' align='right' wrap='any'>
>>> t.text
'stuff'
>>> t.attrib
[('bold', 5)]

get_line_translation(self, maxcol, ta=None)

Return layout structure used to map self.text to a canvas.
This method is used internally, but may be useful for
debugging custom layout classes.
 
maxcol -- columns available for display
ta -- None or the (text, attr) tuple returned from
      get_text()

get_text(self)

Returns (text, attributes).
 
text -- complete string content of text widget
attributes -- run length encoded attributes for text
 
>>> Text("Hello").get_text()
('Hello', [])
>>> Text(('bright', "Headline")).get_text()
('Headline', [('bright', 8)])
>>> Text([('a', "one"), "two", ('b', "three")]).get_text()
('onetwothree', [('a', 3), (None, 3), ('b', 5)])

pack(self, size=None, focus=False)

Return the number of screen columns and rows required for
this Text widget to be displayed without wrapping or 
clipping, as a single element tuple.
 
size -- None for unlimited screen columns or (maxcol,) to
        specify a maximum column size
 
>>> Text("important things").pack()
(16, 1)
>>> Text("important things").pack((15,))
(9, 2)
>>> Text("important things").pack((8,))
(8, 2)

render(self, size, focus=False)

Render contents with wrapping and alignment.  Return canvas.
 
>>> Text("important things").render((18,)).text
['important things  ']
>>> Text("important things").render((11,)).text
['important  ', 'things     ']

rows(self, size, focus=False)

Return the number of rows the rendered text spans.
 
>>> Text("important things").rows((18,))
1
>>> Text("important things").rows((11,))
2

set_align_mode(self, mode)

Set text alignment / justification.  
 
Valid modes for StandardTextLayout are: 
    'left', 'center' and 'right'
 
>>> t = Text("word")
>>> t.set_align_mode('right')
>>> t.align
'right'
>>> t.render((10,)).text
['      word']
>>> t.align = 'center'
>>> t.render((10,)).text
['   word   ']
>>> t.align = 'somewhere'
Traceback (most recent call last):
    ...
TextError: Alignment mode 'somewhere' not supported.

set_layout(self, align, wrap, layout=None)

Set layout object, align and wrap modes.
 
align -- align mode for text layout
wrap -- wrap mode for text layout
layout -- layout object to use, defaults to StandardTextLayout
 
>>> t = Text("hi")
>>> t.set_layout('right', 'clip')
>>> t
<Text flow widget 'hi' align='right' wrap='clip'>

set_text(self, markup)

Set content of text widget.
 
markup -- see __init__() for description.
 
>>> t = Text("foo")
>>> t.text
'foo'
>>> t.set_text("bar")
>>> t.text
'bar'
>>> t.text = "baz"  # not supported because text stores text but set_text() takes markup
Traceback (most recent call last):
    ...  
AttributeError: can't set attribute

set_wrap_mode(self, mode)

Set wrap mode.  
 
Valid modes for StandardTextLayout are :
    'any'    : wrap at any character
    'space'    : wrap on space character
    'clip'    : truncate lines instead of wrapping
 
>>> t = Text("some words")
>>> t.render((6,)).text
['some  ', 'words ']
>>> t.set_wrap_mode('clip')
>>> t.wrap
'clip'
>>> t.render((6,)).text
['some w']
>>> t.wrap = 'any'  # Urwid 0.9.9 or later
>>> t.render((6,)).text
['some w', 'ords  ']
>>> t.wrap = 'somehow'
Traceback (most recent call last):
    ...
TextError: Wrap mode 'somehow' not supported.

align

attrib

layout

text

wrap

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Edit [back to top]

class Edit(Text) [back to top]

Method resolution order:

Edit

Text

FlowWidget

Widget

object

__init__(self, caption='', edit_text='', multiline=False, align='left', wrap='space', allow_tab=False, edit_pos=None, layout=None)

caption -- markup for caption preceeding edit_text
edit_text -- text string for editing
multiline -- True: 'enter' inserts newline  False: return it
align -- align mode
wrap -- wrap mode
allow_tab -- True: 'tab' inserts 1-8 spaces  False: return it
edit_pos -- initial position for cursor, None:at end
layout -- layout object
 
>>> Edit()
<Edit selectable flow widget '' edit_pos=0>
>>> Edit("Y/n? ", "yes")
<Edit selectable flow widget 'yes' caption='Y/n? ' edit_pos=3>
>>> Edit("Name ", "Smith", edit_pos=1)
<Edit selectable flow widget 'Smith' caption='Name ' edit_pos=1>
>>> Edit("", "3.14", align='right')
<Edit selectable flow widget '3.14' align='right' edit_pos=4>

get_cursor_coords(self, size)

Return the (x,y) coordinates of cursor within widget.
 
>>> Edit("? ","yes").get_cursor_coords((10,))
(5, 0)

get_edit_text(self)

Return the edit text for this widget.
 
>>> e = Edit("What? ", "oh, nothing.")
>>> e.get_edit_text()
'oh, nothing.'
>>> e.edit_text
'oh, nothing.'

get_line_translation(self, maxcol, ta=None)

get_pref_col(self, size)

Return the preferred column for the cursor, or the
current cursor x value.  May also return 'left' or 'right'
to indicate the leftmost or rightmost column available.
 
This method is used internally and by other widgets when
moving the cursor up or down between widgets so that the 
column selected is one that the user would expect.
 
>>> size = (10,)
>>> Edit().get_pref_col(size)
0
>>> e = Edit("","word")
>>> e.get_pref_col(size)
4
>>> e.keypress(size, 'left')
>>> e.get_pref_col(size)
3
>>> e.keypress(size, 'end')
>>> e.get_pref_col(size)
'right'
>>> e = Edit("","2\nwords")
>>> e.keypress(size, 'left')
>>> e.keypress(size, 'up')
>>> e.get_pref_col(size)
4
>>> e.keypress(size, 'left')
>>> e.get_pref_col(size)
0

get_text(self)

Returns (text, attributes).
 
text -- complete text of caption and edit_text
attributes -- run length encoded attributes for text
 
>>> Edit("What? ","oh, nothing.").get_text()
('What? oh, nothing.', [])
>>> Edit(('bright',"user@host:~$ "),"ls").get_text()
('user@host:~$ ls', [('bright', 13)])

insert_text(self, text)

Insert text at the cursor position and update cursor.
This method is used by the keypress() method when inserting
one or more characters into edit_text.
 
>>> e = Edit("", "42")
>>> e.insert_text(".5")
>>> e
<Edit selectable flow widget '42.5' edit_pos=4>
>>> e.set_edit_pos(2)
>>> e.insert_text("a")
>>> e.edit_text
'42a.5'

keypress(self, size, key)

Handle editing keystrokes, return others.
 
>>> e, size = Edit(), (20,)
>>> e.keypress(size, 'x')
>>> e.keypress(size, 'left')
>>> e.keypress(size, '1')
>>> e.edit_text
'1x'
>>> e.keypress(size, 'backspace')
>>> e.keypress(size, 'end')
>>> e.keypress(size, '2')
>>> e.edit_text
'x2'
>>> e.keypress(size, 'shift f1')
'shift f1'

mouse_event(self, size, event, button, x, y, focus)

Move the cursor to the location clicked for button 1.
 
>>> size = (20,)
>>> e = Edit("","words here")
>>> e.mouse_event(size, 'mouse press', 1, 2, 0, True)
True
>>> e.edit_pos
2

move_cursor_to_coords(self, size, x, y)

Set the cursor position with (x,y) coordinates.
Returns True if move succeeded, False otherwise.
 
>>> size = (10,)
>>> e = Edit("","edit\ntext")
>>> e.move_cursor_to_coords(size, 5, 0)
True
>>> e.edit_pos
4
>>> e.move_cursor_to_coords(size, 5, 3)
False
>>> e.move_cursor_to_coords(size, 0, 1)
True
>>> e.edit_pos
5

position_coords(self, maxcol, pos)

Return (x,y) coordinates for an offset into self.edit_text.

render(self, size, focus=False)

Render edit widget and return canvas.  Include cursor when in
focus.
 
>>> c = Edit("? ","yes").render((10,), focus=True)
>>> c.text
['? yes     ']
>>> c.cursor
(5, 0)

selectable(self)

set_caption(self, caption)

Set the caption markup for this widget.
 
caption -- see Text.__init__() for description of markup
 
>>> e = Edit("")
>>> e.set_caption("cap1")
>>> e.caption
'cap1'
>>> e.set_caption(('bold', "cap2"))
>>> e.caption
'cap2'
>>> e.attrib
[('bold', 4)]
>>> e.caption = "cap3"  # not supported because caption stores text but set_caption() takes markup
Traceback (most recent call last):
    ...  
AttributeError: can't set attribute

set_edit_pos(self, pos)

Set the cursor position with a self.edit_text offset.  
Clips pos to [0, len(edit_text)].
 
>>> e = Edit("", "word")
>>> e.edit_pos
4
>>> e.set_edit_pos(2)
>>> e.edit_pos
2
>>> e.edit_pos = -1  # Urwid 0.9.9 or later
>>> e.edit_pos
0
>>> e.edit_pos = 20
>>> e.edit_pos
4

set_edit_text(self, text)

Set the edit text for this widget.
 
>>> e = Edit()
>>> e.set_edit_text("yes")
>>> e.edit_text
'yes'
>>> e
<Edit selectable flow widget 'yes' edit_pos=0>
>>> e.edit_text = "no"  # Urwid 0.9.9 or later
>>> e.edit_text
'no'

set_text(self, markup)

Not supported by Edit widget.
 
>>> Edit().set_text("test")
Traceback (most recent call last):
    ...
EditError: set_text() not supported.  Use set_caption() or set_edit_text() instead.

update_text(self)

No longer supported.
 
>>> Edit().update_text()
Traceback (most recent call last):
    ...
EditError: update_text() has been removed.  Use set_caption() or set_edit_text() instead.

valid_char(self, ch)

Return true for printable characters.

caption

edit_pos

edit_text

Return the edit text for this widget.
 
>>> e = Edit("What? ", "oh, nothing.")
>>> e.get_edit_text()
'oh, nothing.'
>>> e.edit_text
'oh, nothing.'

signals = ['change']

pack(self, size=None, focus=False)

Return the number of screen columns and rows required for
this Text widget to be displayed without wrapping or 
clipping, as a single element tuple.
 
size -- None for unlimited screen columns or (maxcol,) to
        specify a maximum column size
 
>>> Text("important things").pack()
(16, 1)
>>> Text("important things").pack((15,))
(9, 2)
>>> Text("important things").pack((8,))
(8, 2)

rows(self, size, focus=False)

Return the number of rows the rendered text spans.
 
>>> Text("important things").rows((18,))
1
>>> Text("important things").rows((11,))
2

set_align_mode(self, mode)

Set text alignment / justification.  
 
Valid modes for StandardTextLayout are: 
    'left', 'center' and 'right'
 
>>> t = Text("word")
>>> t.set_align_mode('right')
>>> t.align
'right'
>>> t.render((10,)).text
['      word']
>>> t.align = 'center'
>>> t.render((10,)).text
['   word   ']
>>> t.align = 'somewhere'
Traceback (most recent call last):
    ...
TextError: Alignment mode 'somewhere' not supported.

set_layout(self, align, wrap, layout=None)

Set layout object, align and wrap modes.
 
align -- align mode for text layout
wrap -- wrap mode for text layout
layout -- layout object to use, defaults to StandardTextLayout
 
>>> t = Text("hi")
>>> t.set_layout('right', 'clip')
>>> t
<Text flow widget 'hi' align='right' wrap='clip'>

set_wrap_mode(self, mode)

Set wrap mode.  
 
Valid modes for StandardTextLayout are :
    'any'    : wrap at any character
    'space'    : wrap on space character
    'clip'    : truncate lines instead of wrapping
 
>>> t = Text("some words")
>>> t.render((6,)).text
['some  ', 'words ']
>>> t.set_wrap_mode('clip')
>>> t.wrap
'clip'
>>> t.render((6,)).text
['some w']
>>> t.wrap = 'any'  # Urwid 0.9.9 or later
>>> t.render((6,)).text
['some w', 'ords  ']
>>> t.wrap = 'somehow'
Traceback (most recent call last):
    ...
TextError: Wrap mode 'somehow' not supported.

align

attrib

layout

text

wrap

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function IntEdit [back to top]

class IntEdit(Edit) [back to top]

Method resolution order:

IntEdit

Edit

Text

FlowWidget

Widget

object

__init__(self, caption='', default=None)

caption -- caption markup
default -- default edit value
 
>>> IntEdit("", 42)
<IntEdit selectable flow widget '42' edit_pos=2>

keypress(self, size, key)

Handle editing keystrokes.  Remove leading zeros.
 
>>> e, size = IntEdit("", 5002), (10,)
>>> e.keypress(size, 'home')
>>> e.keypress(size, 'delete')
>>> e.edit_text
'002'
>>> e.keypress(size, 'end')
>>> e.edit_text
'2'

valid_char(self, ch)

Return true for decimal digits.

value(self)

Return the numeric value of self.edit_text.
 
>>> e, size = IntEdit(), (10,)
>>> e.keypress(size, '5')
>>> e.keypress(size, '1')
>>> e.value() == 51
True

get_cursor_coords(self, size)

Return the (x,y) coordinates of cursor within widget.
 
>>> Edit("? ","yes").get_cursor_coords((10,))
(5, 0)

get_edit_text(self)

Return the edit text for this widget.
 
>>> e = Edit("What? ", "oh, nothing.")
>>> e.get_edit_text()
'oh, nothing.'
>>> e.edit_text
'oh, nothing.'

get_line_translation(self, maxcol, ta=None)

get_pref_col(self, size)

Return the preferred column for the cursor, or the
current cursor x value.  May also return 'left' or 'right'
to indicate the leftmost or rightmost column available.
 
This method is used internally and by other widgets when
moving the cursor up or down between widgets so that the 
column selected is one that the user would expect.
 
>>> size = (10,)
>>> Edit().get_pref_col(size)
0
>>> e = Edit("","word")
>>> e.get_pref_col(size)
4
>>> e.keypress(size, 'left')
>>> e.get_pref_col(size)
3
>>> e.keypress(size, 'end')
>>> e.get_pref_col(size)
'right'
>>> e = Edit("","2\nwords")
>>> e.keypress(size, 'left')
>>> e.keypress(size, 'up')
>>> e.get_pref_col(size)
4
>>> e.keypress(size, 'left')
>>> e.get_pref_col(size)
0

get_text(self)

Returns (text, attributes).
 
text -- complete text of caption and edit_text
attributes -- run length encoded attributes for text
 
>>> Edit("What? ","oh, nothing.").get_text()
('What? oh, nothing.', [])
>>> Edit(('bright',"user@host:~$ "),"ls").get_text()
('user@host:~$ ls', [('bright', 13)])

insert_text(self, text)

Insert text at the cursor position and update cursor.
This method is used by the keypress() method when inserting
one or more characters into edit_text.
 
>>> e = Edit("", "42")
>>> e.insert_text(".5")
>>> e
<Edit selectable flow widget '42.5' edit_pos=4>
>>> e.set_edit_pos(2)
>>> e.insert_text("a")
>>> e.edit_text
'42a.5'

mouse_event(self, size, event, button, x, y, focus)

Move the cursor to the location clicked for button 1.
 
>>> size = (20,)
>>> e = Edit("","words here")
>>> e.mouse_event(size, 'mouse press', 1, 2, 0, True)
True
>>> e.edit_pos
2

move_cursor_to_coords(self, size, x, y)

Set the cursor position with (x,y) coordinates.
Returns True if move succeeded, False otherwise.
 
>>> size = (10,)
>>> e = Edit("","edit\ntext")
>>> e.move_cursor_to_coords(size, 5, 0)
True
>>> e.edit_pos
4
>>> e.move_cursor_to_coords(size, 5, 3)
False
>>> e.move_cursor_to_coords(size, 0, 1)
True
>>> e.edit_pos
5

position_coords(self, maxcol, pos)

Return (x,y) coordinates for an offset into self.edit_text.

render(self, size, focus=False)

Render edit widget and return canvas.  Include cursor when in
focus.
 
>>> c = Edit("? ","yes").render((10,), focus=True)
>>> c.text
['? yes     ']
>>> c.cursor
(5, 0)

selectable(self)

set_caption(self, caption)

Set the caption markup for this widget.
 
caption -- see Text.__init__() for description of markup
 
>>> e = Edit("")
>>> e.set_caption("cap1")
>>> e.caption
'cap1'
>>> e.set_caption(('bold', "cap2"))
>>> e.caption
'cap2'
>>> e.attrib
[('bold', 4)]
>>> e.caption = "cap3"  # not supported because caption stores text but set_caption() takes markup
Traceback (most recent call last):
    ...  
AttributeError: can't set attribute

set_edit_pos(self, pos)

Set the cursor position with a self.edit_text offset.  
Clips pos to [0, len(edit_text)].
 
>>> e = Edit("", "word")
>>> e.edit_pos
4
>>> e.set_edit_pos(2)
>>> e.edit_pos
2
>>> e.edit_pos = -1  # Urwid 0.9.9 or later
>>> e.edit_pos
0
>>> e.edit_pos = 20
>>> e.edit_pos
4

set_edit_text(self, text)

Set the edit text for this widget.
 
>>> e = Edit()
>>> e.set_edit_text("yes")
>>> e.edit_text
'yes'
>>> e
<Edit selectable flow widget 'yes' edit_pos=0>
>>> e.edit_text = "no"  # Urwid 0.9.9 or later
>>> e.edit_text
'no'

set_text(self, markup)

Not supported by Edit widget.
 
>>> Edit().set_text("test")
Traceback (most recent call last):
    ...
EditError: set_text() not supported.  Use set_caption() or set_edit_text() instead.

update_text(self)

No longer supported.
 
>>> Edit().update_text()
Traceback (most recent call last):
    ...
EditError: update_text() has been removed.  Use set_caption() or set_edit_text() instead.

caption

edit_pos

edit_text

Return the edit text for this widget.
 
>>> e = Edit("What? ", "oh, nothing.")
>>> e.get_edit_text()
'oh, nothing.'
>>> e.edit_text
'oh, nothing.'

signals = ['change']

pack(self, size=None, focus=False)

Return the number of screen columns and rows required for
this Text widget to be displayed without wrapping or 
clipping, as a single element tuple.
 
size -- None for unlimited screen columns or (maxcol,) to
        specify a maximum column size
 
>>> Text("important things").pack()
(16, 1)
>>> Text("important things").pack((15,))
(9, 2)
>>> Text("important things").pack((8,))
(8, 2)

rows(self, size, focus=False)

Return the number of rows the rendered text spans.
 
>>> Text("important things").rows((18,))
1
>>> Text("important things").rows((11,))
2

set_align_mode(self, mode)

Set text alignment / justification.  
 
Valid modes for StandardTextLayout are: 
    'left', 'center' and 'right'
 
>>> t = Text("word")
>>> t.set_align_mode('right')
>>> t.align
'right'
>>> t.render((10,)).text
['      word']
>>> t.align = 'center'
>>> t.render((10,)).text
['   word   ']
>>> t.align = 'somewhere'
Traceback (most recent call last):
    ...
TextError: Alignment mode 'somewhere' not supported.

set_layout(self, align, wrap, layout=None)

Set layout object, align and wrap modes.
 
align -- align mode for text layout
wrap -- wrap mode for text layout
layout -- layout object to use, defaults to StandardTextLayout
 
>>> t = Text("hi")
>>> t.set_layout('right', 'clip')
>>> t
<Text flow widget 'hi' align='right' wrap='clip'>

set_wrap_mode(self, mode)

Set wrap mode.  
 
Valid modes for StandardTextLayout are :
    'any'    : wrap at any character
    'space'    : wrap on space character
    'clip'    : truncate lines instead of wrapping
 
>>> t = Text("some words")
>>> t.render((6,)).text
['some  ', 'words ']
>>> t.set_wrap_mode('clip')
>>> t.wrap
'clip'
>>> t.render((6,)).text
['some w']
>>> t.wrap = 'any'  # Urwid 0.9.9 or later
>>> t.render((6,)).text
['some w', 'ords  ']
>>> t.wrap = 'somehow'
Traceback (most recent call last):
    ...
TextError: Wrap mode 'somehow' not supported.

align

attrib

layout

text

wrap

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function Button [back to top]

class Button(WidgetWrap) [back to top]

Method resolution order:

Button

WidgetWrap

Widget

object

__init__(self, label, on_press=None, user_data=None)

label -- markup for button label
on_press, user_data -- shorthand for connect_signal()
    function call for a single callback
 
Signals supported: 'click'
Register signal handler with:
  connect_signal(button, 'click', callback [,user_data])
where callback is callback(button [,user_data])
Unregister signal handlers with:
  disconnect_signal(button, 'click', callback [,user_data])
 
>>> Button("Ok")
<Button selectable widget 'Ok'>
>>> b = Button("Cancel")
>>> b.render((15,), focus=True).text  # preview Button
['< Cancel      >']

get_label(self)

Return label text.
 
>>> b = Button("Ok")
>>> b.get_label()
'Ok'
>>> b.label  # Urwid 0.9.9 or later
'Ok'

keypress(self, size, key)

Send 'click' signal on 'activate' command.
 
>>> assert command_map[' '] == 'activate'
>>> assert command_map['enter'] == 'activate'
>>> size = (15,)
>>> b = Button("Cancel")
>>> clicked_buttons = []
>>> def handle_click(button):
...     clicked_buttons.append(button.label)
>>> connect_signal(b, 'click', handle_click)
>>> b.keypress(size, 'enter')
>>> b.keypress(size, ' ')
>>> clicked_buttons
['Cancel', 'Cancel']

mouse_event(self, size, event, button, x, y, focus)

Send 'click' signal on button 1 press.
 
>>> size = (15,)
>>> b = Button("Ok")
>>> clicked_buttons = []
>>> def handle_click(button):
...     clicked_buttons.append(button.label)
>>> connect_signal(b, 'click', handle_click)
>>> b.mouse_event(size, 'mouse press', 1, 4, 0, True)
True
>>> b.mouse_event(size, 'mouse press', 2, 4, 0, True) # ignored
False
>>> clicked_buttons
['Ok']

set_label(self, label)

Change the button label.
 
label -- markup for button label
 
>>> b = Button("Ok")
>>> b.set_label("Yup yup")
>>> b
<Button selectable widget 'Yup yup'>

label

Return label text.
 
>>> b = Button("Ok")
>>> b.get_label()
'Ok'
>>> b.label  # Urwid 0.9.9 or later
'Ok'

button_left = <Text flow widget '<'>

button_right = <Text flow widget '>'>

signals = ['click']

render(self, size, focus=False)

Render self._w.

get_cursor_coords

get_pref_col

move_cursor_to_coords

rows

selectable

sizing

w

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function CheckBox [back to top]

class CheckBox(WidgetWrap) [back to top]

Method resolution order:

CheckBox

WidgetWrap

Widget

object

__init__(self, label, state=False, has_mixed=False, on_state_change=None, user_data=None)

label -- markup for check box label
state -- False, True or "mixed"
has_mixed -- True if "mixed" is a state to cycle through
on_state_change, user_data -- shorthand for connect_signal()
    function call for a single callback
 
Signals supported: 'change'
Register signal handler with:
  connect_signal(check_box, 'change', callback [,user_data])
where callback is callback(check_box, new_state [,user_data])
Unregister signal handlers with:
  disconnect_signal(check_box, 'change', callback [,user_data])
 
>>> CheckBox("Confirm")
<CheckBox selectable widget 'Confirm' state=False>
>>> CheckBox("Yogourt", "mixed", True)
<CheckBox selectable widget 'Yogourt' state='mixed'>
>>> cb = CheckBox("Extra onions", True)
>>> cb
<CheckBox selectable widget 'Extra onions' state=True>
>>> cb.render((20,), focus=True).text  # preview CheckBox
['[X] Extra onions    ']

get_label(self)

Return label text.
 
>>> cb = CheckBox("Seriously")
>>> cb.get_label()
'Seriously'
>>> cb.label  # Urwid 0.9.9 or later
'Seriously'
>>> cb.set_label([('bright_attr', "flashy"), " normal"])
>>> cb.label  #  only text is returned 
'flashy normal'

get_state(self)

Return the state of the checkbox.

keypress(self, size, key)

Toggle state on 'activate' command.  
 
>>> assert command_map[' '] == 'activate'
>>> assert command_map['enter'] == 'activate'
>>> size = (10,)
>>> cb = CheckBox('press me')
>>> cb.state
False
>>> cb.keypress(size, ' ')
>>> cb.state
True
>>> cb.keypress(size, ' ')
>>> cb.state
False

mouse_event(self, size, event, button, x, y, focus)

Toggle state on button 1 press.
 
>>> size = (20,)
>>> cb = CheckBox("clickme")
>>> cb.state
False
>>> cb.mouse_event(size, 'mouse press', 1, 2, 0, True)
True
>>> cb.state
True

set_label(self, label)

Change the check box label.
 
label -- markup for label.  See Text widget for description
of text markup.
 
>>> cb = CheckBox("foo")
>>> cb
<CheckBox selectable widget 'foo' state=False>
>>> cb.set_label(('bright_attr', "bar"))
>>> cb
<CheckBox selectable widget 'bar' state=False>

set_state(self, state, do_callback=True)

Set the CheckBox state.
 
state -- True, False or "mixed"
do_callback -- False to supress signal from this change
 
>>> changes = []
>>> def callback_a(cb, state, user_data): 
...     changes.append("A %r %r" % (state, user_data))
>>> def callback_b(cb, state): 
...     changes.append("B %r" % state)
>>> cb = CheckBox('test', False, False)
>>> connect_signal(cb, 'change', callback_a, "user_a")
>>> connect_signal(cb, 'change', callback_b)
>>> cb.set_state(True) # both callbacks will be triggered
>>> cb.state
True
>>> disconnect_signal(cb, 'change', callback_a, "user_a")
>>> cb.state = False  # Urwid 0.9.9 or later
>>> cb.state
False
>>> cb.set_state(True)
>>> cb.state
True
>>> cb.set_state(False, False) # don't send signal
>>> changes
["A True 'user_a'", 'B True', 'B False', 'B True']

toggle_state(self)

Cycle to the next valid state.
 
>>> cb = CheckBox("3-state", has_mixed=True)
>>> cb.state
False
>>> cb.toggle_state()
>>> cb.state
True
>>> cb.toggle_state()
>>> cb.state
'mixed'
>>> cb.toggle_state()
>>> cb.state
False

label

Return label text.
 
>>> cb = CheckBox("Seriously")
>>> cb.get_label()
'Seriously'
>>> cb.label  # Urwid 0.9.9 or later
'Seriously'
>>> cb.set_label([('bright_attr', "flashy"), " normal"])
>>> cb.label  #  only text is returned 
'flashy normal'

state

Return the state of the checkbox.

reserve_columns = 4

signals = ['change']

states = {False: <SelectableIcon selectable flow widget '[ ]'>, True: <SelectableIcon selectable flow widget '[X]'>, 'mixed': <SelectableIcon selectable flow widget '[#]'>}

render(self, size, focus=False)

Render self._w.

get_cursor_coords

get_pref_col

move_cursor_to_coords

rows

selectable

sizing

w

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function RadioButton [back to top]

class RadioButton(CheckBox) [back to top]

Method resolution order:

RadioButton

CheckBox

WidgetWrap

Widget

object

__init__(self, group, label, state='first True', on_state_change=None, user_data=None)

group -- list for radio buttons in same group
label -- markup for radio button label
state -- False, True, "mixed" or "first True"
on_state_change, user_data -- shorthand for connect_signal()
    function call for a single 'change' callback
 
This function will append the new radio button to group.
"first True" will set to True if group is empty.
 
Signals supported: 'change'
Register signal handler with:
  connect_signal(radio_button, 'change', callback [,user_data])
where callback is callback(radio_button, new_state [,user_data])
Unregister signal handlers with:
  disconnect_signal(radio_button, 'change', callback [,user_data])
 
>>> bgroup = [] # button group
>>> b1 = RadioButton(bgroup, "Agree")
>>> b2 = RadioButton(bgroup, "Disagree")
>>> len(bgroup)
2
>>> b1
<RadioButton selectable widget 'Agree' state=True>
>>> b2
<RadioButton selectable widget 'Disagree' state=False>
>>> b2.render((15,), focus=True).text  # preview RadioButton
['( ) Disagree   ']

set_state(self, state, do_callback=True)

Set the RadioButton state.
 
state -- True, False or "mixed"
do_callback -- False to supress signal from this change
 
If state is True all other radio buttons in the same button
group will be set to False.
 
>>> bgroup = [] # button group
>>> b1 = RadioButton(bgroup, "Agree")
>>> b2 = RadioButton(bgroup, "Disagree")
>>> b3 = RadioButton(bgroup, "Unsure")
>>> b1.state, b2.state, b3.state
(True, False, False)
>>> b2.set_state(True)
>>> b1.state, b2.state, b3.state
(False, True, False)
>>> def relabel_button(radio_button, new_state):
...     radio_button.set_label("Think Harder!")
>>> connect_signal(b3, 'change', relabel_button)
>>> b3
<RadioButton selectable widget 'Unsure' state=False>
>>> b3.set_state(True) # this will trigger the callback
>>> b3
<RadioButton selectable widget 'Think Harder!' state=True>

toggle_state(self)

Set state to True.
 
>>> bgroup = [] # button group
>>> b1 = RadioButton(bgroup, "Agree")
>>> b2 = RadioButton(bgroup, "Disagree")
>>> b1.state, b2.state
(True, False)
>>> b2.toggle_state()
>>> b1.state, b2.state
(False, True)
>>> b2.toggle_state()
>>> b1.state, b2.state
(False, True)

reserve_columns = 4

states = {False: <SelectableIcon selectable flow widget '( )'>, True: <SelectableIcon selectable flow widget '(X)'>, 'mixed': <SelectableIcon selectable flow widget '(#)'>}

get_label(self)

Return label text.
 
>>> cb = CheckBox("Seriously")
>>> cb.get_label()
'Seriously'
>>> cb.label  # Urwid 0.9.9 or later
'Seriously'
>>> cb.set_label([('bright_attr', "flashy"), " normal"])
>>> cb.label  #  only text is returned 
'flashy normal'

get_state(self)

Return the state of the checkbox.

keypress(self, size, key)

Toggle state on 'activate' command.  
 
>>> assert command_map[' '] == 'activate'
>>> assert command_map['enter'] == 'activate'
>>> size = (10,)
>>> cb = CheckBox('press me')
>>> cb.state
False
>>> cb.keypress(size, ' ')
>>> cb.state
True
>>> cb.keypress(size, ' ')
>>> cb.state
False

mouse_event(self, size, event, button, x, y, focus)

Toggle state on button 1 press.
 
>>> size = (20,)
>>> cb = CheckBox("clickme")
>>> cb.state
False
>>> cb.mouse_event(size, 'mouse press', 1, 2, 0, True)
True
>>> cb.state
True

set_label(self, label)

Change the check box label.
 
label -- markup for label.  See Text widget for description
of text markup.
 
>>> cb = CheckBox("foo")
>>> cb
<CheckBox selectable widget 'foo' state=False>
>>> cb.set_label(('bright_attr', "bar"))
>>> cb
<CheckBox selectable widget 'bar' state=False>

label

Return label text.
 
>>> cb = CheckBox("Seriously")
>>> cb.get_label()
'Seriously'
>>> cb.label  # Urwid 0.9.9 or later
'Seriously'
>>> cb.set_label([('bright_attr', "flashy"), " normal"])
>>> cb.label  #  only text is returned 
'flashy normal'

state

Return the state of the checkbox.

signals = ['change']

render(self, size, focus=False)

Render self._w.

get_cursor_coords

get_pref_col

move_cursor_to_coords

rows

selectable

sizing

w

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

Graphics

function BarGraph [back to top]

class BarGraph(BoxWidget) [back to top]

Method resolution order:

BarGraph

BoxWidget

Widget

object

__init__(self, attlist, hatt=None, satt=None)

Create a bar graph with the passed display characteristics.
see set_segment_attributes for a description of the parameters.

calculate_bar_widths(self, size, bardata)

Return a list of bar widths, one for each bar in data.
 
If self.bar_width is None this implementation will stretch 
the bars across the available space specified by maxcol.

calculate_display(self, size)

Calculate display data.

hlines_display(self, disp, top, hlines, maxrow)

Add hlines to display structure represented as bar_type tuple
values:
(bg, 0-5)
bg is the segment that has the hline on it
0-5 is the hline graphic to use where 0 is a regular underscore
and 1-5 are the UTF-8 horizontal scan line characters.

render(self, size, focus=False)

Render BarGraph.

selectable(self)

Return False.

set_bar_width(self, width)

Set a preferred bar width for calculate_bar_widths to use.
 
width -- width of bar or None for automatic width adjustment

set_data(self, bardata, top, hlines=None)

Store bar data, bargraph top and horizontal line positions.
 
bardata -- a list of bar values.
top -- maximum value for segments within bardata
hlines -- None or a bar value marking horizontal line positions
 
bar values are [ segment1, segment2, ... ] lists where top is 
the maximal value corresponding to the top of the bar graph and
segment1, segment2, ... are the values for the top of each 
segment of this bar.  Simple bar graphs will only have one
segment in each bar value.
 
Eg: if top is 100 and there is a bar value of [ 80, 30 ] then
the top of this bar will be at 80% of full height of the graph
and it will have a second segment that starts at 30%.

set_segment_attributes(self, attlist, hatt=None, satt=None)

attlist -- list containing attribute or (attribute, character)
    tuple for background, first segment, and optionally
    following segments. ie. len(attlist) == num segments+1
    character defaults to ' ' if not specified.
hatt -- list containing attributes for horizontal lines. First 
    lement is for lines on background, second is for lines
           on first segment, third is for lines on second segment
    etc..
satt -- dictionary containing attributes for smoothed 
    transitions of bars in UTF-8 display mode. The values
    are in the form:
        (fg,bg) : attr
    fg and bg are integers where 0 is the graph background,
    1 is the first segment, 2 is the second, ...  
    fg > bg in all values.  attr is an attribute with a 
    foreground corresponding to fg and a background 
    corresponding to bg.
    
If satt is not None and the bar graph is being displayed in
a terminal using the UTF-8 encoding then the character cell
that is shared between the segments specified will be smoothed
with using the UTF-8 vertical eighth characters.
 
eg: set_segment_attributes( ['no', ('unsure',"?"), 'yes'] )
will use the attribute 'no' for the background (the area from
the top of the graph to the top of the bar), question marks 
with the attribute 'unsure' will be used for the topmost 
segment of the bar, and the attribute 'yes' will be used for
the bottom segment of the bar.

smooth_display(self, disp)

smooth (col, row*8) display into (col, row) display using
UTF vertical eighth characters represented as bar_type
tuple values:
( fg, bg, 1-7 )
where fg is the lower segment, bg is the upper segment and
1-7 is the vertical eighth character to use.

use_smoothed(self)

get_data

__metaclass__ = <class 'urwid.graphics.BarGraphMeta'>

Detect subclass get_data() method and dynamic change to
get_data() method and disable caching in these cases.
 
This is for backwards compatibility only, new programs
should use set_data() instead of overriding get_data().

eighths = u' \u2581\u2582\u2583\u2584\u2585\u2586\u2587'

hlines = u'_\u23ba\u23bb\u2500\u23bc\u23bd'

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

function GraphVScale [back to top]

class GraphVScale(BoxWidget) [back to top]

Method resolution order:

GraphVScale

BoxWidget

Widget

object

__init__(self, labels, top)

GraphVScale( [(label1 position, label1 markup),...], top )
label position -- 0 < position < top for the y position
label markup -- text markup for this label
top -- top y position
 
This widget is a vertical scale for the BarGraph widget that
can correspond to the BarGraph's horizontal lines

render(self, size, focus=False)

Render GraphVScale.

selectable(self)

Return False.

set_scale(self, labels, top)

set_scale( [(label1 position, label1 markup),...], top )
label position -- 0 < position < top for the y position
label markup -- text markup for this label
top -- top y position

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function ProgressBar [back to top]

class ProgressBar(FlowWidget) [back to top]

Method resolution order:

ProgressBar

FlowWidget

Widget

object

__init__(self, normal, complete, current=0, done=100, satt=None)

normal -- attribute for uncomplete part of progress bar
complete -- attribute for complete part of progress bar
current -- current progress
done -- progress amount at 100%
satt -- attribute for smoothed part of bar where the foreground
    of satt corresponds to the normal part and the
    background corresponds to the complete part.  If satt
    is None then no smoothing will be done.

render(self, size, focus=False)

Render the progress bar.

rows(self, size, focus=False)

Return 1.

set_completion(self, current)

current -- current progress

eighths = u' \u258f\u258e\u258d\u258c\u258b\u258a\u2589'

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function BigText [back to top]

class BigText(FixedWidget) [back to top]

Method resolution order:

BigText

FixedWidget

Widget

object

__init__(self, markup, font)

markup -- same as Text widget markup
font -- instance of a Font class

get_text(self)

Returns (text, attributes).

pack(self, size=None, focus=False)

render(self, size, focus=False)

set_font(self, font)

set_text(self, markup)

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function get_all_fonts [back to top]

get_all_fonts()

Return a list of (font name, font class) tuples.

Build custom widgets

function WidgetWrap [back to top]

class WidgetWrap(Widget) [back to top]

Method resolution order:

WidgetWrap

Widget

object

__init__(self, w)

w -- widget to wrap, stored as self._w
 
This object will pass the functions defined in Widget interface
definition to self._w.
 
The purpose of this widget is to provide a base class for
widgets that compose other widgets for their display and
behaviour.  The details of that composition should not affect
users of the subclass.  The subclass may decide to expose some
of the wrapped widgets by behaving like a ContainerWidget or
WidgetDecoration, or it may hide them from outside access.

render(self, size, focus=False)

Render self._w.

get_cursor_coords

get_pref_col

keypress

mouse_event

move_cursor_to_coords

rows

selectable

sizing

w

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

Abstract widgets & interfaces

Widget interface definition [back to top]

get_cursor_coords(self, size)

size -- flow widgets: (maxcol,)  box widgets: (maxcol,maxrow)
        where maxcol and maxrow are the maximum screen columns
    and rows for the widget when rendered
    
Returns (col,row) coordinates for cursor or None if no cursor.
 
MUST be implemented if render function returns a canvas with
a cursor.  
MUST match the cursor in the canvas returned by render function
when focus=True.
Caller MUST treat no implementation as equivalent to an 
implementation that always returns None.

get_pref_col(self, size)

size -- flow widgets: (maxcol,)  box widgets: (maxcol,maxrow)
        where maxcol and maxrow are the maximum screen columns
    and rows for the widget when rendered
    
Returns the preferred screen column as an integer or None.
 
Caller MUST treat no implementation as equivalent to an 
implementation that always returns None.

keypress(self, size, key)

size -- flow widgets: (maxcol,)  box widgets: (maxcol,maxrow)
        where maxcol and maxrow are the maximum screen columns
    and rows for the widget when rendered
key -- key pressed
 
Returns None if key was handled, returns key if not handled.
 
MUST be implemented if selectable function returns True.
MUST NOT be called if selectable function returns False.

mouse_event(self, size, event, button, col, row, focus)

size -- flow widgets: (maxcol,)  box widgets: (maxcol,maxrow)
        where maxcol and maxrow are the maximum screen columns
    and rows for the widget when rendered
event -- event part of mouse event structure, eg. 'press',
         'release', 'drag', 'meta press' etc..
button -- button number for event between 1 and 5, may be 0
          on button release events if button is unknown
col -- screen column of event, relative to left edge of widget
row -- screen row of event, relative to top edge of widget
focus -- True if this widget is in focus
 
Returns True if event was handled, False otherwise.
 
Caller MUST treat no implementation as equivalent to an
implementation that always returns False.

move_cursor_to_coords(self, size, col, row)

size -- flow widgets: (maxcol,)  box widgets: (maxcol,maxrow)
        where maxcol and maxrow are the maximum screen columns
    and rows for the widget when rendered
col -- desired screen column for cursor to appear, relative
       to left edge of widget
row -- desired screen row for cursor to appear, relative to
       top edge of widget
    
Returns True on success, False on failure.
 
MUST succeed if there is any column on passed row that the
cursor may be moved to.
Caller MUST treat no implementation as equivalent to an
implementation that always returns True.

render(self, size, focus=False)

size -- flow widgets: (maxcol,)  box widgets: (maxcol,maxrow)
        where maxcol and maxrow are the maximum screen columns
    and rows for the canvas returned
focus -- True if this widget is in focus
 
Returns a canvas object.
 
MUST be implemented.
MUST NOT return a canvas with a cursor when focus=False.

rows(self, (maxcol,), focus=False)

maxcol -- maximum screen columns for rendered widget
focus -- True if this widget is in focus
 
Returns an integer number or screen rows required.
 
MUST be implemented by all flow widgets.
MUST match the number of rows in the canvas returned by
render function called with the same parameters.

selectable(self)

Returns True if this widget will accept keyboard input and
should take the focus when changing focus between widgets.
 
MUST be implemented.

function Widget [back to top]

class Widget(object) [back to top]

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function BoxWidget [back to top]

class BoxWidget(Widget) [back to top]

Method resolution order:

BoxWidget

Widget

object

render(self, size, focus=False)

All widgets must implement this function.

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function FlowWidget [back to top]

class FlowWidget(Widget) [back to top]

Method resolution order:

FlowWidget

Widget

object

render(self, size, focus=False)

All widgets must implement this function.

rows(self, size, focus=False)

All flow widgets must implement this function.

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function FixedWidget [back to top]

class FixedWidget(Widget) [back to top]

Method resolution order:

FixedWidget

Widget

object

pack(self, size=None, focus=False)

All fixed widgets must implement this function.

render(self, size, focus=False)

All widgets must implement this function.

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

selectable(self)

Return True if this widget should take focus.  Default
implementation returns the value of self._selectable.

sizing(self)

Return a set including one or more of 'box', 'flow' and
'fixed'.  Default implementation returns the value of
self._sizing.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

base_widget

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

function WidgetDecoration [back to top]

class WidgetDecoration(Widget) [back to top]

Method resolution order:

WidgetDecoration

Widget

object

__init__(self, original_widget)

original_widget -- the widget being decorated
 
This is a base class for decoration widgets, widgets
that contain one or more widgets and only ever have
a single focus.  This type of widget will affect the
display or behaviour of the original_widget but it is
not part of determining a chain of focus.
 
Don't actually do this -- use a WidgetDecoration subclass
instead, these are not real widgets:
>>> WidgetDecoration(Text("hi"))
<WidgetDecoration flow widget <Text flow widget 'hi'>>

selectable(self)

sizing(self)

base_widget

Return the widget without decorations.  If there is only one
Decoration then this is the same as original_widget.
 
>>> t = Text('hello')
>>> wd1 = WidgetDecoration(t)
>>> wd2 = WidgetDecoration(wd1)
>>> wd3 = WidgetDecoration(wd2)
>>> wd3.original_widget is wd2
True
>>> wd3.base_widget is t
True

original_widget

__repr__ = split_repr(self)

Return a helpful description of the object using
_repr_words() and _repr_attrs() to add
to the description.  This function may be used by
adding code to your class like this:
 
>>> class Foo(object):
...     __repr__ = split_repr
...     def _repr_words(self):
...         return ["words", "here"]
...     def _repr_attrs(self):
...         return {'attrs': "appear too"}
>>> Foo()
<Foo words here attrs='appear too'>
>>> class Bar(Foo):
...     def _repr_words(self):
...         return Foo._repr_words(self) + ["too"]
...     def _repr_attrs(self):
...         return dict(Foo._repr_attrs(self), barttr=42)
>>> Bar()
<Bar words here too attrs='appear too' barttr=42>

pack(self, size, focus=False)

Return a 'packed' (maxcol, maxrow) for this widget.  Default 
implementation (no packing defined) returns size, and
calculates maxrow if not given.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.widget.WidgetMeta'>

Automatic caching of render and rows methods.
 
Class variable no_cache is a list of names of methods to not cache.
Class variable ignore_focus if defined and True indicates that this
widget is not affected by the focus parameter, so it may be ignored
when caching.

List Walker interface definition [back to top]

get_focus(self)

Returns (widget, position).
 
MUST be implemented.
Caller MUST NOT assume that position object may be stored and
reused after contents of list change.

get_next(self, position)

position -- a position returned by get_focus or get_next
 
Returns (widget below, position below).
 
MUST be implemented.
Caller MUST NOT assume that position object may be stored and
reused after contents of list change.

get_prev(self, position)

position -- a position returned by get_focus or get_prev
 
Returns (widget above, position above).
 
MUST be implemented.
Caller MUST NOT assume that position object may be stored and
reused after contents of list change.

set_focus(self, position)

position -- a position returned by get_focus, get_next or
            get_prev
 
Returns None.
 
MUST be implemented.  Should send "modified" signal (or call
self._modified if inheriting from ListWalker)

function ListWalker [back to top]

class ListWalker(object) [back to top]

__hash__(self)

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__metaclass__ = <class 'urwid.signals.MetaSignals'>

register the list of signals in the class varable signals,
including signals in superclasses.

signals = ['modified']

ListBox list walkers

function PollingListWalker [back to top]

class PollingListWalker(object) [back to top]

__init__(self, contents)

contents -- list to poll for changes

get_focus(self)

Return (focus widget, focus position).

get_next(self, start_from)

Return (widget after start_from, position after start_from).

get_prev(self, start_from)

Return (widget before start_from, position before start_from).

set_focus(self, position)

Set focus position.

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

function SimpleListWalker [back to top]

class SimpleListWalker(MonitoredList, ListWalker) [back to top]

Method resolution order:

SimpleListWalker

MonitoredList

list

ListWalker

object

__hash__(self)

__init__(self, contents)

contents -- list to copy into this object
 
Changes made to this object (when it is treated as a list) are
detected automatically and will cause ListBox objects using
this list walker to be updated.

get_focus(self)

Return (focus widget, focus position).

get_next(self, start_from)

Return (widget after start_from, position after start_from).

get_prev(self, start_from)

Return (widget before start_from, position before start_from).

set_focus(self, position)

Set focus position.

set_modified_callback(self, callback)

This function inherited from MonitoredList is not 
implemented in SimleListWalker.
 
Use connect_signal(list_walker, "modified", ...) instead.

contents

Return self.
 
Provides compatibility with old SimpleListWalker class.

__add__ = call_modified_wrapper(self, *args, **kwargs)

__delitem__ = call_modified_wrapper(self, *args, **kwargs)

__delslice__ = call_modified_wrapper(self, *args, **kwargs)

__iadd__ = call_modified_wrapper(self, *args, **kwargs)

__imul__ = call_modified_wrapper(self, *args, **kwargs)

__repr__(self)

__rmul__ = call_modified_wrapper(self, *args, **kwargs)

__setitem__ = call_modified_wrapper(self, *args, **kwargs)

__setslice__ = call_modified_wrapper(self, *args, **kwargs)

append = call_modified_wrapper(self, *args, **kwargs)

extend = call_modified_wrapper(self, *args, **kwargs)

insert = call_modified_wrapper(self, *args, **kwargs)

pop = call_modified_wrapper(self, *args, **kwargs)

remove = call_modified_wrapper(self, *args, **kwargs)

reverse = call_modified_wrapper(self, *args, **kwargs)

sort = call_modified_wrapper(self, *args, **kwargs)

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

__contains__(...)

x.__contains__(y) <==> y in x

__eq__(...)

x.__eq__(y) <==> x==y

__ge__(...)

x.__ge__(y) <==> x>=y

__getattribute__(...)

x.__getattribute__('name') <==> x.name

__getitem__(...)

x.__getitem__(y) <==> x[y]

__getslice__(...)

x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.

__gt__(...)

x.__gt__(y) <==> x>y

__iter__(...)

x.__iter__() <==> iter(x)

__le__(...)

x.__le__(y) <==> x<=y

__len__(...)

x.__len__() <==> len(x)

__lt__(...)

x.__lt__(y) <==> x<y

__mul__(...)

x.__mul__(n) <==> x*n

__ne__(...)

x.__ne__(y) <==> x!=y

__reversed__(...)

L.__reversed__() -- return a reverse iterator over the list

__sizeof__(...)

L.__sizeof__() -- size of L in memory, in bytes

count(...)

L.count(value) -> integer -- return number of occurrences of value

index(...)

L.index(value, [start, [stop]]) -> integer -- return first index of value.
Raises ValueError if the value is not present.

__new__ = <built-in method __new__ of type object at 0x8187c0>

T.__new__(S, ...) -> a new object with type S, a subtype of T

__metaclass__ = <class 'urwid.signals.MetaSignals'>

register the list of signals in the class varable signals,
including signals in superclasses.

signals = ['modified']

Canvas painting

function Canvas [back to top]

class Canvas(object) [back to top]

__init__(self, value1=None, value2=None, value3=None)

value1, value2, value3 -- if not None, raise a helpful error:
    the old Canvas class is now called TextCanvas.

cols(self)

content(self, trim_left=0, trim_top=0, cols=None, rows=None, attr=None)

content_delta(self)

finalize(self, widget, size, focus)

Mark this canvas as finalized (should not be any future
changes to its content). This is required before caching
the canvas.  This happens automatically after a widget's
'render call returns the canvas thanks to some metaclass
magic.
 
widget -- widget that rendered this canvas
size -- size parameter passed to widget's render method
focus -- focus parameter passed to widget's render method

get_cursor(self)

rows(self)

set_cursor(self, c)

translate_coords(self, dx, dy)

Return coords shifted by (dx, dy).

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

attr

cs

cursor

text

Return the text content of the canvas as a list of strings,
one for each row.

widget_info

function TextCanvas [back to top]

class TextCanvas(Canvas) [back to top]

Method resolution order:

TextCanvas

Canvas

object

__init__(self, text=None, attr=None, cs=None, cursor=None, maxcol=None, check_width=True)

text -- list of strings, one for each line
attr -- list of run length encoded attributes for text
cs -- list of run length encoded character set for text
cursor -- (x,y) of cursor or None
maxcol -- screen columns taken by this canvas
check_width -- check and fix width of all lines in text

cols(self)

Return the screen column width of this canvas.

content(self, trim_left=0, trim_top=0, cols=None, rows=None, attr_map=None)

Return the canvas content as a list of rows where each row
is a list of (attr, cs, text) tuples.
 
trim_left, trim_top, cols, rows may be set by 
CompositeCanvas when rendering a partially obscured
canvas.

content_delta(self, other)

Return the differences between other and this canvas.
 
If other is the same object as self this will return no 
differences, otherwise this is the same as calling 
content().

rows(self)

Return the number of rows in this canvas.

translated_coords(self, dx, dy)

Return cursor coords shifted by (dx, dy), or None if there
is no cursor.

finalize(self, widget, size, focus)

Mark this canvas as finalized (should not be any future
changes to its content). This is required before caching
the canvas.  This happens automatically after a widget's
'render call returns the canvas thanks to some metaclass
magic.
 
widget -- widget that rendered this canvas
size -- size parameter passed to widget's render method
focus -- focus parameter passed to widget's render method

get_cursor(self)

set_cursor(self, c)

translate_coords(self, dx, dy)

Return coords shifted by (dx, dy).

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

attr

cs

cursor

text

Return the text content of the canvas as a list of strings,
one for each row.

widget_info

function CompositeCanvas [back to top]

class CompositeCanvas(Canvas) [back to top]

Method resolution order:

CompositeCanvas

Canvas

object

__init__(self, canv=None)

canv -- a Canvas object to wrap this CompositeCanvas around.
 
if canv is a CompositeCanvas, make a copy of its contents

cols(self)

content(self)

Return the canvas content as a list of rows where each row
is a list of (attr, cs, text) tuples.

content_delta(self, other)

Return the differences between other and this canvas.

fill_attr(self, a)

Apply attribute a to all areas of this canvas with default
attribute currently set to None, leaving other attributes
intact.

fill_attr_apply(self, mapping)

Apply an attribute-mapping dictionary to the canvas.
 
mapping -- dictionary of original-attribute:new-attribute items

overlay(self, other, left, top)

Overlay other onto this canvas.

pad_trim_left_right(self, left, right)

Pad or trim this canvas on the left and right
 
values > 0 indicate screen columns to pad
values < 0 indicate screen columns to trim

pad_trim_top_bottom(self, top, bottom)

Pad or trim this canvas on the top and bottom.

rows(self)

set_depends(self, widget_list)

Explicitly specify the list of widgets that this canvas
depends on.  If any of these widgets change this canvas
will have to be updated.

trim(self, top, count=None)

Trim lines from the top and/or bottom of canvas.
 
top -- number of lines to remove from top
count -- number of lines to keep, or None for all the rest

trim_end(self, end)

Trim lines from the bottom of the canvas.
 
end -- number of lines to remove from the end

finalize(self, widget, size, focus)

Mark this canvas as finalized (should not be any future
changes to its content). This is required before caching
the canvas.  This happens automatically after a widget's
'render call returns the canvas thanks to some metaclass
magic.
 
widget -- widget that rendered this canvas
size -- size parameter passed to widget's render method
focus -- focus parameter passed to widget's render method

get_cursor(self)

set_cursor(self, c)

translate_coords(self, dx, dy)

Return coords shifted by (dx, dy).

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

attr

cs

cursor

text

Return the text content of the canvas as a list of strings,
one for each row.

widget_info

function SolidCanvas [back to top]

class SolidCanvas(Canvas) [back to top]

Method resolution order:

SolidCanvas

Canvas

object

__init__(self, fill_char, cols, rows)

cols(self)

content(self, trim_left=0, trim_top=0, cols=None, rows=None, attr=None)

content_delta(self, other)

Return the differences between other and this canvas.

rows(self)

finalize(self, widget, size, focus)

Mark this canvas as finalized (should not be any future
changes to its content). This is required before caching
the canvas.  This happens automatically after a widget's
'render call returns the canvas thanks to some metaclass
magic.
 
widget -- widget that rendered this canvas
size -- size parameter passed to widget's render method
focus -- focus parameter passed to widget's render method

get_cursor(self)

set_cursor(self, c)

translate_coords(self, dx, dy)

Return coords shifted by (dx, dy).

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

attr

cs

cursor

text

Return the text content of the canvas as a list of strings,
one for each row.

widget_info

function CanvasCombine [back to top]

CanvasCombine(l)

Stack canvases in l vertically and return resulting canvas.
 
l -- list of (canvas, position, focus) tuples.  position is a value
     that widget.set_focus will accept, or None if not allowed.
     focus is True if this canvas is the one that would be in focus
     if the whole widget is in focus.

function CanvasJoin [back to top]

CanvasJoin(l)

Join canvases in l horizontally. Return result.
l -- list of (canvas, position, focus, cols) tuples.  position is a 
     value that widget.set_focus will accept,  or None if not allowed.
     focus is True if this canvas is the one that would be in focus if
     the whole widget is in focus.  cols is the number of screen
     columns that this widget will require, if larger than the actual
     canvas.cols() value then this widget will be padded on the right.

function CanvasOverlay [back to top]

CanvasOverlay(top_c, bottom_c, left, top)

Overlay canvas top_c onto bottom_c at position (left, top).

Raw screen attributes

function AttrSpec [back to top]

class AttrSpec(object) [back to top]

__init__(self, fg, bg, colors=256)

fg -- a string containing a comma-separated foreground color
      and settings
 
      Color values:
      'default' (use the terminal's default foreground),
      'black', 'dark red', 'dark green', 'brown', 'dark blue',
      'dark magenta', 'dark cyan', 'light gray', 'dark gray',
      'light red', 'light green', 'yellow', 'light blue', 
      'light magenta', 'light cyan', 'white'
 
      High-color example values:
      '#009' (0% red, 0% green, 60% red, like HTML colors)
      '#fcc' (100% red, 80% green, 80% blue)
      'g40' (40% gray, decimal), 'g#cc' (80% gray, hex),
      '#000', 'g0', 'g#00' (black),
      '#fff', 'g100', 'g#ff' (white)
      'h8' (color number 8), 'h255' (color number 255)
 
      Setting:
      'bold', 'underline', 'blink', 'standout'
 
      Some terminals use 'bold' for bright colors.  Most terminals
      ignore the 'blink' setting.  If the color is not given then
      'default' will be assumed.
 
bg -- a string containing the background color
 
      Color values:
      'default' (use the terminal's default background),
      'black', 'dark red', 'dark green', 'brown', 'dark blue',
      'dark magenta', 'dark cyan', 'light gray'
 
      High-color exaples:
      see fg examples above
 
      An empty string will be treated the same as 'default'.
 
colors -- the maximum colors available for the specification
 
           Valid values include: 1, 16, 88 and 256.  High-color 
           values are only usable with 88 or 256 colors.  With
           1 color only the foreground settings may be used.
 
>>> AttrSpec('dark red', 'light gray', 16)
AttrSpec('dark red', 'light gray')
>>> AttrSpec('yellow, underline, bold', 'dark blue')
AttrSpec('yellow,bold,underline', 'dark blue')
>>> AttrSpec('#ddb', '#004', 256) # closest colors will be found
AttrSpec('#dda', '#006')
>>> AttrSpec('#ddb', '#004', 88)
AttrSpec('#ccc', '#000', colors=88)

__repr__(self)

Return an executable python representation of the AttrSpec
object.

get_rgb_values(self)

Return (fg_red, fg_green, fg_blue, bg_red, bg_green, bg_blue) color
components.  Each component is in the range 0-255.  Values are taken
from the XTerm defaults and may not exactly match the user's terminal.
 
If the foreground or background is 'default' then all their compenents
will be returned as None.
 
>>> AttrSpec('yellow', '#ccf', colors=88).get_rgb_values()
(255, 255, 0, 205, 205, 255)
>>> AttrSpec('default', 'g92').get_rgb_values()
(None, None, None, 238, 238, 238)

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

background

Return the background color.

background_basic

background_high

background_number

bold

colors

Return the maximum colors required for this object.
 
Returns 256, 88, 16 or 1.

foreground

foreground_basic

foreground_high

foreground_number

standout

underline

Custom formatting rules

class TextLayout [back to top]

layout(self, text, width, align, wrap)

Return a layout structure for text.
 
text -- string in current encoding or unicode string
width -- number of screen columns available
align -- align mode for text
wrap -- wrap mode for text
 
Layout structure is a list of line layouts, one per output line.
Line layouts are lists than may contain the following tuples:
  ( column width of text segment, start offset, end offset )
  ( number of space characters to insert, offset or None)
  ( column width of insert text, offset, "insert text" )
 
The offset in the last two tuples is used to determine the
attribute used for the inserted spaces or text respectively.  
The attribute used will be the same as the attribute at that 
text offset.  If the offset is None when inserting spaces
then no attribute will be used.

supports_align_mode(self, align)

Return True if align is a supported align mode.

supports_wrap_mode(self, wrap)

Return True if wrap is a supported wrap mode.

class StandardTextLayout(TextLayout) [back to top]

__init__(self)

align_layout(self, text, width, segs, wrap, align)

Convert the layout segs to an aligned layout.

calculate_text_segments(self, text, width, wrap)

Calculate the segments of text to display given width screen 
columns to display them.  
 
text - text to display
width - number of available screen columns
wrap - wrapping mode used
 
Returns a layout structure without aligmnent applied.

layout(self, text, width, align, wrap)

Return a layout structure for text.

pack(self, maxcol, layout)

Return a minimal maxcol value that would result in the same
number of lines for layout.  layout must be a layout structure
returned by layout().

supports_align_mode(self, align)

Return True if align is 'left', 'center' or 'right'.

supports_wrap_mode(self, wrap)

Return True if wrap is 'any', 'space' or 'clip'.

Character encoding

function set_encoding [back to top]

set_encoding(encoding)

Set the byte encoding to assume when processing strings and the
encoding to use when converting unicode strings.

function get_encoding_mode [back to top]

get_encoding_mode()

Get the mode Urwid is using when processing text strings.
Returns 'narrow' for 8-bit encodings, 'wide' for CJK encodings
or 'utf8' for UTF-8 encodings.