<spanid="pyanaconda-ui-tui-simpleline-base-module"></span><h2>pyanaconda.ui.tui.simpleline.base module<aclass="headerlink"href="#module-pyanaconda.ui.tui.simpleline.base"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.base.</code><codeclass="descname">App</code><spanclass="sig-paren">(</span><em>title</em>, <em>yes_or_no_question=None</em>, <em>width=80</em>, <em>queue_instance=None</em>, <em>quit_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App"title="Permalink to this definition">¶</a></dt>
<li><strong>title</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.5)"><em>str</em></a>) – application title for whenever we need to display app name</li>
<li><strong>yes_or_no_question</strong> (<em>class UIScreen accepting additional message arg</em>) – UIScreen object class used for Quit dialog</li>
<codeclass="descname">NOP</code><emclass="property"> = None</em><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.NOP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_MAINLOOP</code><emclass="property"> = True</em><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.START_MAINLOOP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STOP_MAINLOOP</code><emclass="property"> = False</em><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.STOP_MAINLOOP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">close_screen</code><spanclass="sig-paren">(</span><em>scr=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.close_screen"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>scr</strong> (<em>UIScreen instance</em>) – if an UIScreen instance is passed it is checked to be the screen we are trying to close.</td>
<codeclass="descname">header</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.header"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input</code><spanclass="sig-paren">(</span><em>args</em>, <em>key</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.input"title="Permalink to this definition">¶</a></dt>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">True if key was processed, False if it was not recognized</p>
<codeclass="descname">process_events</code><spanclass="sig-paren">(</span><em>return_at=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.process_events"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">raw_input</code><spanclass="sig-paren">(</span><em>prompt</em>, <em>hidden=False</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.raw_input"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">redraw</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.redraw"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">register_event_handler</code><spanclass="sig-paren">(</span><em>event</em>, <em>callback</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.register_event_handler"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">run</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.run"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">schedule_screen</code><spanclass="sig-paren">(</span><em>ui</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.schedule_screen"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">switch_screen</code><spanclass="sig-paren">(</span><em>ui</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.switch_screen"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>ui</strong> (<em>instance of UIScreen</em>) – screen to show</li>
<li><strong>args</strong> (<em>anything</em>) – optional argument to pass to ui’s refresh method (can be used to select what item should be displayed or so)</li>
<codeclass="descname">switch_screen_modal</code><spanclass="sig-paren">(</span><em>ui</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.switch_screen_modal"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">switch_screen_with_return</code><spanclass="sig-paren">(</span><em>ui</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.switch_screen_with_return"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">width</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.App.width"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.base.</code><codeclass="descname">UIScreen</code><spanclass="sig-paren">(</span><em>app</em>, <em>screen_height=25</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen"title="Permalink to this definition">¶</a></dt>
<li><strong>screen_height</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – height of the screen (useful for printing long widgets)</li>
<codeclass="descname">app</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.app"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">close</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.close"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">hide</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.hide"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input</code><spanclass="sig-paren">(</span><em>args</em>, <em>key</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.input"title="Permalink to this definition">¶</a></dt>
<li><strong>args</strong> (<em>anything</em>) – optional argument passed from switch_screen calls</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">return True or INPUT_PROCESSED (None) if key was handled,
INPUT_DISCARDED (False) if the screen should not process input
<codeclass="descname">prompt</code><spanclass="sig-paren">(</span><em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.prompt"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">refresh</code><spanclass="sig-paren">(</span><em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.refresh"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">setup</code><spanclass="sig-paren">(</span><em>environment</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.setup"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>environment</strong> (<em>either FIRSTBOOT_ENVIRON or ANACONDA_ENVIRON</em>) – environment (see pyanaconda.constants) the UI is running in</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">whether this screen should be scheduled or not</td>
<codeclass="descname">show</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.show"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">show_all</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.show_all"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">title</code><emclass="property"> = 'Screen..'</em><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.UIScreen.title"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.base.</code><codeclass="descname">Widget</code><spanclass="sig-paren">(</span><em>max_width=None</em>, <em>default=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget"title="Permalink to this definition">¶</a></dt>
<li><strong>max_width</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – server as a hint about screen size to write method with default arguments</li>
<li><strong>default</strong> (<aclass="reference external"href="https://docs.python.org/3/library/string.html#module-string"title="(in Python v3.5)"><em>string</em></a>) – string containing the default content to fill the buffer with</li>
<codeclass="descname">clear</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.clear"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">content</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.content"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">cursor</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.cursor"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>w</em>, <em>row=None</em>, <em>col=None</em>, <em>block=False</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.draw"title="Permalink to this definition">¶</a></dt>
<li><strong>row</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – row number to start at (default is at the cursor position)</li>
<li><strong>col</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – column number to start at (default is at the cursor position)</li>
<codeclass="descname">get_lines</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.get_lines"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">height</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.height"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.render"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>width</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – the width of buffer requested by the caller</td>
<codeclass="descname">setend</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.setend"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">setxy</code><spanclass="sig-paren">(</span><em>row</em>, <em>col</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.setxy"title="Permalink to this definition">¶</a></dt>
<li><strong>row</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – row id, starts with 0 at the top of the screen</li>
<li><strong>col</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – column id, starts with 0 on the left side of the screen</li>
<codeclass="descname">width</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.width"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">write</code><spanclass="sig-paren">(</span><em>text</em>, <em>row=None</em>, <em>col=None</em>, <em>width=None</em>, <em>block=False</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.base.Widget.write"title="Permalink to this definition">¶</a></dt>
<li><strong>text</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.5)"><em>str</em></a>) – text to type</li>
<li><strong>row</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – row number to start at (default is at the cursor position)</li>
<li><strong>col</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – column number to start at (default is at the cursor position)</li>
<li><strong>width</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – wrap at “col” + “width” column (default is at self._max_width)</li>
<spanid="pyanaconda-ui-tui-simpleline-widgets-module"></span><h2>pyanaconda.ui.tui.simpleline.widgets module<aclass="headerlink"href="#module-pyanaconda.ui.tui.simpleline.widgets"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><codeclass="descname">TextWidget</code><spanclass="sig-paren">(</span><em>text</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.TextWidget"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>text</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.5)"><em>str</em></a>) – text to format</td>
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.TextWidget.render"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>width</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – maximum width allocated to the string</td>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><codeclass="descname">ColumnWidget</code><spanclass="sig-paren">(</span><em>columns</em>, <em>spacing=0</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.ColumnWidget"title="Permalink to this definition">¶</a></dt>
<li><strong>spacing</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – number of spaces to use between columns</li>
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.ColumnWidget.render"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>width</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – the maximum width the widget can use</td>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><codeclass="descname">CheckboxWidget</code><spanclass="sig-paren">(</span><em>key='x'</em>, <em>title=None</em>, <em>text=None</em>, <em>completed=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget"title="Permalink to this definition">¶</a></dt>
<li><strong>title</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.5)"><em>str</em></a>) – the title next to the [ ] box</li>
<li><strong>text</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.5)"><em>str</em></a>) – the description text to be shown on the second row in ()</li>
<codeclass="descname">completed</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.completed"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.render"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">text</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.text"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">title</code><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.title"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><codeclass="descname">CenterWidget</code><spanclass="sig-paren">(</span><em>w</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CenterWidget"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyanaconda.ui.tui.simpleline.widgets.CenterWidget.render"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>width</strong> (<aclass="reference external"href="https://docs.python.org/3/library/functions.html#int"title="(in Python v3.5)"><em>int</em></a>) – maximum width the widget should use</td>
<spanid="module-contents"></span><h2>Module contents<aclass="headerlink"href="#module-pyanaconda.ui.tui.simpleline"title="Permalink to this headline">¶</a></h2>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.