You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
948 lines
54 KiB
948 lines
54 KiB
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>pyanaconda.ui.tui.simpleline package — Anaconda 25.14 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="top" title="Anaconda 25.14 documentation" href="index.html"/>
|
|
<link rel="up" title="pyanaconda.ui.tui package" href="pyanaconda.ui.tui.html"/>
|
|
<link rel="next" title="pyanaconda.ui.tui.spokes package" href="pyanaconda.ui.tui.spokes.html"/>
|
|
<link rel="prev" title="pyanaconda.ui.tui.hubs package" href="pyanaconda.ui.tui.hubs.html"/>
|
|
|
|
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home"> Anaconda
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
25.14
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Anaconda</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="release.html">Building a Release</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="boot-options.html">Anaconda Boot Options</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="kickstart.html">Anaconda Kickstart Documentation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="commit-log.html">Rules for commit messages</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="driverdisc.html">Brief description of DriverDisc version 3</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="iscsi.html">iSCSI and Anaconda</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="multipath.html">Multipath and Anaconda</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">pyanaconda</a><ul class="current">
|
|
<li class="toctree-l2 current"><a class="reference internal" href="pyanaconda.html">pyanaconda package</a><ul class="current">
|
|
<li class="toctree-l3 current"><a class="reference internal" href="pyanaconda.html#subpackages">Subpackages</a><ul class="current">
|
|
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.installclasses.html">pyanaconda.installclasses package</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.isys.html">pyanaconda.isys package</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.packaging.html">pyanaconda.packaging package</a></li>
|
|
<li class="toctree-l4 current"><a class="reference internal" href="pyanaconda.ui.html">pyanaconda.ui package</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.addons">pyanaconda.addons module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda">pyanaconda.anaconda module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda_argparse">pyanaconda.anaconda_argparse module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda_log">pyanaconda.anaconda_log module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.bootloader">pyanaconda.bootloader module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.constants">pyanaconda.constants module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.constants_text">pyanaconda.constants_text module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.desktop">pyanaconda.desktop module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.errors">pyanaconda.errors module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.exception">pyanaconda.exception module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.flags">pyanaconda.flags module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.geoloc">pyanaconda.geoloc module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.i18n">pyanaconda.i18n module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.ihelp">pyanaconda.ihelp module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.image">pyanaconda.image module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.install">pyanaconda.install module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.installclass">pyanaconda.installclass module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.iutil">pyanaconda.iutil module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.kexec">pyanaconda.kexec module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.keyboard">pyanaconda.keyboard module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.kickstart">pyanaconda.kickstart module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.localization">pyanaconda.localization module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.network">pyanaconda.network module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.nm">pyanaconda.nm module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.ntp">pyanaconda.ntp module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.product">pyanaconda.product module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.progress">pyanaconda.progress module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.pwpolicy">pyanaconda.pwpolicy module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.queuefactory">pyanaconda.queuefactory module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.regexes">pyanaconda.regexes module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.rescue">pyanaconda.rescue module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.safe_dbus">pyanaconda.safe_dbus module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.screensaver">pyanaconda.screensaver module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.simpleconfig">pyanaconda.simpleconfig module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.startup_utils">pyanaconda.startup_utils module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.storage_utils">pyanaconda.storage_utils module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.threads">pyanaconda.threads module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.timezone">pyanaconda.timezone module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.users">pyanaconda.users module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.vnc">pyanaconda.vnc module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="tests/modules.html">tests</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">Anaconda</a>
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html">Docs</a> »</li>
|
|
|
|
<li><a href="modules.html">pyanaconda</a> »</li>
|
|
|
|
<li><a href="pyanaconda.html">pyanaconda package</a> »</li>
|
|
|
|
<li><a href="pyanaconda.ui.html">pyanaconda.ui package</a> »</li>
|
|
|
|
<li><a href="pyanaconda.ui.tui.html">pyanaconda.ui.tui package</a> »</li>
|
|
|
|
<li>pyanaconda.ui.tui.simpleline package</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/pyanaconda.ui.tui.simpleline.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="pyanaconda-ui-tui-simpleline-package">
|
|
<h1>pyanaconda.ui.tui.simpleline package<a class="headerlink" href="#pyanaconda-ui-tui-simpleline-package" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
</div>
|
|
<div class="section" id="module-pyanaconda.ui.tui.simpleline.base">
|
|
<span id="pyanaconda-ui-tui-simpleline-base-module"></span><h2>pyanaconda.ui.tui.simpleline.base module<a class="headerlink" href="#module-pyanaconda.ui.tui.simpleline.base" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.base.</code><code class="descname">App</code><span class="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><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
|
|
<p>This is the main class for TUI screen handling. It is responsible for
|
|
mainloop control and keeping track of the screen stack.</p>
|
|
<p>Screens are organized in stack structure so it is possible to return
|
|
to caller when dialog or sub-screen closes.</p>
|
|
<p>It supports four window transitions:
|
|
- show new screen replacing the current one (linear progression)
|
|
- show new screen keeping the current one in stack (hub & spoke)
|
|
- show new screen and wait for it to end (dialog)
|
|
- close current window and return to the next one in stack</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>title</strong> (<a class="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>
|
|
<li><strong>width</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.5)"><em>int</em></a>) – screen width for rendering purposes</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.NOP">
|
|
<code class="descname">NOP</code><em class="property"> = None</em><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.NOP" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.START_MAINLOOP">
|
|
<code class="descname">START_MAINLOOP</code><em class="property"> = True</em><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.START_MAINLOOP" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.STOP_MAINLOOP">
|
|
<code class="descname">STOP_MAINLOOP</code><em class="property"> = False</em><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.STOP_MAINLOOP" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.close_screen">
|
|
<code class="descname">close_screen</code><span class="sig-paren">(</span><em>scr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.close_screen" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Close the currently displayed screen and exit it’s main loop
|
|
if necessary. Next screen from the stack is then displayed.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.header">
|
|
<code class="descname">header</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.header" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.input">
|
|
<code class="descname">input</code><span class="sig-paren">(</span><em>args</em>, <em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.input" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Method called internally to process unhandled input key presses.
|
|
Also handles the main quit and close commands.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>args</strong> (<em>anything</em>) – optional argument passed from switch_screen calls</li>
|
|
<li><strong>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) – the string entered by user</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if key was processed, False if it was not recognized</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">True|False</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.process_events">
|
|
<code class="descname">process_events</code><span class="sig-paren">(</span><em>return_at=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.process_events" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method processes incoming async messages and returns
|
|
when a specific message is encountered or when the queue_instance
|
|
is empty.</p>
|
|
<p>If return_at message was specified, the received
|
|
message is returned.</p>
|
|
<p>If the message does not fit return_at, but handlers are
|
|
defined then it processes all handlers for this message</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.raw_input">
|
|
<code class="descname">raw_input</code><span class="sig-paren">(</span><em>prompt</em>, <em>hidden=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.raw_input" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method reads one input from user. Its basic form has only one
|
|
line, but we might need to override it for more complex apps or testing.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.redraw">
|
|
<code class="descname">redraw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.redraw" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Set the redraw flag so the screen is refreshed as soon as possible.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.register_event_handler">
|
|
<code class="descname">register_event_handler</code><span class="sig-paren">(</span><em>event</em>, <em>callback</em>, <em>data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.register_event_handler" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method registers a callback which will be called
|
|
when message “event” is encountered during process_events.</p>
|
|
<dl class="docutils">
|
|
<dt>The callback has to accept two arguments:</dt>
|
|
<dd><ul class="first last simple">
|
|
<li>the received message in the form of (type, [arguments])</li>
|
|
<li>the data registered with the handler</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>event</strong> (<em>number|string</em>) – the id of the event we want to react on</li>
|
|
<li><strong>callback</strong> (<em>func(event_message, data)</em>) – the callback function</li>
|
|
<li><strong>data</strong> (<em>anything</em>) – optional data to pass to callback</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.run">
|
|
<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.run" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This methods starts the application. Do not use self.mainloop() directly
|
|
as run() handles all the required exceptions needed to keep nested mainloops
|
|
working.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.schedule_screen">
|
|
<code class="descname">schedule_screen</code><span class="sig-paren">(</span><em>ui</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.schedule_screen" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Add screen to the bottom of the stack. This is mostly usefull
|
|
at the beginning to prepare the first screen hierarchy to display.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>ui</strong> (<em>UIScreen instance</em>) – screen to show</li>
|
|
<li><strong>args</strong> (<em>anything</em>) – optional argument, please see switch_screen for details</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.switch_screen">
|
|
<code class="descname">switch_screen</code><span class="sig-paren">(</span><em>ui</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.switch_screen" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Schedules a screen to replace the current one.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="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>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.switch_screen_modal">
|
|
<code class="descname">switch_screen_modal</code><span class="sig-paren">(</span><em>ui</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.switch_screen_modal" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Starts a new screen right away, so the caller can collect data back.
|
|
When the new screen is closed, the caller is redisplayed.</p>
|
|
<p>This method does not return until the new screen is closed.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>ui</strong> (<em>UIScreen instance</em>) – screen to show</li>
|
|
<li><strong>args</strong> (<em>anything</em>) – optional argument, please see switch_screen for details</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.switch_screen_with_return">
|
|
<code class="descname">switch_screen_with_return</code><span class="sig-paren">(</span><em>ui</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.switch_screen_with_return" title="Permalink to this definition">¶</a></dt>
|
|
<dd><dl class="docutils">
|
|
<dt>Schedules a screen to show, but keeps the current one in stack</dt>
|
|
<dd>to return to, when the new one is closed.</dd>
|
|
</dl>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>ui</strong> (<em>UIScreen instance</em>) – screen to show</li>
|
|
<li><strong>args</strong> (<em>anything</em>) – optional argument, please see switch_screen for details</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.App.width">
|
|
<code class="descname">width</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.App.width" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Return the total width of screen space we have available.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.base.</code><code class="descname">UIScreen</code><span class="sig-paren">(</span><em>app</em>, <em>screen_height=25</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
|
|
<p>Base class representing one TUI Screen. Shares some API with anaconda’s GUI
|
|
to make it easy for devs to create similar UI with the familiar API.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>app</strong> (<em>instance of class App</em>) – reference to application main class</li>
|
|
<li><strong>screen_height</strong> (<a class="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>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.app">
|
|
<code class="descname">app</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.app" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The reference to this Screen’s assigned App instance.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.close">
|
|
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.close" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Close the current screen.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.hide">
|
|
<code class="descname">hide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.hide" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This does nothing in TUI, it is here to make API similar.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.input">
|
|
<code class="descname">input</code><span class="sig-paren">(</span><em>args</em>, <em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.input" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Method called to process input. If the input is not handled here, return it.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
<li><strong>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.5)"><em>str</em></a>) – input string to process</li>
|
|
<li><strong>args</strong> (<em>anything</em>) – optional argument passed from switch_screen calls</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">return True or INPUT_PROCESSED (None) if key was handled,
|
|
INPUT_DISCARDED (False) if the screen should not process input
|
|
on the App and key if you want it to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">True|False|None|str</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.prompt">
|
|
<code class="descname">prompt</code><span class="sig-paren">(</span><em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.prompt" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Return the text to be shown as prompt or handle the prompt and return None.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<em>anything</em>) – optional argument passed from switch_screen calls</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">returns text to be shown next to the prompt for input or None
|
|
to skip further input processing</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str|None</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.refresh">
|
|
<code class="descname">refresh</code><span class="sig-paren">(</span><em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.refresh" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Method which prepares the content desired on the screen to self._window.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<em>anything</em>) – optional argument passed from switch_screen calls</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">has to return True if input processing is requested, otherwise
|
|
the screen will get printed and the main loop will continue</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">True|False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.setup">
|
|
<code class="descname">setup</code><span class="sig-paren">(</span><em>environment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.setup" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Do additional setup right before this screen is used.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>environment</strong> (<em>either FIRSTBOOT_ENVIRON or ANACONDA_ENVIRON</em>) – environment (see pyanaconda.constants) the UI is running in</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">whether this screen should be scheduled or not</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.5)">bool</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.show">
|
|
<code class="descname">show</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.show" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Prepares all elements of self._window for output and then prints
|
|
them on the screen.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.show_all">
|
|
<code class="descname">show_all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.show_all" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Prepares all elements of self._window for output and then prints
|
|
them on the screen.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.UIScreen.title">
|
|
<code class="descname">title</code><em class="property"> = 'Screen..'</em><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.UIScreen.title" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.base.</code><code class="descname">Widget</code><span class="sig-paren">(</span><em>max_width=None</em>, <em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
|
|
<p>Initializes base Widgets buffer.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>max_width</strong> (<a class="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> (<a class="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>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.clear">
|
|
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.clear" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Clears this widgets buffer and resets cursor.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.content">
|
|
<code class="descname">content</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.content" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This has to return list (rows) of lists (columns) with one character elements.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.cursor">
|
|
<code class="descname">cursor</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.cursor" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.draw">
|
|
<code class="descname">draw</code><span class="sig-paren">(</span><em>w</em>, <em>row=None</em>, <em>col=None</em>, <em>block=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.draw" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method copies w widget’s content to this widget’s buffer at row, col position.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>w</strong> (<em>class Widget</em>) – widget to take content from</li>
|
|
<li><strong>row</strong> (<a class="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> (<a class="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>block</strong> (<em>boolean</em>) – when printing newline, start at column col (True) or at column 0 (False)</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.get_lines">
|
|
<code class="descname">get_lines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.get_lines" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Get lines to write out in order to show this widget.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">lines representing this widget</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list(str)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.height">
|
|
<code class="descname">height</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.height" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The current height of the internal buffer.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.render">
|
|
<code class="descname">render</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.render" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method has to redraw the widget’s self._buffer.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>width</strong> (<a class="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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>This method will commonly call render of child widgets and then draw and write
|
|
methods to copy their contents to self._buffer</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.setend">
|
|
<code class="descname">setend</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.setend" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Sets the cursor to first column in new line at the end.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.setxy">
|
|
<code class="descname">setxy</code><span class="sig-paren">(</span><em>row</em>, <em>col</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.setxy" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Sets cursor position.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>row</strong> (<a class="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> (<a class="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>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.width">
|
|
<code class="descname">width</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.width" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The current width of the internal buffer
|
|
(id of the first empty column).</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.base.Widget.write">
|
|
<code class="descname">write</code><span class="sig-paren">(</span><em>text</em>, <em>row=None</em>, <em>col=None</em>, <em>width=None</em>, <em>block=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.base.Widget.write" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method emulates typing machine writing to this widget’s buffer.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>text</strong> (<a class="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> (<a class="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> (<a class="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> (<a class="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>
|
|
<li><strong>block</strong> (<em>boolean</em>) – when printing newline, start at column col (True) or at column 0 (False)</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-pyanaconda.ui.tui.simpleline.widgets">
|
|
<span id="pyanaconda-ui-tui-simpleline-widgets-module"></span><h2>pyanaconda.ui.tui.simpleline.widgets module<a class="headerlink" href="#module-pyanaconda.ui.tui.simpleline.widgets" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.TextWidget">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><code class="descname">TextWidget</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.TextWidget" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.ui.tui.simpleline.base.Widget" title="pyanaconda.ui.tui.simpleline.base.Widget"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.tui.simpleline.base.Widget</span></code></a></p>
|
|
<p>Class to handle wrapped text output.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>text</strong> (<a class="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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.TextWidget.render">
|
|
<code class="descname">render</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.TextWidget.render" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Renders the text widget limited to width number of columns
|
|
(wraps to the next line when the text is longer).</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>width</strong> (<a class="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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>:raises</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.ColumnWidget">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><code class="descname">ColumnWidget</code><span class="sig-paren">(</span><em>columns</em>, <em>spacing=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.ColumnWidget" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.ui.tui.simpleline.base.Widget" title="pyanaconda.ui.tui.simpleline.base.Widget"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.tui.simpleline.base.Widget</span></code></a></p>
|
|
<p>Create text columns</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>columns</strong> (<em>[(int, [...]), ...]</em>) – list containing (column width, [list of widgets to put into this column])</li>
|
|
<li><strong>spacing</strong> (<a class="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>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.ColumnWidget.render">
|
|
<code class="descname">render</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.ColumnWidget.render" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Render the widget to it’s internal buffer</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>width</strong> (<a class="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>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">nothing</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.5)">None</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><code class="descname">CheckboxWidget</code><span class="sig-paren">(</span><em>key='x'</em>, <em>title=None</em>, <em>text=None</em>, <em>completed=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.ui.tui.simpleline.base.Widget" title="pyanaconda.ui.tui.simpleline.base.Widget"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.tui.simpleline.base.Widget</span></code></a></p>
|
|
<p>Widget to show checkbox with (un)checked box, name and description.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>key</strong> (<em>character</em>) – tick character to be used inside [ ]</li>
|
|
<li><strong>title</strong> (<a class="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> (<a class="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>
|
|
<li><strong>completed</strong> (<em>True|False</em>) – is the checkbox ticked or not?</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.completed">
|
|
<code class="descname">completed</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.completed" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the state of the checkbox, checked is True.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.render">
|
|
<code class="descname">render</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.render" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Render the widget to internal buffer. It should be max width
|
|
characters wide.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.text">
|
|
<code class="descname">text</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.text" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Contains the description text from the second line.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.title">
|
|
<code class="descname">title</code><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CheckboxWidget.title" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the first line (main title) of the checkbox.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CenterWidget">
|
|
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.simpleline.widgets.</code><code class="descname">CenterWidget</code><span class="sig-paren">(</span><em>w</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CenterWidget" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.ui.tui.simpleline.base.Widget" title="pyanaconda.ui.tui.simpleline.base.Widget"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.tui.simpleline.base.Widget</span></code></a></p>
|
|
<p>Class to handle horizontal centering of content.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>w</strong> (<a class="reference internal" href="#pyanaconda.ui.tui.simpleline.base.Widget" title="pyanaconda.ui.tui.simpleline.base.Widget"><em>base.Widget</em></a>) – widget to center</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="pyanaconda.ui.tui.simpleline.widgets.CenterWidget.render">
|
|
<code class="descname">render</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.simpleline.widgets.CenterWidget.render" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Render the centered widget to internal buffer.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>width</strong> (<a class="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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-pyanaconda.ui.tui.simpleline">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyanaconda.ui.tui.simpleline" title="Permalink to this headline">¶</a></h2>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="pyanaconda.ui.tui.spokes.html" class="btn btn-neutral float-right" title="pyanaconda.ui.tui.spokes package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="pyanaconda.ui.tui.hubs.html" class="btn btn-neutral" title="pyanaconda.ui.tui.hubs package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2015, Red Hat, Inc..
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'25.14',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |