📄 reference.html
字号:
<html><head><title>Urwid 0.9.8.4 Reference</title><style type="text/css"> h1 { text-align: center; } h2 { margin: 40px 0 0 0; padding: 10px; background: #6d96e8;} h3 { margin: 0 0 3px 0; padding: 12px 6px 6px 6px; background: #efef96;} .l1 { margin: 12px 0 0 0; } .l2 { margin-left: 20px; }</style><body><a name="top"></a><h1>Urwid 0.9.8.4 Reference</h1><div style="text-align: center;"><a href="http://excess.org/urwid/">Urwid Home Page</a> /<a href="http://excess.org/urwid/examples.html">Example Screenshots</a> /<a href="http://excess.org/urwid/utf8examples.html">UTF-8 Screenshots</a> /<a href="tutorial.html">Tutorial</a> /Reference</div><br><table width="100%"><tr><td width="33%" valign="top"><div class="l1">User interface wrappers</div><div class="l2"><a href="#raw_display.Screen">raw_display.Screen</a> </div><div class="l2"><a href="#curses_display.Screen">curses_display.Screen</a> </div><div class="l2"><a href="#web_display.Screen">web_display.Screen</a> </div><div class="l1">Top-level widgets</div><div class="l2"><a href="#Frame">Frame</a> [<b>B</b>]</div><div class="l2"><a href="#Filler">Filler</a> [<b>B</b>]</div><div class="l2"><a href="#ListBox">ListBox</a> [<b>B</b>]</div><div class="l1">Decorations</div><div class="l2"><a href="#WidgetWrap">WidgetWrap</a> [<b>F</b>/<b>B</b>]</div><div class="l2"><a href="#AttrWrap">AttrWrap</a> [<b>F</b>/<b>B</b>]</div><div class="l2"><a href="#Padding">Padding</a> [<b>F</b>/<b>B</b>]</div><div class="l2"><a href="#Divider">Divider</a> [<b>F</b>]</div><div class="l2"><a href="#LineBox">LineBox</a> [<b>F</b>/<b>B</b>]</div><div class="l2"><a href="#SolidFill">SolidFill</a> [<b>B</b>]</div><div class="l1">Composite widgets</div><div class="l2"><a href="#Columns">Columns</a> [<b>F</b>/<b>B</b>]</div><div class="l2"><a href="#Pile">Pile</a> [<b>F</b>/<b>B</b>]</div><div class="l2"><a href="#GridFlow">GridFlow</a> [<b>F</b>]</div><div class="l2"><a href="#BoxAdapter">BoxAdapter</a> [<b>F</b>]</div><div class="l2"><a href="#Overlay">Overlay</a> [<b>B</b>]</div></td><td width="33%" valign="top"><div class="l1">Content widgets</div><div class="l2"><a href="#Text">Text</a> [<b>F</b>]</div><div class="l2"><a href="#Edit">Edit</a> [<b>F</b>]</div><div class="l2"><a href="#IntEdit">IntEdit</a> [<b>F</b>]</div><div class="l2"><a href="#Button">Button</a> [<b>F</b>]</div><div class="l2"><a href="#CheckBox">CheckBox</a> [<b>F</b>]</div><div class="l2"><a href="#RadioButton">RadioButton</a> [<b>F</b>]</div><div class="l1">Graphics</div><div class="l2"><a href="#BarGraph">BarGraph</a> [<b>B</b>]</div><div class="l2"><a href="#GraphVScale">GraphVScale</a> [<b>B</b>]</div><div class="l2"><a href="#ProgressBar">ProgressBar</a> [<b>F</b>]</div><div class="l2"><a href="#BigText">BigText</a> [<b>X</b>]</div><div class="l2"><a href="#get_all_fonts">get_all_fonts</a> </div><div class="l1">Abstract widgets & interfaces</div><div class="l2"><a href="#Widget_interface_definition">Widget interface definition</a> </div><div class="l2"><a href="#Widget">Widget</a> </div><div class="l2"><a href="#BoxWidget">BoxWidget</a> </div><div class="l2"><a href="#FlowWidget">FlowWidget</a> </div><div class="l2"><a href="#FixedWidget">FixedWidget</a> </div><div class="l2"><a href="#List_Walker_interface_definition">List Walker interface definition</a> </div><div class="l2"><a href="#ListWalker">ListWalker</a> </div><div class="l1">ListBox list walkers</div><div class="l2"><a href="#PollingListWalker">PollingListWalker</a> </div><div class="l2"><a href="#SimpleListWalker">SimpleListWalker</a> </div></td><td width="33%" valign="top"><div class="l1">Canvas painting</div><div class="l2"><a href="#Canvas">Canvas</a> </div><div class="l2"><a href="#TextCanvas">TextCanvas</a> </div><div class="l2"><a href="#CompositeCanvas">CompositeCanvas</a> </div><div class="l2"><a href="#SolidCanvas">SolidCanvas</a> </div><div class="l2"><a href="#CanvasCombine">CanvasCombine</a> </div><div class="l2"><a href="#CanvasJoin">CanvasJoin</a> </div><div class="l2"><a href="#CanvasOverlay">CanvasOverlay</a> </div><div class="l1">Custom formatting rules</div><div class="l2"><a href="#TextLayout">TextLayout</a> </div><div class="l2"><a href="#StandardTextLayout">StandardTextLayout</a> </div><div class="l1">Character encoding</div><div class="l2"><a href="#set_encoding">set_encoding</a> </div><div class="l2"><a href="#get_encoding_mode">get_encoding_mode</a> </div><div class="l2"><a href="#supports_unicode">supports_unicode</a> </div><div class="l1">Screen capture</div><div class="l2"><a href="#html_fragment.screenshot_init">html_fragment.screenshot_init</a> </div><div class="l2"><a href="#html_fragment.screenshot_collect">html_fragment.screenshot_collect</a> </div><div class="l2"><a href="#html_fragment.HtmlGenerator">html_fragment.HtmlGenerator</a> </div><div class="l1">Web Application Interface</div><div class="l2"><a href="#web_display.is_web_request">web_display.is_web_request</a> </div><div class="l2"><a href="#web_display.set_preferences">web_display.set_preferences</a> </div><div class="l2"><a href="#web_display.handle_short_request">web_display.handle_short_request</a> </div></td></tr></table><br>[<b>F</b>] = Flow Widget displayed with assigned screen columns and variable screen rows<br>[<b>B</b>] = Box Widget displayed with assigned screen columns and assigned screen rows<br>[<b>F</b>/<b>B</b>] = May behave as either Flow Widget or Box Widget<br>[<b>X</b>] = Fixed Widget has a fixed number of screen columns and rows<br><h2>User interface wrappers</h2><a name="raw_display.Screen"></a><h3>function raw_display.Screen <span style="font-size:small; padding-left: 20px">[<a href="#top">back to top</a>]</span></h3><h3><a name="raw_display.Screen"></a><strong>raw_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 the screen to be completely repainted on the next<br>call to draw_screen().</tt></dd></dl><dl><dt><a name="Screen-draw_screen"><strong>draw_screen</strong></a>(self, (maxcol, maxrow), r)</dt><dd><tt>Paint screen with rendered canvas.</tt></dd></dl><dl><dt><a name="Screen-get_cols_rows"><strong>get_cols_rows</strong></a>(self)</dt><dd><tt>Return the terminal dimensions (num columns, num 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 pending input as a list.<br> <br>raw_keys -- return raw keycodes as well as translated versions<br> <br>This function will immediately return all the input since the<br>last time it was called. If there is no input pending it will<br>wait before returning an empty list. The wait time may be<br>configured with the set_input_timeouts function.<br> <br>If raw_keys is False (default) this function will return a list<br>of keys pressed. If raw_keys is True this function will return<br>a ( keys pressed, raw keycodes ) tuple instead.<br> <br>Examples of keys returned<br>-------------------------<br>ASCII printable characters: " ", "a", "0", "A", "-", "/" <br>ASCII control characters: "tab", "enter"<br>Escape sequences: "up", "page up", "home", "insert", "f1"<br>Key combinations: "shift f1", "meta a", "ctrl b"<br>Window events: "window resize"<br> <br>When a narrow encoding is not enabled<br>"Extended ASCII" characters: "\xa1", "\xb2", "\xfe"<br> <br>When a wide encoding is enabled<br>Double-byte characters: "\xa1\xea", "\xb2\xd4"<br> <br>When utf8 encoding is enabled<br>Unicode characters: u"\u00a5", u'\u253c"<br> <br>Examples of mouse events returned<br>---------------------------------<br>Mouse button press: ('mouse press', 1, 15, 13), <br> ('meta mouse press', 2, 17, 23)<br>Mouse drag: ('mouse drag', 1, 16, 13),<br> ('mouse drag', 1, 17, 13),<br> ('ctrl mouse drag', 1, 18, 13)<br>Mouse button release: ('mouse release', 0, 18, 13),<br> ('ctrl mouse release', 0, 17, 23)</tt></dd></dl><dl><dt><a name="Screen-get_input_descriptors"><strong>get_input_descriptors</strong></a>(self)</dt><dd><tt>Return a list of integer file descriptors that should be<br>polled in external event loops to check for user input.<br> <br>Use this method if you are implementing yout own event loop.</tt></dd></dl><dl><dt><a name="Screen-get_input_nonblocking"><strong>get_input_nonblocking</strong></a>(self)</dt><dd><tt>Return a (next_input_timeout, keys_pressed, raw_keycodes) <br>tuple.<br> <br>Use this method if you are implementing your own event loop.<br> <br>When there is input waiting on one of the descriptors returned<br>by get_input_descriptors() this method should be called to<br>read and process the input.<br> <br>This method expects to be called in next_input_timeout seconds<br>(a floating point number) if there is no input waiting.</tt></dd></dl><dl><dt><a name="Screen-register_palette"><strong>register_palette</strong></a>(self, l)</dt><dd><tt>Register a list of palette entries.<br> <br>l -- list of (name, foreground, background, mono),<br> (name, foreground, background) or<br> (name, same_as_other_name) palette entries.<br> <br>calls self.<strong>register_palette_entry</strong> for each item in 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 a single palette entry.<br> <br>name -- new entry/attribute name<br>foreground -- foreground colour, one of: 'black', 'dark red',<br> 'dark green', 'brown', 'dark blue', 'dark magenta',<br> 'dark cyan', 'light gray', 'dark gray', 'light red',<br> 'light green', 'yellow', 'light blue', 'light magenta',<br> 'light cyan', 'white', 'default' (black if unable to<br> use terminal's default)<br>background -- background colour, one of: 'black', 'dark red',<br> 'dark green', 'brown', 'dark blue', 'dark magenta',<br> 'dark cyan', 'light gray', 'default' (light gray if<br> unable to use terminal's default)<br>mono -- monochrome terminal attribute, one of: None (default),<br> 'bold', 'underline', 'standout', or a tuple containing<br> a combination eg. ('bold','underline')</tt></dd></dl><dl><dt><a name="Screen-run_wrapper"><strong>run_wrapper</strong></a>(self, fn, alternate_buffer<font color="#909090">=True</font>)</dt><dd><tt>Call start to initialize screen, then call fn. <br>When fn exits call stop to restore the screen to normal.<br> <br>alternate_buffer -- use alternate screen buffer and restore<br> normal screen buffer on exit</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 the get_input timeout values. All values have are floating<br>point number of seconds.<br> <br>max_wait -- amount of time in seconds to wait for input when<br> there is no input pending<br>complete_wait -- amount of time in seconds to wait when<br> get_input detects an incomplete escape sequence at the<br> end of the available input<br>resize_wait -- amount of time in seconds to wait for more input<br> after receiving two screen resize requests in a row to<br> stop Urwid from consuming 100% cpu during a gradual<br> window resize operation</tt></dd></dl><dl><dt><a name="Screen-set_mouse_tracking"><strong>set_mouse_tracking</strong></a>(self)</dt><dd><tt>Enable mouse tracking. <br> <br>After calling this function get_input will include mouse<br>click events along with keystrokes.</tt></dd></dl><dl><dt><a name="Screen-signal_init"><strong>signal_init</strong></a>(self)</dt><dd><tt>Called in the startup of run wrapper to set the SIGWINCH <br>signal handler to self.<strong>_sigwinch_handler</strong>.<br> <br>Override this function to call from main thread in threaded<br>applications.</tt></dd></dl><dl><dt><a name="Screen-signal_restore"><strong>signal_restore</strong></a>(self)</dt><dd><tt>Called in the finally block of run wrapper to restore the<br>SIGWINCH handler to the default handler.<br> <br>Override this function to call from main thread in threaded<br>applications.</tt></dd></dl><dl><dt><a name="Screen-start"><strong>start</strong></a>(self, alternate_buffer<font color="#909090">=True</font>)</dt><dd><tt>Initialize the screen and input mode.<br> <br>alternate_buffer -- use alternate screen buffer</tt></dd></dl><dl><dt><a name="Screen-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Restore the screen.</tt></dd></dl><hr>Data descriptors defined here:<br><dl><dt><strong>__dict__</strong></dt><dd><tt>dictionary for instance variables (if defined)</tt></dd></dl>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -