reference.html

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

&nbsp;<br>
Returns&nbsp;(head&nbsp;rows,&nbsp;foot&nbsp;rows),(orig&nbsp;head,&nbsp;orig&nbsp;foot).<br>
orig&nbsp;head/foot&nbsp;are&nbsp;from&nbsp;rows()&nbsp;calls.</tt></dd></dl>

<dl><dt><a name="Frame-get_body"><strong>get_body</strong></a>(self)</dt></dl>

<dl><dt><a name="Frame-get_footer"><strong>get_footer</strong></a>(self)</dt></dl>

<dl><dt><a name="Frame-get_header"><strong>get_header</strong></a>(self)</dt></dl>

<dl><dt><a name="Frame-keypress"><strong>keypress</strong></a>(self, (maxcol, maxrow), key)</dt><dd><tt>Pass&nbsp;keypress&nbsp;to&nbsp;widget&nbsp;in&nbsp;focus.</tt></dd></dl>

<dl><dt><a name="Frame-mouse_event"><strong>mouse_event</strong></a>(self, (maxcol, maxrow), event, button, col, row, focus)</dt><dd><tt>Pass&nbsp;mouse&nbsp;event&nbsp;to&nbsp;appropriate&nbsp;part&nbsp;of&nbsp;frame.<br>
Focus&nbsp;may&nbsp;be&nbsp;changed&nbsp;on&nbsp;button&nbsp;1&nbsp;press.</tt></dd></dl>

<dl><dt><a name="Frame-render"><strong>render</strong></a> = cached_render(self, size, focus<font color="#909090">=False</font>)</dt></dl>

<dl><dt><a name="Frame-set_body"><strong>set_body</strong></a>(self, body)</dt></dl>

<dl><dt><a name="Frame-set_focus"><strong>set_focus</strong></a>(self, part)</dt><dd><tt>Set&nbsp;the&nbsp;part&nbsp;of&nbsp;the&nbsp;frame&nbsp;that&nbsp;is&nbsp;in&nbsp;focus.<br>
&nbsp;<br>
part&nbsp;--&nbsp;'header',&nbsp;'footer'&nbsp;or&nbsp;'body'</tt></dd></dl>

<dl><dt><a name="Frame-set_footer"><strong>set_footer</strong></a>(self, footer)</dt></dl>

<dl><dt><a name="Frame-set_header"><strong>set_header</strong></a>(self, header)</dt></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>body</strong></dt>
</dl>
<dl><dt><strong>footer</strong></dt>
</dl>
<dl><dt><strong>header</strong></dt>
</dl>
<hr>
Methods inherited from Widget:<br>
<dl><dt><a name="Frame-selectable"><strong>selectable</strong></a>(self)</dt></dl>

<hr>
Data descriptors inherited from Widget:<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>
<hr>
Data and other attributes inherited from Widget:<br>
<dl><dt><strong>__metaclass__</strong> = &lt;class 'urwid.widget.WidgetMeta'&gt;<dd><tt>Automatic&nbsp;caching&nbsp;of&nbsp;render&nbsp;and&nbsp;rows&nbsp;methods.<br>
&nbsp;<br>
Class&nbsp;variable&nbsp;no_cache&nbsp;is&nbsp;a&nbsp;list&nbsp;of&nbsp;names&nbsp;of&nbsp;methods&nbsp;to&nbsp;not&nbsp;cache.<br>
Class&nbsp;variable&nbsp;ignore_focus&nbsp;if&nbsp;defined&nbsp;and&nbsp;True&nbsp;indicates&nbsp;that&nbsp;this<br>
widget&nbsp;is&nbsp;not&nbsp;affected&nbsp;by&nbsp;the&nbsp;focus&nbsp;parameter,&nbsp;so&nbsp;it&nbsp;may&nbsp;be&nbsp;ignored<br>
when&nbsp;caching.</tt></dl>

<a name="Filler"></a><h3>function Filler <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="Filler">class <strong>Filler</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>Filler</dd>
<dd>BoxWidget</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Filler-__init__"><strong>__init__</strong></a>(self, body, valign<font color="#909090">='middle'</font>, height<font color="#909090">=None</font>, min_height<font color="#909090">=None</font>)</dt><dd><tt>body&nbsp;--&nbsp;a&nbsp;flow&nbsp;widget&nbsp;or&nbsp;box&nbsp;widget&nbsp;to&nbsp;be&nbsp;filled&nbsp;around<br>
valign&nbsp;--&nbsp;one&nbsp;of:<br>
&nbsp;&nbsp;&nbsp;&nbsp;'top',&nbsp;'middle',&nbsp;'bottom'<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;top',&nbsp;rows)<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;bottom',&nbsp;rows)<br>
&nbsp;&nbsp;&nbsp;&nbsp;('relative',&nbsp;percentage&nbsp;0=top&nbsp;100=bottom)<br>
height&nbsp;--&nbsp;one&nbsp;of:<br>
&nbsp;&nbsp;&nbsp;&nbsp;None&nbsp;if&nbsp;body&nbsp;is&nbsp;a&nbsp;flow&nbsp;widget<br>
&nbsp;&nbsp;&nbsp;&nbsp;number&nbsp;of&nbsp;rows&nbsp;high&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;bottom',&nbsp;rows)&nbsp;&nbsp;Only&nbsp;if&nbsp;valign&nbsp;is&nbsp;'fixed&nbsp;top'<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;top',&nbsp;rows)&nbsp;&nbsp;Only&nbsp;if&nbsp;valign&nbsp;is&nbsp;'fixed&nbsp;bottom'<br>
&nbsp;&nbsp;&nbsp;&nbsp;('relative',&nbsp;percentage&nbsp;of&nbsp;total&nbsp;height)<br>
min_height&nbsp;--&nbsp;one&nbsp;of:<br>
&nbsp;&nbsp;&nbsp;&nbsp;None&nbsp;if&nbsp;no&nbsp;minimum&nbsp;or&nbsp;if&nbsp;body&nbsp;is&nbsp;a&nbsp;flow&nbsp;widget<br>
&nbsp;&nbsp;&nbsp;&nbsp;minimum&nbsp;number&nbsp;of&nbsp;rows&nbsp;for&nbsp;the&nbsp;widget&nbsp;when&nbsp;height&nbsp;not&nbsp;fixed<br>
&nbsp;<br>
If&nbsp;body&nbsp;is&nbsp;a&nbsp;flow&nbsp;widget&nbsp;then&nbsp;height&nbsp;and&nbsp;min_height&nbsp;must&nbsp;be&nbsp;set<br>
to&nbsp;None.<br>
&nbsp;<br>
Filler&nbsp;widgets&nbsp;will&nbsp;try&nbsp;to&nbsp;satisfy&nbsp;height&nbsp;argument&nbsp;first&nbsp;by<br>
reducing&nbsp;the&nbsp;valign&nbsp;amount&nbsp;when&nbsp;necessary.&nbsp;&nbsp;If&nbsp;height&nbsp;still&nbsp;<br>
cannot&nbsp;be&nbsp;satisfied&nbsp;it&nbsp;will&nbsp;also&nbsp;be&nbsp;reduced.</tt></dd></dl>

<dl><dt><a name="Filler-filler_values"><strong>filler_values</strong></a>(self, (maxcol, maxrow), focus)</dt><dd><tt>Return&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;to&nbsp;pad&nbsp;on&nbsp;the&nbsp;top&nbsp;and&nbsp;bottom.<br>
&nbsp;<br>
Override&nbsp;this&nbsp;method&nbsp;to&nbsp;define&nbsp;custom&nbsp;padding&nbsp;behaviour.</tt></dd></dl>

<dl><dt><a name="Filler-get_body"><strong>get_body</strong></a>(self)</dt></dl>

<dl><dt><a name="Filler-get_cursor_coords"><strong>get_cursor_coords</strong></a>(self, (maxcol, maxrow))</dt><dd><tt>Return&nbsp;cursor&nbsp;coords&nbsp;from&nbsp;self.<strong>body</strong>&nbsp;if&nbsp;any.</tt></dd></dl>

<dl><dt><a name="Filler-get_pref_col"><strong>get_pref_col</strong></a>(self, (maxcol, maxrow))</dt><dd><tt>Return&nbsp;pref_col&nbsp;from&nbsp;self.<strong>body</strong>&nbsp;if&nbsp;any.</tt></dd></dl>

<dl><dt><a name="Filler-keypress"><strong>keypress</strong></a>(self, (maxcol, maxrow), key)</dt><dd><tt>Pass&nbsp;keypress&nbsp;to&nbsp;self.<strong>body</strong>.</tt></dd></dl>

<dl><dt><a name="Filler-mouse_event"><strong>mouse_event</strong></a>(self, (maxcol, maxrow), event, button, col, row, focus)</dt><dd><tt>Pass&nbsp;to&nbsp;self.<strong>body</strong>.</tt></dd></dl>

<dl><dt><a name="Filler-move_cursor_to_coords"><strong>move_cursor_to_coords</strong></a>(self, (maxcol, maxrow), col, row)</dt><dd><tt>Pass&nbsp;to&nbsp;self.<strong>body</strong>.</tt></dd></dl>

<dl><dt><a name="Filler-render"><strong>render</strong></a> = cached_render(self, size, focus<font color="#909090">=False</font>)</dt></dl>

<dl><dt><a name="Filler-selectable"><strong>selectable</strong></a>(self)</dt><dd><tt>Return&nbsp;selectable&nbsp;from&nbsp;body.</tt></dd></dl>

<dl><dt><a name="Filler-set_body"><strong>set_body</strong></a>(self, body)</dt></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>body</strong></dt>
</dl>
<hr>
Data descriptors inherited from Widget:<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>
<hr>
Data and other attributes inherited from Widget:<br>
<dl><dt><strong>__metaclass__</strong> = &lt;class 'urwid.widget.WidgetMeta'&gt;<dd><tt>Automatic&nbsp;caching&nbsp;of&nbsp;render&nbsp;and&nbsp;rows&nbsp;methods.<br>
&nbsp;<br>
Class&nbsp;variable&nbsp;no_cache&nbsp;is&nbsp;a&nbsp;list&nbsp;of&nbsp;names&nbsp;of&nbsp;methods&nbsp;to&nbsp;not&nbsp;cache.<br>
Class&nbsp;variable&nbsp;ignore_focus&nbsp;if&nbsp;defined&nbsp;and&nbsp;True&nbsp;indicates&nbsp;that&nbsp;this<br>
widget&nbsp;is&nbsp;not&nbsp;affected&nbsp;by&nbsp;the&nbsp;focus&nbsp;parameter,&nbsp;so&nbsp;it&nbsp;may&nbsp;be&nbsp;ignored<br>
when&nbsp;caching.</tt></dl>

<a name="ListBox"></a><h3>function ListBox <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="ListBox">class <strong>ListBox</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>ListBox</dd>
<dd>BoxWidget</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ListBox-__init__"><strong>__init__</strong></a>(self, body)</dt><dd><tt>body&nbsp;--&nbsp;a&nbsp;ListWalker-like&nbsp;object&nbsp;that&nbsp;contains<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;widgets&nbsp;to&nbsp;be&nbsp;displayed&nbsp;inside&nbsp;the&nbsp;list&nbsp;box</tt></dd></dl>

<dl><dt><a name="ListBox-calculate_visible"><strong>calculate_visible</strong></a>(self, (maxcol, maxrow), focus<font color="#909090">=False</font>)</dt><dd><tt>Return&nbsp;(middle,top,bottom)&nbsp;or&nbsp;None,None,None.<br>
&nbsp;<br>
middle&nbsp;--&nbsp;(&nbsp;row&nbsp;offset(when&nbsp;+ve)&nbsp;or&nbsp;inset(when&nbsp;-ve),<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;focus&nbsp;widget,&nbsp;focus&nbsp;position,&nbsp;focus&nbsp;rows,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cursor&nbsp;coords&nbsp;or&nbsp;None&nbsp;)<br>
top&nbsp;--&nbsp;(&nbsp;#&nbsp;lines&nbsp;to&nbsp;trim&nbsp;off&nbsp;top,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;of&nbsp;(widget,&nbsp;position,&nbsp;rows)&nbsp;tuples&nbsp;above&nbsp;focus<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;order&nbsp;from&nbsp;bottom&nbsp;to&nbsp;top&nbsp;)<br>
bottom&nbsp;--&nbsp;(&nbsp;#&nbsp;lines&nbsp;to&nbsp;trim&nbsp;off&nbsp;bottom,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;of&nbsp;(widget,&nbsp;position,&nbsp;rows)&nbsp;tuples&nbsp;below&nbsp;focus<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;order&nbsp;from&nbsp;top&nbsp;to&nbsp;bottom&nbsp;)</tt></dd></dl>

<dl><dt><a name="ListBox-change_focus"><strong>change_focus</strong></a>(self, (maxcol, maxrow), position, offset_inset<font color="#909090">=0</font>, coming_from<font color="#909090">=None</font>, cursor_coords<font color="#909090">=None</font>, snap_rows<font color="#909090">=None</font>)</dt><dd><tt>Change&nbsp;the&nbsp;current&nbsp;focus&nbsp;widget.<br>
&nbsp;<br>
position&nbsp;--&nbsp;a&nbsp;position&nbsp;compatible&nbsp;with&nbsp;self.<strong>body</strong>.set_focus<br>
offset_inset_rows&nbsp;--&nbsp;either&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;between&nbsp;the&nbsp;<br>
&nbsp;&nbsp;top&nbsp;of&nbsp;the&nbsp;listbox&nbsp;and&nbsp;the&nbsp;start&nbsp;of&nbsp;the&nbsp;focus&nbsp;widget&nbsp;(+ve<br>
&nbsp;&nbsp;value)&nbsp;or&nbsp;the&nbsp;number&nbsp;of&nbsp;lines&nbsp;of&nbsp;the&nbsp;focus&nbsp;widget&nbsp;hidden&nbsp;off&nbsp;<br>
&nbsp;&nbsp;the&nbsp;top&nbsp;edge&nbsp;of&nbsp;the&nbsp;listbox&nbsp;(-ve&nbsp;value)&nbsp;or&nbsp;0&nbsp;if&nbsp;the&nbsp;top&nbsp;edge<br>
&nbsp;&nbsp;of&nbsp;the&nbsp;focus&nbsp;widget&nbsp;is&nbsp;aligned&nbsp;with&nbsp;the&nbsp;top&nbsp;edge&nbsp;of&nbsp;the<br>
&nbsp;&nbsp;listbox&nbsp;(default&nbsp;if&nbsp;unspecified)<br>
coming_from&nbsp;--&nbsp;eiter&nbsp;'above',&nbsp;'below'&nbsp;or&nbsp;unspecified&nbsp;(None)<br>
cursor_coords&nbsp;--&nbsp;(x,&nbsp;y)&nbsp;tuple&nbsp;indicating&nbsp;the&nbsp;desired<br>
&nbsp;&nbsp;column&nbsp;and&nbsp;row&nbsp;for&nbsp;the&nbsp;cursor,&nbsp;a&nbsp;(x,)&nbsp;tuple&nbsp;indicating&nbsp;only<br>
&nbsp;&nbsp;the&nbsp;column&nbsp;for&nbsp;the&nbsp;cursor,&nbsp;or&nbsp;unspecified&nbsp;(None)<br>
snap_rows&nbsp;--&nbsp;the&nbsp;maximum&nbsp;number&nbsp;of&nbsp;extra&nbsp;rows&nbsp;to&nbsp;scroll<br>
&nbsp;&nbsp;when&nbsp;trying&nbsp;to&nbsp;"snap"&nbsp;a&nbsp;selectable&nbsp;focus&nbsp;into&nbsp;the&nbsp;view</tt></dd></dl>