|
|
<!DOCTYPE html> |
|
|
<html class="writer-html5" lang="en" > |
|
|
<head> |
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> |
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
|
|
<title>TermTk.TTkCore.TTkTerm.inputkey — pyTermTk 0.2.0a documentation</title> |
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
|
|
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
|
|
<link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" /> |
|
|
<link rel="stylesheet" href="../_static/ttk.css" type="text/css" /> |
|
|
<!--[if lt IE 9]> |
|
|
<script src="../_static/js/html5shiv.min.js"></script> |
|
|
<![endif]--> |
|
|
|
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
|
|
<script src="../_static/jquery.js"></script> |
|
|
<script src="../_static/underscore.js"></script> |
|
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> |
|
|
<script src="../_static/doctools.js"></script> |
|
|
<script src="../_static/js/theme.js"></script> |
|
|
<link rel="index" title="Index" href="../genindex.html" /> |
|
|
<link rel="search" title="Search" href="../search.html" /> |
|
|
<link rel="next" title="TermTk.TTkCore.TTkTerm.inputmouse" href="TermTk.TTkCore.TTkTerm.inputmouse.html" /> |
|
|
<link rel="prev" title="TermTk.TTkCore.TTkTerm.input" href="TermTk.TTkCore.TTkTerm.input.html" /> |
|
|
</head> |
|
|
|
|
|
<body class="wy-body-for-nav"> |
|
|
<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"> pyTermTk |
|
|
</a> |
|
|
<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="Navigation menu"> |
|
|
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p> |
|
|
<ul> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/000-examples.html">pyTermTk - < <strong>the Examples</strong> ></a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/001-helloworld.html">pyTermTk - Hello World</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/002-layout.html">pyTermTk - Layouts</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/003-signalslots.html">pyTermTk - Signal & Slots</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/004-logging.html">pyTermTk - Logging</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/005-calculator.html">pyTermTk - Your first Calculator</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/ttkDesigner/textEdit/README.html">ttkDesigner - Your first TextEditor</a></li> |
|
|
</ul> |
|
|
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p> |
|
|
<ul class="current"> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkAbstract.html">TermTk.TTkAbstract</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkCore.html">TermTk.TTkCore</a></li> |
|
|
<li class="toctree-l1 current"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.html">TermTk.TTkCore.TTkTerm</a><ul class="current"> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.colors.html">TermTk.TTkCore.TTkTerm.colors</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.colors_ansi_map.html">TermTk.TTkCore.TTkTerm.colors_ansi_map</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.input.html">TermTk.TTkCore.TTkTerm.input</a></li> |
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">TermTk.TTkCore.TTkTerm.inputkey</a><ul> |
|
|
<li class="toctree-l3"><a class="reference internal" href="#ttkkeyevent">TTkKeyEvent</a></li> |
|
|
</ul> |
|
|
</li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.inputmouse.html">TermTk.TTkCore.TTkTerm.inputmouse</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.readinputlinux.html">TermTk.TTkCore.TTkTerm.readinputlinux</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.readinputlinux_thread.html">TermTk.TTkCore.TTkTerm.readinputlinux_thread</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.term.html">TermTk.TTkCore.TTkTerm.term</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.term_base.html">TermTk.TTkCore.TTkTerm.term_base</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.term_pyodide.html">TermTk.TTkCore.TTkTerm.term_pyodide</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.term_unix.html">TermTk.TTkCore.TTkTerm.term_unix</a></li> |
|
|
</ul> |
|
|
</li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkGui.html">TermTk.TTkGui</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkLayouts.html">TermTk.TTkLayouts</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTemplates.html">TermTk.TTkTemplates</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTestWidgets.html">TermTk.TTkTestWidgets</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTheme.html">TermTk.TTkTheme</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTypes.html">TermTk.TTkTypes</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkWidgets.html">TermTk.TTkWidgets</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkWidgets.TTkModelView.html">TermTk.TTkWidgets.TTkModelView</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkWidgets.TTkPickers.html">TermTk.TTkWidgets.TTkPickers</a></li> |
|
|
</ul> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
</nav> |
|
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
|
|
<a href="../index.html">pyTermTk</a> |
|
|
</nav> |
|
|
|
|
|
<div class="wy-nav-content"> |
|
|
<div class="rst-content"> |
|
|
<div role="navigation" aria-label="Page navigation"> |
|
|
<ul class="wy-breadcrumbs"> |
|
|
<li><a href="../index.html" class="icon icon-home"></a> »</li> |
|
|
<li><a href="TermTk.TTkCore.html">TermTk.TTkCore</a> »</li> |
|
|
<li><a href="TermTk.TTkCore.TTkTerm.html">TermTk.TTkCore.TTkTerm</a> »</li> |
|
|
<li>TermTk.TTkCore.TTkTerm.inputkey</li> |
|
|
<li class="wy-breadcrumbs-aside"> |
|
|
<a href="../_sources/autogen.TermTk/TermTk.TTkCore.TTkTerm.inputkey.rst.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"> |
|
|
|
|
|
<section id="module-TermTk.TTkCore.TTkTerm.inputkey"> |
|
|
<span id="termtk-ttkcore-ttkterm-inputkey"></span><h1>TermTk.TTkCore.TTkTerm.inputkey<a class="headerlink" href="#module-TermTk.TTkCore.TTkTerm.inputkey" title="Permalink to this heading"></a></h1> |
|
|
<section id="ttkkeyevent"> |
|
|
<h2>TTkKeyEvent<a class="headerlink" href="#ttkkeyevent" title="Permalink to this heading"></a></h2> |
|
|
<dl class="py class"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent"> |
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TTkKeyEvent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/TTkTerm/inputkey.html#TTkKeyEvent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Keyboard Events</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Demo</dt> |
|
|
<dd class="field-odd"><p><a class="reference external" href="https://github.com/ceccopierangiolieugenio/pyTermTk/blob/main/tests/test.input.py">test.input.py</a></p> |
|
|
</dd> |
|
|
<dt class="field-even">Parameters</dt> |
|
|
<dd class="field-even"><ul class="simple"> |
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyType" title="TermTk.TTkCore.constant.TTkConstant.KeyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyType</span></code></a>) – The key input type recorded</p></li> |
|
|
<li><p><strong>key</strong> (<em>str</em>) – the key</p></li> |
|
|
<li><p><strong>code</strong> (<em>str</em>) – The terminal code used to represent this input</p></li> |
|
|
<li><p><strong>mod</strong> (<a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyModifier" title="TermTk.TTkCore.constant.TTkConstant.KeyModifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyModifier</span></code></a>) – The modifier used by the <a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyType.SpecialKey" title="TermTk.TTkCore.constant.TTkConstant.KeyType.SpecialKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">SpecialKey</span></code></a> type</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
<dl class="py attribute"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.type"> |
|
|
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyType" title="TermTk.TTkCore.constant.TTkConstant.KeyType"><span class="pre">KeyType</span></a></em><a class="headerlink" href="#TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.type" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>The key input <a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyType" title="TermTk.TTkCore.constant.TTkConstant.KeyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyType</span></code></a> recorded</p> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py attribute"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.key"> |
|
|
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.key" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>the input key</p> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py attribute"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.code"> |
|
|
<span class="sig-name descname"><span class="pre">code</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.code" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>The terminal code used to represent this input</p> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py attribute"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.mod"> |
|
|
<span class="sig-name descname"><span class="pre">mod</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyModifier" title="TermTk.TTkCore.constant.TTkConstant.KeyModifier"><span class="pre">KeyModifier</span></a></em><a class="headerlink" href="#TermTk.TTkCore.TTkTerm.inputkey.TTkKeyEvent.mod" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>The <a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyModifier" title="TermTk.TTkCore.constant.TTkConstant.KeyModifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyModifier</span></code></a> used by the <a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.KeyType.SpecialKey" title="TermTk.TTkCore.constant.TTkConstant.KeyType.SpecialKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">SpecialKey</span></code></a> type</p> |
|
|
</dd></dl> |
|
|
|
|
|
</dd></dl> |
|
|
|
|
|
</section> |
|
|
</section> |
|
|
|
|
|
|
|
|
</div> |
|
|
</div> |
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
|
|
<a href="TermTk.TTkCore.TTkTerm.input.html" class="btn btn-neutral float-left" title="TermTk.TTkCore.TTkTerm.input" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
|
|
<a href="TermTk.TTkCore.TTkTerm.inputmouse.html" class="btn btn-neutral float-right" title="TermTk.TTkCore.TTkTerm.inputmouse" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
|
|
</div> |
|
|
|
|
|
<hr/> |
|
|
|
|
|
<div role="contentinfo"> |
|
|
<p>© Copyright 2021, Eugenio Parodi.</p> |
|
|
</div> |
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>. |
|
|
|
|
|
|
|
|
</footer> |
|
|
</div> |
|
|
</div> |
|
|
</section> |
|
|
</div> |
|
|
<script> |
|
|
jQuery(function () { |
|
|
SphinxRtdTheme.Navigation.enable(true); |
|
|
}); |
|
|
</script> |
|
|
|
|
|
</body> |
|
|
</html> |
