reference.html

Urwid is a Python library for making text console applications. It has many features including fluid

<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<a name="curses_display.Screen"></a><h3>function curses_display.Screen <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="curses_display.Screen"></a><strong>curses_display.Screen</strong> <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3>Methods defined here:<br>
<dl><dt><a name="Screen-__init__"><strong>__init__</strong></a>(self)</dt></dl>

<dl><dt><a name="Screen-clear"><strong>clear</strong></a>(self)</dt><dd><tt>Force&nbsp;the&nbsp;screen&nbsp;to&nbsp;be&nbsp;completely&nbsp;repainted&nbsp;on&nbsp;the&nbsp;next<br>
call&nbsp;to&nbsp;draw_screen().</tt></dd></dl>

<dl><dt><a name="Screen-draw_screen"><strong>draw_screen</strong></a>(self, (cols, rows), r)</dt><dd><tt>Paint&nbsp;screen&nbsp;with&nbsp;rendered&nbsp;canvas.</tt></dd></dl>

<dl><dt><a name="Screen-get_cols_rows"><strong>get_cols_rows</strong></a>(self)</dt><dd><tt>Return&nbsp;the&nbsp;terminal&nbsp;dimensions&nbsp;(num&nbsp;columns,&nbsp;num&nbsp;rows).</tt></dd></dl>

<dl><dt><a name="Screen-get_input"><strong>get_input</strong></a>(self, raw_keys<font color="#909090">=False</font>)</dt><dd><tt>Return&nbsp;pending&nbsp;input&nbsp;as&nbsp;a&nbsp;list.<br>
&nbsp;<br>
raw_keys&nbsp;--&nbsp;return&nbsp;raw&nbsp;keycodes&nbsp;as&nbsp;well&nbsp;as&nbsp;translated&nbsp;versions<br>
&nbsp;<br>
This&nbsp;function&nbsp;will&nbsp;immediately&nbsp;return&nbsp;all&nbsp;the&nbsp;input&nbsp;since&nbsp;the<br>
last&nbsp;time&nbsp;it&nbsp;was&nbsp;called.&nbsp;&nbsp;If&nbsp;there&nbsp;is&nbsp;no&nbsp;input&nbsp;pending&nbsp;it&nbsp;will<br>
wait&nbsp;before&nbsp;returning&nbsp;an&nbsp;empty&nbsp;list.&nbsp;&nbsp;The&nbsp;wait&nbsp;time&nbsp;may&nbsp;be<br>
configured&nbsp;with&nbsp;the&nbsp;set_input_timeouts&nbsp;function.<br>
&nbsp;<br>
If&nbsp;raw_keys&nbsp;is&nbsp;False&nbsp;(default)&nbsp;this&nbsp;function&nbsp;will&nbsp;return&nbsp;a&nbsp;list<br>
of&nbsp;keys&nbsp;pressed.&nbsp;&nbsp;If&nbsp;raw_keys&nbsp;is&nbsp;True&nbsp;this&nbsp;function&nbsp;will&nbsp;return<br>
a&nbsp;(&nbsp;keys&nbsp;pressed,&nbsp;raw&nbsp;keycodes&nbsp;)&nbsp;tuple&nbsp;instead.<br>
&nbsp;<br>
Examples&nbsp;of&nbsp;keys&nbsp;returned<br>
-------------------------<br>
ASCII&nbsp;printable&nbsp;characters:&nbsp;&nbsp;"&nbsp;",&nbsp;"a",&nbsp;"0",&nbsp;"A",&nbsp;"-",&nbsp;"/"&nbsp;<br>
ASCII&nbsp;control&nbsp;characters:&nbsp;&nbsp;"tab",&nbsp;"enter"<br>
Escape&nbsp;sequences:&nbsp;&nbsp;"up",&nbsp;"page&nbsp;up",&nbsp;"home",&nbsp;"insert",&nbsp;"f1"<br>
Key&nbsp;combinations:&nbsp;&nbsp;"shift&nbsp;f1",&nbsp;"meta&nbsp;a",&nbsp;"ctrl&nbsp;b"<br>
Window&nbsp;events:&nbsp;&nbsp;"window&nbsp;resize"<br>
&nbsp;<br>
When&nbsp;a&nbsp;narrow&nbsp;encoding&nbsp;is&nbsp;not&nbsp;enabled<br>
"Extended&nbsp;ASCII"&nbsp;characters:&nbsp;&nbsp;"\xa1",&nbsp;"\xb2",&nbsp;"\xfe"<br>
&nbsp;<br>
When&nbsp;a&nbsp;wide&nbsp;encoding&nbsp;is&nbsp;enabled<br>
Double-byte&nbsp;characters:&nbsp;&nbsp;"\xa1\xea",&nbsp;"\xb2\xd4"<br>
&nbsp;<br>
When&nbsp;utf8&nbsp;encoding&nbsp;is&nbsp;enabled<br>
Unicode&nbsp;characters:&nbsp;u"\u00a5",&nbsp;u'\u253c"<br>
&nbsp;<br>
Examples&nbsp;of&nbsp;mouse&nbsp;events&nbsp;returned<br>
---------------------------------<br>
Mouse&nbsp;button&nbsp;press:&nbsp;('mouse&nbsp;press',&nbsp;1,&nbsp;15,&nbsp;13),&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;('meta&nbsp;mouse&nbsp;press',&nbsp;2,&nbsp;17,&nbsp;23)<br>
Mouse&nbsp;button&nbsp;release:&nbsp;('mouse&nbsp;release',&nbsp;0,&nbsp;18,&nbsp;13),<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;('ctrl&nbsp;mouse&nbsp;release',&nbsp;0,&nbsp;17,&nbsp;23)</tt></dd></dl>

<dl><dt><a name="Screen-register_palette"><strong>register_palette</strong></a>(self, l)</dt><dd><tt>Register&nbsp;a&nbsp;list&nbsp;of&nbsp;palette&nbsp;entries.<br>
&nbsp;<br>
l&nbsp;--&nbsp;list&nbsp;of&nbsp;(name,&nbsp;foreground,&nbsp;background,&nbsp;mono),<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(name,&nbsp;foreground,&nbsp;background)&nbsp;or<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(name,&nbsp;same_as_other_name)&nbsp;palette&nbsp;entries.<br>
&nbsp;<br>
calls&nbsp;self.<strong>register_palette_entry</strong>&nbsp;for&nbsp;each&nbsp;item&nbsp;in&nbsp;l</tt></dd></dl>

<dl><dt><a name="Screen-register_palette_entry"><strong>register_palette_entry</strong></a>(self, name, foreground, background, mono<font color="#909090">=None</font>)</dt><dd><tt>Register&nbsp;a&nbsp;single&nbsp;palette&nbsp;entry.<br>
&nbsp;<br>
name&nbsp;--&nbsp;new&nbsp;entry/attribute&nbsp;name<br>
foreground&nbsp;--&nbsp;foreground&nbsp;colour,&nbsp;one&nbsp;of:&nbsp;'black',&nbsp;'dark&nbsp;red',<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'dark&nbsp;green',&nbsp;'brown',&nbsp;'dark&nbsp;blue',&nbsp;'dark&nbsp;magenta',<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'dark&nbsp;cyan',&nbsp;'light&nbsp;gray',&nbsp;'dark&nbsp;gray',&nbsp;'light&nbsp;red',<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'light&nbsp;green',&nbsp;'yellow',&nbsp;'light&nbsp;blue',&nbsp;'light&nbsp;magenta',<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'light&nbsp;cyan',&nbsp;'white',&nbsp;'default'&nbsp;(black&nbsp;if&nbsp;unable&nbsp;to<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;use&nbsp;terminal's&nbsp;default)<br>
background&nbsp;--&nbsp;background&nbsp;colour,&nbsp;one&nbsp;of:&nbsp;'black',&nbsp;'dark&nbsp;red',<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'dark&nbsp;green',&nbsp;'brown',&nbsp;'dark&nbsp;blue',&nbsp;'dark&nbsp;magenta',<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'dark&nbsp;cyan',&nbsp;'light&nbsp;gray',&nbsp;'default'&nbsp;(light&nbsp;gray&nbsp;if<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unable&nbsp;to&nbsp;use&nbsp;terminal's&nbsp;default)<br>
mono&nbsp;--&nbsp;monochrome&nbsp;terminal&nbsp;attribute,&nbsp;one&nbsp;of:&nbsp;None&nbsp;(default),<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'bold',&nbsp;'underline',&nbsp;'standout',&nbsp;or&nbsp;a&nbsp;tuple&nbsp;containing<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a&nbsp;combination&nbsp;eg.&nbsp;('bold','underline')</tt></dd></dl>

<dl><dt><a name="Screen-run_wrapper"><strong>run_wrapper</strong></a>(self, fn)</dt><dd><tt>Call&nbsp;fn&nbsp;in&nbsp;fullscreen&nbsp;mode.&nbsp;&nbsp;Return&nbsp;to&nbsp;normal&nbsp;on&nbsp;exit.<br>
&nbsp;<br>
This&nbsp;function&nbsp;should&nbsp;be&nbsp;called&nbsp;to&nbsp;wrap&nbsp;your&nbsp;main&nbsp;program&nbsp;loop.<br>
Exception&nbsp;tracebacks&nbsp;will&nbsp;be&nbsp;displayed&nbsp;in&nbsp;normal&nbsp;mode.</tt></dd></dl>

<dl><dt><a name="Screen-set_input_timeouts"><strong>set_input_timeouts</strong></a>(self, max_wait<font color="#909090">=0.5</font>, complete_wait<font color="#909090">=0.10000000000000001</font>, resize_wait<font color="#909090">=0.10000000000000001</font>)</dt><dd><tt>Set&nbsp;the&nbsp;get_input&nbsp;timeout&nbsp;values.&nbsp;&nbsp;All&nbsp;values&nbsp;have&nbsp;a&nbsp;granularity<br>
of&nbsp;0.1s,&nbsp;ie.&nbsp;any&nbsp;value&nbsp;between&nbsp;0.15&nbsp;and&nbsp;0.05&nbsp;will&nbsp;be&nbsp;treated&nbsp;as<br>
0.1&nbsp;and&nbsp;any&nbsp;value&nbsp;less&nbsp;than&nbsp;0.05&nbsp;will&nbsp;be&nbsp;treated&nbsp;as&nbsp;0.&nbsp;<br>
&nbsp;<br>
max_wait&nbsp;--&nbsp;amount&nbsp;of&nbsp;time&nbsp;in&nbsp;seconds&nbsp;to&nbsp;wait&nbsp;for&nbsp;input&nbsp;when<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;there&nbsp;is&nbsp;no&nbsp;input&nbsp;pending<br>
complete_wait&nbsp;--&nbsp;amount&nbsp;of&nbsp;time&nbsp;in&nbsp;seconds&nbsp;to&nbsp;wait&nbsp;when<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get_input&nbsp;detects&nbsp;an&nbsp;incomplete&nbsp;escape&nbsp;sequence&nbsp;at&nbsp;the<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;end&nbsp;of&nbsp;the&nbsp;available&nbsp;input<br>
resize_wait&nbsp;--&nbsp;amount&nbsp;of&nbsp;time&nbsp;in&nbsp;seconds&nbsp;to&nbsp;wait&nbsp;for&nbsp;more&nbsp;input<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;after&nbsp;receiving&nbsp;two&nbsp;screen&nbsp;resize&nbsp;requests&nbsp;in&nbsp;a&nbsp;row&nbsp;to<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;stop&nbsp;urwid&nbsp;from&nbsp;consuming&nbsp;100%&nbsp;cpu&nbsp;during&nbsp;a&nbsp;gradual<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;window&nbsp;resize&nbsp;operation</tt></dd></dl>

<dl><dt><a name="Screen-set_mouse_tracking"><strong>set_mouse_tracking</strong></a>(self)</dt><dd><tt>Enable&nbsp;mouse&nbsp;tracking.&nbsp;&nbsp;<br>
&nbsp;<br>
After&nbsp;calling&nbsp;this&nbsp;function&nbsp;get_input&nbsp;will&nbsp;include&nbsp;mouse<br>
click&nbsp;events&nbsp;along&nbsp;with&nbsp;keystrokes.</tt></dd></dl>

<dl><dt><a name="Screen-start"><strong>start</strong></a>(self)</dt><dd><tt>Initialize&nbsp;the&nbsp;screen&nbsp;and&nbsp;input&nbsp;mode.</tt></dd></dl>

<dl><dt><a name="Screen-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Restore&nbsp;the&nbsp;screen.</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<h3><a name="web_display.Screen"></a><strong>web_display.Screen</strong> <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3>Methods defined here:<br>
<dl><dt><a name="Screen-__init__"><strong>__init__</strong></a>(self)</dt></dl>

<dl><dt><a name="Screen-clear"><strong>clear</strong></a>(self)</dt><dd><tt>Force&nbsp;the&nbsp;screen&nbsp;to&nbsp;be&nbsp;completely&nbsp;repainted&nbsp;on&nbsp;the&nbsp;next<br>
call&nbsp;to&nbsp;draw_screen().<br>
&nbsp;<br>
(does&nbsp;nothing&nbsp;for&nbsp;web_display)</tt></dd></dl>

<dl><dt><a name="Screen-draw_screen"><strong>draw_screen</strong></a>(self, (cols, rows), r)</dt><dd><tt>Send&nbsp;a&nbsp;screen&nbsp;update&nbsp;to&nbsp;the&nbsp;client.</tt></dd></dl>

<dl><dt><a name="Screen-get_cols_rows"><strong>get_cols_rows</strong></a>(self)</dt><dd><tt>Return&nbsp;the&nbsp;screen&nbsp;size.</tt></dd></dl>

<dl><dt><a name="Screen-get_input"><strong>get_input</strong></a>(self, raw_keys<font color="#909090">=False</font>)</dt><dd><tt>Return&nbsp;pending&nbsp;input&nbsp;as&nbsp;a&nbsp;list.</tt></dd></dl>

<dl><dt><a name="Screen-register_palette"><strong>register_palette</strong></a>(self, l)</dt><dd><tt>Register&nbsp;a&nbsp;list&nbsp;of&nbsp;palette&nbsp;entries.<br>
&nbsp;<br>
l&nbsp;--&nbsp;list&nbsp;of&nbsp;(name,&nbsp;foreground,&nbsp;background)&nbsp;or<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(name,&nbsp;same_as_other_name)&nbsp;palette&nbsp;entries.<br>
&nbsp;<br>
calls&nbsp;self.<strong>register_palette_entry</strong>&nbsp;for&nbsp;each&nbsp;item&nbsp;in&nbsp;l</tt></dd></dl>

<dl><dt><a name="Screen-register_palette_entry"><strong>register_palette_entry</strong></a>(self, name, foreground, background, mono<font color="#909090">=None</font>)</dt><dd><tt>Register&nbsp;a&nbsp;single&nbsp;palette&nbsp;entry.<br>
&nbsp;<br>
name&nbsp;--&nbsp;new&nbsp;entry/attribute&nbsp;name<br>
foreground&nbsp;--&nbsp;foreground&nbsp;colour<br>
background&nbsp;--&nbsp;background&nbsp;colour<br>
mono&nbsp;--&nbsp;monochrome&nbsp;terminal&nbsp;attribute<br>
&nbsp;<br>
See&nbsp;curses_display.register_palette_entry&nbsp;for&nbsp;more&nbsp;info.</tt></dd></dl>

<dl><dt><a name="Screen-run_wrapper"><strong>run_wrapper</strong></a>(self, fn)</dt><dd><tt>Run&nbsp;the&nbsp;application&nbsp;main&nbsp;loop,&nbsp;calling&nbsp;start()&nbsp;first<br>
and&nbsp;stop()&nbsp;on&nbsp;exit.</tt></dd></dl>

<dl><dt><a name="Screen-set_mouse_tracking"><strong>set_mouse_tracking</strong></a>(self)</dt><dd><tt>Not&nbsp;yet&nbsp;implemented</tt></dd></dl>

<dl><dt><a name="Screen-start"><strong>start</strong></a>(self)</dt><dd><tt>This&nbsp;function&nbsp;reads&nbsp;the&nbsp;initial&nbsp;screen&nbsp;size,&nbsp;generates&nbsp;a<br>
unique&nbsp;id&nbsp;and&nbsp;handles&nbsp;cleanup&nbsp;when&nbsp;fn&nbsp;exits.<br>
&nbsp;<br>
web_display.set_preferences(..)&nbsp;must&nbsp;be&nbsp;called&nbsp;before&nbsp;calling<br>
this&nbsp;function&nbsp;for&nbsp;the&nbsp;preferences&nbsp;to&nbsp;take&nbsp;effect</tt></dd></dl>

<dl><dt><a name="Screen-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Restore&nbsp;settings&nbsp;and&nbsp;clean&nbsp;up.</tt></dd></dl>

<h2>Top-level widgets</h2><a name="Frame"></a><h3>function Frame <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="Frame">class <strong>Frame</strong></a>(BoxWidget) <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><dl><dt>Method resolution order:</dt>
<dd>Frame</dd>
<dd>BoxWidget</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Frame-__init__"><strong>__init__</strong></a>(self, body, header<font color="#909090">=None</font>, footer<font color="#909090">=None</font>, focus_part<font color="#909090">='body'</font>)</dt><dd><tt>body&nbsp;--&nbsp;a&nbsp;box&nbsp;widget&nbsp;for&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;frame<br>
header&nbsp;--&nbsp;a&nbsp;flow&nbsp;widget&nbsp;for&nbsp;above&nbsp;the&nbsp;body&nbsp;(or&nbsp;None)<br>
footer&nbsp;--&nbsp;a&nbsp;flow&nbsp;widget&nbsp;for&nbsp;below&nbsp;the&nbsp;body&nbsp;(or&nbsp;None)<br>
focus_part&nbsp;--&nbsp;'header',&nbsp;'footer'&nbsp;or&nbsp;'body'</tt></dd></dl>

<dl><dt><a name="Frame-frame_top_bottom"><strong>frame_top_bottom</strong></a>(self, (maxcol, maxrow), focus)</dt><dd><tt>Calculate&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;for&nbsp;the&nbsp;header&nbsp;and&nbsp;footer.<br>