reference.html

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

&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="Padding"></a><h3>function Padding <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="Padding">class <strong>Padding</strong></a>(Widget) <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><dl><dt>Method resolution order:</dt>
<dd>Padding</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Padding-__init__"><strong>__init__</strong></a>(self, w, align, width, min_width<font color="#909090">=None</font>)</dt><dd><tt>w&nbsp;--&nbsp;a&nbsp;box,&nbsp;flow&nbsp;or&nbsp;fixed&nbsp;widget&nbsp;to&nbsp;pad&nbsp;on&nbsp;the&nbsp;left&nbsp;and/or&nbsp;right<br>
align&nbsp;--&nbsp;one&nbsp;of:<br>
&nbsp;&nbsp;&nbsp;&nbsp;'left',&nbsp;'center',&nbsp;'right'<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;left',&nbsp;columns)<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;right',&nbsp;columns)<br>
&nbsp;&nbsp;&nbsp;&nbsp;('relative',&nbsp;percentage&nbsp;0=left&nbsp;100=right)<br>
width&nbsp;--&nbsp;one&nbsp;of:<br>
&nbsp;&nbsp;&nbsp;&nbsp;number&nbsp;of&nbsp;columns&nbsp;wide&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;right',&nbsp;columns)&nbsp;&nbsp;Only&nbsp;if&nbsp;align&nbsp;is&nbsp;'fixed&nbsp;left'<br>
&nbsp;&nbsp;&nbsp;&nbsp;('fixed&nbsp;left',&nbsp;columns)&nbsp;&nbsp;Only&nbsp;if&nbsp;align&nbsp;is&nbsp;'fixed&nbsp;right'<br>
&nbsp;&nbsp;&nbsp;&nbsp;('relative',&nbsp;percentage&nbsp;of&nbsp;total&nbsp;width)<br>
&nbsp;&nbsp;&nbsp;&nbsp;None&nbsp;&nbsp;&nbsp;to&nbsp;enable&nbsp;clipping&nbsp;mode<br>
min_width&nbsp;--&nbsp;the&nbsp;minimum&nbsp;number&nbsp;of&nbsp;columns&nbsp;for&nbsp;w&nbsp;or&nbsp;None<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
Padding&nbsp;widgets&nbsp;will&nbsp;try&nbsp;to&nbsp;satisfy&nbsp;width&nbsp;argument&nbsp;first&nbsp;by<br>
reducing&nbsp;the&nbsp;align&nbsp;amount&nbsp;when&nbsp;necessary.&nbsp;&nbsp;If&nbsp;width&nbsp;still&nbsp;<br>
cannot&nbsp;be&nbsp;satisfied&nbsp;it&nbsp;will&nbsp;also&nbsp;be&nbsp;reduced.<br>
&nbsp;<br>
Clipping&nbsp;Mode:<br>
In&nbsp;clipping&nbsp;mode&nbsp;w&nbsp;is&nbsp;treated&nbsp;as&nbsp;a&nbsp;fixed&nbsp;widget&nbsp;and&nbsp;this&nbsp;<br>
widget&nbsp;expects&nbsp;to&nbsp;be&nbsp;treated&nbsp;as&nbsp;a&nbsp;flow&nbsp;widget.&nbsp;&nbsp;w&nbsp;will<br>
be&nbsp;clipped&nbsp;to&nbsp;fit&nbsp;within&nbsp;the&nbsp;space&nbsp;given.&nbsp;&nbsp;For&nbsp;example,<br>
if&nbsp;align&nbsp;is&nbsp;'left'&nbsp;then&nbsp;w&nbsp;may&nbsp;be&nbsp;clipped&nbsp;on&nbsp;the&nbsp;right.</tt></dd></dl>

<dl><dt><a name="Padding-get_cursor_coords"><strong>get_cursor_coords</strong></a>(self, size)</dt><dd><tt>Return&nbsp;the&nbsp;(x,y)&nbsp;coordinates&nbsp;of&nbsp;cursor&nbsp;within&nbsp;self.<strong>w</strong>.</tt></dd></dl>

<dl><dt><a name="Padding-get_pref_col"><strong>get_pref_col</strong></a>(self, size)</dt><dd><tt>Return&nbsp;the&nbsp;preferred&nbsp;column&nbsp;from&nbsp;self.<strong>w</strong>,&nbsp;or&nbsp;None.</tt></dd></dl>

<dl><dt><a name="Padding-keypress"><strong>keypress</strong></a>(self, size, key)</dt><dd><tt>Pass&nbsp;keypress&nbsp;to&nbsp;self.<strong>w</strong>.</tt></dd></dl>

<dl><dt><a name="Padding-mouse_event"><strong>mouse_event</strong></a>(self, size, event, button, x, y, focus)</dt><dd><tt>Send&nbsp;mouse&nbsp;event&nbsp;if&nbsp;position&nbsp;is&nbsp;within&nbsp;self.<strong>w</strong>.</tt></dd></dl>

<dl><dt><a name="Padding-move_cursor_to_coords"><strong>move_cursor_to_coords</strong></a>(self, size, x, y)</dt><dd><tt>Set&nbsp;the&nbsp;cursor&nbsp;position&nbsp;with&nbsp;(x,y)&nbsp;coordinates&nbsp;of&nbsp;self.<strong>w</strong>.<br>
&nbsp;<br>
Returns&nbsp;True&nbsp;if&nbsp;move&nbsp;succeeded,&nbsp;False&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="Padding-padding_values"><strong>padding_values</strong></a>(self, size, focus)</dt><dd><tt>Return&nbsp;the&nbsp;number&nbsp;of&nbsp;columns&nbsp;to&nbsp;pad&nbsp;on&nbsp;the&nbsp;left&nbsp;and&nbsp;right.<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="Padding-render"><strong>render</strong></a> = cached_render(self, size, focus<font color="#909090">=False</font>)</dt></dl>

<dl><dt><a name="Padding-rows"><strong>rows</strong></a> = cached_rows(self, size, focus<font color="#909090">=False</font>)</dt></dl>

<dl><dt><a name="Padding-selectable"><strong>selectable</strong></a>(self)</dt><dd><tt>Return&nbsp;the&nbsp;selectable&nbsp;value&nbsp;of&nbsp;self.<strong>w</strong>.</tt></dd></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="Divider"></a><h3>function Divider <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="Divider">class <strong>Divider</strong></a>(FlowWidget) <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><dl><dt>Method resolution order:</dt>
<dd>Divider</dd>
<dd>FlowWidget</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Divider-__init__"><strong>__init__</strong></a>(self, div_char<font color="#909090">=' '</font>, top<font color="#909090">=0</font>, bottom<font color="#909090">=0</font>)</dt><dd><tt>div_char&nbsp;--&nbsp;character&nbsp;to&nbsp;repeat&nbsp;across&nbsp;line<br>
top&nbsp;--&nbsp;number&nbsp;of&nbsp;blank&nbsp;lines&nbsp;above<br>
bottom&nbsp;--&nbsp;number&nbsp;of&nbsp;blank&nbsp;lines&nbsp;below</tt></dd></dl>

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

<dl><dt><a name="Divider-rows"><strong>rows</strong></a> = cached_rows(self, size, focus<font color="#909090">=False</font>)</dt></dl>

<hr>
Methods inherited from Widget:<br>
<dl><dt><a name="Divider-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="LineBox"></a><h3>function LineBox <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="LineBox">class <strong>LineBox</strong></a>(WidgetWrap) <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><dl><dt>Method resolution order:</dt>
<dd>LineBox</dd>
<dd>WidgetWrap</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="LineBox-__init__"><strong>__init__</strong></a>(self, w)</dt><dd><tt>Draw&nbsp;a&nbsp;line&nbsp;around&nbsp;w.</tt></dd></dl>

<hr>
Methods inherited from WidgetWrap:<br>
<dl><dt><a name="LineBox-__getattr__"><strong>__getattr__</strong></a>(self, name)</dt><dd><tt>Call&nbsp;self.<strong>w</strong>&nbsp;if&nbsp;name&nbsp;is&nbsp;in&nbsp;Widget&nbsp;interface&nbsp;definition.</tt></dd></dl>

<dl><dt><a name="LineBox-get_w"><strong>get_w</strong></a>(self)</dt></dl>

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

<dl><dt><a name="LineBox-selectable"><strong>selectable</strong></a>(self)</dt></dl>

<dl><dt><a name="LineBox-set_w"><strong>set_w</strong></a>(self, w)</dt></dl>

<hr>
Data descriptors inherited from WidgetWrap:<br>
<dl><dt><strong>w</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="SolidFill"></a><h3>function SolidFill <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="SolidFill">class <strong>SolidFill</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>SolidFill</dd>
<dd>BoxWidget</dd>
<dd>Widget</dd>
<dd>object</dd>
</dl>
<hr>
Meth