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.
qubes-installer-qubes-os/anaconda/docs/html/pyanaconda.ui.tui.hubs.html

404 lines
23 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.hubs package &mdash; 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.simpleline package" href="pyanaconda.ui.tui.simpleline.html"/>
<link rel="prev" title="pyanaconda.ui.tui package" href="pyanaconda.ui.tui.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> &raquo;</li>
<li><a href="modules.html">pyanaconda</a> &raquo;</li>
<li><a href="pyanaconda.html">pyanaconda package</a> &raquo;</li>
<li><a href="pyanaconda.ui.html">pyanaconda.ui package</a> &raquo;</li>
<li><a href="pyanaconda.ui.tui.html">pyanaconda.ui.tui package</a> &raquo;</li>
<li>pyanaconda.ui.tui.hubs package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/pyanaconda.ui.tui.hubs.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-hubs-package">
<h1>pyanaconda.ui.tui.hubs package<a class="headerlink" href="#pyanaconda-ui-tui-hubs-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.hubs.summary">
<span id="pyanaconda-ui-tui-hubs-summary-module"></span><h2>pyanaconda.ui.tui.hubs.summary module<a class="headerlink" href="#module-pyanaconda.ui.tui.hubs.summary" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyanaconda.ui.tui.hubs.summary.SummaryHub">
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.hubs.summary.</code><code class="descname">SummaryHub</code><span class="sig-paren">(</span><em>app</em>, <em>data</em>, <em>storage</em>, <em>payload</em>, <em>instclass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.hubs.summary.SummaryHub" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.ui.tui.hubs.TUIHub" title="pyanaconda.ui.tui.hubs.TUIHub"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.tui.hubs.TUIHub</span></code></a></p>
<p class="graphviz">
<img src="_images/inheritance-bfaeccf52316599f19cd7b49d9d4a9e4105f6aea.png" alt="Inheritance diagram of SummaryHub" usemap="#inheritance945d734cf8" class="inheritance"/>
<map id="inheritance945d734cf8" name="inheritance945d734cf8">
<area shape="rect" id="node1" href="#pyanaconda.ui.tui.hubs.summary.SummaryHub" title=".. inheritance&#45;diagram:: SummaryHub" alt="" coords="156,233,340,261"/>
<area shape="rect" id="node2" href="#pyanaconda.ui.tui.hubs.TUIHub" title="Base Hub class implementing the pyanaconda.ui.common.Hub interface." alt="" coords="193,157,303,185"/>
<area shape="rect" id="node3" href="pyanaconda.ui.tui.simpleline.html#pyanaconda.ui.tui.simpleline.base.UIScreen" title="Base class representing one TUI Screen. Shares some API with anaconda&#39;s GUI" alt="" coords="5,5,168,33"/>
<area shape="rect" id="node4" href="pyanaconda.ui.tui.html#pyanaconda.ui.tui.tuiobject.TUIObject" title="Base class for Anaconda specific TUI screens. Implements the" alt="" coords="101,81,246,109"/>
<area shape="rect" id="node5" href="pyanaconda.ui.html#pyanaconda.ui.common.Hub" title="A Hub is an overview UI screen. &#160;A Hub consists of one or more grids of" alt="" coords="271,81,377,109"/>
<area shape="rect" id="node6" href="pyanaconda.ui.html#pyanaconda.ui.common.UIObject" title="This is the base class from which all other UI classes are derived. &#160;It" alt="" coords="193,5,327,33"/>
</map>
</p>
<dl class="method">
<dt id="pyanaconda.ui.tui.hubs.summary.SummaryHub.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.hubs.summary.SummaryHub.input" title="Permalink to this definition"></a></dt>
<dd><p>Handle user input. Numbers are used to show a spoke, the rest is passed
to the higher level for processing.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.ui.tui.hubs.summary.SummaryHub.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.hubs.summary.SummaryHub.prompt" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.ui.tui.hubs.summary.SummaryHub.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>environment='anaconda'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.hubs.summary.SummaryHub.setup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.ui.tui.hubs.summary.SummaryHub.title">
<code class="descname">title</code><em class="property"> = 'Installation'</em><a class="headerlink" href="#pyanaconda.ui.tui.hubs.summary.SummaryHub.title" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyanaconda.ui.tui.hubs">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyanaconda.ui.tui.hubs" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyanaconda.ui.tui.hubs.TUIHub">
<em class="property">class </em><code class="descclassname">pyanaconda.ui.tui.hubs.</code><code class="descname">TUIHub</code><span class="sig-paren">(</span><em>app</em>, <em>data</em>, <em>storage</em>, <em>payload</em>, <em>instclass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.hubs.TUIHub" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyanaconda.ui.tui.html#pyanaconda.ui.tui.tuiobject.TUIObject" title="pyanaconda.ui.tui.tuiobject.TUIObject"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.tui.tuiobject.TUIObject</span></code></a>, <a class="reference internal" href="pyanaconda.ui.html#pyanaconda.ui.common.Hub" title="pyanaconda.ui.common.Hub"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.common.Hub</span></code></a></p>
<p>Base Hub class implementing the pyanaconda.ui.common.Hub interface.
It uses text based categories to look for relevant Spokes and manages
all the spokes it finds to have the proper category.</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>categories</strong> (<em>list of strings</em>) &#8211; list all the spoke categories to be displayed in this Hub</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>) &#8211; title for this Hub</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p class="graphviz">
<img src="_images/inheritance-2d418f579ccd7ac406e887830f1e9c2699f0c635.png" alt="Inheritance diagram of TUIHub" usemap="#inheritance6406bbe875" class="inheritance"/>
<map id="inheritance6406bbe875" name="inheritance6406bbe875">
<area shape="rect" id="node1" href="pyanaconda.ui.tui.simpleline.html#pyanaconda.ui.tui.simpleline.base.UIScreen" title="Base class representing one TUI Screen. Shares some API with anaconda&#39;s GUI" alt="" coords="5,5,168,33"/>
<area shape="rect" id="node3" href="pyanaconda.ui.tui.html#pyanaconda.ui.tui.tuiobject.TUIObject" title="Base class for Anaconda specific TUI screens. Implements the" alt="" coords="101,81,246,109"/>
<area shape="rect" id="node2" href="#pyanaconda.ui.tui.hubs.TUIHub" title="Base Hub class implementing the pyanaconda.ui.common.Hub interface." alt="" coords="193,157,303,185"/>
<area shape="rect" id="node4" href="pyanaconda.ui.html#pyanaconda.ui.common.Hub" title="A Hub is an overview UI screen. &#160;A Hub consists of one or more grids of" alt="" coords="271,81,377,109"/>
<area shape="rect" id="node5" href="pyanaconda.ui.html#pyanaconda.ui.common.UIObject" title="This is the base class from which all other UI classes are derived. &#160;It" alt="" coords="193,5,327,33"/>
</map>
</p>
<dl class="attribute">
<dt id="pyanaconda.ui.tui.hubs.TUIHub.categories">
<code class="descname">categories</code><em class="property"> = []</em><a class="headerlink" href="#pyanaconda.ui.tui.hubs.TUIHub.categories" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyanaconda.ui.tui.hubs.TUIHub.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.hubs.TUIHub.input" title="Permalink to this definition"></a></dt>
<dd><p>Handle user input. Numbers are used to show a spoke, the rest is passed
to the higher level for processing.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.ui.tui.hubs.TUIHub.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.hubs.TUIHub.prompt" title="Permalink to this definition"></a></dt>
<dd><p>Show an alternative prompt if the hub contains only one spoke.
Otherwise it is not readily apparent that the user needs to press
1 to enter the single visible spoke.</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>) &#8211; 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.hubs.TUIHub.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.hubs.TUIHub.refresh" title="Permalink to this definition"></a></dt>
<dd><p>This methods fills the self._window list by all the objects
we want shown on this screen. Title and Spokes mostly.</p>
</dd></dl>
<dl class="method">
<dt id="pyanaconda.ui.tui.hubs.TUIHub.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>environment='anaconda'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.tui.hubs.TUIHub.setup" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyanaconda.ui.tui.hubs.TUIHub.title">
<code class="descname">title</code><em class="property"> = 'Default HUB title'</em><a class="headerlink" href="#pyanaconda.ui.tui.hubs.TUIHub.title" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="pyanaconda.ui.tui.simpleline.html" class="btn btn-neutral float-right" title="pyanaconda.ui.tui.simpleline package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="pyanaconda.ui.tui.html" class="btn btn-neutral" title="pyanaconda.ui.tui package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>